1d4a38612989b6d9a755fe5a665a7608e9405109
[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.8.0
15 @date 2008-2011
16
17 @section intro What is Elementary?
18
19 This is a VERY SIMPLE toolkit. It is not meant for writing extensive desktop
20 applications (yet). Small simple ones with simple needs.
21
22 It is meant to make the programmers work almost brainless but give them lots
23 of flexibility.
24
25 @li @ref Start - Go here to quickly get started with writing Apps
26
27 @section organization Organization
28
29 One can divide Elemementary into three main groups:
30 @li @ref infralist - These are modules that deal with Elementary as a whole.
31 @li @ref widgetslist - These are the widgets you'll compose your UI out of.
32 @li @ref containerslist - These are the containers which hold the widgets.
33
34 @section license License
35
36 LGPL v2 (see COPYING in the base of Elementary's source). This applies to
37 all files in the source tree.
38
39 @section ack Acknowledgements
40 There is a lot that goes into making a widget set, and they don't happen out of
41 nothing. It's like trying to make everyone everywhere happy, regardless of age,
42 gender, race or nationality - and that is really tough. So thanks to people and
43 organisations behind this, as listed in the @ref authors page.
44 */
45
46
47 /**
48  * @defgroup Start Getting Started
49  *
50  * To write an Elementary app, you can get started with the following:
51  *
52 @code
53 #include <Elementary.h>
54 EAPI_MAIN int
55 elm_main(int argc, char **argv)
56 {
57    // create window(s) here and do any application init
58    elm_run(); // run main loop
59    elm_shutdown(); // after mainloop finishes running, shutdown
60    return 0; // exit 0 for exit code
61 }
62 ELM_MAIN()
63 @endcode
64  *
65  * To use autotools (which helps in many ways in the long run, like being able
66  * to immediately create releases of your software directly from your tree
67  * and ensure everything needed to build it is there) you will need a
68  * configure.ac, Makefile.am and autogen.sh file.
69  *
70  * configure.ac:
71  *
72 @verbatim
73 AC_INIT(myapp, 0.0.0, myname@mydomain.com)
74 AC_PREREQ(2.52)
75 AC_CONFIG_SRCDIR(configure.ac)
76 AM_CONFIG_HEADER(config.h)
77 AC_PROG_CC
78 AM_INIT_AUTOMAKE(1.6 dist-bzip2)
79 PKG_CHECK_MODULES([ELEMENTARY], elementary)
80 AC_OUTPUT(Makefile)
81 @endverbatim
82  *
83  * Makefile.am:
84  *
85 @verbatim
86 AUTOMAKE_OPTIONS = 1.4 foreign
87 MAINTAINERCLEANFILES = Makefile.in aclocal.m4 config.h.in configure depcomp install-sh missing
88
89 INCLUDES = -I$(top_srcdir)
90
91 bin_PROGRAMS = myapp
92
93 myapp_SOURCES = main.c
94 myapp_LDADD = @ELEMENTARY_LIBS@
95 myapp_CFLAGS = @ELEMENTARY_CFLAGS@
96 @endverbatim
97  *
98  * autogen.sh:
99  *
100 @verbatim
101 #!/bin/sh
102 echo "Running aclocal..." ; aclocal $ACLOCAL_FLAGS || exit 1
103 echo "Running autoheader..." ; autoheader || exit 1
104 echo "Running autoconf..." ; autoconf || exit 1
105 echo "Running automake..." ; automake --add-missing --copy --gnu || exit 1
106 ./configure "$@"
107 @endverbatim
108  *
109  * To generate all the things needed to bootstrap just run:
110  *
111 @verbatim
112 ./autogen.sh
113 @endverbatim
114  *
115  * This will generate Makefile.in's, the confgure script and everything else.
116  * After this it works like all normal autotools projects:
117 @verbatim
118 ./configure
119 make
120 sudo make install
121 @endverbatim
122  *
123  * Note sudo was assumed to get root permissions, as this would install in
124  * /usr/local which is system-owned. Use any way you like to gain root, or
125  * specify a different prefix with configure:
126  *
127 @verbatim
128 ./confiugre --prefix=$HOME/mysoftware
129 @endverbatim
130  *
131  * Also remember that autotools buys you some useful commands like:
132 @verbatim
133 make uninstall
134 @endverbatim
135  *
136  * This uninstalls the software after it was installed with "make install".
137  * It is very useful to clear up what you built if you wish to clean the
138  * system.
139  *
140 @verbatim
141 make distcheck
142 @endverbatim
143  *
144  * This firstly checks if your build tree is "clean" and ready for
145  * distribution. It also builds a tarball (myapp-0.0.0.tar.gz) that is
146  * ready to upload and distribute to the world, that contains the generated
147  * Makefile.in's and configure script. The users do not need to run
148  * autogen.sh - just configure and on. They don't need autotools installed.
149  * This tarball also builds cleanly, has all the sources it needs to build
150  * included (that is sources for your application, not libraries it depends
151  * on like Elementary). It builds cleanly in a buildroot and does not
152  * contain any files that are temporarily generated like binaries and other
153  * build-generated files, so the tarball is clean, and no need to worry
154  * about cleaning up your tree before packaging.
155  *
156 @verbatim
157 make clean
158 @endverbatim
159  *
160  * This cleans up all build files (binaries, objects etc.) from the tree.
161  *
162 @verbatim
163 make distclean
164 @endverbatim
165  *
166  * This cleans out all files from the build and from configure's output too.
167  *
168 @verbatim
169 make maintainer-clean
170 @endverbatim
171  *
172  * This deletes all the files autogen.sh will produce so the tree is clean
173  * to be put into a revision-control system (like CVS, SVN or GIT for example).
174  *
175  * There is a more advanced way of making use of the quicklaunch infrastructure
176  * in Elementary (which will not be covered here due to its more advanced
177  * nature).
178  *
179  * Now let's actually create an interactive "Hello World" gui that you can
180  * click the ok button to exit. It's more code because this now does something
181  * much more significant, but it's still very simple:
182  *
183 @code
184 #include <Elementary.h>
185
186 static void
187 on_done(void *data, Evas_Object *obj, void *event_info)
188 {
189    // quit the mainloop (elm_run function will return)
190    elm_exit();
191 }
192
193 EAPI_MAIN int
194 elm_main(int argc, char **argv)
195 {
196    Evas_Object *win, *bg, *box, *lab, *btn;
197
198    // new window - do the usual and give it a name (hello) and title (Hello)
199    win = elm_win_util_standard_add("hello", "Hello");
200    // when the user clicks "close" on a window there is a request to delete
201    evas_object_smart_callback_add(win, "delete,request", on_done, NULL);
202
203    // add a box object - default is vertical. a box holds children in a row,
204    // either horizontally or vertically. nothing more.
205    box = elm_box_add(win);
206    // make the box hotizontal
207    elm_box_horizontal_set(box, EINA_TRUE);
208    // add object as a resize object for the window (controls window minimum
209    // size as well as gets resized if window is resized)
210    elm_win_resize_object_add(win, box);
211    evas_object_show(box);
212
213    // add a label widget, set the text and put it in the pad frame
214    lab = elm_label_add(win);
215    // set default text of the label
216    elm_object_text_set(lab, "Hello out there world!");
217    // pack the label at the end of the box
218    elm_box_pack_end(box, lab);
219    evas_object_show(lab);
220
221    // add an ok button
222    btn = elm_button_add(win);
223    // set default text of button to "OK"
224    elm_object_text_set(btn, "OK");
225    // pack the button at the end of the box
226    elm_box_pack_end(box, btn);
227    evas_object_show(btn);
228    // call on_done when button is clicked
229    evas_object_smart_callback_add(btn, "clicked", on_done, NULL);
230
231    // now we are done, show the window
232    evas_object_show(win);
233
234    // run the mainloop and process events and callbacks
235    elm_run();
236    return 0;
237 }
238 ELM_MAIN()
239 @endcode
240    *
241    */
242
243 /**
244 @page authors Authors
245 @author Carsten Haitzler <raster@@rasterman.com>
246 @author Gustavo Sverzut Barbieri <barbieri@@profusion.mobi>
247 @author Cedric Bail <cedric.bail@@free.fr>
248 @author Vincent Torri <vtorri@@univ-evry.fr>
249 @author Daniel Kolesa <quaker66@@gmail.com>
250 @author Jaime Thomas <avi.thomas@@gmail.com>
251 @author Swisscom - http://www.swisscom.ch/
252 @author Christopher Michael <devilhorns@@comcast.net>
253 @author Marco Trevisan (TreviƱo) <mail@@3v1n0.net>
254 @author Michael Bouchaud <michael.bouchaud@@gmail.com>
255 @author Jonathan Atton (Watchwolf) <jonathan.atton@@gmail.com>
256 @author Brian Wang <brian.wang.0721@@gmail.com>
257 @author Mike Blumenkrantz (zmike) <mike@@zentific.com>
258 @author Samsung Electronics <tbd>
259 @author Samsung SAIT <tbd>
260 @author Brett Nash <nash@@nash.id.au>
261 @author Bruno Dilly <bdilly@@profusion.mobi>
262 @author Rafael Fonseca <rfonseca@@profusion.mobi>
263 @author Chuneon Park <hermet@@hermet.pe.kr>
264 @author Woohyun Jung <wh0705.jung@@samsung.com>
265 @author Jaehwan Kim <jae.hwan.kim@@samsung.com>
266 @author Wonguk Jeong <wonguk.jeong@@samsung.com>
267 @author Leandro A. F. Pereira <leandro@@profusion.mobi>
268 @author Helen Fornazier <helen.fornazier@@profusion.mobi>
269 @author Gustavo Lima Chaves <glima@@profusion.mobi>
270 @author Fabiano FidĆŖncio <fidencio@@profusion.mobi>
271 @author Tiago FalcĆ£o <tiago@@profusion.mobi>
272 @author Otavio Pontes <otavio@@profusion.mobi>
273 @author Viktor Kojouharov <vkojouharov@@gmail.com>
274 @author Daniel Juyung Seo (SeoZ) <juyung.seo@@samsung.com> <seojuyung2@@gmail.com>
275 @author Sangho Park <sangho.g.park@@samsung.com> <gouache95@@gmail.com>
276 @author Rajeev Ranjan (Rajeev) <rajeev.r@@samsung.com> <rajeev.jnnce@@gmail.com>
277 @author Seunggyun Kim <sgyun.kim@@samsung.com> <tmdrbs@@gmail.com>
278 @author Sohyun Kim <anna1014.kim@@samsung.com> <sohyun.anna@@gmail.com>
279 @author Jihoon Kim <jihoon48.kim@@samsung.com>
280 @author Jeonghyun Yun (arosis) <jh0506.yun@@samsung.com>
281 @author Tom Hacohen <tom@@stosb.com>
282 @author Aharon Hillel <a.hillel@@partner.samsung.com>
283 @author Jonathan Atton (Watchwolf) <jonathan.atton@@gmail.com>
284 @author Shinwoo Kim <kimcinoo@@gmail.com>
285 @author Govindaraju SM <govi.sm@@samsung.com> <govism@@gmail.com>
286 @author Prince Kumar Dubey <prince.dubey@@samsung.com> <prince.dubey@@gmail.com>
287 @author Sung W. Park <sungwoo@gmail.com>
288 @author Thierry el Borgi <thierry@substantiel.fr>
289 @author Shilpa Singh <shilpa.singh@samsung.com> <shilpasingh.o@gmail.com>
290 @author Chanwook Jung <joey.jung@samsung.com>
291 @author Hyoyoung Chang <hyoyoung.chang@samsung.com>
292 @author Guillaume "Kuri" Friloux <guillaume.friloux@asp64.com>
293 @author Kim Yunhan <spbear@gmail.com>
294
295 Please contact <enlightenment-devel@lists.sourceforge.net> to get in
296 contact with the developers and maintainers.
297  */
298
299 #ifndef ELEMENTARY_H
300 #define ELEMENTARY_H
301
302 /**
303  * @file Elementary.h
304  * @brief Elementary's API
305  *
306  * Elementary API.
307  */
308
309 @ELM_UNIX_DEF@ ELM_UNIX
310 @ELM_WIN32_DEF@ ELM_WIN32
311 @ELM_WINCE_DEF@ ELM_WINCE
312 @ELM_EDBUS_DEF@ ELM_EDBUS
313 @ELM_EFREET_DEF@ ELM_EFREET
314 @ELM_ETHUMB_DEF@ ELM_ETHUMB
315 @ELM_WEB_DEF@ ELM_WEB
316 @ELM_EMAP_DEF@ ELM_EMAP
317 @ELM_DEBUG_DEF@ ELM_DEBUG
318 @ELM_ALLOCA_H_DEF@ ELM_ALLOCA_H
319 @ELM_LIBINTL_H_DEF@ ELM_LIBINTL_H
320
321 /* Standard headers for standard system calls etc. */
322 #include <stdio.h>
323 #include <stdlib.h>
324 #include <unistd.h>
325 #include <string.h>
326 #include <sys/types.h>
327 #include <sys/stat.h>
328 #include <sys/time.h>
329 #include <sys/param.h>
330 #include <math.h>
331 #include <fnmatch.h>
332 #include <limits.h>
333 #include <ctype.h>
334 #include <time.h>
335 #include <dirent.h>
336 #include <pwd.h>
337 #include <errno.h>
338
339 #ifdef ELM_UNIX
340 # include <locale.h>
341 # ifdef ELM_LIBINTL_H
342 #  include <libintl.h>
343 # endif
344 # include <signal.h>
345 # include <grp.h>
346 # include <glob.h>
347 #endif
348
349 #ifdef ELM_ALLOCA_H
350 # include <alloca.h>
351 #endif
352
353 #if defined (ELM_WIN32) || defined (ELM_WINCE)
354 # include <malloc.h>
355 # ifndef alloca
356 #  define alloca _alloca
357 # endif
358 #endif
359
360
361 /* EFL headers */
362 #include <Eina.h>
363 #include <Eet.h>
364 #include <Evas.h>
365 #include <Evas_GL.h>
366 #include <Ecore.h>
367 #include <Ecore_Evas.h>
368 #include <Ecore_File.h>
369 #include <Ecore_IMF.h>
370 #include <Ecore_Con.h>
371 #include <Edje.h>
372
373 #ifdef ELM_EDBUS
374 # include <E_DBus.h>
375 #endif
376
377 #ifdef ELM_EFREET
378 # include <Efreet.h>
379 # include <Efreet_Mime.h>
380 # include <Efreet_Trash.h>
381 #endif
382
383 #ifdef ELM_ETHUMB
384 # include <Ethumb_Client.h>
385 #endif
386
387 #ifdef ELM_EMAP
388 # include <EMap.h>
389 #endif
390
391 #ifdef EAPI
392 # undef EAPI
393 #endif
394
395 #ifdef _WIN32
396 # ifdef ELEMENTARY_BUILD
397 #  ifdef DLL_EXPORT
398 #   define EAPI __declspec(dllexport)
399 #  else
400 #   define EAPI
401 #  endif /* ! DLL_EXPORT */
402 # else
403 #  define EAPI __declspec(dllimport)
404 # endif /* ! EFL_EVAS_BUILD */
405 #else
406 # ifdef __GNUC__
407 #  if __GNUC__ >= 4
408 #   define EAPI __attribute__ ((visibility("default")))
409 #  else
410 #   define EAPI
411 #  endif
412 # else
413 #  define EAPI
414 # endif
415 #endif /* ! _WIN32 */
416
417 #ifdef _WIN32
418 # define EAPI_MAIN
419 #else
420 # define EAPI_MAIN EAPI
421 #endif
422
423 /* allow usage from c++ */
424 #ifdef __cplusplus
425 extern "C" {
426 #endif
427
428 #define ELM_VERSION_MAJOR @VMAJ@
429 #define ELM_VERSION_MINOR @VMIN@
430
431    typedef struct _Elm_Version
432      {
433         int major;
434         int minor;
435         int micro;
436         int revision;
437      } Elm_Version;
438
439    EAPI extern Elm_Version *elm_version;
440
441 /* handy macros */
442 #define ELM_RECTS_INTERSECT(x, y, w, h, xx, yy, ww, hh) (((x) < ((xx) + (ww))) && ((y) < ((yy) + (hh))) && (((x) + (w)) > (xx)) && (((y) + (h)) > (yy)))
443 #define ELM_PI 3.14159265358979323846
444
445    /**
446     * @defgroup General General
447     *
448     * @brief General Elementary API. Functions that don't relate to
449     * Elementary objects specifically.
450     *
451     * Here are documented functions which init/shutdown the library,
452     * that apply to generic Elementary objects, that deal with
453     * configuration, et cetera.
454     *
455     * @ref general_functions_example_page "This" example contemplates
456     * some of these functions.
457     */
458
459    /**
460     * @addtogroup General
461     * @{
462     */
463
464   /**
465    * Defines couple of standard Evas_Object layers to be used
466    * with evas_object_layer_set().
467    *
468    * @note whenever extending with new values, try to keep some padding
469    *       to siblings so there is room for further extensions.
470    */
471   typedef enum _Elm_Object_Layer
472     {
473        ELM_OBJECT_LAYER_BACKGROUND = EVAS_LAYER_MIN + 64, /**< where to place backgrounds */
474        ELM_OBJECT_LAYER_DEFAULT = 0, /**< Evas_Object default layer (and thus for Elementary) */
475        ELM_OBJECT_LAYER_FOCUS = EVAS_LAYER_MAX - 128, /**< where focus object visualization is */
476        ELM_OBJECT_LAYER_TOOLTIP = EVAS_LAYER_MAX - 64, /**< where to show tooltips */
477        ELM_OBJECT_LAYER_CURSOR = EVAS_LAYER_MAX - 32, /**< where to show cursors */
478        ELM_OBJECT_LAYER_LAST /**< last layer known by Elementary */
479     } Elm_Object_Layer;
480
481 /**************************************************************************/
482    EAPI extern int ELM_ECORE_EVENT_ETHUMB_CONNECT;
483
484    /**
485     * Emitted when the application has reconfigured elementary settings due
486     * to an external configuration tool asking it to.
487     */
488    EAPI extern int ELM_EVENT_CONFIG_ALL_CHANGED;
489
490    /**
491     * Emitted when any Elementary's policy value is changed.
492     */
493    EAPI extern int ELM_EVENT_POLICY_CHANGED;
494
495    /**
496     * @typedef Elm_Event_Policy_Changed
497     *
498     * Data on the event when an Elementary policy has changed
499     */
500     typedef struct _Elm_Event_Policy_Changed Elm_Event_Policy_Changed;
501
502    /**
503     * @struct _Elm_Event_Policy_Changed
504     *
505     * Data on the event when an Elementary policy has changed
506     */
507     struct _Elm_Event_Policy_Changed
508      {
509         unsigned int policy; /**< the policy identifier */
510         int          new_value; /**< value the policy had before the change */
511         int          old_value; /**< new value the policy got */
512     };
513
514    /**
515     * Policy identifiers.
516     */
517     typedef enum _Elm_Policy
518     {
519         ELM_POLICY_QUIT, /**< under which circumstances the application
520                           * should quit automatically. @see
521                           * Elm_Policy_Quit.
522                           */
523         ELM_POLICY_LAST
524     } Elm_Policy; /**< Elementary policy identifiers/groups enumeration.  @see elm_policy_set()
525  */
526
527    typedef enum _Elm_Policy_Quit
528      {
529         ELM_POLICY_QUIT_NONE = 0, /**< never quit the application
530                                    * automatically */
531         ELM_POLICY_QUIT_LAST_WINDOW_CLOSED /**< quit when the
532                                             * application's last
533                                             * window is closed */
534      } Elm_Policy_Quit; /**< Possible values for the #ELM_POLICY_QUIT policy */
535
536    typedef enum _Elm_Focus_Direction
537      {
538         ELM_FOCUS_PREVIOUS,
539         ELM_FOCUS_NEXT
540      } Elm_Focus_Direction;
541
542    typedef enum _Elm_Text_Format
543      {
544         ELM_TEXT_FORMAT_PLAIN_UTF8,
545         ELM_TEXT_FORMAT_MARKUP_UTF8
546      } Elm_Text_Format;
547
548    /**
549     * Line wrapping types.
550     */
551    typedef enum _Elm_Wrap_Type
552      {
553         ELM_WRAP_NONE = 0, /**< No wrap - value is zero */
554         ELM_WRAP_CHAR, /**< Char wrap - wrap between characters */
555         ELM_WRAP_WORD, /**< Word wrap - wrap in allowed wrapping points (as defined in the unicode standard) */
556         ELM_WRAP_MIXED, /**< Mixed wrap - Word wrap, and if that fails, char wrap. */
557         ELM_WRAP_LAST
558      } Elm_Wrap_Type;
559
560    typedef enum
561      {
562         ELM_INPUT_PANEL_LAYOUT_NORMAL,          /**< Default layout */
563         ELM_INPUT_PANEL_LAYOUT_NUMBER,          /**< Number layout */
564         ELM_INPUT_PANEL_LAYOUT_EMAIL,           /**< Email layout */
565         ELM_INPUT_PANEL_LAYOUT_URL,             /**< URL layout */
566         ELM_INPUT_PANEL_LAYOUT_PHONENUMBER,     /**< Phone Number layout */
567         ELM_INPUT_PANEL_LAYOUT_IP,              /**< IP layout */
568         ELM_INPUT_PANEL_LAYOUT_MONTH,           /**< Month layout */
569         ELM_INPUT_PANEL_LAYOUT_NUMBERONLY,      /**< Number Only layout */
570         ELM_INPUT_PANEL_LAYOUT_INVALID
571      } Elm_Input_Panel_Layout;
572
573    typedef enum
574      {
575         ELM_AUTOCAPITAL_TYPE_NONE,
576         ELM_AUTOCAPITAL_TYPE_WORD,
577         ELM_AUTOCAPITAL_TYPE_SENTENCE,
578         ELM_AUTOCAPITAL_TYPE_ALLCHARACTER,
579      } Elm_Autocapital_Type;
580
581    /**
582     * @typedef Elm_Object_Item
583     * An Elementary Object item handle.
584     * @ingroup General
585     */
586    typedef struct _Elm_Object_Item Elm_Object_Item;
587
588
589    /**
590     * Called back when a widget's tooltip is activated and needs content.
591     * @param data user-data given to elm_object_tooltip_content_cb_set()
592     * @param obj owner widget.
593     * @param tooltip The tooltip object (affix content to this!)
594     */
595    typedef Evas_Object *(*Elm_Tooltip_Content_Cb) (void *data, Evas_Object *obj, Evas_Object *tooltip);
596
597    /**
598     * Called back when a widget's item tooltip is activated and needs content.
599     * @param data user-data given to elm_object_tooltip_content_cb_set()
600     * @param obj owner widget.
601     * @param tooltip The tooltip object (affix content to this!)
602     * @param item context dependent item. As an example, if tooltip was
603     *        set on Elm_List_Item, then it is of this type.
604     */
605    typedef Evas_Object *(*Elm_Tooltip_Item_Content_Cb) (void *data, Evas_Object *obj, Evas_Object *tooltip, void *item);
606
607    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. */
608
609 #ifndef ELM_LIB_QUICKLAUNCH
610 #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 */
611 #else
612 #define ELM_MAIN() int main(int argc, char **argv) {return elm_quicklaunch_fallback(argc, argv);} /**< macro to be used after the elm_main() function */
613 #endif
614
615 /**************************************************************************/
616    /* General calls */
617
618    /**
619     * Initialize Elementary
620     *
621     * @param[in] argc System's argument count value
622     * @param[in] argv System's pointer to array of argument strings
623     * @return The init counter value.
624     *
625     * This function initializes Elementary and increments a counter of
626     * the number of calls to it. It returns the new counter's value.
627     *
628     * @warning This call is exported only for use by the @c ELM_MAIN()
629     * macro. There is no need to use this if you use this macro (which
630     * is highly advisable). An elm_main() should contain the entry
631     * point code for your application, having the same prototype as
632     * elm_init(), and @b not being static (putting the @c EAPI symbol
633     * in front of its type declaration is advisable). The @c
634     * ELM_MAIN() call should be placed just after it.
635     *
636     * Example:
637     * @dontinclude bg_example_01.c
638     * @skip static void
639     * @until ELM_MAIN
640     *
641     * See the full @ref bg_example_01_c "example".
642     *
643     * @see elm_shutdown().
644     * @ingroup General
645     */
646    EAPI int          elm_init(int argc, char **argv);
647
648    /**
649     * Shut down Elementary
650     *
651     * @return The init counter value.
652     *
653     * This should be called at the end of your application, just
654     * before it ceases to do any more processing. This will clean up
655     * any permanent resources your application may have allocated via
656     * Elementary that would otherwise persist.
657     *
658     * @see elm_init() for an example
659     *
660     * @ingroup General
661     */
662    EAPI int          elm_shutdown(void);
663
664    /**
665     * Run Elementary's main loop
666     *
667     * This call should be issued just after all initialization is
668     * completed. This function will not return until elm_exit() is
669     * called. It will keep looping, running the main
670     * (event/processing) loop for Elementary.
671     *
672     * @see elm_init() for an example
673     *
674     * @ingroup General
675     */
676    EAPI void         elm_run(void);
677
678    /**
679     * Exit Elementary's main loop
680     *
681     * If this call is issued, it will flag the main loop to cease
682     * processing and return back to its parent function (usually your
683     * elm_main() function).
684     *
685     * @see elm_init() for an example. There, just after a request to
686     * close the window comes, the main loop will be left.
687     *
688     * @note By using the appropriate #ELM_POLICY_QUIT on your Elementary
689     * applications, you'll be able to get this function called automatically for you.
690     *
691     * @ingroup General
692     */
693    EAPI void         elm_exit(void);
694
695    /**
696     * Provide information in order to make Elementary determine the @b
697     * run time location of the software in question, so other data files
698     * such as images, sound files, executable utilities, libraries,
699     * modules and locale files can be found.
700     *
701     * @param mainfunc This is your application's main function name,
702     *        whose binary's location is to be found. Providing @c NULL
703     *        will make Elementary not to use it
704     * @param dom This will be used as the application's "domain", in the
705     *        form of a prefix to any environment variables that may
706     *        override prefix detection and the directory name, inside the
707     *        standard share or data directories, where the software's
708     *        data files will be looked for.
709     * @param checkfile This is an (optional) magic file's path to check
710     *        for existence (and it must be located in the data directory,
711     *        under the share directory provided above). Its presence will
712     *        help determine the prefix found was correct. Pass @c NULL if
713     *        the check is not to be done.
714     *
715     * This function allows one to re-locate the application somewhere
716     * else after compilation, if the developer wishes for easier
717     * distribution of pre-compiled binaries.
718     *
719     * The prefix system is designed to locate where the given software is
720     * installed (under a common path prefix) at run time and then report
721     * specific locations of this prefix and common directories inside
722     * this prefix like the binary, library, data and locale directories,
723     * through the @c elm_app_*_get() family of functions.
724     *
725     * Call elm_app_info_set() early on before you change working
726     * directory or anything about @c argv[0], so it gets accurate
727     * information.
728     *
729     * It will then try and trace back which file @p mainfunc comes from,
730     * if provided, to determine the application's prefix directory.
731     *
732     * The @p dom parameter provides a string prefix to prepend before
733     * environment variables, allowing a fallback to @b specific
734     * environment variables to locate the software. You would most
735     * probably provide a lowercase string there, because it will also
736     * serve as directory domain, explained next. For environment
737     * variables purposes, this string is made uppercase. For example if
738     * @c "myapp" is provided as the prefix, then the program would expect
739     * @c "MYAPP_PREFIX" as a master environment variable to specify the
740     * exact install prefix for the software, or more specific environment
741     * variables like @c "MYAPP_BIN_DIR", @c "MYAPP_LIB_DIR", @c
742     * "MYAPP_DATA_DIR" and @c "MYAPP_LOCALE_DIR", which could be set by
743     * the user or scripts before launching. If not provided (@c NULL),
744     * environment variables will not be used to override compiled-in
745     * defaults or auto detections.
746     *
747     * The @p dom string also provides a subdirectory inside the system
748     * shared data directory for data files. For example, if the system
749     * directory is @c /usr/local/share, then this directory name is
750     * appended, creating @c /usr/local/share/myapp, if it @p was @c
751     * "myapp". It is expected that the application installs data files in
752     * this directory.
753     *
754     * The @p checkfile is a file name or path of something inside the
755     * share or data directory to be used to test that the prefix
756     * detection worked. For example, your app will install a wallpaper
757     * image as @c /usr/local/share/myapp/images/wallpaper.jpg and so to
758     * check that this worked, provide @c "images/wallpaper.jpg" as the @p
759     * checkfile string.
760     *
761     * @see elm_app_compile_bin_dir_set()
762     * @see elm_app_compile_lib_dir_set()
763     * @see elm_app_compile_data_dir_set()
764     * @see elm_app_compile_locale_set()
765     * @see elm_app_prefix_dir_get()
766     * @see elm_app_bin_dir_get()
767     * @see elm_app_lib_dir_get()
768     * @see elm_app_data_dir_get()
769     * @see elm_app_locale_dir_get()
770     */
771    EAPI void         elm_app_info_set(void *mainfunc, const char *dom, const char *checkfile);
772
773    /**
774     * Provide information on the @b fallback application's binaries
775     * directory, in scenarios where they get overriden by
776     * elm_app_info_set().
777     *
778     * @param dir The path to the default binaries directory (compile time
779     * one)
780     *
781     * @note Elementary will as well use this path to determine actual
782     * names of binaries' directory paths, maybe changing it to be @c
783     * something/local/bin instead of @c something/bin, only, for
784     * example.
785     *
786     * @warning You should call this function @b before
787     * elm_app_info_set().
788     */
789    EAPI void         elm_app_compile_bin_dir_set(const char *dir);
790
791    /**
792     * Provide information on the @b fallback application's libraries
793     * directory, on scenarios where they get overriden by
794     * elm_app_info_set().
795     *
796     * @param dir The path to the default libraries directory (compile
797     * time one)
798     *
799     * @note Elementary will as well use this path to determine actual
800     * names of libraries' directory paths, maybe changing it to be @c
801     * something/lib32 or @c something/lib64 instead of @c something/lib,
802     * only, for example.
803     *
804     * @warning You should call this function @b before
805     * elm_app_info_set().
806     */
807    EAPI void         elm_app_compile_lib_dir_set(const char *dir);
808
809    /**
810     * Provide information on the @b fallback application's data
811     * directory, on scenarios where they get overriden by
812     * elm_app_info_set().
813     *
814     * @param dir The path to the default data directory (compile time
815     * one)
816     *
817     * @note Elementary will as well use this path to determine actual
818     * names of data directory paths, maybe changing it to be @c
819     * something/local/share instead of @c something/share, only, for
820     * example.
821     *
822     * @warning You should call this function @b before
823     * elm_app_info_set().
824     */
825    EAPI void         elm_app_compile_data_dir_set(const char *dir);
826
827    /**
828     * Provide information on the @b fallback application's locale
829     * directory, on scenarios where they get overriden by
830     * elm_app_info_set().
831     *
832     * @param dir The path to the default locale directory (compile time
833     * one)
834     *
835     * @warning You should call this function @b before
836     * elm_app_info_set().
837     */
838    EAPI void         elm_app_compile_locale_set(const char *dir);
839
840    /**
841     * Retrieve the application's run time prefix directory, as set by
842     * elm_app_info_set() and the way (environment) the application was
843     * run from.
844     *
845     * @return The directory prefix the application is actually using.
846     */
847    EAPI const char  *elm_app_prefix_dir_get(void);
848
849    /**
850     * Retrieve the application's run time binaries prefix directory, as
851     * set by elm_app_info_set() and the way (environment) the application
852     * was run from.
853     *
854     * @return The binaries directory prefix the application is actually
855     * using.
856     */
857    EAPI const char  *elm_app_bin_dir_get(void);
858
859    /**
860     * Retrieve the application's run time libraries prefix directory, as
861     * set by elm_app_info_set() and the way (environment) the application
862     * was run from.
863     *
864     * @return The libraries directory prefix the application is actually
865     * using.
866     */
867    EAPI const char  *elm_app_lib_dir_get(void);
868
869    /**
870     * Retrieve the application's run time data prefix directory, as
871     * set by elm_app_info_set() and the way (environment) the application
872     * was run from.
873     *
874     * @return The data directory prefix the application is actually
875     * using.
876     */
877    EAPI const char  *elm_app_data_dir_get(void);
878
879    /**
880     * Retrieve the application's run time locale prefix directory, as
881     * set by elm_app_info_set() and the way (environment) the application
882     * was run from.
883     *
884     * @return The locale directory prefix the application is actually
885     * using.
886     */
887    EAPI const char  *elm_app_locale_dir_get(void);
888
889    EAPI void         elm_quicklaunch_mode_set(Eina_Bool ql_on);
890    EAPI Eina_Bool    elm_quicklaunch_mode_get(void);
891    EAPI int          elm_quicklaunch_init(int argc, char **argv);
892    EAPI int          elm_quicklaunch_sub_init(int argc, char **argv);
893    EAPI int          elm_quicklaunch_sub_shutdown(void);
894    EAPI int          elm_quicklaunch_shutdown(void);
895    EAPI void         elm_quicklaunch_seed(void);
896    EAPI Eina_Bool    elm_quicklaunch_prepare(int argc, char **argv);
897    EAPI Eina_Bool    elm_quicklaunch_fork(int argc, char **argv, char *cwd, void (postfork_func) (void *data), void *postfork_data);
898    EAPI void         elm_quicklaunch_cleanup(void);
899    EAPI int          elm_quicklaunch_fallback(int argc, char **argv);
900    EAPI char        *elm_quicklaunch_exe_path_get(const char *exe);
901
902    EAPI Eina_Bool    elm_need_efreet(void);
903    EAPI Eina_Bool    elm_need_e_dbus(void);
904
905    /**
906     * This must be called before any other function that deals with
907     * elm_thumb objects or ethumb_client instances.
908     *
909     * @ingroup Thumb
910     */
911    EAPI Eina_Bool    elm_need_ethumb(void);
912
913    /**
914     * This must be called before any other function that deals with
915     * elm_web objects or ewk_view instances.
916     *
917     * @ingroup Web
918     */
919    EAPI Eina_Bool    elm_need_web(void);
920
921    /**
922     * Set a new policy's value (for a given policy group/identifier).
923     *
924     * @param policy policy identifier, as in @ref Elm_Policy.
925     * @param value policy value, which depends on the identifier
926     *
927     * @return @c EINA_TRUE on success or @c EINA_FALSE, on error.
928     *
929     * Elementary policies define applications' behavior,
930     * somehow. These behaviors are divided in policy groups (see
931     * #Elm_Policy enumeration). This call will emit the Ecore event
932     * #ELM_EVENT_POLICY_CHANGED, which can be hooked at with
933     * handlers. An #Elm_Event_Policy_Changed struct will be passed,
934     * then.
935     *
936     * @note Currently, we have only one policy identifier/group
937     * (#ELM_POLICY_QUIT), which has two possible values.
938     *
939     * @ingroup General
940     */
941    EAPI Eina_Bool    elm_policy_set(unsigned int policy, int value);
942
943    /**
944     * Gets the policy value for given policy identifier.
945     *
946     * @param policy policy identifier, as in #Elm_Policy.
947     * @return The currently set policy value, for that
948     * identifier. Will be @c 0 if @p policy passed is invalid.
949     *
950     * @ingroup General
951     */
952    EAPI int          elm_policy_get(unsigned int policy);
953
954    /**
955     * Change the language of the current application
956     *
957     * The @p lang passed must be the full name of the locale to use, for
958     * example "en_US.utf8" or "es_ES@euro".
959     *
960     * Changing language with this function will make Elementary run through
961     * all its widgets, translating strings set with
962     * elm_object_domain_translatable_text_part_set(). This way, an entire
963     * UI can have its language changed without having to restart the program.
964     *
965     * For more complex cases, like having formatted strings that need
966     * translation, widgets will also emit a "language,changed" signal that
967     * the user can listen to to manually translate the text.
968     *
969     * @param lang Language to set, must be the full name of the locale
970     *
971     * @ingroup General
972     */
973    EAPI void         elm_language_set(const char *lang);
974
975    /**
976     * Set a label of an object
977     *
978     * @param obj The Elementary object
979     * @param part The text part name to set (NULL for the default label)
980     * @param label The new text of the label
981     *
982     * @note Elementary objects may have many labels (e.g. Action Slider)
983     *
984     * @ingroup General
985     */
986    EAPI void         elm_object_text_part_set(Evas_Object *obj, const char *part, const char *label);
987
988 #define elm_object_text_set(obj, label) elm_object_text_part_set((obj), NULL, (label))
989
990    /**
991     * Get a label of an object
992     *
993     * @param obj The Elementary object
994     * @param part The text part name to get (NULL for the default label)
995     * @return text of the label or NULL for any error
996     *
997     * @note Elementary objects may have many labels (e.g. Action Slider)
998     *
999     * @ingroup General
1000     */
1001    EAPI const char  *elm_object_text_part_get(const Evas_Object *obj, const char *part);
1002
1003 #define elm_object_text_get(obj) elm_object_text_part_get((obj), NULL)
1004
1005    /**
1006     * Set the text for an objects' part, marking it as translatable.
1007     *
1008     * The string to set as @p text must be the original one. Do not pass the
1009     * return of @c gettext() here. Elementary will translate the string
1010     * internally and set it on the object using elm_object_text_part_set(),
1011     * also storing the original string so that it can be automatically
1012     * translated when the language is changed with elm_language_set().
1013     *
1014     * The @p domain will be stored along to find the translation in the
1015     * correct catalog. It can be NULL, in which case it will use whatever
1016     * domain was set by the application with @c textdomain(). This is useful
1017     * in case you are building a library on top of Elementary that will have
1018     * its own translatable strings, that should not be mixed with those of
1019     * programs using the library.
1020     *
1021     * @param obj The object containing the text part
1022     * @param part The name of the part to set
1023     * @param domain The translation domain to use
1024     * @param text The original, non-translated text to set
1025     *
1026     * @ingroup General
1027     */
1028    EAPI void         elm_object_domain_translatable_text_part_set(Evas_Object *obj, const char *part, const char *domain, const char *text);
1029
1030 #define elm_object_domain_translatable_text_set(obj, domain, text) elm_object_domain_translatable_text_part_set((obj), NULL, (domain), (text))
1031
1032 #define elm_object_translatable_text_set(obj, text) elm_object_domain_translatable_text_part_set((obj), NULL, NULL, (text))
1033
1034    /**
1035     * Gets the original string set as translatable for an object
1036     *
1037     * When setting translated strings, the function elm_object_text_part_get()
1038     * will return the translation returned by @c gettext(). To get the
1039     * original string use this function.
1040     *
1041     * @param obj The object
1042     * @param part The name of the part that was set
1043     *
1044     * @return The original, untranslated string
1045     *
1046     * @ingroup General
1047     */
1048    EAPI const char  *elm_object_translatable_text_part_get(const Evas_Object *obj, const char *part);
1049
1050 #define elm_object_translatable_text_get(obj) elm_object_translatable_text_part_get((obj), NULL)
1051
1052    /**
1053     * Set a content of an object
1054     *
1055     * @param obj The Elementary object
1056     * @param part The content part name to set (NULL for the default content)
1057     * @param content The new content of the object
1058     *
1059     * @note Elementary objects may have many contents
1060     *
1061     * @ingroup General
1062     */
1063    EAPI void elm_object_content_part_set(Evas_Object *obj, const char *part, Evas_Object *content);
1064
1065 #define elm_object_content_set(obj, content) elm_object_content_part_set((obj), NULL, (content))
1066
1067    /**
1068     * Get a content of an object
1069     *
1070     * @param obj The Elementary object
1071     * @param item The content part name to get (NULL for the default content)
1072     * @return content of the object or NULL for any error
1073     *
1074     * @note Elementary objects may have many contents
1075     *
1076     * @ingroup General
1077     */
1078    EAPI Evas_Object *elm_object_content_part_get(const Evas_Object *obj, const char *part);
1079
1080 #define elm_object_content_get(obj) elm_object_content_part_get((obj), NULL)
1081
1082    /**
1083     * Unset a content of an object
1084     *
1085     * @param obj The Elementary object
1086     * @param item The content part name to unset (NULL for the default content)
1087     *
1088     * @note Elementary objects may have many contents
1089     *
1090     * @ingroup General
1091     */
1092    EAPI Evas_Object *elm_object_content_part_unset(Evas_Object *obj, const char *part);
1093
1094 #define elm_object_content_unset(obj) elm_object_content_part_unset((obj), NULL)
1095
1096    /**
1097     * Get the widget object's handle which contains a given item
1098     *
1099     * @param item The Elementary object item
1100     * @return The widget object
1101     *
1102     * @note This returns the widget object itself that an item belongs to.
1103     *
1104     * @ingroup General
1105     */
1106    EAPI Evas_Object *elm_object_item_object_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
1107
1108    /**
1109     * Set a content of an object item
1110     *
1111     * @param it The Elementary object item
1112     * @param part The content part name to set (NULL for the default content)
1113     * @param content The new content of the object item
1114     *
1115     * @note Elementary object items may have many contents
1116     *
1117     * @ingroup General
1118     */
1119    EAPI void elm_object_item_content_part_set(Elm_Object_Item *it, const char *part, Evas_Object *content);
1120
1121 #define elm_object_item_content_set(it, content) elm_object_item_content_part_set((it), NULL, (content))
1122
1123    /**
1124     * Get a content of an object item
1125     *
1126     * @param it The Elementary object item
1127     * @param part The content part name to unset (NULL for the default content)
1128     * @return content of the object item or NULL for any error
1129     *
1130     * @note Elementary object items may have many contents
1131     *
1132     * @ingroup General
1133     */
1134    EAPI Evas_Object *elm_object_item_content_part_get(const Elm_Object_Item *it, const char *part);
1135
1136 #define elm_object_item_content_get(it) elm_object_item_content_part_get((it), NULL)
1137
1138    /**
1139     * Unset a content of an object item
1140     *
1141     * @param it The Elementary object item
1142     * @param part The content part name to unset (NULL for the default content)
1143     *
1144     * @note Elementary object items may have many contents
1145     *
1146     * @ingroup General
1147     */
1148    EAPI Evas_Object *elm_object_item_content_part_unset(Elm_Object_Item *it, const char *part);
1149
1150 #define elm_object_item_content_unset(it) elm_object_item_content_part_unset((it), NULL)
1151
1152    /**
1153     * Set a label of an object item
1154     *
1155     * @param it The Elementary object item
1156     * @param part The text part name to set (NULL for the default label)
1157     * @param label The new text of the label
1158     *
1159     * @note Elementary object items may have many labels
1160     *
1161     * @ingroup General
1162     */
1163    EAPI void elm_object_item_text_part_set(Elm_Object_Item *it, const char *part, const char *label);
1164
1165 #define elm_object_item_text_set(it, label) elm_object_item_text_part_set((it), NULL, (label))
1166
1167    /**
1168     * Get a label of an object item
1169     *
1170     * @param it The Elementary object item
1171     * @param part The text part name to get (NULL for the default label)
1172     * @return text of the label or NULL for any error
1173     *
1174     * @note Elementary object items may have many labels
1175     *
1176     * @ingroup General
1177     */
1178    EAPI const char *elm_object_item_text_part_get(const Elm_Object_Item *it, const char *part);
1179
1180 #define elm_object_item_text_get(it) elm_object_item_text_part_get((it), NULL)
1181
1182    /**
1183     * Set the text to read out when in accessibility mode
1184     *
1185     * @param obj The object which is to be described
1186     * @param txt The text that describes the widget to people with poor or no vision
1187     *
1188     * @ingroup General
1189     */
1190    EAPI void elm_object_access_info_set(Evas_Object *obj, const char *txt);
1191
1192    /**
1193     * Set the text to read out when in accessibility mode
1194     *
1195     * @param it The object item which is to be described
1196     * @param txt The text that describes the widget to people with poor or no vision
1197     *
1198     * @ingroup General
1199     */
1200    EAPI void elm_object_item_access_info_set(Elm_Object_Item *it, const char *txt);
1201
1202    /**
1203     * Get the data associated with an object item
1204     * @param it The object item
1205     * @return The data associated with @p it
1206     *
1207     * @ingroup General
1208     */
1209    EAPI void *elm_object_item_data_get(const Elm_Object_Item *it);
1210
1211    /**
1212     * Set the data associated with an object item
1213     * @param it The object item
1214     * @param data The data to be associated with @p it
1215     *
1216     * @ingroup General
1217     */
1218    EAPI void elm_object_item_data_set(Elm_Object_Item *it, void *data);
1219
1220    /**
1221     * Send a signal to the edje object of the widget item.
1222     *
1223     * This function sends a signal to the edje object of the obj item. An
1224     * edje program can respond to a signal by specifying matching
1225     * 'signal' and 'source' fields.
1226     *
1227     * @param it The Elementary object item
1228     * @param emission The signal's name.
1229     * @param source The signal's source.
1230     * @ingroup General
1231     */
1232    EAPI void             elm_object_item_signal_emit(Elm_Object_Item *it, const char *emission, const char *source) EINA_ARG_NONNULL(1);
1233
1234    /**
1235     * @}
1236     */
1237
1238    /**
1239     * @defgroup Caches Caches
1240     *
1241     * These are functions which let one fine-tune some cache values for
1242     * Elementary applications, thus allowing for performance adjustments.
1243     *
1244     * @{
1245     */
1246
1247    /**
1248     * @brief Flush all caches.
1249     *
1250     * Frees all data that was in cache and is not currently being used to reduce
1251     * memory usage. This frees Edje's, Evas' and Eet's cache. This is equivalent
1252     * to calling all of the following functions:
1253     * @li edje_file_cache_flush()
1254     * @li edje_collection_cache_flush()
1255     * @li eet_clearcache()
1256     * @li evas_image_cache_flush()
1257     * @li evas_font_cache_flush()
1258     * @li evas_render_dump()
1259     * @note Evas caches are flushed for every canvas associated with a window.
1260     *
1261     * @ingroup Caches
1262     */
1263    EAPI void         elm_all_flush(void);
1264
1265    /**
1266     * Get the configured cache flush interval time
1267     *
1268     * This gets the globally configured cache flush interval time, in
1269     * ticks
1270     *
1271     * @return The cache flush interval time
1272     * @ingroup Caches
1273     *
1274     * @see elm_all_flush()
1275     */
1276    EAPI int          elm_cache_flush_interval_get(void);
1277
1278    /**
1279     * Set the configured cache flush interval time
1280     *
1281     * This sets the globally configured cache flush interval time, in ticks
1282     *
1283     * @param size The cache flush interval time
1284     * @ingroup Caches
1285     *
1286     * @see elm_all_flush()
1287     */
1288    EAPI void         elm_cache_flush_interval_set(int size);
1289
1290    /**
1291     * Set the configured cache flush interval time for all applications on the
1292     * display
1293     *
1294     * This sets the globally configured cache flush interval time -- in ticks
1295     * -- for all applications on the display.
1296     *
1297     * @param size The cache flush interval time
1298     * @ingroup Caches
1299     */
1300    EAPI void         elm_cache_flush_interval_all_set(int size);
1301
1302    /**
1303     * Get the configured cache flush enabled state
1304     *
1305     * This gets the globally configured cache flush state - if it is enabled
1306     * or not. When cache flushing is enabled, elementary will regularly
1307     * (see elm_cache_flush_interval_get() ) flush caches and dump data out of
1308     * memory and allow usage to re-seed caches and data in memory where it
1309     * can do so. An idle application will thus minimise its memory usage as
1310     * data will be freed from memory and not be re-loaded as it is idle and
1311     * not rendering or doing anything graphically right now.
1312     *
1313     * @return The cache flush state
1314     * @ingroup Caches
1315     *
1316     * @see elm_all_flush()
1317     */
1318    EAPI Eina_Bool    elm_cache_flush_enabled_get(void);
1319
1320    /**
1321     * Set the configured cache flush enabled state
1322     *
1323     * This sets the globally configured cache flush enabled state.
1324     *
1325     * @param size The cache flush enabled state
1326     * @ingroup Caches
1327     *
1328     * @see elm_all_flush()
1329     */
1330    EAPI void         elm_cache_flush_enabled_set(Eina_Bool enabled);
1331
1332    /**
1333     * Set the configured cache flush enabled state for all applications on the
1334     * display
1335     *
1336     * This sets the globally configured cache flush enabled state for all
1337     * applications on the display.
1338     *
1339     * @param size The cache flush enabled state
1340     * @ingroup Caches
1341     */
1342    EAPI void         elm_cache_flush_enabled_all_set(Eina_Bool enabled);
1343
1344    /**
1345     * Get the configured font cache size
1346     *
1347     * This gets the globally configured font cache size, in bytes.
1348     *
1349     * @return The font cache size
1350     * @ingroup Caches
1351     */
1352    EAPI int          elm_font_cache_get(void);
1353
1354    /**
1355     * Set the configured font cache size
1356     *
1357     * This sets the globally configured font cache size, in bytes
1358     *
1359     * @param size The font cache size
1360     * @ingroup Caches
1361     */
1362    EAPI void         elm_font_cache_set(int size);
1363
1364    /**
1365     * Set the configured font cache size for all applications on the
1366     * display
1367     *
1368     * This sets the globally configured font cache size -- in bytes
1369     * -- for all applications on the display.
1370     *
1371     * @param size The font cache size
1372     * @ingroup Caches
1373     */
1374    EAPI void         elm_font_cache_all_set(int size);
1375
1376    /**
1377     * Get the configured image cache size
1378     *
1379     * This gets the globally configured image cache size, in bytes
1380     *
1381     * @return The image cache size
1382     * @ingroup Caches
1383     */
1384    EAPI int          elm_image_cache_get(void);
1385
1386    /**
1387     * Set the configured image cache size
1388     *
1389     * This sets the globally configured image cache size, in bytes
1390     *
1391     * @param size The image cache size
1392     * @ingroup Caches
1393     */
1394    EAPI void         elm_image_cache_set(int size);
1395
1396    /**
1397     * Set the configured image cache size for all applications on the
1398     * display
1399     *
1400     * This sets the globally configured image cache size -- in bytes
1401     * -- for all applications on the display.
1402     *
1403     * @param size The image cache size
1404     * @ingroup Caches
1405     */
1406    EAPI void         elm_image_cache_all_set(int size);
1407
1408    /**
1409     * Get the configured edje file cache size.
1410     *
1411     * This gets the globally configured edje file cache size, in number
1412     * of files.
1413     *
1414     * @return The edje file cache size
1415     * @ingroup Caches
1416     */
1417    EAPI int          elm_edje_file_cache_get(void);
1418
1419    /**
1420     * Set the configured edje file cache size
1421     *
1422     * This sets the globally configured edje file cache size, in number
1423     * of files.
1424     *
1425     * @param size The edje file cache size
1426     * @ingroup Caches
1427     */
1428    EAPI void         elm_edje_file_cache_set(int size);
1429
1430    /**
1431     * Set the configured edje file cache size for all applications on the
1432     * display
1433     *
1434     * This sets the globally configured edje file cache size -- in number
1435     * of files -- for all applications on the display.
1436     *
1437     * @param size The edje file cache size
1438     * @ingroup Caches
1439     */
1440    EAPI void         elm_edje_file_cache_all_set(int size);
1441
1442    /**
1443     * Get the configured edje collections (groups) cache size.
1444     *
1445     * This gets the globally configured edje collections cache size, in
1446     * number of collections.
1447     *
1448     * @return The edje collections cache size
1449     * @ingroup Caches
1450     */
1451    EAPI int          elm_edje_collection_cache_get(void);
1452
1453    /**
1454     * Set the configured edje collections (groups) cache size
1455     *
1456     * This sets the globally configured edje collections cache size, in
1457     * number of collections.
1458     *
1459     * @param size The edje collections cache size
1460     * @ingroup Caches
1461     */
1462    EAPI void         elm_edje_collection_cache_set(int size);
1463
1464    /**
1465     * Set the configured edje collections (groups) cache size for all
1466     * applications on the display
1467     *
1468     * This sets the globally configured edje collections cache size -- in
1469     * number of collections -- for all applications on the display.
1470     *
1471     * @param size The edje collections cache size
1472     * @ingroup Caches
1473     */
1474    EAPI void         elm_edje_collection_cache_all_set(int size);
1475
1476    /**
1477     * @}
1478     */
1479
1480    /**
1481     * @defgroup Scaling Widget Scaling
1482     *
1483     * Different widgets can be scaled independently. These functions
1484     * allow you to manipulate this scaling on a per-widget basis. The
1485     * object and all its children get their scaling factors multiplied
1486     * by the scale factor set. This is multiplicative, in that if a
1487     * child also has a scale size set it is in turn multiplied by its
1488     * parent's scale size. @c 1.0 means ā€œdon't scaleā€, @c 2.0 is
1489     * double size, @c 0.5 is half, etc.
1490     *
1491     * @ref general_functions_example_page "This" example contemplates
1492     * some of these functions.
1493     */
1494
1495    /**
1496     * Get the global scaling factor
1497     *
1498     * This gets the globally configured scaling factor that is applied to all
1499     * objects.
1500     *
1501     * @return The scaling factor
1502     * @ingroup Scaling
1503     */
1504    EAPI double       elm_scale_get(void);
1505
1506    /**
1507     * Set the global scaling factor
1508     *
1509     * This sets the globally configured scaling factor that is applied to all
1510     * objects.
1511     *
1512     * @param scale The scaling factor to set
1513     * @ingroup Scaling
1514     */
1515    EAPI void         elm_scale_set(double scale);
1516
1517    /**
1518     * Set the global scaling factor for all applications on the display
1519     *
1520     * This sets the globally configured scaling factor that is applied to all
1521     * objects for all applications.
1522     * @param scale The scaling factor to set
1523     * @ingroup Scaling
1524     */
1525    EAPI void         elm_scale_all_set(double scale);
1526
1527    /**
1528     * Set the scaling factor for a given Elementary object
1529     *
1530     * @param obj The Elementary to operate on
1531     * @param scale Scale factor (from @c 0.0 up, with @c 1.0 meaning
1532     * no scaling)
1533     *
1534     * @ingroup Scaling
1535     */
1536    EAPI void         elm_object_scale_set(Evas_Object *obj, double scale) EINA_ARG_NONNULL(1);
1537
1538    /**
1539     * Get the scaling factor for a given Elementary object
1540     *
1541     * @param obj The object
1542     * @return The scaling factor set by elm_object_scale_set()
1543     *
1544     * @ingroup Scaling
1545     */
1546    EAPI double       elm_object_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1547
1548    /**
1549     * @defgroup Password_last_show Password last input show
1550     *
1551     * Last show feature of password mode enables user to view
1552     * the last input entered for few seconds before masking it.
1553     * These functions allow to set this feature in password mode
1554     * of entry widget and also allow to manipulate the duration
1555     * for which the input has to be visible.
1556     *
1557     * @{
1558     */
1559
1560    /**
1561     * Get show last setting of password mode.
1562     *
1563     * This gets the show last input setting of password mode which might be
1564     * enabled or disabled.
1565     *
1566     * @return @c EINA_TRUE, if the last input show setting is enabled, @c EINA_FALSE
1567     *            if it's disabled.
1568     * @ingroup Password_last_show
1569     */
1570    EAPI Eina_Bool elm_password_show_last_get(void);
1571
1572    /**
1573     * Set show last setting in password mode.
1574     *
1575     * This enables or disables show last setting of password mode.
1576     *
1577     * @param password_show_last If EINA_TRUE enable's last input show in password mode.
1578     * @see elm_password_show_last_timeout_set()
1579     * @ingroup Password_last_show
1580     */
1581    EAPI void elm_password_show_last_set(Eina_Bool password_show_last);
1582
1583    /**
1584     * Get's the timeout value in last show password mode.
1585     *
1586     * This gets the time out value for which the last input entered in password
1587     * mode will be visible.
1588     *
1589     * @return The timeout value of last show password mode.
1590     * @ingroup Password_last_show
1591     */
1592    EAPI double elm_password_show_last_timeout_get(void);
1593
1594    /**
1595     * Set's the timeout value in last show password mode.
1596     *
1597     * This sets the time out value for which the last input entered in password
1598     * mode will be visible.
1599     *
1600     * @param password_show_last_timeout The timeout value.
1601     * @see elm_password_show_last_set()
1602     * @ingroup Password_last_show
1603     */
1604    EAPI void elm_password_show_last_timeout_set(double password_show_last_timeout);
1605
1606    /**
1607     * @}
1608     */
1609
1610    /**
1611     * @defgroup UI-Mirroring Selective Widget mirroring
1612     *
1613     * These functions allow you to set ui-mirroring on specific
1614     * widgets or the whole interface. Widgets can be in one of two
1615     * modes, automatic and manual.  Automatic means they'll be changed
1616     * according to the system mirroring mode and manual means only
1617     * explicit changes will matter. You are not supposed to change
1618     * mirroring state of a widget set to automatic, will mostly work,
1619     * but the behavior is not really defined.
1620     *
1621     * @{
1622     */
1623
1624    EAPI Eina_Bool    elm_mirrored_get(void);
1625    EAPI void         elm_mirrored_set(Eina_Bool mirrored);
1626
1627    /**
1628     * Get the system mirrored mode. This determines the default mirrored mode
1629     * of widgets.
1630     *
1631     * @return EINA_TRUE if mirrored is set, EINA_FALSE otherwise
1632     */
1633    EAPI Eina_Bool    elm_object_mirrored_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1634
1635    /**
1636     * Set the system mirrored mode. This determines the default mirrored mode
1637     * of widgets.
1638     *
1639     * @param mirrored EINA_TRUE to set mirrored mode, EINA_FALSE to unset it.
1640     */
1641    EAPI void         elm_object_mirrored_set(Evas_Object *obj, Eina_Bool mirrored) EINA_ARG_NONNULL(1);
1642
1643    /**
1644     * Returns the widget's mirrored mode setting.
1645     *
1646     * @param obj The widget.
1647     * @return mirrored mode setting of the object.
1648     *
1649     **/
1650    EAPI Eina_Bool    elm_object_mirrored_automatic_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1651
1652    /**
1653     * Sets the widget's mirrored mode setting.
1654     * When widget in automatic mode, it follows the system mirrored mode set by
1655     * elm_mirrored_set().
1656     * @param obj The widget.
1657     * @param automatic EINA_TRUE for auto mirrored mode. EINA_FALSE for manual.
1658     */
1659    EAPI void         elm_object_mirrored_automatic_set(Evas_Object *obj, Eina_Bool automatic) EINA_ARG_NONNULL(1);
1660
1661    /**
1662     * @}
1663     */
1664
1665    /**
1666     * Set the style to use by a widget
1667     *
1668     * Sets the style name that will define the appearance of a widget. Styles
1669     * vary from widget to widget and may also be defined by other themes
1670     * by means of extensions and overlays.
1671     *
1672     * @param obj The Elementary widget to style
1673     * @param style The style name to use
1674     *
1675     * @see elm_theme_extension_add()
1676     * @see elm_theme_extension_del()
1677     * @see elm_theme_overlay_add()
1678     * @see elm_theme_overlay_del()
1679     *
1680     * @ingroup Styles
1681     */
1682    EAPI void         elm_object_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
1683    /**
1684     * Get the style used by the widget
1685     *
1686     * This gets the style being used for that widget. Note that the string
1687     * pointer is only valid as longas the object is valid and the style doesn't
1688     * change.
1689     *
1690     * @param obj The Elementary widget to query for its style
1691     * @return The style name used
1692     *
1693     * @see elm_object_style_set()
1694     *
1695     * @ingroup Styles
1696     */
1697    EAPI const char  *elm_object_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1698
1699    /**
1700     * @defgroup Styles Styles
1701     *
1702     * Widgets can have different styles of look. These generic API's
1703     * set styles of widgets, if they support them (and if the theme(s)
1704     * do).
1705     *
1706     * @ref general_functions_example_page "This" example contemplates
1707     * some of these functions.
1708     */
1709
1710    /**
1711     * Set the disabled state of an Elementary object.
1712     *
1713     * @param obj The Elementary object to operate on
1714     * @param disabled The state to put in in: @c EINA_TRUE for
1715     *        disabled, @c EINA_FALSE for enabled
1716     *
1717     * Elementary objects can be @b disabled, in which state they won't
1718     * receive input and, in general, will be themed differently from
1719     * their normal state, usually greyed out. Useful for contexts
1720     * where you don't want your users to interact with some of the
1721     * parts of you interface.
1722     *
1723     * This sets the state for the widget, either disabling it or
1724     * enabling it back.
1725     *
1726     * @ingroup Styles
1727     */
1728    EAPI void         elm_object_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
1729
1730    /**
1731     * Get the disabled state of an Elementary object.
1732     *
1733     * @param obj The Elementary object to operate on
1734     * @return @c EINA_TRUE, if the widget is disabled, @c EINA_FALSE
1735     *            if it's enabled (or on errors)
1736     *
1737     * This gets the state of the widget, which might be enabled or disabled.
1738     *
1739     * @ingroup Styles
1740     */
1741    EAPI Eina_Bool    elm_object_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1742
1743    /**
1744     * @defgroup WidgetNavigation Widget Tree Navigation.
1745     *
1746     * How to check if an Evas Object is an Elementary widget? How to
1747     * get the first elementary widget that is parent of the given
1748     * object?  These are all covered in widget tree navigation.
1749     *
1750     * @ref general_functions_example_page "This" example contemplates
1751     * some of these functions.
1752     */
1753
1754    /**
1755     * Check if the given Evas Object is an Elementary widget.
1756     *
1757     * @param obj the object to query.
1758     * @return @c EINA_TRUE if it is an elementary widget variant,
1759     *         @c EINA_FALSE otherwise
1760     * @ingroup WidgetNavigation
1761     */
1762    EAPI Eina_Bool    elm_object_widget_check(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1763
1764    /**
1765     * Get the first parent of the given object that is an Elementary
1766     * widget.
1767     *
1768     * @param obj the Elementary object to query parent from.
1769     * @return the parent object that is an Elementary widget, or @c
1770     *         NULL, if it was not found.
1771     *
1772     * Use this to query for an object's parent widget.
1773     *
1774     * @note Most of Elementary users wouldn't be mixing non-Elementary
1775     * smart objects in the objects tree of an application, as this is
1776     * an advanced usage of Elementary with Evas. So, except for the
1777     * application's window, which is the root of that tree, all other
1778     * objects would have valid Elementary widget parents.
1779     *
1780     * @ingroup WidgetNavigation
1781     */
1782    EAPI Evas_Object *elm_object_parent_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1783
1784    /**
1785     * Get the top level parent of an Elementary widget.
1786     *
1787     * @param obj The object to query.
1788     * @return The top level Elementary widget, or @c NULL if parent cannot be
1789     * found.
1790     * @ingroup WidgetNavigation
1791     */
1792    EAPI Evas_Object *elm_object_top_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1793
1794    /**
1795     * Get the string that represents this Elementary widget.
1796     *
1797     * @note Elementary is weird and exposes itself as a single
1798     *       Evas_Object_Smart_Class of type "elm_widget", so
1799     *       evas_object_type_get() always return that, making debug and
1800     *       language bindings hard. This function tries to mitigate this
1801     *       problem, but the solution is to change Elementary to use
1802     *       proper inheritance.
1803     *
1804     * @param obj the object to query.
1805     * @return Elementary widget name, or @c NULL if not a valid widget.
1806     * @ingroup WidgetNavigation
1807     */
1808    EAPI const char  *elm_object_widget_type_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1809
1810    /**
1811     * @defgroup Config Elementary Config
1812     *
1813     * Elementary configuration is formed by a set options bounded to a
1814     * given @ref Profile profile, like @ref Theme theme, @ref Fingers
1815     * "finger size", etc. These are functions with which one syncronizes
1816     * changes made to those values to the configuration storing files, de
1817     * facto. You most probably don't want to use the functions in this
1818     * group unlees you're writing an elementary configuration manager.
1819     *
1820     * @{
1821     */
1822
1823    /**
1824     * Save back Elementary's configuration, so that it will persist on
1825     * future sessions.
1826     *
1827     * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
1828     * @ingroup Config
1829     *
1830     * This function will take effect -- thus, do I/O -- immediately. Use
1831     * it when you want to apply all configuration changes at once. The
1832     * current configuration set will get saved onto the current profile
1833     * configuration file.
1834     *
1835     */
1836    EAPI Eina_Bool    elm_config_save(void);
1837
1838    /**
1839     * Reload Elementary's configuration, bounded to current selected
1840     * profile.
1841     *
1842     * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
1843     * @ingroup Config
1844     *
1845     * Useful when you want to force reloading of configuration values for
1846     * a profile. If one removes user custom configuration directories,
1847     * for example, it will force a reload with system values insted.
1848     *
1849     */
1850    EAPI void         elm_config_reload(void);
1851
1852    /**
1853     * @}
1854     */
1855
1856    /**
1857     * @defgroup Profile Elementary Profile
1858     *
1859     * Profiles are pre-set options that affect the whole look-and-feel of
1860     * Elementary-based applications. There are, for example, profiles
1861     * aimed at desktop computer applications and others aimed at mobile,
1862     * touchscreen-based ones. You most probably don't want to use the
1863     * functions in this group unlees you're writing an elementary
1864     * configuration manager.
1865     *
1866     * @{
1867     */
1868
1869    /**
1870     * Get Elementary's profile in use.
1871     *
1872     * This gets the global profile that is applied to all Elementary
1873     * applications.
1874     *
1875     * @return The profile's name
1876     * @ingroup Profile
1877     */
1878    EAPI const char  *elm_profile_current_get(void);
1879
1880    /**
1881     * Get an Elementary's profile directory path in the filesystem. One
1882     * may want to fetch a system profile's dir or an user one (fetched
1883     * inside $HOME).
1884     *
1885     * @param profile The profile's name
1886     * @param is_user Whether to lookup for an user profile (@c EINA_TRUE)
1887     *                or a system one (@c EINA_FALSE)
1888     * @return The profile's directory path.
1889     * @ingroup Profile
1890     *
1891     * @note You must free it with elm_profile_dir_free().
1892     */
1893    EAPI const char  *elm_profile_dir_get(const char *profile, Eina_Bool is_user);
1894
1895    /**
1896     * Free an Elementary's profile directory path, as returned by
1897     * elm_profile_dir_get().
1898     *
1899     * @param p_dir The profile's path
1900     * @ingroup Profile
1901     *
1902     */
1903    EAPI void         elm_profile_dir_free(const char *p_dir);
1904
1905    /**
1906     * Get Elementary's list of available profiles.
1907     *
1908     * @return The profiles list. List node data are the profile name
1909     *         strings.
1910     * @ingroup Profile
1911     *
1912     * @note One must free this list, after usage, with the function
1913     *       elm_profile_list_free().
1914     */
1915    EAPI Eina_List   *elm_profile_list_get(void);
1916
1917    /**
1918     * Free Elementary's list of available profiles.
1919     *
1920     * @param l The profiles list, as returned by elm_profile_list_get().
1921     * @ingroup Profile
1922     *
1923     */
1924    EAPI void         elm_profile_list_free(Eina_List *l);
1925
1926    /**
1927     * Set Elementary's profile.
1928     *
1929     * This sets the global profile that is applied to Elementary
1930     * applications. Just the process the call comes from will be
1931     * affected.
1932     *
1933     * @param profile The profile's name
1934     * @ingroup Profile
1935     *
1936     */
1937    EAPI void         elm_profile_set(const char *profile);
1938
1939    /**
1940     * Set Elementary's profile.
1941     *
1942     * This sets the global profile that is applied to all Elementary
1943     * applications. All running Elementary windows will be affected.
1944     *
1945     * @param profile The profile's name
1946     * @ingroup Profile
1947     *
1948     */
1949    EAPI void         elm_profile_all_set(const char *profile);
1950
1951    /**
1952     * @}
1953     */
1954
1955    /**
1956     * @defgroup Engine Elementary Engine
1957     *
1958     * These are functions setting and querying which rendering engine
1959     * Elementary will use for drawing its windows' pixels.
1960     *
1961     * The following are the available engines:
1962     * @li "software_x11"
1963     * @li "fb"
1964     * @li "directfb"
1965     * @li "software_16_x11"
1966     * @li "software_8_x11"
1967     * @li "xrender_x11"
1968     * @li "opengl_x11"
1969     * @li "software_gdi"
1970     * @li "software_16_wince_gdi"
1971     * @li "sdl"
1972     * @li "software_16_sdl"
1973     * @li "opengl_sdl"
1974     * @li "buffer"
1975     * @li "ews"
1976     * @li "opengl_cocoa"
1977     *
1978     * @{
1979     */
1980
1981    /**
1982     * @brief Get Elementary's rendering engine in use.
1983     *
1984     * @return The rendering engine's name
1985     * @note there's no need to free the returned string, here.
1986     *
1987     * This gets the global rendering engine that is applied to all Elementary
1988     * applications.
1989     *
1990     * @see elm_engine_set()
1991     */
1992    EAPI const char  *elm_engine_current_get(void);
1993
1994    /**
1995     * @brief Set Elementary's rendering engine for use.
1996     *
1997     * @param engine The rendering engine's name
1998     *
1999     * This sets global rendering engine that is applied to all Elementary
2000     * applications. Note that it will take effect only to Elementary windows
2001     * created after this is called.
2002     *
2003     * @see elm_win_add()
2004     */
2005    EAPI void         elm_engine_set(const char *engine);
2006
2007    /**
2008     * @}
2009     */
2010
2011    /**
2012     * @defgroup Fonts Elementary Fonts
2013     *
2014     * These are functions dealing with font rendering, selection and the
2015     * like for Elementary applications. One might fetch which system
2016     * fonts are there to use and set custom fonts for individual classes
2017     * of UI items containing text (text classes).
2018     *
2019     * @{
2020     */
2021
2022   typedef struct _Elm_Text_Class
2023     {
2024        const char *name;
2025        const char *desc;
2026     } Elm_Text_Class;
2027
2028   typedef struct _Elm_Font_Overlay
2029     {
2030        const char     *text_class;
2031        const char     *font;
2032        Evas_Font_Size  size;
2033     } Elm_Font_Overlay;
2034
2035   typedef struct _Elm_Font_Properties
2036     {
2037        const char *name;
2038        Eina_List  *styles;
2039     } Elm_Font_Properties;
2040
2041    /**
2042     * Get Elementary's list of supported text classes.
2043     *
2044     * @return The text classes list, with @c Elm_Text_Class blobs as data.
2045     * @ingroup Fonts
2046     *
2047     * Release the list with elm_text_classes_list_free().
2048     */
2049    EAPI const Eina_List     *elm_text_classes_list_get(void);
2050
2051    /**
2052     * Free Elementary's list of supported text classes.
2053     *
2054     * @ingroup Fonts
2055     *
2056     * @see elm_text_classes_list_get().
2057     */
2058    EAPI void                 elm_text_classes_list_free(const Eina_List *list);
2059
2060    /**
2061     * Get Elementary's list of font overlays, set with
2062     * elm_font_overlay_set().
2063     *
2064     * @return The font overlays list, with @c Elm_Font_Overlay blobs as
2065     * data.
2066     *
2067     * @ingroup Fonts
2068     *
2069     * For each text class, one can set a <b>font overlay</b> for it,
2070     * overriding the default font properties for that class coming from
2071     * the theme in use. There is no need to free this list.
2072     *
2073     * @see elm_font_overlay_set() and elm_font_overlay_unset().
2074     */
2075    EAPI const Eina_List     *elm_font_overlay_list_get(void);
2076
2077    /**
2078     * Set a font overlay for a given Elementary text class.
2079     *
2080     * @param text_class Text class name
2081     * @param font Font name and style string
2082     * @param size Font size
2083     *
2084     * @ingroup Fonts
2085     *
2086     * @p font has to be in the format returned by
2087     * elm_font_fontconfig_name_get(). @see elm_font_overlay_list_get()
2088     * and elm_font_overlay_unset().
2089     */
2090    EAPI void                 elm_font_overlay_set(const char *text_class, const char *font, Evas_Font_Size size);
2091
2092    /**
2093     * Unset a font overlay for a given Elementary text class.
2094     *
2095     * @param text_class Text class name
2096     *
2097     * @ingroup Fonts
2098     *
2099     * This will bring back text elements belonging to text class
2100     * @p text_class back to their default font settings.
2101     */
2102    EAPI void                 elm_font_overlay_unset(const char *text_class);
2103
2104    /**
2105     * Apply the changes made with elm_font_overlay_set() and
2106     * elm_font_overlay_unset() on the current Elementary window.
2107     *
2108     * @ingroup Fonts
2109     *
2110     * This applies all font overlays set to all objects in the UI.
2111     */
2112    EAPI void                 elm_font_overlay_apply(void);
2113
2114    /**
2115     * Apply the changes made with elm_font_overlay_set() and
2116     * elm_font_overlay_unset() on all Elementary application windows.
2117     *
2118     * @ingroup Fonts
2119     *
2120     * This applies all font overlays set to all objects in the UI.
2121     */
2122    EAPI void                 elm_font_overlay_all_apply(void);
2123
2124    /**
2125     * Translate a font (family) name string in fontconfig's font names
2126     * syntax into an @c Elm_Font_Properties struct.
2127     *
2128     * @param font The font name and styles string
2129     * @return the font properties struct
2130     *
2131     * @ingroup Fonts
2132     *
2133     * @note The reverse translation can be achived with
2134     * elm_font_fontconfig_name_get(), for one style only (single font
2135     * instance, not family).
2136     */
2137    EAPI Elm_Font_Properties *elm_font_properties_get(const char *font) EINA_ARG_NONNULL(1);
2138
2139    /**
2140     * Free font properties return by elm_font_properties_get().
2141     *
2142     * @param efp the font properties struct
2143     *
2144     * @ingroup Fonts
2145     */
2146    EAPI void                 elm_font_properties_free(Elm_Font_Properties *efp) EINA_ARG_NONNULL(1);
2147
2148    /**
2149     * Translate a font name, bound to a style, into fontconfig's font names
2150     * syntax.
2151     *
2152     * @param name The font (family) name
2153     * @param style The given style (may be @c NULL)
2154     *
2155     * @return the font name and style string
2156     *
2157     * @ingroup Fonts
2158     *
2159     * @note The reverse translation can be achived with
2160     * elm_font_properties_get(), for one style only (single font
2161     * instance, not family).
2162     */
2163    EAPI const char          *elm_font_fontconfig_name_get(const char *name, const char *style) EINA_ARG_NONNULL(1);
2164
2165    /**
2166     * Free the font string return by elm_font_fontconfig_name_get().
2167     *
2168     * @param efp the font properties struct
2169     *
2170     * @ingroup Fonts
2171     */
2172    EAPI void                 elm_font_fontconfig_name_free(const char *name) EINA_ARG_NONNULL(1);
2173
2174    /**
2175     * Create a font hash table of available system fonts.
2176     *
2177     * One must call it with @p list being the return value of
2178     * evas_font_available_list(). The hash will be indexed by font
2179     * (family) names, being its values @c Elm_Font_Properties blobs.
2180     *
2181     * @param list The list of available system fonts, as returned by
2182     * evas_font_available_list().
2183     * @return the font hash.
2184     *
2185     * @ingroup Fonts
2186     *
2187     * @note The user is supposed to get it populated at least with 3
2188     * default font families (Sans, Serif, Monospace), which should be
2189     * present on most systems.
2190     */
2191    EAPI Eina_Hash           *elm_font_available_hash_add(Eina_List *list);
2192
2193    /**
2194     * Free the hash return by elm_font_available_hash_add().
2195     *
2196     * @param hash the hash to be freed.
2197     *
2198     * @ingroup Fonts
2199     */
2200    EAPI void                 elm_font_available_hash_del(Eina_Hash *hash);
2201
2202    /**
2203     * @}
2204     */
2205
2206    /**
2207     * @defgroup Fingers Fingers
2208     *
2209     * Elementary is designed to be finger-friendly for touchscreens,
2210     * and so in addition to scaling for display resolution, it can
2211     * also scale based on finger "resolution" (or size). You can then
2212     * customize the granularity of the areas meant to receive clicks
2213     * on touchscreens.
2214     *
2215     * Different profiles may have pre-set values for finger sizes.
2216     *
2217     * @ref general_functions_example_page "This" example contemplates
2218     * some of these functions.
2219     *
2220     * @{
2221     */
2222
2223    /**
2224     * Get the configured "finger size"
2225     *
2226     * @return The finger size
2227     *
2228     * This gets the globally configured finger size, <b>in pixels</b>
2229     *
2230     * @ingroup Fingers
2231     */
2232    EAPI Evas_Coord       elm_finger_size_get(void);
2233
2234    /**
2235     * Set the configured finger size
2236     *
2237     * This sets the globally configured finger size in pixels
2238     *
2239     * @param size The finger size
2240     * @ingroup Fingers
2241     */
2242    EAPI void             elm_finger_size_set(Evas_Coord size);
2243
2244    /**
2245     * Set the configured finger size for all applications on the display
2246     *
2247     * This sets the globally configured finger size in pixels for all
2248     * applications on the display
2249     *
2250     * @param size The finger size
2251     * @ingroup Fingers
2252     */
2253    EAPI void             elm_finger_size_all_set(Evas_Coord size);
2254
2255    /**
2256     * @}
2257     */
2258
2259    /**
2260     * @defgroup Focus Focus
2261     *
2262     * An Elementary application has, at all times, one (and only one)
2263     * @b focused object. This is what determines where the input
2264     * events go to within the application's window. Also, focused
2265     * objects can be decorated differently, in order to signal to the
2266     * user where the input is, at a given moment.
2267     *
2268     * Elementary applications also have the concept of <b>focus
2269     * chain</b>: one can cycle through all the windows' focusable
2270     * objects by input (tab key) or programmatically. The default
2271     * focus chain for an application is the one define by the order in
2272     * which the widgets where added in code. One will cycle through
2273     * top level widgets, and, for each one containg sub-objects, cycle
2274     * through them all, before returning to the level
2275     * above. Elementary also allows one to set @b custom focus chains
2276     * for their applications.
2277     *
2278     * Besides the focused decoration a widget may exhibit, when it
2279     * gets focus, Elementary has a @b global focus highlight object
2280     * that can be enabled for a window. If one chooses to do so, this
2281     * extra highlight effect will surround the current focused object,
2282     * too.
2283     *
2284     * @note Some Elementary widgets are @b unfocusable, after
2285     * creation, by their very nature: they are not meant to be
2286     * interacted with input events, but are there just for visual
2287     * purposes.
2288     *
2289     * @ref general_functions_example_page "This" example contemplates
2290     * some of these functions.
2291     */
2292
2293    /**
2294     * Get the enable status of the focus highlight
2295     *
2296     * This gets whether the highlight on focused objects is enabled or not
2297     * @ingroup Focus
2298     */
2299    EAPI Eina_Bool        elm_focus_highlight_enabled_get(void);
2300
2301    /**
2302     * Set the enable status of the focus highlight
2303     *
2304     * Set whether to show or not the highlight on focused objects
2305     * @param enable Enable highlight if EINA_TRUE, disable otherwise
2306     * @ingroup Focus
2307     */
2308    EAPI void             elm_focus_highlight_enabled_set(Eina_Bool enable);
2309
2310    /**
2311     * Get the enable status of the highlight animation
2312     *
2313     * Get whether the focus highlight, if enabled, will animate its switch from
2314     * one object to the next
2315     * @ingroup Focus
2316     */
2317    EAPI Eina_Bool        elm_focus_highlight_animate_get(void);
2318
2319    /**
2320     * Set the enable status of the highlight animation
2321     *
2322     * Set whether the focus highlight, if enabled, will animate its switch from
2323     * one object to the next
2324     * @param animate Enable animation if EINA_TRUE, disable otherwise
2325     * @ingroup Focus
2326     */
2327    EAPI void             elm_focus_highlight_animate_set(Eina_Bool animate);
2328
2329    /**
2330     * Get the whether an Elementary object has the focus or not.
2331     *
2332     * @param obj The Elementary object to get the information from
2333     * @return @c EINA_TRUE, if the object is focused, @c EINA_FALSE if
2334     *            not (and on errors).
2335     *
2336     * @see elm_object_focus_set()
2337     *
2338     * @ingroup Focus
2339     */
2340    EAPI Eina_Bool        elm_object_focus_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2341
2342    /**
2343     * Set/unset focus to a given Elementary object.
2344     *
2345     * @param obj The Elementary object to operate on.
2346     * @param enable @c EINA_TRUE Set focus to a given object,
2347     *               @c EINA_FALSE Unset focus to a given object.
2348     *
2349     * @note When you set focus to this object, if it can handle focus, will
2350     * take the focus away from the one who had it previously and will, for
2351     * now on, be the one receiving input events. Unsetting focus will remove
2352     * the focus from @p obj, passing it back to the previous element in the
2353     * focus chain list.
2354     *
2355     * @see elm_object_focus_get(), elm_object_focus_custom_chain_get()
2356     *
2357     * @ingroup Focus
2358     */
2359    EAPI void             elm_object_focus_set(Evas_Object *obj, Eina_Bool focus) EINA_ARG_NONNULL(1);
2360
2361    /**
2362     * Make a given Elementary object the focused one.
2363     *
2364     * @param obj The Elementary object to make focused.
2365     *
2366     * @note This object, if it can handle focus, will take the focus
2367     * away from the one who had it previously and will, for now on, be
2368     * the one receiving input events.
2369     *
2370     * @see elm_object_focus_get()
2371     * @deprecated use elm_object_focus_set() instead.
2372     *
2373     * @ingroup Focus
2374     */
2375    EINA_DEPRECATED EAPI void             elm_object_focus(Evas_Object *obj) EINA_ARG_NONNULL(1);
2376
2377    /**
2378     * Remove the focus from an Elementary object
2379     *
2380     * @param obj The Elementary to take focus from
2381     *
2382     * This removes the focus from @p obj, passing it back to the
2383     * previous element in the focus chain list.
2384     *
2385     * @see elm_object_focus() and elm_object_focus_custom_chain_get()
2386     * @deprecated use elm_object_focus_set() instead.
2387     *
2388     * @ingroup Focus
2389     */
2390    EINA_DEPRECATED EAPI void             elm_object_unfocus(Evas_Object *obj) EINA_ARG_NONNULL(1);
2391
2392    /**
2393     * Set the ability for an Element object to be focused
2394     *
2395     * @param obj The Elementary object to operate on
2396     * @param enable @c EINA_TRUE if the object can be focused, @c
2397     *        EINA_FALSE if not (and on errors)
2398     *
2399     * This sets whether the object @p obj is able to take focus or
2400     * not. Unfocusable objects do nothing when programmatically
2401     * focused, being the nearest focusable parent object the one
2402     * really getting focus. Also, when they receive mouse input, they
2403     * will get the event, but not take away the focus from where it
2404     * was previously.
2405     *
2406     * @ingroup Focus
2407     */
2408    EAPI void             elm_object_focus_allow_set(Evas_Object *obj, Eina_Bool enable) EINA_ARG_NONNULL(1);
2409
2410    /**
2411     * Get whether an Elementary object is focusable or not
2412     *
2413     * @param obj The Elementary object to operate on
2414     * @return @c EINA_TRUE if the object is allowed to be focused, @c
2415     *             EINA_FALSE if not (and on errors)
2416     *
2417     * @note Objects which are meant to be interacted with by input
2418     * events are created able to be focused, by default. All the
2419     * others are not.
2420     *
2421     * @ingroup Focus
2422     */
2423    EAPI Eina_Bool        elm_object_focus_allow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2424
2425    /**
2426     * Set custom focus chain.
2427     *
2428     * This function overwrites any previous custom focus chain within
2429     * the list of objects. The previous list will be deleted and this list
2430     * will be managed by elementary. After it is set, don't modify it.
2431     *
2432     * @note On focus cycle, only will be evaluated children of this container.
2433     *
2434     * @param obj The container object
2435     * @param objs Chain of objects to pass focus
2436     * @ingroup Focus
2437     */
2438    EAPI void             elm_object_focus_custom_chain_set(Evas_Object *obj, Eina_List *objs) EINA_ARG_NONNULL(1);
2439
2440    /**
2441     * Unset a custom focus chain on a given Elementary widget
2442     *
2443     * @param obj The container object to remove focus chain from
2444     *
2445     * Any focus chain previously set on @p obj (for its child objects)
2446     * is removed entirely after this call.
2447     *
2448     * @ingroup Focus
2449     */
2450    EAPI void             elm_object_focus_custom_chain_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2451
2452    /**
2453     * Get custom focus chain
2454     *
2455     * @param obj The container object
2456     * @ingroup Focus
2457     */
2458    EAPI const Eina_List *elm_object_focus_custom_chain_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2459
2460    /**
2461     * Append object to custom focus chain.
2462     *
2463     * @note If relative_child equal to NULL or not in custom chain, the object
2464     * will be added in end.
2465     *
2466     * @note On focus cycle, only will be evaluated children of this container.
2467     *
2468     * @param obj The container object
2469     * @param child The child to be added in custom chain
2470     * @param relative_child The relative object to position the child
2471     * @ingroup Focus
2472     */
2473    EAPI void             elm_object_focus_custom_chain_append(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
2474
2475    /**
2476     * Prepend object to custom focus chain.
2477     *
2478     * @note If relative_child equal to NULL or not in custom chain, the object
2479     * will be added in begin.
2480     *
2481     * @note On focus cycle, only will be evaluated children of this container.
2482     *
2483     * @param obj The container object
2484     * @param child The child to be added in custom chain
2485     * @param relative_child The relative object to position the child
2486     * @ingroup Focus
2487     */
2488    EAPI void             elm_object_focus_custom_chain_prepend(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
2489
2490    /**
2491     * Give focus to next object in object tree.
2492     *
2493     * Give focus to next object in focus chain of one object sub-tree.
2494     * If the last object of chain already have focus, the focus will go to the
2495     * first object of chain.
2496     *
2497     * @param obj The object root of sub-tree
2498     * @param dir Direction to cycle the focus
2499     *
2500     * @ingroup Focus
2501     */
2502    EAPI void             elm_object_focus_cycle(Evas_Object *obj, Elm_Focus_Direction dir) EINA_ARG_NONNULL(1);
2503
2504    /**
2505     * Give focus to near object in one direction.
2506     *
2507     * Give focus to near object in direction of one object.
2508     * If none focusable object in given direction, the focus will not change.
2509     *
2510     * @param obj The reference object
2511     * @param x Horizontal component of direction to focus
2512     * @param y Vertical component of direction to focus
2513     *
2514     * @ingroup Focus
2515     */
2516    EAPI void             elm_object_focus_direction_go(Evas_Object *obj, int x, int y) EINA_ARG_NONNULL(1);
2517
2518    /**
2519     * Make the elementary object and its children to be unfocusable
2520     * (or focusable).
2521     *
2522     * @param obj The Elementary object to operate on
2523     * @param tree_unfocusable @c EINA_TRUE for unfocusable,
2524     *        @c EINA_FALSE for focusable.
2525     *
2526     * This sets whether the object @p obj and its children objects
2527     * are able to take focus or not. If the tree is set as unfocusable,
2528     * newest focused object which is not in this tree will get focus.
2529     * This API can be helpful for an object to be deleted.
2530     * When an object will be deleted soon, it and its children may not
2531     * want to get focus (by focus reverting or by other focus controls).
2532     * Then, just use this API before deleting.
2533     *
2534     * @see elm_object_tree_unfocusable_get()
2535     *
2536     * @ingroup Focus
2537     */
2538    EAPI void             elm_object_tree_unfocusable_set(Evas_Object *obj, Eina_Bool tree_unfocusable); EINA_ARG_NONNULL(1);
2539
2540    /**
2541     * Get whether an Elementary object and its children are unfocusable or not.
2542     *
2543     * @param obj The Elementary object to get the information from
2544     * @return @c EINA_TRUE, if the tree is unfocussable,
2545     *         @c EINA_FALSE if not (and on errors).
2546     *
2547     * @see elm_object_tree_unfocusable_set()
2548     *
2549     * @ingroup Focus
2550     */
2551    EAPI Eina_Bool        elm_object_tree_unfocusable_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
2552
2553    /**
2554     * @defgroup Scrolling Scrolling
2555     *
2556     * These are functions setting how scrollable views in Elementary
2557     * widgets should behave on user interaction.
2558     *
2559     * @{
2560     */
2561
2562    /**
2563     * Get whether scrollers should bounce when they reach their
2564     * viewport's edge during a scroll.
2565     *
2566     * @return the thumb scroll bouncing state
2567     *
2568     * This is the default behavior for touch screens, in general.
2569     * @ingroup Scrolling
2570     */
2571    EAPI Eina_Bool        elm_scroll_bounce_enabled_get(void);
2572
2573    /**
2574     * Set whether scrollers should bounce when they reach their
2575     * viewport's edge during a scroll.
2576     *
2577     * @param enabled the thumb scroll bouncing state
2578     *
2579     * @see elm_thumbscroll_bounce_enabled_get()
2580     * @ingroup Scrolling
2581     */
2582    EAPI void             elm_scroll_bounce_enabled_set(Eina_Bool enabled);
2583
2584    /**
2585     * Set whether scrollers should bounce when they reach their
2586     * viewport's edge during a scroll, for all Elementary application
2587     * windows.
2588     *
2589     * @param enabled the thumb scroll bouncing state
2590     *
2591     * @see elm_thumbscroll_bounce_enabled_get()
2592     * @ingroup Scrolling
2593     */
2594    EAPI void             elm_scroll_bounce_enabled_all_set(Eina_Bool enabled);
2595
2596    /**
2597     * Get the amount of inertia a scroller will impose at bounce
2598     * animations.
2599     *
2600     * @return the thumb scroll bounce friction
2601     *
2602     * @ingroup Scrolling
2603     */
2604    EAPI double           elm_scroll_bounce_friction_get(void);
2605
2606    /**
2607     * Set the amount of inertia a scroller will impose at bounce
2608     * animations.
2609     *
2610     * @param friction the thumb scroll bounce friction
2611     *
2612     * @see elm_thumbscroll_bounce_friction_get()
2613     * @ingroup Scrolling
2614     */
2615    EAPI void             elm_scroll_bounce_friction_set(double friction);
2616
2617    /**
2618     * Set the amount of inertia a scroller will impose at bounce
2619     * animations, for all Elementary application windows.
2620     *
2621     * @param friction the thumb scroll bounce friction
2622     *
2623     * @see elm_thumbscroll_bounce_friction_get()
2624     * @ingroup Scrolling
2625     */
2626    EAPI void             elm_scroll_bounce_friction_all_set(double friction);
2627
2628    /**
2629     * Get the amount of inertia a <b>paged</b> scroller will impose at
2630     * page fitting animations.
2631     *
2632     * @return the page scroll friction
2633     *
2634     * @ingroup Scrolling
2635     */
2636    EAPI double           elm_scroll_page_scroll_friction_get(void);
2637
2638    /**
2639     * Set the amount of inertia a <b>paged</b> scroller will impose at
2640     * page fitting animations.
2641     *
2642     * @param friction the page scroll friction
2643     *
2644     * @see elm_thumbscroll_page_scroll_friction_get()
2645     * @ingroup Scrolling
2646     */
2647    EAPI void             elm_scroll_page_scroll_friction_set(double friction);
2648
2649    /**
2650     * Set the amount of inertia a <b>paged</b> scroller will impose at
2651     * page fitting animations, for all Elementary application windows.
2652     *
2653     * @param friction the page scroll friction
2654     *
2655     * @see elm_thumbscroll_page_scroll_friction_get()
2656     * @ingroup Scrolling
2657     */
2658    EAPI void             elm_scroll_page_scroll_friction_all_set(double friction);
2659
2660    /**
2661     * Get the amount of inertia a scroller will impose at region bring
2662     * animations.
2663     *
2664     * @return the bring in scroll friction
2665     *
2666     * @ingroup Scrolling
2667     */
2668    EAPI double           elm_scroll_bring_in_scroll_friction_get(void);
2669
2670    /**
2671     * Set the amount of inertia a scroller will impose at region bring
2672     * animations.
2673     *
2674     * @param friction the bring in scroll friction
2675     *
2676     * @see elm_thumbscroll_bring_in_scroll_friction_get()
2677     * @ingroup Scrolling
2678     */
2679    EAPI void             elm_scroll_bring_in_scroll_friction_set(double friction);
2680
2681    /**
2682     * Set the amount of inertia a scroller will impose at region bring
2683     * animations, for all Elementary application windows.
2684     *
2685     * @param friction the bring in scroll friction
2686     *
2687     * @see elm_thumbscroll_bring_in_scroll_friction_get()
2688     * @ingroup Scrolling
2689     */
2690    EAPI void             elm_scroll_bring_in_scroll_friction_all_set(double friction);
2691
2692    /**
2693     * Get the amount of inertia scrollers will impose at animations
2694     * triggered by Elementary widgets' zooming API.
2695     *
2696     * @return the zoom friction
2697     *
2698     * @ingroup Scrolling
2699     */
2700    EAPI double           elm_scroll_zoom_friction_get(void);
2701
2702    /**
2703     * Set the amount of inertia scrollers will impose at animations
2704     * triggered by Elementary widgets' zooming API.
2705     *
2706     * @param friction the zoom friction
2707     *
2708     * @see elm_thumbscroll_zoom_friction_get()
2709     * @ingroup Scrolling
2710     */
2711    EAPI void             elm_scroll_zoom_friction_set(double friction);
2712
2713    /**
2714     * Set the amount of inertia scrollers will impose at animations
2715     * triggered by Elementary widgets' zooming API, for all Elementary
2716     * application windows.
2717     *
2718     * @param friction the zoom friction
2719     *
2720     * @see elm_thumbscroll_zoom_friction_get()
2721     * @ingroup Scrolling
2722     */
2723    EAPI void             elm_scroll_zoom_friction_all_set(double friction);
2724
2725    /**
2726     * Get whether scrollers should be draggable from any point in their
2727     * views.
2728     *
2729     * @return the thumb scroll state
2730     *
2731     * @note This is the default behavior for touch screens, in general.
2732     * @note All other functions namespaced with "thumbscroll" will only
2733     *       have effect if this mode is enabled.
2734     *
2735     * @ingroup Scrolling
2736     */
2737    EAPI Eina_Bool        elm_scroll_thumbscroll_enabled_get(void);
2738
2739    /**
2740     * Set whether scrollers should be draggable from any point in their
2741     * views.
2742     *
2743     * @param enabled the thumb scroll state
2744     *
2745     * @see elm_thumbscroll_enabled_get()
2746     * @ingroup Scrolling
2747     */
2748    EAPI void             elm_scroll_thumbscroll_enabled_set(Eina_Bool enabled);
2749
2750    /**
2751     * Set whether scrollers should be draggable from any point in their
2752     * views, for all Elementary application windows.
2753     *
2754     * @param enabled the thumb scroll state
2755     *
2756     * @see elm_thumbscroll_enabled_get()
2757     * @ingroup Scrolling
2758     */
2759    EAPI void             elm_scroll_thumbscroll_enabled_all_set(Eina_Bool enabled);
2760
2761    /**
2762     * Get the number of pixels one should travel while dragging a
2763     * scroller's view to actually trigger scrolling.
2764     *
2765     * @return the thumb scroll threshould
2766     *
2767     * One would use higher values for touch screens, in general, because
2768     * of their inherent imprecision.
2769     * @ingroup Scrolling
2770     */
2771    EAPI unsigned int     elm_scroll_thumbscroll_threshold_get(void);
2772
2773    /**
2774     * Set the number of pixels one should travel while dragging a
2775     * scroller's view to actually trigger scrolling.
2776     *
2777     * @param threshold the thumb scroll threshould
2778     *
2779     * @see elm_thumbscroll_threshould_get()
2780     * @ingroup Scrolling
2781     */
2782    EAPI void             elm_scroll_thumbscroll_threshold_set(unsigned int threshold);
2783
2784    /**
2785     * Set the number of pixels one should travel while dragging a
2786     * scroller's view to actually trigger scrolling, for all Elementary
2787     * application windows.
2788     *
2789     * @param threshold the thumb scroll threshould
2790     *
2791     * @see elm_thumbscroll_threshould_get()
2792     * @ingroup Scrolling
2793     */
2794    EAPI void             elm_scroll_thumbscroll_threshold_all_set(unsigned int threshold);
2795
2796    /**
2797     * Get the minimum speed of mouse cursor movement which will trigger
2798     * list self scrolling animation after a mouse up event
2799     * (pixels/second).
2800     *
2801     * @return the thumb scroll momentum threshould
2802     *
2803     * @ingroup Scrolling
2804     */
2805    EAPI double           elm_scroll_thumbscroll_momentum_threshold_get(void);
2806
2807    /**
2808     * Set the minimum speed of mouse cursor movement which will trigger
2809     * list self scrolling animation after a mouse up event
2810     * (pixels/second).
2811     *
2812     * @param threshold the thumb scroll momentum threshould
2813     *
2814     * @see elm_thumbscroll_momentum_threshould_get()
2815     * @ingroup Scrolling
2816     */
2817    EAPI void             elm_scroll_thumbscroll_momentum_threshold_set(double threshold);
2818
2819    /**
2820     * Set the minimum speed of mouse cursor movement which will trigger
2821     * list self scrolling animation after a mouse up event
2822     * (pixels/second), for all Elementary application windows.
2823     *
2824     * @param threshold the thumb scroll momentum threshould
2825     *
2826     * @see elm_thumbscroll_momentum_threshould_get()
2827     * @ingroup Scrolling
2828     */
2829    EAPI void             elm_scroll_thumbscroll_momentum_threshold_all_set(double threshold);
2830
2831    /**
2832     * Get the amount of inertia a scroller will impose at self scrolling
2833     * animations.
2834     *
2835     * @return the thumb scroll friction
2836     *
2837     * @ingroup Scrolling
2838     */
2839    EAPI double           elm_scroll_thumbscroll_friction_get(void);
2840
2841    /**
2842     * Set the amount of inertia a scroller will impose at self scrolling
2843     * animations.
2844     *
2845     * @param friction the thumb scroll friction
2846     *
2847     * @see elm_thumbscroll_friction_get()
2848     * @ingroup Scrolling
2849     */
2850    EAPI void             elm_scroll_thumbscroll_friction_set(double friction);
2851
2852    /**
2853     * Set the amount of inertia a scroller will impose at self scrolling
2854     * animations, for all Elementary application windows.
2855     *
2856     * @param friction the thumb scroll friction
2857     *
2858     * @see elm_thumbscroll_friction_get()
2859     * @ingroup Scrolling
2860     */
2861    EAPI void             elm_scroll_thumbscroll_friction_all_set(double friction);
2862
2863    /**
2864     * Get the amount of lag between your actual mouse cursor dragging
2865     * movement and a scroller's view movement itself, while pushing it
2866     * into bounce state manually.
2867     *
2868     * @return the thumb scroll border friction
2869     *
2870     * @ingroup Scrolling
2871     */
2872    EAPI double           elm_scroll_thumbscroll_border_friction_get(void);
2873
2874    /**
2875     * Set the amount of lag between your actual mouse cursor dragging
2876     * movement and a scroller's view movement itself, while pushing it
2877     * into bounce state manually.
2878     *
2879     * @param friction the thumb scroll border friction. @c 0.0 for
2880     *        perfect synchrony between two movements, @c 1.0 for maximum
2881     *        lag.
2882     *
2883     * @see elm_thumbscroll_border_friction_get()
2884     * @note parameter value will get bound to 0.0 - 1.0 interval, always
2885     *
2886     * @ingroup Scrolling
2887     */
2888    EAPI void             elm_scroll_thumbscroll_border_friction_set(double friction);
2889
2890    /**
2891     * Set the amount of lag between your actual mouse cursor dragging
2892     * movement and a scroller's view movement itself, while pushing it
2893     * into bounce state manually, for all Elementary application windows.
2894     *
2895     * @param friction the thumb scroll border friction. @c 0.0 for
2896     *        perfect synchrony between two movements, @c 1.0 for maximum
2897     *        lag.
2898     *
2899     * @see elm_thumbscroll_border_friction_get()
2900     * @note parameter value will get bound to 0.0 - 1.0 interval, always
2901     *
2902     * @ingroup Scrolling
2903     */
2904    EAPI void             elm_scroll_thumbscroll_border_friction_all_set(double friction);
2905
2906    /**
2907     * Get the sensitivity amount which is be multiplied by the length of
2908     * mouse dragging.
2909     *
2910     * @return the thumb scroll sensitivity friction
2911     *
2912     * @ingroup Scrolling
2913     */
2914    EAPI double           elm_scroll_thumbscroll_sensitivity_friction_get(void);
2915
2916    /**
2917     * Set the sensitivity amount which is be multiplied by the length of
2918     * mouse dragging.
2919     *
2920     * @param friction the thumb scroll sensitivity friction. @c 0.1 for
2921     *        minimun sensitivity, @c 1.0 for maximum sensitivity. 0.25
2922     *        is proper.
2923     *
2924     * @see elm_thumbscroll_sensitivity_friction_get()
2925     * @note parameter value will get bound to 0.1 - 1.0 interval, always
2926     *
2927     * @ingroup Scrolling
2928     */
2929    EAPI void             elm_scroll_thumbscroll_sensitivity_friction_set(double friction);
2930
2931    /**
2932     * Set the sensitivity amount which is be multiplied by the length of
2933     * mouse dragging, for all Elementary application windows.
2934     *
2935     * @param friction the thumb scroll sensitivity friction. @c 0.1 for
2936     *        minimun sensitivity, @c 1.0 for maximum sensitivity. 0.25
2937     *        is proper.
2938     *
2939     * @see elm_thumbscroll_sensitivity_friction_get()
2940     * @note parameter value will get bound to 0.1 - 1.0 interval, always
2941     *
2942     * @ingroup Scrolling
2943     */
2944    EAPI void             elm_scroll_thumbscroll_sensitivity_friction_all_set(double friction);
2945
2946    /**
2947     * @}
2948     */
2949
2950    /**
2951     * @defgroup Scrollhints Scrollhints
2952     *
2953     * Objects when inside a scroller can scroll, but this may not always be
2954     * desirable in certain situations. This allows an object to hint to itself
2955     * and parents to "not scroll" in one of 2 ways. If any child object of a
2956     * scroller has pushed a scroll freeze or hold then it affects all parent
2957     * scrollers until all children have released them.
2958     *
2959     * 1. To hold on scrolling. This means just flicking and dragging may no
2960     * longer scroll, but pressing/dragging near an edge of the scroller will
2961     * still scroll. This is automatically used by the entry object when
2962     * selecting text.
2963     *
2964     * 2. To totally freeze scrolling. This means it stops. until
2965     * popped/released.
2966     *
2967     * @{
2968     */
2969
2970    /**
2971     * Push the scroll hold by 1
2972     *
2973     * This increments the scroll hold count by one. If it is more than 0 it will
2974     * take effect on the parents of the indicated object.
2975     *
2976     * @param obj The object
2977     * @ingroup Scrollhints
2978     */
2979    EAPI void             elm_object_scroll_hold_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
2980
2981    /**
2982     * Pop the scroll hold by 1
2983     *
2984     * This decrements the scroll hold count by one. If it is more than 0 it will
2985     * take effect on the parents of the indicated object.
2986     *
2987     * @param obj The object
2988     * @ingroup Scrollhints
2989     */
2990    EAPI void             elm_object_scroll_hold_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
2991
2992    /**
2993     * Push the scroll freeze by 1
2994     *
2995     * This increments the scroll freeze count by one. If it is more
2996     * than 0 it will take effect on the parents of the indicated
2997     * object.
2998     *
2999     * @param obj The object
3000     * @ingroup Scrollhints
3001     */
3002    EAPI void             elm_object_scroll_freeze_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
3003
3004    /**
3005     * Pop the scroll freeze by 1
3006     *
3007     * This decrements the scroll freeze count by one. If it is more
3008     * than 0 it will take effect on the parents of the indicated
3009     * object.
3010     *
3011     * @param obj The object
3012     * @ingroup Scrollhints
3013     */
3014    EAPI void             elm_object_scroll_freeze_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
3015
3016    /**
3017     * Lock the scrolling of the given widget (and thus all parents)
3018     *
3019     * This locks the given object from scrolling in the X axis (and implicitly
3020     * also locks all parent scrollers too from doing the same).
3021     *
3022     * @param obj The object
3023     * @param lock The lock state (1 == locked, 0 == unlocked)
3024     * @ingroup Scrollhints
3025     */
3026    EAPI void             elm_object_scroll_lock_x_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
3027
3028    /**
3029     * Lock the scrolling of the given widget (and thus all parents)
3030     *
3031     * This locks the given object from scrolling in the Y axis (and implicitly
3032     * also locks all parent scrollers too from doing the same).
3033     *
3034     * @param obj The object
3035     * @param lock The lock state (1 == locked, 0 == unlocked)
3036     * @ingroup Scrollhints
3037     */
3038    EAPI void             elm_object_scroll_lock_y_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
3039
3040    /**
3041     * Get the scrolling lock of the given widget
3042     *
3043     * This gets the lock for X axis scrolling.
3044     *
3045     * @param obj The object
3046     * @ingroup Scrollhints
3047     */
3048    EAPI Eina_Bool        elm_object_scroll_lock_x_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3049
3050    /**
3051     * Get the scrolling lock of the given widget
3052     *
3053     * This gets the lock for X axis scrolling.
3054     *
3055     * @param obj The object
3056     * @ingroup Scrollhints
3057     */
3058    EAPI Eina_Bool        elm_object_scroll_lock_y_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3059
3060    /**
3061     * @}
3062     */
3063
3064    /**
3065     * Send a signal to the widget edje object.
3066     *
3067     * This function sends a signal to the edje object of the obj. An
3068     * edje program can respond to a signal by specifying matching
3069     * 'signal' and 'source' fields.
3070     *
3071     * @param obj The object
3072     * @param emission The signal's name.
3073     * @param source The signal's source.
3074     * @ingroup General
3075     */
3076    EAPI void             elm_object_signal_emit(Evas_Object *obj, const char *emission, const char *source) EINA_ARG_NONNULL(1);
3077
3078    /**
3079     * Add a callback for a signal emitted by widget edje object.
3080     *
3081     * This function connects a callback function to a signal emitted by the
3082     * edje object of the obj.
3083     * Globs can occur in either the emission or source name.
3084     *
3085     * @param obj The object
3086     * @param emission The signal's name.
3087     * @param source The signal's source.
3088     * @param func The callback function to be executed when the signal is
3089     * emitted.
3090     * @param data A pointer to data to pass in to the callback function.
3091     * @ingroup General
3092     */
3093    EAPI void             elm_object_signal_callback_add(Evas_Object *obj, const char *emission, const char *source, Edje_Signal_Cb func, void *data) EINA_ARG_NONNULL(1, 4);
3094
3095    /**
3096     * Remove a signal-triggered callback from a widget edje object.
3097     *
3098     * This function removes a callback, previoulsy attached to a
3099     * signal emitted by the edje object of the obj.  The parameters
3100     * emission, source and func must match exactly those passed to a
3101     * previous call to elm_object_signal_callback_add(). The data
3102     * pointer that was passed to this call will be returned.
3103     *
3104     * @param obj The object
3105     * @param emission The signal's name.
3106     * @param source The signal's source.
3107     * @param func The callback function to be executed when the signal is
3108     * emitted.
3109     * @return The data pointer
3110     * @ingroup General
3111     */
3112    EAPI void            *elm_object_signal_callback_del(Evas_Object *obj, const char *emission, const char *source, Edje_Signal_Cb func) EINA_ARG_NONNULL(1, 4);
3113
3114    /**
3115     * Add a callback for input events (key up, key down, mouse wheel)
3116     * on a given Elementary widget
3117     *
3118     * @param obj The widget to add an event callback on
3119     * @param func The callback function to be executed when the event
3120     * happens
3121     * @param data Data to pass in to @p func
3122     *
3123     * Every widget in an Elementary interface set to receive focus,
3124     * with elm_object_focus_allow_set(), will propagate @b all of its
3125     * key up, key down and mouse wheel input events up to its parent
3126     * object, and so on. All of the focusable ones in this chain which
3127     * had an event callback set, with this call, will be able to treat
3128     * those events. There are two ways of making the propagation of
3129     * these event upwards in the tree of widgets to @b cease:
3130     * - Just return @c EINA_TRUE on @p func. @c EINA_FALSE will mean
3131     *   the event was @b not processed, so the propagation will go on.
3132     * - The @c event_info pointer passed to @p func will contain the
3133     *   event's structure and, if you OR its @c event_flags inner
3134     *   value to @c EVAS_EVENT_FLAG_ON_HOLD, you're telling Elementary
3135     *   one has already handled it, thus killing the event's
3136     *   propagation, too.
3137     *
3138     * @note Your event callback will be issued on those events taking
3139     * place only if no other child widget of @obj has consumed the
3140     * event already.
3141     *
3142     * @note Not to be confused with @c
3143     * evas_object_event_callback_add(), which will add event callbacks
3144     * per type on general Evas objects (no event propagation
3145     * infrastructure taken in account).
3146     *
3147     * @note Not to be confused with @c
3148     * elm_object_signal_callback_add(), which will add callbacks to @b
3149     * signals coming from a widget's theme, not input events.
3150     *
3151     * @note Not to be confused with @c
3152     * edje_object_signal_callback_add(), which does the same as
3153     * elm_object_signal_callback_add(), but directly on an Edje
3154     * object.
3155     *
3156     * @note Not to be confused with @c
3157     * evas_object_smart_callback_add(), which adds callbacks to smart
3158     * objects' <b>smart events</b>, and not input events.
3159     *
3160     * @see elm_object_event_callback_del()
3161     *
3162     * @ingroup General
3163     */
3164    EAPI void             elm_object_event_callback_add(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
3165
3166    /**
3167     * Remove an event callback from a widget.
3168     *
3169     * This function removes a callback, previoulsy attached to event emission
3170     * by the @p obj.
3171     * The parameters func and data must match exactly those passed to
3172     * a previous call to elm_object_event_callback_add(). The data pointer that
3173     * was passed to this call will be returned.
3174     *
3175     * @param obj The object
3176     * @param func The callback function to be executed when the event is
3177     * emitted.
3178     * @param data Data to pass in to the callback function.
3179     * @return The data pointer
3180     * @ingroup General
3181     */
3182    EAPI void            *elm_object_event_callback_del(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
3183
3184    /**
3185     * Adjust size of an element for finger usage.
3186     *
3187     * @param times_w How many fingers should fit horizontally
3188     * @param w Pointer to the width size to adjust
3189     * @param times_h How many fingers should fit vertically
3190     * @param h Pointer to the height size to adjust
3191     *
3192     * This takes width and height sizes (in pixels) as input and a
3193     * size multiple (which is how many fingers you want to place
3194     * within the area, being "finger" the size set by
3195     * elm_finger_size_set()), and adjusts the size to be large enough
3196     * to accommodate the resulting size -- if it doesn't already
3197     * accommodate it. On return the @p w and @p h sizes pointed to by
3198     * these parameters will be modified, on those conditions.
3199     *
3200     * @note This is kind of a low level Elementary call, most useful
3201     * on size evaluation times for widgets. An external user wouldn't
3202     * be calling, most of the time.
3203     *
3204     * @ingroup Fingers
3205     */
3206    EAPI void             elm_coords_finger_size_adjust(int times_w, Evas_Coord *w, int times_h, Evas_Coord *h);
3207
3208    /**
3209     * Get the duration for occuring long press event.
3210     *
3211     * @return Timeout for long press event
3212     * @ingroup Longpress
3213     */
3214    EAPI double           elm_longpress_timeout_get(void);
3215
3216    /**
3217     * Set the duration for occuring long press event.
3218     *
3219     * @param lonpress_timeout Timeout for long press event
3220     * @ingroup Longpress
3221     */
3222    EAPI void             elm_longpress_timeout_set(double longpress_timeout);
3223
3224    /**
3225     * @defgroup Debug Debug
3226     * don't use it unless you are sure
3227     *
3228     * @{
3229     */
3230
3231    /**
3232     * Print Tree object hierarchy in stdout
3233     *
3234     * @param obj The root object
3235     * @ingroup Debug
3236     */
3237    EAPI void             elm_object_tree_dump(const Evas_Object *top);
3238
3239    /**
3240     * Print Elm Objects tree hierarchy in file as dot(graphviz) syntax.
3241     *
3242     * @param obj The root object
3243     * @param file The path of output file
3244     * @ingroup Debug
3245     */
3246    EAPI void             elm_object_tree_dot_dump(const Evas_Object *top, const char *file);
3247
3248    /**
3249     * @}
3250     */
3251
3252    /**
3253     * @defgroup Theme Theme
3254     *
3255     * Elementary uses Edje to theme its widgets, naturally. But for the most
3256     * part this is hidden behind a simpler interface that lets the user set
3257     * extensions and choose the style of widgets in a much easier way.
3258     *
3259     * Instead of thinking in terms of paths to Edje files and their groups
3260     * each time you want to change the appearance of a widget, Elementary
3261     * works so you can add any theme file with extensions or replace the
3262     * main theme at one point in the application, and then just set the style
3263     * of widgets with elm_object_style_set() and related functions. Elementary
3264     * will then look in its list of themes for a matching group and apply it,
3265     * and when the theme changes midway through the application, all widgets
3266     * will be updated accordingly.
3267     *
3268     * There are three concepts you need to know to understand how Elementary
3269     * theming works: default theme, extensions and overlays.
3270     *
3271     * Default theme, obviously enough, is the one that provides the default
3272     * look of all widgets. End users can change the theme used by Elementary
3273     * by setting the @c ELM_THEME environment variable before running an
3274     * application, or globally for all programs using the @c elementary_config
3275     * utility. Applications can change the default theme using elm_theme_set(),
3276     * but this can go against the user wishes, so it's not an adviced practice.
3277     *
3278     * Ideally, applications should find everything they need in the already
3279     * provided theme, but there may be occasions when that's not enough and
3280     * custom styles are required to correctly express the idea. For this
3281     * cases, Elementary has extensions.
3282     *
3283     * Extensions allow the application developer to write styles of its own
3284     * to apply to some widgets. This requires knowledge of how each widget
3285     * is themed, as extensions will always replace the entire group used by
3286     * the widget, so important signals and parts need to be there for the
3287     * object to behave properly (see documentation of Edje for details).
3288     * Once the theme for the extension is done, the application needs to add
3289     * it to the list of themes Elementary will look into, using
3290     * elm_theme_extension_add(), and set the style of the desired widgets as
3291     * he would normally with elm_object_style_set().
3292     *
3293     * Overlays, on the other hand, can replace the look of all widgets by
3294     * overriding the default style. Like extensions, it's up to the application
3295     * developer to write the theme for the widgets it wants, the difference
3296     * being that when looking for the theme, Elementary will check first the
3297     * list of overlays, then the set theme and lastly the list of extensions,
3298     * so with overlays it's possible to replace the default view and every
3299     * widget will be affected. This is very much alike to setting the whole
3300     * theme for the application and will probably clash with the end user
3301     * options, not to mention the risk of ending up with not matching styles
3302     * across the program. Unless there's a very special reason to use them,
3303     * overlays should be avoided for the resons exposed before.
3304     *
3305     * All these theme lists are handled by ::Elm_Theme instances. Elementary
3306     * keeps one default internally and every function that receives one of
3307     * these can be called with NULL to refer to this default (except for
3308     * elm_theme_free()). It's possible to create a new instance of a
3309     * ::Elm_Theme to set other theme for a specific widget (and all of its
3310     * children), but this is as discouraged, if not even more so, than using
3311     * overlays. Don't use this unless you really know what you are doing.
3312     *
3313     * But to be less negative about things, you can look at the following
3314     * examples:
3315     * @li @ref theme_example_01 "Using extensions"
3316     * @li @ref theme_example_02 "Using overlays"
3317     *
3318     * @{
3319     */
3320    /**
3321     * @typedef Elm_Theme
3322     *
3323     * Opaque handler for the list of themes Elementary looks for when
3324     * rendering widgets.
3325     *
3326     * Stay out of this unless you really know what you are doing. For most
3327     * cases, sticking to the default is all a developer needs.
3328     */
3329    typedef struct _Elm_Theme Elm_Theme;
3330
3331    /**
3332     * Create a new specific theme
3333     *
3334     * This creates an empty specific theme that only uses the default theme. A
3335     * specific theme has its own private set of extensions and overlays too
3336     * (which are empty by default). Specific themes do not fall back to themes
3337     * of parent objects. They are not intended for this use. Use styles, overlays
3338     * and extensions when needed, but avoid specific themes unless there is no
3339     * other way (example: you want to have a preview of a new theme you are
3340     * selecting in a "theme selector" window. The preview is inside a scroller
3341     * and should display what the theme you selected will look like, but not
3342     * actually apply it yet. The child of the scroller will have a specific
3343     * theme set to show this preview before the user decides to apply it to all
3344     * applications).
3345     */
3346    EAPI Elm_Theme       *elm_theme_new(void);
3347    /**
3348     * Free a specific theme
3349     *
3350     * @param th The theme to free
3351     *
3352     * This frees a theme created with elm_theme_new().
3353     */
3354    EAPI void             elm_theme_free(Elm_Theme *th);
3355    /**
3356     * Copy the theme fom the source to the destination theme
3357     *
3358     * @param th The source theme to copy from
3359     * @param thdst The destination theme to copy data to
3360     *
3361     * This makes a one-time static copy of all the theme config, extensions
3362     * and overlays from @p th to @p thdst. If @p th references a theme, then
3363     * @p thdst is also set to reference it, with all the theme settings,
3364     * overlays and extensions that @p th had.
3365     */
3366    EAPI void             elm_theme_copy(Elm_Theme *th, Elm_Theme *thdst);
3367    /**
3368     * Tell the source theme to reference the ref theme
3369     *
3370     * @param th The theme that will do the referencing
3371     * @param thref The theme that is the reference source
3372     *
3373     * This clears @p th to be empty and then sets it to refer to @p thref
3374     * so @p th acts as an override to @p thref, but where its overrides
3375     * don't apply, it will fall through to @p thref for configuration.
3376     */
3377    EAPI void             elm_theme_ref_set(Elm_Theme *th, Elm_Theme *thref);
3378    /**
3379     * Return the theme referred to
3380     *
3381     * @param th The theme to get the reference from
3382     * @return The referenced theme handle
3383     *
3384     * This gets the theme set as the reference theme by elm_theme_ref_set().
3385     * If no theme is set as a reference, NULL is returned.
3386     */
3387    EAPI Elm_Theme       *elm_theme_ref_get(Elm_Theme *th);
3388    /**
3389     * Return the default theme
3390     *
3391     * @return The default theme handle
3392     *
3393     * This returns the internal default theme setup handle that all widgets
3394     * use implicitly unless a specific theme is set. This is also often use
3395     * as a shorthand of NULL.
3396     */
3397    EAPI Elm_Theme       *elm_theme_default_get(void);
3398    /**
3399     * Prepends a theme overlay to the list of overlays
3400     *
3401     * @param th The theme to add to, or if NULL, the default theme
3402     * @param item The Edje file path to be used
3403     *
3404     * Use this if your application needs to provide some custom overlay theme
3405     * (An Edje file that replaces some default styles of widgets) where adding
3406     * new styles, or changing system theme configuration is not possible. Do
3407     * NOT use this instead of a proper system theme configuration. Use proper
3408     * configuration files, profiles, environment variables etc. to set a theme
3409     * so that the theme can be altered by simple confiugration by a user. Using
3410     * this call to achieve that effect is abusing the API and will create lots
3411     * of trouble.
3412     *
3413     * @see elm_theme_extension_add()
3414     */
3415    EAPI void             elm_theme_overlay_add(Elm_Theme *th, const char *item);
3416    /**
3417     * Delete a theme overlay from the list of overlays
3418     *
3419     * @param th The theme to delete from, or if NULL, the default theme
3420     * @param item The name of the theme overlay
3421     *
3422     * @see elm_theme_overlay_add()
3423     */
3424    EAPI void             elm_theme_overlay_del(Elm_Theme *th, const char *item);
3425    /**
3426     * Appends a theme extension to the list of extensions.
3427     *
3428     * @param th The theme to add to, or if NULL, the default theme
3429     * @param item The Edje file path to be used
3430     *
3431     * This is intended when an application needs more styles of widgets or new
3432     * widget themes that the default does not provide (or may not provide). The
3433     * application has "extended" usage by coming up with new custom style names
3434     * for widgets for specific uses, but as these are not "standard", they are
3435     * not guaranteed to be provided by a default theme. This means the
3436     * application is required to provide these extra elements itself in specific
3437     * Edje files. This call adds one of those Edje files to the theme search
3438     * path to be search after the default theme. The use of this call is
3439     * encouraged when default styles do not meet the needs of the application.
3440     * Use this call instead of elm_theme_overlay_add() for almost all cases.
3441     *
3442     * @see elm_object_style_set()
3443     */
3444    EAPI void             elm_theme_extension_add(Elm_Theme *th, const char *item);
3445    /**
3446     * Deletes a theme extension from the list of extensions.
3447     *
3448     * @param th The theme to delete from, or if NULL, the default theme
3449     * @param item The name of the theme extension
3450     *
3451     * @see elm_theme_extension_add()
3452     */
3453    EAPI void             elm_theme_extension_del(Elm_Theme *th, const char *item);
3454    /**
3455     * Set the theme search order for the given theme
3456     *
3457     * @param th The theme to set the search order, or if NULL, the default theme
3458     * @param theme Theme search string
3459     *
3460     * This sets the search string for the theme in path-notation from first
3461     * theme to search, to last, delimited by the : character. Example:
3462     *
3463     * "shiny:/path/to/file.edj:default"
3464     *
3465     * See the ELM_THEME environment variable for more information.
3466     *
3467     * @see elm_theme_get()
3468     * @see elm_theme_list_get()
3469     */
3470    EAPI void             elm_theme_set(Elm_Theme *th, const char *theme);
3471    /**
3472     * Return the theme search order
3473     *
3474     * @param th The theme to get the search order, or if NULL, the default theme
3475     * @return The internal search order path
3476     *
3477     * This function returns a colon separated string of theme elements as
3478     * returned by elm_theme_list_get().
3479     *
3480     * @see elm_theme_set()
3481     * @see elm_theme_list_get()
3482     */
3483    EAPI const char      *elm_theme_get(Elm_Theme *th);
3484    /**
3485     * Return a list of theme elements to be used in a theme.
3486     *
3487     * @param th Theme to get the list of theme elements from.
3488     * @return The internal list of theme elements
3489     *
3490     * This returns the internal list of theme elements (will only be valid as
3491     * long as the theme is not modified by elm_theme_set() or theme is not
3492     * freed by elm_theme_free(). This is a list of strings which must not be
3493     * altered as they are also internal. If @p th is NULL, then the default
3494     * theme element list is returned.
3495     *
3496     * A theme element can consist of a full or relative path to a .edj file,
3497     * or a name, without extension, for a theme to be searched in the known
3498     * theme paths for Elemementary.
3499     *
3500     * @see elm_theme_set()
3501     * @see elm_theme_get()
3502     */
3503    EAPI const Eina_List *elm_theme_list_get(const Elm_Theme *th);
3504    /**
3505     * Return the full patrh for a theme element
3506     *
3507     * @param f The theme element name
3508     * @param in_search_path Pointer to a boolean to indicate if item is in the search path or not
3509     * @return The full path to the file found.
3510     *
3511     * This returns a string you should free with free() on success, NULL on
3512     * failure. This will search for the given theme element, and if it is a
3513     * full or relative path element or a simple searchable name. The returned
3514     * path is the full path to the file, if searched, and the file exists, or it
3515     * is simply the full path given in the element or a resolved path if
3516     * relative to home. The @p in_search_path boolean pointed to is set to
3517     * EINA_TRUE if the file was a searchable file andis in the search path,
3518     * and EINA_FALSE otherwise.
3519     */
3520    EAPI char            *elm_theme_list_item_path_get(const char *f, Eina_Bool *in_search_path);
3521    /**
3522     * Flush the current theme.
3523     *
3524     * @param th Theme to flush
3525     *
3526     * This flushes caches that let elementary know where to find theme elements
3527     * in the given theme. If @p th is NULL, then the default theme is flushed.
3528     * Call this function if source theme data has changed in such a way as to
3529     * make any caches Elementary kept invalid.
3530     */
3531    EAPI void             elm_theme_flush(Elm_Theme *th);
3532    /**
3533     * This flushes all themes (default and specific ones).
3534     *
3535     * This will flush all themes in the current application context, by calling
3536     * elm_theme_flush() on each of them.
3537     */
3538    EAPI void             elm_theme_full_flush(void);
3539    /**
3540     * Set the theme for all elementary using applications on the current display
3541     *
3542     * @param theme The name of the theme to use. Format same as the ELM_THEME
3543     * environment variable.
3544     */
3545    EAPI void             elm_theme_all_set(const char *theme);
3546    /**
3547     * Return a list of theme elements in the theme search path
3548     *
3549     * @return A list of strings that are the theme element names.
3550     *
3551     * This lists all available theme files in the standard Elementary search path
3552     * for theme elements, and returns them in alphabetical order as theme
3553     * element names in a list of strings. Free this with
3554     * elm_theme_name_available_list_free() when you are done with the list.
3555     */
3556    EAPI Eina_List       *elm_theme_name_available_list_new(void);
3557    /**
3558     * Free the list returned by elm_theme_name_available_list_new()
3559     *
3560     * This frees the list of themes returned by
3561     * elm_theme_name_available_list_new(). Once freed the list should no longer
3562     * be used. a new list mys be created.
3563     */
3564    EAPI void             elm_theme_name_available_list_free(Eina_List *list);
3565    /**
3566     * Set a specific theme to be used for this object and its children
3567     *
3568     * @param obj The object to set the theme on
3569     * @param th The theme to set
3570     *
3571     * This sets a specific theme that will be used for the given object and any
3572     * child objects it has. If @p th is NULL then the theme to be used is
3573     * cleared and the object will inherit its theme from its parent (which
3574     * ultimately will use the default theme if no specific themes are set).
3575     *
3576     * Use special themes with great care as this will annoy users and make
3577     * configuration difficult. Avoid any custom themes at all if it can be
3578     * helped.
3579     */
3580    EAPI void             elm_object_theme_set(Evas_Object *obj, Elm_Theme *th) EINA_ARG_NONNULL(1);
3581    /**
3582     * Get the specific theme to be used
3583     *
3584     * @param obj The object to get the specific theme from
3585     * @return The specifc theme set.
3586     *
3587     * This will return a specific theme set, or NULL if no specific theme is
3588     * set on that object. It will not return inherited themes from parents, only
3589     * the specific theme set for that specific object. See elm_object_theme_set()
3590     * for more information.
3591     */
3592    EAPI Elm_Theme       *elm_object_theme_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3593
3594    /**
3595     * Get a data item from a theme
3596     *
3597     * @param th The theme, or NULL for default theme
3598     * @param key The data key to search with
3599     * @return The data value, or NULL on failure
3600     *
3601     * This function is used to return data items from edc in @p th, an overlay, or an extension.
3602     * It works the same way as edje_file_data_get() except that the return is stringshared.
3603     */
3604    EAPI const char      *elm_theme_data_get(Elm_Theme *th, const char *key) EINA_ARG_NONNULL(2);
3605    /**
3606     * @}
3607     */
3608
3609    /* win */
3610    /** @defgroup Win Win
3611     *
3612     * @image html img/widget/win/preview-00.png
3613     * @image latex img/widget/win/preview-00.eps
3614     *
3615     * The window class of Elementary.  Contains functions to manipulate
3616     * windows. The Evas engine used to render the window contents is specified
3617     * in the system or user elementary config files (whichever is found last),
3618     * and can be overridden with the ELM_ENGINE environment variable for
3619     * testing.  Engines that may be supported (depending on Evas and Ecore-Evas
3620     * compilation setup and modules actually installed at runtime) are (listed
3621     * in order of best supported and most likely to be complete and work to
3622     * lowest quality).
3623     *
3624     * @li "x11", "x", "software-x11", "software_x11" (Software rendering in X11)
3625     * @li "gl", "opengl", "opengl-x11", "opengl_x11" (OpenGL or OpenGL-ES2
3626     * rendering in X11)
3627     * @li "shot:..." (Virtual screenshot renderer - renders to output file and
3628     * exits)
3629     * @li "fb", "software-fb", "software_fb" (Linux framebuffer direct software
3630     * rendering)
3631     * @li "sdl", "software-sdl", "software_sdl" (SDL software rendering to SDL
3632     * buffer)
3633     * @li "gl-sdl", "gl_sdl", "opengl-sdl", "opengl_sdl" (OpenGL or OpenGL-ES2
3634     * rendering using SDL as the buffer)
3635     * @li "gdi", "software-gdi", "software_gdi" (Windows WIN32 rendering via
3636     * GDI with software)
3637     * @li "dfb", "directfb" (Rendering to a DirectFB window)
3638     * @li "x11-8", "x8", "software-8-x11", "software_8_x11" (Rendering in
3639     * grayscale using dedicated 8bit software engine in X11)
3640     * @li "x11-16", "x16", "software-16-x11", "software_16_x11" (Rendering in
3641     * X11 using 16bit software engine)
3642     * @li "wince-gdi", "software-16-wince-gdi", "software_16_wince_gdi"
3643     * (Windows CE rendering via GDI with 16bit software renderer)
3644     * @li "sdl-16", "software-16-sdl", "software_16_sdl" (Rendering to SDL
3645     * buffer with 16bit software renderer)
3646     * @li "ews" (rendering to EWS - Ecore + Evas Single Process Windowing System)
3647     * @li "gl-cocoa", "gl_cocoa", "opengl-cocoa", "opengl_cocoa" (OpenGL rendering in Cocoa)
3648     *
3649     * All engines use a simple string to select the engine to render, EXCEPT
3650     * the "shot" engine. This actually encodes the output of the virtual
3651     * screenshot and how long to delay in the engine string. The engine string
3652     * is encoded in the following way:
3653     *
3654     *   "shot:[delay=XX][:][repeat=DDD][:][file=XX]"
3655     *
3656     * Where options are separated by a ":" char if more than one option is
3657     * given, with delay, if provided being the first option and file the last
3658     * (order is important). The delay specifies how long to wait after the
3659     * window is shown before doing the virtual "in memory" rendering and then
3660     * save the output to the file specified by the file option (and then exit).
3661     * If no delay is given, the default is 0.5 seconds. If no file is given the
3662     * default output file is "out.png". Repeat option is for continous
3663     * capturing screenshots. Repeat range is from 1 to 999 and filename is
3664     * fixed to "out001.png" Some examples of using the shot engine:
3665     *
3666     *   ELM_ENGINE="shot:delay=1.0:repeat=5:file=elm_test.png" elementary_test
3667     *   ELM_ENGINE="shot:delay=1.0:file=elm_test.png" elementary_test
3668     *   ELM_ENGINE="shot:file=elm_test2.png" elementary_test
3669     *   ELM_ENGINE="shot:delay=2.0" elementary_test
3670     *   ELM_ENGINE="shot:" elementary_test
3671     *
3672     * Signals that you can add callbacks for are:
3673     *
3674     * @li "delete,request": the user requested to close the window. See
3675     * elm_win_autodel_set().
3676     * @li "focus,in": window got focus
3677     * @li "focus,out": window lost focus
3678     * @li "moved": window that holds the canvas was moved
3679     *
3680     * Examples:
3681     * @li @ref win_example_01
3682     *
3683     * @{
3684     */
3685    /**
3686     * Defines the types of window that can be created
3687     *
3688     * These are hints set on the window so that a running Window Manager knows
3689     * how the window should be handled and/or what kind of decorations it
3690     * should have.
3691     *
3692     * Currently, only the X11 backed engines use them.
3693     */
3694    typedef enum _Elm_Win_Type
3695      {
3696         ELM_WIN_BASIC, /**< A normal window. Indicates a normal, top-level
3697                          window. Almost every window will be created with this
3698                          type. */
3699         ELM_WIN_DIALOG_BASIC, /**< Used for simple dialog windows/ */
3700         ELM_WIN_DESKTOP, /**< For special desktop windows, like a background
3701                            window holding desktop icons. */
3702         ELM_WIN_DOCK, /**< The window is used as a dock or panel. Usually would
3703                         be kept on top of any other window by the Window
3704                         Manager. */
3705         ELM_WIN_TOOLBAR, /**< The window is used to hold a floating toolbar, or
3706                            similar. */
3707         ELM_WIN_MENU, /**< Similar to #ELM_WIN_TOOLBAR. */
3708         ELM_WIN_UTILITY, /**< A persistent utility window, like a toolbox or
3709                            pallete. */
3710         ELM_WIN_SPLASH, /**< Splash window for a starting up application. */
3711         ELM_WIN_DROPDOWN_MENU, /**< The window is a dropdown menu, as when an
3712                                  entry in a menubar is clicked. Typically used
3713                                  with elm_win_override_set(). This hint exists
3714                                  for completion only, as the EFL way of
3715                                  implementing a menu would not normally use a
3716                                  separate window for its contents. */
3717         ELM_WIN_POPUP_MENU, /**< Like #ELM_WIN_DROPDOWN_MENU, but for the menu
3718                               triggered by right-clicking an object. */
3719         ELM_WIN_TOOLTIP, /**< The window is a tooltip. A short piece of
3720                            explanatory text that typically appear after the
3721                            mouse cursor hovers over an object for a while.
3722                            Typically used with elm_win_override_set() and also
3723                            not very commonly used in the EFL. */
3724         ELM_WIN_NOTIFICATION, /**< A notification window, like a warning about
3725                                 battery life or a new E-Mail received. */
3726         ELM_WIN_COMBO, /**< A window holding the contents of a combo box. Not
3727                          usually used in the EFL. */
3728         ELM_WIN_DND, /**< Used to indicate the window is a representation of an
3729                        object being dragged across different windows, or even
3730                        applications. Typically used with
3731                        elm_win_override_set(). */
3732         ELM_WIN_INLINED_IMAGE, /**< The window is rendered onto an image
3733                                  buffer. No actual window is created for this
3734                                  type, instead the window and all of its
3735                                  contents will be rendered to an image buffer.
3736                                  This allows to have children window inside a
3737                                  parent one just like any other object would
3738                                  be, and do other things like applying @c
3739                                  Evas_Map effects to it. This is the only type
3740                                  of window that requires the @c parent
3741                                  parameter of elm_win_add() to be a valid @c
3742                                  Evas_Object. */
3743      } Elm_Win_Type;
3744
3745    /**
3746     * The differents layouts that can be requested for the virtual keyboard.
3747     *
3748     * When the application window is being managed by Illume, it may request
3749     * any of the following layouts for the virtual keyboard.
3750     */
3751    typedef enum _Elm_Win_Keyboard_Mode
3752      {
3753         ELM_WIN_KEYBOARD_UNKNOWN, /**< Unknown keyboard state */
3754         ELM_WIN_KEYBOARD_OFF, /**< Request to deactivate the keyboard */
3755         ELM_WIN_KEYBOARD_ON, /**< Enable keyboard with default layout */
3756         ELM_WIN_KEYBOARD_ALPHA, /**< Alpha (a-z) keyboard layout */
3757         ELM_WIN_KEYBOARD_NUMERIC, /**< Numeric keyboard layout */
3758         ELM_WIN_KEYBOARD_PIN, /**< PIN keyboard layout */
3759         ELM_WIN_KEYBOARD_PHONE_NUMBER, /**< Phone keyboard layout */
3760         ELM_WIN_KEYBOARD_HEX, /**< Hexadecimal numeric keyboard layout */
3761         ELM_WIN_KEYBOARD_TERMINAL, /**< Full (QUERTY) keyboard layout */
3762         ELM_WIN_KEYBOARD_PASSWORD, /**< Password keyboard layout */
3763         ELM_WIN_KEYBOARD_IP, /**< IP keyboard layout */
3764         ELM_WIN_KEYBOARD_HOST, /**< Host keyboard layout */
3765         ELM_WIN_KEYBOARD_FILE, /**< File keyboard layout */
3766         ELM_WIN_KEYBOARD_URL, /**< URL keyboard layout */
3767         ELM_WIN_KEYBOARD_KEYPAD, /**< Keypad layout */
3768         ELM_WIN_KEYBOARD_J2ME /**< J2ME keyboard layout */
3769      } Elm_Win_Keyboard_Mode;
3770
3771    /**
3772     * Available commands that can be sent to the Illume manager.
3773     *
3774     * When running under an Illume session, a window may send commands to the
3775     * Illume manager to perform different actions.
3776     */
3777    typedef enum _Elm_Illume_Command
3778      {
3779         ELM_ILLUME_COMMAND_FOCUS_BACK, /**< Reverts focus to the previous
3780                                          window */
3781         ELM_ILLUME_COMMAND_FOCUS_FORWARD, /**< Sends focus to the next window\
3782                                             in the list */
3783         ELM_ILLUME_COMMAND_FOCUS_HOME, /**< Hides all windows to show the Home
3784                                          screen */
3785         ELM_ILLUME_COMMAND_CLOSE /**< Closes the currently active window */
3786      } Elm_Illume_Command;
3787
3788    /**
3789     * Adds a window object. If this is the first window created, pass NULL as
3790     * @p parent.
3791     *
3792     * @param parent Parent object to add the window to, or NULL
3793     * @param name The name of the window
3794     * @param type The window type, one of #Elm_Win_Type.
3795     *
3796     * The @p parent paramter can be @c NULL for every window @p type except
3797     * #ELM_WIN_INLINED_IMAGE, which needs a parent to retrieve the canvas on
3798     * which the image object will be created.
3799     *
3800     * @return The created object, or NULL on failure
3801     */
3802    EAPI Evas_Object *elm_win_add(Evas_Object *parent, const char *name, Elm_Win_Type type);
3803    /**
3804     * Adds a window object with standard setup
3805     *
3806     * @param name The name of the window
3807     * @param title The title for the window
3808     *
3809     * This creates a window like elm_win_add() but also puts in a standard
3810     * background with elm_bg_add(), as well as setting the window title to
3811     * @p title. The window type created is of type ELM_WIN_BASIC, with NULL
3812     * as the parent widget.
3813     * 
3814     * @return The created object, or NULL on failure
3815     *
3816     * @see elm_win_add()
3817     */
3818    EAPI Evas_Object *elm_win_util_standard_add(const char *name, const char *title);
3819    /**
3820     * Add @p subobj as a resize object of window @p obj.
3821     *
3822     *
3823     * Setting an object as a resize object of the window means that the
3824     * @p subobj child's size and position will be controlled by the window
3825     * directly. That is, the object will be resized to match the window size
3826     * and should never be moved or resized manually by the developer.
3827     *
3828     * In addition, resize objects of the window control what the minimum size
3829     * of it will be, as well as whether it can or not be resized by the user.
3830     *
3831     * For the end user to be able to resize a window by dragging the handles
3832     * or borders provided by the Window Manager, or using any other similar
3833     * mechanism, all of the resize objects in the window should have their
3834     * evas_object_size_hint_weight_set() set to EVAS_HINT_EXPAND.
3835     *
3836     * @param obj The window object
3837     * @param subobj The resize object to add
3838     */
3839    EAPI void         elm_win_resize_object_add(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3840    /**
3841     * Delete @p subobj as a resize object of window @p obj.
3842     *
3843     * This function removes the object @p subobj from the resize objects of
3844     * the window @p obj. It will not delete the object itself, which will be
3845     * left unmanaged and should be deleted by the developer, manually handled
3846     * or set as child of some other container.
3847     *
3848     * @param obj The window object
3849     * @param subobj The resize object to add
3850     */
3851    EAPI void         elm_win_resize_object_del(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3852    /**
3853     * Set the title of the window
3854     *
3855     * @param obj The window object
3856     * @param title The title to set
3857     */
3858    EAPI void         elm_win_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
3859    /**
3860     * Get the title of the window
3861     *
3862     * The returned string is an internal one and should not be freed or
3863     * modified. It will also be rendered invalid if a new title is set or if
3864     * the window is destroyed.
3865     *
3866     * @param obj The window object
3867     * @return The title
3868     */
3869    EAPI const char  *elm_win_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3870    /**
3871     * Set the window's autodel state.
3872     *
3873     * When closing the window in any way outside of the program control, like
3874     * pressing the X button in the titlebar or using a command from the
3875     * Window Manager, a "delete,request" signal is emitted to indicate that
3876     * this event occurred and the developer can take any action, which may
3877     * include, or not, destroying the window object.
3878     *
3879     * When the @p autodel parameter is set, the window will be automatically
3880     * destroyed when this event occurs, after the signal is emitted.
3881     * If @p autodel is @c EINA_FALSE, then the window will not be destroyed
3882     * and is up to the program to do so when it's required.
3883     *
3884     * @param obj The window object
3885     * @param autodel If true, the window will automatically delete itself when
3886     * closed
3887     */
3888    EAPI void         elm_win_autodel_set(Evas_Object *obj, Eina_Bool autodel) EINA_ARG_NONNULL(1);
3889    /**
3890     * Get the window's autodel state.
3891     *
3892     * @param obj The window object
3893     * @return If the window will automatically delete itself when closed
3894     *
3895     * @see elm_win_autodel_set()
3896     */
3897    EAPI Eina_Bool    elm_win_autodel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3898    /**
3899     * Activate a window object.
3900     *
3901     * This function sends a request to the Window Manager to activate the
3902     * window pointed by @p obj. If honored by the WM, the window will receive
3903     * the keyboard focus.
3904     *
3905     * @note This is just a request that a Window Manager may ignore, so calling
3906     * this function does not ensure in any way that the window will be the
3907     * active one after it.
3908     *
3909     * @param obj The window object
3910     */
3911    EAPI void         elm_win_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
3912    /**
3913     * Lower a window object.
3914     *
3915     * Places the window pointed by @p obj at the bottom of the stack, so that
3916     * no other window is covered by it.
3917     *
3918     * If elm_win_override_set() is not set, the Window Manager may ignore this
3919     * request.
3920     *
3921     * @param obj The window object
3922     */
3923    EAPI void         elm_win_lower(Evas_Object *obj) EINA_ARG_NONNULL(1);
3924    /**
3925     * Raise a window object.
3926     *
3927     * Places the window pointed by @p obj at the top of the stack, so that it's
3928     * not covered by any other window.
3929     *
3930     * If elm_win_override_set() is not set, the Window Manager may ignore this
3931     * request.
3932     *
3933     * @param obj The window object
3934     */
3935    EAPI void         elm_win_raise(Evas_Object *obj) EINA_ARG_NONNULL(1);
3936    /**
3937     * Set the borderless state of a window.
3938     *
3939     * This function requests the Window Manager to not draw any decoration
3940     * around the window.
3941     *
3942     * @param obj The window object
3943     * @param borderless If true, the window is borderless
3944     */
3945    EAPI void         elm_win_borderless_set(Evas_Object *obj, Eina_Bool borderless) EINA_ARG_NONNULL(1);
3946    /**
3947     * Get the borderless state of a window.
3948     *
3949     * @param obj The window object
3950     * @return If true, the window is borderless
3951     */
3952    EAPI Eina_Bool    elm_win_borderless_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3953    /**
3954     * Set the shaped state of a window.
3955     *
3956     * Shaped windows, when supported, will render the parts of the window that
3957     * has no content, transparent.
3958     *
3959     * If @p shaped is EINA_FALSE, then it is strongly adviced to have some
3960     * background object or cover the entire window in any other way, or the
3961     * parts of the canvas that have no data will show framebuffer artifacts.
3962     *
3963     * @param obj The window object
3964     * @param shaped If true, the window is shaped
3965     *
3966     * @see elm_win_alpha_set()
3967     */
3968    EAPI void         elm_win_shaped_set(Evas_Object *obj, Eina_Bool shaped) EINA_ARG_NONNULL(1);
3969    /**
3970     * Get the shaped state of a window.
3971     *
3972     * @param obj The window object
3973     * @return If true, the window is shaped
3974     *
3975     * @see elm_win_shaped_set()
3976     */
3977    EAPI Eina_Bool    elm_win_shaped_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3978    /**
3979     * Set the alpha channel state of a window.
3980     *
3981     * If @p alpha is EINA_TRUE, the alpha channel of the canvas will be enabled
3982     * possibly making parts of the window completely or partially transparent.
3983     * This is also subject to the underlying system supporting it, like for
3984     * example, running under a compositing manager. If no compositing is
3985     * available, enabling this option will instead fallback to using shaped
3986     * windows, with elm_win_shaped_set().
3987     *
3988     * @param obj The window object
3989     * @param alpha If true, the window has an alpha channel
3990     *
3991     * @see elm_win_alpha_set()
3992     */
3993    EAPI void         elm_win_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
3994    /**
3995     * Get the transparency state of a window.
3996     *
3997     * @param obj The window object
3998     * @return If true, the window is transparent
3999     *
4000     * @see elm_win_transparent_set()
4001     */
4002    EAPI Eina_Bool    elm_win_transparent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4003    /**
4004     * Set the transparency state of a window.
4005     *
4006     * Use elm_win_alpha_set() instead.
4007     *
4008     * @param obj The window object
4009     * @param transparent If true, the window is transparent
4010     *
4011     * @see elm_win_alpha_set()
4012     */
4013    EAPI void         elm_win_transparent_set(Evas_Object *obj, Eina_Bool transparent) EINA_ARG_NONNULL(1);
4014    /**
4015     * Get the alpha channel state of a window.
4016     *
4017     * @param obj The window object
4018     * @return If true, the window has an alpha channel
4019     */
4020    EAPI Eina_Bool    elm_win_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4021    /**
4022     * Set the override state of a window.
4023     *
4024     * A window with @p override set to EINA_TRUE will not be managed by the
4025     * Window Manager. This means that no decorations of any kind will be shown
4026     * for it, moving and resizing must be handled by the application, as well
4027     * as the window visibility.
4028     *
4029     * This should not be used for normal windows, and even for not so normal
4030     * ones, it should only be used when there's a good reason and with a lot
4031     * of care. Mishandling override windows may result situations that
4032     * disrupt the normal workflow of the end user.
4033     *
4034     * @param obj The window object
4035     * @param override If true, the window is overridden
4036     */
4037    EAPI void         elm_win_override_set(Evas_Object *obj, Eina_Bool override) EINA_ARG_NONNULL(1);
4038    /**
4039     * Get the override state of a window.
4040     *
4041     * @param obj The window object
4042     * @return If true, the window is overridden
4043     *
4044     * @see elm_win_override_set()
4045     */
4046    EAPI Eina_Bool    elm_win_override_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4047    /**
4048     * Set the fullscreen state of a window.
4049     *
4050     * @param obj The window object
4051     * @param fullscreen If true, the window is fullscreen
4052     */
4053    EAPI void         elm_win_fullscreen_set(Evas_Object *obj, Eina_Bool fullscreen) EINA_ARG_NONNULL(1);
4054    /**
4055     * Get the fullscreen state of a window.
4056     *
4057     * @param obj The window object
4058     * @return If true, the window is fullscreen
4059     */
4060    EAPI Eina_Bool    elm_win_fullscreen_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4061    /**
4062     * Set the maximized state of a window.
4063     *
4064     * @param obj The window object
4065     * @param maximized If true, the window is maximized
4066     */
4067    EAPI void         elm_win_maximized_set(Evas_Object *obj, Eina_Bool maximized) EINA_ARG_NONNULL(1);
4068    /**
4069     * Get the maximized state of a window.
4070     *
4071     * @param obj The window object
4072     * @return If true, the window is maximized
4073     */
4074    EAPI Eina_Bool    elm_win_maximized_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4075    /**
4076     * Set the iconified state of a window.
4077     *
4078     * @param obj The window object
4079     * @param iconified If true, the window is iconified
4080     */
4081    EAPI void         elm_win_iconified_set(Evas_Object *obj, Eina_Bool iconified) EINA_ARG_NONNULL(1);
4082    /**
4083     * Get the iconified state of a window.
4084     *
4085     * @param obj The window object
4086     * @return If true, the window is iconified
4087     */
4088    EAPI Eina_Bool    elm_win_iconified_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4089    /**
4090     * Set the layer of the window.
4091     *
4092     * What this means exactly will depend on the underlying engine used.
4093     *
4094     * In the case of X11 backed engines, the value in @p layer has the
4095     * following meanings:
4096     * @li < 3: The window will be placed below all others.
4097     * @li > 5: The window will be placed above all others.
4098     * @li other: The window will be placed in the default layer.
4099     *
4100     * @param obj The window object
4101     * @param layer The layer of the window
4102     */
4103    EAPI void         elm_win_layer_set(Evas_Object *obj, int layer) EINA_ARG_NONNULL(1);
4104    /**
4105     * Get the layer of the window.
4106     *
4107     * @param obj The window object
4108     * @return The layer of the window
4109     *
4110     * @see elm_win_layer_set()
4111     */
4112    EAPI int          elm_win_layer_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4113    /**
4114     * Set the rotation of the window.
4115     *
4116     * Most engines only work with multiples of 90.
4117     *
4118     * This function is used to set the orientation of the window @p obj to
4119     * match that of the screen. The window itself will be resized to adjust
4120     * to the new geometry of its contents. If you want to keep the window size,
4121     * see elm_win_rotation_with_resize_set().
4122     *
4123     * @param obj The window object
4124     * @param rotation The rotation of the window, in degrees (0-360),
4125     * counter-clockwise.
4126     */
4127    EAPI void         elm_win_rotation_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
4128    /**
4129     * Rotates the window and resizes it.
4130     *
4131     * Like elm_win_rotation_set(), but it also resizes the window's contents so
4132     * that they fit inside the current window geometry.
4133     *
4134     * @param obj The window object
4135     * @param layer The rotation of the window in degrees (0-360),
4136     * counter-clockwise.
4137     */
4138    EAPI void         elm_win_rotation_with_resize_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
4139    /**
4140     * Get the rotation of the window.
4141     *
4142     * @param obj The window object
4143     * @return The rotation of the window in degrees (0-360)
4144     *
4145     * @see elm_win_rotation_set()
4146     * @see elm_win_rotation_with_resize_set()
4147     */
4148    EAPI int          elm_win_rotation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4149    /**
4150     * Set the sticky state of the window.
4151     *
4152     * Hints the Window Manager that the window in @p obj should be left fixed
4153     * at its position even when the virtual desktop it's on moves or changes.
4154     *
4155     * @param obj The window object
4156     * @param sticky If true, the window's sticky state is enabled
4157     */
4158    EAPI void         elm_win_sticky_set(Evas_Object *obj, Eina_Bool sticky) EINA_ARG_NONNULL(1);
4159    /**
4160     * Get the sticky state of the window.
4161     *
4162     * @param obj The window object
4163     * @return If true, the window's sticky state is enabled
4164     *
4165     * @see elm_win_sticky_set()
4166     */
4167    EAPI Eina_Bool    elm_win_sticky_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4168    /**
4169     * Set if this window is an illume conformant window
4170     *
4171     * @param obj The window object
4172     * @param conformant The conformant flag (1 = conformant, 0 = non-conformant)
4173     */
4174    EAPI void         elm_win_conformant_set(Evas_Object *obj, Eina_Bool conformant) EINA_ARG_NONNULL(1);
4175    /**
4176     * Get if this window is an illume conformant window
4177     *
4178     * @param obj The window object
4179     * @return A boolean if this window is illume conformant or not
4180     */
4181    EAPI Eina_Bool    elm_win_conformant_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4182    /**
4183     * Set a window to be an illume quickpanel window
4184     *
4185     * By default window objects are not quickpanel windows.
4186     *
4187     * @param obj The window object
4188     * @param quickpanel The quickpanel flag (1 = quickpanel, 0 = normal window)
4189     */
4190    EAPI void         elm_win_quickpanel_set(Evas_Object *obj, Eina_Bool quickpanel) EINA_ARG_NONNULL(1);
4191    /**
4192     * Get if this window is a quickpanel or not
4193     *
4194     * @param obj The window object
4195     * @return A boolean if this window is a quickpanel or not
4196     */
4197    EAPI Eina_Bool    elm_win_quickpanel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4198    /**
4199     * Set the major priority of a quickpanel window
4200     *
4201     * @param obj The window object
4202     * @param priority The major priority for this quickpanel
4203     */
4204    EAPI void         elm_win_quickpanel_priority_major_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
4205    /**
4206     * Get the major priority of a quickpanel window
4207     *
4208     * @param obj The window object
4209     * @return The major priority of this quickpanel
4210     */
4211    EAPI int          elm_win_quickpanel_priority_major_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4212    /**
4213     * Set the minor priority of a quickpanel window
4214     *
4215     * @param obj The window object
4216     * @param priority The minor priority for this quickpanel
4217     */
4218    EAPI void         elm_win_quickpanel_priority_minor_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
4219    /**
4220     * Get the minor priority of a quickpanel window
4221     *
4222     * @param obj The window object
4223     * @return The minor priority of this quickpanel
4224     */
4225    EAPI int          elm_win_quickpanel_priority_minor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4226    /**
4227     * Set which zone this quickpanel should appear in
4228     *
4229     * @param obj The window object
4230     * @param zone The requested zone for this quickpanel
4231     */
4232    EAPI void         elm_win_quickpanel_zone_set(Evas_Object *obj, int zone) EINA_ARG_NONNULL(1);
4233    /**
4234     * Get which zone this quickpanel should appear in
4235     *
4236     * @param obj The window object
4237     * @return The requested zone for this quickpanel
4238     */
4239    EAPI int          elm_win_quickpanel_zone_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4240    /**
4241     * Set the window to be skipped by keyboard focus
4242     *
4243     * This sets the window to be skipped by normal keyboard input. This means
4244     * a window manager will be asked to not focus this window as well as omit
4245     * it from things like the taskbar, pager, "alt-tab" list etc. etc.
4246     *
4247     * Call this and enable it on a window BEFORE you show it for the first time,
4248     * otherwise it may have no effect.
4249     *
4250     * Use this for windows that have only output information or might only be
4251     * interacted with by the mouse or fingers, and never for typing input.
4252     * Be careful that this may have side-effects like making the window
4253     * non-accessible in some cases unless the window is specially handled. Use
4254     * this with care.
4255     *
4256     * @param obj The window object
4257     * @param skip The skip flag state (EINA_TRUE if it is to be skipped)
4258     */
4259    EAPI void         elm_win_prop_focus_skip_set(Evas_Object *obj, Eina_Bool skip) EINA_ARG_NONNULL(1);
4260    /**
4261     * Send a command to the windowing environment
4262     *
4263     * This is intended to work in touchscreen or small screen device
4264     * environments where there is a more simplistic window management policy in
4265     * place. This uses the window object indicated to select which part of the
4266     * environment to control (the part that this window lives in), and provides
4267     * a command and an optional parameter structure (use NULL for this if not
4268     * needed).
4269     *
4270     * @param obj The window object that lives in the environment to control
4271     * @param command The command to send
4272     * @param params Optional parameters for the command
4273     */
4274    EAPI void         elm_win_illume_command_send(Evas_Object *obj, Elm_Illume_Command command, void *params) EINA_ARG_NONNULL(1);
4275    /**
4276     * Get the inlined image object handle
4277     *
4278     * When you create a window with elm_win_add() of type ELM_WIN_INLINED_IMAGE,
4279     * then the window is in fact an evas image object inlined in the parent
4280     * canvas. You can get this object (be careful to not manipulate it as it
4281     * is under control of elementary), and use it to do things like get pixel
4282     * data, save the image to a file, etc.
4283     *
4284     * @param obj The window object to get the inlined image from
4285     * @return The inlined image object, or NULL if none exists
4286     */
4287    EAPI Evas_Object *elm_win_inlined_image_object_get(Evas_Object *obj);
4288    /**
4289     * Set the enabled status for the focus highlight in a window
4290     *
4291     * This function will enable or disable the focus highlight only for the
4292     * given window, regardless of the global setting for it
4293     *
4294     * @param obj The window where to enable the highlight
4295     * @param enabled The enabled value for the highlight
4296     */
4297    EAPI void         elm_win_focus_highlight_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
4298    /**
4299     * Get the enabled value of the focus highlight for this window
4300     *
4301     * @param obj The window in which to check if the focus highlight is enabled
4302     *
4303     * @return EINA_TRUE if enabled, EINA_FALSE otherwise
4304     */
4305    EAPI Eina_Bool    elm_win_focus_highlight_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4306    /**
4307     * Set the style for the focus highlight on this window
4308     *
4309     * Sets the style to use for theming the highlight of focused objects on
4310     * the given window. If @p style is NULL, the default will be used.
4311     *
4312     * @param obj The window where to set the style
4313     * @param style The style to set
4314     */
4315    EAPI void         elm_win_focus_highlight_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
4316    /**
4317     * Get the style set for the focus highlight object
4318     *
4319     * Gets the style set for this windows highilght object, or NULL if none
4320     * is set.
4321     *
4322     * @param obj The window to retrieve the highlights style from
4323     *
4324     * @return The style set or NULL if none was. Default is used in that case.
4325     */
4326    EAPI const char  *elm_win_focus_highlight_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4327    /*...
4328     * ecore_x_icccm_hints_set -> accepts_focus (add to ecore_evas)
4329     * ecore_x_icccm_hints_set -> window_group (add to ecore_evas)
4330     * ecore_x_icccm_size_pos_hints_set -> request_pos (add to ecore_evas)
4331     * ecore_x_icccm_client_leader_set -> l (add to ecore_evas)
4332     * ecore_x_icccm_window_role_set -> role (add to ecore_evas)
4333     * ecore_x_icccm_transient_for_set -> forwin (add to ecore_evas)
4334     * ecore_x_netwm_window_type_set -> type (add to ecore_evas)
4335     *
4336     * (add to ecore_x) set netwm argb icon! (add to ecore_evas)
4337     * (blank mouse, private mouse obj, defaultmouse)
4338     *
4339     */
4340    /**
4341     * Sets the keyboard mode of the window.
4342     *
4343     * @param obj The window object
4344     * @param mode The mode to set, one of #Elm_Win_Keyboard_Mode
4345     */
4346    EAPI void                  elm_win_keyboard_mode_set(Evas_Object *obj, Elm_Win_Keyboard_Mode mode) EINA_ARG_NONNULL(1);
4347    /**
4348     * Gets the keyboard mode of the window.
4349     *
4350     * @param obj The window object
4351     * @return The mode, one of #Elm_Win_Keyboard_Mode
4352     */
4353    EAPI Elm_Win_Keyboard_Mode elm_win_keyboard_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4354    /**
4355     * Sets whether the window is a keyboard.
4356     *
4357     * @param obj The window object
4358     * @param is_keyboard If true, the window is a virtual keyboard
4359     */
4360    EAPI void                  elm_win_keyboard_win_set(Evas_Object *obj, Eina_Bool is_keyboard) EINA_ARG_NONNULL(1);
4361    /**
4362     * Gets whether the window is a keyboard.
4363     *
4364     * @param obj The window object
4365     * @return If the window is a virtual keyboard
4366     */
4367    EAPI Eina_Bool             elm_win_keyboard_win_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4368
4369    /**
4370     * Get the screen position of a window.
4371     *
4372     * @param obj The window object
4373     * @param x The int to store the x coordinate to
4374     * @param y The int to store the y coordinate to
4375     */
4376    EAPI void                  elm_win_screen_position_get(const Evas_Object *obj, int *x, int *y) EINA_ARG_NONNULL(1);
4377    /**
4378     * @}
4379     */
4380
4381    /**
4382     * @defgroup Inwin Inwin
4383     *
4384     * @image html img/widget/inwin/preview-00.png
4385     * @image latex img/widget/inwin/preview-00.eps
4386     * @image html img/widget/inwin/preview-01.png
4387     * @image latex img/widget/inwin/preview-01.eps
4388     * @image html img/widget/inwin/preview-02.png
4389     * @image latex img/widget/inwin/preview-02.eps
4390     *
4391     * An inwin is a window inside a window that is useful for a quick popup.
4392     * It does not hover.
4393     *
4394     * It works by creating an object that will occupy the entire window, so it
4395     * must be created using an @ref Win "elm_win" as parent only. The inwin
4396     * object can be hidden or restacked below every other object if it's
4397     * needed to show what's behind it without destroying it. If this is done,
4398     * the elm_win_inwin_activate() function can be used to bring it back to
4399     * full visibility again.
4400     *
4401     * There are three styles available in the default theme. These are:
4402     * @li default: The inwin is sized to take over most of the window it's
4403     * placed in.
4404     * @li minimal: The size of the inwin will be the minimum necessary to show
4405     * its contents.
4406     * @li minimal_vertical: Horizontally, the inwin takes as much space as
4407     * possible, but it's sized vertically the most it needs to fit its\
4408     * contents.
4409     *
4410     * Some examples of Inwin can be found in the following:
4411     * @li @ref inwin_example_01
4412     *
4413     * @{
4414     */
4415    /**
4416     * Adds an inwin to the current window
4417     *
4418     * The @p obj used as parent @b MUST be an @ref Win "Elementary Window".
4419     * Never call this function with anything other than the top-most window
4420     * as its parameter, unless you are fond of undefined behavior.
4421     *
4422     * After creating the object, the widget will set itself as resize object
4423     * for the window with elm_win_resize_object_add(), so when shown it will
4424     * appear to cover almost the entire window (how much of it depends on its
4425     * content and the style used). It must not be added into other container
4426     * objects and it needs not be moved or resized manually.
4427     *
4428     * @param parent The parent object
4429     * @return The new object or NULL if it cannot be created
4430     */
4431    EAPI Evas_Object          *elm_win_inwin_add(Evas_Object *obj) EINA_ARG_NONNULL(1);
4432    /**
4433     * Activates an inwin object, ensuring its visibility
4434     *
4435     * This function will make sure that the inwin @p obj is completely visible
4436     * by calling evas_object_show() and evas_object_raise() on it, to bring it
4437     * to the front. It also sets the keyboard focus to it, which will be passed
4438     * onto its content.
4439     *
4440     * The object's theme will also receive the signal "elm,action,show" with
4441     * source "elm".
4442     *
4443     * @param obj The inwin to activate
4444     */
4445    EAPI void                  elm_win_inwin_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
4446    /**
4447     * Set the content of an inwin object.
4448     *
4449     * Once the content object is set, a previously set one will be deleted.
4450     * If you want to keep that old content object, use the
4451     * elm_win_inwin_content_unset() function.
4452     *
4453     * @param obj The inwin object
4454     * @param content The object to set as content
4455     */
4456    EAPI void                  elm_win_inwin_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
4457    /**
4458     * Get the content of an inwin object.
4459     *
4460     * Return the content object which is set for this widget.
4461     *
4462     * The returned object is valid as long as the inwin is still alive and no
4463     * other content is set on it. Deleting the object will notify the inwin
4464     * about it and this one will be left empty.
4465     *
4466     * If you need to remove an inwin's content to be reused somewhere else,
4467     * see elm_win_inwin_content_unset().
4468     *
4469     * @param obj The inwin object
4470     * @return The content that is being used
4471     */
4472    EAPI Evas_Object          *elm_win_inwin_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4473    /**
4474     * Unset the content of an inwin object.
4475     *
4476     * Unparent and return the content object which was set for this widget.
4477     *
4478     * @param obj The inwin object
4479     * @return The content that was being used
4480     */
4481    EAPI Evas_Object          *elm_win_inwin_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4482    /**
4483     * @}
4484     */
4485    /* X specific calls - won't work on non-x engines (return 0) */
4486
4487    /**
4488     * Get the Ecore_X_Window of an Evas_Object
4489     *
4490     * @param obj The object
4491     *
4492     * @return The Ecore_X_Window of @p obj
4493     *
4494     * @ingroup Win
4495     */
4496    EAPI Ecore_X_Window elm_win_xwindow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4497
4498    /* smart callbacks called:
4499     * "delete,request" - the user requested to delete the window
4500     * "focus,in" - window got focus
4501     * "focus,out" - window lost focus
4502     * "moved" - window that holds the canvas was moved
4503     */
4504
4505    /**
4506     * @defgroup Bg Bg
4507     *
4508     * @image html img/widget/bg/preview-00.png
4509     * @image latex img/widget/bg/preview-00.eps
4510     *
4511     * @brief Background object, used for setting a solid color, image or Edje
4512     * group as background to a window or any container object.
4513     *
4514     * The bg object is used for setting a solid background to a window or
4515     * packing into any container object. It works just like an image, but has
4516     * some properties useful to a background, like setting it to tiled,
4517     * centered, scaled or stretched.
4518     * 
4519     * Default contents parts of the bg widget that you can use for are:
4520     * @li "elm.swallow.content" - overlay of the bg
4521     *
4522     * Here is some sample code using it:
4523     * @li @ref bg_01_example_page
4524     * @li @ref bg_02_example_page
4525     * @li @ref bg_03_example_page
4526     */
4527
4528    /* bg */
4529    typedef enum _Elm_Bg_Option
4530      {
4531         ELM_BG_OPTION_CENTER,  /**< center the background */
4532         ELM_BG_OPTION_SCALE,   /**< scale the background retaining aspect ratio */
4533         ELM_BG_OPTION_STRETCH, /**< stretch the background to fill */
4534         ELM_BG_OPTION_TILE     /**< tile background at its original size */
4535      } Elm_Bg_Option;
4536
4537    /**
4538     * Add a new background to the parent
4539     *
4540     * @param parent The parent object
4541     * @return The new object or NULL if it cannot be created
4542     *
4543     * @ingroup Bg
4544     */
4545    EAPI Evas_Object  *elm_bg_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4546
4547    /**
4548     * Set the file (image or edje) used for the background
4549     *
4550     * @param obj The bg object
4551     * @param file The file path
4552     * @param group Optional key (group in Edje) within the file
4553     *
4554     * This sets the image file used in the background object. The image (or edje)
4555     * will be stretched (retaining aspect if its an image file) to completely fill
4556     * the bg object. This may mean some parts are not visible.
4557     *
4558     * @note  Once the image of @p obj is set, a previously set one will be deleted,
4559     * even if @p file is NULL.
4560     *
4561     * @ingroup Bg
4562     */
4563    EAPI void          elm_bg_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
4564
4565    /**
4566     * Get the file (image or edje) used for the background
4567     *
4568     * @param obj The bg object
4569     * @param file The file path
4570     * @param group Optional key (group in Edje) within the file
4571     *
4572     * @ingroup Bg
4573     */
4574    EAPI void          elm_bg_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4575
4576    /**
4577     * Set the option used for the background image
4578     *
4579     * @param obj The bg object
4580     * @param option The desired background option (TILE, SCALE)
4581     *
4582     * This sets the option used for manipulating the display of the background
4583     * image. The image can be tiled or scaled.
4584     *
4585     * @ingroup Bg
4586     */
4587    EAPI void          elm_bg_option_set(Evas_Object *obj, Elm_Bg_Option option) EINA_ARG_NONNULL(1);
4588
4589    /**
4590     * Get the option used for the background image
4591     *
4592     * @param obj The bg object
4593     * @return The desired background option (CENTER, SCALE, STRETCH or TILE)
4594     *
4595     * @ingroup Bg
4596     */
4597    EAPI Elm_Bg_Option elm_bg_option_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4598    /**
4599     * Set the option used for the background color
4600     *
4601     * @param obj The bg object
4602     * @param r
4603     * @param g
4604     * @param b
4605     *
4606     * This sets the color used for the background rectangle. Its range goes
4607     * from 0 to 255.
4608     *
4609     * @ingroup Bg
4610     */
4611    EAPI void          elm_bg_color_set(Evas_Object *obj, int r, int g, int b) EINA_ARG_NONNULL(1);
4612    /**
4613     * Get the option used for the background color
4614     *
4615     * @param obj The bg object
4616     * @param r
4617     * @param g
4618     * @param b
4619     *
4620     * @ingroup Bg
4621     */
4622    EAPI void          elm_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b) EINA_ARG_NONNULL(1);
4623
4624    /**
4625     * Set the overlay object used for the background object.
4626     *
4627     * @param obj The bg object
4628     * @param overlay The overlay object
4629     *
4630     * This provides a way for elm_bg to have an 'overlay' that will be on top
4631     * of the bg. Once the over object is set, a previously set one will be
4632     * deleted, even if you set the new one to NULL. If you want to keep that
4633     * old content object, use the elm_bg_overlay_unset() function.
4634     *
4635     * @ingroup Bg
4636     */
4637
4638    EINA_DEPRECATED EAPI void          elm_bg_overlay_set(Evas_Object *obj, Evas_Object *overlay) EINA_ARG_NONNULL(1);
4639
4640    /**
4641     * Get the overlay object used for the background object.
4642     *
4643     * @param obj The bg object
4644     * @return The content that is being used
4645     *
4646     * Return the content object which is set for this widget
4647     *
4648     * @ingroup Bg
4649     */
4650    EINA_DEPRECATED EAPI Evas_Object  *elm_bg_overlay_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4651
4652    /**
4653     * Get the overlay object used for the background object.
4654     *
4655     * @param obj The bg object
4656     * @return The content that was being used
4657     *
4658     * Unparent and return the overlay object which was set for this widget
4659     *
4660     * @ingroup Bg
4661     */
4662    EINA_DEPRECATED EAPI Evas_Object  *elm_bg_overlay_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4663
4664    /**
4665     * Set the size of the pixmap representation of the image.
4666     *
4667     * This option just makes sense if an image is going to be set in the bg.
4668     *
4669     * @param obj The bg object
4670     * @param w The new width of the image pixmap representation.
4671     * @param h The new height of the image pixmap representation.
4672     *
4673     * This function sets a new size for pixmap representation of the given bg
4674     * image. It allows the image to be loaded already in the specified size,
4675     * reducing the memory usage and load time when loading a big image with load
4676     * size set to a smaller size.
4677     *
4678     * NOTE: this is just a hint, the real size of the pixmap may differ
4679     * depending on the type of image being loaded, being bigger than requested.
4680     *
4681     * @ingroup Bg
4682     */
4683    EAPI void          elm_bg_load_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
4684    /* smart callbacks called:
4685     */
4686
4687    /**
4688     * @defgroup Icon Icon
4689     *
4690     * @image html img/widget/icon/preview-00.png
4691     * @image latex img/widget/icon/preview-00.eps
4692     *
4693     * An object that provides standard icon images (delete, edit, arrows, etc.)
4694     * or a custom file (PNG, JPG, EDJE, etc.) used for an icon.
4695     *
4696     * The icon image requested can be in the elementary theme, or in the
4697     * freedesktop.org paths. It's possible to set the order of preference from
4698     * where the image will be used.
4699     *
4700     * This API is very similar to @ref Image, but with ready to use images.
4701     *
4702     * Default images provided by the theme are described below.
4703     *
4704     * The first list contains icons that were first intended to be used in
4705     * toolbars, but can be used in many other places too:
4706     * @li home
4707     * @li close
4708     * @li apps
4709     * @li arrow_up
4710     * @li arrow_down
4711     * @li arrow_left
4712     * @li arrow_right
4713     * @li chat
4714     * @li clock
4715     * @li delete
4716     * @li edit
4717     * @li refresh
4718     * @li folder
4719     * @li file
4720     *
4721     * Now some icons that were designed to be used in menus (but again, you can
4722     * use them anywhere else):
4723     * @li menu/home
4724     * @li menu/close
4725     * @li menu/apps
4726     * @li menu/arrow_up
4727     * @li menu/arrow_down
4728     * @li menu/arrow_left
4729     * @li menu/arrow_right
4730     * @li menu/chat
4731     * @li menu/clock
4732     * @li menu/delete
4733     * @li menu/edit
4734     * @li menu/refresh
4735     * @li menu/folder
4736     * @li menu/file
4737     *
4738     * And here we have some media player specific icons:
4739     * @li media_player/forward
4740     * @li media_player/info
4741     * @li media_player/next
4742     * @li media_player/pause
4743     * @li media_player/play
4744     * @li media_player/prev
4745     * @li media_player/rewind
4746     * @li media_player/stop
4747     *
4748     * Signals that you can add callbacks for are:
4749     *
4750     * "clicked" - This is called when a user has clicked the icon
4751     *
4752     * An example of usage for this API follows:
4753     * @li @ref tutorial_icon
4754     */
4755
4756    /**
4757     * @addtogroup Icon
4758     * @{
4759     */
4760
4761    typedef enum _Elm_Icon_Type
4762      {
4763         ELM_ICON_NONE,
4764         ELM_ICON_FILE,
4765         ELM_ICON_STANDARD
4766      } Elm_Icon_Type;
4767    /**
4768     * @enum _Elm_Icon_Lookup_Order
4769     * @typedef Elm_Icon_Lookup_Order
4770     *
4771     * Lookup order used by elm_icon_standard_set(). Should look for icons in the
4772     * theme, FDO paths, or both?
4773     *
4774     * @ingroup Icon
4775     */
4776    typedef enum _Elm_Icon_Lookup_Order
4777      {
4778         ELM_ICON_LOOKUP_FDO_THEME, /**< icon look up order: freedesktop, theme */
4779         ELM_ICON_LOOKUP_THEME_FDO, /**< icon look up order: theme, freedesktop */
4780         ELM_ICON_LOOKUP_FDO,       /**< icon look up order: freedesktop */
4781         ELM_ICON_LOOKUP_THEME      /**< icon look up order: theme */
4782      } Elm_Icon_Lookup_Order;
4783
4784    /**
4785     * Add a new icon object to the parent.
4786     *
4787     * @param parent The parent object
4788     * @return The new object or NULL if it cannot be created
4789     *
4790     * @see elm_icon_file_set()
4791     *
4792     * @ingroup Icon
4793     */
4794    EAPI Evas_Object          *elm_icon_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4795    /**
4796     * Set the file that will be used as icon.
4797     *
4798     * @param obj The icon object
4799     * @param file The path to file that will be used as icon image
4800     * @param group The group that the icon belongs to an edje file
4801     *
4802     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4803     *
4804     * @note The icon image set by this function can be changed by
4805     * elm_icon_standard_set().
4806     *
4807     * @see elm_icon_file_get()
4808     *
4809     * @ingroup Icon
4810     */
4811    EAPI Eina_Bool             elm_icon_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
4812    /**
4813     * Set a location in memory to be used as an icon
4814     *
4815     * @param obj The icon object
4816     * @param img The binary data that will be used as an image
4817     * @param size The size of binary data @p img
4818     * @param format Optional format of @p img to pass to the image loader
4819     * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
4820     *
4821     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4822     *
4823     * @note The icon image set by this function can be changed by
4824     * elm_icon_standard_set().
4825     *
4826     * @ingroup Icon
4827     */
4828    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);
4829    /**
4830     * Get the file that will be used as icon.
4831     *
4832     * @param obj The icon object
4833     * @param file The path to file that will be used as the icon image
4834     * @param group The group that the icon belongs to, in edje file
4835     *
4836     * @see elm_icon_file_set()
4837     *
4838     * @ingroup Icon
4839     */
4840    EAPI void                  elm_icon_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4841    EAPI void                  elm_icon_thumb_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
4842    /**
4843     * Set the icon by icon standards names.
4844     *
4845     * @param obj The icon object
4846     * @param name The icon name
4847     *
4848     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4849     *
4850     * For example, freedesktop.org defines standard icon names such as "home",
4851     * "network", etc. There can be different icon sets to match those icon
4852     * keys. The @p name given as parameter is one of these "keys", and will be
4853     * used to look in the freedesktop.org paths and elementary theme. One can
4854     * change the lookup order with elm_icon_order_lookup_set().
4855     *
4856     * If name is not found in any of the expected locations and it is the
4857     * absolute path of an image file, this image will be used.
4858     *
4859     * @note The icon image set by this function can be changed by
4860     * elm_icon_file_set().
4861     *
4862     * @see elm_icon_standard_get()
4863     * @see elm_icon_file_set()
4864     *
4865     * @ingroup Icon
4866     */
4867    EAPI Eina_Bool             elm_icon_standard_set(Evas_Object *obj, const char *name) EINA_ARG_NONNULL(1);
4868    /**
4869     * Get the icon name set by icon standard names.
4870     *
4871     * @param obj The icon object
4872     * @return The icon name
4873     *
4874     * If the icon image was set using elm_icon_file_set() instead of
4875     * elm_icon_standard_set(), then this function will return @c NULL.
4876     *
4877     * @see elm_icon_standard_set()
4878     *
4879     * @ingroup Icon
4880     */
4881    EAPI const char           *elm_icon_standard_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4882    /**
4883     * Set the smooth scaling for an icon object.
4884     *
4885     * @param obj The icon object
4886     * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
4887     * otherwise. Default is @c EINA_TRUE.
4888     *
4889     * Set the scaling algorithm to be used when scaling the icon image. Smooth
4890     * scaling provides a better resulting image, but is slower.
4891     *
4892     * The smooth scaling should be disabled when making animations that change
4893     * the icon size, since they will be faster. Animations that don't require
4894     * resizing of the icon can keep the smooth scaling enabled (even if the icon
4895     * is already scaled, since the scaled icon image will be cached).
4896     *
4897     * @see elm_icon_smooth_get()
4898     *
4899     * @ingroup Icon
4900     */
4901    EAPI void                  elm_icon_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
4902    /**
4903     * Get whether smooth scaling is enabled for an icon object.
4904     *
4905     * @param obj The icon object
4906     * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
4907     *
4908     * @see elm_icon_smooth_set()
4909     *
4910     * @ingroup Icon
4911     */
4912    EAPI Eina_Bool             elm_icon_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4913    /**
4914     * Disable scaling of this object.
4915     *
4916     * @param obj The icon object.
4917     * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
4918     * otherwise. Default is @c EINA_FALSE.
4919     *
4920     * This function disables scaling of the icon object through the function
4921     * elm_object_scale_set(). However, this does not affect the object
4922     * size/resize in any way. For that effect, take a look at
4923     * elm_icon_scale_set().
4924     *
4925     * @see elm_icon_no_scale_get()
4926     * @see elm_icon_scale_set()
4927     * @see elm_object_scale_set()
4928     *
4929     * @ingroup Icon
4930     */
4931    EAPI void                  elm_icon_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
4932    /**
4933     * Get whether scaling is disabled on the object.
4934     *
4935     * @param obj The icon object
4936     * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
4937     *
4938     * @see elm_icon_no_scale_set()
4939     *
4940     * @ingroup Icon
4941     */
4942    EAPI Eina_Bool             elm_icon_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4943    /**
4944     * Set if the object is (up/down) resizable.
4945     *
4946     * @param obj The icon object
4947     * @param scale_up A bool to set if the object is resizable up. Default is
4948     * @c EINA_TRUE.
4949     * @param scale_down A bool to set if the object is resizable down. Default
4950     * is @c EINA_TRUE.
4951     *
4952     * This function limits the icon object resize ability. If @p scale_up is set to
4953     * @c EINA_FALSE, the object can't have its height or width resized to a value
4954     * higher than the original icon size. Same is valid for @p scale_down.
4955     *
4956     * @see elm_icon_scale_get()
4957     *
4958     * @ingroup Icon
4959     */
4960    EAPI void                  elm_icon_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
4961    /**
4962     * Get if the object is (up/down) resizable.
4963     *
4964     * @param obj The icon object
4965     * @param scale_up A bool to set if the object is resizable up
4966     * @param scale_down A bool to set if the object is resizable down
4967     *
4968     * @see elm_icon_scale_set()
4969     *
4970     * @ingroup Icon
4971     */
4972    EAPI void                  elm_icon_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
4973    /**
4974     * Get the object's image size
4975     *
4976     * @param obj The icon object
4977     * @param w A pointer to store the width in
4978     * @param h A pointer to store the height in
4979     *
4980     * @ingroup Icon
4981     */
4982    EAPI void                  elm_icon_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
4983    /**
4984     * Set if the icon fill the entire object area.
4985     *
4986     * @param obj The icon object
4987     * @param fill_outside @c EINA_TRUE if the object is filled outside,
4988     * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
4989     *
4990     * When the icon object is resized to a different aspect ratio from the
4991     * original icon image, the icon image will still keep its aspect. This flag
4992     * tells how the image should fill the object's area. They are: keep the
4993     * entire icon inside the limits of height and width of the object (@p
4994     * fill_outside is @c EINA_FALSE) or let the extra width or height go outside
4995     * of the object, and the icon will fill the entire object (@p fill_outside
4996     * is @c EINA_TRUE).
4997     *
4998     * @note Unlike @ref Image, there's no option in icon to set the aspect ratio
4999     * retain property to false. Thus, the icon image will always keep its
5000     * original aspect ratio.
5001     *
5002     * @see elm_icon_fill_outside_get()
5003     * @see elm_image_fill_outside_set()
5004     *
5005     * @ingroup Icon
5006     */
5007    EAPI void                  elm_icon_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
5008    /**
5009     * Get if the object is filled outside.
5010     *
5011     * @param obj The icon object
5012     * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
5013     *
5014     * @see elm_icon_fill_outside_set()
5015     *
5016     * @ingroup Icon
5017     */
5018    EAPI Eina_Bool             elm_icon_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5019    /**
5020     * Set the prescale size for the icon.
5021     *
5022     * @param obj The icon object
5023     * @param size The prescale size. This value is used for both width and
5024     * height.
5025     *
5026     * This function sets a new size for pixmap representation of the given
5027     * icon. It allows the icon to be loaded already in the specified size,
5028     * reducing the memory usage and load time when loading a big icon with load
5029     * size set to a smaller size.
5030     *
5031     * It's equivalent to the elm_bg_load_size_set() function for bg.
5032     *
5033     * @note this is just a hint, the real size of the pixmap may differ
5034     * depending on the type of icon being loaded, being bigger than requested.
5035     *
5036     * @see elm_icon_prescale_get()
5037     * @see elm_bg_load_size_set()
5038     *
5039     * @ingroup Icon
5040     */
5041    EAPI void                  elm_icon_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
5042    /**
5043     * Get the prescale size for the icon.
5044     *
5045     * @param obj The icon object
5046     * @return The prescale size
5047     *
5048     * @see elm_icon_prescale_set()
5049     *
5050     * @ingroup Icon
5051     */
5052    EAPI int                   elm_icon_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5053    /**
5054     * Sets the icon lookup order used by elm_icon_standard_set().
5055     *
5056     * @param obj The icon object
5057     * @param order The icon lookup order (can be one of
5058     * ELM_ICON_LOOKUP_FDO_THEME, ELM_ICON_LOOKUP_THEME_FDO, ELM_ICON_LOOKUP_FDO
5059     * or ELM_ICON_LOOKUP_THEME)
5060     *
5061     * @see elm_icon_order_lookup_get()
5062     * @see Elm_Icon_Lookup_Order
5063     *
5064     * @ingroup Icon
5065     */
5066    EAPI void                  elm_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
5067    /**
5068     * Gets the icon lookup order.
5069     *
5070     * @param obj The icon object
5071     * @return The icon lookup order
5072     *
5073     * @see elm_icon_order_lookup_set()
5074     * @see Elm_Icon_Lookup_Order
5075     *
5076     * @ingroup Icon
5077     */
5078    EAPI Elm_Icon_Lookup_Order elm_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5079    /**
5080     * Get if the icon supports animation or not.
5081     *
5082     * @param obj The icon object
5083     * @return @c EINA_TRUE if the icon supports animation,
5084     *         @c EINA_FALSE otherwise.
5085     *
5086     * Return if this elm icon's image can be animated. Currently Evas only
5087     * supports gif animation. If the return value is EINA_FALSE, other
5088     * elm_icon_animated_XXX APIs won't work.
5089     * @ingroup Icon
5090     */
5091    EAPI Eina_Bool           elm_icon_animated_available_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5092    /**
5093     * Set animation mode of the icon.
5094     *
5095     * @param obj The icon object
5096     * @param anim @c EINA_TRUE if the object do animation job,
5097     * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5098     *
5099     * Since the default animation mode is set to EINA_FALSE, 
5100     * the icon is shown without animation.
5101     * This might be desirable when the application developer wants to show
5102     * a snapshot of the animated icon.
5103     * Set it to EINA_TRUE when the icon needs to be animated.
5104     * @ingroup Icon
5105     */
5106    EAPI void                elm_icon_animated_set(Evas_Object *obj, Eina_Bool animated) EINA_ARG_NONNULL(1);
5107    /**
5108     * Get animation mode of the icon.
5109     *
5110     * @param obj The icon object
5111     * @return The animation mode of the icon object
5112     * @see elm_icon_animated_set
5113     * @ingroup Icon
5114     */
5115    EAPI Eina_Bool           elm_icon_animated_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5116    /**
5117     * Set animation play mode of the icon.
5118     *
5119     * @param obj The icon object
5120     * @param play @c EINA_TRUE the object play animation images,
5121     * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5122     *
5123     * To play elm icon's animation, set play to EINA_TURE.
5124     * For example, you make gif player using this set/get API and click event.
5125     *
5126     * 1. Click event occurs
5127     * 2. Check play flag using elm_icon_animaged_play_get
5128     * 3. If elm icon was playing, set play to EINA_FALSE.
5129     *    Then animation will be stopped and vice versa
5130     * @ingroup Icon
5131     */
5132    EAPI void                elm_icon_animated_play_set(Evas_Object *obj, Eina_Bool play) EINA_ARG_NONNULL(1);
5133    /**
5134     * Get animation play mode of the icon.
5135     *
5136     * @param obj The icon object
5137     * @return The play mode of the icon object
5138     *
5139     * @see elm_icon_animated_play_get
5140     * @ingroup Icon
5141     */
5142    EAPI Eina_Bool           elm_icon_animated_play_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5143
5144    /**
5145     * @}
5146     */
5147
5148    /**
5149     * @defgroup Image Image
5150     *
5151     * @image html img/widget/image/preview-00.png
5152     * @image latex img/widget/image/preview-00.eps
5153
5154     *
5155     * An object that allows one to load an image file to it. It can be used
5156     * anywhere like any other elementary widget.
5157     *
5158     * This widget provides most of the functionality provided from @ref Bg or @ref
5159     * Icon, but with a slightly different API (use the one that fits better your
5160     * needs).
5161     *
5162     * The features not provided by those two other image widgets are:
5163     * @li allowing to get the basic @c Evas_Object with elm_image_object_get();
5164     * @li change the object orientation with elm_image_orient_set();
5165     * @li and turning the image editable with elm_image_editable_set().
5166     *
5167     * Signals that you can add callbacks for are:
5168     *
5169     * @li @c "clicked" - This is called when a user has clicked the image
5170     *
5171     * An example of usage for this API follows:
5172     * @li @ref tutorial_image
5173     */
5174
5175    /**
5176     * @addtogroup Image
5177     * @{
5178     */
5179
5180    /**
5181     * @enum _Elm_Image_Orient
5182     * @typedef Elm_Image_Orient
5183     *
5184     * Possible orientation options for elm_image_orient_set().
5185     *
5186     * @image html elm_image_orient_set.png
5187     * @image latex elm_image_orient_set.eps width=\textwidth
5188     *
5189     * @ingroup Image
5190     */
5191    typedef enum _Elm_Image_Orient
5192      {
5193         ELM_IMAGE_ORIENT_NONE, /**< no orientation change */
5194         ELM_IMAGE_ROTATE_90_CW, /**< rotate 90 degrees clockwise */
5195         ELM_IMAGE_ROTATE_180_CW, /**< rotate 180 degrees clockwise */
5196         ELM_IMAGE_ROTATE_90_CCW, /**< rotate 90 degrees counter-clockwise (i.e. 270 degrees clockwise) */
5197         ELM_IMAGE_FLIP_HORIZONTAL, /**< flip image horizontally */
5198         ELM_IMAGE_FLIP_VERTICAL, /**< flip image vertically */
5199         ELM_IMAGE_FLIP_TRANSPOSE, /**< flip the image along the y = (side - x) line*/
5200         ELM_IMAGE_FLIP_TRANSVERSE /**< flip the image along the y = x line */
5201      } Elm_Image_Orient;
5202
5203    /**
5204     * Add a new image to the parent.
5205     *
5206     * @param parent The parent object
5207     * @return The new object or NULL if it cannot be created
5208     *
5209     * @see elm_image_file_set()
5210     *
5211     * @ingroup Image
5212     */
5213    EAPI Evas_Object     *elm_image_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5214    /**
5215     * Set the file that will be used as image.
5216     *
5217     * @param obj The image object
5218     * @param file The path to file that will be used as image
5219     * @param group The group that the image belongs in edje file (if it's an
5220     * edje image)
5221     *
5222     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
5223     *
5224     * @see elm_image_file_get()
5225     *
5226     * @ingroup Image
5227     */
5228    EAPI Eina_Bool        elm_image_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
5229    /**
5230     * Get the file that will be used as image.
5231     *
5232     * @param obj The image object
5233     * @param file The path to file
5234     * @param group The group that the image belongs in edje file
5235     *
5236     * @see elm_image_file_set()
5237     *
5238     * @ingroup Image
5239     */
5240    EAPI void             elm_image_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
5241    /**
5242     * Set the smooth effect for an image.
5243     *
5244     * @param obj The image object
5245     * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
5246     * otherwise. Default is @c EINA_TRUE.
5247     *
5248     * Set the scaling algorithm to be used when scaling the image. Smooth
5249     * scaling provides a better resulting image, but is slower.
5250     *
5251     * The smooth scaling should be disabled when making animations that change
5252     * the image size, since it will be faster. Animations that don't require
5253     * resizing of the image can keep the smooth scaling enabled (even if the
5254     * image is already scaled, since the scaled image will be cached).
5255     *
5256     * @see elm_image_smooth_get()
5257     *
5258     * @ingroup Image
5259     */
5260    EAPI void             elm_image_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
5261    /**
5262     * Get the smooth effect for an image.
5263     *
5264     * @param obj The image object
5265     * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
5266     *
5267     * @see elm_image_smooth_get()
5268     *
5269     * @ingroup Image
5270     */
5271    EAPI Eina_Bool        elm_image_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5272
5273    /**
5274     * Gets the current size of the image.
5275     *
5276     * @param obj The image object.
5277     * @param w Pointer to store width, or NULL.
5278     * @param h Pointer to store height, or NULL.
5279     *
5280     * This is the real size of the image, not the size of the object.
5281     *
5282     * On error, neither w or h will be written.
5283     *
5284     * @ingroup Image
5285     */
5286    EAPI void             elm_image_object_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
5287    /**
5288     * Disable scaling of this object.
5289     *
5290     * @param obj The image object.
5291     * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
5292     * otherwise. Default is @c EINA_FALSE.
5293     *
5294     * This function disables scaling of the elm_image widget through the
5295     * function elm_object_scale_set(). However, this does not affect the widget
5296     * size/resize in any way. For that effect, take a look at
5297     * elm_image_scale_set().
5298     *
5299     * @see elm_image_no_scale_get()
5300     * @see elm_image_scale_set()
5301     * @see elm_object_scale_set()
5302     *
5303     * @ingroup Image
5304     */
5305    EAPI void             elm_image_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
5306    /**
5307     * Get whether scaling is disabled on the object.
5308     *
5309     * @param obj The image object
5310     * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
5311     *
5312     * @see elm_image_no_scale_set()
5313     *
5314     * @ingroup Image
5315     */
5316    EAPI Eina_Bool        elm_image_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5317    /**
5318     * Set if the object is (up/down) resizable.
5319     *
5320     * @param obj The image object
5321     * @param scale_up A bool to set if the object is resizable up. Default is
5322     * @c EINA_TRUE.
5323     * @param scale_down A bool to set if the object is resizable down. Default
5324     * is @c EINA_TRUE.
5325     *
5326     * This function limits the image resize ability. If @p scale_up is set to
5327     * @c EINA_FALSE, the object can't have its height or width resized to a value
5328     * higher than the original image size. Same is valid for @p scale_down.
5329     *
5330     * @see elm_image_scale_get()
5331     *
5332     * @ingroup Image
5333     */
5334    EAPI void             elm_image_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
5335    /**
5336     * Get if the object is (up/down) resizable.
5337     *
5338     * @param obj The image object
5339     * @param scale_up A bool to set if the object is resizable up
5340     * @param scale_down A bool to set if the object is resizable down
5341     *
5342     * @see elm_image_scale_set()
5343     *
5344     * @ingroup Image
5345     */
5346    EAPI void             elm_image_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
5347    /**
5348     * Set if the image fills the entire object area, when keeping the aspect ratio.
5349     *
5350     * @param obj The image object
5351     * @param fill_outside @c EINA_TRUE if the object is filled outside,
5352     * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5353     *
5354     * When the image should keep its aspect ratio even if resized to another
5355     * aspect ratio, there are two possibilities to resize it: keep the entire
5356     * image inside the limits of height and width of the object (@p fill_outside
5357     * is @c EINA_FALSE) or let the extra width or height go outside of the object,
5358     * and the image will fill the entire object (@p fill_outside is @c EINA_TRUE).
5359     *
5360     * @note This option will have no effect if
5361     * elm_image_aspect_ratio_retained_set() is set to @c EINA_FALSE.
5362     *
5363     * @see elm_image_fill_outside_get()
5364     * @see elm_image_aspect_ratio_retained_set()
5365     *
5366     * @ingroup Image
5367     */
5368    EAPI void             elm_image_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
5369    /**
5370     * Get if the object is filled outside
5371     *
5372     * @param obj The image object
5373     * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
5374     *
5375     * @see elm_image_fill_outside_set()
5376     *
5377     * @ingroup Image
5378     */
5379    EAPI Eina_Bool        elm_image_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5380    /**
5381     * Set the prescale size for the image
5382     *
5383     * @param obj The image object
5384     * @param size The prescale size. This value is used for both width and
5385     * height.
5386     *
5387     * This function sets a new size for pixmap representation of the given
5388     * image. It allows the image to be loaded already in the specified size,
5389     * reducing the memory usage and load time when loading a big image with load
5390     * size set to a smaller size.
5391     *
5392     * It's equivalent to the elm_bg_load_size_set() function for bg.
5393     *
5394     * @note this is just a hint, the real size of the pixmap may differ
5395     * depending on the type of image being loaded, being bigger than requested.
5396     *
5397     * @see elm_image_prescale_get()
5398     * @see elm_bg_load_size_set()
5399     *
5400     * @ingroup Image
5401     */
5402    EAPI void             elm_image_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
5403    /**
5404     * Get the prescale size for the image
5405     *
5406     * @param obj The image object
5407     * @return The prescale size
5408     *
5409     * @see elm_image_prescale_set()
5410     *
5411     * @ingroup Image
5412     */
5413    EAPI int              elm_image_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5414    /**
5415     * Set the image orientation.
5416     *
5417     * @param obj The image object
5418     * @param orient The image orientation @ref Elm_Image_Orient
5419     *  Default is #ELM_IMAGE_ORIENT_NONE.
5420     *
5421     * This function allows to rotate or flip the given image.
5422     *
5423     * @see elm_image_orient_get()
5424     * @see @ref Elm_Image_Orient
5425     *
5426     * @ingroup Image
5427     */
5428    EAPI void             elm_image_orient_set(Evas_Object *obj, Elm_Image_Orient orient) EINA_ARG_NONNULL(1);
5429    /**
5430     * Get the image orientation.
5431     *
5432     * @param obj The image object
5433     * @return The image orientation @ref Elm_Image_Orient
5434     *
5435     * @see elm_image_orient_set()
5436     * @see @ref Elm_Image_Orient
5437     *
5438     * @ingroup Image
5439     */
5440    EAPI Elm_Image_Orient elm_image_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5441    /**
5442     * Make the image 'editable'.
5443     *
5444     * @param obj Image object.
5445     * @param set Turn on or off editability. Default is @c EINA_FALSE.
5446     *
5447     * This means the image is a valid drag target for drag and drop, and can be
5448     * cut or pasted too.
5449     *
5450     * @ingroup Image
5451     */
5452    EAPI void             elm_image_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
5453    /**
5454     * Check if the image 'editable'.
5455     *
5456     * @param obj Image object.
5457     * @return Editability.
5458     *
5459     * A return value of EINA_TRUE means the image is a valid drag target
5460     * for drag and drop, and can be cut or pasted too.
5461     *
5462     * @ingroup Image
5463     */
5464    EAPI Eina_Bool        elm_image_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5465    /**
5466     * Get the basic Evas_Image object from this object (widget).
5467     *
5468     * @param obj The image object to get the inlined image from
5469     * @return The inlined image object, or NULL if none exists
5470     *
5471     * This function allows one to get the underlying @c Evas_Object of type
5472     * Image from this elementary widget. It can be useful to do things like get
5473     * the pixel data, save the image to a file, etc.
5474     *
5475     * @note Be careful to not manipulate it, as it is under control of
5476     * elementary.
5477     *
5478     * @ingroup Image
5479     */
5480    EAPI Evas_Object     *elm_image_object_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5481    /**
5482     * Set whether the original aspect ratio of the image should be kept on resize.
5483     *
5484     * @param obj The image object.
5485     * @param retained @c EINA_TRUE if the image should retain the aspect,
5486     * @c EINA_FALSE otherwise.
5487     *
5488     * The original aspect ratio (width / height) of the image is usually
5489     * distorted to match the object's size. Enabling this option will retain
5490     * this original aspect, and the way that the image is fit into the object's
5491     * area depends on the option set by elm_image_fill_outside_set().
5492     *
5493     * @see elm_image_aspect_ratio_retained_get()
5494     * @see elm_image_fill_outside_set()
5495     *
5496     * @ingroup Image
5497     */
5498    EAPI void             elm_image_aspect_ratio_retained_set(Evas_Object *obj, Eina_Bool retained) EINA_ARG_NONNULL(1);
5499    /**
5500     * Get if the object retains the original aspect ratio.
5501     *
5502     * @param obj The image object.
5503     * @return @c EINA_TRUE if the object keeps the original aspect, @c EINA_FALSE
5504     * otherwise.
5505     *
5506     * @ingroup Image
5507     */
5508    EAPI Eina_Bool        elm_image_aspect_ratio_retained_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5509
5510    /**
5511     * @}
5512     */
5513
5514    /* glview */
5515    typedef void (*Elm_GLView_Func_Cb)(Evas_Object *obj);
5516
5517    typedef enum _Elm_GLView_Mode
5518      {
5519         ELM_GLVIEW_ALPHA   = 1,
5520         ELM_GLVIEW_DEPTH   = 2,
5521         ELM_GLVIEW_STENCIL = 4
5522      } Elm_GLView_Mode;
5523
5524    /**
5525     * Defines a policy for the glview resizing.
5526     *
5527     * @note Default is ELM_GLVIEW_RESIZE_POLICY_RECREATE
5528     */
5529    typedef enum _Elm_GLView_Resize_Policy
5530      {
5531         ELM_GLVIEW_RESIZE_POLICY_RECREATE = 1,      /**< Resize the internal surface along with the image */
5532         ELM_GLVIEW_RESIZE_POLICY_SCALE    = 2       /**< Only reize the internal image and not the surface */
5533      } Elm_GLView_Resize_Policy;
5534
5535    typedef enum _Elm_GLView_Render_Policy
5536      {
5537         ELM_GLVIEW_RENDER_POLICY_ON_DEMAND = 1,     /**< Render only when there is a need for redrawing */
5538         ELM_GLVIEW_RENDER_POLICY_ALWAYS    = 2      /**< Render always even when it is not visible */
5539      } Elm_GLView_Render_Policy;
5540
5541    /**
5542     * @defgroup GLView
5543     *
5544     * A simple GLView widget that allows GL rendering.
5545     *
5546     * Signals that you can add callbacks for are:
5547     *
5548     * @{
5549     */
5550
5551    /**
5552     * Add a new glview to the parent
5553     *
5554     * @param parent The parent object
5555     * @return The new object or NULL if it cannot be created
5556     *
5557     * @ingroup GLView
5558     */
5559    EAPI Evas_Object     *elm_glview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5560
5561    /**
5562     * Sets the size of the glview
5563     *
5564     * @param obj The glview object
5565     * @param width width of the glview object
5566     * @param height height of the glview object
5567     *
5568     * @ingroup GLView
5569     */
5570    EAPI void             elm_glview_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
5571
5572    /**
5573     * Gets the size of the glview.
5574     *
5575     * @param obj The glview object
5576     * @param width width of the glview object
5577     * @param height height of the glview object
5578     *
5579     * Note that this function returns the actual image size of the
5580     * glview.  This means that when the scale policy is set to
5581     * ELM_GLVIEW_RESIZE_POLICY_SCALE, it'll return the non-scaled
5582     * size.
5583     *
5584     * @ingroup GLView
5585     */
5586    EAPI void             elm_glview_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
5587
5588    /**
5589     * Gets the gl api struct for gl rendering
5590     *
5591     * @param obj The glview object
5592     * @return The api object or NULL if it cannot be created
5593     *
5594     * @ingroup GLView
5595     */
5596    EAPI Evas_GL_API     *elm_glview_gl_api_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5597
5598    /**
5599     * Set the mode of the GLView. Supports Three simple modes.
5600     *
5601     * @param obj The glview object
5602     * @param mode The mode Options OR'ed enabling Alpha, Depth, Stencil.
5603     * @return True if set properly.
5604     *
5605     * @ingroup GLView
5606     */
5607    EAPI Eina_Bool        elm_glview_mode_set(Evas_Object *obj, Elm_GLView_Mode mode) EINA_ARG_NONNULL(1);
5608
5609    /**
5610     * Set the resize policy for the glview object.
5611     *
5612     * @param obj The glview object.
5613     * @param policy The scaling policy.
5614     *
5615     * By default, the resize policy is set to
5616     * ELM_GLVIEW_RESIZE_POLICY_RECREATE.  When resize is called it
5617     * destroys the previous surface and recreates the newly specified
5618     * size. If the policy is set to ELM_GLVIEW_RESIZE_POLICY_SCALE,
5619     * however, glview only scales the image object and not the underlying
5620     * GL Surface.
5621     *
5622     * @ingroup GLView
5623     */
5624    EAPI Eina_Bool        elm_glview_resize_policy_set(Evas_Object *obj, Elm_GLView_Resize_Policy policy) EINA_ARG_NONNULL(1);
5625
5626    /**
5627     * Set the render policy for the glview object.
5628     *
5629     * @param obj The glview object.
5630     * @param policy The render policy.
5631     *
5632     * By default, the render policy is set to
5633     * ELM_GLVIEW_RENDER_POLICY_ON_DEMAND.  This policy is set such
5634     * that during the render loop, glview is only redrawn if it needs
5635     * to be redrawn. (i.e. When it is visible) If the policy is set to
5636     * ELM_GLVIEWW_RENDER_POLICY_ALWAYS, it redraws regardless of
5637     * whether it is visible/need redrawing or not.
5638     *
5639     * @ingroup GLView
5640     */
5641    EAPI Eina_Bool        elm_glview_render_policy_set(Evas_Object *obj, Elm_GLView_Render_Policy policy) EINA_ARG_NONNULL(1);
5642
5643    /**
5644     * Set the init function that runs once in the main loop.
5645     *
5646     * @param obj The glview object.
5647     * @param func The init function to be registered.
5648     *
5649     * The registered init function gets called once during the render loop.
5650     *
5651     * @ingroup GLView
5652     */
5653    EAPI void             elm_glview_init_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5654
5655    /**
5656     * Set the render function that runs in the main loop.
5657     *
5658     * @param obj The glview object.
5659     * @param func The delete function to be registered.
5660     *
5661     * The registered del function gets called when GLView object is deleted.
5662     *
5663     * @ingroup GLView
5664     */
5665    EAPI void             elm_glview_del_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5666
5667    /**
5668     * Set the resize function that gets called when resize happens.
5669     *
5670     * @param obj The glview object.
5671     * @param func The resize function to be registered.
5672     *
5673     * @ingroup GLView
5674     */
5675    EAPI void             elm_glview_resize_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5676
5677    /**
5678     * Set the render function that runs in the main loop.
5679     *
5680     * @param obj The glview object.
5681     * @param func The render function to be registered.
5682     *
5683     * @ingroup GLView
5684     */
5685    EAPI void             elm_glview_render_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5686
5687    /**
5688     * Notifies that there has been changes in the GLView.
5689     *
5690     * @param obj The glview object.
5691     *
5692     * @ingroup GLView
5693     */
5694    EAPI void             elm_glview_changed_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
5695
5696    /**
5697     * @}
5698     */
5699
5700    /* box */
5701    /**
5702     * @defgroup Box Box
5703     *
5704     * @image html img/widget/box/preview-00.png
5705     * @image latex img/widget/box/preview-00.eps width=\textwidth
5706     *
5707     * @image html img/box.png
5708     * @image latex img/box.eps width=\textwidth
5709     *
5710     * A box arranges objects in a linear fashion, governed by a layout function
5711     * that defines the details of this arrangement.
5712     *
5713     * By default, the box will use an internal function to set the layout to
5714     * a single row, either vertical or horizontal. This layout is affected
5715     * by a number of parameters, such as the homogeneous flag set by
5716     * elm_box_homogeneous_set(), the values given by elm_box_padding_set() and
5717     * elm_box_align_set() and the hints set to each object in the box.
5718     *
5719     * For this default layout, it's possible to change the orientation with
5720     * elm_box_horizontal_set(). The box will start in the vertical orientation,
5721     * placing its elements ordered from top to bottom. When horizontal is set,
5722     * the order will go from left to right. If the box is set to be
5723     * homogeneous, every object in it will be assigned the same space, that
5724     * of the largest object. Padding can be used to set some spacing between
5725     * the cell given to each object. The alignment of the box, set with
5726     * elm_box_align_set(), determines how the bounding box of all the elements
5727     * will be placed within the space given to the box widget itself.
5728     *
5729     * The size hints of each object also affect how they are placed and sized
5730     * within the box. evas_object_size_hint_min_set() will give the minimum
5731     * size the object can have, and the box will use it as the basis for all
5732     * latter calculations. Elementary widgets set their own minimum size as
5733     * needed, so there's rarely any need to use it manually.
5734     *
5735     * evas_object_size_hint_weight_set(), when not in homogeneous mode, is
5736     * used to tell whether the object will be allocated the minimum size it
5737     * needs or if the space given to it should be expanded. It's important
5738     * to realize that expanding the size given to the object is not the same
5739     * thing as resizing the object. It could very well end being a small
5740     * widget floating in a much larger empty space. If not set, the weight
5741     * for objects will normally be 0.0 for both axis, meaning the widget will
5742     * not be expanded. To take as much space possible, set the weight to
5743     * EVAS_HINT_EXPAND (defined to 1.0) for the desired axis to expand.
5744     *
5745     * Besides how much space each object is allocated, it's possible to control
5746     * how the widget will be placed within that space using
5747     * evas_object_size_hint_align_set(). By default, this value will be 0.5
5748     * for both axis, meaning the object will be centered, but any value from
5749     * 0.0 (left or top, for the @c x and @c y axis, respectively) to 1.0
5750     * (right or bottom) can be used. The special value EVAS_HINT_FILL, which
5751     * is -1.0, means the object will be resized to fill the entire space it
5752     * was allocated.
5753     *
5754     * In addition, customized functions to define the layout can be set, which
5755     * allow the application developer to organize the objects within the box
5756     * in any number of ways.
5757     *
5758     * The special elm_box_layout_transition() function can be used
5759     * to switch from one layout to another, animating the motion of the
5760     * children of the box.
5761     *
5762     * @note Objects should not be added to box objects using _add() calls.
5763     *
5764     * Some examples on how to use boxes follow:
5765     * @li @ref box_example_01
5766     * @li @ref box_example_02
5767     *
5768     * @{
5769     */
5770    /**
5771     * @typedef Elm_Box_Transition
5772     *
5773     * Opaque handler containing the parameters to perform an animated
5774     * transition of the layout the box uses.
5775     *
5776     * @see elm_box_transition_new()
5777     * @see elm_box_layout_set()
5778     * @see elm_box_layout_transition()
5779     */
5780    typedef struct _Elm_Box_Transition Elm_Box_Transition;
5781
5782    /**
5783     * Add a new box to the parent
5784     *
5785     * By default, the box will be in vertical mode and non-homogeneous.
5786     *
5787     * @param parent The parent object
5788     * @return The new object or NULL if it cannot be created
5789     */
5790    EAPI Evas_Object        *elm_box_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5791    /**
5792     * Set the horizontal orientation
5793     *
5794     * By default, box object arranges their contents vertically from top to
5795     * bottom.
5796     * By calling this function with @p horizontal as EINA_TRUE, the box will
5797     * become horizontal, arranging contents from left to right.
5798     *
5799     * @note This flag is ignored if a custom layout function is set.
5800     *
5801     * @param obj The box object
5802     * @param horizontal The horizontal flag (EINA_TRUE = horizontal,
5803     * EINA_FALSE = vertical)
5804     */
5805    EAPI void                elm_box_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
5806    /**
5807     * Get the horizontal orientation
5808     *
5809     * @param obj The box object
5810     * @return EINA_TRUE if the box is set to horizontal mode, EINA_FALSE otherwise
5811     */
5812    EAPI Eina_Bool           elm_box_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5813    /**
5814     * Set the box to arrange its children homogeneously
5815     *
5816     * If enabled, homogeneous layout makes all items the same size, according
5817     * to the size of the largest of its children.
5818     *
5819     * @note This flag is ignored if a custom layout function is set.
5820     *
5821     * @param obj The box object
5822     * @param homogeneous The homogeneous flag
5823     */
5824    EAPI void                elm_box_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
5825    /**
5826     * Get whether the box is using homogeneous mode or not
5827     *
5828     * @param obj The box object
5829     * @return EINA_TRUE if it's homogeneous, EINA_FALSE otherwise
5830     */
5831    EAPI Eina_Bool           elm_box_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5832    EINA_DEPRECATED EAPI void elm_box_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
5833    EINA_DEPRECATED EAPI Eina_Bool elm_box_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5834    /**
5835     * Add an object to the beginning of the pack list
5836     *
5837     * Pack @p subobj into the box @p obj, placing it first in the list of
5838     * children objects. The actual position the object will get on screen
5839     * depends on the layout used. If no custom layout is set, it will be at
5840     * the top or left, depending if the box is vertical or horizontal,
5841     * respectively.
5842     *
5843     * @param obj The box object
5844     * @param subobj The object to add to the box
5845     *
5846     * @see elm_box_pack_end()
5847     * @see elm_box_pack_before()
5848     * @see elm_box_pack_after()
5849     * @see elm_box_unpack()
5850     * @see elm_box_unpack_all()
5851     * @see elm_box_clear()
5852     */
5853    EAPI void                elm_box_pack_start(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5854    /**
5855     * Add an object at the end of the pack list
5856     *
5857     * Pack @p subobj into the box @p obj, placing it last in the list of
5858     * children objects. The actual position the object will get on screen
5859     * depends on the layout used. If no custom layout is set, it will be at
5860     * the bottom or right, depending if the box is vertical or horizontal,
5861     * respectively.
5862     *
5863     * @param obj The box object
5864     * @param subobj The object to add to the box
5865     *
5866     * @see elm_box_pack_start()
5867     * @see elm_box_pack_before()
5868     * @see elm_box_pack_after()
5869     * @see elm_box_unpack()
5870     * @see elm_box_unpack_all()
5871     * @see elm_box_clear()
5872     */
5873    EAPI void                elm_box_pack_end(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5874    /**
5875     * Adds an object to the box before the indicated object
5876     *
5877     * This will add the @p subobj to the box indicated before the object
5878     * indicated with @p before. If @p before is not already in the box, results
5879     * are undefined. Before means either to the left of the indicated object or
5880     * above it depending on orientation.
5881     *
5882     * @param obj The box object
5883     * @param subobj The object to add to the box
5884     * @param before The object before which to add it
5885     *
5886     * @see elm_box_pack_start()
5887     * @see elm_box_pack_end()
5888     * @see elm_box_pack_after()
5889     * @see elm_box_unpack()
5890     * @see elm_box_unpack_all()
5891     * @see elm_box_clear()
5892     */
5893    EAPI void                elm_box_pack_before(Evas_Object *obj, Evas_Object *subobj, Evas_Object *before) EINA_ARG_NONNULL(1);
5894    /**
5895     * Adds an object to the box after the indicated object
5896     *
5897     * This will add the @p subobj to the box indicated after the object
5898     * indicated with @p after. If @p after is not already in the box, results
5899     * are undefined. After means either to the right of the indicated object or
5900     * below it depending on orientation.
5901     *
5902     * @param obj The box object
5903     * @param subobj The object to add to the box
5904     * @param after The object after which to add it
5905     *
5906     * @see elm_box_pack_start()
5907     * @see elm_box_pack_end()
5908     * @see elm_box_pack_before()
5909     * @see elm_box_unpack()
5910     * @see elm_box_unpack_all()
5911     * @see elm_box_clear()
5912     */
5913    EAPI void                elm_box_pack_after(Evas_Object *obj, Evas_Object *subobj, Evas_Object *after) EINA_ARG_NONNULL(1);
5914    /**
5915     * Clear the box of all children
5916     *
5917     * Remove all the elements contained by the box, deleting the respective
5918     * objects.
5919     *
5920     * @param obj The box object
5921     *
5922     * @see elm_box_unpack()
5923     * @see elm_box_unpack_all()
5924     */
5925    EAPI void                elm_box_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
5926    /**
5927     * Unpack a box item
5928     *
5929     * Remove the object given by @p subobj from the box @p obj without
5930     * deleting it.
5931     *
5932     * @param obj The box object
5933     *
5934     * @see elm_box_unpack_all()
5935     * @see elm_box_clear()
5936     */
5937    EAPI void                elm_box_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5938    /**
5939     * Remove all items from the box, without deleting them
5940     *
5941     * Clear the box from all children, but don't delete the respective objects.
5942     * If no other references of the box children exist, the objects will never
5943     * be deleted, and thus the application will leak the memory. Make sure
5944     * when using this function that you hold a reference to all the objects
5945     * in the box @p obj.
5946     *
5947     * @param obj The box object
5948     *
5949     * @see elm_box_clear()
5950     * @see elm_box_unpack()
5951     */
5952    EAPI void                elm_box_unpack_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
5953    /**
5954     * Retrieve a list of the objects packed into the box
5955     *
5956     * Returns a new @c Eina_List with a pointer to @c Evas_Object in its nodes.
5957     * The order of the list corresponds to the packing order the box uses.
5958     *
5959     * You must free this list with eina_list_free() once you are done with it.
5960     *
5961     * @param obj The box object
5962     */
5963    EAPI const Eina_List    *elm_box_children_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5964    /**
5965     * Set the space (padding) between the box's elements.
5966     *
5967     * Extra space in pixels that will be added between a box child and its
5968     * neighbors after its containing cell has been calculated. This padding
5969     * is set for all elements in the box, besides any possible padding that
5970     * individual elements may have through their size hints.
5971     *
5972     * @param obj The box object
5973     * @param horizontal The horizontal space between elements
5974     * @param vertical The vertical space between elements
5975     */
5976    EAPI void                elm_box_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
5977    /**
5978     * Get the space (padding) between the box's elements.
5979     *
5980     * @param obj The box object
5981     * @param horizontal The horizontal space between elements
5982     * @param vertical The vertical space between elements
5983     *
5984     * @see elm_box_padding_set()
5985     */
5986    EAPI void                elm_box_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
5987    /**
5988     * Set the alignment of the whole bouding box of contents.
5989     *
5990     * Sets how the bounding box containing all the elements of the box, after
5991     * their sizes and position has been calculated, will be aligned within
5992     * the space given for the whole box widget.
5993     *
5994     * @param obj The box object
5995     * @param horizontal The horizontal alignment of elements
5996     * @param vertical The vertical alignment of elements
5997     */
5998    EAPI void                elm_box_align_set(Evas_Object *obj, double horizontal, double vertical) EINA_ARG_NONNULL(1);
5999    /**
6000     * Get the alignment of the whole bouding box of contents.
6001     *
6002     * @param obj The box object
6003     * @param horizontal The horizontal alignment of elements
6004     * @param vertical The vertical alignment of elements
6005     *
6006     * @see elm_box_align_set()
6007     */
6008    EAPI void                elm_box_align_get(const Evas_Object *obj, double *horizontal, double *vertical) EINA_ARG_NONNULL(1);
6009
6010    /**
6011     * Force the box to recalculate its children packing.
6012     *
6013     * If any children was added or removed, box will not calculate the
6014     * values immediately rather leaving it to the next main loop
6015     * iteration. While this is great as it would save lots of
6016     * recalculation, whenever you need to get the position of a just
6017     * added item you must force recalculate before doing so.
6018     *
6019     * @param obj The box object.
6020     */
6021    EAPI void                 elm_box_recalculate(Evas_Object *obj);
6022
6023    /**
6024     * Set the layout defining function to be used by the box
6025     *
6026     * Whenever anything changes that requires the box in @p obj to recalculate
6027     * the size and position of its elements, the function @p cb will be called
6028     * to determine what the layout of the children will be.
6029     *
6030     * Once a custom function is set, everything about the children layout
6031     * is defined by it. The flags set by elm_box_horizontal_set() and
6032     * elm_box_homogeneous_set() no longer have any meaning, and the values
6033     * given by elm_box_padding_set() and elm_box_align_set() are up to this
6034     * layout function to decide if they are used and how. These last two
6035     * will be found in the @c priv parameter, of type @c Evas_Object_Box_Data,
6036     * passed to @p cb. The @c Evas_Object the function receives is not the
6037     * Elementary widget, but the internal Evas Box it uses, so none of the
6038     * functions described here can be used on it.
6039     *
6040     * Any of the layout functions in @c Evas can be used here, as well as the
6041     * special elm_box_layout_transition().
6042     *
6043     * The final @p data argument received by @p cb is the same @p data passed
6044     * here, and the @p free_data function will be called to free it
6045     * whenever the box is destroyed or another layout function is set.
6046     *
6047     * Setting @p cb to NULL will revert back to the default layout function.
6048     *
6049     * @param obj The box object
6050     * @param cb The callback function used for layout
6051     * @param data Data that will be passed to layout function
6052     * @param free_data Function called to free @p data
6053     *
6054     * @see elm_box_layout_transition()
6055     */
6056    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);
6057    /**
6058     * Special layout function that animates the transition from one layout to another
6059     *
6060     * Normally, when switching the layout function for a box, this will be
6061     * reflected immediately on screen on the next render, but it's also
6062     * possible to do this through an animated transition.
6063     *
6064     * This is done by creating an ::Elm_Box_Transition and setting the box
6065     * layout to this function.
6066     *
6067     * For example:
6068     * @code
6069     * Elm_Box_Transition *t = elm_box_transition_new(1.0,
6070     *                            evas_object_box_layout_vertical, // start
6071     *                            NULL, // data for initial layout
6072     *                            NULL, // free function for initial data
6073     *                            evas_object_box_layout_horizontal, // end
6074     *                            NULL, // data for final layout
6075     *                            NULL, // free function for final data
6076     *                            anim_end, // will be called when animation ends
6077     *                            NULL); // data for anim_end function\
6078     * elm_box_layout_set(box, elm_box_layout_transition, t,
6079     *                    elm_box_transition_free);
6080     * @endcode
6081     *
6082     * @note This function can only be used with elm_box_layout_set(). Calling
6083     * it directly will not have the expected results.
6084     *
6085     * @see elm_box_transition_new
6086     * @see elm_box_transition_free
6087     * @see elm_box_layout_set
6088     */
6089    EAPI void                elm_box_layout_transition(Evas_Object *obj, Evas_Object_Box_Data *priv, void *data);
6090    /**
6091     * Create a new ::Elm_Box_Transition to animate the switch of layouts
6092     *
6093     * If you want to animate the change from one layout to another, you need
6094     * to set the layout function of the box to elm_box_layout_transition(),
6095     * passing as user data to it an instance of ::Elm_Box_Transition with the
6096     * necessary information to perform this animation. The free function to
6097     * set for the layout is elm_box_transition_free().
6098     *
6099     * The parameters to create an ::Elm_Box_Transition sum up to how long
6100     * will it be, in seconds, a layout function to describe the initial point,
6101     * another for the final position of the children and one function to be
6102     * called when the whole animation ends. This last function is useful to
6103     * set the definitive layout for the box, usually the same as the end
6104     * layout for the animation, but could be used to start another transition.
6105     *
6106     * @param start_layout The layout function that will be used to start the animation
6107     * @param start_layout_data The data to be passed the @p start_layout function
6108     * @param start_layout_free_data Function to free @p start_layout_data
6109     * @param end_layout The layout function that will be used to end the animation
6110     * @param end_layout_free_data The data to be passed the @p end_layout function
6111     * @param end_layout_free_data Function to free @p end_layout_data
6112     * @param transition_end_cb Callback function called when animation ends
6113     * @param transition_end_data Data to be passed to @p transition_end_cb
6114     * @return An instance of ::Elm_Box_Transition
6115     *
6116     * @see elm_box_transition_new
6117     * @see elm_box_layout_transition
6118     */
6119    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);
6120    /**
6121     * Free a Elm_Box_Transition instance created with elm_box_transition_new().
6122     *
6123     * This function is mostly useful as the @c free_data parameter in
6124     * elm_box_layout_set() when elm_box_layout_transition().
6125     *
6126     * @param data The Elm_Box_Transition instance to be freed.
6127     *
6128     * @see elm_box_transition_new
6129     * @see elm_box_layout_transition
6130     */
6131    EAPI void                elm_box_transition_free(void *data);
6132    /**
6133     * @}
6134     */
6135
6136    /* button */
6137    /**
6138     * @defgroup Button Button
6139     *
6140     * @image html img/widget/button/preview-00.png
6141     * @image latex img/widget/button/preview-00.eps
6142     * @image html img/widget/button/preview-01.png
6143     * @image latex img/widget/button/preview-01.eps
6144     * @image html img/widget/button/preview-02.png
6145     * @image latex img/widget/button/preview-02.eps
6146     *
6147     * This is a push-button. Press it and run some function. It can contain
6148     * a simple label and icon object and it also has an autorepeat feature.
6149     *
6150     * This widgets emits the following signals:
6151     * @li "clicked": the user clicked the button (press/release).
6152     * @li "repeated": the user pressed the button without releasing it.
6153     * @li "pressed": button was pressed.
6154     * @li "unpressed": button was released after being pressed.
6155     * In all three cases, the @c event parameter of the callback will be
6156     * @c NULL.
6157     *
6158     * Also, defined in the default theme, the button has the following styles
6159     * available:
6160     * @li default: a normal button.
6161     * @li anchor: Like default, but the button fades away when the mouse is not
6162     * over it, leaving only the text or icon.
6163     * @li hoversel_vertical: Internally used by @ref Hoversel to give a
6164     * continuous look across its options.
6165     * @li hoversel_vertical_entry: Another internal for @ref Hoversel.
6166     *
6167     * Default contents parts of the button widget that you can use for are:
6168     * @li "elm.swallow.content" - A icon of the button
6169     *
6170     * Default text parts of the button widget that you can use for are:
6171     * @li "elm.text" - Label of the button
6172     *
6173     * Follow through a complete example @ref button_example_01 "here".
6174     * @{
6175     */
6176    /**
6177     * Add a new button to the parent's canvas
6178     *
6179     * @param parent The parent object
6180     * @return The new object or NULL if it cannot be created
6181     */
6182    EAPI Evas_Object *elm_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6183    /**
6184     * Set the label used in the button
6185     *
6186     * The passed @p label can be NULL to clean any existing text in it and
6187     * leave the button as an icon only object.
6188     *
6189     * @param obj The button object
6190     * @param label The text will be written on the button
6191     * @deprecated use elm_object_text_set() instead.
6192     */
6193    EINA_DEPRECATED EAPI void         elm_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6194    /**
6195     * Get the label set for the button
6196     *
6197     * The string returned is an internal pointer and should not be freed or
6198     * altered. It will also become invalid when the button is destroyed.
6199     * The string returned, if not NULL, is a stringshare, so if you need to
6200     * keep it around even after the button is destroyed, you can use
6201     * eina_stringshare_ref().
6202     *
6203     * @param obj The button object
6204     * @return The text set to the label, or NULL if nothing is set
6205     * @deprecated use elm_object_text_set() instead.
6206     */
6207    EINA_DEPRECATED EAPI const char  *elm_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6208    /**
6209     * Set the icon used for the button
6210     *
6211     * Setting a new icon will delete any other that was previously set, making
6212     * any reference to them invalid. If you need to maintain the previous
6213     * object alive, unset it first with elm_button_icon_unset().
6214     *
6215     * @param obj The button object
6216     * @param icon The icon object for the button
6217     * @deprecated use elm_object_content_set() instead.
6218     */
6219    EINA_DEPRECATED EAPI void         elm_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6220    /**
6221     * Get the icon used for the button
6222     *
6223     * Return the icon object which is set for this widget. If the button is
6224     * destroyed or another icon is set, the returned object will be deleted
6225     * and any reference to it will be invalid.
6226     *
6227     * @param obj The button object
6228     * @return The icon object that is being used
6229     *
6230     * @see elm_button_icon_unset()
6231     */
6232    EINA_DEPRECATED EAPI Evas_Object *elm_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6233    /**
6234     * Remove the icon set without deleting it and return the object
6235     *
6236     * This function drops the reference the button holds of the icon object
6237     * and returns this last object. It is used in case you want to remove any
6238     * icon, or set another one, without deleting the actual object. The button
6239     * will be left without an icon set.
6240     *
6241     * @param obj The button object
6242     * @return The icon object that was being used
6243     * @deprecated use elm_object_content_unset() instead.
6244     */
6245    EINA_DEPRECATED EAPI Evas_Object *elm_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6246    /**
6247     * Turn on/off the autorepeat event generated when the button is kept pressed
6248     *
6249     * When off, no autorepeat is performed and buttons emit a normal @c clicked
6250     * signal when they are clicked.
6251     *
6252     * When on, keeping a button pressed will continuously emit a @c repeated
6253     * signal until the button is released. The time it takes until it starts
6254     * emitting the signal is given by
6255     * elm_button_autorepeat_initial_timeout_set(), and the time between each
6256     * new emission by elm_button_autorepeat_gap_timeout_set().
6257     *
6258     * @param obj The button object
6259     * @param on  A bool to turn on/off the event
6260     */
6261    EAPI void         elm_button_autorepeat_set(Evas_Object *obj, Eina_Bool on) EINA_ARG_NONNULL(1);
6262    /**
6263     * Get whether the autorepeat feature is enabled
6264     *
6265     * @param obj The button object
6266     * @return EINA_TRUE if autorepeat is on, EINA_FALSE otherwise
6267     *
6268     * @see elm_button_autorepeat_set()
6269     */
6270    EAPI Eina_Bool    elm_button_autorepeat_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6271    /**
6272     * Set the initial timeout before the autorepeat event is generated
6273     *
6274     * Sets the timeout, in seconds, since the button is pressed until the
6275     * first @c repeated signal is emitted. If @p t is 0.0 or less, there
6276     * won't be any delay and the even will be fired the moment the button is
6277     * pressed.
6278     *
6279     * @param obj The button object
6280     * @param t   Timeout in seconds
6281     *
6282     * @see elm_button_autorepeat_set()
6283     * @see elm_button_autorepeat_gap_timeout_set()
6284     */
6285    EAPI void         elm_button_autorepeat_initial_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
6286    /**
6287     * Get the initial timeout before the autorepeat event is generated
6288     *
6289     * @param obj The button object
6290     * @return Timeout in seconds
6291     *
6292     * @see elm_button_autorepeat_initial_timeout_set()
6293     */
6294    EAPI double       elm_button_autorepeat_initial_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6295    /**
6296     * Set the interval between each generated autorepeat event
6297     *
6298     * After the first @c repeated event is fired, all subsequent ones will
6299     * follow after a delay of @p t seconds for each.
6300     *
6301     * @param obj The button object
6302     * @param t   Interval in seconds
6303     *
6304     * @see elm_button_autorepeat_initial_timeout_set()
6305     */
6306    EAPI void         elm_button_autorepeat_gap_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
6307    /**
6308     * Get the interval between each generated autorepeat event
6309     *
6310     * @param obj The button object
6311     * @return Interval in seconds
6312     */
6313    EAPI double       elm_button_autorepeat_gap_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6314    /**
6315     * @}
6316     */
6317
6318    /**
6319     * @defgroup File_Selector_Button File Selector Button
6320     *
6321     * @image html img/widget/fileselector_button/preview-00.png
6322     * @image latex img/widget/fileselector_button/preview-00.eps
6323     * @image html img/widget/fileselector_button/preview-01.png
6324     * @image latex img/widget/fileselector_button/preview-01.eps
6325     * @image html img/widget/fileselector_button/preview-02.png
6326     * @image latex img/widget/fileselector_button/preview-02.eps
6327     *
6328     * This is a button that, when clicked, creates an Elementary
6329     * window (or inner window) <b> with a @ref Fileselector "file
6330     * selector widget" within</b>. When a file is chosen, the (inner)
6331     * window is closed and the button emits a signal having the
6332     * selected file as it's @c event_info.
6333     *
6334     * This widget encapsulates operations on its internal file
6335     * selector on its own API. There is less control over its file
6336     * selector than that one would have instatiating one directly.
6337     *
6338     * The following styles are available for this button:
6339     * @li @c "default"
6340     * @li @c "anchor"
6341     * @li @c "hoversel_vertical"
6342     * @li @c "hoversel_vertical_entry"
6343     *
6344     * Smart callbacks one can register to:
6345     * - @c "file,chosen" - the user has selected a path, whose string
6346     *   pointer comes as the @c event_info data (a stringshared
6347     *   string)
6348     *
6349     * Here is an example on its usage:
6350     * @li @ref fileselector_button_example
6351     *
6352     * @see @ref File_Selector_Entry for a similar widget.
6353     * @{
6354     */
6355
6356    /**
6357     * Add a new file selector button widget to the given parent
6358     * Elementary (container) object
6359     *
6360     * @param parent The parent object
6361     * @return a new file selector button widget handle or @c NULL, on
6362     * errors
6363     */
6364    EAPI Evas_Object *elm_fileselector_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6365
6366    /**
6367     * Set the label for a given file selector button widget
6368     *
6369     * @param obj The file selector button widget
6370     * @param label The text label to be displayed on @p obj
6371     *
6372     * @deprecated use elm_object_text_set() instead.
6373     */
6374    EINA_DEPRECATED EAPI void         elm_fileselector_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6375
6376    /**
6377     * Get the label set for a given file selector button widget
6378     *
6379     * @param obj The file selector button widget
6380     * @return The button label
6381     *
6382     * @deprecated use elm_object_text_set() instead.
6383     */
6384    EINA_DEPRECATED EAPI const char  *elm_fileselector_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6385
6386    /**
6387     * Set the icon on a given file selector button widget
6388     *
6389     * @param obj The file selector button widget
6390     * @param icon The icon object for the button
6391     *
6392     * Once the icon object is set, a previously set one will be
6393     * deleted. If you want to keep the latter, use the
6394     * elm_fileselector_button_icon_unset() function.
6395     *
6396     * @see elm_fileselector_button_icon_get()
6397     */
6398    EAPI void         elm_fileselector_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6399
6400    /**
6401     * Get the icon set for a given file selector button widget
6402     *
6403     * @param obj The file selector button widget
6404     * @return The icon object currently set on @p obj or @c NULL, if
6405     * none is
6406     *
6407     * @see elm_fileselector_button_icon_set()
6408     */
6409    EAPI Evas_Object *elm_fileselector_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6410
6411    /**
6412     * Unset the icon used in a given file selector button widget
6413     *
6414     * @param obj The file selector button widget
6415     * @return The icon object that was being used on @p obj or @c
6416     * NULL, on errors
6417     *
6418     * Unparent and return the icon object which was set for this
6419     * widget.
6420     *
6421     * @see elm_fileselector_button_icon_set()
6422     */
6423    EAPI Evas_Object *elm_fileselector_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6424
6425    /**
6426     * Set the title for a given file selector button widget's window
6427     *
6428     * @param obj The file selector button widget
6429     * @param title The title string
6430     *
6431     * This will change the window's title, when the file selector pops
6432     * out after a click on the button. Those windows have the default
6433     * (unlocalized) value of @c "Select a file" as titles.
6434     *
6435     * @note It will only take any effect if the file selector
6436     * button widget is @b not under "inwin mode".
6437     *
6438     * @see elm_fileselector_button_window_title_get()
6439     */
6440    EAPI void         elm_fileselector_button_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6441
6442    /**
6443     * Get the title set for a given file selector button widget's
6444     * window
6445     *
6446     * @param obj The file selector button widget
6447     * @return Title of the file selector button's window
6448     *
6449     * @see elm_fileselector_button_window_title_get() for more details
6450     */
6451    EAPI const char  *elm_fileselector_button_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6452
6453    /**
6454     * Set the size of a given file selector button widget's window,
6455     * holding the file selector itself.
6456     *
6457     * @param obj The file selector button widget
6458     * @param width The window's width
6459     * @param height The window's height
6460     *
6461     * @note it will only take any effect if the file selector button
6462     * widget is @b not under "inwin mode". The default size for the
6463     * window (when applicable) is 400x400 pixels.
6464     *
6465     * @see elm_fileselector_button_window_size_get()
6466     */
6467    EAPI void         elm_fileselector_button_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6468
6469    /**
6470     * Get the size of a given file selector button widget's window,
6471     * holding the file selector itself.
6472     *
6473     * @param obj The file selector button widget
6474     * @param width Pointer into which to store the width value
6475     * @param height Pointer into which to store the height value
6476     *
6477     * @note Use @c NULL pointers on the size values you're not
6478     * interested in: they'll be ignored by the function.
6479     *
6480     * @see elm_fileselector_button_window_size_set(), for more details
6481     */
6482    EAPI void         elm_fileselector_button_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6483
6484    /**
6485     * Set the initial file system path for a given file selector
6486     * button widget
6487     *
6488     * @param obj The file selector button widget
6489     * @param path The path string
6490     *
6491     * It must be a <b>directory</b> path, which will have the contents
6492     * displayed initially in the file selector's view, when invoked
6493     * from @p obj. The default initial path is the @c "HOME"
6494     * environment variable's value.
6495     *
6496     * @see elm_fileselector_button_path_get()
6497     */
6498    EAPI void         elm_fileselector_button_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6499
6500    /**
6501     * Get the initial file system path set for a given file selector
6502     * button widget
6503     *
6504     * @param obj The file selector button widget
6505     * @return path The path string
6506     *
6507     * @see elm_fileselector_button_path_set() for more details
6508     */
6509    EAPI const char  *elm_fileselector_button_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6510
6511    /**
6512     * Enable/disable a tree view in the given file selector button
6513     * widget's internal file selector
6514     *
6515     * @param obj The file selector button widget
6516     * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
6517     * disable
6518     *
6519     * This has the same effect as elm_fileselector_expandable_set(),
6520     * but now applied to a file selector button's internal file
6521     * selector.
6522     *
6523     * @note There's no way to put a file selector button's internal
6524     * file selector in "grid mode", as one may do with "pure" file
6525     * selectors.
6526     *
6527     * @see elm_fileselector_expandable_get()
6528     */
6529    EAPI void         elm_fileselector_button_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6530
6531    /**
6532     * Get whether tree view is enabled for the given file selector
6533     * button widget's internal file selector
6534     *
6535     * @param obj The file selector button widget
6536     * @return @c EINA_TRUE if @p obj widget's internal file selector
6537     * is in tree view, @c EINA_FALSE otherwise (and or errors)
6538     *
6539     * @see elm_fileselector_expandable_set() for more details
6540     */
6541    EAPI Eina_Bool    elm_fileselector_button_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6542
6543    /**
6544     * Set whether a given file selector button widget's internal file
6545     * selector is to display folders only or the directory contents,
6546     * as well.
6547     *
6548     * @param obj The file selector button widget
6549     * @param only @c EINA_TRUE to make @p obj widget's internal file
6550     * selector only display directories, @c EINA_FALSE to make files
6551     * to be displayed in it too
6552     *
6553     * This has the same effect as elm_fileselector_folder_only_set(),
6554     * but now applied to a file selector button's internal file
6555     * selector.
6556     *
6557     * @see elm_fileselector_folder_only_get()
6558     */
6559    EAPI void         elm_fileselector_button_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6560
6561    /**
6562     * Get whether a given file selector button widget's internal file
6563     * selector is displaying folders only or the directory contents,
6564     * as well.
6565     *
6566     * @param obj The file selector button widget
6567     * @return @c EINA_TRUE if @p obj widget's internal file
6568     * selector is only displaying directories, @c EINA_FALSE if files
6569     * are being displayed in it too (and on errors)
6570     *
6571     * @see elm_fileselector_button_folder_only_set() for more details
6572     */
6573    EAPI Eina_Bool    elm_fileselector_button_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6574
6575    /**
6576     * Enable/disable the file name entry box where the user can type
6577     * in a name for a file, in a given file selector button widget's
6578     * internal file selector.
6579     *
6580     * @param obj The file selector button widget
6581     * @param is_save @c EINA_TRUE to make @p obj widget's internal
6582     * file selector a "saving dialog", @c EINA_FALSE otherwise
6583     *
6584     * This has the same effect as elm_fileselector_is_save_set(),
6585     * but now applied to a file selector button's internal file
6586     * selector.
6587     *
6588     * @see elm_fileselector_is_save_get()
6589     */
6590    EAPI void         elm_fileselector_button_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6591
6592    /**
6593     * Get whether the given file selector button widget's internal
6594     * file selector is in "saving dialog" mode
6595     *
6596     * @param obj The file selector button widget
6597     * @return @c EINA_TRUE, if @p obj widget's internal file selector
6598     * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
6599     * errors)
6600     *
6601     * @see elm_fileselector_button_is_save_set() for more details
6602     */
6603    EAPI Eina_Bool    elm_fileselector_button_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6604
6605    /**
6606     * Set whether a given file selector button widget's internal file
6607     * selector will raise an Elementary "inner window", instead of a
6608     * dedicated Elementary window. By default, it won't.
6609     *
6610     * @param obj The file selector button widget
6611     * @param value @c EINA_TRUE to make it use an inner window, @c
6612     * EINA_TRUE to make it use a dedicated window
6613     *
6614     * @see elm_win_inwin_add() for more information on inner windows
6615     * @see elm_fileselector_button_inwin_mode_get()
6616     */
6617    EAPI void         elm_fileselector_button_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6618
6619    /**
6620     * Get whether a given file selector button widget's internal file
6621     * selector will raise an Elementary "inner window", instead of a
6622     * dedicated Elementary window.
6623     *
6624     * @param obj The file selector button widget
6625     * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
6626     * if it will use a dedicated window
6627     *
6628     * @see elm_fileselector_button_inwin_mode_set() for more details
6629     */
6630    EAPI Eina_Bool    elm_fileselector_button_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6631
6632    /**
6633     * @}
6634     */
6635
6636     /**
6637     * @defgroup File_Selector_Entry File Selector Entry
6638     *
6639     * @image html img/widget/fileselector_entry/preview-00.png
6640     * @image latex img/widget/fileselector_entry/preview-00.eps
6641     *
6642     * This is an entry made to be filled with or display a <b>file
6643     * system path string</b>. Besides the entry itself, the widget has
6644     * a @ref File_Selector_Button "file selector button" on its side,
6645     * which will raise an internal @ref Fileselector "file selector widget",
6646     * when clicked, for path selection aided by file system
6647     * navigation.
6648     *
6649     * This file selector may appear in an Elementary window or in an
6650     * inner window. When a file is chosen from it, the (inner) window
6651     * is closed and the selected file's path string is exposed both as
6652     * an smart event and as the new text on the entry.
6653     *
6654     * This widget encapsulates operations on its internal file
6655     * selector on its own API. There is less control over its file
6656     * selector than that one would have instatiating one directly.
6657     *
6658     * Smart callbacks one can register to:
6659     * - @c "changed" - The text within the entry was changed
6660     * - @c "activated" - The entry has had editing finished and
6661     *   changes are to be "committed"
6662     * - @c "press" - The entry has been clicked
6663     * - @c "longpressed" - The entry has been clicked (and held) for a
6664     *   couple seconds
6665     * - @c "clicked" - The entry has been clicked
6666     * - @c "clicked,double" - The entry has been double clicked
6667     * - @c "focused" - The entry has received focus
6668     * - @c "unfocused" - The entry has lost focus
6669     * - @c "selection,paste" - A paste action has occurred on the
6670     *   entry
6671     * - @c "selection,copy" - A copy action has occurred on the entry
6672     * - @c "selection,cut" - A cut action has occurred on the entry
6673     * - @c "unpressed" - The file selector entry's button was released
6674     *   after being pressed.
6675     * - @c "file,chosen" - The user has selected a path via the file
6676     *   selector entry's internal file selector, whose string pointer
6677     *   comes as the @c event_info data (a stringshared string)
6678     *
6679     * Here is an example on its usage:
6680     * @li @ref fileselector_entry_example
6681     *
6682     * @see @ref File_Selector_Button for a similar widget.
6683     * @{
6684     */
6685
6686    /**
6687     * Add a new file selector entry widget to the given parent
6688     * Elementary (container) object
6689     *
6690     * @param parent The parent object
6691     * @return a new file selector entry widget handle or @c NULL, on
6692     * errors
6693     */
6694    EAPI Evas_Object *elm_fileselector_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6695
6696    /**
6697     * Set the label for a given file selector entry widget's button
6698     *
6699     * @param obj The file selector entry widget
6700     * @param label The text label to be displayed on @p obj widget's
6701     * button
6702     *
6703     * @deprecated use elm_object_text_set() instead.
6704     */
6705    EINA_DEPRECATED EAPI void         elm_fileselector_entry_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6706
6707    /**
6708     * Get the label set for a given file selector entry widget's button
6709     *
6710     * @param obj The file selector entry widget
6711     * @return The widget button's label
6712     *
6713     * @deprecated use elm_object_text_set() instead.
6714     */
6715    EINA_DEPRECATED EAPI const char  *elm_fileselector_entry_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6716
6717    /**
6718     * Set the icon on a given file selector entry widget's button
6719     *
6720     * @param obj The file selector entry widget
6721     * @param icon The icon object for the entry's button
6722     *
6723     * Once the icon object is set, a previously set one will be
6724     * deleted. If you want to keep the latter, use the
6725     * elm_fileselector_entry_button_icon_unset() function.
6726     *
6727     * @see elm_fileselector_entry_button_icon_get()
6728     */
6729    EAPI void         elm_fileselector_entry_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6730
6731    /**
6732     * Get the icon set for a given file selector entry widget's button
6733     *
6734     * @param obj The file selector entry widget
6735     * @return The icon object currently set on @p obj widget's button
6736     * or @c NULL, if none is
6737     *
6738     * @see elm_fileselector_entry_button_icon_set()
6739     */
6740    EAPI Evas_Object *elm_fileselector_entry_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6741
6742    /**
6743     * Unset the icon used in a given file selector entry widget's
6744     * button
6745     *
6746     * @param obj The file selector entry widget
6747     * @return The icon object that was being used on @p obj widget's
6748     * button or @c NULL, on errors
6749     *
6750     * Unparent and return the icon object which was set for this
6751     * widget's button.
6752     *
6753     * @see elm_fileselector_entry_button_icon_set()
6754     */
6755    EAPI Evas_Object *elm_fileselector_entry_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6756
6757    /**
6758     * Set the title for a given file selector entry widget's window
6759     *
6760     * @param obj The file selector entry widget
6761     * @param title The title string
6762     *
6763     * This will change the window's title, when the file selector pops
6764     * out after a click on the entry's button. Those windows have the
6765     * default (unlocalized) value of @c "Select a file" as titles.
6766     *
6767     * @note It will only take any effect if the file selector
6768     * entry widget is @b not under "inwin mode".
6769     *
6770     * @see elm_fileselector_entry_window_title_get()
6771     */
6772    EAPI void         elm_fileselector_entry_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6773
6774    /**
6775     * Get the title set for a given file selector entry widget's
6776     * window
6777     *
6778     * @param obj The file selector entry widget
6779     * @return Title of the file selector entry's window
6780     *
6781     * @see elm_fileselector_entry_window_title_get() for more details
6782     */
6783    EAPI const char  *elm_fileselector_entry_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6784
6785    /**
6786     * Set the size of a given file selector entry widget's window,
6787     * holding the file selector itself.
6788     *
6789     * @param obj The file selector entry widget
6790     * @param width The window's width
6791     * @param height The window's height
6792     *
6793     * @note it will only take any effect if the file selector entry
6794     * widget is @b not under "inwin mode". The default size for the
6795     * window (when applicable) is 400x400 pixels.
6796     *
6797     * @see elm_fileselector_entry_window_size_get()
6798     */
6799    EAPI void         elm_fileselector_entry_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6800
6801    /**
6802     * Get the size of a given file selector entry widget's window,
6803     * holding the file selector itself.
6804     *
6805     * @param obj The file selector entry widget
6806     * @param width Pointer into which to store the width value
6807     * @param height Pointer into which to store the height value
6808     *
6809     * @note Use @c NULL pointers on the size values you're not
6810     * interested in: they'll be ignored by the function.
6811     *
6812     * @see elm_fileselector_entry_window_size_set(), for more details
6813     */
6814    EAPI void         elm_fileselector_entry_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6815
6816    /**
6817     * Set the initial file system path and the entry's path string for
6818     * a given file selector entry widget
6819     *
6820     * @param obj The file selector entry widget
6821     * @param path The path string
6822     *
6823     * It must be a <b>directory</b> path, which will have the contents
6824     * displayed initially in the file selector's view, when invoked
6825     * from @p obj. The default initial path is the @c "HOME"
6826     * environment variable's value.
6827     *
6828     * @see elm_fileselector_entry_path_get()
6829     */
6830    EAPI void         elm_fileselector_entry_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6831
6832    /**
6833     * Get the entry's path string for a given file selector entry
6834     * widget
6835     *
6836     * @param obj The file selector entry widget
6837     * @return path The path string
6838     *
6839     * @see elm_fileselector_entry_path_set() for more details
6840     */
6841    EAPI const char  *elm_fileselector_entry_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6842
6843    /**
6844     * Enable/disable a tree view in the given file selector entry
6845     * widget's internal file selector
6846     *
6847     * @param obj The file selector entry widget
6848     * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
6849     * disable
6850     *
6851     * This has the same effect as elm_fileselector_expandable_set(),
6852     * but now applied to a file selector entry's internal file
6853     * selector.
6854     *
6855     * @note There's no way to put a file selector entry's internal
6856     * file selector in "grid mode", as one may do with "pure" file
6857     * selectors.
6858     *
6859     * @see elm_fileselector_expandable_get()
6860     */
6861    EAPI void         elm_fileselector_entry_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6862
6863    /**
6864     * Get whether tree view is enabled for the given file selector
6865     * entry widget's internal file selector
6866     *
6867     * @param obj The file selector entry widget
6868     * @return @c EINA_TRUE if @p obj widget's internal file selector
6869     * is in tree view, @c EINA_FALSE otherwise (and or errors)
6870     *
6871     * @see elm_fileselector_expandable_set() for more details
6872     */
6873    EAPI Eina_Bool    elm_fileselector_entry_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6874
6875    /**
6876     * Set whether a given file selector entry widget's internal file
6877     * selector is to display folders only or the directory contents,
6878     * as well.
6879     *
6880     * @param obj The file selector entry widget
6881     * @param only @c EINA_TRUE to make @p obj widget's internal file
6882     * selector only display directories, @c EINA_FALSE to make files
6883     * to be displayed in it too
6884     *
6885     * This has the same effect as elm_fileselector_folder_only_set(),
6886     * but now applied to a file selector entry's internal file
6887     * selector.
6888     *
6889     * @see elm_fileselector_folder_only_get()
6890     */
6891    EAPI void         elm_fileselector_entry_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6892
6893    /**
6894     * Get whether a given file selector entry widget's internal file
6895     * selector is displaying folders only or the directory contents,
6896     * as well.
6897     *
6898     * @param obj The file selector entry widget
6899     * @return @c EINA_TRUE if @p obj widget's internal file
6900     * selector is only displaying directories, @c EINA_FALSE if files
6901     * are being displayed in it too (and on errors)
6902     *
6903     * @see elm_fileselector_entry_folder_only_set() for more details
6904     */
6905    EAPI Eina_Bool    elm_fileselector_entry_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6906
6907    /**
6908     * Enable/disable the file name entry box where the user can type
6909     * in a name for a file, in a given file selector entry widget's
6910     * internal file selector.
6911     *
6912     * @param obj The file selector entry widget
6913     * @param is_save @c EINA_TRUE to make @p obj widget's internal
6914     * file selector a "saving dialog", @c EINA_FALSE otherwise
6915     *
6916     * This has the same effect as elm_fileselector_is_save_set(),
6917     * but now applied to a file selector entry's internal file
6918     * selector.
6919     *
6920     * @see elm_fileselector_is_save_get()
6921     */
6922    EAPI void         elm_fileselector_entry_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6923
6924    /**
6925     * Get whether the given file selector entry widget's internal
6926     * file selector is in "saving dialog" mode
6927     *
6928     * @param obj The file selector entry widget
6929     * @return @c EINA_TRUE, if @p obj widget's internal file selector
6930     * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
6931     * errors)
6932     *
6933     * @see elm_fileselector_entry_is_save_set() for more details
6934     */
6935    EAPI Eina_Bool    elm_fileselector_entry_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6936
6937    /**
6938     * Set whether a given file selector entry widget's internal file
6939     * selector will raise an Elementary "inner window", instead of a
6940     * dedicated Elementary window. By default, it won't.
6941     *
6942     * @param obj The file selector entry widget
6943     * @param value @c EINA_TRUE to make it use an inner window, @c
6944     * EINA_TRUE to make it use a dedicated window
6945     *
6946     * @see elm_win_inwin_add() for more information on inner windows
6947     * @see elm_fileselector_entry_inwin_mode_get()
6948     */
6949    EAPI void         elm_fileselector_entry_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6950
6951    /**
6952     * Get whether a given file selector entry widget's internal file
6953     * selector will raise an Elementary "inner window", instead of a
6954     * dedicated Elementary window.
6955     *
6956     * @param obj The file selector entry widget
6957     * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
6958     * if it will use a dedicated window
6959     *
6960     * @see elm_fileselector_entry_inwin_mode_set() for more details
6961     */
6962    EAPI Eina_Bool    elm_fileselector_entry_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6963
6964    /**
6965     * Set the initial file system path for a given file selector entry
6966     * widget
6967     *
6968     * @param obj The file selector entry widget
6969     * @param path The path string
6970     *
6971     * It must be a <b>directory</b> path, which will have the contents
6972     * displayed initially in the file selector's view, when invoked
6973     * from @p obj. The default initial path is the @c "HOME"
6974     * environment variable's value.
6975     *
6976     * @see elm_fileselector_entry_path_get()
6977     */
6978    EAPI void         elm_fileselector_entry_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6979
6980    /**
6981     * Get the parent directory's path to the latest file selection on
6982     * a given filer selector entry widget
6983     *
6984     * @param obj The file selector object
6985     * @return The (full) path of the directory of the last selection
6986     * on @p obj widget, a @b stringshared string
6987     *
6988     * @see elm_fileselector_entry_path_set()
6989     */
6990    EAPI const char  *elm_fileselector_entry_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6991
6992    /**
6993     * @}
6994     */
6995
6996    /**
6997     * @defgroup Scroller Scroller
6998     *
6999     * A scroller holds a single object and "scrolls it around". This means that
7000     * it allows the user to use a scrollbar (or a finger) to drag the viewable
7001     * region around, allowing to move through a much larger object that is
7002     * contained in the scroller. The scroller will always have a small minimum
7003     * size by default as it won't be limited by the contents of the scroller.
7004     *
7005     * Signals that you can add callbacks for are:
7006     * @li "edge,left" - the left edge of the content has been reached
7007     * @li "edge,right" - the right edge of the content has been reached
7008     * @li "edge,top" - the top edge of the content has been reached
7009     * @li "edge,bottom" - the bottom edge of the content has been reached
7010     * @li "scroll" - the content has been scrolled (moved)
7011     * @li "scroll,anim,start" - scrolling animation has started
7012     * @li "scroll,anim,stop" - scrolling animation has stopped
7013     * @li "scroll,drag,start" - dragging the contents around has started
7014     * @li "scroll,drag,stop" - dragging the contents around has stopped
7015     * @note The "scroll,anim,*" and "scroll,drag,*" signals are only emitted by
7016     * user intervetion.
7017     *
7018     * @note When Elemementary is in embedded mode the scrollbars will not be
7019     * dragable, they appear merely as indicators of how much has been scrolled.
7020     * @note When Elementary is in desktop mode the thumbscroll(a.k.a.
7021     * fingerscroll) won't work.
7022     *
7023     * To set/get/unset the content of the panel, you can use
7024     * elm_object_content_set/get/unset APIs.
7025     * Once the content object is set, a previously set one will be deleted.
7026     * If you want to keep that old content object, use the
7027     * elm_object_content_unset() function
7028     *
7029     * In @ref tutorial_scroller you'll find an example of how to use most of
7030     * this API.
7031     * @{
7032     */
7033    /**
7034     * @brief Type that controls when scrollbars should appear.
7035     *
7036     * @see elm_scroller_policy_set()
7037     */
7038    typedef enum _Elm_Scroller_Policy
7039      {
7040         ELM_SCROLLER_POLICY_AUTO = 0, /**< Show scrollbars as needed */
7041         ELM_SCROLLER_POLICY_ON, /**< Always show scrollbars */
7042         ELM_SCROLLER_POLICY_OFF, /**< Never show scrollbars */
7043         ELM_SCROLLER_POLICY_LAST
7044      } Elm_Scroller_Policy;
7045    /**
7046     * @brief Add a new scroller to the parent
7047     *
7048     * @param parent The parent object
7049     * @return The new object or NULL if it cannot be created
7050     */
7051    EAPI Evas_Object *elm_scroller_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7052    /**
7053     * @brief Set the content of the scroller widget (the object to be scrolled around).
7054     *
7055     * @param obj The scroller object
7056     * @param content The new content object
7057     *
7058     * Once the content object is set, a previously set one will be deleted.
7059     * If you want to keep that old content object, use the
7060     * elm_scroller_content_unset() function.
7061     * @deprecated See elm_object_content_set()
7062     */
7063    EINA_DEPRECATED EAPI void         elm_scroller_content_set(Evas_Object *obj, Evas_Object *child) EINA_ARG_NONNULL(1);
7064    /**
7065     * @brief Get the content of the scroller widget
7066     *
7067     * @param obj The slider object
7068     * @return The content that is being used
7069     *
7070     * Return the content object which is set for this widget
7071     *
7072     * @see elm_scroller_content_set()
7073     * @deprecated use elm_object_content_get() instead.
7074     */
7075    EINA_DEPRECATED EAPI Evas_Object *elm_scroller_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7076    /**
7077     * @brief Unset the content of the scroller widget
7078     *
7079     * @param obj The slider object
7080     * @return The content that was being used
7081     *
7082     * Unparent and return the content object which was set for this widget
7083     *
7084     * @see elm_scroller_content_set()
7085     * @deprecated use elm_object_content_unset() instead.
7086     */
7087    EINA_DEPRECATED EAPI Evas_Object *elm_scroller_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7088    /**
7089     * @brief Set custom theme elements for the scroller
7090     *
7091     * @param obj The scroller object
7092     * @param widget The widget name to use (default is "scroller")
7093     * @param base The base name to use (default is "base")
7094     */
7095    EAPI void         elm_scroller_custom_widget_base_theme_set(Evas_Object *obj, const char *widget, const char *base) EINA_ARG_NONNULL(1, 2, 3);
7096    /**
7097     * @brief Make the scroller minimum size limited to the minimum size of the content
7098     *
7099     * @param obj The scroller object
7100     * @param w Enable limiting minimum size horizontally
7101     * @param h Enable limiting minimum size vertically
7102     *
7103     * By default the scroller will be as small as its design allows,
7104     * irrespective of its content. This will make the scroller minimum size the
7105     * right size horizontally and/or vertically to perfectly fit its content in
7106     * that direction.
7107     */
7108    EAPI void         elm_scroller_content_min_limit(Evas_Object *obj, Eina_Bool w, Eina_Bool h) EINA_ARG_NONNULL(1);
7109    /**
7110     * @brief Show a specific virtual region within the scroller content object
7111     *
7112     * @param obj The scroller object
7113     * @param x X coordinate of the region
7114     * @param y Y coordinate of the region
7115     * @param w Width of the region
7116     * @param h Height of the region
7117     *
7118     * This will ensure all (or part if it does not fit) of the designated
7119     * region in the virtual content object (0, 0 starting at the top-left of the
7120     * virtual content object) is shown within the scroller.
7121     */
7122    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);
7123    /**
7124     * @brief Set the scrollbar visibility policy
7125     *
7126     * @param obj The scroller object
7127     * @param policy_h Horizontal scrollbar policy
7128     * @param policy_v Vertical scrollbar policy
7129     *
7130     * This sets the scrollbar visibility policy for the given scroller.
7131     * ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it is
7132     * needed, and otherwise kept hidden. ELM_SCROLLER_POLICY_ON turns it on all
7133     * the time, and ELM_SCROLLER_POLICY_OFF always keeps it off. This applies
7134     * respectively for the horizontal and vertical scrollbars.
7135     */
7136    EAPI void         elm_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
7137    /**
7138     * @brief Gets scrollbar visibility policy
7139     *
7140     * @param obj The scroller object
7141     * @param policy_h Horizontal scrollbar policy
7142     * @param policy_v Vertical scrollbar policy
7143     *
7144     * @see elm_scroller_policy_set()
7145     */
7146    EAPI void         elm_scroller_policy_get(const Evas_Object *obj, Elm_Scroller_Policy *policy_h, Elm_Scroller_Policy *policy_v) EINA_ARG_NONNULL(1);
7147    /**
7148     * @brief Get the currently visible content region
7149     *
7150     * @param obj The scroller object
7151     * @param x X coordinate of the region
7152     * @param y Y coordinate of the region
7153     * @param w Width of the region
7154     * @param h Height of the region
7155     *
7156     * This gets the current region in the content object that is visible through
7157     * the scroller. The region co-ordinates are returned in the @p x, @p y, @p
7158     * w, @p h values pointed to.
7159     *
7160     * @note All coordinates are relative to the content.
7161     *
7162     * @see elm_scroller_region_show()
7163     */
7164    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);
7165    /**
7166     * @brief Get the size of the content object
7167     *
7168     * @param obj The scroller object
7169     * @param w Width of the content object.
7170     * @param h Height of the content object.
7171     *
7172     * This gets the size of the content object of the scroller.
7173     */
7174    EAPI void         elm_scroller_child_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
7175    /**
7176     * @brief Set bouncing behavior
7177     *
7178     * @param obj The scroller object
7179     * @param h_bounce Allow bounce horizontally
7180     * @param v_bounce Allow bounce vertically
7181     *
7182     * When scrolling, the scroller may "bounce" when reaching an edge of the
7183     * content object. This is a visual way to indicate the end has been reached.
7184     * This is enabled by default for both axis. This API will set if it is enabled
7185     * for the given axis with the boolean parameters for each axis.
7186     */
7187    EAPI void         elm_scroller_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
7188    /**
7189     * @brief Get the bounce behaviour
7190     *
7191     * @param obj The Scroller object
7192     * @param h_bounce Will the scroller bounce horizontally or not
7193     * @param v_bounce Will the scroller bounce vertically or not
7194     *
7195     * @see elm_scroller_bounce_set()
7196     */
7197    EAPI void         elm_scroller_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
7198    /**
7199     * @brief Set scroll page size relative to viewport size.
7200     *
7201     * @param obj The scroller object
7202     * @param h_pagerel The horizontal page relative size
7203     * @param v_pagerel The vertical page relative size
7204     *
7205     * The scroller is capable of limiting scrolling by the user to "pages". That
7206     * is to jump by and only show a "whole page" at a time as if the continuous
7207     * area of the scroller content is split into page sized pieces. This sets
7208     * the size of a page relative to the viewport of the scroller. 1.0 is "1
7209     * viewport" is size (horizontally or vertically). 0.0 turns it off in that
7210     * axis. This is mutually exclusive with page size
7211     * (see elm_scroller_page_size_set()  for more information). Likewise 0.5
7212     * is "half a viewport". Sane usable values are normally between 0.0 and 1.0
7213     * including 1.0. If you only want 1 axis to be page "limited", use 0.0 for
7214     * the other axis.
7215     */
7216    EAPI void         elm_scroller_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
7217    /**
7218     * @brief Set scroll page size.
7219     *
7220     * @param obj The scroller object
7221     * @param h_pagesize The horizontal page size
7222     * @param v_pagesize The vertical page size
7223     *
7224     * This sets the page size to an absolute fixed value, with 0 turning it off
7225     * for that axis.
7226     *
7227     * @see elm_scroller_page_relative_set()
7228     */
7229    EAPI void         elm_scroller_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
7230    /**
7231     * @brief Get scroll current page number.
7232     *
7233     * @param obj The scroller object
7234     * @param h_pagenumber The horizontal page number
7235     * @param v_pagenumber The vertical page number
7236     *
7237     * The page number starts from 0. 0 is the first page.
7238     * Current page means the page which meets the top-left of the viewport.
7239     * If there are two or more pages in the viewport, it returns the number of the page
7240     * which meets the top-left of the viewport.
7241     *
7242     * @see elm_scroller_last_page_get()
7243     * @see elm_scroller_page_show()
7244     * @see elm_scroller_page_brint_in()
7245     */
7246    EAPI void         elm_scroller_current_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
7247    /**
7248     * @brief Get scroll last page number.
7249     *
7250     * @param obj The scroller object
7251     * @param h_pagenumber The horizontal page number
7252     * @param v_pagenumber The vertical page number
7253     *
7254     * The page number starts from 0. 0 is the first page.
7255     * This returns the last page number among the pages.
7256     *
7257     * @see elm_scroller_current_page_get()
7258     * @see elm_scroller_page_show()
7259     * @see elm_scroller_page_brint_in()
7260     */
7261    EAPI void         elm_scroller_last_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
7262    /**
7263     * Show a specific virtual region within the scroller content object by page number.
7264     *
7265     * @param obj The scroller object
7266     * @param h_pagenumber The horizontal page number
7267     * @param v_pagenumber The vertical page number
7268     *
7269     * 0, 0 of the indicated page is located at the top-left of the viewport.
7270     * This will jump to the page directly without animation.
7271     *
7272     * Example of usage:
7273     *
7274     * @code
7275     * sc = elm_scroller_add(win);
7276     * elm_scroller_content_set(sc, content);
7277     * elm_scroller_page_relative_set(sc, 1, 0);
7278     * elm_scroller_current_page_get(sc, &h_page, &v_page);
7279     * elm_scroller_page_show(sc, h_page + 1, v_page);
7280     * @endcode
7281     *
7282     * @see elm_scroller_page_bring_in()
7283     */
7284    EAPI void         elm_scroller_page_show(Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
7285    /**
7286     * Show a specific virtual region within the scroller content object by page number.
7287     *
7288     * @param obj The scroller object
7289     * @param h_pagenumber The horizontal page number
7290     * @param v_pagenumber The vertical page number
7291     *
7292     * 0, 0 of the indicated page is located at the top-left of the viewport.
7293     * This will slide to the page with animation.
7294     *
7295     * Example of usage:
7296     *
7297     * @code
7298     * sc = elm_scroller_add(win);
7299     * elm_scroller_content_set(sc, content);
7300     * elm_scroller_page_relative_set(sc, 1, 0);
7301     * elm_scroller_last_page_get(sc, &h_page, &v_page);
7302     * elm_scroller_page_bring_in(sc, h_page, v_page);
7303     * @endcode
7304     *
7305     * @see elm_scroller_page_show()
7306     */
7307    EAPI void         elm_scroller_page_bring_in(Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
7308    /**
7309     * @brief Show a specific virtual region within the scroller content object.
7310     *
7311     * @param obj The scroller object
7312     * @param x X coordinate of the region
7313     * @param y Y coordinate of the region
7314     * @param w Width of the region
7315     * @param h Height of the region
7316     *
7317     * This will ensure all (or part if it does not fit) of the designated
7318     * region in the virtual content object (0, 0 starting at the top-left of the
7319     * virtual content object) is shown within the scroller. Unlike
7320     * elm_scroller_region_show(), this allow the scroller to "smoothly slide"
7321     * to this location (if configuration in general calls for transitions). It
7322     * may not jump immediately to the new location and make take a while and
7323     * show other content along the way.
7324     *
7325     * @see elm_scroller_region_show()
7326     */
7327    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);
7328    /**
7329     * @brief Set event propagation on a scroller
7330     *
7331     * @param obj The scroller object
7332     * @param propagation If propagation is enabled or not
7333     *
7334     * This enables or disabled event propagation from the scroller content to
7335     * the scroller and its parent. By default event propagation is disabled.
7336     */
7337    EAPI void         elm_scroller_propagate_events_set(Evas_Object *obj, Eina_Bool propagation) EINA_ARG_NONNULL(1);
7338    /**
7339     * @brief Get event propagation for a scroller
7340     *
7341     * @param obj The scroller object
7342     * @return The propagation state
7343     *
7344     * This gets the event propagation for a scroller.
7345     *
7346     * @see elm_scroller_propagate_events_set()
7347     */
7348    EAPI Eina_Bool    elm_scroller_propagate_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7349    /**
7350     * @brief Set scrolling gravity on a scroller
7351     *
7352     * @param obj The scroller object
7353     * @param x The scrolling horizontal gravity
7354     * @param y The scrolling vertical gravity
7355     *
7356     * The gravity, defines how the scroller will adjust its view
7357     * when the size of the scroller contents increase.
7358     *
7359     * The scroller will adjust the view to glue itself as follows.
7360     *
7361     *  x=0.0, for showing the left most region of the content.
7362     *  x=1.0, for showing the right most region of the content.
7363     *  y=0.0, for showing the bottom most region of the content.
7364     *  y=1.0, for showing the top most region of the content.
7365     *
7366     * Default values for x and y are 0.0
7367     */
7368    EAPI void         elm_scroller_gravity_set(Evas_Object *obj, double x, double y) EINA_ARG_NONNULL(1);
7369    /**
7370     * @brief Get scrolling gravity values for a scroller
7371     *
7372     * @param obj The scroller object
7373     * @param x The scrolling horizontal gravity
7374     * @param y The scrolling vertical gravity
7375     *
7376     * This gets gravity values for a scroller.
7377     *
7378     * @see elm_scroller_gravity_set()
7379     *
7380     */
7381    EAPI void         elm_scroller_gravity_get(const Evas_Object *obj, double *x, double *y) EINA_ARG_NONNULL(1);
7382    /**
7383     * @}
7384     */
7385
7386    /**
7387     * @defgroup Label Label
7388     *
7389     * @image html img/widget/label/preview-00.png
7390     * @image latex img/widget/label/preview-00.eps
7391     *
7392     * @brief Widget to display text, with simple html-like markup.
7393     *
7394     * The Label widget @b doesn't allow text to overflow its boundaries, if the
7395     * text doesn't fit the geometry of the label it will be ellipsized or be
7396     * cut. Elementary provides several themes for this widget:
7397     * @li default - No animation
7398     * @li marker - Centers the text in the label and make it bold by default
7399     * @li slide_long - The entire text appears from the right of the screen and
7400     * slides until it disappears in the left of the screen(reappering on the
7401     * right again).
7402     * @li slide_short - The text appears in the left of the label and slides to
7403     * the right to show the overflow. When all of the text has been shown the
7404     * position is reset.
7405     * @li slide_bounce - The text appears in the left of the label and slides to
7406     * the right to show the overflow. When all of the text has been shown the
7407     * animation reverses, moving the text to the left.
7408     *
7409     * Custom themes can of course invent new markup tags and style them any way
7410     * they like.
7411     *
7412     * The following signals may be emitted by the label widget:
7413     * @li "language,changed": The program's language changed.
7414     *
7415     * See @ref tutorial_label for a demonstration of how to use a label widget.
7416     * @{
7417     */
7418    /**
7419     * @brief Add a new label to the parent
7420     *
7421     * @param parent The parent object
7422     * @return The new object or NULL if it cannot be created
7423     */
7424    EAPI Evas_Object *elm_label_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7425    /**
7426     * @brief Set the label on the label object
7427     *
7428     * @param obj The label object
7429     * @param label The label will be used on the label object
7430     * @deprecated See elm_object_text_set()
7431     */
7432    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 */
7433    /**
7434     * @brief Get the label used on the label object
7435     *
7436     * @param obj The label object
7437     * @return The string inside the label
7438     * @deprecated See elm_object_text_get()
7439     */
7440    EINA_DEPRECATED EAPI const char *elm_label_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1); /* deprecated, use elm_object_text_get instead */
7441    /**
7442     * @brief Set the wrapping behavior of the label
7443     *
7444     * @param obj The label object
7445     * @param wrap To wrap text or not
7446     *
7447     * By default no wrapping is done. Possible values for @p wrap are:
7448     * @li ELM_WRAP_NONE - No wrapping
7449     * @li ELM_WRAP_CHAR - wrap between characters
7450     * @li ELM_WRAP_WORD - wrap between words
7451     * @li ELM_WRAP_MIXED - Word wrap, and if that fails, char wrap
7452     */
7453    EAPI void         elm_label_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
7454    /**
7455     * @brief Get the wrapping behavior of the label
7456     *
7457     * @param obj The label object
7458     * @return Wrap type
7459     *
7460     * @see elm_label_line_wrap_set()
7461     */
7462    EAPI Elm_Wrap_Type elm_label_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7463    /**
7464     * @brief Set wrap width of the label
7465     *
7466     * @param obj The label object
7467     * @param w The wrap width in pixels at a minimum where words need to wrap
7468     *
7469     * This function sets the maximum width size hint of the label.
7470     *
7471     * @warning This is only relevant if the label is inside a container.
7472     */
7473    EAPI void         elm_label_wrap_width_set(Evas_Object *obj, Evas_Coord w) EINA_ARG_NONNULL(1);
7474    /**
7475     * @brief Get wrap width of the label
7476     *
7477     * @param obj The label object
7478     * @return The wrap width in pixels at a minimum where words need to wrap
7479     *
7480     * @see elm_label_wrap_width_set()
7481     */
7482    EAPI Evas_Coord   elm_label_wrap_width_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7483    /**
7484     * @brief Set wrap height of the label
7485     *
7486     * @param obj The label object
7487     * @param h The wrap height in pixels at a minimum where words need to wrap
7488     *
7489     * This function sets the maximum height size hint of the label.
7490     *
7491     * @warning This is only relevant if the label is inside a container.
7492     */
7493    EAPI void         elm_label_wrap_height_set(Evas_Object *obj, Evas_Coord h) EINA_ARG_NONNULL(1);
7494    /**
7495     * @brief get wrap width of the label
7496     *
7497     * @param obj The label object
7498     * @return The wrap height in pixels at a minimum where words need to wrap
7499     */
7500    EAPI Evas_Coord   elm_label_wrap_height_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7501    /**
7502     * @brief Set the font size on the label object.
7503     *
7504     * @param obj The label object
7505     * @param size font size
7506     *
7507     * @warning NEVER use this. It is for hyper-special cases only. use styles
7508     * instead. e.g. "big", "medium", "small" - or better name them by use:
7509     * "title", "footnote", "quote" etc.
7510     */
7511    EAPI void         elm_label_fontsize_set(Evas_Object *obj, int fontsize) EINA_ARG_NONNULL(1);
7512    /**
7513     * @brief Set the text color on the label object
7514     *
7515     * @param obj The label object
7516     * @param r Red property background color of The label object
7517     * @param g Green property background color of The label object
7518     * @param b Blue property background color of The label object
7519     * @param a Alpha property background color of The label object
7520     *
7521     * @warning NEVER use this. It is for hyper-special cases only. use styles
7522     * instead. e.g. "big", "medium", "small" - or better name them by use:
7523     * "title", "footnote", "quote" etc.
7524     */
7525    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);
7526    /**
7527     * @brief Set the text align on the label object
7528     *
7529     * @param obj The label object
7530     * @param align align mode ("left", "center", "right")
7531     *
7532     * @warning NEVER use this. It is for hyper-special cases only. use styles
7533     * instead. e.g. "big", "medium", "small" - or better name them by use:
7534     * "title", "footnote", "quote" etc.
7535     */
7536    EAPI void         elm_label_text_align_set(Evas_Object *obj, const char *alignmode) EINA_ARG_NONNULL(1);
7537    /**
7538     * @brief Set background color of the label
7539     *
7540     * @param obj The label object
7541     * @param r Red property background color of The label object
7542     * @param g Green property background color of The label object
7543     * @param b Blue property background color of The label object
7544     * @param a Alpha property background alpha of The label object
7545     *
7546     * @warning NEVER use this. It is for hyper-special cases only. use styles
7547     * instead. e.g. "big", "medium", "small" - or better name them by use:
7548     * "title", "footnote", "quote" etc.
7549     */
7550    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);
7551    /**
7552     * @brief Set the ellipsis behavior of the label
7553     *
7554     * @param obj The label object
7555     * @param ellipsis To ellipsis text or not
7556     *
7557     * If set to true and the text doesn't fit in the label an ellipsis("...")
7558     * will be shown at the end of the widget.
7559     *
7560     * @warning This doesn't work with slide(elm_label_slide_set()) or if the
7561     * choosen wrap method was ELM_WRAP_WORD.
7562     */
7563    EAPI void         elm_label_ellipsis_set(Evas_Object *obj, Eina_Bool ellipsis) EINA_ARG_NONNULL(1);
7564    /**
7565     * @brief Set the text slide of the label
7566     *
7567     * @param obj The label object
7568     * @param slide To start slide or stop
7569     *
7570     * If set to true, the text of the label will slide/scroll through the length of
7571     * label.
7572     *
7573     * @warning This only works with the themes "slide_short", "slide_long" and
7574     * "slide_bounce".
7575     */
7576    EAPI void         elm_label_slide_set(Evas_Object *obj, Eina_Bool slide) EINA_ARG_NONNULL(1);
7577    /**
7578     * @brief Get the text slide mode of the label
7579     *
7580     * @param obj The label object
7581     * @return slide slide mode value
7582     *
7583     * @see elm_label_slide_set()
7584     */
7585    EAPI Eina_Bool    elm_label_slide_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7586    /**
7587     * @brief Set the slide duration(speed) of the label
7588     *
7589     * @param obj The label object
7590     * @return The duration in seconds in moving text from slide begin position
7591     * to slide end position
7592     */
7593    EAPI void         elm_label_slide_duration_set(Evas_Object *obj, double duration) EINA_ARG_NONNULL(1);
7594    /**
7595     * @brief Get the slide duration(speed) of the label
7596     *
7597     * @param obj The label object
7598     * @return The duration time in moving text from slide begin position to slide end position
7599     *
7600     * @see elm_label_slide_duration_set()
7601     */
7602    EAPI double       elm_label_slide_duration_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7603    /**
7604     * @}
7605     */
7606
7607    /**
7608     * @defgroup Toggle Toggle
7609     *
7610     * @image html img/widget/toggle/preview-00.png
7611     * @image latex img/widget/toggle/preview-00.eps
7612     *
7613     * @brief A toggle is a slider which can be used to toggle between
7614     * two values.  It has two states: on and off.
7615     *
7616     * This widget is deprecated. Please use elm_check_add() instead using the
7617     * toggle style like:
7618     * 
7619     * @code
7620     * obj = elm_check_add(parent);
7621     * elm_object_style_set(obj, "toggle");
7622     * elm_object_text_part_set(obj, "on", "ON");
7623     * elm_object_text_part_set(obj, "off", "OFF");
7624     * @endcode
7625     * 
7626     * Signals that you can add callbacks for are:
7627     * @li "changed" - Whenever the toggle value has been changed.  Is not called
7628     *                 until the toggle is released by the cursor (assuming it
7629     *                 has been triggered by the cursor in the first place).
7630     *
7631     * @ref tutorial_toggle show how to use a toggle.
7632     * @{
7633     */
7634    /**
7635     * @brief Add a toggle to @p parent.
7636     *
7637     * @param parent The parent object
7638     *
7639     * @return The toggle object
7640     */
7641    EINA_DEPRECATED EAPI Evas_Object *elm_toggle_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7642    /**
7643     * @brief Sets the label to be displayed with the toggle.
7644     *
7645     * @param obj The toggle object
7646     * @param label The label to be displayed
7647     *
7648     * @deprecated use elm_object_text_set() instead.
7649     */
7650    EINA_DEPRECATED EAPI void         elm_toggle_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7651    /**
7652     * @brief Gets the label of the toggle
7653     *
7654     * @param obj  toggle object
7655     * @return The label of the toggle
7656     *
7657     * @deprecated use elm_object_text_get() instead.
7658     */
7659    EINA_DEPRECATED EAPI const char  *elm_toggle_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7660    /**
7661     * @brief Set the icon used for the toggle
7662     *
7663     * @param obj The toggle object
7664     * @param icon The icon object for the button
7665     *
7666     * Once the icon object is set, a previously set one will be deleted
7667     * If you want to keep that old content object, use the
7668     * elm_toggle_icon_unset() function.
7669     *
7670     * @deprecated use elm_object_content_set() instead.
7671     */
7672    EINA_DEPRECATED EAPI void         elm_toggle_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
7673    /**
7674     * @brief Get the icon used for the toggle
7675     *
7676     * @param obj The toggle object
7677     * @return The icon object that is being used
7678     *
7679     * Return the icon object which is set for this widget.
7680     *
7681     * @see elm_toggle_icon_set()
7682     *
7683     * @deprecated use elm_object_content_get() instead.
7684     */
7685    EINA_DEPRECATED EAPI Evas_Object *elm_toggle_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7686    /**
7687     * @brief Unset the icon used for the toggle
7688     *
7689     * @param obj The toggle object
7690     * @return The icon object that was being used
7691     *
7692     * Unparent and return the icon object which was set for this widget.
7693     *
7694     * @see elm_toggle_icon_set()
7695     *
7696     * @deprecated use elm_object_content_unset() instead.
7697     */
7698    EINA_DEPRECATED EAPI Evas_Object *elm_toggle_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7699    /**
7700     * @brief Sets the labels to be associated with the on and off states of the toggle.
7701     *
7702     * @param obj The toggle object
7703     * @param onlabel The label displayed when the toggle is in the "on" state
7704     * @param offlabel The label displayed when the toggle is in the "off" state
7705     *
7706     * @deprecated use elm_object_text_part_set() for "on" and "off" parts
7707     * instead.
7708     */
7709    EINA_DEPRECATED EAPI void         elm_toggle_states_labels_set(Evas_Object *obj, const char *onlabel, const char *offlabel) EINA_ARG_NONNULL(1);
7710    /**
7711     * @brief Gets the labels associated with the on and off states of the
7712     * toggle.
7713     *
7714     * @param obj The toggle object
7715     * @param onlabel A char** to place the onlabel of @p obj into
7716     * @param offlabel A char** to place the offlabel of @p obj into
7717     *
7718     * @deprecated use elm_object_text_part_get() for "on" and "off" parts
7719     * instead.
7720     */
7721    EINA_DEPRECATED EAPI void         elm_toggle_states_labels_get(const Evas_Object *obj, const char **onlabel, const char **offlabel) EINA_ARG_NONNULL(1);
7722    /**
7723     * @brief Sets the state of the toggle to @p state.
7724     *
7725     * @param obj The toggle object
7726     * @param state The state of @p obj
7727     *
7728     * @deprecated use elm_check_state_set() instead.
7729     */
7730    EINA_DEPRECATED EAPI void         elm_toggle_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
7731    /**
7732     * @brief Gets the state of the toggle to @p state.
7733     *
7734     * @param obj The toggle object
7735     * @return The state of @p obj
7736     *
7737     * @deprecated use elm_check_state_get() instead.
7738     */
7739    EINA_DEPRECATED EAPI Eina_Bool    elm_toggle_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7740    /**
7741     * @brief Sets the state pointer of the toggle to @p statep.
7742     *
7743     * @param obj The toggle object
7744     * @param statep The state pointer of @p obj
7745     *
7746     * @deprecated use elm_check_state_pointer_set() instead.
7747     */
7748    EINA_DEPRECATED EAPI void         elm_toggle_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
7749    /**
7750     * @}
7751     */
7752
7753    /**
7754     * @defgroup Frame Frame
7755     *
7756     * @image html img/widget/frame/preview-00.png
7757     * @image latex img/widget/frame/preview-00.eps
7758     *
7759     * @brief Frame is a widget that holds some content and has a title.
7760     *
7761     * The default look is a frame with a title, but Frame supports multple
7762     * styles:
7763     * @li default
7764     * @li pad_small
7765     * @li pad_medium
7766     * @li pad_large
7767     * @li pad_huge
7768     * @li outdent_top
7769     * @li outdent_bottom
7770     *
7771     * Of all this styles only default shows the title. Frame emits no signals.
7772     *
7773     * Default contents parts of the frame widget that you can use for are:
7774     * @li "elm.swallow.content" - A content of the frame
7775     *
7776     * Default text parts of the frame widget that you can use for are:
7777     * @li "elm.text" - Label of the frame
7778     *
7779     * For a detailed example see the @ref tutorial_frame.
7780     *
7781     * @{
7782     */
7783    /**
7784     * @brief Add a new frame to the parent
7785     *
7786     * @param parent The parent object
7787     * @return The new object or NULL if it cannot be created
7788     */
7789    EAPI Evas_Object *elm_frame_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7790    /**
7791     * @brief Set the frame label
7792     *
7793     * @param obj The frame object
7794     * @param label The label of this frame object
7795     *
7796     * @deprecated use elm_object_text_set() instead.
7797     */
7798    EINA_DEPRECATED EAPI void         elm_frame_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7799    /**
7800     * @brief Get the frame label
7801     *
7802     * @param obj The frame object
7803     *
7804     * @return The label of this frame objet or NULL if unable to get frame
7805     *
7806     * @deprecated use elm_object_text_get() instead.
7807     */
7808    EINA_DEPRECATED EAPI const char  *elm_frame_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7809    /**
7810     * @brief Set the content of the frame widget
7811     *
7812     * Once the content object is set, a previously set one will be deleted.
7813     * If you want to keep that old content object, use the
7814     * elm_frame_content_unset() function.
7815     *
7816     * @param obj The frame object
7817     * @param content The content will be filled in this frame object
7818     */
7819    EINA_DEPRECATED EAPI void         elm_frame_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
7820    /**
7821     * @brief Get the content of the frame widget
7822     *
7823     * Return the content object which is set for this widget
7824     *
7825     * @param obj The frame object
7826     * @return The content that is being used
7827     */
7828    EINA_DEPRECATED EAPI Evas_Object *elm_frame_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7829    /**
7830     * @brief Unset the content of the frame widget
7831     *
7832     * Unparent and return the content object which was set for this widget
7833     *
7834     * @param obj The frame object
7835     * @return The content that was being used
7836     */
7837    EINA_DEPRECATED EAPI Evas_Object *elm_frame_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7838    /**
7839     * @}
7840     */
7841
7842    /**
7843     * @defgroup Table Table
7844     *
7845     * A container widget to arrange other widgets in a table where items can
7846     * also span multiple columns or rows - even overlap (and then be raised or
7847     * lowered accordingly to adjust stacking if they do overlap).
7848     *
7849     * For a Table widget the row/column count is not fixed.
7850     * The table widget adjusts itself when subobjects are added to it dynamically.
7851     *
7852     * The followin are examples of how to use a table:
7853     * @li @ref tutorial_table_01
7854     * @li @ref tutorial_table_02
7855     *
7856     * @{
7857     */
7858    /**
7859     * @brief Add a new table to the parent
7860     *
7861     * @param parent The parent object
7862     * @return The new object or NULL if it cannot be created
7863     */
7864    EAPI Evas_Object *elm_table_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7865    /**
7866     * @brief Set the homogeneous layout in the table
7867     *
7868     * @param obj The layout object
7869     * @param homogeneous A boolean to set if the layout is homogeneous in the
7870     * table (EINA_TRUE = homogeneous,  EINA_FALSE = no homogeneous)
7871     */
7872    EAPI void         elm_table_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
7873    /**
7874     * @brief Get the current table homogeneous mode.
7875     *
7876     * @param obj The table object
7877     * @return A boolean to indicating if the layout is homogeneous in the table
7878     * (EINA_TRUE = homogeneous,  EINA_FALSE = no homogeneous)
7879     */
7880    EAPI Eina_Bool    elm_table_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7881    /**
7882     * @warning <b>Use elm_table_homogeneous_set() instead</b>
7883     */
7884    EINA_DEPRECATED EAPI void elm_table_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
7885    /**
7886     * @warning <b>Use elm_table_homogeneous_get() instead</b>
7887     */
7888    EINA_DEPRECATED EAPI Eina_Bool elm_table_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7889    /**
7890     * @brief Set padding between cells.
7891     *
7892     * @param obj The layout object.
7893     * @param horizontal set the horizontal padding.
7894     * @param vertical set the vertical padding.
7895     *
7896     * Default value is 0.
7897     */
7898    EAPI void         elm_table_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
7899    /**
7900     * @brief Get padding between cells.
7901     *
7902     * @param obj The layout object.
7903     * @param horizontal set the horizontal padding.
7904     * @param vertical set the vertical padding.
7905     */
7906    EAPI void         elm_table_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
7907    /**
7908     * @brief Add a subobject on the table with the coordinates passed
7909     *
7910     * @param obj The table object
7911     * @param subobj The subobject to be added to the table
7912     * @param x Row number
7913     * @param y Column number
7914     * @param w rowspan
7915     * @param h colspan
7916     *
7917     * @note All positioning inside the table is relative to rows and columns, so
7918     * a value of 0 for x and y, means the top left cell of the table, and a
7919     * value of 1 for w and h means @p subobj only takes that 1 cell.
7920     */
7921    EAPI void         elm_table_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
7922    /**
7923     * @brief Remove child from table.
7924     *
7925     * @param obj The table object
7926     * @param subobj The subobject
7927     */
7928    EAPI void         elm_table_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
7929    /**
7930     * @brief Faster way to remove all child objects from a table object.
7931     *
7932     * @param obj The table object
7933     * @param clear If true, will delete children, else just remove from table.
7934     */
7935    EAPI void         elm_table_clear(Evas_Object *obj, Eina_Bool clear) EINA_ARG_NONNULL(1);
7936    /**
7937     * @brief Set the packing location of an existing child of the table
7938     *
7939     * @param subobj The subobject to be modified in the table
7940     * @param x Row number
7941     * @param y Column number
7942     * @param w rowspan
7943     * @param h colspan
7944     *
7945     * Modifies the position of an object already in the table.
7946     *
7947     * @note All positioning inside the table is relative to rows and columns, so
7948     * a value of 0 for x and y, means the top left cell of the table, and a
7949     * value of 1 for w and h means @p subobj only takes that 1 cell.
7950     */
7951    EAPI void         elm_table_pack_set(Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
7952    /**
7953     * @brief Get the packing location of an existing child of the table
7954     *
7955     * @param subobj The subobject to be modified in the table
7956     * @param x Row number
7957     * @param y Column number
7958     * @param w rowspan
7959     * @param h colspan
7960     *
7961     * @see elm_table_pack_set()
7962     */
7963    EAPI void         elm_table_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
7964    /**
7965     * @}
7966     */
7967
7968    /* TEMPORARY: DOCS WILL BE FILLED IN WITH CNP/SED */
7969    typedef struct Elm_Gen_Item Elm_Gen_Item;
7970    typedef struct _Elm_Gen_Item_Class Elm_Gen_Item_Class;
7971    typedef struct _Elm_Gen_Item_Class_Func Elm_Gen_Item_Class_Func; /**< Class functions for gen item classes. */
7972    typedef char        *(*Elm_Gen_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for gen item classes. */
7973    typedef Evas_Object *(*Elm_Gen_Item_Content_Get_Cb)  (void *data, Evas_Object *obj, const char *part); /**< Content(swallowed object) fetching class function for gen item classes. */
7974    typedef Eina_Bool    (*Elm_Gen_Item_State_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< State fetching class function for gen item classes. */
7975    typedef void         (*Elm_Gen_Item_Del_Cb)      (void *data, Evas_Object *obj); /**< Deletion class function for gen item classes. */
7976    struct _Elm_Gen_Item_Class
7977      {
7978         const char             *item_style;
7979         struct _Elm_Gen_Item_Class_Func
7980           {
7981              Elm_Gen_Item_Label_Get_Cb label_get;
7982              Elm_Gen_Item_Content_Get_Cb  content_get;
7983              Elm_Gen_Item_State_Get_Cb state_get;
7984              Elm_Gen_Item_Del_Cb       del;
7985           } func;
7986      };
7987    EAPI void elm_gen_clear(Evas_Object *obj);
7988    EAPI void elm_gen_item_selected_set(Elm_Gen_Item *it, Eina_Bool selected);
7989    EAPI Eina_Bool elm_gen_item_selected_get(const Elm_Gen_Item *it);
7990    EAPI void elm_gen_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select);
7991    EAPI Eina_Bool elm_gen_always_select_mode_get(const Evas_Object *obj);
7992    EAPI void elm_gen_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select);
7993    EAPI Eina_Bool elm_gen_no_select_mode_get(const Evas_Object *obj);
7994    EAPI void elm_gen_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
7995    EAPI void elm_gen_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
7996    EAPI void elm_gen_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel);
7997    EAPI void elm_gen_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel);
7998    EAPI void elm_gen_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize);
7999    EAPI void elm_gen_current_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber);
8000    EAPI void elm_gen_last_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber);
8001    EAPI void elm_gen_page_show(const Evas_Object *obj, int h_pagenumber, int v_pagenumber);
8002    EAPI void elm_gen_page_bring_in(const Evas_Object *obj, int h_pagenumber, int v_pagenumber);
8003    EAPI Elm_Gen_Item *elm_gen_first_item_get(const Evas_Object *obj);
8004    EAPI Elm_Gen_Item *elm_gen_last_item_get(const Evas_Object *obj);
8005    EAPI Elm_Gen_Item *elm_gen_item_next_get(const Elm_Gen_Item *it);
8006    EAPI Elm_Gen_Item *elm_gen_item_prev_get(const Elm_Gen_Item *it);
8007    EAPI Evas_Object *elm_gen_item_widget_get(const Elm_Gen_Item *it);
8008
8009    /**
8010     * @defgroup Gengrid Gengrid (Generic grid)
8011     *
8012     * This widget aims to position objects in a grid layout while
8013     * actually creating and rendering only the visible ones, using the
8014     * same idea as the @ref Genlist "genlist": the user defines a @b
8015     * class for each item, specifying functions that will be called at
8016     * object creation, deletion, etc. When those items are selected by
8017     * the user, a callback function is issued. Users may interact with
8018     * a gengrid via the mouse (by clicking on items to select them and
8019     * clicking on the grid's viewport and swiping to pan the whole
8020     * view) or via the keyboard, navigating through item with the
8021     * arrow keys.
8022     *
8023     * @section Gengrid_Layouts Gengrid layouts
8024     *
8025     * Gengrid may layout its items in one of two possible layouts:
8026     * - horizontal or
8027     * - vertical.
8028     *
8029     * When in "horizontal mode", items will be placed in @b columns,
8030     * from top to bottom and, when the space for a column is filled,
8031     * another one is started on the right, thus expanding the grid
8032     * horizontally, making for horizontal scrolling. When in "vertical
8033     * mode" , though, items will be placed in @b rows, from left to
8034     * right and, when the space for a row is filled, another one is
8035     * started below, thus expanding the grid vertically (and making
8036     * for vertical scrolling).
8037     *
8038     * @section Gengrid_Items Gengrid items
8039     *
8040     * An item in a gengrid can have 0 or more text labels (they can be
8041     * regular text or textblock Evas objects - that's up to the style
8042     * to determine), 0 or more icons (which are simply objects
8043     * swallowed into the gengrid item's theming Edje object) and 0 or
8044     * more <b>boolean states</b>, which have the behavior left to the
8045     * user to define. The Edje part names for each of these properties
8046     * will be looked up, in the theme file for the gengrid, under the
8047     * Edje (string) data items named @c "labels", @c "icons" and @c
8048     * "states", respectively. For each of those properties, if more
8049     * than one part is provided, they must have names listed separated
8050     * by spaces in the data fields. For the default gengrid item
8051     * theme, we have @b one label part (@c "elm.text"), @b two icon
8052     * parts (@c "elm.swalllow.icon" and @c "elm.swallow.end") and @b
8053     * no state parts.
8054     *
8055     * A gengrid item may be at one of several styles. Elementary
8056     * provides one by default - "default", but this can be extended by
8057     * system or application custom themes/overlays/extensions (see
8058     * @ref Theme "themes" for more details).
8059     *
8060     * @section Gengrid_Item_Class Gengrid item classes
8061     *
8062     * In order to have the ability to add and delete items on the fly,
8063     * gengrid implements a class (callback) system where the
8064     * application provides a structure with information about that
8065     * type of item (gengrid may contain multiple different items with
8066     * different classes, states and styles). Gengrid will call the
8067     * functions in this struct (methods) when an item is "realized"
8068     * (i.e., created dynamically, while the user is scrolling the
8069     * grid). All objects will simply be deleted when no longer needed
8070     * with evas_object_del(). The #Elm_GenGrid_Item_Class structure
8071     * contains the following members:
8072     * - @c item_style - This is a constant string and simply defines
8073     * the name of the item style. It @b must be specified and the
8074     * default should be @c "default".
8075     * - @c func.label_get - This function is called when an item
8076     * object is actually created. The @c data parameter will point to
8077     * the same data passed to elm_gengrid_item_append() and related
8078     * item creation functions. The @c obj parameter is the gengrid
8079     * object itself, while the @c part one is the name string of one
8080     * of the existing text parts in the Edje group implementing the
8081     * item's theme. This function @b must return a strdup'()ed string,
8082     * as the caller will free() it when done. See
8083     * #Elm_Gengrid_Item_Label_Get_Cb.
8084     * - @c func.content_get - This function is called when an item object
8085     * is actually created. The @c data parameter will point to the
8086     * same data passed to elm_gengrid_item_append() and related item
8087     * creation functions. The @c obj parameter is the gengrid object
8088     * itself, while the @c part one is the name string of one of the
8089     * existing (content) swallow parts in the Edje group implementing the
8090     * item's theme. It must return @c NULL, when no content is desired,
8091     * or a valid object handle, otherwise. The object will be deleted
8092     * by the gengrid on its deletion or when the item is "unrealized".
8093     * See #Elm_Gengrid_Item_Content_Get_Cb.
8094     * - @c func.state_get - This function is called when an item
8095     * object is actually created. The @c data parameter will point to
8096     * the same data passed to elm_gengrid_item_append() and related
8097     * item creation functions. The @c obj parameter is the gengrid
8098     * object itself, while the @c part one is the name string of one
8099     * of the state parts in the Edje group implementing the item's
8100     * theme. Return @c EINA_FALSE for false/off or @c EINA_TRUE for
8101     * true/on. Gengrids will emit a signal to its theming Edje object
8102     * with @c "elm,state,XXX,active" and @c "elm" as "emission" and
8103     * "source" arguments, respectively, when the state is true (the
8104     * default is false), where @c XXX is the name of the (state) part.
8105     * See #Elm_Gengrid_Item_State_Get_Cb.
8106     * - @c func.del - This is called when elm_gengrid_item_del() is
8107     * called on an item or elm_gengrid_clear() is called on the
8108     * gengrid. This is intended for use when gengrid items are
8109     * deleted, so any data attached to the item (e.g. its data
8110     * parameter on creation) can be deleted. See #Elm_Gengrid_Item_Del_Cb.
8111     *
8112     * @section Gengrid_Usage_Hints Usage hints
8113     *
8114     * If the user wants to have multiple items selected at the same
8115     * time, elm_gengrid_multi_select_set() will permit it. If the
8116     * gengrid is single-selection only (the default), then
8117     * elm_gengrid_select_item_get() will return the selected item or
8118     * @c NULL, if none is selected. If the gengrid is under
8119     * multi-selection, then elm_gengrid_selected_items_get() will
8120     * return a list (that is only valid as long as no items are
8121     * modified (added, deleted, selected or unselected) of child items
8122     * on a gengrid.
8123     *
8124     * If an item changes (internal (boolean) state, label or content 
8125     * changes), then use elm_gengrid_item_update() to have gengrid
8126     * update the item with the new state. A gengrid will re-"realize"
8127     * the item, thus calling the functions in the
8128     * #Elm_Gengrid_Item_Class set for that item.
8129     *
8130     * To programmatically (un)select an item, use
8131     * elm_gengrid_item_selected_set(). To get its selected state use
8132     * elm_gengrid_item_selected_get(). To make an item disabled
8133     * (unable to be selected and appear differently) use
8134     * elm_gengrid_item_disabled_set() to set this and
8135     * elm_gengrid_item_disabled_get() to get the disabled state.
8136     *
8137     * Grid cells will only have their selection smart callbacks called
8138     * when firstly getting selected. Any further clicks will do
8139     * nothing, unless you enable the "always select mode", with
8140     * elm_gengrid_always_select_mode_set(), thus making every click to
8141     * issue selection callbacks. elm_gengrid_no_select_mode_set() will
8142     * turn off the ability to select items entirely in the widget and
8143     * they will neither appear selected nor call the selection smart
8144     * callbacks.
8145     *
8146     * Remember that you can create new styles and add your own theme
8147     * augmentation per application with elm_theme_extension_add(). If
8148     * you absolutely must have a specific style that overrides any
8149     * theme the user or system sets up you can use
8150     * elm_theme_overlay_add() to add such a file.
8151     *
8152     * @section Gengrid_Smart_Events Gengrid smart events
8153     *
8154     * Smart events that you can add callbacks for are:
8155     * - @c "activated" - The user has double-clicked or pressed
8156     *   (enter|return|spacebar) on an item. The @c event_info parameter
8157     *   is the gengrid item that was activated.
8158     * - @c "clicked,double" - The user has double-clicked an item.
8159     *   The @c event_info parameter is the gengrid item that was double-clicked.
8160     * - @c "longpressed" - This is called when the item is pressed for a certain
8161     *   amount of time. By default it's 1 second.
8162     * - @c "selected" - The user has made an item selected. The
8163     *   @c event_info parameter is the gengrid item that was selected.
8164     * - @c "unselected" - The user has made an item unselected. The
8165     *   @c event_info parameter is the gengrid item that was unselected.
8166     * - @c "realized" - This is called when the item in the gengrid
8167     *   has its implementing Evas object instantiated, de facto. @c
8168     *   event_info is the gengrid item that was created. The object
8169     *   may be deleted at any time, so it is highly advised to the
8170     *   caller @b not to use the object pointer returned from
8171     *   elm_gengrid_item_object_get(), because it may point to freed
8172     *   objects.
8173     * - @c "unrealized" - This is called when the implementing Evas
8174     *   object for this item is deleted. @c event_info is the gengrid
8175     *   item that was deleted.
8176     * - @c "changed" - Called when an item is added, removed, resized
8177     *   or moved and when the gengrid is resized or gets "horizontal"
8178     *   property changes.
8179     * - @c "scroll,anim,start" - This is called when scrolling animation has
8180     *   started.
8181     * - @c "scroll,anim,stop" - This is called when scrolling animation has
8182     *   stopped.
8183     * - @c "drag,start,up" - Called when the item in the gengrid has
8184     *   been dragged (not scrolled) up.
8185     * - @c "drag,start,down" - Called when the item in the gengrid has
8186     *   been dragged (not scrolled) down.
8187     * - @c "drag,start,left" - Called when the item in the gengrid has
8188     *   been dragged (not scrolled) left.
8189     * - @c "drag,start,right" - Called when the item in the gengrid has
8190     *   been dragged (not scrolled) right.
8191     * - @c "drag,stop" - Called when the item in the gengrid has
8192     *   stopped being dragged.
8193     * - @c "drag" - Called when the item in the gengrid is being
8194     *   dragged.
8195     * - @c "scroll" - called when the content has been scrolled
8196     *   (moved).
8197     * - @c "scroll,drag,start" - called when dragging the content has
8198     *   started.
8199     * - @c "scroll,drag,stop" - called when dragging the content has
8200     *   stopped.
8201     * - @c "edge,top" - This is called when the gengrid is scrolled until
8202     *   the top edge.
8203     * - @c "edge,bottom" - This is called when the gengrid is scrolled
8204     *   until the bottom edge.
8205     * - @c "edge,left" - This is called when the gengrid is scrolled
8206     *   until the left edge.
8207     * - @c "edge,right" - This is called when the gengrid is scrolled
8208     *   until the right edge.
8209     *
8210     * List of gengrid examples:
8211     * @li @ref gengrid_example
8212     */
8213
8214    /**
8215     * @addtogroup Gengrid
8216     * @{
8217     */
8218
8219    typedef struct _Elm_Gengrid_Item_Class Elm_Gengrid_Item_Class; /**< Gengrid item class definition structs */
8220    #define Elm_Gengrid_Item_Class Elm_Gen_Item_Class
8221    typedef struct _Elm_Gengrid_Item Elm_Gengrid_Item; /**< Gengrid item handles */
8222    #define Elm_Gengrid_Item Elm_Gen_Item /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
8223    typedef struct _Elm_Gengrid_Item_Class_Func Elm_Gengrid_Item_Class_Func; /**< Class functions for gengrid item classes. */
8224    typedef char        *(*Elm_Gengrid_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for gengrid item classes. */
8225    typedef Evas_Object *(*Elm_Gengrid_Item_Content_Get_Cb)  (void *data, Evas_Object *obj, const char *part); /**< Content (swallowed object) fetching class function for gengrid item classes. */
8226    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. */
8227    typedef void         (*Elm_Gengrid_Item_Del_Cb)      (void *data, Evas_Object *obj); /**< Deletion class function for gengrid item classes. */
8228
8229    /**
8230     * @struct _Elm_Gengrid_Item_Class
8231     *
8232     * Gengrid item class definition. See @ref Gengrid_Item_Class for
8233     * field details.
8234     */
8235    struct _Elm_Gengrid_Item_Class
8236      {
8237         const char             *item_style;
8238         struct _Elm_Gengrid_Item_Class_Func
8239           {
8240              Elm_Gengrid_Item_Label_Get_Cb label_get;
8241              Elm_Gengrid_Item_Content_Get_Cb content_get;
8242              Elm_Gengrid_Item_State_Get_Cb state_get;
8243              Elm_Gengrid_Item_Del_Cb       del;
8244           } func;
8245      }; /**< #Elm_Gengrid_Item_Class member definitions */
8246    #define Elm_Gengrid_Item_Class_Func Elm_Gen_Item_Class_Func
8247    /**
8248     * Add a new gengrid widget to the given parent Elementary
8249     * (container) object
8250     *
8251     * @param parent The parent object
8252     * @return a new gengrid widget handle or @c NULL, on errors
8253     *
8254     * This function inserts a new gengrid widget on the canvas.
8255     *
8256     * @see elm_gengrid_item_size_set()
8257     * @see elm_gengrid_group_item_size_set()
8258     * @see elm_gengrid_horizontal_set()
8259     * @see elm_gengrid_item_append()
8260     * @see elm_gengrid_item_del()
8261     * @see elm_gengrid_clear()
8262     *
8263     * @ingroup Gengrid
8264     */
8265    EAPI Evas_Object       *elm_gengrid_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8266
8267    /**
8268     * Set the size for the items of a given gengrid widget
8269     *
8270     * @param obj The gengrid object.
8271     * @param w The items' width.
8272     * @param h The items' height;
8273     *
8274     * A gengrid, after creation, has still no information on the size
8275     * to give to each of its cells. So, you most probably will end up
8276     * with squares one @ref Fingers "finger" wide, the default
8277     * size. Use this function to force a custom size for you items,
8278     * making them as big as you wish.
8279     *
8280     * @see elm_gengrid_item_size_get()
8281     *
8282     * @ingroup Gengrid
8283     */
8284    EAPI void               elm_gengrid_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
8285
8286    /**
8287     * Get the size set for the items of a given gengrid widget
8288     *
8289     * @param obj The gengrid object.
8290     * @param w Pointer to a variable where to store the items' width.
8291     * @param h Pointer to a variable where to store the items' height.
8292     *
8293     * @note Use @c NULL pointers on the size values you're not
8294     * interested in: they'll be ignored by the function.
8295     *
8296     * @see elm_gengrid_item_size_get() for more details
8297     *
8298     * @ingroup Gengrid
8299     */
8300    EAPI void               elm_gengrid_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
8301
8302    /**
8303     * Set the size for the group items of a given gengrid widget
8304     *
8305     * @param obj The gengrid object.
8306     * @param w The group items' width.
8307     * @param h The group items' height;
8308     *
8309     * A gengrid, after creation, has still no information on the size
8310     * to give to each of its cells. So, you most probably will end up
8311     * with squares one @ref Fingers "finger" wide, the default
8312     * size. Use this function to force a custom size for you group items,
8313     * making them as big as you wish.
8314     *
8315     * @see elm_gengrid_group_item_size_get()
8316     *
8317     * @ingroup Gengrid
8318     */
8319    EAPI void               elm_gengrid_group_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
8320
8321    /**
8322     * Get the size set for the group items of a given gengrid widget
8323     *
8324     * @param obj The gengrid object.
8325     * @param w Pointer to a variable where to store the group items' width.
8326     * @param h Pointer to a variable where to store the group items' height.
8327     *
8328     * @note Use @c NULL pointers on the size values you're not
8329     * interested in: they'll be ignored by the function.
8330     *
8331     * @see elm_gengrid_group_item_size_get() for more details
8332     *
8333     * @ingroup Gengrid
8334     */
8335    EAPI void               elm_gengrid_group_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
8336
8337    /**
8338     * Set the items grid's alignment within a given gengrid widget
8339     *
8340     * @param obj The gengrid object.
8341     * @param align_x Alignment in the horizontal axis (0 <= align_x <= 1).
8342     * @param align_y Alignment in the vertical axis (0 <= align_y <= 1).
8343     *
8344     * This sets the alignment of the whole grid of items of a gengrid
8345     * within its given viewport. By default, those values are both
8346     * 0.5, meaning that the gengrid will have its items grid placed
8347     * exactly in the middle of its viewport.
8348     *
8349     * @note If given alignment values are out of the cited ranges,
8350     * they'll be changed to the nearest boundary values on the valid
8351     * ranges.
8352     *
8353     * @see elm_gengrid_align_get()
8354     *
8355     * @ingroup Gengrid
8356     */
8357    EAPI void               elm_gengrid_align_set(Evas_Object *obj, double align_x, double align_y) EINA_ARG_NONNULL(1);
8358
8359    /**
8360     * Get the items grid's alignment values within a given gengrid
8361     * widget
8362     *
8363     * @param obj The gengrid object.
8364     * @param align_x Pointer to a variable where to store the
8365     * horizontal alignment.
8366     * @param align_y Pointer to a variable where to store the vertical
8367     * alignment.
8368     *
8369     * @note Use @c NULL pointers on the alignment values you're not
8370     * interested in: they'll be ignored by the function.
8371     *
8372     * @see elm_gengrid_align_set() for more details
8373     *
8374     * @ingroup Gengrid
8375     */
8376    EAPI void               elm_gengrid_align_get(const Evas_Object *obj, double *align_x, double *align_y) EINA_ARG_NONNULL(1);
8377
8378    /**
8379     * Set whether a given gengrid widget is or not able have items
8380     * @b reordered
8381     *
8382     * @param obj The gengrid object
8383     * @param reorder_mode Use @c EINA_TRUE to turn reoderding on,
8384     * @c EINA_FALSE to turn it off
8385     *
8386     * If a gengrid is set to allow reordering, a click held for more
8387     * than 0.5 over a given item will highlight it specially,
8388     * signalling the gengrid has entered the reordering state. From
8389     * that time on, the user will be able to, while still holding the
8390     * mouse button down, move the item freely in the gengrid's
8391     * viewport, replacing to said item to the locations it goes to.
8392     * The replacements will be animated and, whenever the user
8393     * releases the mouse button, the item being replaced gets a new
8394     * definitive place in the grid.
8395     *
8396     * @see elm_gengrid_reorder_mode_get()
8397     *
8398     * @ingroup Gengrid
8399     */
8400    EAPI void               elm_gengrid_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
8401
8402    /**
8403     * Get whether a given gengrid widget is or not able have items
8404     * @b reordered
8405     *
8406     * @param obj The gengrid object
8407     * @return @c EINA_TRUE, if reoderding is on, @c EINA_FALSE if it's
8408     * off
8409     *
8410     * @see elm_gengrid_reorder_mode_set() for more details
8411     *
8412     * @ingroup Gengrid
8413     */
8414    EAPI Eina_Bool          elm_gengrid_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8415
8416    /**
8417     * Append a new item in a given gengrid widget.
8418     *
8419     * @param obj The gengrid object.
8420     * @param gic The item class for the item.
8421     * @param data The item data.
8422     * @param func Convenience function called when the item is
8423     * selected.
8424     * @param func_data Data to be passed to @p func.
8425     * @return A handle to the item added or @c NULL, on errors.
8426     *
8427     * This adds an item to the beginning of the gengrid.
8428     *
8429     * @see elm_gengrid_item_prepend()
8430     * @see elm_gengrid_item_insert_before()
8431     * @see elm_gengrid_item_insert_after()
8432     * @see elm_gengrid_item_del()
8433     *
8434     * @ingroup Gengrid
8435     */
8436    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);
8437
8438    /**
8439     * Prepend a new item in a given gengrid widget.
8440     *
8441     * @param obj The gengrid object.
8442     * @param gic The item class for the item.
8443     * @param data The item data.
8444     * @param func Convenience function called when the item is
8445     * selected.
8446     * @param func_data Data to be passed to @p func.
8447     * @return A handle to the item added or @c NULL, on errors.
8448     *
8449     * This adds an item to the end of the gengrid.
8450     *
8451     * @see elm_gengrid_item_append()
8452     * @see elm_gengrid_item_insert_before()
8453     * @see elm_gengrid_item_insert_after()
8454     * @see elm_gengrid_item_del()
8455     *
8456     * @ingroup Gengrid
8457     */
8458    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);
8459
8460    /**
8461     * Insert an item before another in a gengrid widget
8462     *
8463     * @param obj The gengrid object.
8464     * @param gic The item class for the item.
8465     * @param data The item data.
8466     * @param relative The item to place this new one before.
8467     * @param func Convenience function called when the item is
8468     * selected.
8469     * @param func_data Data to be passed to @p func.
8470     * @return A handle to the item added or @c NULL, on errors.
8471     *
8472     * This inserts an item before another in the gengrid.
8473     *
8474     * @see elm_gengrid_item_append()
8475     * @see elm_gengrid_item_prepend()
8476     * @see elm_gengrid_item_insert_after()
8477     * @see elm_gengrid_item_del()
8478     *
8479     * @ingroup Gengrid
8480     */
8481    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);
8482
8483    /**
8484     * Insert an item after another in a gengrid widget
8485     *
8486     * @param obj The gengrid object.
8487     * @param gic The item class for the item.
8488     * @param data The item data.
8489     * @param relative The item to place this new one after.
8490     * @param func Convenience function called when the item is
8491     * selected.
8492     * @param func_data Data to be passed to @p func.
8493     * @return A handle to the item added or @c NULL, on errors.
8494     *
8495     * This inserts an item after another in the gengrid.
8496     *
8497     * @see elm_gengrid_item_append()
8498     * @see elm_gengrid_item_prepend()
8499     * @see elm_gengrid_item_insert_after()
8500     * @see elm_gengrid_item_del()
8501     *
8502     * @ingroup Gengrid
8503     */
8504    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);
8505
8506    /**
8507     * Insert an item in a gengrid widget using a user-defined sort function.
8508     *
8509     * @param obj The gengrid object.
8510     * @param gic The item class for the item.
8511     * @param data The item data.
8512     * @param comp User defined comparison function that defines the sort order based on
8513     * Elm_Gen_Item and its data param.
8514     * @param func Convenience function called when the item is selected.
8515     * @param func_data Data to be passed to @p func.
8516     * @return A handle to the item added or @c NULL, on errors.
8517     *
8518     * This inserts an item in the gengrid based on user defined comparison function.
8519     *
8520     * @see elm_gengrid_item_append()
8521     * @see elm_gengrid_item_prepend()
8522     * @see elm_gengrid_item_insert_after()
8523     * @see elm_gengrid_item_del()
8524     * @see elm_gengrid_item_direct_sorted_insert()
8525     *
8526     * @ingroup Gengrid
8527     */
8528    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);
8529
8530    /**
8531     * Insert an item in a gengrid widget using a user-defined sort function.
8532     *
8533     * @param obj The gengrid object.
8534     * @param gic The item class for the item.
8535     * @param data The item data.
8536     * @param comp User defined comparison function that defines the sort order based on
8537     * Elm_Gen_Item.
8538     * @param func Convenience function called when the item is selected.
8539     * @param func_data Data to be passed to @p func.
8540     * @return A handle to the item added or @c NULL, on errors.
8541     *
8542     * This inserts an item in the gengrid based on user defined comparison function.
8543     *
8544     * @see elm_gengrid_item_append()
8545     * @see elm_gengrid_item_prepend()
8546     * @see elm_gengrid_item_insert_after()
8547     * @see elm_gengrid_item_del()
8548     * @see elm_gengrid_item_sorted_insert()
8549     *
8550     * @ingroup Gengrid
8551     */
8552    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);
8553
8554    /**
8555     * Set whether items on a given gengrid widget are to get their
8556     * selection callbacks issued for @b every subsequent selection
8557     * click on them or just for the first click.
8558     *
8559     * @param obj The gengrid object
8560     * @param always_select @c EINA_TRUE to make items "always
8561     * selected", @c EINA_FALSE, otherwise
8562     *
8563     * By default, grid items will only call their selection callback
8564     * function when firstly getting selected, any subsequent further
8565     * clicks will do nothing. With this call, you make those
8566     * subsequent clicks also to issue the selection callbacks.
8567     *
8568     * @note <b>Double clicks</b> will @b always be reported on items.
8569     *
8570     * @see elm_gengrid_always_select_mode_get()
8571     *
8572     * @ingroup Gengrid
8573     */
8574    EINA_DEPRECATED EAPI void               elm_gengrid_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
8575
8576    /**
8577     * Get whether items on a given gengrid widget have their selection
8578     * callbacks issued for @b every subsequent selection click on them
8579     * or just for the first click.
8580     *
8581     * @param obj The gengrid object.
8582     * @return @c EINA_TRUE if the gengrid items are "always selected",
8583     * @c EINA_FALSE, otherwise
8584     *
8585     * @see elm_gengrid_always_select_mode_set() for more details
8586     *
8587     * @ingroup Gengrid
8588     */
8589    EINA_DEPRECATED EAPI Eina_Bool          elm_gengrid_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8590
8591    /**
8592     * Set whether items on a given gengrid widget can be selected or not.
8593     *
8594     * @param obj The gengrid object
8595     * @param no_select @c EINA_TRUE to make items selectable,
8596     * @c EINA_FALSE otherwise
8597     *
8598     * This will make items in @p obj selectable or not. In the latter
8599     * case, any user interaction on the gengrid items will neither make
8600     * them appear selected nor them call their selection callback
8601     * functions.
8602     *
8603     * @see elm_gengrid_no_select_mode_get()
8604     *
8605     * @ingroup Gengrid
8606     */
8607    EINA_DEPRECATED EAPI void               elm_gengrid_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
8608
8609    /**
8610     * Get whether items on a given gengrid widget can be selected or
8611     * not.
8612     *
8613     * @param obj The gengrid object
8614     * @return @c EINA_TRUE, if items are selectable, @c EINA_FALSE
8615     * otherwise
8616     *
8617     * @see elm_gengrid_no_select_mode_set() for more details
8618     *
8619     * @ingroup Gengrid
8620     */
8621    EINA_DEPRECATED EAPI Eina_Bool          elm_gengrid_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8622
8623    /**
8624     * Enable or disable multi-selection in a given gengrid widget
8625     *
8626     * @param obj The gengrid object.
8627     * @param multi @c EINA_TRUE, to enable multi-selection,
8628     * @c EINA_FALSE to disable it.
8629     *
8630     * Multi-selection is the ability to have @b more than one
8631     * item selected, on a given gengrid, simultaneously. When it is
8632     * enabled, a sequence of clicks on different items will make them
8633     * all selected, progressively. A click on an already selected item
8634     * will unselect it. If interacting via the keyboard,
8635     * multi-selection is enabled while holding the "Shift" key.
8636     *
8637     * @note By default, multi-selection is @b disabled on gengrids
8638     *
8639     * @see elm_gengrid_multi_select_get()
8640     *
8641     * @ingroup Gengrid
8642     */
8643    EAPI void               elm_gengrid_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
8644
8645    /**
8646     * Get whether multi-selection is enabled or disabled for a given
8647     * gengrid widget
8648     *
8649     * @param obj The gengrid object.
8650     * @return @c EINA_TRUE, if multi-selection is enabled, @c
8651     * EINA_FALSE otherwise
8652     *
8653     * @see elm_gengrid_multi_select_set() for more details
8654     *
8655     * @ingroup Gengrid
8656     */
8657    EAPI Eina_Bool          elm_gengrid_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8658
8659    /**
8660     * Enable or disable bouncing effect for a given gengrid widget
8661     *
8662     * @param obj The gengrid object
8663     * @param h_bounce @c EINA_TRUE, to enable @b horizontal bouncing,
8664     * @c EINA_FALSE to disable it
8665     * @param v_bounce @c EINA_TRUE, to enable @b vertical bouncing,
8666     * @c EINA_FALSE to disable it
8667     *
8668     * The bouncing effect occurs whenever one reaches the gengrid's
8669     * edge's while panning it -- it will scroll past its limits a
8670     * little bit and return to the edge again, in a animated for,
8671     * automatically.
8672     *
8673     * @note By default, gengrids have bouncing enabled on both axis
8674     *
8675     * @see elm_gengrid_bounce_get()
8676     *
8677     * @ingroup Gengrid
8678     */
8679    EINA_DEPRECATED EAPI void               elm_gengrid_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
8680
8681    /**
8682     * Get whether bouncing effects are enabled or disabled, for a
8683     * given gengrid widget, on each axis
8684     *
8685     * @param obj The gengrid object
8686     * @param h_bounce Pointer to a variable where to store the
8687     * horizontal bouncing flag.
8688     * @param v_bounce Pointer to a variable where to store the
8689     * vertical bouncing flag.
8690     *
8691     * @see elm_gengrid_bounce_set() for more details
8692     *
8693     * @ingroup Gengrid
8694     */
8695    EINA_DEPRECATED EAPI void               elm_gengrid_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
8696
8697    /**
8698     * Set a given gengrid widget's scrolling page size, relative to
8699     * its viewport size.
8700     *
8701     * @param obj The gengrid object
8702     * @param h_pagerel The horizontal page (relative) size
8703     * @param v_pagerel The vertical page (relative) size
8704     *
8705     * The gengrid's scroller is capable of binding scrolling by the
8706     * user to "pages". It means that, while scrolling and, specially
8707     * after releasing the mouse button, the grid will @b snap to the
8708     * nearest displaying page's area. When page sizes are set, the
8709     * grid's continuous content area is split into (equal) page sized
8710     * pieces.
8711     *
8712     * This function sets the size of a page <b>relatively to the
8713     * viewport dimensions</b> of the gengrid, for each axis. A value
8714     * @c 1.0 means "the exact viewport's size", in that axis, while @c
8715     * 0.0 turns paging off in that axis. Likewise, @c 0.5 means "half
8716     * a viewport". Sane usable values are, than, between @c 0.0 and @c
8717     * 1.0. Values beyond those will make it behave behave
8718     * inconsistently. If you only want one axis to snap to pages, use
8719     * the value @c 0.0 for the other one.
8720     *
8721     * There is a function setting page size values in @b absolute
8722     * values, too -- elm_gengrid_page_size_set(). Naturally, its use
8723     * is mutually exclusive to this one.
8724     *
8725     * @see elm_gengrid_page_relative_get()
8726     *
8727     * @ingroup Gengrid
8728     */
8729    EINA_DEPRECATED EAPI void               elm_gengrid_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
8730
8731    /**
8732     * Get a given gengrid widget's scrolling page size, relative to
8733     * its viewport size.
8734     *
8735     * @param obj The gengrid object
8736     * @param h_pagerel Pointer to a variable where to store the
8737     * horizontal page (relative) size
8738     * @param v_pagerel Pointer to a variable where to store the
8739     * vertical page (relative) size
8740     *
8741     * @see elm_gengrid_page_relative_set() for more details
8742     *
8743     * @ingroup Gengrid
8744     */
8745    EINA_DEPRECATED EAPI void               elm_gengrid_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel) EINA_ARG_NONNULL(1);
8746
8747    /**
8748     * Set a given gengrid widget's scrolling page size
8749     *
8750     * @param obj The gengrid object
8751     * @param h_pagerel The horizontal page size, in pixels
8752     * @param v_pagerel The vertical page size, in pixels
8753     *
8754     * The gengrid's scroller is capable of binding scrolling by the
8755     * user to "pages". It means that, while scrolling and, specially
8756     * after releasing the mouse button, the grid will @b snap to the
8757     * nearest displaying page's area. When page sizes are set, the
8758     * grid's continuous content area is split into (equal) page sized
8759     * pieces.
8760     *
8761     * This function sets the size of a page of the gengrid, in pixels,
8762     * for each axis. Sane usable values are, between @c 0 and the
8763     * dimensions of @p obj, for each axis. Values beyond those will
8764     * make it behave behave inconsistently. If you only want one axis
8765     * to snap to pages, use the value @c 0 for the other one.
8766     *
8767     * There is a function setting page size values in @b relative
8768     * values, too -- elm_gengrid_page_relative_set(). Naturally, its
8769     * use is mutually exclusive to this one.
8770     *
8771     * @ingroup Gengrid
8772     */
8773    EINA_DEPRECATED EAPI void               elm_gengrid_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
8774
8775    /**
8776     * @brief Get gengrid current page number.
8777     *
8778     * @param obj The gengrid object
8779     * @param h_pagenumber The horizontal page number
8780     * @param v_pagenumber The vertical page number
8781     *
8782     * The page number starts from 0. 0 is the first page.
8783     * Current page means the page which meet the top-left of the viewport.
8784     * If there are two or more pages in the viewport, it returns the number of page
8785     * which meet the top-left of the viewport.
8786     *
8787     * @see elm_gengrid_last_page_get()
8788     * @see elm_gengrid_page_show()
8789     * @see elm_gengrid_page_brint_in()
8790     */
8791    EINA_DEPRECATED EAPI void         elm_gengrid_current_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
8792
8793    /**
8794     * @brief Get scroll last page number.
8795     *
8796     * @param obj The gengrid object
8797     * @param h_pagenumber The horizontal page number
8798     * @param v_pagenumber The vertical page number
8799     *
8800     * The page number starts from 0. 0 is the first page.
8801     * This returns the last page number among the pages.
8802     *
8803     * @see elm_gengrid_current_page_get()
8804     * @see elm_gengrid_page_show()
8805     * @see elm_gengrid_page_brint_in()
8806     */
8807    EINA_DEPRECATED EAPI void         elm_gengrid_last_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
8808
8809    /**
8810     * Show a specific virtual region within the gengrid content object by page number.
8811     *
8812     * @param obj The gengrid object
8813     * @param h_pagenumber The horizontal page number
8814     * @param v_pagenumber The vertical page number
8815     *
8816     * 0, 0 of the indicated page is located at the top-left of the viewport.
8817     * This will jump to the page directly without animation.
8818     *
8819     * Example of usage:
8820     *
8821     * @code
8822     * sc = elm_gengrid_add(win);
8823     * elm_gengrid_content_set(sc, content);
8824     * elm_gengrid_page_relative_set(sc, 1, 0);
8825     * elm_gengrid_current_page_get(sc, &h_page, &v_page);
8826     * elm_gengrid_page_show(sc, h_page + 1, v_page);
8827     * @endcode
8828     *
8829     * @see elm_gengrid_page_bring_in()
8830     */
8831    EINA_DEPRECATED EAPI void         elm_gengrid_page_show(const Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
8832
8833    /**
8834     * Show a specific virtual region within the gengrid content object by page number.
8835     *
8836     * @param obj The gengrid object
8837     * @param h_pagenumber The horizontal page number
8838     * @param v_pagenumber The vertical page number
8839     *
8840     * 0, 0 of the indicated page is located at the top-left of the viewport.
8841     * This will slide to the page with animation.
8842     *
8843     * Example of usage:
8844     *
8845     * @code
8846     * sc = elm_gengrid_add(win);
8847     * elm_gengrid_content_set(sc, content);
8848     * elm_gengrid_page_relative_set(sc, 1, 0);
8849     * elm_gengrid_last_page_get(sc, &h_page, &v_page);
8850     * elm_gengrid_page_bring_in(sc, h_page, v_page);
8851     * @endcode
8852     *
8853     * @see elm_gengrid_page_show()
8854     */
8855     EINA_DEPRECATED EAPI void         elm_gengrid_page_bring_in(const Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
8856
8857    /**
8858     * Set the direction in which a given gengrid widget will expand while
8859     * placing its items.
8860     *
8861     * @param obj The gengrid object.
8862     * @param setting @c EINA_TRUE to make the gengrid expand
8863     * horizontally, @c EINA_FALSE to expand vertically.
8864     *
8865     * When in "horizontal mode" (@c EINA_TRUE), items will be placed
8866     * in @b columns, from top to bottom and, when the space for a
8867     * column is filled, another one is started on the right, thus
8868     * expanding the grid horizontally. When in "vertical mode"
8869     * (@c EINA_FALSE), though, items will be placed in @b rows, from left
8870     * to right and, when the space for a row is filled, another one is
8871     * started below, thus expanding the grid vertically.
8872     *
8873     * @see elm_gengrid_horizontal_get()
8874     *
8875     * @ingroup Gengrid
8876     */
8877    EAPI void               elm_gengrid_horizontal_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
8878
8879    /**
8880     * Get for what direction a given gengrid widget will expand while
8881     * placing its items.
8882     *
8883     * @param obj The gengrid object.
8884     * @return @c EINA_TRUE, if @p obj is set to expand horizontally,
8885     * @c EINA_FALSE if it's set to expand vertically.
8886     *
8887     * @see elm_gengrid_horizontal_set() for more detais
8888     *
8889     * @ingroup Gengrid
8890     */
8891    EAPI Eina_Bool          elm_gengrid_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8892
8893    /**
8894     * Get the first item in a given gengrid widget
8895     *
8896     * @param obj The gengrid object
8897     * @return The first item's handle or @c NULL, if there are no
8898     * items in @p obj (and on errors)
8899     *
8900     * This returns the first item in the @p obj's internal list of
8901     * items.
8902     *
8903     * @see elm_gengrid_last_item_get()
8904     *
8905     * @ingroup Gengrid
8906     */
8907    EINA_DEPRECATED EAPI Elm_Gengrid_Item  *elm_gengrid_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8908
8909    /**
8910     * Get the last item in a given gengrid widget
8911     *
8912     * @param obj The gengrid object
8913     * @return The last item's handle or @c NULL, if there are no
8914     * items in @p obj (and on errors)
8915     *
8916     * This returns the last item in the @p obj's internal list of
8917     * items.
8918     *
8919     * @see elm_gengrid_first_item_get()
8920     *
8921     * @ingroup Gengrid
8922     */
8923    EINA_DEPRECATED EAPI Elm_Gengrid_Item  *elm_gengrid_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8924
8925    /**
8926     * Get the @b next item in a gengrid widget's internal list of items,
8927     * given a handle to one of those items.
8928     *
8929     * @param item The gengrid item to fetch next from
8930     * @return The item after @p item, or @c NULL if there's none (and
8931     * on errors)
8932     *
8933     * This returns the item placed after the @p item, on the container
8934     * gengrid.
8935     *
8936     * @see elm_gengrid_item_prev_get()
8937     *
8938     * @ingroup Gengrid
8939     */
8940    EINA_DEPRECATED EAPI Elm_Gengrid_Item  *elm_gengrid_item_next_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8941
8942    /**
8943     * Get the @b previous item in a gengrid widget's internal list of items,
8944     * given a handle to one of those items.
8945     *
8946     * @param item The gengrid item to fetch previous from
8947     * @return The item before @p item, or @c NULL if there's none (and
8948     * on errors)
8949     *
8950     * This returns the item placed before the @p item, on the container
8951     * gengrid.
8952     *
8953     * @see elm_gengrid_item_next_get()
8954     *
8955     * @ingroup Gengrid
8956     */
8957    EINA_DEPRECATED EAPI Elm_Gengrid_Item  *elm_gengrid_item_prev_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8958
8959    /**
8960     * Get the gengrid object's handle which contains a given gengrid
8961     * item
8962     *
8963     * @param item The item to fetch the container from
8964     * @return The gengrid (parent) object
8965     *
8966     * This returns the gengrid object itself that an item belongs to.
8967     *
8968     * @ingroup Gengrid
8969     */
8970    EINA_DEPRECATED EAPI Evas_Object       *elm_gengrid_item_gengrid_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8971
8972    /**
8973     * Remove a gengrid item from its parent, deleting it.
8974     *
8975     * @param item The item to be removed.
8976     * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
8977     *
8978     * @see elm_gengrid_clear(), to remove all items in a gengrid at
8979     * once.
8980     *
8981     * @ingroup Gengrid
8982     */
8983    EAPI void               elm_gengrid_item_del(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8984
8985    /**
8986     * Update the contents of a given gengrid item
8987     *
8988     * @param item The gengrid item
8989     *
8990     * This updates an item by calling all the item class functions
8991     * again to get the contents, labels and states. Use this when the
8992     * original item data has changed and you want the changes to be
8993     * reflected.
8994     *
8995     * @ingroup Gengrid
8996     */
8997    EAPI void               elm_gengrid_item_update(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8998
8999    /**
9000     * Get the Gengrid Item class for the given Gengrid Item.
9001     *
9002     * @param item The gengrid item
9003     *
9004     * This returns the Gengrid_Item_Class for the given item. It can be used to examine
9005     * the function pointers and item_style.
9006     *
9007     * @ingroup Gengrid
9008     */
9009    EAPI const Elm_Gengrid_Item_Class *elm_gengrid_item_item_class_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9010
9011    /**
9012     * Get the Gengrid Item class for the given Gengrid Item.
9013     *
9014     * This sets the Gengrid_Item_Class for the given item. It can be used to examine
9015     * the function pointers and item_style.
9016     *
9017     * @param item The gengrid item
9018     * @param gic The gengrid item class describing the function pointers and the item style.
9019     *
9020     * @ingroup Gengrid
9021     */
9022    EAPI void               elm_gengrid_item_item_class_set(Elm_Gengrid_Item *item, const Elm_Gengrid_Item_Class *gic) EINA_ARG_NONNULL(1, 2);
9023
9024    /**
9025     * Return the data associated to a given gengrid item
9026     *
9027     * @param item The gengrid item.
9028     * @return the data associated with this item.
9029     *
9030     * This returns the @c data value passed on the
9031     * elm_gengrid_item_append() and related item addition calls.
9032     *
9033     * @see elm_gengrid_item_append()
9034     * @see elm_gengrid_item_data_set()
9035     *
9036     * @ingroup Gengrid
9037     */
9038    EAPI void              *elm_gengrid_item_data_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9039
9040    /**
9041     * Set the data associated with a given gengrid item
9042     *
9043     * @param item The gengrid item
9044     * @param data The data pointer to set on it
9045     *
9046     * This @b overrides the @c data value passed on the
9047     * elm_gengrid_item_append() and related item addition calls. This
9048     * function @b won't call elm_gengrid_item_update() automatically,
9049     * so you'd issue it afterwards if you want to have the item
9050     * updated to reflect the new data.
9051     *
9052     * @see elm_gengrid_item_data_get()
9053     * @see elm_gengrid_item_update()
9054     *
9055     * @ingroup Gengrid
9056     */
9057    EAPI void               elm_gengrid_item_data_set(Elm_Gengrid_Item *item, const void *data) EINA_ARG_NONNULL(1);
9058
9059    /**
9060     * Get a given gengrid item's position, relative to the whole
9061     * gengrid's grid area.
9062     *
9063     * @param item The Gengrid item.
9064     * @param x Pointer to variable to store the item's <b>row number</b>.
9065     * @param y Pointer to variable to store the item's <b>column number</b>.
9066     *
9067     * This returns the "logical" position of the item within the
9068     * gengrid. For example, @c (0, 1) would stand for first row,
9069     * second column.
9070     *
9071     * @ingroup Gengrid
9072     */
9073    EAPI void               elm_gengrid_item_pos_get(const Elm_Gengrid_Item *item, unsigned int *x, unsigned int *y) EINA_ARG_NONNULL(1);
9074
9075    /**
9076     * Set whether a given gengrid item is selected or not
9077     *
9078     * @param item The gengrid item
9079     * @param selected Use @c EINA_TRUE, to make it selected, @c
9080     * EINA_FALSE to make it unselected
9081     *
9082     * This sets the selected state of an item. If multi-selection is
9083     * not enabled on the containing gengrid and @p selected is @c
9084     * EINA_TRUE, any other previously selected items will get
9085     * unselected in favor of this new one.
9086     *
9087     * @see elm_gengrid_item_selected_get()
9088     *
9089     * @ingroup Gengrid
9090     */
9091    EINA_DEPRECATED EAPI void elm_gengrid_item_selected_set(Elm_Gengrid_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
9092
9093    /**
9094     * Get whether a given gengrid item is selected or not
9095     *
9096     * @param item The gengrid item
9097     * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
9098     *
9099     * This API returns EINA_TRUE for all the items selected in multi-select mode as well.
9100     *
9101     * @see elm_gengrid_item_selected_set() for more details
9102     *
9103     * @ingroup Gengrid
9104     */
9105    EINA_DEPRECATED EAPI Eina_Bool elm_gengrid_item_selected_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9106
9107    /**
9108     * Get the real Evas object created to implement the view of a
9109     * given gengrid item
9110     *
9111     * @param item The gengrid item.
9112     * @return the Evas object implementing this item's view.
9113     *
9114     * This returns the actual Evas object used to implement the
9115     * specified gengrid item's view. This may be @c NULL, as it may
9116     * not have been created or may have been deleted, at any time, by
9117     * the gengrid. <b>Do not modify this object</b> (move, resize,
9118     * show, hide, etc.), as the gengrid is controlling it. This
9119     * function is for querying, emitting custom signals or hooking
9120     * lower level callbacks for events on that object. Do not delete
9121     * this object under any circumstances.
9122     *
9123     * @see elm_gengrid_item_data_get()
9124     *
9125     * @ingroup Gengrid
9126     */
9127    EAPI const Evas_Object *elm_gengrid_item_object_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9128
9129    /**
9130     * Show the portion of a gengrid's internal grid containing a given
9131     * item, @b immediately.
9132     *
9133     * @param item The item to display
9134     *
9135     * This causes gengrid to @b redraw its viewport's contents to the
9136     * region contining the given @p item item, if it is not fully
9137     * visible.
9138     *
9139     * @see elm_gengrid_item_bring_in()
9140     *
9141     * @ingroup Gengrid
9142     */
9143    EAPI void               elm_gengrid_item_show(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9144
9145    /**
9146     * Animatedly bring in, to the visible area of a gengrid, a given
9147     * item on it.
9148     *
9149     * @param item The gengrid item to display
9150     *
9151     * This causes gengrid to jump to the given @p item and show
9152     * it (by scrolling), if it is not fully visible. This will use
9153     * animation to do so and take a period of time to complete.
9154     *
9155     * @see elm_gengrid_item_show()
9156     *
9157     * @ingroup Gengrid
9158     */
9159    EAPI void               elm_gengrid_item_bring_in(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9160
9161    /**
9162     * Set whether a given gengrid item is disabled or not.
9163     *
9164     * @param item The gengrid item
9165     * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
9166     * to enable it back.
9167     *
9168     * A disabled item cannot be selected or unselected. It will also
9169     * change its appearance, to signal the user it's disabled.
9170     *
9171     * @see elm_gengrid_item_disabled_get()
9172     *
9173     * @ingroup Gengrid
9174     */
9175    EAPI void               elm_gengrid_item_disabled_set(Elm_Gengrid_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
9176
9177    /**
9178     * Get whether a given gengrid item is disabled or not.
9179     *
9180     * @param item The gengrid item
9181     * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
9182     * (and on errors).
9183     *
9184     * @see elm_gengrid_item_disabled_set() for more details
9185     *
9186     * @ingroup Gengrid
9187     */
9188    EAPI Eina_Bool          elm_gengrid_item_disabled_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9189
9190    /**
9191     * Set the text to be shown in a given gengrid item's tooltips.
9192     *
9193     * @param item The gengrid item
9194     * @param text The text to set in the content
9195     *
9196     * This call will setup the text to be used as tooltip to that item
9197     * (analogous to elm_object_tooltip_text_set(), but being item
9198     * tooltips with higher precedence than object tooltips). It can
9199     * have only one tooltip at a time, so any previous tooltip data
9200     * will get removed.
9201     *
9202     * @ingroup Gengrid
9203     */
9204    EAPI void               elm_gengrid_item_tooltip_text_set(Elm_Gengrid_Item *item, const char *text) EINA_ARG_NONNULL(1);
9205
9206    /**
9207     * Set the content to be shown in a given gengrid item's tooltip
9208     *
9209     * @param item The gengrid item.
9210     * @param func The function returning the tooltip contents.
9211     * @param data What to provide to @a func as callback data/context.
9212     * @param del_cb Called when data is not needed anymore, either when
9213     *        another callback replaces @p func, the tooltip is unset with
9214     *        elm_gengrid_item_tooltip_unset() or the owner @p item
9215     *        dies. This callback receives as its first parameter the
9216     *        given @p data, being @c event_info the item handle.
9217     *
9218     * This call will setup the tooltip's contents to @p item
9219     * (analogous to elm_object_tooltip_content_cb_set(), but being
9220     * item tooltips with higher precedence than object tooltips). It
9221     * can have only one tooltip at a time, so any previous tooltip
9222     * content will get removed. @p func (with @p data) will be called
9223     * every time Elementary needs to show the tooltip and it should
9224     * return a valid Evas object, which will be fully managed by the
9225     * tooltip system, getting deleted when the tooltip is gone.
9226     *
9227     * @ingroup Gengrid
9228     */
9229    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);
9230
9231    /**
9232     * Unset a tooltip from a given gengrid item
9233     *
9234     * @param item gengrid item to remove a previously set tooltip from.
9235     *
9236     * This call removes any tooltip set on @p item. The callback
9237     * provided as @c del_cb to
9238     * elm_gengrid_item_tooltip_content_cb_set() will be called to
9239     * notify it is not used anymore (and have resources cleaned, if
9240     * need be).
9241     *
9242     * @see elm_gengrid_item_tooltip_content_cb_set()
9243     *
9244     * @ingroup Gengrid
9245     */
9246    EAPI void               elm_gengrid_item_tooltip_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9247
9248    /**
9249     * Set a different @b style for a given gengrid item's tooltip.
9250     *
9251     * @param item gengrid item with tooltip set
9252     * @param style the <b>theme style</b> to use on tooltips (e.g. @c
9253     * "default", @c "transparent", etc)
9254     *
9255     * Tooltips can have <b>alternate styles</b> to be displayed on,
9256     * which are defined by the theme set on Elementary. This function
9257     * works analogously as elm_object_tooltip_style_set(), but here
9258     * applied only to gengrid item objects. The default style for
9259     * tooltips is @c "default".
9260     *
9261     * @note before you set a style you should define a tooltip with
9262     *       elm_gengrid_item_tooltip_content_cb_set() or
9263     *       elm_gengrid_item_tooltip_text_set()
9264     *
9265     * @see elm_gengrid_item_tooltip_style_get()
9266     *
9267     * @ingroup Gengrid
9268     */
9269    EAPI void               elm_gengrid_item_tooltip_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
9270
9271    /**
9272     * Get the style set a given gengrid item's tooltip.
9273     *
9274     * @param item gengrid item with tooltip already set on.
9275     * @return style the theme style in use, which defaults to
9276     *         "default". If the object does not have a tooltip set,
9277     *         then @c NULL is returned.
9278     *
9279     * @see elm_gengrid_item_tooltip_style_set() for more details
9280     *
9281     * @ingroup Gengrid
9282     */
9283    EAPI const char        *elm_gengrid_item_tooltip_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9284    /**
9285     * @brief Disable size restrictions on an object's tooltip
9286     * @param item The tooltip's anchor object
9287     * @param disable If EINA_TRUE, size restrictions are disabled
9288     * @return EINA_FALSE on failure, EINA_TRUE on success
9289     *
9290     * This function allows a tooltip to expand beyond its parant window's canvas.
9291     * It will instead be limited only by the size of the display.
9292     */
9293    EAPI Eina_Bool          elm_gengrid_item_tooltip_size_restrict_disable(Elm_Gengrid_Item *item, Eina_Bool disable);
9294    /**
9295     * @brief Retrieve size restriction state of an object's tooltip
9296     * @param item The tooltip's anchor object
9297     * @return If EINA_TRUE, size restrictions are disabled
9298     *
9299     * This function returns whether a tooltip is allowed to expand beyond
9300     * its parant window's canvas.
9301     * It will instead be limited only by the size of the display.
9302     */
9303    EAPI Eina_Bool          elm_gengrid_item_tooltip_size_restrict_disabled_get(const Elm_Gengrid_Item *item);
9304    /**
9305     * Set the type of mouse pointer/cursor decoration to be shown,
9306     * when the mouse pointer is over the given gengrid widget item
9307     *
9308     * @param item gengrid item to customize cursor on
9309     * @param cursor the cursor type's name
9310     *
9311     * This function works analogously as elm_object_cursor_set(), but
9312     * here the cursor's changing area is restricted to the item's
9313     * area, and not the whole widget's. Note that that item cursors
9314     * have precedence over widget cursors, so that a mouse over @p
9315     * item will always show cursor @p type.
9316     *
9317     * If this function is called twice for an object, a previously set
9318     * cursor will be unset on the second call.
9319     *
9320     * @see elm_object_cursor_set()
9321     * @see elm_gengrid_item_cursor_get()
9322     * @see elm_gengrid_item_cursor_unset()
9323     *
9324     * @ingroup Gengrid
9325     */
9326    EAPI void               elm_gengrid_item_cursor_set(Elm_Gengrid_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
9327
9328    /**
9329     * Get the type of mouse pointer/cursor decoration set to be shown,
9330     * when the mouse pointer is over the given gengrid widget item
9331     *
9332     * @param item gengrid item with custom cursor set
9333     * @return the cursor type's name or @c NULL, if no custom cursors
9334     * were set to @p item (and on errors)
9335     *
9336     * @see elm_object_cursor_get()
9337     * @see elm_gengrid_item_cursor_set() for more details
9338     * @see elm_gengrid_item_cursor_unset()
9339     *
9340     * @ingroup Gengrid
9341     */
9342    EAPI const char        *elm_gengrid_item_cursor_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9343
9344    /**
9345     * Unset any custom mouse pointer/cursor decoration set to be
9346     * shown, when the mouse pointer is over the given gengrid widget
9347     * item, thus making it show the @b default cursor again.
9348     *
9349     * @param item a gengrid item
9350     *
9351     * Use this call to undo any custom settings on this item's cursor
9352     * decoration, bringing it back to defaults (no custom style set).
9353     *
9354     * @see elm_object_cursor_unset()
9355     * @see elm_gengrid_item_cursor_set() for more details
9356     *
9357     * @ingroup Gengrid
9358     */
9359    EAPI void               elm_gengrid_item_cursor_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9360
9361    /**
9362     * Set a different @b style for a given custom cursor set for a
9363     * gengrid item.
9364     *
9365     * @param item gengrid item with custom cursor set
9366     * @param style the <b>theme style</b> to use (e.g. @c "default",
9367     * @c "transparent", etc)
9368     *
9369     * This function only makes sense when one is using custom mouse
9370     * cursor decorations <b>defined in a theme file</b> , which can
9371     * have, given a cursor name/type, <b>alternate styles</b> on
9372     * it. It works analogously as elm_object_cursor_style_set(), but
9373     * here applied only to gengrid item objects.
9374     *
9375     * @warning Before you set a cursor style you should have defined a
9376     *       custom cursor previously on the item, with
9377     *       elm_gengrid_item_cursor_set()
9378     *
9379     * @see elm_gengrid_item_cursor_engine_only_set()
9380     * @see elm_gengrid_item_cursor_style_get()
9381     *
9382     * @ingroup Gengrid
9383     */
9384    EAPI void               elm_gengrid_item_cursor_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
9385
9386    /**
9387     * Get the current @b style set for a given gengrid item's custom
9388     * cursor
9389     *
9390     * @param item gengrid item with custom cursor set.
9391     * @return style the cursor style in use. If the object does not
9392     *         have a cursor set, then @c NULL is returned.
9393     *
9394     * @see elm_gengrid_item_cursor_style_set() for more details
9395     *
9396     * @ingroup Gengrid
9397     */
9398    EAPI const char        *elm_gengrid_item_cursor_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9399
9400    /**
9401     * Set if the (custom) cursor for a given gengrid item should be
9402     * searched in its theme, also, or should only rely on the
9403     * rendering engine.
9404     *
9405     * @param item item with custom (custom) cursor already set on
9406     * @param engine_only Use @c EINA_TRUE to have cursors looked for
9407     * only on those provided by the rendering engine, @c EINA_FALSE to
9408     * have them searched on the widget's theme, as well.
9409     *
9410     * @note This call is of use only if you've set a custom cursor
9411     * for gengrid items, with elm_gengrid_item_cursor_set().
9412     *
9413     * @note By default, cursors will only be looked for between those
9414     * provided by the rendering engine.
9415     *
9416     * @ingroup Gengrid
9417     */
9418    EAPI void               elm_gengrid_item_cursor_engine_only_set(Elm_Gengrid_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
9419
9420    /**
9421     * Get if the (custom) cursor for a given gengrid item is being
9422     * searched in its theme, also, or is only relying on the rendering
9423     * engine.
9424     *
9425     * @param item a gengrid item
9426     * @return @c EINA_TRUE, if cursors are being looked for only on
9427     * those provided by the rendering engine, @c EINA_FALSE if they
9428     * are being searched on the widget's theme, as well.
9429     *
9430     * @see elm_gengrid_item_cursor_engine_only_set(), for more details
9431     *
9432     * @ingroup Gengrid
9433     */
9434    EAPI Eina_Bool          elm_gengrid_item_cursor_engine_only_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9435
9436    /**
9437     * Remove all items from a given gengrid widget
9438     *
9439     * @param obj The gengrid object.
9440     *
9441     * This removes (and deletes) all items in @p obj, leaving it
9442     * empty.
9443     *
9444     * @see elm_gengrid_item_del(), to remove just one item.
9445     *
9446     * @ingroup Gengrid
9447     */
9448    EINA_DEPRECATED EAPI void elm_gengrid_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
9449
9450    /**
9451     * Get the selected item in a given gengrid widget
9452     *
9453     * @param obj The gengrid object.
9454     * @return The selected item's handleor @c NULL, if none is
9455     * selected at the moment (and on errors)
9456     *
9457     * This returns the selected item in @p obj. If multi selection is
9458     * enabled on @p obj (@see elm_gengrid_multi_select_set()), only
9459     * the first item in the list is selected, which might not be very
9460     * useful. For that case, see elm_gengrid_selected_items_get().
9461     *
9462     * @ingroup Gengrid
9463     */
9464    EAPI Elm_Gengrid_Item  *elm_gengrid_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9465
9466    /**
9467     * Get <b>a list</b> of selected items in a given gengrid
9468     *
9469     * @param obj The gengrid object.
9470     * @return The list of selected items or @c NULL, if none is
9471     * selected at the moment (and on errors)
9472     *
9473     * This returns a list of the selected items, in the order that
9474     * they appear in the grid. This list is only valid as long as no
9475     * more items are selected or unselected (or unselected implictly
9476     * by deletion). The list contains #Elm_Gengrid_Item pointers as
9477     * data, naturally.
9478     *
9479     * @see elm_gengrid_selected_item_get()
9480     *
9481     * @ingroup Gengrid
9482     */
9483    EAPI const Eina_List   *elm_gengrid_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9484
9485    /**
9486     * @}
9487     */
9488
9489    /**
9490     * @defgroup Clock Clock
9491     *
9492     * @image html img/widget/clock/preview-00.png
9493     * @image latex img/widget/clock/preview-00.eps
9494     *
9495     * This is a @b digital clock widget. In its default theme, it has a
9496     * vintage "flipping numbers clock" appearance, which will animate
9497     * sheets of individual algarisms individually as time goes by.
9498     *
9499     * A newly created clock will fetch system's time (already
9500     * considering local time adjustments) to start with, and will tick
9501     * accondingly. It may or may not show seconds.
9502     *
9503     * Clocks have an @b edition mode. When in it, the sheets will
9504     * display extra arrow indications on the top and bottom and the
9505     * user may click on them to raise or lower the time values. After
9506     * it's told to exit edition mode, it will keep ticking with that
9507     * new time set (it keeps the difference from local time).
9508     *
9509     * Also, when under edition mode, user clicks on the cited arrows
9510     * which are @b held for some time will make the clock to flip the
9511     * sheet, thus editing the time, continuosly and automatically for
9512     * the user. The interval between sheet flips will keep growing in
9513     * time, so that it helps the user to reach a time which is distant
9514     * from the one set.
9515     *
9516     * The time display is, by default, in military mode (24h), but an
9517     * am/pm indicator may be optionally shown, too, when it will
9518     * switch to 12h.
9519     *
9520     * Smart callbacks one can register to:
9521     * - "changed" - the clock's user changed the time
9522     *
9523     * Here is an example on its usage:
9524     * @li @ref clock_example
9525     */
9526
9527    /**
9528     * @addtogroup Clock
9529     * @{
9530     */
9531
9532    /**
9533     * Identifiers for which clock digits should be editable, when a
9534     * clock widget is in edition mode. Values may be ORed together to
9535     * make a mask, naturally.
9536     *
9537     * @see elm_clock_edit_set()
9538     * @see elm_clock_digit_edit_set()
9539     */
9540    typedef enum _Elm_Clock_Digedit
9541      {
9542         ELM_CLOCK_NONE         = 0, /**< Default value. Means that all digits are editable, when in edition mode. */
9543         ELM_CLOCK_HOUR_DECIMAL = 1 << 0, /**< Decimal algarism of hours value should be editable */
9544         ELM_CLOCK_HOUR_UNIT    = 1 << 1, /**< Unit algarism of hours value should be editable */
9545         ELM_CLOCK_MIN_DECIMAL  = 1 << 2, /**< Decimal algarism of minutes value should be editable */
9546         ELM_CLOCK_MIN_UNIT     = 1 << 3, /**< Unit algarism of minutes value should be editable */
9547         ELM_CLOCK_SEC_DECIMAL  = 1 << 4, /**< Decimal algarism of seconds value should be editable */
9548         ELM_CLOCK_SEC_UNIT     = 1 << 5, /**< Unit algarism of seconds value should be editable */
9549         ELM_CLOCK_ALL          = (1 << 6) - 1 /**< All digits should be editable */
9550      } Elm_Clock_Digedit;
9551
9552    /**
9553     * Add a new clock widget to the given parent Elementary
9554     * (container) object
9555     *
9556     * @param parent The parent object
9557     * @return a new clock widget handle or @c NULL, on errors
9558     *
9559     * This function inserts a new clock widget on the canvas.
9560     *
9561     * @ingroup Clock
9562     */
9563    EAPI Evas_Object      *elm_clock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9564
9565    /**
9566     * Set a clock widget's time, programmatically
9567     *
9568     * @param obj The clock widget object
9569     * @param hrs The hours to set
9570     * @param min The minutes to set
9571     * @param sec The secondes to set
9572     *
9573     * This function updates the time that is showed by the clock
9574     * widget.
9575     *
9576     *  Values @b must be set within the following ranges:
9577     * - 0 - 23, for hours
9578     * - 0 - 59, for minutes
9579     * - 0 - 59, for seconds,
9580     *
9581     * even if the clock is not in "military" mode.
9582     *
9583     * @warning The behavior for values set out of those ranges is @b
9584     * undefined.
9585     *
9586     * @ingroup Clock
9587     */
9588    EAPI void              elm_clock_time_set(Evas_Object *obj, int hrs, int min, int sec) EINA_ARG_NONNULL(1);
9589
9590    /**
9591     * Get a clock widget's time values
9592     *
9593     * @param obj The clock object
9594     * @param[out] hrs Pointer to the variable to get the hours value
9595     * @param[out] min Pointer to the variable to get the minutes value
9596     * @param[out] sec Pointer to the variable to get the seconds value
9597     *
9598     * This function gets the time set for @p obj, returning
9599     * it on the variables passed as the arguments to function
9600     *
9601     * @note Use @c NULL pointers on the time values you're not
9602     * interested in: they'll be ignored by the function.
9603     *
9604     * @ingroup Clock
9605     */
9606    EAPI void              elm_clock_time_get(const Evas_Object *obj, int *hrs, int *min, int *sec) EINA_ARG_NONNULL(1);
9607
9608    /**
9609     * Set whether a given clock widget is under <b>edition mode</b> or
9610     * under (default) displaying-only mode.
9611     *
9612     * @param obj The clock object
9613     * @param edit @c EINA_TRUE to put it in edition, @c EINA_FALSE to
9614     * put it back to "displaying only" mode
9615     *
9616     * This function makes a clock's time to be editable or not <b>by
9617     * user interaction</b>. When in edition mode, clocks @b stop
9618     * ticking, until one brings them back to canonical mode. The
9619     * elm_clock_digit_edit_set() function will influence which digits
9620     * of the clock will be editable. By default, all of them will be
9621     * (#ELM_CLOCK_NONE).
9622     *
9623     * @note am/pm sheets, if being shown, will @b always be editable
9624     * under edition mode.
9625     *
9626     * @see elm_clock_edit_get()
9627     *
9628     * @ingroup Clock
9629     */
9630    EAPI void              elm_clock_edit_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
9631
9632    /**
9633     * Retrieve whether a given clock widget is under <b>edition
9634     * mode</b> or under (default) displaying-only mode.
9635     *
9636     * @param obj The clock object
9637     * @param edit @c EINA_TRUE, if it's in edition mode, @c EINA_FALSE
9638     * otherwise
9639     *
9640     * This function retrieves whether the clock's time can be edited
9641     * or not by user interaction.
9642     *
9643     * @see elm_clock_edit_set() for more details
9644     *
9645     * @ingroup Clock
9646     */
9647    EAPI Eina_Bool         elm_clock_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9648
9649    /**
9650     * Set what digits of the given clock widget should be editable
9651     * when in edition mode.
9652     *
9653     * @param obj The clock object
9654     * @param digedit Bit mask indicating the digits to be editable
9655     * (values in #Elm_Clock_Digedit).
9656     *
9657     * If the @p digedit param is #ELM_CLOCK_NONE, editing will be
9658     * disabled on @p obj (same effect as elm_clock_edit_set(), with @c
9659     * EINA_FALSE).
9660     *
9661     * @see elm_clock_digit_edit_get()
9662     *
9663     * @ingroup Clock
9664     */
9665    EAPI void              elm_clock_digit_edit_set(Evas_Object *obj, Elm_Clock_Digedit digedit) EINA_ARG_NONNULL(1);
9666
9667    /**
9668     * Retrieve what digits of the given clock widget should be
9669     * editable when in edition mode.
9670     *
9671     * @param obj The clock object
9672     * @return Bit mask indicating the digits to be editable
9673     * (values in #Elm_Clock_Digedit).
9674     *
9675     * @see elm_clock_digit_edit_set() for more details
9676     *
9677     * @ingroup Clock
9678     */
9679    EAPI Elm_Clock_Digedit elm_clock_digit_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9680
9681    /**
9682     * Set if the given clock widget must show hours in military or
9683     * am/pm mode
9684     *
9685     * @param obj The clock object
9686     * @param am_pm @c EINA_TRUE to put it in am/pm mode, @c EINA_FALSE
9687     * to military mode
9688     *
9689     * This function sets if the clock must show hours in military or
9690     * am/pm mode. In some countries like Brazil the military mode
9691     * (00-24h-format) is used, in opposition to the USA, where the
9692     * am/pm mode is more commonly used.
9693     *
9694     * @see elm_clock_show_am_pm_get()
9695     *
9696     * @ingroup Clock
9697     */
9698    EAPI void              elm_clock_show_am_pm_set(Evas_Object *obj, Eina_Bool am_pm) EINA_ARG_NONNULL(1);
9699
9700    /**
9701     * Get if the given clock widget shows hours in military or am/pm
9702     * mode
9703     *
9704     * @param obj The clock object
9705     * @return @c EINA_TRUE, if in am/pm mode, @c EINA_FALSE if in
9706     * military
9707     *
9708     * This function gets if the clock shows hours in military or am/pm
9709     * mode.
9710     *
9711     * @see elm_clock_show_am_pm_set() for more details
9712     *
9713     * @ingroup Clock
9714     */
9715    EAPI Eina_Bool         elm_clock_show_am_pm_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9716
9717    /**
9718     * Set if the given clock widget must show time with seconds or not
9719     *
9720     * @param obj The clock object
9721     * @param seconds @c EINA_TRUE to show seconds, @c EINA_FALSE otherwise
9722     *
9723     * This function sets if the given clock must show or not elapsed
9724     * seconds. By default, they are @b not shown.
9725     *
9726     * @see elm_clock_show_seconds_get()
9727     *
9728     * @ingroup Clock
9729     */
9730    EAPI void              elm_clock_show_seconds_set(Evas_Object *obj, Eina_Bool seconds) EINA_ARG_NONNULL(1);
9731
9732    /**
9733     * Get whether the given clock widget is showing time with seconds
9734     * or not
9735     *
9736     * @param obj The clock object
9737     * @return @c EINA_TRUE if it's showing seconds, @c EINA_FALSE otherwise
9738     *
9739     * This function gets whether @p obj is showing or not the elapsed
9740     * seconds.
9741     *
9742     * @see elm_clock_show_seconds_set()
9743     *
9744     * @ingroup Clock
9745     */
9746    EAPI Eina_Bool         elm_clock_show_seconds_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9747
9748    /**
9749     * Set the interval on time updates for an user mouse button hold
9750     * on clock widgets' time edition.
9751     *
9752     * @param obj The clock object
9753     * @param interval The (first) interval value in seconds
9754     *
9755     * This interval value is @b decreased while the user holds the
9756     * mouse pointer either incrementing or decrementing a given the
9757     * clock digit's value.
9758     *
9759     * This helps the user to get to a given time distant from the
9760     * current one easier/faster, as it will start to flip quicker and
9761     * quicker on mouse button holds.
9762     *
9763     * The calculation for the next flip interval value, starting from
9764     * the one set with this call, is the previous interval divided by
9765     * 1.05, so it decreases a little bit.
9766     *
9767     * The default starting interval value for automatic flips is
9768     * @b 0.85 seconds.
9769     *
9770     * @see elm_clock_interval_get()
9771     *
9772     * @ingroup Clock
9773     */
9774    EAPI void              elm_clock_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
9775
9776    /**
9777     * Get the interval on time updates for an user mouse button hold
9778     * on clock widgets' time edition.
9779     *
9780     * @param obj The clock object
9781     * @return The (first) interval value, in seconds, set on it
9782     *
9783     * @see elm_clock_interval_set() for more details
9784     *
9785     * @ingroup Clock
9786     */
9787    EAPI double            elm_clock_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9788
9789    /**
9790     * @}
9791     */
9792
9793    /**
9794     * @defgroup Layout Layout
9795     *
9796     * @image html img/widget/layout/preview-00.png
9797     * @image latex img/widget/layout/preview-00.eps width=\textwidth
9798     *
9799     * @image html img/layout-predefined.png
9800     * @image latex img/layout-predefined.eps width=\textwidth
9801     *
9802     * This is a container widget that takes a standard Edje design file and
9803     * wraps it very thinly in a widget.
9804     *
9805     * An Edje design (theme) file has a very wide range of possibilities to
9806     * describe the behavior of elements added to the Layout. Check out the Edje
9807     * documentation and the EDC reference to get more information about what can
9808     * be done with Edje.
9809     *
9810     * Just like @ref List, @ref Box, and other container widgets, any
9811     * object added to the Layout will become its child, meaning that it will be
9812     * deleted if the Layout is deleted, move if the Layout is moved, and so on.
9813     *
9814     * The Layout widget can contain as many Contents, Boxes or Tables as
9815     * described in its theme file. For instance, objects can be added to
9816     * different Tables by specifying the respective Table part names. The same
9817     * is valid for Content and Box.
9818     *
9819     * The objects added as child of the Layout will behave as described in the
9820     * part description where they were added. There are 3 possible types of
9821     * parts where a child can be added:
9822     *
9823     * @section secContent Content (SWALLOW part)
9824     *
9825     * Only one object can be added to the @c SWALLOW part (but you still can
9826     * have many @c SWALLOW parts and one object on each of them). Use the @c
9827     * elm_object_content_set/get/unset functions to set, retrieve and unset 
9828     * objects as content of the @c SWALLOW. After being set to this part, the 
9829     * object size, position, visibility, clipping and other description 
9830     * properties will be totally controled by the description of the given part 
9831     * (inside the Edje theme file).
9832     *
9833     * One can use @c evas_object_size_hint_* functions on the child to have some
9834     * kind of control over its behavior, but the resulting behavior will still
9835     * depend heavily on the @c SWALLOW part description.
9836     *
9837     * The Edje theme also can change the part description, based on signals or
9838     * scripts running inside the theme. This change can also be animated. All of
9839     * this will affect the child object set as content accordingly. The object
9840     * size will be changed if the part size is changed, it will animate move if
9841     * the part is moving, and so on.
9842     *
9843     * The following picture demonstrates a Layout widget with a child object
9844     * added to its @c SWALLOW:
9845     *
9846     * @image html layout_swallow.png
9847     * @image latex layout_swallow.eps width=\textwidth
9848     *
9849     * @section secBox Box (BOX part)
9850     *
9851     * An Edje @c BOX part is very similar to the Elementary @ref Box widget. It
9852     * allows one to add objects to the box and have them distributed along its
9853     * area, accordingly to the specified @a layout property (now by @a layout we
9854     * mean the chosen layouting design of the Box, not the Layout widget
9855     * itself).
9856     *
9857     * A similar effect for having a box with its position, size and other things
9858     * controled by the Layout theme would be to create an Elementary @ref Box
9859     * widget and add it as a Content in the @c SWALLOW part.
9860     *
9861     * The main difference of using the Layout Box is that its behavior, the box
9862     * properties like layouting format, padding, align, etc. will be all
9863     * controled by the theme. This means, for example, that a signal could be
9864     * sent to the Layout theme (with elm_object_signal_emit()) and the theme
9865     * handled the signal by changing the box padding, or align, or both. Using
9866     * the Elementary @ref Box widget is not necessarily harder or easier, it
9867     * just depends on the circunstances and requirements.
9868     *
9869     * The Layout Box can be used through the @c elm_layout_box_* set of
9870     * functions.
9871     *
9872     * The following picture demonstrates a Layout widget with many child objects
9873     * added to its @c BOX part:
9874     *
9875     * @image html layout_box.png
9876     * @image latex layout_box.eps width=\textwidth
9877     *
9878     * @section secTable Table (TABLE part)
9879     *
9880     * Just like the @ref secBox, the Layout Table is very similar to the
9881     * Elementary @ref Table widget. It allows one to add objects to the Table
9882     * specifying the row and column where the object should be added, and any
9883     * column or row span if necessary.
9884     *
9885     * Again, we could have this design by adding a @ref Table widget to the @c
9886     * SWALLOW part using elm_object_content_part_set(). The same difference happens
9887     * here when choosing to use the Layout Table (a @c TABLE part) instead of
9888     * the @ref Table plus @c SWALLOW part. It's just a matter of convenience.
9889     *
9890     * The Layout Table can be used through the @c elm_layout_table_* set of
9891     * functions.
9892     *
9893     * The following picture demonstrates a Layout widget with many child objects
9894     * added to its @c TABLE part:
9895     *
9896     * @image html layout_table.png
9897     * @image latex layout_table.eps width=\textwidth
9898     *
9899     * @section secPredef Predefined Layouts
9900     *
9901     * Another interesting thing about the Layout widget is that it offers some
9902     * predefined themes that come with the default Elementary theme. These
9903     * themes can be set by the call elm_layout_theme_set(), and provide some
9904     * basic functionality depending on the theme used.
9905     *
9906     * Most of them already send some signals, some already provide a toolbar or
9907     * back and next buttons.
9908     *
9909     * These are available predefined theme layouts. All of them have class = @c
9910     * layout, group = @c application, and style = one of the following options:
9911     *
9912     * @li @c toolbar-content - application with toolbar and main content area
9913     * @li @c toolbar-content-back - application with toolbar and main content
9914     * area with a back button and title area
9915     * @li @c toolbar-content-back-next - application with toolbar and main
9916     * content area with a back and next buttons and title area
9917     * @li @c content-back - application with a main content area with a back
9918     * button and title area
9919     * @li @c content-back-next - application with a main content area with a
9920     * back and next buttons and title area
9921     * @li @c toolbar-vbox - application with toolbar and main content area as a
9922     * vertical box
9923     * @li @c toolbar-table - application with toolbar and main content area as a
9924     * table
9925     *
9926     * @section secExamples Examples
9927     *
9928     * Some examples of the Layout widget can be found here:
9929     * @li @ref layout_example_01
9930     * @li @ref layout_example_02
9931     * @li @ref layout_example_03
9932     * @li @ref layout_example_edc
9933     *
9934     */
9935
9936    /**
9937     * Add a new layout to the parent
9938     *
9939     * @param parent The parent object
9940     * @return The new object or NULL if it cannot be created
9941     *
9942     * @see elm_layout_file_set()
9943     * @see elm_layout_theme_set()
9944     *
9945     * @ingroup Layout
9946     */
9947    EAPI Evas_Object       *elm_layout_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9948    /**
9949     * Set the file that will be used as layout
9950     *
9951     * @param obj The layout object
9952     * @param file The path to file (edj) that will be used as layout
9953     * @param group The group that the layout belongs in edje file
9954     *
9955     * @return (1 = success, 0 = error)
9956     *
9957     * @ingroup Layout
9958     */
9959    EAPI Eina_Bool          elm_layout_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
9960    /**
9961     * Set the edje group from the elementary theme that will be used as layout
9962     *
9963     * @param obj The layout object
9964     * @param clas the clas of the group
9965     * @param group the group
9966     * @param style the style to used
9967     *
9968     * @return (1 = success, 0 = error)
9969     *
9970     * @ingroup Layout
9971     */
9972    EAPI Eina_Bool          elm_layout_theme_set(Evas_Object *obj, const char *clas, const char *group, const char *style) EINA_ARG_NONNULL(1);
9973    /**
9974     * Set the layout content.
9975     *
9976     * @param obj The layout object
9977     * @param swallow The swallow part name in the edje file
9978     * @param content The child that will be added in this layout object
9979     *
9980     * Once the content object is set, a previously set one will be deleted.
9981     * If you want to keep that old content object, use the
9982     * elm_object_content_part_unset() function.
9983     *
9984     * @note In an Edje theme, the part used as a content container is called @c
9985     * SWALLOW. This is why the parameter name is called @p swallow, but it is
9986     * expected to be a part name just like the second parameter of
9987     * elm_layout_box_append().
9988     *
9989     * @see elm_layout_box_append()
9990     * @see elm_object_content_part_get()
9991     * @see elm_object_content_part_unset()
9992     * @see @ref secBox
9993     *
9994     * @ingroup Layout
9995     */
9996    EINA_DEPRECATED EAPI void               elm_layout_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
9997    /**
9998     * Get the child object in the given content part.
9999     *
10000     * @param obj The layout object
10001     * @param swallow The SWALLOW part to get its content
10002     *
10003     * @return The swallowed object or NULL if none or an error occurred
10004     *
10005     * @see elm_object_content_part_set()
10006     *
10007     * @ingroup Layout
10008     */
10009    EINA_DEPRECATED EAPI Evas_Object       *elm_layout_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10010    /**
10011     * Unset the layout content.
10012     *
10013     * @param obj The layout object
10014     * @param swallow The swallow part name in the edje file
10015     * @return The content that was being used
10016     *
10017     * Unparent and return the content object which was set for this part.
10018     *
10019     * @see elm_object_content_part_set()
10020     *
10021     * @ingroup Layout
10022     */
10023    EINA_DEPRECATED EAPI Evas_Object       *elm_layout_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10024    /**
10025     * Set the text of the given part
10026     *
10027     * @param obj The layout object
10028     * @param part The TEXT part where to set the text
10029     * @param text The text to set
10030     *
10031     * @ingroup Layout
10032     * @deprecated use elm_object_text_* instead.
10033     */
10034    EINA_DEPRECATED EAPI void               elm_layout_text_set(Evas_Object *obj, const char *part, const char *text) EINA_ARG_NONNULL(1);
10035    /**
10036     * Get the text set in the given part
10037     *
10038     * @param obj The layout object
10039     * @param part The TEXT part to retrieve the text off
10040     *
10041     * @return The text set in @p part
10042     *
10043     * @ingroup Layout
10044     * @deprecated use elm_object_text_* instead.
10045     */
10046    EINA_DEPRECATED EAPI const char        *elm_layout_text_get(const Evas_Object *obj, const char *part) EINA_ARG_NONNULL(1);
10047    /**
10048     * Append child to layout box part.
10049     *
10050     * @param obj the layout object
10051     * @param part the box part to which the object will be appended.
10052     * @param child the child object to append to box.
10053     *
10054     * Once the object is appended, it will become child of the layout. Its
10055     * lifetime will be bound to the layout, whenever the layout dies the child
10056     * will be deleted automatically. One should use elm_layout_box_remove() to
10057     * make this layout forget about the object.
10058     *
10059     * @see elm_layout_box_prepend()
10060     * @see elm_layout_box_insert_before()
10061     * @see elm_layout_box_insert_at()
10062     * @see elm_layout_box_remove()
10063     *
10064     * @ingroup Layout
10065     */
10066    EAPI void               elm_layout_box_append(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
10067    /**
10068     * Prepend child to layout box part.
10069     *
10070     * @param obj the layout object
10071     * @param part the box part to prepend.
10072     * @param child the child object to prepend to box.
10073     *
10074     * Once the object is prepended, it will become child of the layout. Its
10075     * lifetime will be bound to the layout, whenever the layout dies the child
10076     * will be deleted automatically. One should use elm_layout_box_remove() to
10077     * make this layout forget about the object.
10078     *
10079     * @see elm_layout_box_append()
10080     * @see elm_layout_box_insert_before()
10081     * @see elm_layout_box_insert_at()
10082     * @see elm_layout_box_remove()
10083     *
10084     * @ingroup Layout
10085     */
10086    EAPI void               elm_layout_box_prepend(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
10087    /**
10088     * Insert child to layout box part before a reference object.
10089     *
10090     * @param obj the layout object
10091     * @param part the box part to insert.
10092     * @param child the child object to insert into box.
10093     * @param reference another reference object to insert before in box.
10094     *
10095     * Once the object is inserted, it will become child of the layout. Its
10096     * lifetime will be bound to the layout, whenever the layout dies the child
10097     * will be deleted automatically. One should use elm_layout_box_remove() to
10098     * make this layout forget about the object.
10099     *
10100     * @see elm_layout_box_append()
10101     * @see elm_layout_box_prepend()
10102     * @see elm_layout_box_insert_before()
10103     * @see elm_layout_box_remove()
10104     *
10105     * @ingroup Layout
10106     */
10107    EAPI void               elm_layout_box_insert_before(Evas_Object *obj, const char *part, Evas_Object *child, const Evas_Object *reference) EINA_ARG_NONNULL(1);
10108    /**
10109     * Insert child to layout box part at a given position.
10110     *
10111     * @param obj the layout object
10112     * @param part the box part to insert.
10113     * @param child the child object to insert into box.
10114     * @param pos the numeric position >=0 to insert the child.
10115     *
10116     * Once the object is inserted, it will become child of the layout. Its
10117     * lifetime will be bound to the layout, whenever the layout dies the child
10118     * will be deleted automatically. One should use elm_layout_box_remove() to
10119     * make this layout forget about the object.
10120     *
10121     * @see elm_layout_box_append()
10122     * @see elm_layout_box_prepend()
10123     * @see elm_layout_box_insert_before()
10124     * @see elm_layout_box_remove()
10125     *
10126     * @ingroup Layout
10127     */
10128    EAPI void               elm_layout_box_insert_at(Evas_Object *obj, const char *part, Evas_Object *child, unsigned int pos) EINA_ARG_NONNULL(1);
10129    /**
10130     * Remove a child of the given part box.
10131     *
10132     * @param obj The layout object
10133     * @param part The box part name to remove child.
10134     * @param child The object to remove from box.
10135     * @return The object that was being used, or NULL if not found.
10136     *
10137     * The object will be removed from the box part and its lifetime will
10138     * not be handled by the layout anymore. This is equivalent to
10139     * elm_object_content_part_unset() for box.
10140     *
10141     * @see elm_layout_box_append()
10142     * @see elm_layout_box_remove_all()
10143     *
10144     * @ingroup Layout
10145     */
10146    EAPI Evas_Object       *elm_layout_box_remove(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1, 2, 3);
10147    /**
10148     * Remove all child of the given part box.
10149     *
10150     * @param obj The layout object
10151     * @param part The box part name to remove child.
10152     * @param clear If EINA_TRUE, then all objects will be deleted as
10153     *        well, otherwise they will just be removed and will be
10154     *        dangling on the canvas.
10155     *
10156     * The objects will be removed from the box part and their lifetime will
10157     * not be handled by the layout anymore. This is equivalent to
10158     * elm_layout_box_remove() for all box children.
10159     *
10160     * @see elm_layout_box_append()
10161     * @see elm_layout_box_remove()
10162     *
10163     * @ingroup Layout
10164     */
10165    EAPI void               elm_layout_box_remove_all(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
10166    /**
10167     * Insert child to layout table part.
10168     *
10169     * @param obj the layout object
10170     * @param part the box part to pack child.
10171     * @param child_obj the child object to pack into table.
10172     * @param col the column to which the child should be added. (>= 0)
10173     * @param row the row to which the child should be added. (>= 0)
10174     * @param colspan how many columns should be used to store this object. (>=
10175     *        1)
10176     * @param rowspan how many rows should be used to store this object. (>= 1)
10177     *
10178     * Once the object is inserted, it will become child of the table. Its
10179     * lifetime will be bound to the layout, and whenever the layout dies the
10180     * child will be deleted automatically. One should use
10181     * elm_layout_table_remove() to make this layout forget about the object.
10182     *
10183     * If @p colspan or @p rowspan are bigger than 1, that object will occupy
10184     * more space than a single cell. For instance, the following code:
10185     * @code
10186     * elm_layout_table_pack(layout, "table_part", child, 0, 1, 3, 1);
10187     * @endcode
10188     *
10189     * Would result in an object being added like the following picture:
10190     *
10191     * @image html layout_colspan.png
10192     * @image latex layout_colspan.eps width=\textwidth
10193     *
10194     * @see elm_layout_table_unpack()
10195     * @see elm_layout_table_clear()
10196     *
10197     * @ingroup Layout
10198     */
10199    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);
10200    /**
10201     * Unpack (remove) a child of the given part table.
10202     *
10203     * @param obj The layout object
10204     * @param part The table part name to remove child.
10205     * @param child_obj The object to remove from table.
10206     * @return The object that was being used, or NULL if not found.
10207     *
10208     * The object will be unpacked from the table part and its lifetime
10209     * will not be handled by the layout anymore. This is equivalent to
10210     * elm_object_content_part_unset() for table.
10211     *
10212     * @see elm_layout_table_pack()
10213     * @see elm_layout_table_clear()
10214     *
10215     * @ingroup Layout
10216     */
10217    EAPI Evas_Object       *elm_layout_table_unpack(Evas_Object *obj, const char *part, Evas_Object *child_obj) EINA_ARG_NONNULL(1, 2, 3);
10218    /**
10219     * Remove all child of the given part table.
10220     *
10221     * @param obj The layout object
10222     * @param part The table part name to remove child.
10223     * @param clear If EINA_TRUE, then all objects will be deleted as
10224     *        well, otherwise they will just be removed and will be
10225     *        dangling on the canvas.
10226     *
10227     * The objects will be removed from the table part and their lifetime will
10228     * not be handled by the layout anymore. This is equivalent to
10229     * elm_layout_table_unpack() for all table children.
10230     *
10231     * @see elm_layout_table_pack()
10232     * @see elm_layout_table_unpack()
10233     *
10234     * @ingroup Layout
10235     */
10236    EAPI void               elm_layout_table_clear(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
10237    /**
10238     * Get the edje layout
10239     *
10240     * @param obj The layout object
10241     *
10242     * @return A Evas_Object with the edje layout settings loaded
10243     * with function elm_layout_file_set
10244     *
10245     * This returns the edje object. It is not expected to be used to then
10246     * swallow objects via edje_object_part_swallow() for example. Use
10247     * elm_object_content_part_set() instead so child object handling and sizing is
10248     * done properly.
10249     *
10250     * @note This function should only be used if you really need to call some
10251     * low level Edje function on this edje object. All the common stuff (setting
10252     * text, emitting signals, hooking callbacks to signals, etc.) can be done
10253     * with proper elementary functions.
10254     *
10255     * @see elm_object_signal_callback_add()
10256     * @see elm_object_signal_emit()
10257     * @see elm_object_text_part_set()
10258     * @see elm_object_content_part_set()
10259     * @see elm_layout_box_append()
10260     * @see elm_layout_table_pack()
10261     * @see elm_layout_data_get()
10262     *
10263     * @ingroup Layout
10264     */
10265    EAPI Evas_Object       *elm_layout_edje_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10266    /**
10267     * Get the edje data from the given layout
10268     *
10269     * @param obj The layout object
10270     * @param key The data key
10271     *
10272     * @return The edje data string
10273     *
10274     * This function fetches data specified inside the edje theme of this layout.
10275     * This function return NULL if data is not found.
10276     *
10277     * In EDC this comes from a data block within the group block that @p
10278     * obj was loaded from. E.g.
10279     *
10280     * @code
10281     * collections {
10282     *   group {
10283     *     name: "a_group";
10284     *     data {
10285     *       item: "key1" "value1";
10286     *       item: "key2" "value2";
10287     *     }
10288     *   }
10289     * }
10290     * @endcode
10291     *
10292     * @ingroup Layout
10293     */
10294    EAPI const char        *elm_layout_data_get(const Evas_Object *obj, const char *key) EINA_ARG_NONNULL(1, 2);
10295    /**
10296     * Eval sizing
10297     *
10298     * @param obj The layout object
10299     *
10300     * Manually forces a sizing re-evaluation. This is useful when the minimum
10301     * size required by the edje theme of this layout has changed. The change on
10302     * the minimum size required by the edje theme is not immediately reported to
10303     * the elementary layout, so one needs to call this function in order to tell
10304     * the widget (layout) that it needs to reevaluate its own size.
10305     *
10306     * The minimum size of the theme is calculated based on minimum size of
10307     * parts, the size of elements inside containers like box and table, etc. All
10308     * of this can change due to state changes, and that's when this function
10309     * should be called.
10310     *
10311     * Also note that a standard signal of "size,eval" "elm" emitted from the
10312     * edje object will cause this to happen too.
10313     *
10314     * @ingroup Layout
10315     */
10316    EAPI void               elm_layout_sizing_eval(Evas_Object *obj) EINA_ARG_NONNULL(1);
10317
10318    /**
10319     * Sets a specific cursor for an edje part.
10320     *
10321     * @param obj The layout object.
10322     * @param part_name a part from loaded edje group.
10323     * @param cursor cursor name to use, see Elementary_Cursor.h
10324     *
10325     * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10326     *         part not exists or it has "mouse_events: 0".
10327     *
10328     * @ingroup Layout
10329     */
10330    EAPI Eina_Bool          elm_layout_part_cursor_set(Evas_Object *obj, const char *part_name, const char *cursor) EINA_ARG_NONNULL(1, 2);
10331
10332    /**
10333     * Get the cursor to be shown when mouse is over an edje part
10334     *
10335     * @param obj The layout object.
10336     * @param part_name a part from loaded edje group.
10337     * @return the cursor name.
10338     *
10339     * @ingroup Layout
10340     */
10341    EAPI const char        *elm_layout_part_cursor_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10342
10343    /**
10344     * Unsets a cursor previously set with elm_layout_part_cursor_set().
10345     *
10346     * @param obj The layout object.
10347     * @param part_name a part from loaded edje group, that had a cursor set
10348     *        with elm_layout_part_cursor_set().
10349     *
10350     * @ingroup Layout
10351     */
10352    EAPI void               elm_layout_part_cursor_unset(Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10353
10354    /**
10355     * Sets a specific cursor style for an edje part.
10356     *
10357     * @param obj The layout object.
10358     * @param part_name a part from loaded edje group.
10359     * @param style the theme style to use (default, transparent, ...)
10360     *
10361     * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10362     *         part not exists or it did not had a cursor set.
10363     *
10364     * @ingroup Layout
10365     */
10366    EAPI Eina_Bool          elm_layout_part_cursor_style_set(Evas_Object *obj, const char *part_name, const char *style) EINA_ARG_NONNULL(1, 2);
10367
10368    /**
10369     * Gets a specific cursor style for an edje part.
10370     *
10371     * @param obj The layout object.
10372     * @param part_name a part from loaded edje group.
10373     *
10374     * @return the theme style in use, defaults to "default". If the
10375     *         object does not have a cursor set, then NULL is returned.
10376     *
10377     * @ingroup Layout
10378     */
10379    EAPI const char        *elm_layout_part_cursor_style_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10380
10381    /**
10382     * Sets if the cursor set should be searched on the theme or should use
10383     * the provided by the engine, only.
10384     *
10385     * @note before you set if should look on theme you should define a
10386     * cursor with elm_layout_part_cursor_set(). By default it will only
10387     * look for cursors provided by the engine.
10388     *
10389     * @param obj The layout object.
10390     * @param part_name a part from loaded edje group.
10391     * @param engine_only if cursors should be just provided by the engine
10392     *        or should also search on widget's theme as well
10393     *
10394     * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10395     *         part not exists or it did not had a cursor set.
10396     *
10397     * @ingroup Layout
10398     */
10399    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);
10400
10401    /**
10402     * Gets a specific cursor engine_only for an edje part.
10403     *
10404     * @param obj The layout object.
10405     * @param part_name a part from loaded edje group.
10406     *
10407     * @return whenever the cursor is just provided by engine or also from theme.
10408     *
10409     * @ingroup Layout
10410     */
10411    EAPI Eina_Bool          elm_layout_part_cursor_engine_only_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10412
10413 /**
10414  * @def elm_layout_icon_set
10415  * Convienience macro to set the icon object in a layout that follows the
10416  * Elementary naming convention for its parts.
10417  *
10418  * @ingroup Layout
10419  */
10420 #define elm_layout_icon_set(_ly, _obj) \
10421   do { \
10422     const char *sig; \
10423     elm_object_content_part_set((_ly), "elm.swallow.icon", (_obj)); \
10424     if ((_obj)) sig = "elm,state,icon,visible"; \
10425     else sig = "elm,state,icon,hidden"; \
10426     elm_object_signal_emit((_ly), sig, "elm"); \
10427   } while (0)
10428
10429 /**
10430  * @def elm_layout_icon_get
10431  * Convienience macro to get the icon object from a layout that follows the
10432  * Elementary naming convention for its parts.
10433  *
10434  * @ingroup Layout
10435  */
10436 #define elm_layout_icon_get(_ly) \
10437   elm_object_content_part_get((_ly), "elm.swallow.icon")
10438
10439 /**
10440  * @def elm_layout_end_set
10441  * Convienience macro to set the end object in a layout that follows the
10442  * Elementary naming convention for its parts.
10443  *
10444  * @ingroup Layout
10445  */
10446 #define elm_layout_end_set(_ly, _obj) \
10447   do { \
10448     const char *sig; \
10449     elm_object_content_part_set((_ly), "elm.swallow.end", (_obj)); \
10450     if ((_obj)) sig = "elm,state,end,visible"; \
10451     else sig = "elm,state,end,hidden"; \
10452     elm_object_signal_emit((_ly), sig, "elm"); \
10453   } while (0)
10454
10455 /**
10456  * @def elm_layout_end_get
10457  * Convienience macro to get the end object in a layout that follows the
10458  * Elementary naming convention for its parts.
10459  *
10460  * @ingroup Layout
10461  */
10462 #define elm_layout_end_get(_ly) \
10463   elm_object_content_part_get((_ly), "elm.swallow.end")
10464
10465 /**
10466  * @def elm_layout_label_set
10467  * Convienience macro to set the label in a layout that follows the
10468  * Elementary naming convention for its parts.
10469  *
10470  * @ingroup Layout
10471  * @deprecated use elm_object_text_* instead.
10472  */
10473 #define elm_layout_label_set(_ly, _txt) \
10474   elm_layout_text_set((_ly), "elm.text", (_txt))
10475
10476 /**
10477  * @def elm_layout_label_get
10478  * Convenience macro to get the label in a layout that follows the
10479  * Elementary naming convention for its parts.
10480  *
10481  * @ingroup Layout
10482  * @deprecated use elm_object_text_* instead.
10483  */
10484 #define elm_layout_label_get(_ly) \
10485   elm_layout_text_get((_ly), "elm.text")
10486
10487    /* smart callbacks called:
10488     * "theme,changed" - when elm theme is changed.
10489     */
10490
10491    /**
10492     * @defgroup Notify Notify
10493     *
10494     * @image html img/widget/notify/preview-00.png
10495     * @image latex img/widget/notify/preview-00.eps
10496     *
10497     * Display a container in a particular region of the parent(top, bottom,
10498     * etc).  A timeout can be set to automatically hide the notify. This is so
10499     * that, after an evas_object_show() on a notify object, if a timeout was set
10500     * on it, it will @b automatically get hidden after that time.
10501     *
10502     * Signals that you can add callbacks for are:
10503     * @li "timeout" - when timeout happens on notify and it's hidden
10504     * @li "block,clicked" - when a click outside of the notify happens
10505     *
10506     * Default contents parts of the notify widget that you can use for are:
10507     * @li "elm.swallow.content" - A content of the notify
10508     *
10509     * @ref tutorial_notify show usage of the API.
10510     *
10511     * @{
10512     */
10513    /**
10514     * @brief Possible orient values for notify.
10515     *
10516     * This values should be used in conjunction to elm_notify_orient_set() to
10517     * set the position in which the notify should appear(relative to its parent)
10518     * and in conjunction with elm_notify_orient_get() to know where the notify
10519     * is appearing.
10520     */
10521    typedef enum _Elm_Notify_Orient
10522      {
10523         ELM_NOTIFY_ORIENT_TOP, /**< Notify should appear in the top of parent, default */
10524         ELM_NOTIFY_ORIENT_CENTER, /**< Notify should appear in the center of parent */
10525         ELM_NOTIFY_ORIENT_BOTTOM, /**< Notify should appear in the bottom of parent */
10526         ELM_NOTIFY_ORIENT_LEFT, /**< Notify should appear in the left of parent */
10527         ELM_NOTIFY_ORIENT_RIGHT, /**< Notify should appear in the right of parent */
10528         ELM_NOTIFY_ORIENT_TOP_LEFT, /**< Notify should appear in the top left of parent */
10529         ELM_NOTIFY_ORIENT_TOP_RIGHT, /**< Notify should appear in the top right of parent */
10530         ELM_NOTIFY_ORIENT_BOTTOM_LEFT, /**< Notify should appear in the bottom left of parent */
10531         ELM_NOTIFY_ORIENT_BOTTOM_RIGHT, /**< Notify should appear in the bottom right of parent */
10532         ELM_NOTIFY_ORIENT_LAST /**< Sentinel value, @b don't use */
10533      } Elm_Notify_Orient;
10534    /**
10535     * @brief Add a new notify to the parent
10536     *
10537     * @param parent The parent object
10538     * @return The new object or NULL if it cannot be created
10539     */
10540    EAPI Evas_Object      *elm_notify_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10541    /**
10542     * @brief Set the content of the notify widget
10543     *
10544     * @param obj The notify object
10545     * @param content The content will be filled in this notify object
10546     *
10547     * Once the content object is set, a previously set one will be deleted. If
10548     * you want to keep that old content object, use the
10549     * elm_notify_content_unset() function.
10550     */
10551    EINA_DEPRECATED EAPI void              elm_notify_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
10552    /**
10553     * @brief Unset the content of the notify widget
10554     *
10555     * @param obj The notify object
10556     * @return The content that was being used
10557     *
10558     * Unparent and return the content object which was set for this widget
10559     *
10560     * @see elm_notify_content_set()
10561     */
10562    EINA_DEPRECATED EAPI Evas_Object      *elm_notify_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
10563    /**
10564     * @brief Return the content of the notify widget
10565     *
10566     * @param obj The notify object
10567     * @return The content that is being used
10568     *
10569     * @see elm_notify_content_set()
10570     */
10571    EINA_DEPRECATED EAPI Evas_Object      *elm_notify_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10572    /**
10573     * @brief Set the notify parent
10574     *
10575     * @param obj The notify object
10576     * @param content The new parent
10577     *
10578     * Once the parent object is set, a previously set one will be disconnected
10579     * and replaced.
10580     */
10581    EAPI void              elm_notify_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10582    /**
10583     * @brief Get the notify parent
10584     *
10585     * @param obj The notify object
10586     * @return The parent
10587     *
10588     * @see elm_notify_parent_set()
10589     */
10590    EAPI Evas_Object      *elm_notify_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10591    /**
10592     * @brief Set the orientation
10593     *
10594     * @param obj The notify object
10595     * @param orient The new orientation
10596     *
10597     * Sets the position in which the notify will appear in its parent.
10598     *
10599     * @see @ref Elm_Notify_Orient for possible values.
10600     */
10601    EAPI void              elm_notify_orient_set(Evas_Object *obj, Elm_Notify_Orient orient) EINA_ARG_NONNULL(1);
10602    /**
10603     * @brief Return the orientation
10604     * @param obj The notify object
10605     * @return The orientation of the notification
10606     *
10607     * @see elm_notify_orient_set()
10608     * @see Elm_Notify_Orient
10609     */
10610    EAPI Elm_Notify_Orient elm_notify_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10611    /**
10612     * @brief Set the time interval after which the notify window is going to be
10613     * hidden.
10614     *
10615     * @param obj The notify object
10616     * @param time The timeout in seconds
10617     *
10618     * This function sets a timeout and starts the timer controlling when the
10619     * notify is hidden. Since calling evas_object_show() on a notify restarts
10620     * the timer controlling when the notify is hidden, setting this before the
10621     * notify is shown will in effect mean starting the timer when the notify is
10622     * shown.
10623     *
10624     * @note Set a value <= 0.0 to disable a running timer.
10625     *
10626     * @note If the value > 0.0 and the notify is previously visible, the
10627     * timer will be started with this value, canceling any running timer.
10628     */
10629    EAPI void              elm_notify_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
10630    /**
10631     * @brief Return the timeout value (in seconds)
10632     * @param obj the notify object
10633     *
10634     * @see elm_notify_timeout_set()
10635     */
10636    EAPI double            elm_notify_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10637    /**
10638     * @brief Sets whether events should be passed to by a click outside
10639     * its area.
10640     *
10641     * @param obj The notify object
10642     * @param repeats EINA_TRUE Events are repeats, else no
10643     *
10644     * When true if the user clicks outside the window the events will be caught
10645     * by the others widgets, else the events are blocked.
10646     *
10647     * @note The default value is EINA_TRUE.
10648     */
10649    EAPI void              elm_notify_repeat_events_set(Evas_Object *obj, Eina_Bool repeat) EINA_ARG_NONNULL(1);
10650    /**
10651     * @brief Return true if events are repeat below the notify object
10652     * @param obj the notify object
10653     *
10654     * @see elm_notify_repeat_events_set()
10655     */
10656    EAPI Eina_Bool         elm_notify_repeat_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10657    /**
10658     * @}
10659     */
10660
10661    /**
10662     * @defgroup Hover Hover
10663     *
10664     * @image html img/widget/hover/preview-00.png
10665     * @image latex img/widget/hover/preview-00.eps
10666     *
10667     * A Hover object will hover over its @p parent object at the @p target
10668     * location. Anything in the background will be given a darker coloring to
10669     * indicate that the hover object is on top (at the default theme). When the
10670     * hover is clicked it is dismissed(hidden), if the contents of the hover are
10671     * clicked that @b doesn't cause the hover to be dismissed.
10672     *
10673     * A Hover object has two parents. One parent that owns it during creation
10674     * and the other parent being the one over which the hover object spans.
10675     *
10676     *
10677     * @note The hover object will take up the entire space of @p target
10678     * object.
10679     *
10680     * Elementary has the following styles for the hover widget:
10681     * @li default
10682     * @li popout
10683     * @li menu
10684     * @li hoversel_vertical
10685     *
10686     * The following are the available position for content:
10687     * @li left
10688     * @li top-left
10689     * @li top
10690     * @li top-right
10691     * @li right
10692     * @li bottom-right
10693     * @li bottom
10694     * @li bottom-left
10695     * @li middle
10696     * @li smart
10697     *
10698     * Signals that you can add callbacks for are:
10699     * @li "clicked" - the user clicked the empty space in the hover to dismiss
10700     * @li "smart,changed" - a content object placed under the "smart"
10701     *                   policy was replaced to a new slot direction.
10702     *
10703     * See @ref tutorial_hover for more information.
10704     *
10705     * @{
10706     */
10707    typedef enum _Elm_Hover_Axis
10708      {
10709         ELM_HOVER_AXIS_NONE, /**< ELM_HOVER_AXIS_NONE -- no prefered orientation */
10710         ELM_HOVER_AXIS_HORIZONTAL, /**< ELM_HOVER_AXIS_HORIZONTAL -- horizontal */
10711         ELM_HOVER_AXIS_VERTICAL, /**< ELM_HOVER_AXIS_VERTICAL -- vertical */
10712         ELM_HOVER_AXIS_BOTH /**< ELM_HOVER_AXIS_BOTH -- both */
10713      } Elm_Hover_Axis;
10714    /**
10715     * @brief Adds a hover object to @p parent
10716     *
10717     * @param parent The parent object
10718     * @return The hover object or NULL if one could not be created
10719     */
10720    EAPI Evas_Object *elm_hover_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10721    /**
10722     * @brief Sets the target object for the hover.
10723     *
10724     * @param obj The hover object
10725     * @param target The object to center the hover onto. The hover
10726     *
10727     * This function will cause the hover to be centered on the target object.
10728     */
10729    EAPI void         elm_hover_target_set(Evas_Object *obj, Evas_Object *target) EINA_ARG_NONNULL(1);
10730    /**
10731     * @brief Gets the target object for the hover.
10732     *
10733     * @param obj The hover object
10734     * @param parent The object to locate the hover over.
10735     *
10736     * @see elm_hover_target_set()
10737     */
10738    EAPI Evas_Object *elm_hover_target_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10739    /**
10740     * @brief Sets the parent object for the hover.
10741     *
10742     * @param obj The hover object
10743     * @param parent The object to locate the hover over.
10744     *
10745     * This function will cause the hover to take up the entire space that the
10746     * parent object fills.
10747     */
10748    EAPI void         elm_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10749    /**
10750     * @brief Gets the parent object for the hover.
10751     *
10752     * @param obj The hover object
10753     * @return The parent object to locate the hover over.
10754     *
10755     * @see elm_hover_parent_set()
10756     */
10757    EAPI Evas_Object *elm_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10758    /**
10759     * @brief Sets the content of the hover object and the direction in which it
10760     * will pop out.
10761     *
10762     * @param obj The hover object
10763     * @param swallow The direction that the object will be displayed
10764     * at. Accepted values are "left", "top-left", "top", "top-right",
10765     * "right", "bottom-right", "bottom", "bottom-left", "middle" and
10766     * "smart".
10767     * @param content The content to place at @p swallow
10768     *
10769     * Once the content object is set for a given direction, a previously
10770     * set one (on the same direction) will be deleted. If you want to
10771     * keep that old content object, use the elm_hover_content_unset()
10772     * function.
10773     *
10774     * All directions may have contents at the same time, except for
10775     * "smart". This is a special placement hint and its use case
10776     * independs of the calculations coming from
10777     * elm_hover_best_content_location_get(). Its use is for cases when
10778     * one desires only one hover content, but with a dinamic special
10779     * placement within the hover area. The content's geometry, whenever
10780     * it changes, will be used to decide on a best location not
10781     * extrapolating the hover's parent object view to show it in (still
10782     * being the hover's target determinant of its medium part -- move and
10783     * resize it to simulate finger sizes, for example). If one of the
10784     * directions other than "smart" are used, a previously content set
10785     * using it will be deleted, and vice-versa.
10786     */
10787    EAPI void         elm_hover_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
10788    /**
10789     * @brief Get the content of the hover object, in a given direction.
10790     *
10791     * Return the content object which was set for this widget in the
10792     * @p swallow direction.
10793     *
10794     * @param obj The hover object
10795     * @param swallow The direction that the object was display at.
10796     * @return The content that was being used
10797     *
10798     * @see elm_hover_content_set()
10799     */
10800    EAPI Evas_Object *elm_hover_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10801    /**
10802     * @brief Unset the content of the hover object, in a given direction.
10803     *
10804     * Unparent and return the content object set at @p swallow direction.
10805     *
10806     * @param obj The hover object
10807     * @param swallow The direction that the object was display at.
10808     * @return The content that was being used.
10809     *
10810     * @see elm_hover_content_set()
10811     */
10812    EAPI Evas_Object *elm_hover_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10813    /**
10814     * @brief Returns the best swallow location for content in the hover.
10815     *
10816     * @param obj The hover object
10817     * @param pref_axis The preferred orientation axis for the hover object to use
10818     * @return The edje location to place content into the hover or @c
10819     *         NULL, on errors.
10820     *
10821     * Best is defined here as the location at which there is the most available
10822     * space.
10823     *
10824     * @p pref_axis may be one of
10825     * - @c ELM_HOVER_AXIS_NONE -- no prefered orientation
10826     * - @c ELM_HOVER_AXIS_HORIZONTAL -- horizontal
10827     * - @c ELM_HOVER_AXIS_VERTICAL -- vertical
10828     * - @c ELM_HOVER_AXIS_BOTH -- both
10829     *
10830     * If ELM_HOVER_AXIS_HORIZONTAL is choosen the returned position will
10831     * nescessarily be along the horizontal axis("left" or "right"). If
10832     * ELM_HOVER_AXIS_VERTICAL is choosen the returned position will nescessarily
10833     * be along the vertical axis("top" or "bottom"). Chossing
10834     * ELM_HOVER_AXIS_BOTH or ELM_HOVER_AXIS_NONE has the same effect and the
10835     * returned position may be in either axis.
10836     *
10837     * @see elm_hover_content_set()
10838     */
10839    EAPI const char  *elm_hover_best_content_location_get(const Evas_Object *obj, Elm_Hover_Axis pref_axis) EINA_ARG_NONNULL(1);
10840    /**
10841     * @}
10842     */
10843
10844    /* entry */
10845    /**
10846     * @defgroup Entry Entry
10847     *
10848     * @image html img/widget/entry/preview-00.png
10849     * @image latex img/widget/entry/preview-00.eps width=\textwidth
10850     * @image html img/widget/entry/preview-01.png
10851     * @image latex img/widget/entry/preview-01.eps width=\textwidth
10852     * @image html img/widget/entry/preview-02.png
10853     * @image latex img/widget/entry/preview-02.eps width=\textwidth
10854     * @image html img/widget/entry/preview-03.png
10855     * @image latex img/widget/entry/preview-03.eps width=\textwidth
10856     *
10857     * An entry is a convenience widget which shows a box that the user can
10858     * enter text into. Entries by default don't scroll, so they grow to
10859     * accomodate the entire text, resizing the parent window as needed. This
10860     * can be changed with the elm_entry_scrollable_set() function.
10861     *
10862     * They can also be single line or multi line (the default) and when set
10863     * to multi line mode they support text wrapping in any of the modes
10864     * indicated by #Elm_Wrap_Type.
10865     *
10866     * Other features include password mode, filtering of inserted text with
10867     * elm_entry_text_filter_append() and related functions, inline "items" and
10868     * formatted markup text.
10869     *
10870     * @section entry-markup Formatted text
10871     *
10872     * The markup tags supported by the Entry are defined by the theme, but
10873     * even when writing new themes or extensions it's a good idea to stick to
10874     * a sane default, to maintain coherency and avoid application breakages.
10875     * Currently defined by the default theme are the following tags:
10876     * @li \<br\>: Inserts a line break.
10877     * @li \<ps\>: Inserts a paragraph separator. This is preferred over line
10878     * breaks.
10879     * @li \<tab\>: Inserts a tab.
10880     * @li \<em\>...\</em\>: Emphasis. Sets the @em oblique style for the
10881     * enclosed text.
10882     * @li \<b\>...\</b\>: Sets the @b bold style for the enclosed text.
10883     * @li \<link\>...\</link\>: Underlines the enclosed text.
10884     * @li \<hilight\>...\</hilight\>: Hilights the enclosed text.
10885     *
10886     * @section entry-special Special markups
10887     *
10888     * Besides those used to format text, entries support two special markup
10889     * tags used to insert clickable portions of text or items inlined within
10890     * the text.
10891     *
10892     * @subsection entry-anchors Anchors
10893     *
10894     * Anchors are similar to HTML anchors. Text can be surrounded by \<a\> and
10895     * \</a\> tags and an event will be generated when this text is clicked,
10896     * like this:
10897     *
10898     * @code
10899     * This text is outside <a href=anc-01>but this one is an anchor</a>
10900     * @endcode
10901     *
10902     * The @c href attribute in the opening tag gives the name that will be
10903     * used to identify the anchor and it can be any valid utf8 string.
10904     *
10905     * When an anchor is clicked, an @c "anchor,clicked" signal is emitted with
10906     * an #Elm_Entry_Anchor_Info in the @c event_info parameter for the
10907     * callback function. The same applies for "anchor,in" (mouse in), "anchor,out"
10908     * (mouse out), "anchor,down" (mouse down), and "anchor,up" (mouse up) events on
10909     * an anchor.
10910     *
10911     * @subsection entry-items Items
10912     *
10913     * Inlined in the text, any other @c Evas_Object can be inserted by using
10914     * \<item\> tags this way:
10915     *
10916     * @code
10917     * <item size=16x16 vsize=full href=emoticon/haha></item>
10918     * @endcode
10919     *
10920     * Just like with anchors, the @c href identifies each item, but these need,
10921     * in addition, to indicate their size, which is done using any one of
10922     * @c size, @c absize or @c relsize attributes. These attributes take their
10923     * value in the WxH format, where W is the width and H the height of the
10924     * item.
10925     *
10926     * @li absize: Absolute pixel size for the item. Whatever value is set will
10927     * be the item's size regardless of any scale value the object may have
10928     * been set to. The final line height will be adjusted to fit larger items.
10929     * @li size: Similar to @c absize, but it's adjusted to the scale value set
10930     * for the object.
10931     * @li relsize: Size is adjusted for the item to fit within the current
10932     * line height.
10933     *
10934     * Besides their size, items are specificed a @c vsize value that affects
10935     * how their final size and position are calculated. The possible values
10936     * are:
10937     * @li ascent: Item will be placed within the line's baseline and its
10938     * ascent. That is, the height between the line where all characters are
10939     * positioned and the highest point in the line. For @c size and @c absize
10940     * items, the descent value will be added to the total line height to make
10941     * them fit. @c relsize items will be adjusted to fit within this space.
10942     * @li full: Items will be placed between the descent and ascent, or the
10943     * lowest point in the line and its highest.
10944     *
10945     * The next image shows different configurations of items and how they
10946     * are the previously mentioned options affect their sizes. In all cases,
10947     * the green line indicates the ascent, blue for the baseline and red for
10948     * the descent.
10949     *
10950     * @image html entry_item.png
10951     * @image latex entry_item.eps width=\textwidth
10952     *
10953     * And another one to show how size differs from absize. In the first one,
10954     * the scale value is set to 1.0, while the second one is using one of 2.0.
10955     *
10956     * @image html entry_item_scale.png
10957     * @image latex entry_item_scale.eps width=\textwidth
10958     *
10959     * After the size for an item is calculated, the entry will request an
10960     * object to place in its space. For this, the functions set with
10961     * elm_entry_item_provider_append() and related functions will be called
10962     * in order until one of them returns a @c non-NULL value. If no providers
10963     * are available, or all of them return @c NULL, then the entry falls back
10964     * to one of the internal defaults, provided the name matches with one of
10965     * them.
10966     *
10967     * All of the following are currently supported:
10968     *
10969     * - emoticon/angry
10970     * - emoticon/angry-shout
10971     * - emoticon/crazy-laugh
10972     * - emoticon/evil-laugh
10973     * - emoticon/evil
10974     * - emoticon/goggle-smile
10975     * - emoticon/grumpy
10976     * - emoticon/grumpy-smile
10977     * - emoticon/guilty
10978     * - emoticon/guilty-smile
10979     * - emoticon/haha
10980     * - emoticon/half-smile
10981     * - emoticon/happy-panting
10982     * - emoticon/happy
10983     * - emoticon/indifferent
10984     * - emoticon/kiss
10985     * - emoticon/knowing-grin
10986     * - emoticon/laugh
10987     * - emoticon/little-bit-sorry
10988     * - emoticon/love-lots
10989     * - emoticon/love
10990     * - emoticon/minimal-smile
10991     * - emoticon/not-happy
10992     * - emoticon/not-impressed
10993     * - emoticon/omg
10994     * - emoticon/opensmile
10995     * - emoticon/smile
10996     * - emoticon/sorry
10997     * - emoticon/squint-laugh
10998     * - emoticon/surprised
10999     * - emoticon/suspicious
11000     * - emoticon/tongue-dangling
11001     * - emoticon/tongue-poke
11002     * - emoticon/uh
11003     * - emoticon/unhappy
11004     * - emoticon/very-sorry
11005     * - emoticon/what
11006     * - emoticon/wink
11007     * - emoticon/worried
11008     * - emoticon/wtf
11009     *
11010     * Alternatively, an item may reference an image by its path, using
11011     * the URI form @c file:///path/to/an/image.png and the entry will then
11012     * use that image for the item.
11013     *
11014     * @section entry-files Loading and saving files
11015     *
11016     * Entries have convinience functions to load text from a file and save
11017     * changes back to it after a short delay. The automatic saving is enabled
11018     * by default, but can be disabled with elm_entry_autosave_set() and files
11019     * can be loaded directly as plain text or have any markup in them
11020     * recognized. See elm_entry_file_set() for more details.
11021     *
11022     * @section entry-signals Emitted signals
11023     *
11024     * This widget emits the following signals:
11025     *
11026     * @li "changed": The text within the entry was changed.
11027     * @li "changed,user": The text within the entry was changed because of user interaction.
11028     * @li "activated": The enter key was pressed on a single line entry.
11029     * @li "press": A mouse button has been pressed on the entry.
11030     * @li "longpressed": A mouse button has been pressed and held for a couple
11031     * seconds.
11032     * @li "clicked": The entry has been clicked (mouse press and release).
11033     * @li "clicked,double": The entry has been double clicked.
11034     * @li "clicked,triple": The entry has been triple clicked.
11035     * @li "focused": The entry has received focus.
11036     * @li "unfocused": The entry has lost focus.
11037     * @li "selection,paste": A paste of the clipboard contents was requested.
11038     * @li "selection,copy": A copy of the selected text into the clipboard was
11039     * requested.
11040     * @li "selection,cut": A cut of the selected text into the clipboard was
11041     * requested.
11042     * @li "selection,start": A selection has begun and no previous selection
11043     * existed.
11044     * @li "selection,changed": The current selection has changed.
11045     * @li "selection,cleared": The current selection has been cleared.
11046     * @li "cursor,changed": The cursor has changed position.
11047     * @li "anchor,clicked": An anchor has been clicked. The event_info
11048     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11049     * @li "anchor,in": Mouse cursor has moved into an anchor. The event_info
11050     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11051     * @li "anchor,out": Mouse cursor has moved out of an anchor. The event_info
11052     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11053     * @li "anchor,up": Mouse button has been unpressed on an anchor. The event_info
11054     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11055     * @li "anchor,down": Mouse button has been pressed on an anchor. The event_info
11056     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11057     * @li "preedit,changed": The preedit string has changed.
11058     * @li "language,changed": Program language changed.
11059     *
11060     * @section entry-examples
11061     *
11062     * An overview of the Entry API can be seen in @ref entry_example_01
11063     *
11064     * @{
11065     */
11066    /**
11067     * @typedef Elm_Entry_Anchor_Info
11068     *
11069     * The info sent in the callback for the "anchor,clicked" signals emitted
11070     * by entries.
11071     */
11072    typedef struct _Elm_Entry_Anchor_Info Elm_Entry_Anchor_Info;
11073    /**
11074     * @struct _Elm_Entry_Anchor_Info
11075     *
11076     * The info sent in the callback for the "anchor,clicked" signals emitted
11077     * by entries.
11078     */
11079    struct _Elm_Entry_Anchor_Info
11080      {
11081         const char *name; /**< The name of the anchor, as stated in its href */
11082         int         button; /**< The mouse button used to click on it */
11083         Evas_Coord  x, /**< Anchor geometry, relative to canvas */
11084                     y, /**< Anchor geometry, relative to canvas */
11085                     w, /**< Anchor geometry, relative to canvas */
11086                     h; /**< Anchor geometry, relative to canvas */
11087      };
11088    /**
11089     * @typedef Elm_Entry_Filter_Cb
11090     * This callback type is used by entry filters to modify text.
11091     * @param data The data specified as the last param when adding the filter
11092     * @param entry The entry object
11093     * @param text A pointer to the location of the text being filtered. This data can be modified,
11094     * but any additional allocations must be managed by the user.
11095     * @see elm_entry_text_filter_append
11096     * @see elm_entry_text_filter_prepend
11097     */
11098    typedef void (*Elm_Entry_Filter_Cb)(void *data, Evas_Object *entry, char **text);
11099
11100    /**
11101     * This adds an entry to @p parent object.
11102     *
11103     * By default, entries are:
11104     * @li not scrolled
11105     * @li multi-line
11106     * @li word wrapped
11107     * @li autosave is enabled
11108     *
11109     * @param parent The parent object
11110     * @return The new object or NULL if it cannot be created
11111     */
11112    EAPI Evas_Object *elm_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11113    /**
11114     * Sets the entry to single line mode.
11115     *
11116     * In single line mode, entries don't ever wrap when the text reaches the
11117     * edge, and instead they keep growing horizontally. Pressing the @c Enter
11118     * key will generate an @c "activate" event instead of adding a new line.
11119     *
11120     * When @p single_line is @c EINA_FALSE, line wrapping takes effect again
11121     * and pressing enter will break the text into a different line
11122     * without generating any events.
11123     *
11124     * @param obj The entry object
11125     * @param single_line If true, the text in the entry
11126     * will be on a single line.
11127     */
11128    EAPI void         elm_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
11129    /**
11130     * Gets whether the entry is set to be single line.
11131     *
11132     * @param obj The entry object
11133     * @return single_line If true, the text in the entry is set to display
11134     * on a single line.
11135     *
11136     * @see elm_entry_single_line_set()
11137     */
11138    EAPI Eina_Bool    elm_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11139    /**
11140     * Sets the entry to password mode.
11141     *
11142     * In password mode, entries are implicitly single line and the display of
11143     * any text in them is replaced with asterisks (*).
11144     *
11145     * @param obj The entry object
11146     * @param password If true, password mode is enabled.
11147     */
11148    EAPI void         elm_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
11149    /**
11150     * Gets whether the entry is set to password mode.
11151     *
11152     * @param obj The entry object
11153     * @return If true, the entry is set to display all characters
11154     * as asterisks (*).
11155     *
11156     * @see elm_entry_password_set()
11157     */
11158    EAPI Eina_Bool    elm_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11159    /**
11160     * This sets the text displayed within the entry to @p entry.
11161     *
11162     * @param obj The entry object
11163     * @param entry The text to be displayed
11164     *
11165     * @deprecated Use elm_object_text_set() instead.
11166     * @note Using this function bypasses text filters
11167     */
11168    EAPI void         elm_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
11169    /**
11170     * This returns the text currently shown in object @p entry.
11171     * See also elm_entry_entry_set().
11172     *
11173     * @param obj The entry object
11174     * @return The currently displayed text or NULL on failure
11175     *
11176     * @deprecated Use elm_object_text_get() instead.
11177     */
11178    EAPI const char  *elm_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11179    /**
11180     * Appends @p entry to the text of the entry.
11181     *
11182     * Adds the text in @p entry to the end of any text already present in the
11183     * widget.
11184     *
11185     * The appended text is subject to any filters set for the widget.
11186     *
11187     * @param obj The entry object
11188     * @param entry The text to be displayed
11189     *
11190     * @see elm_entry_text_filter_append()
11191     */
11192    EAPI void         elm_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
11193    /**
11194     * Gets whether the entry is empty.
11195     *
11196     * Empty means no text at all. If there are any markup tags, like an item
11197     * tag for which no provider finds anything, and no text is displayed, this
11198     * function still returns EINA_FALSE.
11199     *
11200     * @param obj The entry object
11201     * @return EINA_TRUE if the entry is empty, EINA_FALSE otherwise.
11202     */
11203    EAPI Eina_Bool    elm_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11204    /**
11205     * Gets any selected text within the entry.
11206     *
11207     * If there's any selected text in the entry, this function returns it as
11208     * a string in markup format. NULL is returned if no selection exists or
11209     * if an error occurred.
11210     *
11211     * The returned value points to an internal string and should not be freed
11212     * or modified in any way. If the @p entry object is deleted or its
11213     * contents are changed, the returned pointer should be considered invalid.
11214     *
11215     * @param obj The entry object
11216     * @return The selected text within the entry or NULL on failure
11217     */
11218    EAPI const char  *elm_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11219    /**
11220     * Inserts the given text into the entry at the current cursor position.
11221     *
11222     * This inserts text at the cursor position as if it was typed
11223     * by the user (note that this also allows markup which a user
11224     * can't just "type" as it would be converted to escaped text, so this
11225     * call can be used to insert things like emoticon items or bold push/pop
11226     * tags, other font and color change tags etc.)
11227     *
11228     * If any selection exists, it will be replaced by the inserted text.
11229     *
11230     * The inserted text is subject to any filters set for the widget.
11231     *
11232     * @param obj The entry object
11233     * @param entry The text to insert
11234     *
11235     * @see elm_entry_text_filter_append()
11236     */
11237    EAPI void         elm_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
11238    /**
11239     * Set the line wrap type to use on multi-line entries.
11240     *
11241     * Sets the wrap type used by the entry to any of the specified in
11242     * #Elm_Wrap_Type. This tells how the text will be implicitly cut into a new
11243     * line (without inserting a line break or paragraph separator) when it
11244     * reaches the far edge of the widget.
11245     *
11246     * Note that this only makes sense for multi-line entries. A widget set
11247     * to be single line will never wrap.
11248     *
11249     * @param obj The entry object
11250     * @param wrap The wrap mode to use. See #Elm_Wrap_Type for details on them
11251     */
11252    EAPI void         elm_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
11253    /**
11254     * Gets the wrap mode the entry was set to use.
11255     *
11256     * @param obj The entry object
11257     * @return Wrap type
11258     *
11259     * @see also elm_entry_line_wrap_set()
11260     */
11261    EAPI Elm_Wrap_Type elm_entry_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11262    /**
11263     * Sets if the entry is to be editable or not.
11264     *
11265     * By default, entries are editable and when focused, any text input by the
11266     * user will be inserted at the current cursor position. But calling this
11267     * function with @p editable as EINA_FALSE will prevent the user from
11268     * inputting text into the entry.
11269     *
11270     * The only way to change the text of a non-editable entry is to use
11271     * elm_object_text_set(), elm_entry_entry_insert() and other related
11272     * functions.
11273     *
11274     * @param obj The entry object
11275     * @param editable If EINA_TRUE, user input will be inserted in the entry,
11276     * if not, the entry is read-only and no user input is allowed.
11277     */
11278    EAPI void         elm_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
11279    /**
11280     * Gets whether the entry is editable or not.
11281     *
11282     * @param obj The entry object
11283     * @return If true, the entry is editable by the user.
11284     * If false, it is not editable by the user
11285     *
11286     * @see elm_entry_editable_set()
11287     */
11288    EAPI Eina_Bool    elm_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11289    /**
11290     * This drops any existing text selection within the entry.
11291     *
11292     * @param obj The entry object
11293     */
11294    EAPI void         elm_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
11295    /**
11296     * This selects all text within the entry.
11297     *
11298     * @param obj The entry object
11299     */
11300    EAPI void         elm_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
11301    /**
11302     * This moves the cursor one place to the right within the entry.
11303     *
11304     * @param obj The entry object
11305     * @return EINA_TRUE upon success, EINA_FALSE upon failure
11306     */
11307    EAPI Eina_Bool    elm_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
11308    /**
11309     * This moves the cursor one place to the left within the entry.
11310     *
11311     * @param obj The entry object
11312     * @return EINA_TRUE upon success, EINA_FALSE upon failure
11313     */
11314    EAPI Eina_Bool    elm_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
11315    /**
11316     * This moves the cursor one line up within the entry.
11317     *
11318     * @param obj The entry object
11319     * @return EINA_TRUE upon success, EINA_FALSE upon failure
11320     */
11321    EAPI Eina_Bool    elm_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
11322    /**
11323     * This moves the cursor one line down within the entry.
11324     *
11325     * @param obj The entry object
11326     * @return EINA_TRUE upon success, EINA_FALSE upon failure
11327     */
11328    EAPI Eina_Bool    elm_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
11329    /**
11330     * This moves the cursor to the beginning of the entry.
11331     *
11332     * @param obj The entry object
11333     */
11334    EAPI void         elm_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11335    /**
11336     * This moves the cursor to the end of the entry.
11337     *
11338     * @param obj The entry object
11339     */
11340    EAPI void         elm_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11341    /**
11342     * This moves the cursor to the beginning of the current line.
11343     *
11344     * @param obj The entry object
11345     */
11346    EAPI void         elm_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11347    /**
11348     * This moves the cursor to the end of the current line.
11349     *
11350     * @param obj The entry object
11351     */
11352    EAPI void         elm_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11353    /**
11354     * This begins a selection within the entry as though
11355     * the user were holding down the mouse button to make a selection.
11356     *
11357     * @param obj The entry object
11358     */
11359    EAPI void         elm_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
11360    /**
11361     * This ends a selection within the entry as though
11362     * the user had just released the mouse button while making a selection.
11363     *
11364     * @param obj The entry object
11365     */
11366    EAPI void         elm_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
11367    /**
11368     * Gets whether a format node exists at the current cursor position.
11369     *
11370     * A format node is anything that defines how the text is rendered. It can
11371     * be a visible format node, such as a line break or a paragraph separator,
11372     * or an invisible one, such as bold begin or end tag.
11373     * This function returns whether any format node exists at the current
11374     * cursor position.
11375     *
11376     * @param obj The entry object
11377     * @return EINA_TRUE if the current cursor position contains a format node,
11378     * EINA_FALSE otherwise.
11379     *
11380     * @see elm_entry_cursor_is_visible_format_get()
11381     */
11382    EAPI Eina_Bool    elm_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11383    /**
11384     * Gets if the current cursor position holds a visible format node.
11385     *
11386     * @param obj The entry object
11387     * @return EINA_TRUE if the current cursor is a visible format, EINA_FALSE
11388     * if it's an invisible one or no format exists.
11389     *
11390     * @see elm_entry_cursor_is_format_get()
11391     */
11392    EAPI Eina_Bool    elm_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11393    /**
11394     * Gets the character pointed by the cursor at its current position.
11395     *
11396     * This function returns a string with the utf8 character stored at the
11397     * current cursor position.
11398     * Only the text is returned, any format that may exist will not be part
11399     * of the return value.
11400     *
11401     * @param obj The entry object
11402     * @return The text pointed by the cursors.
11403     */
11404    EAPI const char  *elm_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11405    /**
11406     * This function returns the geometry of the cursor.
11407     *
11408     * It's useful if you want to draw something on the cursor (or where it is),
11409     * or for example in the case of scrolled entry where you want to show the
11410     * cursor.
11411     *
11412     * @param obj The entry object
11413     * @param x returned geometry
11414     * @param y returned geometry
11415     * @param w returned geometry
11416     * @param h returned geometry
11417     * @return EINA_TRUE upon success, EINA_FALSE upon failure
11418     */
11419    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);
11420    /**
11421     * Sets the cursor position in the entry to the given value
11422     *
11423     * The value in @p pos is the index of the character position within the
11424     * contents of the string as returned by elm_entry_cursor_pos_get().
11425     *
11426     * @param obj The entry object
11427     * @param pos The position of the cursor
11428     */
11429    EAPI void         elm_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
11430    /**
11431     * Retrieves the current position of the cursor in the entry
11432     *
11433     * @param obj The entry object
11434     * @return The cursor position
11435     */
11436    EAPI int          elm_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11437    /**
11438     * This executes a "cut" action on the selected text in the entry.
11439     *
11440     * @param obj The entry object
11441     */
11442    EAPI void         elm_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
11443    /**
11444     * This executes a "copy" action on the selected text in the entry.
11445     *
11446     * @param obj The entry object
11447     */
11448    EAPI void         elm_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
11449    /**
11450     * This executes a "paste" action in the entry.
11451     *
11452     * @param obj The entry object
11453     */
11454    EAPI void         elm_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
11455    /**
11456     * This clears and frees the items in a entry's contextual (longpress)
11457     * menu.
11458     *
11459     * @param obj The entry object
11460     *
11461     * @see elm_entry_context_menu_item_add()
11462     */
11463    EAPI void         elm_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
11464    /**
11465     * This adds an item to the entry's contextual menu.
11466     *
11467     * A longpress on an entry will make the contextual menu show up, if this
11468     * hasn't been disabled with elm_entry_context_menu_disabled_set().
11469     * By default, this menu provides a few options like enabling selection mode,
11470     * which is useful on embedded devices that need to be explicit about it,
11471     * and when a selection exists it also shows the copy and cut actions.
11472     *
11473     * With this function, developers can add other options to this menu to
11474     * perform any action they deem necessary.
11475     *
11476     * @param obj The entry object
11477     * @param label The item's text label
11478     * @param icon_file The item's icon file
11479     * @param icon_type The item's icon type
11480     * @param func The callback to execute when the item is clicked
11481     * @param data The data to associate with the item for related functions
11482     */
11483    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);
11484    /**
11485     * This disables the entry's contextual (longpress) menu.
11486     *
11487     * @param obj The entry object
11488     * @param disabled If true, the menu is disabled
11489     */
11490    EAPI void         elm_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
11491    /**
11492     * This returns whether the entry's contextual (longpress) menu is
11493     * disabled.
11494     *
11495     * @param obj The entry object
11496     * @return If true, the menu is disabled
11497     */
11498    EAPI Eina_Bool    elm_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11499    /**
11500     * This appends a custom item provider to the list for that entry
11501     *
11502     * This appends the given callback. The list is walked from beginning to end
11503     * with each function called given the item href string in the text. If the
11504     * function returns an object handle other than NULL (it should create an
11505     * object to do this), then this object is used to replace that item. If
11506     * not the next provider is called until one provides an item object, or the
11507     * default provider in entry does.
11508     *
11509     * @param obj The entry object
11510     * @param func The function called to provide the item object
11511     * @param data The data passed to @p func
11512     *
11513     * @see @ref entry-items
11514     */
11515    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);
11516    /**
11517     * This prepends a custom item provider to the list for that entry
11518     *
11519     * This prepends the given callback. See elm_entry_item_provider_append() for
11520     * more information
11521     *
11522     * @param obj The entry object
11523     * @param func The function called to provide the item object
11524     * @param data The data passed to @p func
11525     */
11526    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);
11527    /**
11528     * This removes a custom item provider to the list for that entry
11529     *
11530     * This removes the given callback. See elm_entry_item_provider_append() for
11531     * more information
11532     *
11533     * @param obj The entry object
11534     * @param func The function called to provide the item object
11535     * @param data The data passed to @p func
11536     */
11537    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);
11538    /**
11539     * Append a filter function for text inserted in the entry
11540     *
11541     * Append the given callback to the list. This functions will be called
11542     * whenever any text is inserted into the entry, with the text to be inserted
11543     * as a parameter. The callback function is free to alter the text in any way
11544     * it wants, but it must remember to free the given pointer and update it.
11545     * If the new text is to be discarded, the function can free it and set its
11546     * text parameter to NULL. This will also prevent any following filters from
11547     * being called.
11548     *
11549     * @param obj The entry object
11550     * @param func The function to use as text filter
11551     * @param data User data to pass to @p func
11552     */
11553    EAPI void         elm_entry_text_filter_append(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11554    /**
11555     * Prepend a filter function for text insdrted in the entry
11556     *
11557     * Prepend the given callback to the list. See elm_entry_text_filter_append()
11558     * for more information
11559     *
11560     * @param obj The entry object
11561     * @param func The function to use as text filter
11562     * @param data User data to pass to @p func
11563     */
11564    EAPI void         elm_entry_text_filter_prepend(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11565    /**
11566     * Remove a filter from the list
11567     *
11568     * Removes the given callback from the filter list. See
11569     * elm_entry_text_filter_append() for more information.
11570     *
11571     * @param obj The entry object
11572     * @param func The filter function to remove
11573     * @param data The user data passed when adding the function
11574     */
11575    EAPI void         elm_entry_text_filter_remove(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11576    /**
11577     * This converts a markup (HTML-like) string into UTF-8.
11578     *
11579     * The returned string is a malloc'ed buffer and it should be freed when
11580     * not needed anymore.
11581     *
11582     * @param s The string (in markup) to be converted
11583     * @return The converted string (in UTF-8). It should be freed.
11584     */
11585    EAPI char        *elm_entry_markup_to_utf8(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
11586    /**
11587     * This converts a UTF-8 string into markup (HTML-like).
11588     *
11589     * The returned string is a malloc'ed buffer and it should be freed when
11590     * not needed anymore.
11591     *
11592     * @param s The string (in UTF-8) to be converted
11593     * @return The converted string (in markup). It should be freed.
11594     */
11595    EAPI char        *elm_entry_utf8_to_markup(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
11596    /**
11597     * This sets the file (and implicitly loads it) for the text to display and
11598     * then edit. All changes are written back to the file after a short delay if
11599     * the entry object is set to autosave (which is the default).
11600     *
11601     * If the entry had any other file set previously, any changes made to it
11602     * will be saved if the autosave feature is enabled, otherwise, the file
11603     * will be silently discarded and any non-saved changes will be lost.
11604     *
11605     * @param obj The entry object
11606     * @param file The path to the file to load and save
11607     * @param format The file format
11608     */
11609    EAPI void         elm_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
11610    /**
11611     * Gets the file being edited by the entry.
11612     *
11613     * This function can be used to retrieve any file set on the entry for
11614     * edition, along with the format used to load and save it.
11615     *
11616     * @param obj The entry object
11617     * @param file The path to the file to load and save
11618     * @param format The file format
11619     */
11620    EAPI void         elm_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
11621    /**
11622     * This function writes any changes made to the file set with
11623     * elm_entry_file_set()
11624     *
11625     * @param obj The entry object
11626     */
11627    EAPI void         elm_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
11628    /**
11629     * This sets the entry object to 'autosave' the loaded text file or not.
11630     *
11631     * @param obj The entry object
11632     * @param autosave Autosave the loaded file or not
11633     *
11634     * @see elm_entry_file_set()
11635     */
11636    EAPI void         elm_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
11637    /**
11638     * This gets the entry object's 'autosave' status.
11639     *
11640     * @param obj The entry object
11641     * @return Autosave the loaded file or not
11642     *
11643     * @see elm_entry_file_set()
11644     */
11645    EAPI Eina_Bool    elm_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11646    /**
11647     * Control pasting of text and images for the widget.
11648     *
11649     * Normally the entry allows both text and images to be pasted.  By setting
11650     * textonly to be true, this prevents images from being pasted.
11651     *
11652     * Note this only changes the behaviour of text.
11653     *
11654     * @param obj The entry object
11655     * @param textonly paste mode - EINA_TRUE is text only, EINA_FALSE is
11656     * text+image+other.
11657     */
11658    EAPI void         elm_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
11659    /**
11660     * Getting elm_entry text paste/drop mode.
11661     *
11662     * In textonly mode, only text may be pasted or dropped into the widget.
11663     *
11664     * @param obj The entry object
11665     * @return If the widget only accepts text from pastes.
11666     */
11667    EAPI Eina_Bool    elm_entry_cnp_textonly_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11668    /**
11669     * Enable or disable scrolling in entry
11670     *
11671     * Normally the entry is not scrollable unless you enable it with this call.
11672     *
11673     * @param obj The entry object
11674     * @param scroll EINA_TRUE if it is to be scrollable, EINA_FALSE otherwise
11675     */
11676    EAPI void         elm_entry_scrollable_set(Evas_Object *obj, Eina_Bool scroll);
11677    /**
11678     * Get the scrollable state of the entry
11679     *
11680     * Normally the entry is not scrollable. This gets the scrollable state
11681     * of the entry. See elm_entry_scrollable_set() for more information.
11682     *
11683     * @param obj The entry object
11684     * @return The scrollable state
11685     */
11686    EAPI Eina_Bool    elm_entry_scrollable_get(const Evas_Object *obj);
11687    /**
11688     * This sets a widget to be displayed to the left of a scrolled entry.
11689     *
11690     * @param obj The scrolled entry object
11691     * @param icon The widget to display on the left side of the scrolled
11692     * entry.
11693     *
11694     * @note A previously set widget will be destroyed.
11695     * @note If the object being set does not have minimum size hints set,
11696     * it won't get properly displayed.
11697     *
11698     * @see elm_entry_end_set()
11699     */
11700    EAPI void         elm_entry_icon_set(Evas_Object *obj, Evas_Object *icon);
11701    /**
11702     * Gets the leftmost widget of the scrolled entry. This object is
11703     * owned by the scrolled entry and should not be modified.
11704     *
11705     * @param obj The scrolled entry object
11706     * @return the left widget inside the scroller
11707     */
11708    EAPI Evas_Object *elm_entry_icon_get(const Evas_Object *obj);
11709    /**
11710     * Unset the leftmost widget of the scrolled entry, unparenting and
11711     * returning it.
11712     *
11713     * @param obj The scrolled entry object
11714     * @return the previously set icon sub-object of this entry, on
11715     * success.
11716     *
11717     * @see elm_entry_icon_set()
11718     */
11719    EAPI Evas_Object *elm_entry_icon_unset(Evas_Object *obj);
11720    /**
11721     * Sets the visibility of the left-side widget of the scrolled entry,
11722     * set by elm_entry_icon_set().
11723     *
11724     * @param obj The scrolled entry object
11725     * @param setting EINA_TRUE if the object should be displayed,
11726     * EINA_FALSE if not.
11727     */
11728    EAPI void         elm_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting);
11729    /**
11730     * This sets a widget to be displayed to the end of a scrolled entry.
11731     *
11732     * @param obj The scrolled entry object
11733     * @param end The widget to display on the right side of the scrolled
11734     * entry.
11735     *
11736     * @note A previously set widget will be destroyed.
11737     * @note If the object being set does not have minimum size hints set,
11738     * it won't get properly displayed.
11739     *
11740     * @see elm_entry_icon_set
11741     */
11742    EAPI void         elm_entry_end_set(Evas_Object *obj, Evas_Object *end);
11743    /**
11744     * Gets the endmost widget of the scrolled entry. This object is owned
11745     * by the scrolled entry and should not be modified.
11746     *
11747     * @param obj The scrolled entry object
11748     * @return the right widget inside the scroller
11749     */
11750    EAPI Evas_Object *elm_entry_end_get(const Evas_Object *obj);
11751    /**
11752     * Unset the endmost widget of the scrolled entry, unparenting and
11753     * returning it.
11754     *
11755     * @param obj The scrolled entry object
11756     * @return the previously set icon sub-object of this entry, on
11757     * success.
11758     *
11759     * @see elm_entry_icon_set()
11760     */
11761    EAPI Evas_Object *elm_entry_end_unset(Evas_Object *obj);
11762    /**
11763     * Sets the visibility of the end widget of the scrolled entry, set by
11764     * elm_entry_end_set().
11765     *
11766     * @param obj The scrolled entry object
11767     * @param setting EINA_TRUE if the object should be displayed,
11768     * EINA_FALSE if not.
11769     */
11770    EAPI void         elm_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting);
11771    /**
11772     * This sets the scrolled entry's scrollbar policy (ie. enabling/disabling
11773     * them).
11774     *
11775     * Setting an entry to single-line mode with elm_entry_single_line_set()
11776     * will automatically disable the display of scrollbars when the entry
11777     * moves inside its scroller.
11778     *
11779     * @param obj The scrolled entry object
11780     * @param h The horizontal scrollbar policy to apply
11781     * @param v The vertical scrollbar policy to apply
11782     */
11783    EAPI void         elm_entry_scrollbar_policy_set(Evas_Object *obj, Elm_Scroller_Policy h, Elm_Scroller_Policy v);
11784    /**
11785     * This enables/disables bouncing within the entry.
11786     *
11787     * This function sets whether the entry will bounce when scrolling reaches
11788     * the end of the contained entry.
11789     *
11790     * @param obj The scrolled entry object
11791     * @param h The horizontal bounce state
11792     * @param v The vertical bounce state
11793     */
11794    EAPI void         elm_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
11795    /**
11796     * Get the bounce mode
11797     *
11798     * @param obj The Entry object
11799     * @param h_bounce Allow bounce horizontally
11800     * @param v_bounce Allow bounce vertically
11801     */
11802    EAPI void         elm_entry_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
11803
11804    /* pre-made filters for entries */
11805    /**
11806     * @typedef Elm_Entry_Filter_Limit_Size
11807     *
11808     * Data for the elm_entry_filter_limit_size() entry filter.
11809     */
11810    typedef struct _Elm_Entry_Filter_Limit_Size Elm_Entry_Filter_Limit_Size;
11811    /**
11812     * @struct _Elm_Entry_Filter_Limit_Size
11813     *
11814     * Data for the elm_entry_filter_limit_size() entry filter.
11815     */
11816    struct _Elm_Entry_Filter_Limit_Size
11817      {
11818         int max_char_count; /**< The maximum number of characters allowed. */
11819         int max_byte_count; /**< The maximum number of bytes allowed*/
11820      };
11821    /**
11822     * Filter inserted text based on user defined character and byte limits
11823     *
11824     * Add this filter to an entry to limit the characters that it will accept
11825     * based the the contents of the provided #Elm_Entry_Filter_Limit_Size.
11826     * The funtion works on the UTF-8 representation of the string, converting
11827     * it from the set markup, thus not accounting for any format in it.
11828     *
11829     * The user must create an #Elm_Entry_Filter_Limit_Size structure and pass
11830     * it as data when setting the filter. In it, it's possible to set limits
11831     * by character count or bytes (any of them is disabled if 0), and both can
11832     * be set at the same time. In that case, it first checks for characters,
11833     * then bytes.
11834     *
11835     * The function will cut the inserted text in order to allow only the first
11836     * number of characters that are still allowed. The cut is made in
11837     * characters, even when limiting by bytes, in order to always contain
11838     * valid ones and avoid half unicode characters making it in.
11839     *
11840     * This filter, like any others, does not apply when setting the entry text
11841     * directly with elm_object_text_set() (or the deprecated
11842     * elm_entry_entry_set()).
11843     */
11844    EAPI void         elm_entry_filter_limit_size(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 2, 3);
11845    /**
11846     * @typedef Elm_Entry_Filter_Accept_Set
11847     *
11848     * Data for the elm_entry_filter_accept_set() entry filter.
11849     */
11850    typedef struct _Elm_Entry_Filter_Accept_Set Elm_Entry_Filter_Accept_Set;
11851    /**
11852     * @struct _Elm_Entry_Filter_Accept_Set
11853     *
11854     * Data for the elm_entry_filter_accept_set() entry filter.
11855     */
11856    struct _Elm_Entry_Filter_Accept_Set
11857      {
11858         const char *accepted; /**< Set of characters accepted in the entry. */
11859         const char *rejected; /**< Set of characters rejected from the entry. */
11860      };
11861    /**
11862     * Filter inserted text based on accepted or rejected sets of characters
11863     *
11864     * Add this filter to an entry to restrict the set of accepted characters
11865     * based on the sets in the provided #Elm_Entry_Filter_Accept_Set.
11866     * This structure contains both accepted and rejected sets, but they are
11867     * mutually exclusive.
11868     *
11869     * The @c accepted set takes preference, so if it is set, the filter will
11870     * only work based on the accepted characters, ignoring anything in the
11871     * @c rejected value. If @c accepted is @c NULL, then @c rejected is used.
11872     *
11873     * In both cases, the function filters by matching utf8 characters to the
11874     * raw markup text, so it can be used to remove formatting tags.
11875     *
11876     * This filter, like any others, does not apply when setting the entry text
11877     * directly with elm_object_text_set() (or the deprecated
11878     * elm_entry_entry_set()).
11879     */
11880    EAPI void         elm_entry_filter_accept_set(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 3);
11881    /**
11882     * Set the input panel layout of the entry
11883     *
11884     * @param obj The entry object
11885     * @param layout layout type
11886     */
11887    EAPI void elm_entry_input_panel_layout_set(Evas_Object *obj, Elm_Input_Panel_Layout layout) EINA_ARG_NONNULL(1);
11888    /**
11889     * Get the input panel layout of the entry
11890     *
11891     * @param obj The entry object
11892     * @return layout type
11893     *
11894     * @see elm_entry_input_panel_layout_set
11895     */
11896    EAPI Elm_Input_Panel_Layout elm_entry_input_panel_layout_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
11897    /**
11898     * Set the autocapitalization type on the immodule.
11899     *
11900     * @param obj The entry object
11901     * @param autocapital_type The type of autocapitalization
11902     */
11903    EAPI void         elm_entry_autocapital_type_set(Evas_Object *obj, Elm_Autocapital_Type autocapital_type) EINA_ARG_NONNULL(1);
11904    /**
11905     * Retrieve the autocapitalization type on the immodule.
11906     *
11907     * @param obj The entry object
11908     * @return autocapitalization type
11909     */
11910    EAPI Elm_Autocapital_Type elm_entry_autocapital_type_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
11911    /**
11912     * Sets the attribute to show the input panel automatically.
11913     *
11914     * @param obj The entry object
11915     * @param enabled If true, the input panel is appeared when entry is clicked or has a focus
11916     */
11917    EAPI void elm_entry_input_panel_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
11918    /**
11919     * Retrieve the attribute to show the input panel automatically.
11920     *
11921     * @param obj The entry object
11922     * @return EINA_TRUE if input panel will be appeared when the entry is clicked or has a focus, EINA_FALSE otherwise
11923     */
11924    EAPI Eina_Bool elm_entry_input_panel_enabled_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
11925
11926    /**
11927     * @}
11928     */
11929
11930    /* composite widgets - these basically put together basic widgets above
11931     * in convenient packages that do more than basic stuff */
11932
11933    /* anchorview */
11934    /**
11935     * @defgroup Anchorview Anchorview
11936     *
11937     * @image html img/widget/anchorview/preview-00.png
11938     * @image latex img/widget/anchorview/preview-00.eps
11939     *
11940     * Anchorview is for displaying text that contains markup with anchors
11941     * like <c>\<a href=1234\>something\</\></c> in it.
11942     *
11943     * Besides being styled differently, the anchorview widget provides the
11944     * necessary functionality so that clicking on these anchors brings up a
11945     * popup with user defined content such as "call", "add to contacts" or
11946     * "open web page". This popup is provided using the @ref Hover widget.
11947     *
11948     * This widget is very similar to @ref Anchorblock, so refer to that
11949     * widget for an example. The only difference Anchorview has is that the
11950     * widget is already provided with scrolling functionality, so if the
11951     * text set to it is too large to fit in the given space, it will scroll,
11952     * whereas the @ref Anchorblock widget will keep growing to ensure all the
11953     * text can be displayed.
11954     *
11955     * This widget emits the following signals:
11956     * @li "anchor,clicked": will be called when an anchor is clicked. The
11957     * @p event_info parameter on the callback will be a pointer of type
11958     * ::Elm_Entry_Anchorview_Info.
11959     *
11960     * See @ref Anchorblock for an example on how to use both of them.
11961     *
11962     * @see Anchorblock
11963     * @see Entry
11964     * @see Hover
11965     *
11966     * @{
11967     */
11968    /**
11969     * @typedef Elm_Entry_Anchorview_Info
11970     *
11971     * The info sent in the callback for "anchor,clicked" signals emitted by
11972     * the Anchorview widget.
11973     */
11974    typedef struct _Elm_Entry_Anchorview_Info Elm_Entry_Anchorview_Info;
11975    /**
11976     * @struct _Elm_Entry_Anchorview_Info
11977     *
11978     * The info sent in the callback for "anchor,clicked" signals emitted by
11979     * the Anchorview widget.
11980     */
11981    struct _Elm_Entry_Anchorview_Info
11982      {
11983         const char     *name; /**< Name of the anchor, as indicated in its href
11984                                    attribute */
11985         int             button; /**< The mouse button used to click on it */
11986         Evas_Object    *hover; /**< The hover object to use for the popup */
11987         struct {
11988              Evas_Coord    x, y, w, h;
11989         } anchor, /**< Geometry selection of text used as anchor */
11990           hover_parent; /**< Geometry of the object used as parent by the
11991                              hover */
11992         Eina_Bool       hover_left : 1; /**< Hint indicating if there's space
11993                                              for content on the left side of
11994                                              the hover. Before calling the
11995                                              callback, the widget will make the
11996                                              necessary calculations to check
11997                                              which sides are fit to be set with
11998                                              content, based on the position the
11999                                              hover is activated and its distance
12000                                              to the edges of its parent object
12001                                              */
12002         Eina_Bool       hover_right : 1; /**< Hint indicating content fits on
12003                                               the right side of the hover.
12004                                               See @ref hover_left */
12005         Eina_Bool       hover_top : 1; /**< Hint indicating content fits on top
12006                                             of the hover. See @ref hover_left */
12007         Eina_Bool       hover_bottom : 1; /**< Hint indicating content fits
12008                                                below the hover. See @ref
12009                                                hover_left */
12010      };
12011    /**
12012     * Add a new Anchorview object
12013     *
12014     * @param parent The parent object
12015     * @return The new object or NULL if it cannot be created
12016     */
12017    EAPI Evas_Object *elm_anchorview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12018    /**
12019     * Set the text to show in the anchorview
12020     *
12021     * Sets the text of the anchorview to @p text. This text can include markup
12022     * format tags, including <c>\<a href=anchorname\></c> to begin a segment of
12023     * text that will be specially styled and react to click events, ended with
12024     * either of \</a\> or \</\>. When clicked, the anchor will emit an
12025     * "anchor,clicked" signal that you can attach a callback to with
12026     * evas_object_smart_callback_add(). The name of the anchor given in the
12027     * event info struct will be the one set in the href attribute, in this
12028     * case, anchorname.
12029     *
12030     * Other markup can be used to style the text in different ways, but it's
12031     * up to the style defined in the theme which tags do what.
12032     * @deprecated use elm_object_text_set() instead.
12033     */
12034    EINA_DEPRECATED EAPI void         elm_anchorview_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
12035    /**
12036     * Get the markup text set for the anchorview
12037     *
12038     * Retrieves the text set on the anchorview, with markup tags included.
12039     *
12040     * @param obj The anchorview object
12041     * @return The markup text set or @c NULL if nothing was set or an error
12042     * occurred
12043     * @deprecated use elm_object_text_set() instead.
12044     */
12045    EINA_DEPRECATED EAPI const char  *elm_anchorview_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12046    /**
12047     * Set the parent of the hover popup
12048     *
12049     * Sets the parent object to use by the hover created by the anchorview
12050     * when an anchor is clicked. See @ref Hover for more details on this.
12051     * If no parent is set, the same anchorview object will be used.
12052     *
12053     * @param obj The anchorview object
12054     * @param parent The object to use as parent for the hover
12055     */
12056    EAPI void         elm_anchorview_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
12057    /**
12058     * Get the parent of the hover popup
12059     *
12060     * Get the object used as parent for the hover created by the anchorview
12061     * widget. See @ref Hover for more details on this.
12062     *
12063     * @param obj The anchorview object
12064     * @return The object used as parent for the hover, NULL if none is set.
12065     */
12066    EAPI Evas_Object *elm_anchorview_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12067    /**
12068     * Set the style that the hover should use
12069     *
12070     * When creating the popup hover, anchorview will request that it's
12071     * themed according to @p style.
12072     *
12073     * @param obj The anchorview object
12074     * @param style The style to use for the underlying hover
12075     *
12076     * @see elm_object_style_set()
12077     */
12078    EAPI void         elm_anchorview_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
12079    /**
12080     * Get the style that the hover should use
12081     *
12082     * Get the style the hover created by anchorview will use.
12083     *
12084     * @param obj The anchorview object
12085     * @return The style to use by the hover. NULL means the default is used.
12086     *
12087     * @see elm_object_style_set()
12088     */
12089    EAPI const char  *elm_anchorview_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12090    /**
12091     * Ends the hover popup in the anchorview
12092     *
12093     * When an anchor is clicked, the anchorview widget will create a hover
12094     * object to use as a popup with user provided content. This function
12095     * terminates this popup, returning the anchorview to its normal state.
12096     *
12097     * @param obj The anchorview object
12098     */
12099    EAPI void         elm_anchorview_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
12100    /**
12101     * Set bouncing behaviour when the scrolled content reaches an edge
12102     *
12103     * Tell the internal scroller object whether it should bounce or not
12104     * when it reaches the respective edges for each axis.
12105     *
12106     * @param obj The anchorview object
12107     * @param h_bounce Whether to bounce or not in the horizontal axis
12108     * @param v_bounce Whether to bounce or not in the vertical axis
12109     *
12110     * @see elm_scroller_bounce_set()
12111     */
12112    EAPI void         elm_anchorview_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
12113    /**
12114     * Get the set bouncing behaviour of the internal scroller
12115     *
12116     * Get whether the internal scroller should bounce when the edge of each
12117     * axis is reached scrolling.
12118     *
12119     * @param obj The anchorview object
12120     * @param h_bounce Pointer where to store the bounce state of the horizontal
12121     *                 axis
12122     * @param v_bounce Pointer where to store the bounce state of the vertical
12123     *                 axis
12124     *
12125     * @see elm_scroller_bounce_get()
12126     */
12127    EAPI void         elm_anchorview_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
12128    /**
12129     * Appends a custom item provider to the given anchorview
12130     *
12131     * Appends the given function to the list of items providers. This list is
12132     * called, one function at a time, with the given @p data pointer, the
12133     * anchorview object and, in the @p item parameter, the item name as
12134     * referenced in its href string. Following functions in the list will be
12135     * called in order until one of them returns something different to NULL,
12136     * which should be an Evas_Object which will be used in place of the item
12137     * element.
12138     *
12139     * Items in the markup text take the form \<item relsize=16x16 vsize=full
12140     * href=item/name\>\</item\>
12141     *
12142     * @param obj The anchorview object
12143     * @param func The function to add to the list of providers
12144     * @param data User data that will be passed to the callback function
12145     *
12146     * @see elm_entry_item_provider_append()
12147     */
12148    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);
12149    /**
12150     * Prepend a custom item provider to the given anchorview
12151     *
12152     * Like elm_anchorview_item_provider_append(), but it adds the function
12153     * @p func to the beginning of the list, instead of the end.
12154     *
12155     * @param obj The anchorview object
12156     * @param func The function to add to the list of providers
12157     * @param data User data that will be passed to the callback function
12158     */
12159    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);
12160    /**
12161     * Remove a custom item provider from the list of the given anchorview
12162     *
12163     * Removes the function and data pairing that matches @p func and @p data.
12164     * That is, unless the same function and same user data are given, the
12165     * function will not be removed from the list. This allows us to add the
12166     * same callback several times, with different @p data pointers and be
12167     * able to remove them later without conflicts.
12168     *
12169     * @param obj The anchorview object
12170     * @param func The function to remove from the list
12171     * @param data The data matching the function to remove from the list
12172     */
12173    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);
12174    /**
12175     * @}
12176     */
12177
12178    /* anchorblock */
12179    /**
12180     * @defgroup Anchorblock Anchorblock
12181     *
12182     * @image html img/widget/anchorblock/preview-00.png
12183     * @image latex img/widget/anchorblock/preview-00.eps
12184     *
12185     * Anchorblock is for displaying text that contains markup with anchors
12186     * like <c>\<a href=1234\>something\</\></c> in it.
12187     *
12188     * Besides being styled differently, the anchorblock widget provides the
12189     * necessary functionality so that clicking on these anchors brings up a
12190     * popup with user defined content such as "call", "add to contacts" or
12191     * "open web page". This popup is provided using the @ref Hover widget.
12192     *
12193     * This widget emits the following signals:
12194     * @li "anchor,clicked": will be called when an anchor is clicked. The
12195     * @p event_info parameter on the callback will be a pointer of type
12196     * ::Elm_Entry_Anchorblock_Info.
12197     *
12198     * @see Anchorview
12199     * @see Entry
12200     * @see Hover
12201     *
12202     * Since examples are usually better than plain words, we might as well
12203     * try @ref tutorial_anchorblock_example "one".
12204     */
12205    /**
12206     * @addtogroup Anchorblock
12207     * @{
12208     */
12209    /**
12210     * @typedef Elm_Entry_Anchorblock_Info
12211     *
12212     * The info sent in the callback for "anchor,clicked" signals emitted by
12213     * the Anchorblock widget.
12214     */
12215    typedef struct _Elm_Entry_Anchorblock_Info Elm_Entry_Anchorblock_Info;
12216    /**
12217     * @struct _Elm_Entry_Anchorblock_Info
12218     *
12219     * The info sent in the callback for "anchor,clicked" signals emitted by
12220     * the Anchorblock widget.
12221     */
12222    struct _Elm_Entry_Anchorblock_Info
12223      {
12224         const char     *name; /**< Name of the anchor, as indicated in its href
12225                                    attribute */
12226         int             button; /**< The mouse button used to click on it */
12227         Evas_Object    *hover; /**< The hover object to use for the popup */
12228         struct {
12229              Evas_Coord    x, y, w, h;
12230         } anchor, /**< Geometry selection of text used as anchor */
12231           hover_parent; /**< Geometry of the object used as parent by the
12232                              hover */
12233         Eina_Bool       hover_left : 1; /**< Hint indicating if there's space
12234                                              for content on the left side of
12235                                              the hover. Before calling the
12236                                              callback, the widget will make the
12237                                              necessary calculations to check
12238                                              which sides are fit to be set with
12239                                              content, based on the position the
12240                                              hover is activated and its distance
12241                                              to the edges of its parent object
12242                                              */
12243         Eina_Bool       hover_right : 1; /**< Hint indicating content fits on
12244                                               the right side of the hover.
12245                                               See @ref hover_left */
12246         Eina_Bool       hover_top : 1; /**< Hint indicating content fits on top
12247                                             of the hover. See @ref hover_left */
12248         Eina_Bool       hover_bottom : 1; /**< Hint indicating content fits
12249                                                below the hover. See @ref
12250                                                hover_left */
12251      };
12252    /**
12253     * Add a new Anchorblock object
12254     *
12255     * @param parent The parent object
12256     * @return The new object or NULL if it cannot be created
12257     */
12258    EAPI Evas_Object *elm_anchorblock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12259    /**
12260     * Set the text to show in the anchorblock
12261     *
12262     * Sets the text of the anchorblock to @p text. This text can include markup
12263     * format tags, including <c>\<a href=anchorname\></a></c> to begin a segment
12264     * of text that will be specially styled and react to click events, ended
12265     * with either of \</a\> or \</\>. When clicked, the anchor will emit an
12266     * "anchor,clicked" signal that you can attach a callback to with
12267     * evas_object_smart_callback_add(). The name of the anchor given in the
12268     * event info struct will be the one set in the href attribute, in this
12269     * case, anchorname.
12270     *
12271     * Other markup can be used to style the text in different ways, but it's
12272     * up to the style defined in the theme which tags do what.
12273     * @deprecated use elm_object_text_set() instead.
12274     */
12275    EINA_DEPRECATED EAPI void         elm_anchorblock_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
12276    /**
12277     * Get the markup text set for the anchorblock
12278     *
12279     * Retrieves the text set on the anchorblock, with markup tags included.
12280     *
12281     * @param obj The anchorblock object
12282     * @return The markup text set or @c NULL if nothing was set or an error
12283     * occurred
12284     * @deprecated use elm_object_text_set() instead.
12285     */
12286    EINA_DEPRECATED EAPI const char  *elm_anchorblock_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12287    /**
12288     * Set the parent of the hover popup
12289     *
12290     * Sets the parent object to use by the hover created by the anchorblock
12291     * when an anchor is clicked. See @ref Hover for more details on this.
12292     *
12293     * @param obj The anchorblock object
12294     * @param parent The object to use as parent for the hover
12295     */
12296    EAPI void         elm_anchorblock_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
12297    /**
12298     * Get the parent of the hover popup
12299     *
12300     * Get the object used as parent for the hover created by the anchorblock
12301     * widget. See @ref Hover for more details on this.
12302     * If no parent is set, the same anchorblock object will be used.
12303     *
12304     * @param obj The anchorblock object
12305     * @return The object used as parent for the hover, NULL if none is set.
12306     */
12307    EAPI Evas_Object *elm_anchorblock_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12308    /**
12309     * Set the style that the hover should use
12310     *
12311     * When creating the popup hover, anchorblock will request that it's
12312     * themed according to @p style.
12313     *
12314     * @param obj The anchorblock object
12315     * @param style The style to use for the underlying hover
12316     *
12317     * @see elm_object_style_set()
12318     */
12319    EAPI void         elm_anchorblock_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
12320    /**
12321     * Get the style that the hover should use
12322     *
12323     * Get the style, the hover created by anchorblock will use.
12324     *
12325     * @param obj The anchorblock object
12326     * @return The style to use by the hover. NULL means the default is used.
12327     *
12328     * @see elm_object_style_set()
12329     */
12330    EAPI const char  *elm_anchorblock_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12331    /**
12332     * Ends the hover popup in the anchorblock
12333     *
12334     * When an anchor is clicked, the anchorblock widget will create a hover
12335     * object to use as a popup with user provided content. This function
12336     * terminates this popup, returning the anchorblock to its normal state.
12337     *
12338     * @param obj The anchorblock object
12339     */
12340    EAPI void         elm_anchorblock_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
12341    /**
12342     * Appends a custom item provider to the given anchorblock
12343     *
12344     * Appends the given function to the list of items providers. This list is
12345     * called, one function at a time, with the given @p data pointer, the
12346     * anchorblock object and, in the @p item parameter, the item name as
12347     * referenced in its href string. Following functions in the list will be
12348     * called in order until one of them returns something different to NULL,
12349     * which should be an Evas_Object which will be used in place of the item
12350     * element.
12351     *
12352     * Items in the markup text take the form \<item relsize=16x16 vsize=full
12353     * href=item/name\>\</item\>
12354     *
12355     * @param obj The anchorblock object
12356     * @param func The function to add to the list of providers
12357     * @param data User data that will be passed to the callback function
12358     *
12359     * @see elm_entry_item_provider_append()
12360     */
12361    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);
12362    /**
12363     * Prepend a custom item provider to the given anchorblock
12364     *
12365     * Like elm_anchorblock_item_provider_append(), but it adds the function
12366     * @p func to the beginning of the list, instead of the end.
12367     *
12368     * @param obj The anchorblock object
12369     * @param func The function to add to the list of providers
12370     * @param data User data that will be passed to the callback function
12371     */
12372    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);
12373    /**
12374     * Remove a custom item provider from the list of the given anchorblock
12375     *
12376     * Removes the function and data pairing that matches @p func and @p data.
12377     * That is, unless the same function and same user data are given, the
12378     * function will not be removed from the list. This allows us to add the
12379     * same callback several times, with different @p data pointers and be
12380     * able to remove them later without conflicts.
12381     *
12382     * @param obj The anchorblock object
12383     * @param func The function to remove from the list
12384     * @param data The data matching the function to remove from the list
12385     */
12386    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);
12387    /**
12388     * @}
12389     */
12390
12391    /**
12392     * @defgroup Bubble Bubble
12393     *
12394     * @image html img/widget/bubble/preview-00.png
12395     * @image latex img/widget/bubble/preview-00.eps
12396     * @image html img/widget/bubble/preview-01.png
12397     * @image latex img/widget/bubble/preview-01.eps
12398     * @image html img/widget/bubble/preview-02.png
12399     * @image latex img/widget/bubble/preview-02.eps
12400     *
12401     * @brief The Bubble is a widget to show text similar to how speech is
12402     * represented in comics.
12403     *
12404     * The bubble widget contains 5 important visual elements:
12405     * @li The frame is a rectangle with rounded edjes and an "arrow".
12406     * @li The @p icon is an image to which the frame's arrow points to.
12407     * @li The @p label is a text which appears to the right of the icon if the
12408     * corner is "top_left" or "bottom_left" and is right aligned to the frame
12409     * otherwise.
12410     * @li The @p info is a text which appears to the right of the label. Info's
12411     * font is of a ligther color than label.
12412     * @li The @p content is an evas object that is shown inside the frame.
12413     *
12414     * The position of the arrow, icon, label and info depends on which corner is
12415     * selected. The four available corners are:
12416     * @li "top_left" - Default
12417     * @li "top_right"
12418     * @li "bottom_left"
12419     * @li "bottom_right"
12420     *
12421     * Signals that you can add callbacks for are:
12422     * @li "clicked" - This is called when a user has clicked the bubble.
12423     *
12424     * For an example of using a buble see @ref bubble_01_example_page "this".
12425     *
12426     * @{
12427     */
12428    /**
12429     * Add a new bubble to the parent
12430     *
12431     * @param parent The parent object
12432     * @return The new object or NULL if it cannot be created
12433     *
12434     * This function adds a text bubble to the given parent evas object.
12435     */
12436    EAPI Evas_Object *elm_bubble_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12437    /**
12438     * Set the label of the bubble
12439     *
12440     * @param obj The bubble object
12441     * @param label The string to set in the label
12442     *
12443     * This function sets the title of the bubble. Where this appears depends on
12444     * the selected corner.
12445     * @deprecated use elm_object_text_set() instead.
12446     */
12447    EINA_DEPRECATED EAPI void         elm_bubble_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
12448    /**
12449     * Get the label of the bubble
12450     *
12451     * @param obj The bubble object
12452     * @return The string of set in the label
12453     *
12454     * This function gets the title of the bubble.
12455     * @deprecated use elm_object_text_get() instead.
12456     */
12457    EINA_DEPRECATED EAPI const char  *elm_bubble_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12458    /**
12459     * Set the info of the bubble
12460     *
12461     * @param obj The bubble object
12462     * @param info The given info about the bubble
12463     *
12464     * This function sets the info of the bubble. Where this appears depends on
12465     * the selected corner.
12466     * @deprecated use elm_object_text_part_set() instead. (with "info" as the parameter).
12467     */
12468    EINA_DEPRECATED EAPI void         elm_bubble_info_set(Evas_Object *obj, const char *info) EINA_ARG_NONNULL(1);
12469    /**
12470     * Get the info of the bubble
12471     *
12472     * @param obj The bubble object
12473     *
12474     * @return The "info" string of the bubble
12475     *
12476     * This function gets the info text.
12477     * @deprecated use elm_object_text_part_get() instead. (with "info" as the parameter).
12478     */
12479    EINA_DEPRECATED EAPI const char  *elm_bubble_info_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12480    /**
12481     * Set the content to be shown in the bubble
12482     *
12483     * Once the content object is set, a previously set one will be deleted.
12484     * If you want to keep the old content object, use the
12485     * elm_bubble_content_unset() function.
12486     *
12487     * @param obj The bubble object
12488     * @param content The given content of the bubble
12489     *
12490     * This function sets the content shown on the middle of the bubble.
12491     */
12492    EINA_DEPRECATED EAPI void         elm_bubble_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
12493    /**
12494     * Get the content shown in the bubble
12495     *
12496     * Return the content object which is set for this widget.
12497     *
12498     * @param obj The bubble object
12499     * @return The content that is being used
12500     */
12501    EINA_DEPRECATED EAPI Evas_Object *elm_bubble_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12502    /**
12503     * Unset the content shown in the bubble
12504     *
12505     * Unparent and return the content object which was set for this widget.
12506     *
12507     * @param obj The bubble object
12508     * @return The content that was being used
12509     */
12510    EINA_DEPRECATED EAPI Evas_Object *elm_bubble_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12511    /**
12512     * Set the icon of the bubble
12513     *
12514     * Once the icon object is set, a previously set one will be deleted.
12515     * If you want to keep the old content object, use the
12516     * elm_icon_content_unset() function.
12517     *
12518     * @param obj The bubble object
12519     * @param icon The given icon for the bubble
12520     */
12521    EAPI void         elm_bubble_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
12522    /**
12523     * Get the icon of the bubble
12524     *
12525     * @param obj The bubble object
12526     * @return The icon for the bubble
12527     *
12528     * This function gets the icon shown on the top left of bubble.
12529     */
12530    EAPI Evas_Object *elm_bubble_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12531    /**
12532     * Unset the icon of the bubble
12533     *
12534     * Unparent and return the icon object which was set for this widget.
12535     *
12536     * @param obj The bubble object
12537     * @return The icon that was being used
12538     */
12539    EAPI Evas_Object *elm_bubble_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12540    /**
12541     * Set the corner of the bubble
12542     *
12543     * @param obj The bubble object.
12544     * @param corner The given corner for the bubble.
12545     *
12546     * This function sets the corner of the bubble. The corner will be used to
12547     * determine where the arrow in the frame points to and where label, icon and
12548     * info are shown.
12549     *
12550     * Possible values for corner are:
12551     * @li "top_left" - Default
12552     * @li "top_right"
12553     * @li "bottom_left"
12554     * @li "bottom_right"
12555     */
12556    EAPI void         elm_bubble_corner_set(Evas_Object *obj, const char *corner) EINA_ARG_NONNULL(1, 2);
12557    /**
12558     * Get the corner of the bubble
12559     *
12560     * @param obj The bubble object.
12561     * @return The given corner for the bubble.
12562     *
12563     * This function gets the selected corner of the bubble.
12564     */
12565    EAPI const char  *elm_bubble_corner_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12566    /**
12567     * @}
12568     */
12569
12570    /**
12571     * @defgroup Photo Photo
12572     *
12573     * For displaying the photo of a person (contact). Simple, yet
12574     * with a very specific purpose.
12575     *
12576     * Signals that you can add callbacks for are:
12577     *
12578     * "clicked" - This is called when a user has clicked the photo
12579     * "drag,start" - Someone started dragging the image out of the object
12580     * "drag,end" - Dragged item was dropped (somewhere)
12581     *
12582     * @{
12583     */
12584
12585    /**
12586     * Add a new photo to the parent
12587     *
12588     * @param parent The parent object
12589     * @return The new object or NULL if it cannot be created
12590     *
12591     * @ingroup Photo
12592     */
12593    EAPI Evas_Object *elm_photo_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12594
12595    /**
12596     * Set the file that will be used as photo
12597     *
12598     * @param obj The photo object
12599     * @param file The path to file that will be used as photo
12600     *
12601     * @return (1 = success, 0 = error)
12602     *
12603     * @ingroup Photo
12604     */
12605    EAPI Eina_Bool    elm_photo_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
12606
12607     /**
12608     * Set the file that will be used as thumbnail in the photo.
12609     *
12610     * @param obj The photo object.
12611     * @param file The path to file that will be used as thumb.
12612     * @param group The key used in case of an EET file.
12613     *
12614     * @ingroup Photo
12615     */
12616    EAPI void         elm_photo_thumb_set(const Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
12617
12618    /**
12619     * Set the size that will be used on the photo
12620     *
12621     * @param obj The photo object
12622     * @param size The size that the photo will be
12623     *
12624     * @ingroup Photo
12625     */
12626    EAPI void         elm_photo_size_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
12627
12628    /**
12629     * Set if the photo should be completely visible or not.
12630     *
12631     * @param obj The photo object
12632     * @param fill if true the photo will be completely visible
12633     *
12634     * @ingroup Photo
12635     */
12636    EAPI void         elm_photo_fill_inside_set(Evas_Object *obj, Eina_Bool fill) EINA_ARG_NONNULL(1);
12637
12638    /**
12639     * Set editability of the photo.
12640     *
12641     * An editable photo can be dragged to or from, and can be cut or
12642     * pasted too.  Note that pasting an image or dropping an item on
12643     * the image will delete the existing content.
12644     *
12645     * @param obj The photo object.
12646     * @param set To set of clear editablity.
12647     */
12648    EAPI void         elm_photo_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
12649
12650    /**
12651     * @}
12652     */
12653
12654    /* gesture layer */
12655    /**
12656     * @defgroup Elm_Gesture_Layer Gesture Layer
12657     * Gesture Layer Usage:
12658     *
12659     * Use Gesture Layer to detect gestures.
12660     * The advantage is that you don't have to implement
12661     * gesture detection, just set callbacks of gesture state.
12662     * By using gesture layer we make standard interface.
12663     *
12664     * In order to use Gesture Layer you start with @ref elm_gesture_layer_add
12665     * with a parent object parameter.
12666     * Next 'activate' gesture layer with a @ref elm_gesture_layer_attach
12667     * call. Usually with same object as target (2nd parameter).
12668     *
12669     * Now you need to tell gesture layer what gestures you follow.
12670     * This is done with @ref elm_gesture_layer_cb_set call.
12671     * By setting the callback you actually saying to gesture layer:
12672     * I would like to know when the gesture @ref Elm_Gesture_Types
12673     * switches to state @ref Elm_Gesture_State.
12674     *
12675     * Next, you need to implement the actual action that follows the input
12676     * in your callback.
12677     *
12678     * Note that if you like to stop being reported about a gesture, just set
12679     * all callbacks referring this gesture to NULL.
12680     * (again with @ref elm_gesture_layer_cb_set)
12681     *
12682     * The information reported by gesture layer to your callback is depending
12683     * on @ref Elm_Gesture_Types:
12684     * @ref Elm_Gesture_Taps_Info is the info reported for tap gestures:
12685     * @ref ELM_GESTURE_N_TAPS, @ref ELM_GESTURE_N_LONG_TAPS,
12686     * @ref ELM_GESTURE_N_DOUBLE_TAPS, @ref ELM_GESTURE_N_TRIPLE_TAPS.
12687     *
12688     * @ref Elm_Gesture_Momentum_Info is info reported for momentum gestures:
12689     * @ref ELM_GESTURE_MOMENTUM.
12690     *
12691     * @ref Elm_Gesture_Line_Info is the info reported for line gestures:
12692     * (this also contains @ref Elm_Gesture_Momentum_Info internal structure)
12693     * @ref ELM_GESTURE_N_LINES, @ref ELM_GESTURE_N_FLICKS.
12694     * Note that we consider a flick as a line-gesture that should be completed
12695     * in flick-time-limit as defined in @ref Config.
12696     *
12697     * @ref Elm_Gesture_Zoom_Info is the info reported for @ref ELM_GESTURE_ZOOM gesture.
12698     *
12699     * @ref Elm_Gesture_Rotate_Info is the info reported for @ref ELM_GESTURE_ROTATE gesture.
12700     *
12701     *
12702     * Gesture Layer Tweaks:
12703     *
12704     * Note that line, flick, gestures can start without the need to remove fingers from surface.
12705     * When user fingers rests on same-spot gesture is ended and starts again when fingers moved.
12706     *
12707     * Setting glayer_continues_enable to false in @ref Config will change this behavior
12708     * so gesture starts when user touches (a *DOWN event) touch-surface
12709     * and ends when no fingers touches surface (a *UP event).
12710     */
12711
12712    /**
12713     * @enum _Elm_Gesture_Types
12714     * Enum of supported gesture types.
12715     * @ingroup Elm_Gesture_Layer
12716     */
12717    enum _Elm_Gesture_Types
12718      {
12719         ELM_GESTURE_FIRST = 0,
12720
12721         ELM_GESTURE_N_TAPS, /**< N fingers single taps */
12722         ELM_GESTURE_N_LONG_TAPS, /**< N fingers single long-taps */
12723         ELM_GESTURE_N_DOUBLE_TAPS, /**< N fingers double-single taps */
12724         ELM_GESTURE_N_TRIPLE_TAPS, /**< N fingers triple-single taps */
12725
12726         ELM_GESTURE_MOMENTUM, /**< Reports momentum in the dircetion of move */
12727
12728         ELM_GESTURE_N_LINES, /**< N fingers line gesture */
12729         ELM_GESTURE_N_FLICKS, /**< N fingers flick gesture */
12730
12731         ELM_GESTURE_ZOOM, /**< Zoom */
12732         ELM_GESTURE_ROTATE, /**< Rotate */
12733
12734         ELM_GESTURE_LAST
12735      };
12736
12737    /**
12738     * @typedef Elm_Gesture_Types
12739     * gesture types enum
12740     * @ingroup Elm_Gesture_Layer
12741     */
12742    typedef enum _Elm_Gesture_Types Elm_Gesture_Types;
12743
12744    /**
12745     * @enum _Elm_Gesture_State
12746     * Enum of gesture states.
12747     * @ingroup Elm_Gesture_Layer
12748     */
12749    enum _Elm_Gesture_State
12750      {
12751         ELM_GESTURE_STATE_UNDEFINED = -1, /**< Gesture not STARTed */
12752         ELM_GESTURE_STATE_START,          /**< Gesture STARTed     */
12753         ELM_GESTURE_STATE_MOVE,           /**< Gesture is ongoing  */
12754         ELM_GESTURE_STATE_END,            /**< Gesture completed   */
12755         ELM_GESTURE_STATE_ABORT    /**< Onging gesture was ABORTed */
12756      };
12757
12758    /**
12759     * @typedef Elm_Gesture_State
12760     * gesture states enum
12761     * @ingroup Elm_Gesture_Layer
12762     */
12763    typedef enum _Elm_Gesture_State Elm_Gesture_State;
12764
12765    /**
12766     * @struct _Elm_Gesture_Taps_Info
12767     * Struct holds taps info for user
12768     * @ingroup Elm_Gesture_Layer
12769     */
12770    struct _Elm_Gesture_Taps_Info
12771      {
12772         Evas_Coord x, y;         /**< Holds center point between fingers */
12773         unsigned int n;          /**< Number of fingers tapped           */
12774         unsigned int timestamp;  /**< event timestamp       */
12775      };
12776
12777    /**
12778     * @typedef Elm_Gesture_Taps_Info
12779     * holds taps info for user
12780     * @ingroup Elm_Gesture_Layer
12781     */
12782    typedef struct _Elm_Gesture_Taps_Info Elm_Gesture_Taps_Info;
12783
12784    /**
12785     * @struct _Elm_Gesture_Momentum_Info
12786     * Struct holds momentum info for user
12787     * x1 and y1 are not necessarily in sync
12788     * x1 holds x value of x direction starting point
12789     * and same holds for y1.
12790     * This is noticeable when doing V-shape movement
12791     * @ingroup Elm_Gesture_Layer
12792     */
12793    struct _Elm_Gesture_Momentum_Info
12794      {  /* Report line ends, timestamps, and momentum computed        */
12795         Evas_Coord x1; /**< Final-swipe direction starting point on X */
12796         Evas_Coord y1; /**< Final-swipe direction starting point on Y */
12797         Evas_Coord x2; /**< Final-swipe direction ending point on X   */
12798         Evas_Coord y2; /**< Final-swipe direction ending point on Y   */
12799
12800         unsigned int tx; /**< Timestamp of start of final x-swipe */
12801         unsigned int ty; /**< Timestamp of start of final y-swipe */
12802
12803         Evas_Coord mx; /**< Momentum on X */
12804         Evas_Coord my; /**< Momentum on Y */
12805
12806         unsigned int n;  /**< Number of fingers */
12807      };
12808
12809    /**
12810     * @typedef Elm_Gesture_Momentum_Info
12811     * holds momentum info for user
12812     * @ingroup Elm_Gesture_Layer
12813     */
12814     typedef struct _Elm_Gesture_Momentum_Info Elm_Gesture_Momentum_Info;
12815
12816    /**
12817     * @struct _Elm_Gesture_Line_Info
12818     * Struct holds line info for user
12819     * @ingroup Elm_Gesture_Layer
12820     */
12821    struct _Elm_Gesture_Line_Info
12822      {  /* Report line ends, timestamps, and momentum computed      */
12823         Elm_Gesture_Momentum_Info momentum; /**< Line momentum info */
12824         /* FIXME should be radians, bot degrees */
12825         double angle;              /**< Angle (direction) of lines  */
12826      };
12827
12828    /**
12829     * @typedef Elm_Gesture_Line_Info
12830     * Holds line info for user
12831     * @ingroup Elm_Gesture_Layer
12832     */
12833     typedef struct  _Elm_Gesture_Line_Info Elm_Gesture_Line_Info;
12834
12835    /**
12836     * @struct _Elm_Gesture_Zoom_Info
12837     * Struct holds zoom info for user
12838     * @ingroup Elm_Gesture_Layer
12839     */
12840    struct _Elm_Gesture_Zoom_Info
12841      {
12842         Evas_Coord x, y;       /**< Holds zoom center point reported to user  */
12843         Evas_Coord radius; /**< Holds radius between fingers reported to user */
12844         double zoom;            /**< Zoom value: 1.0 means no zoom             */
12845         double momentum;        /**< Zoom momentum: zoom growth per second (NOT YET SUPPORTED) */
12846      };
12847
12848    /**
12849     * @typedef Elm_Gesture_Zoom_Info
12850     * Holds zoom info for user
12851     * @ingroup Elm_Gesture_Layer
12852     */
12853    typedef struct _Elm_Gesture_Zoom_Info Elm_Gesture_Zoom_Info;
12854
12855    /**
12856     * @struct _Elm_Gesture_Rotate_Info
12857     * Struct holds rotation info for user
12858     * @ingroup Elm_Gesture_Layer
12859     */
12860    struct _Elm_Gesture_Rotate_Info
12861      {
12862         Evas_Coord x, y;   /**< Holds zoom center point reported to user      */
12863         Evas_Coord radius; /**< Holds radius between fingers reported to user */
12864         double base_angle; /**< Holds start-angle */
12865         double angle;      /**< Rotation value: 0.0 means no rotation         */
12866         double momentum;   /**< Rotation momentum: rotation done per second (NOT YET SUPPORTED) */
12867      };
12868
12869    /**
12870     * @typedef Elm_Gesture_Rotate_Info
12871     * Holds rotation info for user
12872     * @ingroup Elm_Gesture_Layer
12873     */
12874    typedef struct _Elm_Gesture_Rotate_Info Elm_Gesture_Rotate_Info;
12875
12876    /**
12877     * @typedef Elm_Gesture_Event_Cb
12878     * User callback used to stream gesture info from gesture layer
12879     * @param data user data
12880     * @param event_info gesture report info
12881     * Returns a flag field to be applied on the causing event.
12882     * You should probably return EVAS_EVENT_FLAG_ON_HOLD if your widget acted
12883     * upon the event, in an irreversible way.
12884     *
12885     * @ingroup Elm_Gesture_Layer
12886     */
12887    typedef Evas_Event_Flags (*Elm_Gesture_Event_Cb) (void *data, void *event_info);
12888
12889    /**
12890     * Use function to set callbacks to be notified about
12891     * change of state of gesture.
12892     * When a user registers a callback with this function
12893     * this means this gesture has to be tested.
12894     *
12895     * When ALL callbacks for a gesture are set to NULL
12896     * it means user isn't interested in gesture-state
12897     * and it will not be tested.
12898     *
12899     * @param obj Pointer to gesture-layer.
12900     * @param idx The gesture you would like to track its state.
12901     * @param cb callback function pointer.
12902     * @param cb_type what event this callback tracks: START, MOVE, END, ABORT.
12903     * @param data user info to be sent to callback (usually, Smart Data)
12904     *
12905     * @ingroup Elm_Gesture_Layer
12906     */
12907    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);
12908
12909    /**
12910     * Call this function to get repeat-events settings.
12911     *
12912     * @param obj Pointer to gesture-layer.
12913     *
12914     * @return repeat events settings.
12915     * @see elm_gesture_layer_hold_events_set()
12916     * @ingroup Elm_Gesture_Layer
12917     */
12918    EAPI Eina_Bool elm_gesture_layer_hold_events_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
12919
12920    /**
12921     * This function called in order to make gesture-layer repeat events.
12922     * Set this of you like to get the raw events only if gestures were not detected.
12923     * Clear this if you like gesture layer to fwd events as testing gestures.
12924     *
12925     * @param obj Pointer to gesture-layer.
12926     * @param r Repeat: TRUE/FALSE
12927     *
12928     * @ingroup Elm_Gesture_Layer
12929     */
12930    EAPI void elm_gesture_layer_hold_events_set(Evas_Object *obj, Eina_Bool r) EINA_ARG_NONNULL(1);
12931
12932    /**
12933     * This function sets step-value for zoom action.
12934     * Set step to any positive value.
12935     * Cancel step setting by setting to 0.0
12936     *
12937     * @param obj Pointer to gesture-layer.
12938     * @param s new zoom step value.
12939     *
12940     * @ingroup Elm_Gesture_Layer
12941     */
12942    EAPI void elm_gesture_layer_zoom_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
12943
12944    /**
12945     * This function sets step-value for rotate action.
12946     * Set step to any positive value.
12947     * Cancel step setting by setting to 0.0
12948     *
12949     * @param obj Pointer to gesture-layer.
12950     * @param s new roatate step value.
12951     *
12952     * @ingroup Elm_Gesture_Layer
12953     */
12954    EAPI void elm_gesture_layer_rotate_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
12955
12956    /**
12957     * This function called to attach gesture-layer to an Evas_Object.
12958     * @param obj Pointer to gesture-layer.
12959     * @param t Pointer to underlying object (AKA Target)
12960     *
12961     * @return TRUE, FALSE on success, failure.
12962     *
12963     * @ingroup Elm_Gesture_Layer
12964     */
12965    EAPI Eina_Bool elm_gesture_layer_attach(Evas_Object *obj, Evas_Object *t) EINA_ARG_NONNULL(1, 2);
12966
12967    /**
12968     * Call this function to construct a new gesture-layer object.
12969     * This does not activate the gesture layer. You have to
12970     * call elm_gesture_layer_attach in order to 'activate' gesture-layer.
12971     *
12972     * @param parent the parent object.
12973     *
12974     * @return Pointer to new gesture-layer object.
12975     *
12976     * @ingroup Elm_Gesture_Layer
12977     */
12978    EAPI Evas_Object *elm_gesture_layer_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12979
12980    /**
12981     * @defgroup Thumb Thumb
12982     *
12983     * @image html img/widget/thumb/preview-00.png
12984     * @image latex img/widget/thumb/preview-00.eps
12985     *
12986     * A thumb object is used for displaying the thumbnail of an image or video.
12987     * You must have compiled Elementary with Ethumb_Client support and the DBus
12988     * service must be present and auto-activated in order to have thumbnails to
12989     * be generated.
12990     *
12991     * Once the thumbnail object becomes visible, it will check if there is a
12992     * previously generated thumbnail image for the file set on it. If not, it
12993     * will start generating this thumbnail.
12994     *
12995     * Different config settings will cause different thumbnails to be generated
12996     * even on the same file.
12997     *
12998     * Generated thumbnails are stored under @c $HOME/.thumbnails/. Check the
12999     * Ethumb documentation to change this path, and to see other configuration
13000     * options.
13001     *
13002     * Signals that you can add callbacks for are:
13003     *
13004     * - "clicked" - This is called when a user has clicked the thumb without dragging
13005     *             around.
13006     * - "clicked,double" - This is called when a user has double-clicked the thumb.
13007     * - "press" - This is called when a user has pressed down the thumb.
13008     * - "generate,start" - The thumbnail generation started.
13009     * - "generate,stop" - The generation process stopped.
13010     * - "generate,error" - The generation failed.
13011     * - "load,error" - The thumbnail image loading failed.
13012     *
13013     * available styles:
13014     * - default
13015     * - noframe
13016     *
13017     * An example of use of thumbnail:
13018     *
13019     * - @ref thumb_example_01
13020     */
13021
13022    /**
13023     * @addtogroup Thumb
13024     * @{
13025     */
13026
13027    /**
13028     * @enum _Elm_Thumb_Animation_Setting
13029     * @typedef Elm_Thumb_Animation_Setting
13030     *
13031     * Used to set if a video thumbnail is animating or not.
13032     *
13033     * @ingroup Thumb
13034     */
13035    typedef enum _Elm_Thumb_Animation_Setting
13036      {
13037         ELM_THUMB_ANIMATION_START = 0, /**< Play animation once */
13038         ELM_THUMB_ANIMATION_LOOP,      /**< Keep playing animation until stop is requested */
13039         ELM_THUMB_ANIMATION_STOP,      /**< Stop playing the animation */
13040         ELM_THUMB_ANIMATION_LAST
13041      } Elm_Thumb_Animation_Setting;
13042
13043    /**
13044     * Add a new thumb object to the parent.
13045     *
13046     * @param parent The parent object.
13047     * @return The new object or NULL if it cannot be created.
13048     *
13049     * @see elm_thumb_file_set()
13050     * @see elm_thumb_ethumb_client_get()
13051     *
13052     * @ingroup Thumb
13053     */
13054    EAPI Evas_Object                 *elm_thumb_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13055    /**
13056     * Reload thumbnail if it was generated before.
13057     *
13058     * @param obj The thumb object to reload
13059     *
13060     * This is useful if the ethumb client configuration changed, like its
13061     * size, aspect or any other property one set in the handle returned
13062     * by elm_thumb_ethumb_client_get().
13063     *
13064     * If the options didn't change, the thumbnail won't be generated again, but
13065     * the old one will still be used.
13066     *
13067     * @see elm_thumb_file_set()
13068     *
13069     * @ingroup Thumb
13070     */
13071    EAPI void                         elm_thumb_reload(Evas_Object *obj) EINA_ARG_NONNULL(1);
13072    /**
13073     * Set the file that will be used as thumbnail.
13074     *
13075     * @param obj The thumb object.
13076     * @param file The path to file that will be used as thumb.
13077     * @param key The key used in case of an EET file.
13078     *
13079     * The file can be an image or a video (in that case, acceptable extensions are:
13080     * avi, mp4, ogv, mov, mpg and wmv). To start the video animation, use the
13081     * function elm_thumb_animate().
13082     *
13083     * @see elm_thumb_file_get()
13084     * @see elm_thumb_reload()
13085     * @see elm_thumb_animate()
13086     *
13087     * @ingroup Thumb
13088     */
13089    EAPI void                         elm_thumb_file_set(Evas_Object *obj, const char *file, const char *key) EINA_ARG_NONNULL(1);
13090    /**
13091     * Get the image or video path and key used to generate the thumbnail.
13092     *
13093     * @param obj The thumb object.
13094     * @param file Pointer to filename.
13095     * @param key Pointer to key.
13096     *
13097     * @see elm_thumb_file_set()
13098     * @see elm_thumb_path_get()
13099     *
13100     * @ingroup Thumb
13101     */
13102    EAPI void                         elm_thumb_file_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
13103    /**
13104     * Get the path and key to the image or video generated by ethumb.
13105     *
13106     * One just need to make sure that the thumbnail was generated before getting
13107     * its path; otherwise, the path will be NULL. One way to do that is by asking
13108     * for the path when/after the "generate,stop" smart callback is called.
13109     *
13110     * @param obj The thumb object.
13111     * @param file Pointer to thumb path.
13112     * @param key Pointer to thumb key.
13113     *
13114     * @see elm_thumb_file_get()
13115     *
13116     * @ingroup Thumb
13117     */
13118    EAPI void                         elm_thumb_path_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
13119    /**
13120     * Set the animation state for the thumb object. If its content is an animated
13121     * video, you may start/stop the animation or tell it to play continuously and
13122     * looping.
13123     *
13124     * @param obj The thumb object.
13125     * @param setting The animation setting.
13126     *
13127     * @see elm_thumb_file_set()
13128     *
13129     * @ingroup Thumb
13130     */
13131    EAPI void                         elm_thumb_animate_set(Evas_Object *obj, Elm_Thumb_Animation_Setting s) EINA_ARG_NONNULL(1);
13132    /**
13133     * Get the animation state for the thumb object.
13134     *
13135     * @param obj The thumb object.
13136     * @return getting The animation setting or @c ELM_THUMB_ANIMATION_LAST,
13137     * on errors.
13138     *
13139     * @see elm_thumb_animate_set()
13140     *
13141     * @ingroup Thumb
13142     */
13143    EAPI Elm_Thumb_Animation_Setting  elm_thumb_animate_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13144    /**
13145     * Get the ethumb_client handle so custom configuration can be made.
13146     *
13147     * @return Ethumb_Client instance or NULL.
13148     *
13149     * This must be called before the objects are created to be sure no object is
13150     * visible and no generation started.
13151     *
13152     * Example of usage:
13153     *
13154     * @code
13155     * #include <Elementary.h>
13156     * #ifndef ELM_LIB_QUICKLAUNCH
13157     * EAPI_MAIN int
13158     * elm_main(int argc, char **argv)
13159     * {
13160     *    Ethumb_Client *client;
13161     *
13162     *    elm_need_ethumb();
13163     *
13164     *    // ... your code
13165     *
13166     *    client = elm_thumb_ethumb_client_get();
13167     *    if (!client)
13168     *      {
13169     *         ERR("could not get ethumb_client");
13170     *         return 1;
13171     *      }
13172     *    ethumb_client_size_set(client, 100, 100);
13173     *    ethumb_client_crop_align_set(client, 0.5, 0.5);
13174     *    // ... your code
13175     *
13176     *    // Create elm_thumb objects here
13177     *
13178     *    elm_run();
13179     *    elm_shutdown();
13180     *    return 0;
13181     * }
13182     * #endif
13183     * ELM_MAIN()
13184     * @endcode
13185     *
13186     * @note There's only one client handle for Ethumb, so once a configuration
13187     * change is done to it, any other request for thumbnails (for any thumbnail
13188     * object) will use that configuration. Thus, this configuration is global.
13189     *
13190     * @ingroup Thumb
13191     */
13192    EAPI void                        *elm_thumb_ethumb_client_get(void);
13193    /**
13194     * Get the ethumb_client connection state.
13195     *
13196     * @return EINA_TRUE if the client is connected to the server or EINA_FALSE
13197     * otherwise.
13198     */
13199    EAPI Eina_Bool                    elm_thumb_ethumb_client_connected(void);
13200    /**
13201     * Make the thumbnail 'editable'.
13202     *
13203     * @param obj Thumb object.
13204     * @param set Turn on or off editability. Default is @c EINA_FALSE.
13205     *
13206     * This means the thumbnail is a valid drag target for drag and drop, and can be
13207     * cut or pasted too.
13208     *
13209     * @see elm_thumb_editable_get()
13210     *
13211     * @ingroup Thumb
13212     */
13213    EAPI Eina_Bool                    elm_thumb_editable_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
13214    /**
13215     * Make the thumbnail 'editable'.
13216     *
13217     * @param obj Thumb object.
13218     * @return Editability.
13219     *
13220     * This means the thumbnail is a valid drag target for drag and drop, and can be
13221     * cut or pasted too.
13222     *
13223     * @see elm_thumb_editable_set()
13224     *
13225     * @ingroup Thumb
13226     */
13227    EAPI Eina_Bool                    elm_thumb_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13228
13229    /**
13230     * @}
13231     */
13232
13233    /**
13234     * @defgroup Web Web
13235     *
13236     * @image html img/widget/web/preview-00.png
13237     * @image latex img/widget/web/preview-00.eps
13238     *
13239     * A web object is used for displaying web pages (HTML/CSS/JS)
13240     * using WebKit-EFL. You must have compiled Elementary with
13241     * ewebkit support.
13242     *
13243     * Signals that you can add callbacks for are:
13244     * @li "download,request": A file download has been requested. Event info is
13245     * a pointer to a Elm_Web_Download
13246     * @li "editorclient,contents,changed": Editor client's contents changed
13247     * @li "editorclient,selection,changed": Editor client's selection changed
13248     * @li "frame,created": A new frame was created. Event info is an
13249     * Evas_Object which can be handled with WebKit's ewk_frame API
13250     * @li "icon,received": An icon was received by the main frame
13251     * @li "inputmethod,changed": Input method changed. Event info is an
13252     * Eina_Bool indicating whether it's enabled or not
13253     * @li "js,windowobject,clear": JS window object has been cleared
13254     * @li "link,hover,in": Mouse cursor is hovering over a link. Event info
13255     * is a char *link[2], where the first string contains the URL the link
13256     * points to, and the second one the title of the link
13257     * @li "link,hover,out": Mouse cursor left the link
13258     * @li "load,document,finished": Loading of a document finished. Event info
13259     * is the frame that finished loading
13260     * @li "load,error": Load failed. Event info is a pointer to
13261     * Elm_Web_Frame_Load_Error
13262     * @li "load,finished": Load finished. Event info is NULL on success, on
13263     * error it's a pointer to Elm_Web_Frame_Load_Error
13264     * @li "load,newwindow,show": A new window was created and is ready to be
13265     * shown
13266     * @li "load,progress": Overall load progress. Event info is a pointer to
13267     * a double containing a value between 0.0 and 1.0
13268     * @li "load,provisional": Started provisional load
13269     * @li "load,started": Loading of a document started
13270     * @li "menubar,visible,get": Queries if the menubar is visible. Event info
13271     * is a pointer to Eina_Bool where the callback should set EINA_TRUE if
13272     * the menubar is visible, or EINA_FALSE in case it's not
13273     * @li "menubar,visible,set": Informs menubar visibility. Event info is
13274     * an Eina_Bool indicating the visibility
13275     * @li "popup,created": A dropdown widget was activated, requesting its
13276     * popup menu to be created. Event info is a pointer to Elm_Web_Menu
13277     * @li "popup,willdelete": The web object is ready to destroy the popup
13278     * object created. Event info is a pointer to Elm_Web_Menu
13279     * @li "ready": Page is fully loaded
13280     * @li "scrollbars,visible,get": Queries visibility of scrollbars. Event
13281     * info is a pointer to Eina_Bool where the visibility state should be set
13282     * @li "scrollbars,visible,set": Informs scrollbars visibility. Event info
13283     * is an Eina_Bool with the visibility state set
13284     * @li "statusbar,text,set": Text of the statusbar changed. Even info is
13285     * a string with the new text
13286     * @li "statusbar,visible,get": Queries visibility of the status bar.
13287     * Event info is a pointer to Eina_Bool where the visibility state should be
13288     * set.
13289     * @li "statusbar,visible,set": Informs statusbar visibility. Event info is
13290     * an Eina_Bool with the visibility value
13291     * @li "title,changed": Title of the main frame changed. Event info is a
13292     * string with the new title
13293     * @li "toolbars,visible,get": Queries visibility of toolbars. Event info
13294     * is a pointer to Eina_Bool where the visibility state should be set
13295     * @li "toolbars,visible,set": Informs the visibility of toolbars. Event
13296     * info is an Eina_Bool with the visibility state
13297     * @li "tooltip,text,set": Show and set text of a tooltip. Event info is
13298     * a string with the text to show
13299     * @li "uri,changed": URI of the main frame changed. Event info is a string
13300     * with the new URI
13301     * @li "view,resized": The web object internal's view changed sized
13302     * @li "windows,close,request": A JavaScript request to close the current
13303     * window was requested
13304     * @li "zoom,animated,end": Animated zoom finished
13305     *
13306     * available styles:
13307     * - default
13308     *
13309     * An example of use of web:
13310     *
13311     * - @ref web_example_01 TBD
13312     */
13313
13314    /**
13315     * @addtogroup Web
13316     * @{
13317     */
13318
13319    /**
13320     * Structure used to report load errors.
13321     *
13322     * Load errors are reported as signal by elm_web. All the strings are
13323     * temporary references and should @b not be used after the signal
13324     * callback returns. If it's required, make copies with strdup() or
13325     * eina_stringshare_add() (they are not even guaranteed to be
13326     * stringshared, so must use eina_stringshare_add() and not
13327     * eina_stringshare_ref()).
13328     */
13329    typedef struct _Elm_Web_Frame_Load_Error Elm_Web_Frame_Load_Error;
13330    /**
13331     * Structure used to report load errors.
13332     *
13333     * Load errors are reported as signal by elm_web. All the strings are
13334     * temporary references and should @b not be used after the signal
13335     * callback returns. If it's required, make copies with strdup() or
13336     * eina_stringshare_add() (they are not even guaranteed to be
13337     * stringshared, so must use eina_stringshare_add() and not
13338     * eina_stringshare_ref()).
13339     */
13340    struct _Elm_Web_Frame_Load_Error
13341      {
13342         int code; /**< Numeric error code */
13343         Eina_Bool is_cancellation; /**< Error produced by cancelling a request */
13344         const char *domain; /**< Error domain name */
13345         const char *description; /**< Error description (already localized) */
13346         const char *failing_url; /**< The URL that failed to load */
13347         Evas_Object *frame; /**< Frame object that produced the error */
13348      };
13349
13350    /**
13351     * The possibles types that the items in a menu can be
13352     */
13353    typedef enum _Elm_Web_Menu_Item_Type
13354      {
13355         ELM_WEB_MENU_SEPARATOR,
13356         ELM_WEB_MENU_GROUP,
13357         ELM_WEB_MENU_OPTION
13358      } Elm_Web_Menu_Item_Type;
13359
13360    /**
13361     * Structure describing the items in a menu
13362     */
13363    typedef struct _Elm_Web_Menu_Item Elm_Web_Menu_Item;
13364    /**
13365     * Structure describing the items in a menu
13366     */
13367    struct _Elm_Web_Menu_Item
13368      {
13369         const char *text; /**< The text for the item */
13370         Elm_Web_Menu_Item_Type type; /**< The type of the item */
13371      };
13372
13373    /**
13374     * Structure describing the menu of a popup
13375     *
13376     * This structure will be passed as the @c event_info for the "popup,create"
13377     * signal, which is emitted when a dropdown menu is opened. Users wanting
13378     * to handle these popups by themselves should listen to this signal and
13379     * set the @c handled property of the struct to @c EINA_TRUE. Leaving this
13380     * property as @c EINA_FALSE means that the user will not handle the popup
13381     * and the default implementation will be used.
13382     *
13383     * When the popup is ready to be dismissed, a "popup,willdelete" signal
13384     * will be emitted to notify the user that it can destroy any objects and
13385     * free all data related to it.
13386     *
13387     * @see elm_web_popup_selected_set()
13388     * @see elm_web_popup_destroy()
13389     */
13390    typedef struct _Elm_Web_Menu Elm_Web_Menu;
13391    /**
13392     * Structure describing the menu of a popup
13393     *
13394     * This structure will be passed as the @c event_info for the "popup,create"
13395     * signal, which is emitted when a dropdown menu is opened. Users wanting
13396     * to handle these popups by themselves should listen to this signal and
13397     * set the @c handled property of the struct to @c EINA_TRUE. Leaving this
13398     * property as @c EINA_FALSE means that the user will not handle the popup
13399     * and the default implementation will be used.
13400     *
13401     * When the popup is ready to be dismissed, a "popup,willdelete" signal
13402     * will be emitted to notify the user that it can destroy any objects and
13403     * free all data related to it.
13404     *
13405     * @see elm_web_popup_selected_set()
13406     * @see elm_web_popup_destroy()
13407     */
13408    struct _Elm_Web_Menu
13409      {
13410         Eina_List *items; /**< List of #Elm_Web_Menu_Item */
13411         int x; /**< The X position of the popup, relative to the elm_web object */
13412         int y; /**< The Y position of the popup, relative to the elm_web object */
13413         int width; /**< Width of the popup menu */
13414         int height; /**< Height of the popup menu */
13415
13416         Eina_Bool handled : 1; /**< Set to @c EINA_TRUE by the user to indicate that the popup has been handled and the default implementation should be ignored. Leave as @c EINA_FALSE otherwise. */
13417      };
13418
13419    typedef struct _Elm_Web_Download Elm_Web_Download;
13420    struct _Elm_Web_Download
13421      {
13422         const char *url;
13423      };
13424
13425    /**
13426     * Types of zoom available.
13427     */
13428    typedef enum _Elm_Web_Zoom_Mode
13429      {
13430         ELM_WEB_ZOOM_MODE_MANUAL = 0, /**< Zoom controled normally by elm_web_zoom_set */
13431         ELM_WEB_ZOOM_MODE_AUTO_FIT, /**< Zoom until content fits in web object */
13432         ELM_WEB_ZOOM_MODE_AUTO_FILL, /**< Zoom until content fills web object */
13433         ELM_WEB_ZOOM_MODE_LAST
13434      } Elm_Web_Zoom_Mode;
13435    /**
13436     * Opaque handler containing the features (such as statusbar, menubar, etc)
13437     * that are to be set on a newly requested window.
13438     */
13439    typedef struct _Elm_Web_Window_Features Elm_Web_Window_Features;
13440    /**
13441     * Callback type for the create_window hook.
13442     *
13443     * The function parameters are:
13444     * @li @p data User data pointer set when setting the hook function
13445     * @li @p obj The elm_web object requesting the new window
13446     * @li @p js Set to @c EINA_TRUE if the request was originated from
13447     * JavaScript. @c EINA_FALSE otherwise.
13448     * @li @p window_features A pointer of #Elm_Web_Window_Features indicating
13449     * the features requested for the new window.
13450     *
13451     * The returned value of the function should be the @c elm_web widget where
13452     * the request will be loaded. That is, if a new window or tab is created,
13453     * the elm_web widget in it should be returned, and @b NOT the window
13454     * object.
13455     * Returning @c NULL should cancel the request.
13456     *
13457     * @see elm_web_window_create_hook_set()
13458     */
13459    typedef Evas_Object *(*Elm_Web_Window_Open)(void *data, Evas_Object *obj, Eina_Bool js, const Elm_Web_Window_Features *window_features);
13460    /**
13461     * Callback type for the JS alert hook.
13462     *
13463     * The function parameters are:
13464     * @li @p data User data pointer set when setting the hook function
13465     * @li @p obj The elm_web object requesting the new window
13466     * @li @p message The message to show in the alert dialog
13467     *
13468     * The function should return the object representing the alert dialog.
13469     * Elm_Web will run a second main loop to handle the dialog and normal
13470     * flow of the application will be restored when the object is deleted, so
13471     * the user should handle the popup properly in order to delete the object
13472     * when the action is finished.
13473     * If the function returns @c NULL the popup will be ignored.
13474     *
13475     * @see elm_web_dialog_alert_hook_set()
13476     */
13477    typedef Evas_Object *(*Elm_Web_Dialog_Alert)(void *data, Evas_Object *obj, const char *message);
13478    /**
13479     * Callback type for the JS confirm hook.
13480     *
13481     * The function parameters are:
13482     * @li @p data User data pointer set when setting the hook function
13483     * @li @p obj The elm_web object requesting the new window
13484     * @li @p message The message to show in the confirm dialog
13485     * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13486     * the user selected @c Ok, @c EINA_FALSE otherwise.
13487     *
13488     * The function should return the object representing the confirm dialog.
13489     * Elm_Web will run a second main loop to handle the dialog and normal
13490     * flow of the application will be restored when the object is deleted, so
13491     * the user should handle the popup properly in order to delete the object
13492     * when the action is finished.
13493     * If the function returns @c NULL the popup will be ignored.
13494     *
13495     * @see elm_web_dialog_confirm_hook_set()
13496     */
13497    typedef Evas_Object *(*Elm_Web_Dialog_Confirm)(void *data, Evas_Object *obj, const char *message, Eina_Bool *ret);
13498    /**
13499     * Callback type for the JS prompt hook.
13500     *
13501     * The function parameters are:
13502     * @li @p data User data pointer set when setting the hook function
13503     * @li @p obj The elm_web object requesting the new window
13504     * @li @p message The message to show in the prompt dialog
13505     * @li @p def_value The default value to present the user in the entry
13506     * @li @p value Pointer where to store the value given by the user. Must
13507     * be a malloc'ed string or @c NULL if the user cancelled the popup.
13508     * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13509     * the user selected @c Ok, @c EINA_FALSE otherwise.
13510     *
13511     * The function should return the object representing the prompt dialog.
13512     * Elm_Web will run a second main loop to handle the dialog and normal
13513     * flow of the application will be restored when the object is deleted, so
13514     * the user should handle the popup properly in order to delete the object
13515     * when the action is finished.
13516     * If the function returns @c NULL the popup will be ignored.
13517     *
13518     * @see elm_web_dialog_prompt_hook_set()
13519     */
13520    typedef Evas_Object *(*Elm_Web_Dialog_Prompt)(void *data, Evas_Object *obj, const char *message, const char *def_value, char **value, Eina_Bool *ret);
13521    /**
13522     * Callback type for the JS file selector hook.
13523     *
13524     * The function parameters are:
13525     * @li @p data User data pointer set when setting the hook function
13526     * @li @p obj The elm_web object requesting the new window
13527     * @li @p allows_multiple @c EINA_TRUE if multiple files can be selected.
13528     * @li @p accept_types Mime types accepted
13529     * @li @p selected Pointer where to store the list of malloc'ed strings
13530     * containing the path to each file selected. Must be @c NULL if the file
13531     * dialog is cancelled
13532     * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13533     * the user selected @c Ok, @c EINA_FALSE otherwise.
13534     *
13535     * The function should return the object representing the file selector
13536     * dialog.
13537     * Elm_Web will run a second main loop to handle the dialog and normal
13538     * flow of the application will be restored when the object is deleted, so
13539     * the user should handle the popup properly in order to delete the object
13540     * when the action is finished.
13541     * If the function returns @c NULL the popup will be ignored.
13542     *
13543     * @see elm_web_dialog_file selector_hook_set()
13544     */
13545    typedef Evas_Object *(*Elm_Web_Dialog_File_Selector)(void *data, Evas_Object *obj, Eina_Bool allows_multiple, Eina_List *accept_types, Eina_List **selected, Eina_Bool *ret);
13546    /**
13547     * Callback type for the JS console message hook.
13548     *
13549     * When a console message is added from JavaScript, any set function to the
13550     * console message hook will be called for the user to handle. There is no
13551     * default implementation of this hook.
13552     *
13553     * The function parameters are:
13554     * @li @p data User data pointer set when setting the hook function
13555     * @li @p obj The elm_web object that originated the message
13556     * @li @p message The message sent
13557     * @li @p line_number The line number
13558     * @li @p source_id Source id
13559     *
13560     * @see elm_web_console_message_hook_set()
13561     */
13562    typedef void (*Elm_Web_Console_Message)(void *data, Evas_Object *obj, const char *message, unsigned int line_number, const char *source_id);
13563    /**
13564     * Add a new web object to the parent.
13565     *
13566     * @param parent The parent object.
13567     * @return The new object or NULL if it cannot be created.
13568     *
13569     * @see elm_web_uri_set()
13570     * @see elm_web_webkit_view_get()
13571     */
13572    EAPI Evas_Object                 *elm_web_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13573
13574    /**
13575     * Get internal ewk_view object from web object.
13576     *
13577     * Elementary may not provide some low level features of EWebKit,
13578     * instead of cluttering the API with proxy methods we opted to
13579     * return the internal reference. Be careful using it as it may
13580     * interfere with elm_web behavior.
13581     *
13582     * @param obj The web object.
13583     * @return The internal ewk_view object or NULL if it does not
13584     *         exist. (Failure to create or Elementary compiled without
13585     *         ewebkit)
13586     *
13587     * @see elm_web_add()
13588     */
13589    EAPI Evas_Object                 *elm_web_webkit_view_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13590
13591    /**
13592     * Sets the function to call when a new window is requested
13593     *
13594     * This hook will be called when a request to create a new window is
13595     * issued from the web page loaded.
13596     * There is no default implementation for this feature, so leaving this
13597     * unset or passing @c NULL in @p func will prevent new windows from
13598     * opening.
13599     *
13600     * @param obj The web object where to set the hook function
13601     * @param func The hook function to be called when a window is requested
13602     * @param data User data
13603     */
13604    EAPI void                         elm_web_window_create_hook_set(Evas_Object *obj, Elm_Web_Window_Open func, void *data);
13605    /**
13606     * Sets the function to call when an alert dialog
13607     *
13608     * This hook will be called when a JavaScript alert dialog is requested.
13609     * If no function is set or @c NULL is passed in @p func, the default
13610     * implementation will take place.
13611     *
13612     * @param obj The web object where to set the hook function
13613     * @param func The callback function to be used
13614     * @param data User data
13615     *
13616     * @see elm_web_inwin_mode_set()
13617     */
13618    EAPI void                         elm_web_dialog_alert_hook_set(Evas_Object *obj, Elm_Web_Dialog_Alert func, void *data);
13619    /**
13620     * Sets the function to call when an confirm dialog
13621     *
13622     * This hook will be called when a JavaScript confirm dialog is requested.
13623     * If no function is set or @c NULL is passed in @p func, the default
13624     * implementation will take place.
13625     *
13626     * @param obj The web object where to set the hook function
13627     * @param func The callback function to be used
13628     * @param data User data
13629     *
13630     * @see elm_web_inwin_mode_set()
13631     */
13632    EAPI void                         elm_web_dialog_confirm_hook_set(Evas_Object *obj, Elm_Web_Dialog_Confirm func, void *data);
13633    /**
13634     * Sets the function to call when an prompt dialog
13635     *
13636     * This hook will be called when a JavaScript prompt dialog is requested.
13637     * If no function is set or @c NULL is passed in @p func, the default
13638     * implementation will take place.
13639     *
13640     * @param obj The web object where to set the hook function
13641     * @param func The callback function to be used
13642     * @param data User data
13643     *
13644     * @see elm_web_inwin_mode_set()
13645     */
13646    EAPI void                         elm_web_dialog_prompt_hook_set(Evas_Object *obj, Elm_Web_Dialog_Prompt func, void *data);
13647    /**
13648     * Sets the function to call when an file selector dialog
13649     *
13650     * This hook will be called when a JavaScript file selector dialog is
13651     * requested.
13652     * If no function is set or @c NULL is passed in @p func, the default
13653     * implementation will take place.
13654     *
13655     * @param obj The web object where to set the hook function
13656     * @param func The callback function to be used
13657     * @param data User data
13658     *
13659     * @see elm_web_inwin_mode_set()
13660     */
13661    EAPI void                         elm_web_dialog_file_selector_hook_set(Evas_Object *obj, Elm_Web_Dialog_File_Selector func, void *data);
13662    /**
13663     * Sets the function to call when a console message is emitted from JS
13664     *
13665     * This hook will be called when a console message is emitted from
13666     * JavaScript. There is no default implementation for this feature.
13667     *
13668     * @param obj The web object where to set the hook function
13669     * @param func The callback function to be used
13670     * @param data User data
13671     */
13672    EAPI void                         elm_web_console_message_hook_set(Evas_Object *obj, Elm_Web_Console_Message func, void *data);
13673    /**
13674     * Gets the status of the tab propagation
13675     *
13676     * @param obj The web object to query
13677     * @return EINA_TRUE if tab propagation is enabled, EINA_FALSE otherwise
13678     *
13679     * @see elm_web_tab_propagate_set()
13680     */
13681    EAPI Eina_Bool                    elm_web_tab_propagate_get(const Evas_Object *obj);
13682    /**
13683     * Sets whether to use tab propagation
13684     *
13685     * If tab propagation is enabled, whenever the user presses the Tab key,
13686     * Elementary will handle it and switch focus to the next widget.
13687     * The default value is disabled, where WebKit will handle the Tab key to
13688     * cycle focus though its internal objects, jumping to the next widget
13689     * only when that cycle ends.
13690     *
13691     * @param obj The web object
13692     * @param propagate Whether to propagate Tab keys to Elementary or not
13693     */
13694    EAPI void                         elm_web_tab_propagate_set(Evas_Object *obj, Eina_Bool propagate);
13695    /**
13696     * Sets the URI for the web object
13697     *
13698     * It must be a full URI, with resource included, in the form
13699     * http://www.enlightenment.org or file:///tmp/something.html
13700     *
13701     * @param obj The web object
13702     * @param uri The URI to set
13703     * @return EINA_TRUE if the URI could be, EINA_FALSE if an error occurred
13704     */
13705    EAPI Eina_Bool                    elm_web_uri_set(Evas_Object *obj, const char *uri);
13706    /**
13707     * Gets the current URI for the object
13708     *
13709     * The returned string must not be freed and is guaranteed to be
13710     * stringshared.
13711     *
13712     * @param obj The web object
13713     * @return A stringshared internal string with the current URI, or NULL on
13714     * failure
13715     */
13716    EAPI const char                  *elm_web_uri_get(const Evas_Object *obj);
13717    /**
13718     * Gets the current title
13719     *
13720     * The returned string must not be freed and is guaranteed to be
13721     * stringshared.
13722     *
13723     * @param obj The web object
13724     * @return A stringshared internal string with the current title, or NULL on
13725     * failure
13726     */
13727    EAPI const char                  *elm_web_title_get(const Evas_Object *obj);
13728    /**
13729     * Sets the background color to be used by the web object
13730     *
13731     * This is the color that will be used by default when the loaded page
13732     * does not set it's own. Color values are pre-multiplied.
13733     *
13734     * @param obj The web object
13735     * @param r Red component
13736     * @param g Green component
13737     * @param b Blue component
13738     * @param a Alpha component
13739     */
13740    EAPI void                         elm_web_bg_color_set(Evas_Object *obj, int r, int g, int b, int a);
13741    /**
13742     * Gets the background color to be used by the web object
13743     *
13744     * This is the color that will be used by default when the loaded page
13745     * does not set it's own. Color values are pre-multiplied.
13746     *
13747     * @param obj The web object
13748     * @param r Red component
13749     * @param g Green component
13750     * @param b Blue component
13751     * @param a Alpha component
13752     */
13753    EAPI void                         elm_web_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b, int *a);
13754    /**
13755     * Gets a copy of the currently selected text
13756     *
13757     * The string returned must be freed by the user when it's done with it.
13758     *
13759     * @param obj The web object
13760     * @return A newly allocated string, or NULL if nothing is selected or an
13761     * error occurred
13762     */
13763    EAPI char                        *elm_view_selection_get(const Evas_Object *obj);
13764    /**
13765     * Tells the web object which index in the currently open popup was selected
13766     *
13767     * When the user handles the popup creation from the "popup,created" signal,
13768     * it needs to tell the web object which item was selected by calling this
13769     * function with the index corresponding to the item.
13770     *
13771     * @param obj The web object
13772     * @param index The index selected
13773     *
13774     * @see elm_web_popup_destroy()
13775     */
13776    EAPI void                         elm_web_popup_selected_set(Evas_Object *obj, int index);
13777    /**
13778     * Dismisses an open dropdown popup
13779     *
13780     * When the popup from a dropdown widget is to be dismissed, either after
13781     * selecting an option or to cancel it, this function must be called, which
13782     * will later emit an "popup,willdelete" signal to notify the user that
13783     * any memory and objects related to this popup can be freed.
13784     *
13785     * @param obj The web object
13786     * @return EINA_TRUE if the menu was successfully destroyed, or EINA_FALSE
13787     * if there was no menu to destroy
13788     */
13789    EAPI Eina_Bool                    elm_web_popup_destroy(Evas_Object *obj);
13790    /**
13791     * Searches the given string in a document.
13792     *
13793     * @param obj The web object where to search the text
13794     * @param string String to search
13795     * @param case_sensitive If search should be case sensitive or not
13796     * @param forward If search is from cursor and on or backwards
13797     * @param wrap If search should wrap at the end
13798     *
13799     * @return @c EINA_TRUE if the given string was found, @c EINA_FALSE if not
13800     * or failure
13801     */
13802    EAPI Eina_Bool                    elm_web_text_search(const Evas_Object *obj, const char *string, Eina_Bool case_sensitive, Eina_Bool forward, Eina_Bool wrap);
13803    /**
13804     * Marks matches of the given string in a document.
13805     *
13806     * @param obj The web object where to search text
13807     * @param string String to match
13808     * @param case_sensitive If match should be case sensitive or not
13809     * @param highlight If matches should be highlighted
13810     * @param limit Maximum amount of matches, or zero to unlimited
13811     *
13812     * @return number of matched @a string
13813     */
13814    EAPI unsigned int                 elm_web_text_matches_mark(Evas_Object *obj, const char *string, Eina_Bool case_sensitive, Eina_Bool highlight, unsigned int limit);
13815    /**
13816     * Clears all marked matches in the document
13817     *
13818     * @param obj The web object
13819     *
13820     * @return EINA_TRUE on success, EINA_FALSE otherwise
13821     */
13822    EAPI Eina_Bool                    elm_web_text_matches_unmark_all(Evas_Object *obj);
13823    /**
13824     * Sets whether to highlight the matched marks
13825     *
13826     * If enabled, marks set with elm_web_text_matches_mark() will be
13827     * highlighted.
13828     *
13829     * @param obj The web object
13830     * @param highlight Whether to highlight the marks or not
13831     *
13832     * @return EINA_TRUE on success, EINA_FALSE otherwise
13833     */
13834    EAPI Eina_Bool                    elm_web_text_matches_highlight_set(Evas_Object *obj, Eina_Bool highlight);
13835    /**
13836     * Gets whether highlighting marks is enabled
13837     *
13838     * @param The web object
13839     *
13840     * @return EINA_TRUE is marks are set to be highlighted, EINA_FALSE
13841     * otherwise
13842     */
13843    EAPI Eina_Bool                    elm_web_text_matches_highlight_get(const Evas_Object *obj);
13844    /**
13845     * Gets the overall loading progress of the page
13846     *
13847     * Returns the estimated loading progress of the page, with a value between
13848     * 0.0 and 1.0. This is an estimated progress accounting for all the frames
13849     * included in the page.
13850     *
13851     * @param The web object
13852     *
13853     * @return A value between 0.0 and 1.0 indicating the progress, or -1.0 on
13854     * failure
13855     */
13856    EAPI double                       elm_web_load_progress_get(const Evas_Object *obj);
13857    /**
13858     * Stops loading the current page
13859     *
13860     * Cancels the loading of the current page in the web object. This will
13861     * cause a "load,error" signal to be emitted, with the is_cancellation
13862     * flag set to EINA_TRUE.
13863     *
13864     * @param obj The web object
13865     *
13866     * @return EINA_TRUE if the cancel was successful, EINA_FALSE otherwise
13867     */
13868    EAPI Eina_Bool                    elm_web_stop(Evas_Object *obj);
13869    /**
13870     * Requests a reload of the current document in the object
13871     *
13872     * @param obj The web object
13873     *
13874     * @return EINA_TRUE on success, EINA_FALSE otherwise
13875     */
13876    EAPI Eina_Bool                    elm_web_reload(Evas_Object *obj);
13877    /**
13878     * Requests a reload of the current document, avoiding any existing caches
13879     *
13880     * @param obj The web object
13881     *
13882     * @return EINA_TRUE on success, EINA_FALSE otherwise
13883     */
13884    EAPI Eina_Bool                    elm_web_reload_full(Evas_Object *obj);
13885    /**
13886     * Goes back one step in the browsing history
13887     *
13888     * This is equivalent to calling elm_web_object_navigate(obj, -1);
13889     *
13890     * @param obj The web object
13891     *
13892     * @return EINA_TRUE on success, EINA_FALSE otherwise
13893     *
13894     * @see elm_web_history_enable_set()
13895     * @see elm_web_back_possible()
13896     * @see elm_web_forward()
13897     * @see elm_web_navigate()
13898     */
13899    EAPI Eina_Bool                    elm_web_back(Evas_Object *obj);
13900    /**
13901     * Goes forward one step in the browsing history
13902     *
13903     * This is equivalent to calling elm_web_object_navigate(obj, 1);
13904     *
13905     * @param obj The web object
13906     *
13907     * @return EINA_TRUE on success, EINA_FALSE otherwise
13908     *
13909     * @see elm_web_history_enable_set()
13910     * @see elm_web_forward_possible()
13911     * @see elm_web_back()
13912     * @see elm_web_navigate()
13913     */
13914    EAPI Eina_Bool                    elm_web_forward(Evas_Object *obj);
13915    /**
13916     * Jumps the given number of steps in the browsing history
13917     *
13918     * The @p steps value can be a negative integer to back in history, or a
13919     * positive to move forward.
13920     *
13921     * @param obj The web object
13922     * @param steps The number of steps to jump
13923     *
13924     * @return EINA_TRUE on success, EINA_FALSE on error or if not enough
13925     * history exists to jump the given number of steps
13926     *
13927     * @see elm_web_history_enable_set()
13928     * @see elm_web_navigate_possible()
13929     * @see elm_web_back()
13930     * @see elm_web_forward()
13931     */
13932    EAPI Eina_Bool                    elm_web_navigate(Evas_Object *obj, int steps);
13933    /**
13934     * Queries whether it's possible to go back in history
13935     *
13936     * @param obj The web object
13937     *
13938     * @return EINA_TRUE if it's possible to back in history, EINA_FALSE
13939     * otherwise
13940     */
13941    EAPI Eina_Bool                    elm_web_back_possible(Evas_Object *obj);
13942    /**
13943     * Queries whether it's possible to go forward in history
13944     *
13945     * @param obj The web object
13946     *
13947     * @return EINA_TRUE if it's possible to forward in history, EINA_FALSE
13948     * otherwise
13949     */
13950    EAPI Eina_Bool                    elm_web_forward_possible(Evas_Object *obj);
13951    /**
13952     * Queries whether it's possible to jump the given number of steps
13953     *
13954     * The @p steps value can be a negative integer to back in history, or a
13955     * positive to move forward.
13956     *
13957     * @param obj The web object
13958     * @param steps The number of steps to check for
13959     *
13960     * @return EINA_TRUE if enough history exists to perform the given jump,
13961     * EINA_FALSE otherwise
13962     */
13963    EAPI Eina_Bool                    elm_web_navigate_possible(Evas_Object *obj, int steps);
13964    /**
13965     * Gets whether browsing history is enabled for the given object
13966     *
13967     * @param obj The web object
13968     *
13969     * @return EINA_TRUE if history is enabled, EINA_FALSE otherwise
13970     */
13971    EAPI Eina_Bool                    elm_web_history_enable_get(const Evas_Object *obj);
13972    /**
13973     * Enables or disables the browsing history
13974     *
13975     * @param obj The web object
13976     * @param enable Whether to enable or disable the browsing history
13977     */
13978    EAPI void                         elm_web_history_enable_set(Evas_Object *obj, Eina_Bool enable);
13979    /**
13980     * Sets the zoom level of the web object
13981     *
13982     * Zoom level matches the Webkit API, so 1.0 means normal zoom, with higher
13983     * values meaning zoom in and lower meaning zoom out. This function will
13984     * only affect the zoom level if the mode set with elm_web_zoom_mode_set()
13985     * is ::ELM_WEB_ZOOM_MODE_MANUAL.
13986     *
13987     * @param obj The web object
13988     * @param zoom The zoom level to set
13989     */
13990    EAPI void                         elm_web_zoom_set(Evas_Object *obj, double zoom);
13991    /**
13992     * Gets the current zoom level set on the web object
13993     *
13994     * Note that this is the zoom level set on the web object and not that
13995     * of the underlying Webkit one. In the ::ELM_WEB_ZOOM_MODE_MANUAL mode,
13996     * the two zoom levels should match, but for the other two modes the
13997     * Webkit zoom is calculated internally to match the chosen mode without
13998     * changing the zoom level set for the web object.
13999     *
14000     * @param obj The web object
14001     *
14002     * @return The zoom level set on the object
14003     */
14004    EAPI double                       elm_web_zoom_get(const Evas_Object *obj);
14005    /**
14006     * Sets the zoom mode to use
14007     *
14008     * The modes can be any of those defined in ::Elm_Web_Zoom_Mode, except
14009     * ::ELM_WEB_ZOOM_MODE_LAST. The default is ::ELM_WEB_ZOOM_MODE_MANUAL.
14010     *
14011     * ::ELM_WEB_ZOOM_MODE_MANUAL means the zoom level will be controlled
14012     * with the elm_web_zoom_set() function.
14013     * ::ELM_WEB_ZOOM_MODE_AUTO_FIT will calculate the needed zoom level to
14014     * make sure the entirety of the web object's contents are shown.
14015     * ::ELM_WEB_ZOOM_MODE_AUTO_FILL will calculate the needed zoom level to
14016     * fit the contents in the web object's size, without leaving any space
14017     * unused.
14018     *
14019     * @param obj The web object
14020     * @param mode The mode to set
14021     */
14022    EAPI void                         elm_web_zoom_mode_set(Evas_Object *obj, Elm_Web_Zoom_Mode mode);
14023    /**
14024     * Gets the currently set zoom mode
14025     *
14026     * @param obj The web object
14027     *
14028     * @return The current zoom mode set for the object, or
14029     * ::ELM_WEB_ZOOM_MODE_LAST on error
14030     */
14031    EAPI Elm_Web_Zoom_Mode            elm_web_zoom_mode_get(const Evas_Object *obj);
14032    /**
14033     * Shows the given region in the web object
14034     *
14035     * @param obj The web object
14036     * @param x The x coordinate of the region to show
14037     * @param y The y coordinate of the region to show
14038     * @param w The width of the region to show
14039     * @param h The height of the region to show
14040     */
14041    EAPI void                         elm_web_region_show(Evas_Object *obj, int x, int y, int w, int h);
14042    /**
14043     * Brings in the region to the visible area
14044     *
14045     * Like elm_web_region_show(), but it animates the scrolling of the object
14046     * to show the area
14047     *
14048     * @param obj The web object
14049     * @param x The x coordinate of the region to show
14050     * @param y The y coordinate of the region to show
14051     * @param w The width of the region to show
14052     * @param h The height of the region to show
14053     */
14054    EAPI void                         elm_web_region_bring_in(Evas_Object *obj, int x, int y, int w, int h);
14055    /**
14056     * Sets the default dialogs to use an Inwin instead of a normal window
14057     *
14058     * If set, then the default implementation for the JavaScript dialogs and
14059     * file selector will be opened in an Inwin. Otherwise they will use a
14060     * normal separated window.
14061     *
14062     * @param obj The web object
14063     * @param value EINA_TRUE to use Inwin, EINA_FALSE to use a normal window
14064     */
14065    EAPI void                         elm_web_inwin_mode_set(Evas_Object *obj, Eina_Bool value);
14066    /**
14067     * Gets whether Inwin mode is set for the current object
14068     *
14069     * @param obj The web object
14070     *
14071     * @return EINA_TRUE if Inwin mode is set, EINA_FALSE otherwise
14072     */
14073    EAPI Eina_Bool                    elm_web_inwin_mode_get(const Evas_Object *obj);
14074
14075    EAPI void                         elm_web_window_features_ref(Elm_Web_Window_Features *wf);
14076    EAPI void                         elm_web_window_features_unref(Elm_Web_Window_Features *wf);
14077    EAPI void                         elm_web_window_features_bool_property_get(const Elm_Web_Window_Features *wf, Eina_Bool *toolbar_visible, Eina_Bool *statusbar_visible, Eina_Bool *scrollbars_visible, Eina_Bool *menubar_visible, Eina_Bool *locationbar_visble, Eina_Bool *fullscreen);
14078    EAPI void                         elm_web_window_features_int_property_get(const Elm_Web_Window_Features *wf, int *x, int *y, int *w, int *h);
14079
14080    /**
14081     * @}
14082     */
14083
14084    /**
14085     * @defgroup Hoversel Hoversel
14086     *
14087     * @image html img/widget/hoversel/preview-00.png
14088     * @image latex img/widget/hoversel/preview-00.eps
14089     *
14090     * A hoversel is a button that pops up a list of items (automatically
14091     * choosing the direction to display) that have a label and, optionally, an
14092     * icon to select from. It is a convenience widget to avoid the need to do
14093     * all the piecing together yourself. It is intended for a small number of
14094     * items in the hoversel menu (no more than 8), though is capable of many
14095     * more.
14096     *
14097     * Signals that you can add callbacks for are:
14098     * "clicked" - the user clicked the hoversel button and popped up the sel
14099     * "selected" - an item in the hoversel list is selected. event_info is the item
14100     * "dismissed" - the hover is dismissed
14101     *
14102     * See @ref tutorial_hoversel for an example.
14103     * @{
14104     */
14105    typedef struct _Elm_Hoversel_Item Elm_Hoversel_Item; /**< Item of Elm_Hoversel. Sub-type of Elm_Widget_Item */
14106    /**
14107     * @brief Add a new Hoversel object
14108     *
14109     * @param parent The parent object
14110     * @return The new object or NULL if it cannot be created
14111     */
14112    EAPI Evas_Object       *elm_hoversel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14113    /**
14114     * @brief This sets the hoversel to expand horizontally.
14115     *
14116     * @param obj The hoversel object
14117     * @param horizontal If true, the hover will expand horizontally to the
14118     * right.
14119     *
14120     * @note The initial button will display horizontally regardless of this
14121     * setting.
14122     */
14123    EAPI void               elm_hoversel_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
14124    /**
14125     * @brief This returns whether the hoversel is set to expand horizontally.
14126     *
14127     * @param obj The hoversel object
14128     * @return If true, the hover will expand horizontally to the right.
14129     *
14130     * @see elm_hoversel_horizontal_set()
14131     */
14132    EAPI Eina_Bool          elm_hoversel_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14133    /**
14134     * @brief Set the Hover parent
14135     *
14136     * @param obj The hoversel object
14137     * @param parent The parent to use
14138     *
14139     * Sets the hover parent object, the area that will be darkened when the
14140     * hoversel is clicked. Should probably be the window that the hoversel is
14141     * in. See @ref Hover objects for more information.
14142     */
14143    EAPI void               elm_hoversel_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
14144    /**
14145     * @brief Get the Hover parent
14146     *
14147     * @param obj The hoversel object
14148     * @return The used parent
14149     *
14150     * Gets the hover parent object.
14151     *
14152     * @see elm_hoversel_hover_parent_set()
14153     */
14154    EAPI Evas_Object       *elm_hoversel_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14155    /**
14156     * @brief Set the hoversel button label
14157     *
14158     * @param obj The hoversel object
14159     * @param label The label text.
14160     *
14161     * This sets the label of the button that is always visible (before it is
14162     * clicked and expanded).
14163     *
14164     * @deprecated elm_object_text_set()
14165     */
14166    EINA_DEPRECATED EAPI void               elm_hoversel_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
14167    /**
14168     * @brief Get the hoversel button label
14169     *
14170     * @param obj The hoversel object
14171     * @return The label text.
14172     *
14173     * @deprecated elm_object_text_get()
14174     */
14175    EINA_DEPRECATED EAPI const char        *elm_hoversel_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14176    /**
14177     * @brief Set the icon of the hoversel button
14178     *
14179     * @param obj The hoversel object
14180     * @param icon The icon object
14181     *
14182     * Sets the icon of the button that is always visible (before it is clicked
14183     * and expanded).  Once the icon object is set, a previously set one will be
14184     * deleted, if you want to keep that old content object, use the
14185     * elm_hoversel_icon_unset() function.
14186     *
14187     * @see elm_object_content_set() for the button widget
14188     */
14189    EAPI void               elm_hoversel_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
14190    /**
14191     * @brief Get the icon of the hoversel button
14192     *
14193     * @param obj The hoversel object
14194     * @return The icon object
14195     *
14196     * Get the icon of the button that is always visible (before it is clicked
14197     * and expanded). Also see elm_object_content_get() for the button widget.
14198     *
14199     * @see elm_hoversel_icon_set()
14200     */
14201    EAPI Evas_Object       *elm_hoversel_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14202    /**
14203     * @brief Get and unparent the icon of the hoversel button
14204     *
14205     * @param obj The hoversel object
14206     * @return The icon object that was being used
14207     *
14208     * Unparent and return the icon of the button that is always visible
14209     * (before it is clicked and expanded).
14210     *
14211     * @see elm_hoversel_icon_set()
14212     * @see elm_object_content_unset() for the button widget
14213     */
14214    EAPI Evas_Object       *elm_hoversel_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
14215    /**
14216     * @brief This triggers the hoversel popup from code, the same as if the user
14217     * had clicked the button.
14218     *
14219     * @param obj The hoversel object
14220     */
14221    EAPI void               elm_hoversel_hover_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
14222    /**
14223     * @brief This dismisses the hoversel popup as if the user had clicked
14224     * outside the hover.
14225     *
14226     * @param obj The hoversel object
14227     */
14228    EAPI void               elm_hoversel_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
14229    /**
14230     * @brief Returns whether the hoversel is expanded.
14231     *
14232     * @param obj The hoversel object
14233     * @return  This will return EINA_TRUE if the hoversel is expanded or
14234     * EINA_FALSE if it is not expanded.
14235     */
14236    EAPI Eina_Bool          elm_hoversel_expanded_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14237    /**
14238     * @brief This will remove all the children items from the hoversel.
14239     *
14240     * @param obj The hoversel object
14241     *
14242     * @warning Should @b not be called while the hoversel is active; use
14243     * elm_hoversel_expanded_get() to check first.
14244     *
14245     * @see elm_hoversel_item_del_cb_set()
14246     * @see elm_hoversel_item_del()
14247     */
14248    EAPI void               elm_hoversel_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
14249    /**
14250     * @brief Get the list of items within the given hoversel.
14251     *
14252     * @param obj The hoversel object
14253     * @return Returns a list of Elm_Hoversel_Item*
14254     *
14255     * @see elm_hoversel_item_add()
14256     */
14257    EAPI const Eina_List   *elm_hoversel_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14258    /**
14259     * @brief Add an item to the hoversel button
14260     *
14261     * @param obj The hoversel object
14262     * @param label The text label to use for the item (NULL if not desired)
14263     * @param icon_file An image file path on disk to use for the icon or standard
14264     * icon name (NULL if not desired)
14265     * @param icon_type The icon type if relevant
14266     * @param func Convenience function to call when this item is selected
14267     * @param data Data to pass to item-related functions
14268     * @return A handle to the item added.
14269     *
14270     * This adds an item to the hoversel to show when it is clicked. Note: if you
14271     * need to use an icon from an edje file then use
14272     * elm_hoversel_item_icon_set() right after the this function, and set
14273     * icon_file to NULL here.
14274     *
14275     * For more information on what @p icon_file and @p icon_type are see the
14276     * @ref Icon "icon documentation".
14277     */
14278    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);
14279    /**
14280     * @brief Delete an item from the hoversel
14281     *
14282     * @param item The item to delete
14283     *
14284     * This deletes the item from the hoversel (should not be called while the
14285     * hoversel is active; use elm_hoversel_expanded_get() to check first).
14286     *
14287     * @see elm_hoversel_item_add()
14288     * @see elm_hoversel_item_del_cb_set()
14289     */
14290    EAPI void               elm_hoversel_item_del(Elm_Hoversel_Item *item) EINA_ARG_NONNULL(1);
14291    /**
14292     * @brief Set the function to be called when an item from the hoversel is
14293     * freed.
14294     *
14295     * @param item The item to set the callback on
14296     * @param func The function called
14297     *
14298     * That function will receive these parameters:
14299     * @li void *item_data
14300     * @li Evas_Object *the_item_object
14301     * @li Elm_Hoversel_Item *the_object_struct
14302     *
14303     * @see elm_hoversel_item_add()
14304     */
14305    EAPI void               elm_hoversel_item_del_cb_set(Elm_Hoversel_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
14306    /**
14307     * @brief This returns the data pointer supplied with elm_hoversel_item_add()
14308     * that will be passed to associated function callbacks.
14309     *
14310     * @param item The item to get the data from
14311     * @return The data pointer set with elm_hoversel_item_add()
14312     *
14313     * @see elm_hoversel_item_add()
14314     */
14315    EAPI void              *elm_hoversel_item_data_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
14316    /**
14317     * @brief This returns the label text of the given hoversel item.
14318     *
14319     * @param item The item to get the label
14320     * @return The label text of the hoversel item
14321     *
14322     * @see elm_hoversel_item_add()
14323     */
14324    EAPI const char        *elm_hoversel_item_label_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
14325    /**
14326     * @brief This sets the icon for the given hoversel item.
14327     *
14328     * @param item The item to set the icon
14329     * @param icon_file An image file path on disk to use for the icon or standard
14330     * icon name
14331     * @param icon_group The edje group to use if @p icon_file is an edje file. Set this
14332     * to NULL if the icon is not an edje file
14333     * @param icon_type The icon type
14334     *
14335     * The icon can be loaded from the standard set, from an image file, or from
14336     * an edje file.
14337     *
14338     * @see elm_hoversel_item_add()
14339     */
14340    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);
14341    /**
14342     * @brief Get the icon object of the hoversel item
14343     *
14344     * @param item The item to get the icon from
14345     * @param icon_file The image file path on disk used for the icon or standard
14346     * icon name
14347     * @param icon_group The edje group used if @p icon_file is an edje file. NULL
14348     * if the icon is not an edje file
14349     * @param icon_type The icon type
14350     *
14351     * @see elm_hoversel_item_icon_set()
14352     * @see elm_hoversel_item_add()
14353     */
14354    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);
14355    /**
14356     * @}
14357     */
14358
14359    /**
14360     * @defgroup Toolbar Toolbar
14361     * @ingroup Elementary
14362     *
14363     * @image html img/widget/toolbar/preview-00.png
14364     * @image latex img/widget/toolbar/preview-00.eps width=\textwidth
14365     *
14366     * @image html img/toolbar.png
14367     * @image latex img/toolbar.eps width=\textwidth
14368     *
14369     * A toolbar is a widget that displays a list of items inside
14370     * a box. It can be scrollable, show a menu with items that don't fit
14371     * to toolbar size or even crop them.
14372     *
14373     * Only one item can be selected at a time.
14374     *
14375     * Items can have multiple states, or show menus when selected by the user.
14376     *
14377     * Smart callbacks one can listen to:
14378     * - "clicked" - when the user clicks on a toolbar item and becomes selected.
14379     * - "language,changed" - when the program language changes
14380     *
14381     * Available styles for it:
14382     * - @c "default"
14383     * - @c "transparent" - no background or shadow, just show the content
14384     *
14385     * List of examples:
14386     * @li @ref toolbar_example_01
14387     * @li @ref toolbar_example_02
14388     * @li @ref toolbar_example_03
14389     */
14390
14391    /**
14392     * @addtogroup Toolbar
14393     * @{
14394     */
14395
14396    /**
14397     * @enum _Elm_Toolbar_Shrink_Mode
14398     * @typedef Elm_Toolbar_Shrink_Mode
14399     *
14400     * Set toolbar's items display behavior, it can be scrollabel,
14401     * show a menu with exceeding items, or simply hide them.
14402     *
14403     * @note Default value is #ELM_TOOLBAR_SHRINK_MENU. It reads value
14404     * from elm config.
14405     *
14406     * Values <b> don't </b> work as bitmask, only one can be choosen.
14407     *
14408     * @see elm_toolbar_mode_shrink_set()
14409     * @see elm_toolbar_mode_shrink_get()
14410     *
14411     * @ingroup Toolbar
14412     */
14413    typedef enum _Elm_Toolbar_Shrink_Mode
14414      {
14415         ELM_TOOLBAR_SHRINK_NONE,   /**< Set toolbar minimun size to fit all the items. */
14416         ELM_TOOLBAR_SHRINK_HIDE,   /**< Hide exceeding items. */
14417         ELM_TOOLBAR_SHRINK_SCROLL, /**< Allow accessing exceeding items through a scroller. */
14418         ELM_TOOLBAR_SHRINK_MENU,   /**< Inserts a button to pop up a menu with exceeding items. */
14419         ELM_TOOLBAR_SHRINK_LAST    /**< Indicates error if returned by elm_toolbar_shrink_mode_get() */
14420      } Elm_Toolbar_Shrink_Mode;
14421
14422    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(). */
14423
14424    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(). */
14425
14426    /**
14427     * Add a new toolbar widget to the given parent Elementary
14428     * (container) object.
14429     *
14430     * @param parent The parent object.
14431     * @return a new toolbar widget handle or @c NULL, on errors.
14432     *
14433     * This function inserts a new toolbar widget on the canvas.
14434     *
14435     * @ingroup Toolbar
14436     */
14437    EAPI Evas_Object            *elm_toolbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14438
14439    /**
14440     * Set the icon size, in pixels, to be used by toolbar items.
14441     *
14442     * @param obj The toolbar object
14443     * @param icon_size The icon size in pixels
14444     *
14445     * @note Default value is @c 32. It reads value from elm config.
14446     *
14447     * @see elm_toolbar_icon_size_get()
14448     *
14449     * @ingroup Toolbar
14450     */
14451    EAPI void                    elm_toolbar_icon_size_set(Evas_Object *obj, int icon_size) EINA_ARG_NONNULL(1);
14452
14453    /**
14454     * Get the icon size, in pixels, to be used by toolbar items.
14455     *
14456     * @param obj The toolbar object.
14457     * @return The icon size in pixels.
14458     *
14459     * @see elm_toolbar_icon_size_set() for details.
14460     *
14461     * @ingroup Toolbar
14462     */
14463    EAPI int                     elm_toolbar_icon_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14464
14465    /**
14466     * Sets icon lookup order, for toolbar items' icons.
14467     *
14468     * @param obj The toolbar object.
14469     * @param order The icon lookup order.
14470     *
14471     * Icons added before calling this function will not be affected.
14472     * The default lookup order is #ELM_ICON_LOOKUP_THEME_FDO.
14473     *
14474     * @see elm_toolbar_icon_order_lookup_get()
14475     *
14476     * @ingroup Toolbar
14477     */
14478    EAPI void                    elm_toolbar_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
14479
14480    /**
14481     * Gets the icon lookup order.
14482     *
14483     * @param obj The toolbar object.
14484     * @return The icon lookup order.
14485     *
14486     * @see elm_toolbar_icon_order_lookup_set() for details.
14487     *
14488     * @ingroup Toolbar
14489     */
14490    EAPI Elm_Icon_Lookup_Order   elm_toolbar_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14491
14492    /**
14493     * Set whether the toolbar should always have an item selected.
14494     *
14495     * @param obj The toolbar object.
14496     * @param wrap @c EINA_TRUE to enable always-select mode or @c EINA_FALSE to
14497     * disable it.
14498     *
14499     * This will cause the toolbar to always have an item selected, and clicking
14500     * the selected item will not cause a selected event to be emitted. Enabling this mode
14501     * will immediately select the first toolbar item.
14502     *
14503     * Always-selected is disabled by default.
14504     *
14505     * @see elm_toolbar_always_select_mode_get().
14506     *
14507     * @ingroup Toolbar
14508     */
14509    EAPI void                    elm_toolbar_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
14510
14511    /**
14512     * Get whether the toolbar should always have an item selected.
14513     *
14514     * @param obj The toolbar object.
14515     * @return @c EINA_TRUE means an item will always be selected, @c EINA_FALSE indicates
14516     * that it is possible to have no items selected. If @p obj is @c NULL, @c EINA_FALSE is returned.
14517     *
14518     * @see elm_toolbar_always_select_mode_set() for details.
14519     *
14520     * @ingroup Toolbar
14521     */
14522    EAPI Eina_Bool               elm_toolbar_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14523
14524    /**
14525     * Set whether the toolbar items' should be selected by the user or not.
14526     *
14527     * @param obj The toolbar object.
14528     * @param wrap @c EINA_TRUE to disable selection or @c EINA_FALSE to
14529     * enable it.
14530     *
14531     * This will turn off the ability to select items entirely and they will
14532     * neither appear selected nor emit selected signals. The clicked
14533     * callback function will still be called.
14534     *
14535     * Selection is enabled by default.
14536     *
14537     * @see elm_toolbar_no_select_mode_get().
14538     *
14539     * @ingroup Toolbar
14540     */
14541    EAPI void                    elm_toolbar_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
14542
14543    /**
14544     * Set whether the toolbar items' should be selected by the user or not.
14545     *
14546     * @param obj The toolbar object.
14547     * @return @c EINA_TRUE means items can be selected. @c EINA_FALSE indicates
14548     * they can't. If @p obj is @c NULL, @c EINA_FALSE is returned.
14549     *
14550     * @see elm_toolbar_no_select_mode_set() for details.
14551     *
14552     * @ingroup Toolbar
14553     */
14554    EAPI Eina_Bool               elm_toolbar_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14555
14556    /**
14557     * Append item to the toolbar.
14558     *
14559     * @param obj The toolbar object.
14560     * @param icon A string with icon name or the absolute path of an image file.
14561     * @param label The label of the item.
14562     * @param func The function to call when the item is clicked.
14563     * @param data The data to associate with the item for related callbacks.
14564     * @return The created item or @c NULL upon failure.
14565     *
14566     * A new item will be created and appended to the toolbar, i.e., will
14567     * be set as @b last item.
14568     *
14569     * Items created with this method can be deleted with
14570     * elm_toolbar_item_del().
14571     *
14572     * Associated @p data can be properly freed when item is deleted if a
14573     * callback function is set with elm_toolbar_item_del_cb_set().
14574     *
14575     * If a function is passed as argument, it will be called everytime this item
14576     * is selected, i.e., the user clicks over an unselected item.
14577     * If such function isn't needed, just passing
14578     * @c NULL as @p func is enough. The same should be done for @p data.
14579     *
14580     * Toolbar will load icon image from fdo or current theme.
14581     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14582     * If an absolute path is provided it will load it direct from a file.
14583     *
14584     * @see elm_toolbar_item_icon_set()
14585     * @see elm_toolbar_item_del()
14586     * @see elm_toolbar_item_del_cb_set()
14587     *
14588     * @ingroup Toolbar
14589     */
14590    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);
14591
14592    /**
14593     * Prepend item to the toolbar.
14594     *
14595     * @param obj The toolbar object.
14596     * @param icon A string with icon name or the absolute path of an image file.
14597     * @param label The label of the item.
14598     * @param func The function to call when the item is clicked.
14599     * @param data The data to associate with the item for related callbacks.
14600     * @return The created item or @c NULL upon failure.
14601     *
14602     * A new item will be created and prepended to the toolbar, i.e., will
14603     * be set as @b first item.
14604     *
14605     * Items created with this method can be deleted with
14606     * elm_toolbar_item_del().
14607     *
14608     * Associated @p data can be properly freed when item is deleted if a
14609     * callback function is set with elm_toolbar_item_del_cb_set().
14610     *
14611     * If a function is passed as argument, it will be called everytime this item
14612     * is selected, i.e., the user clicks over an unselected item.
14613     * If such function isn't needed, just passing
14614     * @c NULL as @p func is enough. The same should be done for @p data.
14615     *
14616     * Toolbar will load icon image from fdo or current theme.
14617     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14618     * If an absolute path is provided it will load it direct from a file.
14619     *
14620     * @see elm_toolbar_item_icon_set()
14621     * @see elm_toolbar_item_del()
14622     * @see elm_toolbar_item_del_cb_set()
14623     *
14624     * @ingroup Toolbar
14625     */
14626    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);
14627
14628    /**
14629     * Insert a new item into the toolbar object before item @p before.
14630     *
14631     * @param obj The toolbar object.
14632     * @param before The toolbar item to insert before.
14633     * @param icon A string with icon name or the absolute path of an image file.
14634     * @param label The label of the item.
14635     * @param func The function to call when the item is clicked.
14636     * @param data The data to associate with the item for related callbacks.
14637     * @return The created item or @c NULL upon failure.
14638     *
14639     * A new item will be created and added to the toolbar. Its position in
14640     * this toolbar will be just before item @p before.
14641     *
14642     * Items created with this method can be deleted with
14643     * elm_toolbar_item_del().
14644     *
14645     * Associated @p data can be properly freed when item is deleted if a
14646     * callback function is set with elm_toolbar_item_del_cb_set().
14647     *
14648     * If a function is passed as argument, it will be called everytime this item
14649     * is selected, i.e., the user clicks over an unselected item.
14650     * If such function isn't needed, just passing
14651     * @c NULL as @p func is enough. The same should be done for @p data.
14652     *
14653     * Toolbar will load icon image from fdo or current theme.
14654     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14655     * If an absolute path is provided it will load it direct from a file.
14656     *
14657     * @see elm_toolbar_item_icon_set()
14658     * @see elm_toolbar_item_del()
14659     * @see elm_toolbar_item_del_cb_set()
14660     *
14661     * @ingroup Toolbar
14662     */
14663    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);
14664
14665    /**
14666     * Insert a new item into the toolbar object after item @p after.
14667     *
14668     * @param obj The toolbar object.
14669     * @param after The toolbar item to insert after.
14670     * @param icon A string with icon name or the absolute path of an image file.
14671     * @param label The label of the item.
14672     * @param func The function to call when the item is clicked.
14673     * @param data The data to associate with the item for related callbacks.
14674     * @return The created item or @c NULL upon failure.
14675     *
14676     * A new item will be created and added to the toolbar. Its position in
14677     * this toolbar will be just after item @p after.
14678     *
14679     * Items created with this method can be deleted with
14680     * elm_toolbar_item_del().
14681     *
14682     * Associated @p data can be properly freed when item is deleted if a
14683     * callback function is set with elm_toolbar_item_del_cb_set().
14684     *
14685     * If a function is passed as argument, it will be called everytime this item
14686     * is selected, i.e., the user clicks over an unselected item.
14687     * If such function isn't needed, just passing
14688     * @c NULL as @p func is enough. The same should be done for @p data.
14689     *
14690     * Toolbar will load icon image from fdo or current theme.
14691     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14692     * If an absolute path is provided it will load it direct from a file.
14693     *
14694     * @see elm_toolbar_item_icon_set()
14695     * @see elm_toolbar_item_del()
14696     * @see elm_toolbar_item_del_cb_set()
14697     *
14698     * @ingroup Toolbar
14699     */
14700    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);
14701
14702    /**
14703     * Get the first item in the given toolbar widget's list of
14704     * items.
14705     *
14706     * @param obj The toolbar object
14707     * @return The first item or @c NULL, if it has no items (and on
14708     * errors)
14709     *
14710     * @see elm_toolbar_item_append()
14711     * @see elm_toolbar_last_item_get()
14712     *
14713     * @ingroup Toolbar
14714     */
14715    EAPI Elm_Toolbar_Item       *elm_toolbar_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14716
14717    /**
14718     * Get the last item in the given toolbar widget's list of
14719     * items.
14720     *
14721     * @param obj The toolbar object
14722     * @return The last item or @c NULL, if it has no items (and on
14723     * errors)
14724     *
14725     * @see elm_toolbar_item_prepend()
14726     * @see elm_toolbar_first_item_get()
14727     *
14728     * @ingroup Toolbar
14729     */
14730    EAPI Elm_Toolbar_Item       *elm_toolbar_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14731
14732    /**
14733     * Get the item after @p item in toolbar.
14734     *
14735     * @param item The toolbar item.
14736     * @return The item after @p item, or @c NULL if none or on failure.
14737     *
14738     * @note If it is the last item, @c NULL will be returned.
14739     *
14740     * @see elm_toolbar_item_append()
14741     *
14742     * @ingroup Toolbar
14743     */
14744    EAPI Elm_Toolbar_Item       *elm_toolbar_item_next_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14745
14746    /**
14747     * Get the item before @p item in toolbar.
14748     *
14749     * @param item The toolbar item.
14750     * @return The item before @p item, or @c NULL if none or on failure.
14751     *
14752     * @note If it is the first item, @c NULL will be returned.
14753     *
14754     * @see elm_toolbar_item_prepend()
14755     *
14756     * @ingroup Toolbar
14757     */
14758    EAPI Elm_Toolbar_Item       *elm_toolbar_item_prev_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14759
14760    /**
14761     * Get the toolbar object from an item.
14762     *
14763     * @param item The item.
14764     * @return The toolbar object.
14765     *
14766     * This returns the toolbar object itself that an item belongs to.
14767     *
14768     * @ingroup Toolbar
14769     */
14770    EAPI Evas_Object            *elm_toolbar_item_toolbar_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14771
14772    /**
14773     * Set the priority of a toolbar item.
14774     *
14775     * @param item The toolbar item.
14776     * @param priority The item priority. The default is zero.
14777     *
14778     * This is used only when the toolbar shrink mode is set to
14779     * #ELM_TOOLBAR_SHRINK_MENU or #ELM_TOOLBAR_SHRINK_HIDE.
14780     * When space is less than required, items with low priority
14781     * will be removed from the toolbar and added to a dynamically-created menu,
14782     * while items with higher priority will remain on the toolbar,
14783     * with the same order they were added.
14784     *
14785     * @see elm_toolbar_item_priority_get()
14786     *
14787     * @ingroup Toolbar
14788     */
14789    EAPI void                    elm_toolbar_item_priority_set(Elm_Toolbar_Item *item, int priority) EINA_ARG_NONNULL(1);
14790
14791    /**
14792     * Get the priority of a toolbar item.
14793     *
14794     * @param item The toolbar item.
14795     * @return The @p item priority, or @c 0 on failure.
14796     *
14797     * @see elm_toolbar_item_priority_set() for details.
14798     *
14799     * @ingroup Toolbar
14800     */
14801    EAPI int                     elm_toolbar_item_priority_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14802
14803    /**
14804     * Get the label of item.
14805     *
14806     * @param item The item of toolbar.
14807     * @return The label of item.
14808     *
14809     * The return value is a pointer to the label associated to @p item when
14810     * it was created, with function elm_toolbar_item_append() or similar,
14811     * or later,
14812     * with function elm_toolbar_item_label_set. If no label
14813     * was passed as argument, it will return @c NULL.
14814     *
14815     * @see elm_toolbar_item_label_set() for more details.
14816     * @see elm_toolbar_item_append()
14817     *
14818     * @ingroup Toolbar
14819     */
14820    EAPI const char             *elm_toolbar_item_label_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14821
14822    /**
14823     * Set the label of item.
14824     *
14825     * @param item The item of toolbar.
14826     * @param text The label of item.
14827     *
14828     * The label to be displayed by the item.
14829     * Label will be placed at icons bottom (if set).
14830     *
14831     * If a label was passed as argument on item creation, with function
14832     * elm_toolbar_item_append() or similar, it will be already
14833     * displayed by the item.
14834     *
14835     * @see elm_toolbar_item_label_get()
14836     * @see elm_toolbar_item_append()
14837     *
14838     * @ingroup Toolbar
14839     */
14840    EAPI void                    elm_toolbar_item_label_set(Elm_Toolbar_Item *item, const char *label) EINA_ARG_NONNULL(1);
14841
14842    /**
14843     * Return the data associated with a given toolbar widget item.
14844     *
14845     * @param item The toolbar widget item handle.
14846     * @return The data associated with @p item.
14847     *
14848     * @see elm_toolbar_item_data_set()
14849     *
14850     * @ingroup Toolbar
14851     */
14852    EAPI void                   *elm_toolbar_item_data_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14853
14854    /**
14855     * Set the data associated with a given toolbar widget item.
14856     *
14857     * @param item The toolbar widget item handle.
14858     * @param data The new data pointer to set to @p item.
14859     *
14860     * This sets new item data on @p item.
14861     *
14862     * @warning The old data pointer won't be touched by this function, so
14863     * the user had better to free that old data himself/herself.
14864     *
14865     * @ingroup Toolbar
14866     */
14867    EAPI void                    elm_toolbar_item_data_set(Elm_Toolbar_Item *item, const void *data) EINA_ARG_NONNULL(1);
14868
14869    /**
14870     * Returns a pointer to a toolbar item by its label.
14871     *
14872     * @param obj The toolbar object.
14873     * @param label The label of the item to find.
14874     *
14875     * @return The pointer to the toolbar item matching @p label or @c NULL
14876     * on failure.
14877     *
14878     * @ingroup Toolbar
14879     */
14880    EAPI Elm_Toolbar_Item       *elm_toolbar_item_find_by_label(const Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
14881
14882    /*
14883     * Get whether the @p item is selected or not.
14884     *
14885     * @param item The toolbar item.
14886     * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
14887     * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
14888     *
14889     * @see elm_toolbar_selected_item_set() for details.
14890     * @see elm_toolbar_item_selected_get()
14891     *
14892     * @ingroup Toolbar
14893     */
14894    EAPI Eina_Bool               elm_toolbar_item_selected_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14895
14896    /**
14897     * Set the selected state of an item.
14898     *
14899     * @param item The toolbar item
14900     * @param selected The selected state
14901     *
14902     * This sets the selected state of the given item @p it.
14903     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
14904     *
14905     * If a new item is selected the previosly selected will be unselected.
14906     * Previoulsy selected item can be get with function
14907     * elm_toolbar_selected_item_get().
14908     *
14909     * Selected items will be highlighted.
14910     *
14911     * @see elm_toolbar_item_selected_get()
14912     * @see elm_toolbar_selected_item_get()
14913     *
14914     * @ingroup Toolbar
14915     */
14916    EAPI void                    elm_toolbar_item_selected_set(Elm_Toolbar_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
14917
14918    /**
14919     * Get the selected item.
14920     *
14921     * @param obj The toolbar object.
14922     * @return The selected toolbar item.
14923     *
14924     * The selected item can be unselected with function
14925     * elm_toolbar_item_selected_set().
14926     *
14927     * The selected item always will be highlighted on toolbar.
14928     *
14929     * @see elm_toolbar_selected_items_get()
14930     *
14931     * @ingroup Toolbar
14932     */
14933    EAPI Elm_Toolbar_Item       *elm_toolbar_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14934
14935    /**
14936     * Set the icon associated with @p item.
14937     *
14938     * @param obj The parent of this item.
14939     * @param item The toolbar item.
14940     * @param icon A string with icon name or the absolute path of an image file.
14941     *
14942     * Toolbar will load icon image from fdo or current theme.
14943     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14944     * If an absolute path is provided it will load it direct from a file.
14945     *
14946     * @see elm_toolbar_icon_order_lookup_set()
14947     * @see elm_toolbar_icon_order_lookup_get()
14948     *
14949     * @ingroup Toolbar
14950     */
14951    EAPI void                    elm_toolbar_item_icon_set(Elm_Toolbar_Item *item, const char *icon) EINA_ARG_NONNULL(1);
14952
14953    /**
14954     * Get the string used to set the icon of @p item.
14955     *
14956     * @param item The toolbar item.
14957     * @return The string associated with the icon object.
14958     *
14959     * @see elm_toolbar_item_icon_set() for details.
14960     *
14961     * @ingroup Toolbar
14962     */
14963    EAPI const char             *elm_toolbar_item_icon_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14964
14965    /**
14966     * Get the object of @p item.
14967     *
14968     * @param item The toolbar item.
14969     * @return The object
14970     *
14971     * @ingroup Toolbar
14972     */
14973    EAPI Evas_Object            *elm_toolbar_item_object_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14974
14975    /**
14976     * Get the icon object of @p item.
14977     *
14978     * @param item The toolbar item.
14979     * @return The icon object
14980     *
14981     * @see elm_toolbar_item_icon_set() or elm_toolbar_item_icon_memfile_set() for details.
14982     *
14983     * @ingroup Toolbar
14984     */
14985    EAPI Evas_Object            *elm_toolbar_item_icon_object_get(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14986
14987    /**
14988     * Set the icon associated with @p item to an image in a binary buffer.
14989     *
14990     * @param item The toolbar item.
14991     * @param img The binary data that will be used as an image
14992     * @param size The size of binary data @p img
14993     * @param format Optional format of @p img to pass to the image loader
14994     * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
14995     *
14996     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
14997     *
14998     * @note The icon image set by this function can be changed by
14999     * elm_toolbar_item_icon_set().
15000     * 
15001     * @ingroup Toolbar
15002     */
15003    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);
15004
15005    /**
15006     * Delete them item from the toolbar.
15007     *
15008     * @param item The item of toolbar to be deleted.
15009     *
15010     * @see elm_toolbar_item_append()
15011     * @see elm_toolbar_item_del_cb_set()
15012     *
15013     * @ingroup Toolbar
15014     */
15015    EAPI void                    elm_toolbar_item_del(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15016
15017    /**
15018     * Set the function called when a toolbar item is freed.
15019     *
15020     * @param item The item to set the callback on.
15021     * @param func The function called.
15022     *
15023     * If there is a @p func, then it will be called prior item's memory release.
15024     * That will be called with the following arguments:
15025     * @li item's data;
15026     * @li item's Evas object;
15027     * @li item itself;
15028     *
15029     * This way, a data associated to a toolbar item could be properly freed.
15030     *
15031     * @ingroup Toolbar
15032     */
15033    EAPI void                    elm_toolbar_item_del_cb_set(Elm_Toolbar_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
15034
15035    /**
15036     * Get a value whether toolbar item is disabled or not.
15037     *
15038     * @param item The item.
15039     * @return The disabled state.
15040     *
15041     * @see elm_toolbar_item_disabled_set() for more details.
15042     *
15043     * @ingroup Toolbar
15044     */
15045    EAPI Eina_Bool               elm_toolbar_item_disabled_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15046
15047    /**
15048     * Sets the disabled/enabled state of a toolbar item.
15049     *
15050     * @param item The item.
15051     * @param disabled The disabled state.
15052     *
15053     * A disabled item cannot be selected or unselected. It will also
15054     * change its appearance (generally greyed out). This sets the
15055     * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
15056     * enabled).
15057     *
15058     * @ingroup Toolbar
15059     */
15060    EAPI void                    elm_toolbar_item_disabled_set(Elm_Toolbar_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
15061
15062    /**
15063     * Set or unset item as a separator.
15064     *
15065     * @param item The toolbar item.
15066     * @param setting @c EINA_TRUE to set item @p item as separator or
15067     * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
15068     *
15069     * Items aren't set as separator by default.
15070     *
15071     * If set as separator it will display separator theme, so won't display
15072     * icons or label.
15073     *
15074     * @see elm_toolbar_item_separator_get()
15075     *
15076     * @ingroup Toolbar
15077     */
15078    EAPI void                    elm_toolbar_item_separator_set(Elm_Toolbar_Item *item, Eina_Bool separator) EINA_ARG_NONNULL(1);
15079
15080    /**
15081     * Get a value whether item is a separator or not.
15082     *
15083     * @param item The toolbar item.
15084     * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
15085     * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
15086     *
15087     * @see elm_toolbar_item_separator_set() for details.
15088     *
15089     * @ingroup Toolbar
15090     */
15091    EAPI Eina_Bool               elm_toolbar_item_separator_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15092
15093    /**
15094     * Set the shrink state of toolbar @p obj.
15095     *
15096     * @param obj The toolbar object.
15097     * @param shrink_mode Toolbar's items display behavior.
15098     *
15099     * The toolbar won't scroll if #ELM_TOOLBAR_SHRINK_NONE,
15100     * but will enforce a minimun size so all the items will fit, won't scroll
15101     * and won't show the items that don't fit if #ELM_TOOLBAR_SHRINK_HIDE,
15102     * will scroll if #ELM_TOOLBAR_SHRINK_SCROLL, and will create a button to
15103     * pop up excess elements with #ELM_TOOLBAR_SHRINK_MENU.
15104     *
15105     * @ingroup Toolbar
15106     */
15107    EAPI void                    elm_toolbar_mode_shrink_set(Evas_Object *obj, Elm_Toolbar_Shrink_Mode shrink_mode) EINA_ARG_NONNULL(1);
15108
15109    /**
15110     * Get the shrink mode of toolbar @p obj.
15111     *
15112     * @param obj The toolbar object.
15113     * @return Toolbar's items display behavior.
15114     *
15115     * @see elm_toolbar_mode_shrink_set() for details.
15116     *
15117     * @ingroup Toolbar
15118     */
15119    EAPI Elm_Toolbar_Shrink_Mode elm_toolbar_mode_shrink_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15120
15121    /**
15122     * Enable/disable homogenous mode.
15123     *
15124     * @param obj The toolbar object
15125     * @param homogeneous Assume the items within the toolbar are of the
15126     * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
15127     *
15128     * This will enable the homogeneous mode where items are of the same size.
15129     * @see elm_toolbar_homogeneous_get()
15130     *
15131     * @ingroup Toolbar
15132     */
15133    EAPI void                    elm_toolbar_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
15134
15135    /**
15136     * Get whether the homogenous mode is enabled.
15137     *
15138     * @param obj The toolbar object.
15139     * @return Assume the items within the toolbar are of the same height
15140     * and width (EINA_TRUE = on, EINA_FALSE = off).
15141     *
15142     * @see elm_toolbar_homogeneous_set()
15143     *
15144     * @ingroup Toolbar
15145     */
15146    EAPI Eina_Bool               elm_toolbar_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15147
15148    /**
15149     * Enable/disable homogenous mode.
15150     *
15151     * @param obj The toolbar object
15152     * @param homogeneous Assume the items within the toolbar are of the
15153     * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
15154     *
15155     * This will enable the homogeneous mode where items are of the same size.
15156     * @see elm_toolbar_homogeneous_get()
15157     *
15158     * @deprecated use elm_toolbar_homogeneous_set() instead.
15159     *
15160     * @ingroup Toolbar
15161     */
15162    EINA_DEPRECATED EAPI void    elm_toolbar_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
15163
15164    /**
15165     * Get whether the homogenous mode is enabled.
15166     *
15167     * @param obj The toolbar object.
15168     * @return Assume the items within the toolbar are of the same height
15169     * and width (EINA_TRUE = on, EINA_FALSE = off).
15170     *
15171     * @see elm_toolbar_homogeneous_set()
15172     * @deprecated use elm_toolbar_homogeneous_get() instead.
15173     *
15174     * @ingroup Toolbar
15175     */
15176    EINA_DEPRECATED EAPI Eina_Bool elm_toolbar_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15177
15178    /**
15179     * Set the parent object of the toolbar items' menus.
15180     *
15181     * @param obj The toolbar object.
15182     * @param parent The parent of the menu objects.
15183     *
15184     * Each item can be set as item menu, with elm_toolbar_item_menu_set().
15185     *
15186     * For more details about setting the parent for toolbar menus, see
15187     * elm_menu_parent_set().
15188     *
15189     * @see elm_menu_parent_set() for details.
15190     * @see elm_toolbar_item_menu_set() for details.
15191     *
15192     * @ingroup Toolbar
15193     */
15194    EAPI void                    elm_toolbar_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
15195
15196    /**
15197     * Get the parent object of the toolbar items' menus.
15198     *
15199     * @param obj The toolbar object.
15200     * @return The parent of the menu objects.
15201     *
15202     * @see elm_toolbar_menu_parent_set() for details.
15203     *
15204     * @ingroup Toolbar
15205     */
15206    EAPI Evas_Object            *elm_toolbar_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15207
15208    /**
15209     * Set the alignment of the items.
15210     *
15211     * @param obj The toolbar object.
15212     * @param align The new alignment, a float between <tt> 0.0 </tt>
15213     * and <tt> 1.0 </tt>.
15214     *
15215     * Alignment of toolbar items, from <tt> 0.0 </tt> to indicates to align
15216     * left, to <tt> 1.0 </tt>, to align to right. <tt> 0.5 </tt> centralize
15217     * items.
15218     *
15219     * Centered items by default.
15220     *
15221     * @see elm_toolbar_align_get()
15222     *
15223     * @ingroup Toolbar
15224     */
15225    EAPI void                    elm_toolbar_align_set(Evas_Object *obj, double align) EINA_ARG_NONNULL(1);
15226
15227    /**
15228     * Get the alignment of the items.
15229     *
15230     * @param obj The toolbar object.
15231     * @return toolbar items alignment, a float between <tt> 0.0 </tt> and
15232     * <tt> 1.0 </tt>.
15233     *
15234     * @see elm_toolbar_align_set() for details.
15235     *
15236     * @ingroup Toolbar
15237     */
15238    EAPI double                  elm_toolbar_align_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15239
15240    /**
15241     * Set whether the toolbar item opens a menu.
15242     *
15243     * @param item The toolbar item.
15244     * @param menu If @c EINA_TRUE, @p item will opens a menu when selected.
15245     *
15246     * A toolbar item can be set to be a menu, using this function.
15247     *
15248     * Once it is set to be a menu, it can be manipulated through the
15249     * menu-like function elm_toolbar_menu_parent_set() and the other
15250     * elm_menu functions, using the Evas_Object @c menu returned by
15251     * elm_toolbar_item_menu_get().
15252     *
15253     * So, items to be displayed in this item's menu should be added with
15254     * elm_menu_item_add().
15255     *
15256     * The following code exemplifies the most basic usage:
15257     * @code
15258     * tb = elm_toolbar_add(win)
15259     * item = elm_toolbar_item_append(tb, "refresh", "Menu", NULL, NULL);
15260     * elm_toolbar_item_menu_set(item, EINA_TRUE);
15261     * elm_toolbar_menu_parent_set(tb, win);
15262     * menu = elm_toolbar_item_menu_get(item);
15263     * elm_menu_item_add(menu, NULL, "edit-cut", "Cut", NULL, NULL);
15264     * menu_item = elm_menu_item_add(menu, NULL, "edit-copy", "Copy", NULL,
15265     * NULL);
15266     * @endcode
15267     *
15268     * @see elm_toolbar_item_menu_get()
15269     *
15270     * @ingroup Toolbar
15271     */
15272    EAPI void                    elm_toolbar_item_menu_set(Elm_Toolbar_Item *item, Eina_Bool menu) EINA_ARG_NONNULL(1);
15273
15274    /**
15275     * Get toolbar item's menu.
15276     *
15277     * @param item The toolbar item.
15278     * @return Item's menu object or @c NULL on failure.
15279     *
15280     * If @p item wasn't set as menu item with elm_toolbar_item_menu_set(),
15281     * this function will set it.
15282     *
15283     * @see elm_toolbar_item_menu_set() for details.
15284     *
15285     * @ingroup Toolbar
15286     */
15287    EAPI Evas_Object            *elm_toolbar_item_menu_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15288
15289    /**
15290     * Add a new state to @p item.
15291     *
15292     * @param item The item.
15293     * @param icon A string with icon name or the absolute path of an image file.
15294     * @param label The label of the new state.
15295     * @param func The function to call when the item is clicked when this
15296     * state is selected.
15297     * @param data The data to associate with the state.
15298     * @return The toolbar item state, or @c NULL upon failure.
15299     *
15300     * Toolbar will load icon image from fdo or current theme.
15301     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
15302     * If an absolute path is provided it will load it direct from a file.
15303     *
15304     * States created with this function can be removed with
15305     * elm_toolbar_item_state_del().
15306     *
15307     * @see elm_toolbar_item_state_del()
15308     * @see elm_toolbar_item_state_sel()
15309     * @see elm_toolbar_item_state_get()
15310     *
15311     * @ingroup Toolbar
15312     */
15313    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);
15314
15315    /**
15316     * Delete a previoulsy added state to @p item.
15317     *
15318     * @param item The toolbar item.
15319     * @param state The state to be deleted.
15320     * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
15321     *
15322     * @see elm_toolbar_item_state_add()
15323     */
15324    EAPI Eina_Bool               elm_toolbar_item_state_del(Elm_Toolbar_Item *item, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
15325
15326    /**
15327     * Set @p state as the current state of @p it.
15328     *
15329     * @param it The item.
15330     * @param state The state to use.
15331     * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
15332     *
15333     * If @p state is @c NULL, it won't select any state and the default item's
15334     * icon and label will be used. It's the same behaviour than
15335     * elm_toolbar_item_state_unser().
15336     *
15337     * @see elm_toolbar_item_state_unset()
15338     *
15339     * @ingroup Toolbar
15340     */
15341    EAPI Eina_Bool               elm_toolbar_item_state_set(Elm_Toolbar_Item *it, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
15342
15343    /**
15344     * Unset the state of @p it.
15345     *
15346     * @param it The item.
15347     *
15348     * The default icon and label from this item will be displayed.
15349     *
15350     * @see elm_toolbar_item_state_set() for more details.
15351     *
15352     * @ingroup Toolbar
15353     */
15354    EAPI void                    elm_toolbar_item_state_unset(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15355
15356    /**
15357     * Get the current state of @p it.
15358     *
15359     * @param item The item.
15360     * @return The selected state or @c NULL if none is selected or on failure.
15361     *
15362     * @see elm_toolbar_item_state_set() for details.
15363     * @see elm_toolbar_item_state_unset()
15364     * @see elm_toolbar_item_state_add()
15365     *
15366     * @ingroup Toolbar
15367     */
15368    EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_get(const Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15369
15370    /**
15371     * Get the state after selected state in toolbar's @p item.
15372     *
15373     * @param it The toolbar item to change state.
15374     * @return The state after current state, or @c NULL on failure.
15375     *
15376     * If last state is selected, this function will return first state.
15377     *
15378     * @see elm_toolbar_item_state_set()
15379     * @see elm_toolbar_item_state_add()
15380     *
15381     * @ingroup Toolbar
15382     */
15383    EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_next(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15384
15385    /**
15386     * Get the state before selected state in toolbar's @p item.
15387     *
15388     * @param it The toolbar item to change state.
15389     * @return The state before current state, or @c NULL on failure.
15390     *
15391     * If first state is selected, this function will return last state.
15392     *
15393     * @see elm_toolbar_item_state_set()
15394     * @see elm_toolbar_item_state_add()
15395     *
15396     * @ingroup Toolbar
15397     */
15398    EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_prev(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15399
15400    /**
15401     * Set the text to be shown in a given toolbar item's tooltips.
15402     *
15403     * @param item Target item.
15404     * @param text The text to set in the content.
15405     *
15406     * Setup the text as tooltip to object. The item can have only one tooltip,
15407     * so any previous tooltip data - set with this function or
15408     * elm_toolbar_item_tooltip_content_cb_set() - is removed.
15409     *
15410     * @see elm_object_tooltip_text_set() for more details.
15411     *
15412     * @ingroup Toolbar
15413     */
15414    EAPI void             elm_toolbar_item_tooltip_text_set(Elm_Toolbar_Item *item, const char *text) EINA_ARG_NONNULL(1);
15415
15416    /**
15417     * Set the content to be shown in the tooltip item.
15418     *
15419     * Setup the tooltip to item. The item can have only one tooltip,
15420     * so any previous tooltip data is removed. @p func(with @p data) will
15421     * be called every time that need show the tooltip and it should
15422     * return a valid Evas_Object. This object is then managed fully by
15423     * tooltip system and is deleted when the tooltip is gone.
15424     *
15425     * @param item the toolbar item being attached a tooltip.
15426     * @param func the function used to create the tooltip contents.
15427     * @param data what to provide to @a func as callback data/context.
15428     * @param del_cb called when data is not needed anymore, either when
15429     *        another callback replaces @a func, the tooltip is unset with
15430     *        elm_toolbar_item_tooltip_unset() or the owner @a item
15431     *        dies. This callback receives as the first parameter the
15432     *        given @a data, and @c event_info is the item.
15433     *
15434     * @see elm_object_tooltip_content_cb_set() for more details.
15435     *
15436     * @ingroup Toolbar
15437     */
15438    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);
15439
15440    /**
15441     * Unset tooltip from item.
15442     *
15443     * @param item toolbar item to remove previously set tooltip.
15444     *
15445     * Remove tooltip from item. The callback provided as del_cb to
15446     * elm_toolbar_item_tooltip_content_cb_set() will be called to notify
15447     * it is not used anymore.
15448     *
15449     * @see elm_object_tooltip_unset() for more details.
15450     * @see elm_toolbar_item_tooltip_content_cb_set()
15451     *
15452     * @ingroup Toolbar
15453     */
15454    EAPI void             elm_toolbar_item_tooltip_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15455
15456    /**
15457     * Sets a different style for this item tooltip.
15458     *
15459     * @note before you set a style you should define a tooltip with
15460     *       elm_toolbar_item_tooltip_content_cb_set() or
15461     *       elm_toolbar_item_tooltip_text_set()
15462     *
15463     * @param item toolbar item with tooltip already set.
15464     * @param style the theme style to use (default, transparent, ...)
15465     *
15466     * @see elm_object_tooltip_style_set() for more details.
15467     *
15468     * @ingroup Toolbar
15469     */
15470    EAPI void             elm_toolbar_item_tooltip_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
15471
15472    /**
15473     * Get the style for this item tooltip.
15474     *
15475     * @param item toolbar item with tooltip already set.
15476     * @return style the theme style in use, defaults to "default". If the
15477     *         object does not have a tooltip set, then NULL is returned.
15478     *
15479     * @see elm_object_tooltip_style_get() for more details.
15480     * @see elm_toolbar_item_tooltip_style_set()
15481     *
15482     * @ingroup Toolbar
15483     */
15484    EAPI const char      *elm_toolbar_item_tooltip_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15485
15486    /**
15487     * Set the type of mouse pointer/cursor decoration to be shown,
15488     * when the mouse pointer is over the given toolbar widget item
15489     *
15490     * @param item toolbar item to customize cursor on
15491     * @param cursor the cursor type's name
15492     *
15493     * This function works analogously as elm_object_cursor_set(), but
15494     * here the cursor's changing area is restricted to the item's
15495     * area, and not the whole widget's. Note that that item cursors
15496     * have precedence over widget cursors, so that a mouse over an
15497     * item with custom cursor set will always show @b that cursor.
15498     *
15499     * If this function is called twice for an object, a previously set
15500     * cursor will be unset on the second call.
15501     *
15502     * @see elm_object_cursor_set()
15503     * @see elm_toolbar_item_cursor_get()
15504     * @see elm_toolbar_item_cursor_unset()
15505     *
15506     * @ingroup Toolbar
15507     */
15508    EAPI void             elm_toolbar_item_cursor_set(Elm_Toolbar_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
15509
15510    /*
15511     * Get the type of mouse pointer/cursor decoration set to be shown,
15512     * when the mouse pointer is over the given toolbar widget item
15513     *
15514     * @param item toolbar item with custom cursor set
15515     * @return the cursor type's name or @c NULL, if no custom cursors
15516     * were set to @p item (and on errors)
15517     *
15518     * @see elm_object_cursor_get()
15519     * @see elm_toolbar_item_cursor_set()
15520     * @see elm_toolbar_item_cursor_unset()
15521     *
15522     * @ingroup Toolbar
15523     */
15524    EAPI const char      *elm_toolbar_item_cursor_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15525
15526    /**
15527     * Unset any custom mouse pointer/cursor decoration set to be
15528     * shown, when the mouse pointer is over the given toolbar widget
15529     * item, thus making it show the @b default cursor again.
15530     *
15531     * @param item a toolbar item
15532     *
15533     * Use this call to undo any custom settings on this item's cursor
15534     * decoration, bringing it back to defaults (no custom style set).
15535     *
15536     * @see elm_object_cursor_unset()
15537     * @see elm_toolbar_item_cursor_set()
15538     *
15539     * @ingroup Toolbar
15540     */
15541    EAPI void             elm_toolbar_item_cursor_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15542
15543    /**
15544     * Set a different @b style for a given custom cursor set for a
15545     * toolbar item.
15546     *
15547     * @param item toolbar item with custom cursor set
15548     * @param style the <b>theme style</b> to use (e.g. @c "default",
15549     * @c "transparent", etc)
15550     *
15551     * This function only makes sense when one is using custom mouse
15552     * cursor decorations <b>defined in a theme file</b>, which can have,
15553     * given a cursor name/type, <b>alternate styles</b> on it. It
15554     * works analogously as elm_object_cursor_style_set(), but here
15555     * applyed only to toolbar item objects.
15556     *
15557     * @warning Before you set a cursor style you should have definen a
15558     *       custom cursor previously on the item, with
15559     *       elm_toolbar_item_cursor_set()
15560     *
15561     * @see elm_toolbar_item_cursor_engine_only_set()
15562     * @see elm_toolbar_item_cursor_style_get()
15563     *
15564     * @ingroup Toolbar
15565     */
15566    EAPI void             elm_toolbar_item_cursor_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
15567
15568    /**
15569     * Get the current @b style set for a given toolbar item's custom
15570     * cursor
15571     *
15572     * @param item toolbar item with custom cursor set.
15573     * @return style the cursor style in use. If the object does not
15574     *         have a cursor set, then @c NULL is returned.
15575     *
15576     * @see elm_toolbar_item_cursor_style_set() for more details
15577     *
15578     * @ingroup Toolbar
15579     */
15580    EAPI const char      *elm_toolbar_item_cursor_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15581
15582    /**
15583     * Set if the (custom)cursor for a given toolbar item should be
15584     * searched in its theme, also, or should only rely on the
15585     * rendering engine.
15586     *
15587     * @param item item with custom (custom) cursor already set on
15588     * @param engine_only Use @c EINA_TRUE to have cursors looked for
15589     * only on those provided by the rendering engine, @c EINA_FALSE to
15590     * have them searched on the widget's theme, as well.
15591     *
15592     * @note This call is of use only if you've set a custom cursor
15593     * for toolbar items, with elm_toolbar_item_cursor_set().
15594     *
15595     * @note By default, cursors will only be looked for between those
15596     * provided by the rendering engine.
15597     *
15598     * @ingroup Toolbar
15599     */
15600    EAPI void             elm_toolbar_item_cursor_engine_only_set(Elm_Toolbar_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
15601
15602    /**
15603     * Get if the (custom) cursor for a given toolbar item is being
15604     * searched in its theme, also, or is only relying on the rendering
15605     * engine.
15606     *
15607     * @param item a toolbar item
15608     * @return @c EINA_TRUE, if cursors are being looked for only on
15609     * those provided by the rendering engine, @c EINA_FALSE if they
15610     * are being searched on the widget's theme, as well.
15611     *
15612     * @see elm_toolbar_item_cursor_engine_only_set(), for more details
15613     *
15614     * @ingroup Toolbar
15615     */
15616    EAPI Eina_Bool        elm_toolbar_item_cursor_engine_only_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15617
15618    /**
15619     * Change a toolbar's orientation
15620     * @param obj The toolbar object
15621     * @param vertical If @c EINA_TRUE, the toolbar is vertical
15622     * By default, a toolbar will be horizontal. Use this function to create a vertical toolbar.
15623     * @ingroup Toolbar
15624     * @deprecated use elm_toolbar_horizontal_set() instead.
15625     */
15626    EINA_DEPRECATED EAPI void             elm_toolbar_orientation_set(Evas_Object *obj, Eina_Bool vertical) EINA_ARG_NONNULL(1);
15627
15628    /**
15629     * Change a toolbar's orientation
15630     * @param obj The toolbar object
15631     * @param horizontal If @c EINA_TRUE, the toolbar is horizontal
15632     * By default, a toolbar will be horizontal. Use this function to create a vertical toolbar.
15633     * @ingroup Toolbar
15634     */
15635    EAPI void             elm_toolbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
15636
15637    /**
15638     * Get a toolbar's orientation
15639     * @param obj The toolbar object
15640     * @return If @c EINA_TRUE, the toolbar is vertical
15641     * By default, a toolbar will be horizontal. Use this function to determine whether a toolbar is vertical.
15642     * @ingroup Toolbar
15643     * @deprecated use elm_toolbar_horizontal_get() instead.
15644     */
15645    EINA_DEPRECATED EAPI Eina_Bool        elm_toolbar_orientation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15646
15647    /**
15648     * Get a toolbar's orientation
15649     * @param obj The toolbar object
15650     * @return If @c EINA_TRUE, the toolbar is horizontal
15651     * By default, a toolbar will be horizontal. Use this function to determine whether a toolbar is vertical.
15652     * @ingroup Toolbar
15653     */
15654    EAPI Eina_Bool elm_toolbar_horizontal_get(const Evas_Object *obj);
15655    /**
15656     * @}
15657     */
15658
15659    /**
15660     * @defgroup Tooltips Tooltips
15661     *
15662     * The Tooltip is an (internal, for now) smart object used to show a
15663     * content in a frame on mouse hover of objects(or widgets), with
15664     * tips/information about them.
15665     *
15666     * @{
15667     */
15668
15669    EAPI double       elm_tooltip_delay_get(void);
15670    EAPI Eina_Bool    elm_tooltip_delay_set(double delay);
15671    EAPI void         elm_object_tooltip_show(Evas_Object *obj) EINA_ARG_NONNULL(1);
15672    EAPI void         elm_object_tooltip_hide(Evas_Object *obj) EINA_ARG_NONNULL(1);
15673    EAPI void         elm_object_tooltip_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1, 2);
15674    EAPI void         elm_object_tooltip_domain_translatable_text_set(Evas_Object *obj, const char *domain, const char *text) EINA_ARG_NONNULL(1, 3);
15675 #define elm_object_tooltip_translatable_text_set(obj, text) elm_object_tooltip_domain_translatable_text_set((obj), NULL, (text))
15676    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);
15677    EAPI void         elm_object_tooltip_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15678    EAPI void         elm_object_tooltip_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
15679    EAPI const char  *elm_object_tooltip_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15680    EAPI Eina_Bool    elm_tooltip_size_restrict_disable(Evas_Object *obj, Eina_Bool disable); EINA_ARG_NONNULL(1);
15681    EAPI Eina_Bool    elm_tooltip_size_restrict_disabled_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
15682
15683    /**
15684     * @}
15685     */
15686
15687    /**
15688     * @defgroup Cursors Cursors
15689     *
15690     * The Elementary cursor is an internal smart object used to
15691     * customize the mouse cursor displayed over objects (or
15692     * widgets). In the most common scenario, the cursor decoration
15693     * comes from the graphical @b engine Elementary is running
15694     * on. Those engines may provide different decorations for cursors,
15695     * and Elementary provides functions to choose them (think of X11
15696     * cursors, as an example).
15697     *
15698     * There's also the possibility of, besides using engine provided
15699     * cursors, also use ones coming from Edje theming files. Both
15700     * globally and per widget, Elementary makes it possible for one to
15701     * make the cursors lookup to be held on engines only or on
15702     * Elementary's theme file, too. To set cursor's hot spot,
15703     * two data items should be added to cursor's theme: "hot_x" and
15704     * "hot_y", that are the offset from upper-left corner of the cursor
15705     * (coordinates 0,0).
15706     *
15707     * @{
15708     */
15709
15710    /**
15711     * Set the cursor to be shown when mouse is over the object
15712     *
15713     * Set the cursor that will be displayed when mouse is over the
15714     * object. The object can have only one cursor set to it, so if
15715     * this function is called twice for an object, the previous set
15716     * will be unset.
15717     * If using X cursors, a definition of all the valid cursor names
15718     * is listed on Elementary_Cursors.h. If an invalid name is set
15719     * the default cursor will be used.
15720     *
15721     * @param obj the object being set a cursor.
15722     * @param cursor the cursor name to be used.
15723     *
15724     * @ingroup Cursors
15725     */
15726    EAPI void         elm_object_cursor_set(Evas_Object *obj, const char *cursor) EINA_ARG_NONNULL(1);
15727
15728    /**
15729     * Get the cursor to be shown when mouse is over the object
15730     *
15731     * @param obj an object with cursor already set.
15732     * @return the cursor name.
15733     *
15734     * @ingroup Cursors
15735     */
15736    EAPI const char  *elm_object_cursor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15737
15738    /**
15739     * Unset cursor for object
15740     *
15741     * Unset cursor for object, and set the cursor to default if the mouse
15742     * was over this object.
15743     *
15744     * @param obj Target object
15745     * @see elm_object_cursor_set()
15746     *
15747     * @ingroup Cursors
15748     */
15749    EAPI void         elm_object_cursor_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15750
15751    /**
15752     * Sets a different style for this object cursor.
15753     *
15754     * @note before you set a style you should define a cursor with
15755     *       elm_object_cursor_set()
15756     *
15757     * @param obj an object with cursor already set.
15758     * @param style the theme style to use (default, transparent, ...)
15759     *
15760     * @ingroup Cursors
15761     */
15762    EAPI void         elm_object_cursor_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
15763
15764    /**
15765     * Get the style for this object cursor.
15766     *
15767     * @param obj an object with cursor already set.
15768     * @return style the theme style in use, defaults to "default". If the
15769     *         object does not have a cursor set, then NULL is returned.
15770     *
15771     * @ingroup Cursors
15772     */
15773    EAPI const char  *elm_object_cursor_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15774
15775    /**
15776     * Set if the cursor set should be searched on the theme or should use
15777     * the provided by the engine, only.
15778     *
15779     * @note before you set if should look on theme you should define a cursor
15780     * with elm_object_cursor_set(). By default it will only look for cursors
15781     * provided by the engine.
15782     *
15783     * @param obj an object with cursor already set.
15784     * @param engine_only boolean to define it cursors should be looked only
15785     * between the provided by the engine or searched on widget's theme as well.
15786     *
15787     * @ingroup Cursors
15788     */
15789    EAPI void         elm_object_cursor_engine_only_set(Evas_Object *obj, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
15790
15791    /**
15792     * Get the cursor engine only usage for this object cursor.
15793     *
15794     * @param obj an object with cursor already set.
15795     * @return engine_only boolean to define it cursors should be
15796     * looked only between the provided by the engine or searched on
15797     * widget's theme as well. If the object does not have a cursor
15798     * set, then EINA_FALSE is returned.
15799     *
15800     * @ingroup Cursors
15801     */
15802    EAPI Eina_Bool    elm_object_cursor_engine_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15803
15804    /**
15805     * Get the configured cursor engine only usage
15806     *
15807     * This gets the globally configured exclusive usage of engine cursors.
15808     *
15809     * @return 1 if only engine cursors should be used
15810     * @ingroup Cursors
15811     */
15812    EAPI int          elm_cursor_engine_only_get(void);
15813
15814    /**
15815     * Set the configured cursor engine only usage
15816     *
15817     * This sets the globally configured exclusive usage of engine cursors.
15818     * It won't affect cursors set before changing this value.
15819     *
15820     * @param engine_only If 1 only engine cursors will be enabled, if 0 will
15821     * look for them on theme before.
15822     * @return EINA_TRUE if value is valid and setted (0 or 1)
15823     * @ingroup Cursors
15824     */
15825    EAPI Eina_Bool    elm_cursor_engine_only_set(int engine_only);
15826
15827    /**
15828     * @}
15829     */
15830
15831    /**
15832     * @defgroup Menu Menu
15833     *
15834     * @image html img/widget/menu/preview-00.png
15835     * @image latex img/widget/menu/preview-00.eps
15836     *
15837     * A menu is a list of items displayed above its parent. When the menu is
15838     * showing its parent is darkened. Each item can have a sub-menu. The menu
15839     * object can be used to display a menu on a right click event, in a toolbar,
15840     * anywhere.
15841     *
15842     * Signals that you can add callbacks for are:
15843     * @li "clicked" - the user clicked the empty space in the menu to dismiss.
15844     *             event_info is NULL.
15845     *
15846     * @see @ref tutorial_menu
15847     * @{
15848     */
15849    typedef struct _Elm_Menu_Item Elm_Menu_Item; /**< Item of Elm_Menu. Sub-type of Elm_Widget_Item */
15850    /**
15851     * @brief Add a new menu to the parent
15852     *
15853     * @param parent The parent object.
15854     * @return The new object or NULL if it cannot be created.
15855     */
15856    EAPI Evas_Object       *elm_menu_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
15857    /**
15858     * @brief Set the parent for the given menu widget
15859     *
15860     * @param obj The menu object.
15861     * @param parent The new parent.
15862     */
15863    EAPI void               elm_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
15864    /**
15865     * @brief Get the parent for the given menu widget
15866     *
15867     * @param obj The menu object.
15868     * @return The parent.
15869     *
15870     * @see elm_menu_parent_set()
15871     */
15872    EAPI Evas_Object       *elm_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15873    /**
15874     * @brief Move the menu to a new position
15875     *
15876     * @param obj The menu object.
15877     * @param x The new position.
15878     * @param y The new position.
15879     *
15880     * Sets the top-left position of the menu to (@p x,@p y).
15881     *
15882     * @note @p x and @p y coordinates are relative to parent.
15883     */
15884    EAPI void               elm_menu_move(Evas_Object *obj, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
15885    /**
15886     * @brief Close a opened menu
15887     *
15888     * @param obj the menu object
15889     * @return void
15890     *
15891     * Hides the menu and all it's sub-menus.
15892     */
15893    EAPI void               elm_menu_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
15894    /**
15895     * @brief Returns a list of @p item's items.
15896     *
15897     * @param obj The menu object
15898     * @return An Eina_List* of @p item's items
15899     */
15900    EAPI const Eina_List   *elm_menu_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15901    /**
15902     * @brief Get the Evas_Object of an Elm_Menu_Item
15903     *
15904     * @param item The menu item object.
15905     * @return The edje object containing the swallowed content
15906     *
15907     * @warning Don't manipulate this object!
15908     */
15909    EAPI Evas_Object       *elm_menu_item_object_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
15910    /**
15911     * @brief Add an item at the end of the given menu widget
15912     *
15913     * @param obj The menu object.
15914     * @param parent The parent menu item (optional)
15915     * @param icon A icon display on the item. The icon will be destryed by the menu.
15916     * @param label The label of the item.
15917     * @param func Function called when the user select the item.
15918     * @param data Data sent by the callback.
15919     * @return Returns the new item.
15920     */
15921    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);
15922    /**
15923     * @brief Add an object swallowed in an item at the end of the given menu
15924     * widget
15925     *
15926     * @param obj The menu object.
15927     * @param parent The parent menu item (optional)
15928     * @param subobj The object to swallow
15929     * @param func Function called when the user select the item.
15930     * @param data Data sent by the callback.
15931     * @return Returns the new item.
15932     *
15933     * Add an evas object as an item to the menu.
15934     */
15935    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);
15936    /**
15937     * @brief Set the label of a menu item
15938     *
15939     * @param item The menu item object.
15940     * @param label The label to set for @p item
15941     *
15942     * @warning Don't use this funcion on items created with
15943     * elm_menu_item_add_object() or elm_menu_item_separator_add().
15944     */
15945    EAPI void               elm_menu_item_label_set(Elm_Menu_Item *item, const char *label) EINA_ARG_NONNULL(1);
15946    /**
15947     * @brief Get the label of a menu item
15948     *
15949     * @param item The menu item object.
15950     * @return The label of @p item
15951     */
15952    EAPI const char        *elm_menu_item_label_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15953    /**
15954     * @brief Set the icon of a menu item to the standard icon with name @p icon
15955     *
15956     * @param item The menu item object.
15957     * @param icon The icon object to set for the content of @p item
15958     *
15959     * Once this icon is set, any previously set icon will be deleted.
15960     */
15961    EAPI void               elm_menu_item_object_icon_name_set(Elm_Menu_Item *item, const char *icon) EINA_ARG_NONNULL(1, 2);
15962    /**
15963     * @brief Get the string representation from the icon of a menu item
15964     *
15965     * @param item The menu item object.
15966     * @return The string representation of @p item's icon or NULL
15967     *
15968     * @see elm_menu_item_object_icon_name_set()
15969     */
15970    EAPI const char        *elm_menu_item_object_icon_name_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15971    /**
15972     * @brief Set the content object of a menu item
15973     *
15974     * @param item The menu item object
15975     * @param The content object or NULL
15976     * @return EINA_TRUE on success, else EINA_FALSE
15977     *
15978     * Use this function to change the object swallowed by a menu item, deleting
15979     * any previously swallowed object.
15980     */
15981    EAPI Eina_Bool          elm_menu_item_object_content_set(Elm_Menu_Item *item, Evas_Object *obj) EINA_ARG_NONNULL(1);
15982    /**
15983     * @brief Get the content object of a menu item
15984     *
15985     * @param item The menu item object
15986     * @return The content object or NULL
15987     * @note If @p item was added with elm_menu_item_add_object, this
15988     * function will return the object passed, else it will return the
15989     * icon object.
15990     *
15991     * @see elm_menu_item_object_content_set()
15992     */
15993    EAPI Evas_Object *elm_menu_item_object_content_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15994    /**
15995     * @brief Set the selected state of @p item.
15996     *
15997     * @param item The menu item object.
15998     * @param selected The selected/unselected state of the item
15999     */
16000    EAPI void               elm_menu_item_selected_set(Elm_Menu_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
16001    /**
16002     * @brief Get the selected state of @p item.
16003     *
16004     * @param item The menu item object.
16005     * @return The selected/unselected state of the item
16006     *
16007     * @see elm_menu_item_selected_set()
16008     */
16009    EAPI Eina_Bool          elm_menu_item_selected_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
16010    /**
16011     * @brief Set the disabled state of @p item.
16012     *
16013     * @param item The menu item object.
16014     * @param disabled The enabled/disabled state of the item
16015     */
16016    EAPI void               elm_menu_item_disabled_set(Elm_Menu_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
16017    /**
16018     * @brief Get the disabled state of @p item.
16019     *
16020     * @param item The menu item object.
16021     * @return The enabled/disabled state of the item
16022     *
16023     * @see elm_menu_item_disabled_set()
16024     */
16025    EAPI Eina_Bool          elm_menu_item_disabled_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
16026    /**
16027     * @brief Add a separator item to menu @p obj under @p parent.
16028     *
16029     * @param obj The menu object
16030     * @param parent The item to add the separator under
16031     * @return The created item or NULL on failure
16032     *
16033     * This is item is a @ref Separator.
16034     */
16035    EAPI Elm_Menu_Item     *elm_menu_item_separator_add(Evas_Object *obj, Elm_Menu_Item *parent) EINA_ARG_NONNULL(1);
16036    /**
16037     * @brief Returns whether @p item is a separator.
16038     *
16039     * @param item The item to check
16040     * @return If true, @p item is a separator
16041     *
16042     * @see elm_menu_item_separator_add()
16043     */
16044    EAPI Eina_Bool          elm_menu_item_is_separator(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
16045    /**
16046     * @brief Deletes an item from the menu.
16047     *
16048     * @param item The item to delete.
16049     *
16050     * @see elm_menu_item_add()
16051     */
16052    EAPI void               elm_menu_item_del(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
16053    /**
16054     * @brief Set the function called when a menu item is deleted.
16055     *
16056     * @param item The item to set the callback on
16057     * @param func The function called
16058     *
16059     * @see elm_menu_item_add()
16060     * @see elm_menu_item_del()
16061     */
16062    EAPI void               elm_menu_item_del_cb_set(Elm_Menu_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
16063    /**
16064     * @brief Returns the data associated with menu item @p item.
16065     *
16066     * @param item The item
16067     * @return The data associated with @p item or NULL if none was set.
16068     *
16069     * This is the data set with elm_menu_add() or elm_menu_item_data_set().
16070     */
16071    EAPI void              *elm_menu_item_data_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
16072    /**
16073     * @brief Sets the data to be associated with menu item @p item.
16074     *
16075     * @param item The item
16076     * @param data The data to be associated with @p item
16077     */
16078    EAPI void               elm_menu_item_data_set(Elm_Menu_Item *item, const void *data) EINA_ARG_NONNULL(1);
16079    /**
16080     * @brief Returns a list of @p item's subitems.
16081     *
16082     * @param item The item
16083     * @return An Eina_List* of @p item's subitems
16084     *
16085     * @see elm_menu_add()
16086     */
16087    EAPI const Eina_List   *elm_menu_item_subitems_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
16088    /**
16089     * @brief Get the position of a menu item
16090     *
16091     * @param item The menu item
16092     * @return The item's index
16093     *
16094     * This function returns the index position of a menu item in a menu.
16095     * For a sub-menu, this number is relative to the first item in the sub-menu.
16096     *
16097     * @note Index values begin with 0
16098     */
16099    EAPI unsigned int       elm_menu_item_index_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
16100    /**
16101     * @brief @brief Return a menu item's owner menu
16102     *
16103     * @param item The menu item
16104     * @return The menu object owning @p item, or NULL on failure
16105     *
16106     * Use this function to get the menu object owning an item.
16107     */
16108    EAPI Evas_Object       *elm_menu_item_menu_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
16109    /**
16110     * @brief Get the selected item in the menu
16111     *
16112     * @param obj The menu object
16113     * @return The selected item, or NULL if none
16114     *
16115     * @see elm_menu_item_selected_get()
16116     * @see elm_menu_item_selected_set()
16117     */
16118    EAPI Elm_Menu_Item *elm_menu_selected_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
16119    /**
16120     * @brief Get the last item in the menu
16121     *
16122     * @param obj The menu object
16123     * @return The last item, or NULL if none
16124     */
16125    EAPI Elm_Menu_Item *elm_menu_last_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
16126    /**
16127     * @brief Get the first item in the menu
16128     *
16129     * @param obj The menu object
16130     * @return The first item, or NULL if none
16131     */
16132    EAPI Elm_Menu_Item *elm_menu_first_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
16133    /**
16134     * @brief Get the next item in the menu.
16135     *
16136     * @param item The menu item object.
16137     * @return The item after it, or NULL if none
16138     */
16139    EAPI Elm_Menu_Item *elm_menu_item_next_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
16140    /**
16141     * @brief Get the previous item in the menu.
16142     *
16143     * @param item The menu item object.
16144     * @return The item before it, or NULL if none
16145     */
16146    EAPI Elm_Menu_Item *elm_menu_item_prev_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
16147    /**
16148     * @}
16149     */
16150
16151    /**
16152     * @defgroup List List
16153     * @ingroup Elementary
16154     *
16155     * @image html img/widget/list/preview-00.png
16156     * @image latex img/widget/list/preview-00.eps width=\textwidth
16157     *
16158     * @image html img/list.png
16159     * @image latex img/list.eps width=\textwidth
16160     *
16161     * A list widget is a container whose children are displayed vertically or
16162     * horizontally, in order, and can be selected.
16163     * The list can accept only one or multiple items selection. Also has many
16164     * modes of items displaying.
16165     *
16166     * A list is a very simple type of list widget.  For more robust
16167     * lists, @ref Genlist should probably be used.
16168     *
16169     * Smart callbacks one can listen to:
16170     * - @c "activated" - The user has double-clicked or pressed
16171     *   (enter|return|spacebar) on an item. The @c event_info parameter
16172     *   is the item that was activated.
16173     * - @c "clicked,double" - The user has double-clicked an item.
16174     *   The @c event_info parameter is the item that was double-clicked.
16175     * - "selected" - when the user selected an item
16176     * - "unselected" - when the user unselected an item
16177     * - "longpressed" - an item in the list is long-pressed
16178     * - "edge,top" - the list is scrolled until the top edge
16179     * - "edge,bottom" - the list is scrolled until the bottom edge
16180     * - "edge,left" - the list is scrolled until the left edge
16181     * - "edge,right" - the list is scrolled until the right edge
16182     * - "language,changed" - the program's language changed
16183     *
16184     * Available styles for it:
16185     * - @c "default"
16186     *
16187     * List of examples:
16188     * @li @ref list_example_01
16189     * @li @ref list_example_02
16190     * @li @ref list_example_03
16191     */
16192
16193    /**
16194     * @addtogroup List
16195     * @{
16196     */
16197
16198    /**
16199     * @enum _Elm_List_Mode
16200     * @typedef Elm_List_Mode
16201     *
16202     * Set list's resize behavior, transverse axis scroll and
16203     * items cropping. See each mode's description for more details.
16204     *
16205     * @note Default value is #ELM_LIST_SCROLL.
16206     *
16207     * Values <b> don't </b> work as bitmask, only one can be choosen.
16208     *
16209     * @see elm_list_mode_set()
16210     * @see elm_list_mode_get()
16211     *
16212     * @ingroup List
16213     */
16214    typedef enum _Elm_List_Mode
16215      {
16216         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. */
16217         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). */
16218         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. */
16219         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. */
16220         ELM_LIST_LAST /**< Indicates error if returned by elm_list_mode_get() */
16221      } Elm_List_Mode;
16222
16223    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().  */
16224
16225    /**
16226     * Add a new list widget to the given parent Elementary
16227     * (container) object.
16228     *
16229     * @param parent The parent object.
16230     * @return a new list widget handle or @c NULL, on errors.
16231     *
16232     * This function inserts a new list widget on the canvas.
16233     *
16234     * @ingroup List
16235     */
16236    EAPI Evas_Object     *elm_list_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16237
16238    /**
16239     * Starts the list.
16240     *
16241     * @param obj The list object
16242     *
16243     * @note Call before running show() on the list object.
16244     * @warning If not called, it won't display the list properly.
16245     *
16246     * @code
16247     * li = elm_list_add(win);
16248     * elm_list_item_append(li, "First", NULL, NULL, NULL, NULL);
16249     * elm_list_item_append(li, "Second", NULL, NULL, NULL, NULL);
16250     * elm_list_go(li);
16251     * evas_object_show(li);
16252     * @endcode
16253     *
16254     * @ingroup List
16255     */
16256    EAPI void             elm_list_go(Evas_Object *obj) EINA_ARG_NONNULL(1);
16257
16258    /**
16259     * Enable or disable multiple items selection on the list object.
16260     *
16261     * @param obj The list object
16262     * @param multi @c EINA_TRUE to enable multi selection or @c EINA_FALSE to
16263     * disable it.
16264     *
16265     * Disabled by default. If disabled, the user can select a single item of
16266     * the list each time. Selected items are highlighted on list.
16267     * If enabled, many items can be selected.
16268     *
16269     * If a selected item is selected again, it will be unselected.
16270     *
16271     * @see elm_list_multi_select_get()
16272     *
16273     * @ingroup List
16274     */
16275    EAPI void             elm_list_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
16276
16277    /**
16278     * Get a value whether multiple items selection is enabled or not.
16279     *
16280     * @see elm_list_multi_select_set() for details.
16281     *
16282     * @param obj The list object.
16283     * @return @c EINA_TRUE means multiple items selection is enabled.
16284     * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
16285     * @c EINA_FALSE is returned.
16286     *
16287     * @ingroup List
16288     */
16289    EAPI Eina_Bool        elm_list_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16290
16291    /**
16292     * Set which mode to use for the list object.
16293     *
16294     * @param obj The list object
16295     * @param mode One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
16296     * #ELM_LIST_LIMIT or #ELM_LIST_EXPAND.
16297     *
16298     * Set list's resize behavior, transverse axis scroll and
16299     * items cropping. See each mode's description for more details.
16300     *
16301     * @note Default value is #ELM_LIST_SCROLL.
16302     *
16303     * Only one can be set, if a previous one was set, it will be changed
16304     * by the new mode set. Bitmask won't work as well.
16305     *
16306     * @see elm_list_mode_get()
16307     *
16308     * @ingroup List
16309     */
16310    EAPI void             elm_list_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
16311
16312    /**
16313     * Get the mode the list is at.
16314     *
16315     * @param obj The list object
16316     * @return One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
16317     * #ELM_LIST_LIMIT, #ELM_LIST_EXPAND or #ELM_LIST_LAST on errors.
16318     *
16319     * @note see elm_list_mode_set() for more information.
16320     *
16321     * @ingroup List
16322     */
16323    EAPI Elm_List_Mode    elm_list_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16324
16325    /**
16326     * Enable or disable horizontal mode on the list object.
16327     *
16328     * @param obj The list object.
16329     * @param horizontal @c EINA_TRUE to enable horizontal or @c EINA_FALSE to
16330     * disable it, i.e., to enable vertical mode.
16331     *
16332     * @note Vertical mode is set by default.
16333     *
16334     * On horizontal mode items are displayed on list from left to right,
16335     * instead of from top to bottom. Also, the list will scroll horizontally.
16336     * Each item will presents left icon on top and right icon, or end, at
16337     * the bottom.
16338     *
16339     * @see elm_list_horizontal_get()
16340     *
16341     * @ingroup List
16342     */
16343    EAPI void             elm_list_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
16344
16345    /**
16346     * Get a value whether horizontal mode is enabled or not.
16347     *
16348     * @param obj The list object.
16349     * @return @c EINA_TRUE means horizontal mode selection is enabled.
16350     * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
16351     * @c EINA_FALSE is returned.
16352     *
16353     * @see elm_list_horizontal_set() for details.
16354     *
16355     * @ingroup List
16356     */
16357    EAPI Eina_Bool        elm_list_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16358
16359    /**
16360     * Enable or disable always select mode on the list object.
16361     *
16362     * @param obj The list object
16363     * @param always_select @c EINA_TRUE to enable always select mode or
16364     * @c EINA_FALSE to disable it.
16365     *
16366     * @note Always select mode is disabled by default.
16367     *
16368     * Default behavior of list items is to only call its callback function
16369     * the first time it's pressed, i.e., when it is selected. If a selected
16370     * item is pressed again, and multi-select is disabled, it won't call
16371     * this function (if multi-select is enabled it will unselect the item).
16372     *
16373     * If always select is enabled, it will call the callback function
16374     * everytime a item is pressed, so it will call when the item is selected,
16375     * and again when a selected item is pressed.
16376     *
16377     * @see elm_list_always_select_mode_get()
16378     * @see elm_list_multi_select_set()
16379     *
16380     * @ingroup List
16381     */
16382    EAPI void             elm_list_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
16383
16384    /**
16385     * Get a value whether always select mode is enabled or not, meaning that
16386     * an item will always call its callback function, even if already selected.
16387     *
16388     * @param obj The list object
16389     * @return @c EINA_TRUE means horizontal mode selection is enabled.
16390     * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
16391     * @c EINA_FALSE is returned.
16392     *
16393     * @see elm_list_always_select_mode_set() for details.
16394     *
16395     * @ingroup List
16396     */
16397    EAPI Eina_Bool        elm_list_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16398
16399    /**
16400     * Set bouncing behaviour when the scrolled content reaches an edge.
16401     *
16402     * Tell the internal scroller object whether it should bounce or not
16403     * when it reaches the respective edges for each axis.
16404     *
16405     * @param obj The list object
16406     * @param h_bounce Whether to bounce or not in the horizontal axis.
16407     * @param v_bounce Whether to bounce or not in the vertical axis.
16408     *
16409     * @see elm_scroller_bounce_set()
16410     *
16411     * @ingroup List
16412     */
16413    EAPI void             elm_list_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
16414
16415    /**
16416     * Get the bouncing behaviour of the internal scroller.
16417     *
16418     * Get whether the internal scroller should bounce when the edge of each
16419     * axis is reached scrolling.
16420     *
16421     * @param obj The list object.
16422     * @param h_bounce Pointer where to store the bounce state of the horizontal
16423     * axis.
16424     * @param v_bounce Pointer where to store the bounce state of the vertical
16425     * axis.
16426     *
16427     * @see elm_scroller_bounce_get()
16428     * @see elm_list_bounce_set()
16429     *
16430     * @ingroup List
16431     */
16432    EAPI void             elm_list_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
16433
16434    /**
16435     * Set the scrollbar policy.
16436     *
16437     * @param obj The list object
16438     * @param policy_h Horizontal scrollbar policy.
16439     * @param policy_v Vertical scrollbar policy.
16440     *
16441     * This sets the scrollbar visibility policy for the given scroller.
16442     * #ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it
16443     * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
16444     * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
16445     * This applies respectively for the horizontal and vertical scrollbars.
16446     *
16447     * The both are disabled by default, i.e., are set to
16448     * #ELM_SCROLLER_POLICY_OFF.
16449     *
16450     * @ingroup List
16451     */
16452    EAPI void             elm_list_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
16453
16454    /**
16455     * Get the scrollbar policy.
16456     *
16457     * @see elm_list_scroller_policy_get() for details.
16458     *
16459     * @param obj The list object.
16460     * @param policy_h Pointer where to store horizontal scrollbar policy.
16461     * @param policy_v Pointer where to store vertical scrollbar policy.
16462     *
16463     * @ingroup List
16464     */
16465    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);
16466
16467    /**
16468     * Append a new item to the list object.
16469     *
16470     * @param obj The list object.
16471     * @param label The label of the list item.
16472     * @param icon The icon object to use for the left side of the item. An
16473     * icon can be any Evas object, but usually it is an icon created
16474     * with elm_icon_add().
16475     * @param end The icon object to use for the right side of the item. An
16476     * icon can be any Evas object.
16477     * @param func The function to call when the item is clicked.
16478     * @param data The data to associate with the item for related callbacks.
16479     *
16480     * @return The created item or @c NULL upon failure.
16481     *
16482     * A new item will be created and appended to the list, i.e., will
16483     * be set as @b last item.
16484     *
16485     * Items created with this method can be deleted with
16486     * elm_list_item_del().
16487     *
16488     * Associated @p data can be properly freed when item is deleted if a
16489     * callback function is set with elm_list_item_del_cb_set().
16490     *
16491     * If a function is passed as argument, it will be called everytime this item
16492     * is selected, i.e., the user clicks over an unselected item.
16493     * If always select is enabled it will call this function every time
16494     * user clicks over an item (already selected or not).
16495     * If such function isn't needed, just passing
16496     * @c NULL as @p func is enough. The same should be done for @p data.
16497     *
16498     * Simple example (with no function callback or data associated):
16499     * @code
16500     * li = elm_list_add(win);
16501     * ic = elm_icon_add(win);
16502     * elm_icon_file_set(ic, "path/to/image", NULL);
16503     * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
16504     * elm_list_item_append(li, "label", ic, NULL, NULL, NULL);
16505     * elm_list_go(li);
16506     * evas_object_show(li);
16507     * @endcode
16508     *
16509     * @see elm_list_always_select_mode_set()
16510     * @see elm_list_item_del()
16511     * @see elm_list_item_del_cb_set()
16512     * @see elm_list_clear()
16513     * @see elm_icon_add()
16514     *
16515     * @ingroup List
16516     */
16517    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);
16518
16519    /**
16520     * Prepend a new item to the list object.
16521     *
16522     * @param obj The list object.
16523     * @param label The label of the list item.
16524     * @param icon The icon object to use for the left side of the item. An
16525     * icon can be any Evas object, but usually it is an icon created
16526     * with elm_icon_add().
16527     * @param end The icon object to use for the right side of the item. An
16528     * icon can be any Evas object.
16529     * @param func The function to call when the item is clicked.
16530     * @param data The data to associate with the item for related callbacks.
16531     *
16532     * @return The created item or @c NULL upon failure.
16533     *
16534     * A new item will be created and prepended to the list, i.e., will
16535     * be set as @b first item.
16536     *
16537     * Items created with this method can be deleted with
16538     * elm_list_item_del().
16539     *
16540     * Associated @p data can be properly freed when item is deleted if a
16541     * callback function is set with elm_list_item_del_cb_set().
16542     *
16543     * If a function is passed as argument, it will be called everytime this item
16544     * is selected, i.e., the user clicks over an unselected item.
16545     * If always select is enabled it will call this function every time
16546     * user clicks over an item (already selected or not).
16547     * If such function isn't needed, just passing
16548     * @c NULL as @p func is enough. The same should be done for @p data.
16549     *
16550     * @see elm_list_item_append() for a simple code example.
16551     * @see elm_list_always_select_mode_set()
16552     * @see elm_list_item_del()
16553     * @see elm_list_item_del_cb_set()
16554     * @see elm_list_clear()
16555     * @see elm_icon_add()
16556     *
16557     * @ingroup List
16558     */
16559    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);
16560
16561    /**
16562     * Insert a new item into the list object before item @p before.
16563     *
16564     * @param obj The list object.
16565     * @param before The list item to insert before.
16566     * @param label The label of the list item.
16567     * @param icon The icon object to use for the left side of the item. An
16568     * icon can be any Evas object, but usually it is an icon created
16569     * with elm_icon_add().
16570     * @param end The icon object to use for the right side of the item. An
16571     * icon can be any Evas object.
16572     * @param func The function to call when the item is clicked.
16573     * @param data The data to associate with the item for related callbacks.
16574     *
16575     * @return The created item or @c NULL upon failure.
16576     *
16577     * A new item will be created and added to the list. Its position in
16578     * this list will be just before item @p before.
16579     *
16580     * Items created with this method can be deleted with
16581     * elm_list_item_del().
16582     *
16583     * Associated @p data can be properly freed when item is deleted if a
16584     * callback function is set with elm_list_item_del_cb_set().
16585     *
16586     * If a function is passed as argument, it will be called everytime this item
16587     * is selected, i.e., the user clicks over an unselected item.
16588     * If always select is enabled it will call this function every time
16589     * user clicks over an item (already selected or not).
16590     * If such function isn't needed, just passing
16591     * @c NULL as @p func is enough. The same should be done for @p data.
16592     *
16593     * @see elm_list_item_append() for a simple code example.
16594     * @see elm_list_always_select_mode_set()
16595     * @see elm_list_item_del()
16596     * @see elm_list_item_del_cb_set()
16597     * @see elm_list_clear()
16598     * @see elm_icon_add()
16599     *
16600     * @ingroup List
16601     */
16602    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);
16603
16604    /**
16605     * Insert a new item into the list object after item @p after.
16606     *
16607     * @param obj The list object.
16608     * @param after The list item to insert after.
16609     * @param label The label of the list item.
16610     * @param icon The icon object to use for the left side of the item. An
16611     * icon can be any Evas object, but usually it is an icon created
16612     * with elm_icon_add().
16613     * @param end The icon object to use for the right side of the item. An
16614     * icon can be any Evas object.
16615     * @param func The function to call when the item is clicked.
16616     * @param data The data to associate with the item for related callbacks.
16617     *
16618     * @return The created item or @c NULL upon failure.
16619     *
16620     * A new item will be created and added to the list. Its position in
16621     * this list will be just after item @p after.
16622     *
16623     * Items created with this method can be deleted with
16624     * elm_list_item_del().
16625     *
16626     * Associated @p data can be properly freed when item is deleted if a
16627     * callback function is set with elm_list_item_del_cb_set().
16628     *
16629     * If a function is passed as argument, it will be called everytime this item
16630     * is selected, i.e., the user clicks over an unselected item.
16631     * If always select is enabled it will call this function every time
16632     * user clicks over an item (already selected or not).
16633     * If such function isn't needed, just passing
16634     * @c NULL as @p func is enough. The same should be done for @p data.
16635     *
16636     * @see elm_list_item_append() for a simple code example.
16637     * @see elm_list_always_select_mode_set()
16638     * @see elm_list_item_del()
16639     * @see elm_list_item_del_cb_set()
16640     * @see elm_list_clear()
16641     * @see elm_icon_add()
16642     *
16643     * @ingroup List
16644     */
16645    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);
16646
16647    /**
16648     * Insert a new item into the sorted list object.
16649     *
16650     * @param obj The list object.
16651     * @param label The label of the list item.
16652     * @param icon The icon object to use for the left side of the item. An
16653     * icon can be any Evas object, but usually it is an icon created
16654     * with elm_icon_add().
16655     * @param end The icon object to use for the right side of the item. An
16656     * icon can be any Evas object.
16657     * @param func The function to call when the item is clicked.
16658     * @param data The data to associate with the item for related callbacks.
16659     * @param cmp_func The comparing function to be used to sort list
16660     * items <b>by #Elm_List_Item item handles</b>. This function will
16661     * receive two items and compare them, returning a non-negative integer
16662     * if the second item should be place after the first, or negative value
16663     * if should be placed before.
16664     *
16665     * @return The created item or @c NULL upon failure.
16666     *
16667     * @note This function inserts values into a list object assuming it was
16668     * sorted and the result will be sorted.
16669     *
16670     * A new item will be created and added to the list. Its position in
16671     * this list will be found comparing the new item with previously inserted
16672     * items using function @p cmp_func.
16673     *
16674     * Items created with this method can be deleted with
16675     * elm_list_item_del().
16676     *
16677     * Associated @p data can be properly freed when item is deleted if a
16678     * callback function is set with elm_list_item_del_cb_set().
16679     *
16680     * If a function is passed as argument, it will be called everytime this item
16681     * is selected, i.e., the user clicks over an unselected item.
16682     * If always select is enabled it will call this function every time
16683     * user clicks over an item (already selected or not).
16684     * If such function isn't needed, just passing
16685     * @c NULL as @p func is enough. The same should be done for @p data.
16686     *
16687     * @see elm_list_item_append() for a simple code example.
16688     * @see elm_list_always_select_mode_set()
16689     * @see elm_list_item_del()
16690     * @see elm_list_item_del_cb_set()
16691     * @see elm_list_clear()
16692     * @see elm_icon_add()
16693     *
16694     * @ingroup List
16695     */
16696    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);
16697
16698    /**
16699     * Remove all list's items.
16700     *
16701     * @param obj The list object
16702     *
16703     * @see elm_list_item_del()
16704     * @see elm_list_item_append()
16705     *
16706     * @ingroup List
16707     */
16708    EAPI void             elm_list_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
16709
16710    /**
16711     * Get a list of all the list items.
16712     *
16713     * @param obj The list object
16714     * @return An @c Eina_List of list items, #Elm_List_Item,
16715     * or @c NULL on failure.
16716     *
16717     * @see elm_list_item_append()
16718     * @see elm_list_item_del()
16719     * @see elm_list_clear()
16720     *
16721     * @ingroup List
16722     */
16723    EAPI const Eina_List *elm_list_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16724
16725    /**
16726     * Get the selected item.
16727     *
16728     * @param obj The list object.
16729     * @return The selected list item.
16730     *
16731     * The selected item can be unselected with function
16732     * elm_list_item_selected_set().
16733     *
16734     * The selected item always will be highlighted on list.
16735     *
16736     * @see elm_list_selected_items_get()
16737     *
16738     * @ingroup List
16739     */
16740    EAPI Elm_List_Item   *elm_list_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16741
16742    /**
16743     * Return a list of the currently selected list items.
16744     *
16745     * @param obj The list object.
16746     * @return An @c Eina_List of list items, #Elm_List_Item,
16747     * or @c NULL on failure.
16748     *
16749     * Multiple items can be selected if multi select is enabled. It can be
16750     * done with elm_list_multi_select_set().
16751     *
16752     * @see elm_list_selected_item_get()
16753     * @see elm_list_multi_select_set()
16754     *
16755     * @ingroup List
16756     */
16757    EAPI const Eina_List *elm_list_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16758
16759    /**
16760     * Set the selected state of an item.
16761     *
16762     * @param item The list item
16763     * @param selected The selected state
16764     *
16765     * This sets the selected state of the given item @p it.
16766     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
16767     *
16768     * If a new item is selected the previosly selected will be unselected,
16769     * unless multiple selection is enabled with elm_list_multi_select_set().
16770     * Previoulsy selected item can be get with function
16771     * elm_list_selected_item_get().
16772     *
16773     * Selected items will be highlighted.
16774     *
16775     * @see elm_list_item_selected_get()
16776     * @see elm_list_selected_item_get()
16777     * @see elm_list_multi_select_set()
16778     *
16779     * @ingroup List
16780     */
16781    EAPI void             elm_list_item_selected_set(Elm_List_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
16782
16783    /*
16784     * Get whether the @p item is selected or not.
16785     *
16786     * @param item The list item.
16787     * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
16788     * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
16789     *
16790     * @see elm_list_selected_item_set() for details.
16791     * @see elm_list_item_selected_get()
16792     *
16793     * @ingroup List
16794     */
16795    EAPI Eina_Bool        elm_list_item_selected_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16796
16797    /**
16798     * Set or unset item as a separator.
16799     *
16800     * @param it The list item.
16801     * @param setting @c EINA_TRUE to set item @p it as separator or
16802     * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
16803     *
16804     * Items aren't set as separator by default.
16805     *
16806     * If set as separator it will display separator theme, so won't display
16807     * icons or label.
16808     *
16809     * @see elm_list_item_separator_get()
16810     *
16811     * @ingroup List
16812     */
16813    EAPI void             elm_list_item_separator_set(Elm_List_Item *it, Eina_Bool setting) EINA_ARG_NONNULL(1);
16814
16815    /**
16816     * Get a value whether item is a separator or not.
16817     *
16818     * @see elm_list_item_separator_set() for details.
16819     *
16820     * @param it The list item.
16821     * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
16822     * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
16823     *
16824     * @ingroup List
16825     */
16826    EAPI Eina_Bool        elm_list_item_separator_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
16827
16828    /**
16829     * Show @p item in the list view.
16830     *
16831     * @param item The list item to be shown.
16832     *
16833     * It won't animate list until item is visible. If such behavior is wanted,
16834     * use elm_list_bring_in() intead.
16835     *
16836     * @ingroup List
16837     */
16838    EAPI void             elm_list_item_show(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16839
16840    /**
16841     * Bring in the given item to list view.
16842     *
16843     * @param item The item.
16844     *
16845     * This causes list to jump to the given item @p item and show it
16846     * (by scrolling), if it is not fully visible.
16847     *
16848     * This may use animation to do so and take a period of time.
16849     *
16850     * If animation isn't wanted, elm_list_item_show() can be used.
16851     *
16852     * @ingroup List
16853     */
16854    EAPI void             elm_list_item_bring_in(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16855
16856    /**
16857     * Delete them item from the list.
16858     *
16859     * @param item The item of list to be deleted.
16860     *
16861     * If deleting all list items is required, elm_list_clear()
16862     * should be used instead of getting items list and deleting each one.
16863     *
16864     * @see elm_list_clear()
16865     * @see elm_list_item_append()
16866     * @see elm_list_item_del_cb_set()
16867     *
16868     * @ingroup List
16869     */
16870    EAPI void             elm_list_item_del(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16871
16872    /**
16873     * Set the function called when a list item is freed.
16874     *
16875     * @param item The item to set the callback on
16876     * @param func The function called
16877     *
16878     * If there is a @p func, then it will be called prior item's memory release.
16879     * That will be called with the following arguments:
16880     * @li item's data;
16881     * @li item's Evas object;
16882     * @li item itself;
16883     *
16884     * This way, a data associated to a list item could be properly freed.
16885     *
16886     * @ingroup List
16887     */
16888    EAPI void             elm_list_item_del_cb_set(Elm_List_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
16889
16890    /**
16891     * Get the data associated to the item.
16892     *
16893     * @param item The list item
16894     * @return The data associated to @p item
16895     *
16896     * The return value is a pointer to data associated to @p item when it was
16897     * created, with function elm_list_item_append() or similar. If no data
16898     * was passed as argument, it will return @c NULL.
16899     *
16900     * @see elm_list_item_append()
16901     *
16902     * @ingroup List
16903     */
16904    EAPI void            *elm_list_item_data_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16905
16906    /**
16907     * Get the left side icon associated to the item.
16908     *
16909     * @param item The list item
16910     * @return The left side icon associated to @p item
16911     *
16912     * The return value is a pointer to the icon associated to @p item when
16913     * it was
16914     * created, with function elm_list_item_append() or similar, or later
16915     * with function elm_list_item_icon_set(). If no icon
16916     * was passed as argument, it will return @c NULL.
16917     *
16918     * @see elm_list_item_append()
16919     * @see elm_list_item_icon_set()
16920     *
16921     * @ingroup List
16922     */
16923    EAPI Evas_Object     *elm_list_item_icon_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16924
16925    /**
16926     * Set the left side icon associated to the item.
16927     *
16928     * @param item The list item
16929     * @param icon The left side icon object to associate with @p item
16930     *
16931     * The icon object to use at left side of the item. An
16932     * icon can be any Evas object, but usually it is an icon created
16933     * with elm_icon_add().
16934     *
16935     * Once the icon object is set, a previously set one will be deleted.
16936     * @warning Setting the same icon for two items will cause the icon to
16937     * dissapear from the first item.
16938     *
16939     * If an icon was passed as argument on item creation, with function
16940     * elm_list_item_append() or similar, it will be already
16941     * associated to the item.
16942     *
16943     * @see elm_list_item_append()
16944     * @see elm_list_item_icon_get()
16945     *
16946     * @ingroup List
16947     */
16948    EAPI void             elm_list_item_icon_set(Elm_List_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
16949
16950    /**
16951     * Get the right side icon associated to the item.
16952     *
16953     * @param item The list item
16954     * @return The right side icon associated to @p item
16955     *
16956     * The return value is a pointer to the icon associated to @p item when
16957     * it was
16958     * created, with function elm_list_item_append() or similar, or later
16959     * with function elm_list_item_icon_set(). If no icon
16960     * was passed as argument, it will return @c NULL.
16961     *
16962     * @see elm_list_item_append()
16963     * @see elm_list_item_icon_set()
16964     *
16965     * @ingroup List
16966     */
16967    EAPI Evas_Object     *elm_list_item_end_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16968
16969    /**
16970     * Set the right side icon associated to the item.
16971     *
16972     * @param item The list item
16973     * @param end The right side icon object to associate with @p item
16974     *
16975     * The icon object to use at right side of the item. An
16976     * icon can be any Evas object, but usually it is an icon created
16977     * with elm_icon_add().
16978     *
16979     * Once the icon object is set, a previously set one will be deleted.
16980     * @warning Setting the same icon for two items will cause the icon to
16981     * dissapear from the first item.
16982     *
16983     * If an icon was passed as argument on item creation, with function
16984     * elm_list_item_append() or similar, it will be already
16985     * associated to the item.
16986     *
16987     * @see elm_list_item_append()
16988     * @see elm_list_item_end_get()
16989     *
16990     * @ingroup List
16991     */
16992    EAPI void             elm_list_item_end_set(Elm_List_Item *item, Evas_Object *end) EINA_ARG_NONNULL(1);
16993
16994    /**
16995     * Gets the base object of the item.
16996     *
16997     * @param item The list item
16998     * @return The base object associated with @p item
16999     *
17000     * Base object is the @c Evas_Object that represents that item.
17001     *
17002     * @ingroup List
17003     */
17004    EAPI Evas_Object     *elm_list_item_object_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17005    EINA_DEPRECATED EAPI Evas_Object     *elm_list_item_base_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17006
17007    /**
17008     * Get the label of item.
17009     *
17010     * @param item The item of list.
17011     * @return The label of item.
17012     *
17013     * The return value is a pointer to the label associated to @p item when
17014     * it was created, with function elm_list_item_append(), or later
17015     * with function elm_list_item_label_set. If no label
17016     * was passed as argument, it will return @c NULL.
17017     *
17018     * @see elm_list_item_label_set() for more details.
17019     * @see elm_list_item_append()
17020     *
17021     * @ingroup List
17022     */
17023    EAPI const char      *elm_list_item_label_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17024
17025    /**
17026     * Set the label of item.
17027     *
17028     * @param item The item of list.
17029     * @param text The label of item.
17030     *
17031     * The label to be displayed by the item.
17032     * Label will be placed between left and right side icons (if set).
17033     *
17034     * If a label was passed as argument on item creation, with function
17035     * elm_list_item_append() or similar, it will be already
17036     * displayed by the item.
17037     *
17038     * @see elm_list_item_label_get()
17039     * @see elm_list_item_append()
17040     *
17041     * @ingroup List
17042     */
17043    EAPI void             elm_list_item_label_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
17044
17045
17046    /**
17047     * Get the item before @p it in list.
17048     *
17049     * @param it The list item.
17050     * @return The item before @p it, or @c NULL if none or on failure.
17051     *
17052     * @note If it is the first item, @c NULL will be returned.
17053     *
17054     * @see elm_list_item_append()
17055     * @see elm_list_items_get()
17056     *
17057     * @ingroup List
17058     */
17059    EAPI Elm_List_Item   *elm_list_item_prev(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
17060
17061    /**
17062     * Get the item after @p it in list.
17063     *
17064     * @param it The list item.
17065     * @return The item after @p it, or @c NULL if none or on failure.
17066     *
17067     * @note If it is the last item, @c NULL will be returned.
17068     *
17069     * @see elm_list_item_append()
17070     * @see elm_list_items_get()
17071     *
17072     * @ingroup List
17073     */
17074    EAPI Elm_List_Item   *elm_list_item_next(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
17075
17076    /**
17077     * Sets the disabled/enabled state of a list item.
17078     *
17079     * @param it The item.
17080     * @param disabled The disabled state.
17081     *
17082     * A disabled item cannot be selected or unselected. It will also
17083     * change its appearance (generally greyed out). This sets the
17084     * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
17085     * enabled).
17086     *
17087     * @ingroup List
17088     */
17089    EAPI void             elm_list_item_disabled_set(Elm_List_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
17090
17091    /**
17092     * Get a value whether list item is disabled or not.
17093     *
17094     * @param it The item.
17095     * @return The disabled state.
17096     *
17097     * @see elm_list_item_disabled_set() for more details.
17098     *
17099     * @ingroup List
17100     */
17101    EAPI Eina_Bool        elm_list_item_disabled_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
17102
17103    /**
17104     * Set the text to be shown in a given list item's tooltips.
17105     *
17106     * @param item Target item.
17107     * @param text The text to set in the content.
17108     *
17109     * Setup the text as tooltip to object. The item can have only one tooltip,
17110     * so any previous tooltip data - set with this function or
17111     * elm_list_item_tooltip_content_cb_set() - is removed.
17112     *
17113     * @see elm_object_tooltip_text_set() for more details.
17114     *
17115     * @ingroup List
17116     */
17117    EAPI void             elm_list_item_tooltip_text_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
17118
17119
17120    /**
17121     * @brief Disable size restrictions on an object's tooltip
17122     * @param item The tooltip's anchor object
17123     * @param disable If EINA_TRUE, size restrictions are disabled
17124     * @return EINA_FALSE on failure, EINA_TRUE on success
17125     *
17126     * This function allows a tooltip to expand beyond its parant window's canvas.
17127     * It will instead be limited only by the size of the display.
17128     */
17129    EAPI Eina_Bool        elm_list_item_tooltip_size_restrict_disable(Elm_List_Item *item, Eina_Bool disable) EINA_ARG_NONNULL(1);
17130    /**
17131     * @brief Retrieve size restriction state of an object's tooltip
17132     * @param obj The tooltip's anchor object
17133     * @return If EINA_TRUE, size restrictions are disabled
17134     *
17135     * This function returns whether a tooltip is allowed to expand beyond
17136     * its parant window's canvas.
17137     * It will instead be limited only by the size of the display.
17138     */
17139    EAPI Eina_Bool        elm_list_item_tooltip_size_restrict_disabled_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17140
17141    /**
17142     * Set the content to be shown in the tooltip item.
17143     *
17144     * Setup the tooltip to item. The item can have only one tooltip,
17145     * so any previous tooltip data is removed. @p func(with @p data) will
17146     * be called every time that need show the tooltip and it should
17147     * return a valid Evas_Object. This object is then managed fully by
17148     * tooltip system and is deleted when the tooltip is gone.
17149     *
17150     * @param item the list item being attached a tooltip.
17151     * @param func the function used to create the tooltip contents.
17152     * @param data what to provide to @a func as callback data/context.
17153     * @param del_cb called when data is not needed anymore, either when
17154     *        another callback replaces @a func, the tooltip is unset with
17155     *        elm_list_item_tooltip_unset() or the owner @a item
17156     *        dies. This callback receives as the first parameter the
17157     *        given @a data, and @c event_info is the item.
17158     *
17159     * @see elm_object_tooltip_content_cb_set() for more details.
17160     *
17161     * @ingroup List
17162     */
17163    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);
17164
17165    /**
17166     * Unset tooltip from item.
17167     *
17168     * @param item list item to remove previously set tooltip.
17169     *
17170     * Remove tooltip from item. The callback provided as del_cb to
17171     * elm_list_item_tooltip_content_cb_set() will be called to notify
17172     * it is not used anymore.
17173     *
17174     * @see elm_object_tooltip_unset() for more details.
17175     * @see elm_list_item_tooltip_content_cb_set()
17176     *
17177     * @ingroup List
17178     */
17179    EAPI void             elm_list_item_tooltip_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
17180
17181    /**
17182     * Sets a different style for this item tooltip.
17183     *
17184     * @note before you set a style you should define a tooltip with
17185     *       elm_list_item_tooltip_content_cb_set() or
17186     *       elm_list_item_tooltip_text_set()
17187     *
17188     * @param item list item with tooltip already set.
17189     * @param style the theme style to use (default, transparent, ...)
17190     *
17191     * @see elm_object_tooltip_style_set() for more details.
17192     *
17193     * @ingroup List
17194     */
17195    EAPI void             elm_list_item_tooltip_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
17196
17197    /**
17198     * Get the style for this item tooltip.
17199     *
17200     * @param item list item with tooltip already set.
17201     * @return style the theme style in use, defaults to "default". If the
17202     *         object does not have a tooltip set, then NULL is returned.
17203     *
17204     * @see elm_object_tooltip_style_get() for more details.
17205     * @see elm_list_item_tooltip_style_set()
17206     *
17207     * @ingroup List
17208     */
17209    EAPI const char      *elm_list_item_tooltip_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17210
17211    /**
17212     * Set the type of mouse pointer/cursor decoration to be shown,
17213     * when the mouse pointer is over the given list widget item
17214     *
17215     * @param item list item to customize cursor on
17216     * @param cursor the cursor type's name
17217     *
17218     * This function works analogously as elm_object_cursor_set(), but
17219     * here the cursor's changing area is restricted to the item's
17220     * area, and not the whole widget's. Note that that item cursors
17221     * have precedence over widget cursors, so that a mouse over an
17222     * item with custom cursor set will always show @b that cursor.
17223     *
17224     * If this function is called twice for an object, a previously set
17225     * cursor will be unset on the second call.
17226     *
17227     * @see elm_object_cursor_set()
17228     * @see elm_list_item_cursor_get()
17229     * @see elm_list_item_cursor_unset()
17230     *
17231     * @ingroup List
17232     */
17233    EAPI void             elm_list_item_cursor_set(Elm_List_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
17234
17235    /*
17236     * Get the type of mouse pointer/cursor decoration set to be shown,
17237     * when the mouse pointer is over the given list widget item
17238     *
17239     * @param item list item with custom cursor set
17240     * @return the cursor type's name or @c NULL, if no custom cursors
17241     * were set to @p item (and on errors)
17242     *
17243     * @see elm_object_cursor_get()
17244     * @see elm_list_item_cursor_set()
17245     * @see elm_list_item_cursor_unset()
17246     *
17247     * @ingroup List
17248     */
17249    EAPI const char      *elm_list_item_cursor_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17250
17251    /**
17252     * Unset any custom mouse pointer/cursor decoration set to be
17253     * shown, when the mouse pointer is over the given list widget
17254     * item, thus making it show the @b default cursor again.
17255     *
17256     * @param item a list item
17257     *
17258     * Use this call to undo any custom settings on this item's cursor
17259     * decoration, bringing it back to defaults (no custom style set).
17260     *
17261     * @see elm_object_cursor_unset()
17262     * @see elm_list_item_cursor_set()
17263     *
17264     * @ingroup List
17265     */
17266    EAPI void             elm_list_item_cursor_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
17267
17268    /**
17269     * Set a different @b style for a given custom cursor set for a
17270     * list item.
17271     *
17272     * @param item list item with custom cursor set
17273     * @param style the <b>theme style</b> to use (e.g. @c "default",
17274     * @c "transparent", etc)
17275     *
17276     * This function only makes sense when one is using custom mouse
17277     * cursor decorations <b>defined in a theme file</b>, which can have,
17278     * given a cursor name/type, <b>alternate styles</b> on it. It
17279     * works analogously as elm_object_cursor_style_set(), but here
17280     * applyed only to list item objects.
17281     *
17282     * @warning Before you set a cursor style you should have definen a
17283     *       custom cursor previously on the item, with
17284     *       elm_list_item_cursor_set()
17285     *
17286     * @see elm_list_item_cursor_engine_only_set()
17287     * @see elm_list_item_cursor_style_get()
17288     *
17289     * @ingroup List
17290     */
17291    EAPI void             elm_list_item_cursor_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
17292
17293    /**
17294     * Get the current @b style set for a given list item's custom
17295     * cursor
17296     *
17297     * @param item list item with custom cursor set.
17298     * @return style the cursor style in use. If the object does not
17299     *         have a cursor set, then @c NULL is returned.
17300     *
17301     * @see elm_list_item_cursor_style_set() for more details
17302     *
17303     * @ingroup List
17304     */
17305    EAPI const char      *elm_list_item_cursor_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17306
17307    /**
17308     * Set if the (custom)cursor for a given list item should be
17309     * searched in its theme, also, or should only rely on the
17310     * rendering engine.
17311     *
17312     * @param item item with custom (custom) cursor already set on
17313     * @param engine_only Use @c EINA_TRUE to have cursors looked for
17314     * only on those provided by the rendering engine, @c EINA_FALSE to
17315     * have them searched on the widget's theme, as well.
17316     *
17317     * @note This call is of use only if you've set a custom cursor
17318     * for list items, with elm_list_item_cursor_set().
17319     *
17320     * @note By default, cursors will only be looked for between those
17321     * provided by the rendering engine.
17322     *
17323     * @ingroup List
17324     */
17325    EAPI void             elm_list_item_cursor_engine_only_set(Elm_List_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
17326
17327    /**
17328     * Get if the (custom) cursor for a given list item is being
17329     * searched in its theme, also, or is only relying on the rendering
17330     * engine.
17331     *
17332     * @param item a list item
17333     * @return @c EINA_TRUE, if cursors are being looked for only on
17334     * those provided by the rendering engine, @c EINA_FALSE if they
17335     * are being searched on the widget's theme, as well.
17336     *
17337     * @see elm_list_item_cursor_engine_only_set(), for more details
17338     *
17339     * @ingroup List
17340     */
17341    EAPI Eina_Bool        elm_list_item_cursor_engine_only_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17342
17343    /**
17344     * @}
17345     */
17346
17347    /**
17348     * @defgroup Slider Slider
17349     * @ingroup Elementary
17350     *
17351     * @image html img/widget/slider/preview-00.png
17352     * @image latex img/widget/slider/preview-00.eps width=\textwidth
17353     *
17354     * The slider adds a dragable ā€œsliderā€ widget for selecting the value of
17355     * something within a range.
17356     *
17357     * A slider can be horizontal or vertical. It can contain an Icon and has a
17358     * primary label as well as a units label (that is formatted with floating
17359     * point values and thus accepts a printf-style format string, like
17360     * ā€œ%1.2f unitsā€. There is also an indicator string that may be somewhere
17361     * else (like on the slider itself) that also accepts a format string like
17362     * units. Label, Icon Unit and Indicator strings/objects are optional.
17363     *
17364     * A slider may be inverted which means values invert, with high vales being
17365     * on the left or top and low values on the right or bottom (as opposed to
17366     * normally being low on the left or top and high on the bottom and right).
17367     *
17368     * The slider should have its minimum and maximum values set by the
17369     * application with  elm_slider_min_max_set() and value should also be set by
17370     * the application before use with  elm_slider_value_set(). The span of the
17371     * slider is its length (horizontally or vertically). This will be scaled by
17372     * the object or applications scaling factor. At any point code can query the
17373     * slider for its value with elm_slider_value_get().
17374     *
17375     * Smart callbacks one can listen to:
17376     * - "changed" - Whenever the slider value is changed by the user.
17377     * - "slider,drag,start" - dragging the slider indicator around has started.
17378     * - "slider,drag,stop" - dragging the slider indicator around has stopped.
17379     * - "delay,changed" - A short time after the value is changed by the user.
17380     * This will be called only when the user stops dragging for
17381     * a very short period or when they release their
17382     * finger/mouse, so it avoids possibly expensive reactions to
17383     * the value change.
17384     *
17385     * Available styles for it:
17386     * - @c "default"
17387     *
17388     * Default contents parts of the slider widget that you can use for are:
17389     * @li "elm.swallow.icon" - A icon of the slider
17390     * @li "elm.swallow.end" - A end part content of the slider
17391     * 
17392     * Here is an example on its usage:
17393     * @li @ref slider_example
17394     */
17395
17396 #define ELM_SLIDER_CONTENT_ICON "elm.swallow.icon"
17397 #define ELM_SLIDER_CONTENT_END "elm.swallow.end"
17398
17399    /**
17400     * @addtogroup Slider
17401     * @{
17402     */
17403
17404    /**
17405     * Add a new slider widget to the given parent Elementary
17406     * (container) object.
17407     *
17408     * @param parent The parent object.
17409     * @return a new slider widget handle or @c NULL, on errors.
17410     *
17411     * This function inserts a new slider widget on the canvas.
17412     *
17413     * @ingroup Slider
17414     */
17415    EAPI Evas_Object       *elm_slider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17416
17417    /**
17418     * Set the label of a given slider widget
17419     *
17420     * @param obj The progress bar object
17421     * @param label The text label string, in UTF-8
17422     *
17423     * @ingroup Slider
17424     * @deprecated use elm_object_text_set() instead.
17425     */
17426    EINA_DEPRECATED EAPI void               elm_slider_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
17427
17428    /**
17429     * Get the label of a given slider widget
17430     *
17431     * @param obj The progressbar object
17432     * @return The text label string, in UTF-8
17433     *
17434     * @ingroup Slider
17435     * @deprecated use elm_object_text_get() instead.
17436     */
17437    EINA_DEPRECATED EAPI const char        *elm_slider_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17438
17439    /**
17440     * Set the icon object of the slider object.
17441     *
17442     * @param obj The slider object.
17443     * @param icon The icon object.
17444     *
17445     * On horizontal mode, icon is placed at left, and on vertical mode,
17446     * placed at top.
17447     *
17448     * @note Once the icon object is set, a previously set one will be deleted.
17449     * If you want to keep that old content object, use the
17450     * elm_slider_icon_unset() function.
17451     *
17452     * @warning If the object being set does not have minimum size hints set,
17453     * it won't get properly displayed.
17454     *
17455     * @ingroup Slider
17456     * @deprecated use elm_object_content_set() instead.
17457     */
17458    EINA_DEPRECATED EAPI void               elm_slider_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
17459
17460    /**
17461     * Unset an icon set on a given slider widget.
17462     *
17463     * @param obj The slider object.
17464     * @return The icon object that was being used, if any was set, or
17465     * @c NULL, otherwise (and on errors).
17466     *
17467     * On horizontal mode, icon is placed at left, and on vertical mode,
17468     * placed at top.
17469     *
17470     * This call will unparent and return the icon object which was set
17471     * for this widget, previously, on success.
17472     *
17473     * @see elm_slider_icon_set() for more details
17474     * @see elm_slider_icon_get()
17475     * @deprecated use elm_object_content_unset() instead.
17476     *
17477     * @ingroup Slider
17478     */
17479    EINA_DEPRECATED EAPI Evas_Object       *elm_slider_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
17480
17481    /**
17482     * Retrieve the icon object set for a given slider widget.
17483     *
17484     * @param obj The slider object.
17485     * @return The icon object's handle, if @p obj had one set, or @c NULL,
17486     * otherwise (and on errors).
17487     *
17488     * On horizontal mode, icon is placed at left, and on vertical mode,
17489     * placed at top.
17490     *
17491     * @see elm_slider_icon_set() for more details
17492     * @see elm_slider_icon_unset()
17493     *
17494     * @deprecated use elm_object_content_set() instead.
17495     *
17496     * @ingroup Slider
17497     */
17498    EINA_DEPRECATED EAPI Evas_Object       *elm_slider_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17499
17500    /**
17501     * Set the end object of the slider object.
17502     *
17503     * @param obj The slider object.
17504     * @param end The end object.
17505     *
17506     * On horizontal mode, end is placed at left, and on vertical mode,
17507     * placed at bottom.
17508     *
17509     * @note Once the icon object is set, a previously set one will be deleted.
17510     * If you want to keep that old content object, use the
17511     * elm_slider_end_unset() function.
17512     *
17513     * @warning If the object being set does not have minimum size hints set,
17514     * it won't get properly displayed.
17515     *
17516     * @deprecated use elm_object_content_part_set(obj, "elm.swallow.end", end) instead.
17517     *
17518     * @ingroup Slider
17519     */
17520    EINA_DEPRECATED EAPI void               elm_slider_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1);
17521
17522    /**
17523     * Unset an end object set on a given slider widget.
17524     *
17525     * @param obj The slider object.
17526     * @return The end object that was being used, if any was set, or
17527     * @c NULL, otherwise (and on errors).
17528     *
17529     * On horizontal mode, end is placed at left, and on vertical mode,
17530     * placed at bottom.
17531     *
17532     * This call will unparent and return the icon object which was set
17533     * for this widget, previously, on success.
17534     *
17535     * @see elm_slider_end_set() for more details.
17536     * @see elm_slider_end_get()
17537     *
17538     * @deprecated use elm_object_content_part_unset(obj, "elm.swallow.end") instead.
17539     *
17540     * @ingroup Slider
17541     */
17542    EINA_DEPRECATED EAPI Evas_Object       *elm_slider_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
17543
17544    /**
17545     * Retrieve the end object set for a given slider widget.
17546     *
17547     * @param obj The slider object.
17548     * @return The end object's handle, if @p obj had one set, or @c NULL,
17549     * otherwise (and on errors).
17550     *
17551     * On horizontal mode, icon is placed at right, and on vertical mode,
17552     * placed at bottom.
17553     *
17554     * @see elm_slider_end_set() for more details.
17555     * @see elm_slider_end_unset()
17556     *
17557     * @ingroup Slider
17558     */
17559    EINA_DEPRECATED EAPI Evas_Object       *elm_slider_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17560
17561    /**
17562     * Set the (exact) length of the bar region of a given slider widget.
17563     *
17564     * @param obj The slider object.
17565     * @param size The length of the slider's bar region.
17566     *
17567     * This sets the minimum width (when in horizontal mode) or height
17568     * (when in vertical mode) of the actual bar area of the slider
17569     * @p obj. This in turn affects the object's minimum size. Use
17570     * this when you're not setting other size hints expanding on the
17571     * given direction (like weight and alignment hints) and you would
17572     * like it to have a specific size.
17573     *
17574     * @note Icon, end, label, indicator and unit text around @p obj
17575     * will require their
17576     * own space, which will make @p obj to require more the @p size,
17577     * actually.
17578     *
17579     * @see elm_slider_span_size_get()
17580     *
17581     * @ingroup Slider
17582     */
17583    EAPI void               elm_slider_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
17584
17585    /**
17586     * Get the length set for the bar region of a given slider widget
17587     *
17588     * @param obj The slider object.
17589     * @return The length of the slider's bar region.
17590     *
17591     * If that size was not set previously, with
17592     * elm_slider_span_size_set(), this call will return @c 0.
17593     *
17594     * @ingroup Slider
17595     */
17596    EAPI Evas_Coord         elm_slider_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17597
17598    /**
17599     * Set the format string for the unit label.
17600     *
17601     * @param obj The slider object.
17602     * @param format The format string for the unit display.
17603     *
17604     * Unit label is displayed all the time, if set, after slider's bar.
17605     * In horizontal mode, at right and in vertical mode, at bottom.
17606     *
17607     * If @c NULL, unit label won't be visible. If not it sets the format
17608     * string for the label text. To the label text is provided a floating point
17609     * value, so the label text can display up to 1 floating point value.
17610     * Note that this is optional.
17611     *
17612     * Use a format string such as "%1.2f meters" for example, and it will
17613     * display values like: "3.14 meters" for a value equal to 3.14159.
17614     *
17615     * Default is unit label disabled.
17616     *
17617     * @see elm_slider_indicator_format_get()
17618     *
17619     * @ingroup Slider
17620     */
17621    EAPI void               elm_slider_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
17622
17623    /**
17624     * Get the unit label format of the slider.
17625     *
17626     * @param obj The slider object.
17627     * @return The unit label format string in UTF-8.
17628     *
17629     * Unit label is displayed all the time, if set, after slider's bar.
17630     * In horizontal mode, at right and in vertical mode, at bottom.
17631     *
17632     * @see elm_slider_unit_format_set() for more
17633     * information on how this works.
17634     *
17635     * @ingroup Slider
17636     */
17637    EAPI const char        *elm_slider_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17638
17639    /**
17640     * Set the format string for the indicator label.
17641     *
17642     * @param obj The slider object.
17643     * @param indicator The format string for the indicator display.
17644     *
17645     * The slider may display its value somewhere else then unit label,
17646     * for example, above the slider knob that is dragged around. This function
17647     * sets the format string used for this.
17648     *
17649     * If @c NULL, indicator label won't be visible. If not it sets the format
17650     * string for the label text. To the label text is provided a floating point
17651     * value, so the label text can display up to 1 floating point value.
17652     * Note that this is optional.
17653     *
17654     * Use a format string such as "%1.2f meters" for example, and it will
17655     * display values like: "3.14 meters" for a value equal to 3.14159.
17656     *
17657     * Default is indicator label disabled.
17658     *
17659     * @see elm_slider_indicator_format_get()
17660     *
17661     * @ingroup Slider
17662     */
17663    EAPI void               elm_slider_indicator_format_set(Evas_Object *obj, const char *indicator) EINA_ARG_NONNULL(1);
17664
17665    /**
17666     * Get the indicator label format of the slider.
17667     *
17668     * @param obj The slider object.
17669     * @return The indicator label format string in UTF-8.
17670     *
17671     * The slider may display its value somewhere else then unit label,
17672     * for example, above the slider knob that is dragged around. This function
17673     * gets the format string used for this.
17674     *
17675     * @see elm_slider_indicator_format_set() for more
17676     * information on how this works.
17677     *
17678     * @ingroup Slider
17679     */
17680    EAPI const char        *elm_slider_indicator_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17681
17682    /**
17683     * Set the format function pointer for the indicator label
17684     *
17685     * @param obj The slider object.
17686     * @param func The indicator format function.
17687     * @param free_func The freeing function for the format string.
17688     *
17689     * Set the callback function to format the indicator string.
17690     *
17691     * @see elm_slider_indicator_format_set() for more info on how this works.
17692     *
17693     * @ingroup Slider
17694     */
17695   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);
17696
17697   /**
17698    * Set the format function pointer for the units label
17699    *
17700    * @param obj The slider object.
17701    * @param func The units format function.
17702    * @param free_func The freeing function for the format string.
17703    *
17704    * Set the callback function to format the indicator string.
17705    *
17706    * @see elm_slider_units_format_set() for more info on how this works.
17707    *
17708    * @ingroup Slider
17709    */
17710   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);
17711
17712   /**
17713    * Set the orientation of a given slider widget.
17714    *
17715    * @param obj The slider object.
17716    * @param horizontal Use @c EINA_TRUE to make @p obj to be
17717    * @b horizontal, @c EINA_FALSE to make it @b vertical.
17718    *
17719    * Use this function to change how your slider is to be
17720    * disposed: vertically or horizontally.
17721    *
17722    * By default it's displayed horizontally.
17723    *
17724    * @see elm_slider_horizontal_get()
17725    *
17726    * @ingroup Slider
17727    */
17728    EAPI void               elm_slider_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
17729
17730    /**
17731     * Retrieve the orientation of a given slider widget
17732     *
17733     * @param obj The slider object.
17734     * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
17735     * @c EINA_FALSE if it's @b vertical (and on errors).
17736     *
17737     * @see elm_slider_horizontal_set() for more details.
17738     *
17739     * @ingroup Slider
17740     */
17741    EAPI Eina_Bool          elm_slider_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17742
17743    /**
17744     * Set the minimum and maximum values for the slider.
17745     *
17746     * @param obj The slider object.
17747     * @param min The minimum value.
17748     * @param max The maximum value.
17749     *
17750     * Define the allowed range of values to be selected by the user.
17751     *
17752     * If actual value is less than @p min, it will be updated to @p min. If it
17753     * is bigger then @p max, will be updated to @p max. Actual value can be
17754     * get with elm_slider_value_get().
17755     *
17756     * By default, min is equal to 0.0, and max is equal to 1.0.
17757     *
17758     * @warning Maximum must be greater than minimum, otherwise behavior
17759     * is undefined.
17760     *
17761     * @see elm_slider_min_max_get()
17762     *
17763     * @ingroup Slider
17764     */
17765    EAPI void               elm_slider_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
17766
17767    /**
17768     * Get the minimum and maximum values of the slider.
17769     *
17770     * @param obj The slider object.
17771     * @param min Pointer where to store the minimum value.
17772     * @param max Pointer where to store the maximum value.
17773     *
17774     * @note If only one value is needed, the other pointer can be passed
17775     * as @c NULL.
17776     *
17777     * @see elm_slider_min_max_set() for details.
17778     *
17779     * @ingroup Slider
17780     */
17781    EAPI void               elm_slider_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
17782
17783    /**
17784     * Set the value the slider displays.
17785     *
17786     * @param obj The slider object.
17787     * @param val The value to be displayed.
17788     *
17789     * Value will be presented on the unit label following format specified with
17790     * elm_slider_unit_format_set() and on indicator with
17791     * elm_slider_indicator_format_set().
17792     *
17793     * @warning The value must to be between min and max values. This values
17794     * are set by elm_slider_min_max_set().
17795     *
17796     * @see elm_slider_value_get()
17797     * @see elm_slider_unit_format_set()
17798     * @see elm_slider_indicator_format_set()
17799     * @see elm_slider_min_max_set()
17800     *
17801     * @ingroup Slider
17802     */
17803    EAPI void               elm_slider_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
17804
17805    /**
17806     * Get the value displayed by the spinner.
17807     *
17808     * @param obj The spinner object.
17809     * @return The value displayed.
17810     *
17811     * @see elm_spinner_value_set() for details.
17812     *
17813     * @ingroup Slider
17814     */
17815    EAPI double             elm_slider_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17816
17817    /**
17818     * Invert a given slider widget's displaying values order
17819     *
17820     * @param obj The slider object.
17821     * @param inverted Use @c EINA_TRUE to make @p obj inverted,
17822     * @c EINA_FALSE to bring it back to default, non-inverted values.
17823     *
17824     * A slider may be @b inverted, in which state it gets its
17825     * values inverted, with high vales being on the left or top and
17826     * low values on the right or bottom, as opposed to normally have
17827     * the low values on the former and high values on the latter,
17828     * respectively, for horizontal and vertical modes.
17829     *
17830     * @see elm_slider_inverted_get()
17831     *
17832     * @ingroup Slider
17833     */
17834    EAPI void               elm_slider_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
17835
17836    /**
17837     * Get whether a given slider widget's displaying values are
17838     * inverted or not.
17839     *
17840     * @param obj The slider object.
17841     * @return @c EINA_TRUE, if @p obj has inverted values,
17842     * @c EINA_FALSE otherwise (and on errors).
17843     *
17844     * @see elm_slider_inverted_set() for more details.
17845     *
17846     * @ingroup Slider
17847     */
17848    EAPI Eina_Bool          elm_slider_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17849
17850    /**
17851     * Set whether to enlarge slider indicator (augmented knob) or not.
17852     *
17853     * @param obj The slider object.
17854     * @param show @c EINA_TRUE will make it enlarge, @c EINA_FALSE will
17855     * let the knob always at default size.
17856     *
17857     * By default, indicator will be bigger while dragged by the user.
17858     *
17859     * @warning It won't display values set with
17860     * elm_slider_indicator_format_set() if you disable indicator.
17861     *
17862     * @ingroup Slider
17863     */
17864    EAPI void               elm_slider_indicator_show_set(Evas_Object *obj, Eina_Bool show) EINA_ARG_NONNULL(1);
17865
17866    /**
17867     * Get whether a given slider widget's enlarging indicator or not.
17868     *
17869     * @param obj The slider object.
17870     * @return @c EINA_TRUE, if @p obj is enlarging indicator, or
17871     * @c EINA_FALSE otherwise (and on errors).
17872     *
17873     * @see elm_slider_indicator_show_set() for details.
17874     *
17875     * @ingroup Slider
17876     */
17877    EAPI Eina_Bool          elm_slider_indicator_show_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17878
17879    /**
17880     * @}
17881     */
17882
17883    /**
17884     * @addtogroup Actionslider Actionslider
17885     *
17886     * @image html img/widget/actionslider/preview-00.png
17887     * @image latex img/widget/actionslider/preview-00.eps
17888     *
17889     * An actionslider is a switcher for 2 or 3 labels with customizable magnet
17890     * properties. The user drags and releases the indicator, to choose a label.
17891     *
17892     * Labels occupy the following positions.
17893     * a. Left
17894     * b. Right
17895     * c. Center
17896     *
17897     * Positions can be enabled or disabled.
17898     *
17899     * Magnets can be set on the above positions.
17900     *
17901     * When the indicator is released, it will move to its nearest "enabled and magnetized" position.
17902     *
17903     * @note By default all positions are set as enabled.
17904     *
17905     * Signals that you can add callbacks for are:
17906     *
17907     * "selected" - when user selects an enabled position (the label is passed
17908     *              as event info)".
17909     * @n
17910     * "pos_changed" - when the indicator reaches any of the positions("left",
17911     *                 "right" or "center").
17912     *
17913     * See an example of actionslider usage @ref actionslider_example_page "here"
17914     * @{
17915     */
17916    typedef enum _Elm_Actionslider_Pos
17917      {
17918         ELM_ACTIONSLIDER_NONE = 0,
17919         ELM_ACTIONSLIDER_LEFT = 1 << 0,
17920         ELM_ACTIONSLIDER_CENTER = 1 << 1,
17921         ELM_ACTIONSLIDER_RIGHT = 1 << 2,
17922         ELM_ACTIONSLIDER_ALL = (1 << 3) -1
17923      } Elm_Actionslider_Pos;
17924
17925    /**
17926     * Add a new actionslider to the parent.
17927     *
17928     * @param parent The parent object
17929     * @return The new actionslider object or NULL if it cannot be created
17930     */
17931    EAPI Evas_Object          *elm_actionslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17932    /**
17933     * Set actionslider labels.
17934     *
17935     * @param obj The actionslider object
17936     * @param left_label The label to be set on the left.
17937     * @param center_label The label to be set on the center.
17938     * @param right_label The label to be set on the right.
17939     * @deprecated use elm_object_text_set() instead.
17940     */
17941    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);
17942    /**
17943     * Get actionslider labels.
17944     *
17945     * @param obj The actionslider object
17946     * @param left_label A char** to place the left_label of @p obj into.
17947     * @param center_label A char** to place the center_label of @p obj into.
17948     * @param right_label A char** to place the right_label of @p obj into.
17949     * @deprecated use elm_object_text_set() instead.
17950     */
17951    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);
17952    /**
17953     * Get actionslider selected label.
17954     *
17955     * @param obj The actionslider object
17956     * @return The selected label
17957     */
17958    EAPI const char           *elm_actionslider_selected_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17959    /**
17960     * Set actionslider indicator position.
17961     *
17962     * @param obj The actionslider object.
17963     * @param pos The position of the indicator.
17964     */
17965    EAPI void                  elm_actionslider_indicator_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
17966    /**
17967     * Get actionslider indicator position.
17968     *
17969     * @param obj The actionslider object.
17970     * @return The position of the indicator.
17971     */
17972    EAPI Elm_Actionslider_Pos  elm_actionslider_indicator_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17973    /**
17974     * Set actionslider magnet position. To make multiple positions magnets @c or
17975     * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT)
17976     *
17977     * @param obj The actionslider object.
17978     * @param pos Bit mask indicating the magnet positions.
17979     */
17980    EAPI void                  elm_actionslider_magnet_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
17981    /**
17982     * Get actionslider magnet position.
17983     *
17984     * @param obj The actionslider object.
17985     * @return The positions with magnet property.
17986     */
17987    EAPI Elm_Actionslider_Pos  elm_actionslider_magnet_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17988    /**
17989     * Set actionslider enabled position. To set multiple positions as enabled @c or
17990     * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT).
17991     *
17992     * @note All the positions are enabled by default.
17993     *
17994     * @param obj The actionslider object.
17995     * @param pos Bit mask indicating the enabled positions.
17996     */
17997    EAPI void                  elm_actionslider_enabled_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
17998    /**
17999     * Get actionslider enabled position.
18000     *
18001     * @param obj The actionslider object.
18002     * @return The enabled positions.
18003     */
18004    EAPI Elm_Actionslider_Pos  elm_actionslider_enabled_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18005    /**
18006     * Set the label used on the indicator.
18007     *
18008     * @param obj The actionslider object
18009     * @param label The label to be set on the indicator.
18010     * @deprecated use elm_object_text_set() instead.
18011     */
18012    EINA_DEPRECATED EAPI void                  elm_actionslider_indicator_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
18013    /**
18014     * Get the label used on the indicator object.
18015     *
18016     * @param obj The actionslider object
18017     * @return The indicator label
18018     * @deprecated use elm_object_text_get() instead.
18019     */
18020    EINA_DEPRECATED EAPI const char           *elm_actionslider_indicator_label_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
18021    /**
18022     * @}
18023     */
18024
18025    /**
18026     * @defgroup Genlist Genlist
18027     *
18028     * @image html img/widget/genlist/preview-00.png
18029     * @image latex img/widget/genlist/preview-00.eps
18030     * @image html img/genlist.png
18031     * @image latex img/genlist.eps
18032     *
18033     * This widget aims to have more expansive list than the simple list in
18034     * Elementary that could have more flexible items and allow many more entries
18035     * while still being fast and low on memory usage. At the same time it was
18036     * also made to be able to do tree structures. But the price to pay is more
18037     * complexity when it comes to usage. If all you want is a simple list with
18038     * icons and a single label, use the normal @ref List object.
18039     *
18040     * Genlist has a fairly large API, mostly because it's relatively complex,
18041     * trying to be both expansive, powerful and efficient. First we will begin
18042     * an overview on the theory behind genlist.
18043     *
18044     * @section Genlist_Item_Class Genlist item classes - creating items
18045     *
18046     * In order to have the ability to add and delete items on the fly, genlist
18047     * implements a class (callback) system where the application provides a
18048     * structure with information about that type of item (genlist may contain
18049     * multiple different items with different classes, states and styles).
18050     * Genlist will call the functions in this struct (methods) when an item is
18051     * "realized" (i.e., created dynamically, while the user is scrolling the
18052     * grid). All objects will simply be deleted when no longer needed with
18053     * evas_object_del(). The #Elm_Genlist_Item_Class structure contains the
18054     * following members:
18055     * - @c item_style - This is a constant string and simply defines the name
18056     *   of the item style. It @b must be specified and the default should be @c
18057     *   "default".
18058     *
18059     * - @c func - A struct with pointers to functions that will be called when
18060     *   an item is going to be actually created. All of them receive a @c data
18061     *   parameter that will point to the same data passed to
18062     *   elm_genlist_item_append() and related item creation functions, and a @c
18063     *   obj parameter that points to the genlist object itself.
18064     *
18065     * The function pointers inside @c func are @c label_get, @c icon_get, @c
18066     * state_get and @c del. The 3 first functions also receive a @c part
18067     * parameter described below. A brief description of these functions follows:
18068     *
18069     * - @c label_get - The @c part parameter is the name string of one of the
18070     *   existing text parts in the Edje group implementing the item's theme.
18071     *   This function @b must return a strdup'()ed string, as the caller will
18072     *   free() it when done. See #Elm_Genlist_Item_Label_Get_Cb.
18073     * - @c content_get - The @c part parameter is the name string of one of the
18074     *   existing (content) swallow parts in the Edje group implementing the item's
18075     *   theme. It must return @c NULL, when no content is desired, or a valid
18076     *   object handle, otherwise.  The object will be deleted by the genlist on
18077     *   its deletion or when the item is "unrealized".  See
18078     *   #Elm_Genlist_Item_Icon_Get_Cb.
18079     * - @c func.state_get - The @c part parameter is the name string of one of
18080     *   the state parts in the Edje group implementing the item's theme. Return
18081     *   @c EINA_FALSE for false/off or @c EINA_TRUE for true/on. Genlists will
18082     *   emit a signal to its theming Edje object with @c "elm,state,XXX,active"
18083     *   and @c "elm" as "emission" and "source" arguments, respectively, when
18084     *   the state is true (the default is false), where @c XXX is the name of
18085     *   the (state) part.  See #Elm_Genlist_Item_State_Get_Cb.
18086     * - @c func.del - This is intended for use when genlist items are deleted,
18087     *   so any data attached to the item (e.g. its data parameter on creation)
18088     *   can be deleted. See #Elm_Genlist_Item_Del_Cb.
18089     *
18090     * available item styles:
18091     * - default
18092     * - default_style - The text part is a textblock
18093     *
18094     * @image html img/widget/genlist/preview-04.png
18095     * @image latex img/widget/genlist/preview-04.eps
18096     *
18097     * - double_label
18098     *
18099     * @image html img/widget/genlist/preview-01.png
18100     * @image latex img/widget/genlist/preview-01.eps
18101     *
18102     * - icon_top_text_bottom
18103     *
18104     * @image html img/widget/genlist/preview-02.png
18105     * @image latex img/widget/genlist/preview-02.eps
18106     *
18107     * - group_index
18108     *
18109     * @image html img/widget/genlist/preview-03.png
18110     * @image latex img/widget/genlist/preview-03.eps
18111     *
18112     * @section Genlist_Items Structure of items
18113     *
18114     * An item in a genlist can have 0 or more text labels (they can be regular
18115     * text or textblock Evas objects - that's up to the style to determine), 0
18116     * or more contents (which are simply objects swallowed into the genlist item's
18117     * theming Edje object) and 0 or more <b>boolean states</b>, which have the
18118     * behavior left to the user to define. The Edje part names for each of
18119     * these properties will be looked up, in the theme file for the genlist,
18120     * under the Edje (string) data items named @c "labels", @c "contents" and @c
18121     * "states", respectively. For each of those properties, if more than one
18122     * part is provided, they must have names listed separated by spaces in the
18123     * data fields. For the default genlist item theme, we have @b one label
18124     * part (@c "elm.text"), @b two content parts (@c "elm.swalllow.icon" and @c
18125     * "elm.swallow.end") and @b no state parts.
18126     *
18127     * A genlist item may be at one of several styles. Elementary provides one
18128     * by default - "default", but this can be extended by system or application
18129     * custom themes/overlays/extensions (see @ref Theme "themes" for more
18130     * details).
18131     *
18132     * @section Genlist_Manipulation Editing and Navigating
18133     *
18134     * Items can be added by several calls. All of them return a @ref
18135     * Elm_Genlist_Item handle that is an internal member inside the genlist.
18136     * They all take a data parameter that is meant to be used for a handle to
18137     * the applications internal data (eg the struct with the original item
18138     * data). The parent parameter is the parent genlist item this belongs to if
18139     * it is a tree or an indexed group, and NULL if there is no parent. The
18140     * flags can be a bitmask of #ELM_GENLIST_ITEM_NONE,
18141     * #ELM_GENLIST_ITEM_SUBITEMS and #ELM_GENLIST_ITEM_GROUP. If
18142     * #ELM_GENLIST_ITEM_SUBITEMS is set then this item is displayed as an item
18143     * that is able to expand and have child items.  If ELM_GENLIST_ITEM_GROUP
18144     * is set then this item is group index item that is displayed at the top
18145     * until the next group comes. The func parameter is a convenience callback
18146     * that is called when the item is selected and the data parameter will be
18147     * the func_data parameter, obj be the genlist object and event_info will be
18148     * the genlist item.
18149     *
18150     * elm_genlist_item_append() adds an item to the end of the list, or if
18151     * there is a parent, to the end of all the child items of the parent.
18152     * elm_genlist_item_prepend() is the same but adds to the beginning of
18153     * the list or children list. elm_genlist_item_insert_before() inserts at
18154     * item before another item and elm_genlist_item_insert_after() inserts after
18155     * the indicated item.
18156     *
18157     * The application can clear the list with elm_genlist_clear() which deletes
18158     * all the items in the list and elm_genlist_item_del() will delete a specific
18159     * item. elm_genlist_item_subitems_clear() will clear all items that are
18160     * children of the indicated parent item.
18161     *
18162     * To help inspect list items you can jump to the item at the top of the list
18163     * with elm_genlist_first_item_get() which will return the item pointer, and
18164     * similarly elm_genlist_last_item_get() gets the item at the end of the list.
18165     * elm_genlist_item_next_get() and elm_genlist_item_prev_get() get the next
18166     * and previous items respectively relative to the indicated item. Using
18167     * these calls you can walk the entire item list/tree. Note that as a tree
18168     * the items are flattened in the list, so elm_genlist_item_parent_get() will
18169     * let you know which item is the parent (and thus know how to skip them if
18170     * wanted).
18171     *
18172     * @section Genlist_Muti_Selection Multi-selection
18173     *
18174     * If the application wants multiple items to be able to be selected,
18175     * elm_genlist_multi_select_set() can enable this. If the list is
18176     * single-selection only (the default), then elm_genlist_selected_item_get()
18177     * will return the selected item, if any, or NULL I none is selected. If the
18178     * list is multi-select then elm_genlist_selected_items_get() will return a
18179     * list (that is only valid as long as no items are modified (added, deleted,
18180     * selected or unselected)).
18181     *
18182     * @section Genlist_Usage_Hints Usage hints
18183     *
18184     * There are also convenience functions. elm_genlist_item_genlist_get() will
18185     * return the genlist object the item belongs to. elm_genlist_item_show()
18186     * will make the scroller scroll to show that specific item so its visible.
18187     * elm_genlist_item_data_get() returns the data pointer set by the item
18188     * creation functions.
18189     *
18190     * If an item changes (state of boolean changes, label or contents change),
18191     * then use elm_genlist_item_update() to have genlist update the item with
18192     * the new state. Genlist will re-realize the item thus call the functions
18193     * in the _Elm_Genlist_Item_Class for that item.
18194     *
18195     * To programmatically (un)select an item use elm_genlist_item_selected_set().
18196     * To get its selected state use elm_genlist_item_selected_get(). Similarly
18197     * to expand/contract an item and get its expanded state, use
18198     * elm_genlist_item_expanded_set() and elm_genlist_item_expanded_get(). And
18199     * again to make an item disabled (unable to be selected and appear
18200     * differently) use elm_genlist_item_disabled_set() to set this and
18201     * elm_genlist_item_disabled_get() to get the disabled state.
18202     *
18203     * In general to indicate how the genlist should expand items horizontally to
18204     * fill the list area, use elm_genlist_horizontal_set(). Valid modes are
18205     * ELM_LIST_LIMIT and ELM_LIST_SCROLL. The default is ELM_LIST_SCROLL. This
18206     * mode means that if items are too wide to fit, the scroller will scroll
18207     * horizontally. Otherwise items are expanded to fill the width of the
18208     * viewport of the scroller. If it is ELM_LIST_LIMIT, items will be expanded
18209     * to the viewport width and limited to that size. This can be combined with
18210     * a different style that uses edjes' ellipsis feature (cutting text off like
18211     * this: "tex...").
18212     *
18213     * Items will only call their selection func and callback when first becoming
18214     * selected. Any further clicks will do nothing, unless you enable always
18215     * select with elm_genlist_always_select_mode_set(). This means even if
18216     * selected, every click will make the selected callbacks be called.
18217     * elm_genlist_no_select_mode_set() will turn off the ability to select
18218     * items entirely and they will neither appear selected nor call selected
18219     * callback functions.
18220     *
18221     * Remember that you can create new styles and add your own theme augmentation
18222     * per application with elm_theme_extension_add(). If you absolutely must
18223     * have a specific style that overrides any theme the user or system sets up
18224     * you can use elm_theme_overlay_add() to add such a file.
18225     *
18226     * @section Genlist_Implementation Implementation
18227     *
18228     * Evas tracks every object you create. Every time it processes an event
18229     * (mouse move, down, up etc.) it needs to walk through objects and find out
18230     * what event that affects. Even worse every time it renders display updates,
18231     * in order to just calculate what to re-draw, it needs to walk through many
18232     * many many objects. Thus, the more objects you keep active, the more
18233     * overhead Evas has in just doing its work. It is advisable to keep your
18234     * active objects to the minimum working set you need. Also remember that
18235     * object creation and deletion carries an overhead, so there is a
18236     * middle-ground, which is not easily determined. But don't keep massive lists
18237     * of objects you can't see or use. Genlist does this with list objects. It
18238     * creates and destroys them dynamically as you scroll around. It groups them
18239     * into blocks so it can determine the visibility etc. of a whole block at
18240     * once as opposed to having to walk the whole list. This 2-level list allows
18241     * for very large numbers of items to be in the list (tests have used up to
18242     * 2,000,000 items). Also genlist employs a queue for adding items. As items
18243     * may be different sizes, every item added needs to be calculated as to its
18244     * size and thus this presents a lot of overhead on populating the list, this
18245     * genlist employs a queue. Any item added is queued and spooled off over
18246     * time, actually appearing some time later, so if your list has many members
18247     * you may find it takes a while for them to all appear, with your process
18248     * consuming a lot of CPU while it is busy spooling.
18249     *
18250     * Genlist also implements a tree structure, but it does so with callbacks to
18251     * the application, with the application filling in tree structures when
18252     * requested (allowing for efficient building of a very deep tree that could
18253     * even be used for file-management). See the above smart signal callbacks for
18254     * details.
18255     *
18256     * @section Genlist_Smart_Events Genlist smart events
18257     *
18258     * Signals that you can add callbacks for are:
18259     * - @c "activated" - The user has double-clicked or pressed
18260     *   (enter|return|spacebar) on an item. The @c event_info parameter is the
18261     *   item that was activated.
18262     * - @c "clicked,double" - The user has double-clicked an item.  The @c
18263     *   event_info parameter is the item that was double-clicked.
18264     * - @c "selected" - This is called when a user has made an item selected.
18265     *   The event_info parameter is the genlist item that was selected.
18266     * - @c "unselected" - This is called when a user has made an item
18267     *   unselected. The event_info parameter is the genlist item that was
18268     *   unselected.
18269     * - @c "expanded" - This is called when elm_genlist_item_expanded_set() is
18270     *   called and the item is now meant to be expanded. The event_info
18271     *   parameter is the genlist item that was indicated to expand.  It is the
18272     *   job of this callback to then fill in the child items.
18273     * - @c "contracted" - This is called when elm_genlist_item_expanded_set() is
18274     *   called and the item is now meant to be contracted. The event_info
18275     *   parameter is the genlist item that was indicated to contract. It is the
18276     *   job of this callback to then delete the child items.
18277     * - @c "expand,request" - This is called when a user has indicated they want
18278     *   to expand a tree branch item. The callback should decide if the item can
18279     *   expand (has any children) and then call elm_genlist_item_expanded_set()
18280     *   appropriately to set the state. The event_info parameter is the genlist
18281     *   item that was indicated to expand.
18282     * - @c "contract,request" - This is called when a user has indicated they
18283     *   want to contract a tree branch item. The callback should decide if the
18284     *   item can contract (has any children) and then call
18285     *   elm_genlist_item_expanded_set() appropriately to set the state. The
18286     *   event_info parameter is the genlist item that was indicated to contract.
18287     * - @c "realized" - This is called when the item in the list is created as a
18288     *   real evas object. event_info parameter is the genlist item that was
18289     *   created. The object may be deleted at any time, so it is up to the
18290     *   caller to not use the object pointer from elm_genlist_item_object_get()
18291     *   in a way where it may point to freed objects.
18292     * - @c "unrealized" - This is called just before an item is unrealized.
18293     *   After this call content objects provided will be deleted and the item
18294     *   object itself delete or be put into a floating cache.
18295     * - @c "drag,start,up" - This is called when the item in the list has been
18296     *   dragged (not scrolled) up.
18297     * - @c "drag,start,down" - This is called when the item in the list has been
18298     *   dragged (not scrolled) down.
18299     * - @c "drag,start,left" - This is called when the item in the list has been
18300     *   dragged (not scrolled) left.
18301     * - @c "drag,start,right" - This is called when the item in the list has
18302     *   been dragged (not scrolled) right.
18303     * - @c "drag,stop" - This is called when the item in the list has stopped
18304     *   being dragged.
18305     * - @c "drag" - This is called when the item in the list is being dragged.
18306     * - @c "longpressed" - This is called when the item is pressed for a certain
18307     *   amount of time. By default it's 1 second.
18308     * - @c "scroll,anim,start" - This is called when scrolling animation has
18309     *   started.
18310     * - @c "scroll,anim,stop" - This is called when scrolling animation has
18311     *   stopped.
18312     * - @c "scroll,drag,start" - This is called when dragging the content has
18313     *   started.
18314     * - @c "scroll,drag,stop" - This is called when dragging the content has
18315     *   stopped.
18316     * - @c "edge,top" - This is called when the genlist is scrolled until
18317     *   the top edge.
18318     * - @c "edge,bottom" - This is called when the genlist is scrolled
18319     *   until the bottom edge.
18320     * - @c "edge,left" - This is called when the genlist is scrolled
18321     *   until the left edge.
18322     * - @c "edge,right" - This is called when the genlist is scrolled
18323     *   until the right edge.
18324     * - @c "multi,swipe,left" - This is called when the genlist is multi-touch
18325     *   swiped left.
18326     * - @c "multi,swipe,right" - This is called when the genlist is multi-touch
18327     *   swiped right.
18328     * - @c "multi,swipe,up" - This is called when the genlist is multi-touch
18329     *   swiped up.
18330     * - @c "multi,swipe,down" - This is called when the genlist is multi-touch
18331     *   swiped down.
18332     * - @c "multi,pinch,out" - This is called when the genlist is multi-touch
18333     *   pinched out.  "- @c multi,pinch,in" - This is called when the genlist is
18334     *   multi-touch pinched in.
18335     * - @c "swipe" - This is called when the genlist is swiped.
18336     * - @c "moved" - This is called when a genlist item is moved.
18337     * - @c "language,changed" - This is called when the program's language is
18338     *   changed.
18339     *
18340     * @section Genlist_Examples Examples
18341     *
18342     * Here is a list of examples that use the genlist, trying to show some of
18343     * its capabilities:
18344     * - @ref genlist_example_01
18345     * - @ref genlist_example_02
18346     * - @ref genlist_example_03
18347     * - @ref genlist_example_04
18348     * - @ref genlist_example_05
18349     */
18350
18351    /**
18352     * @addtogroup Genlist
18353     * @{
18354     */
18355
18356    /**
18357     * @enum _Elm_Genlist_Item_Flags
18358     * @typedef Elm_Genlist_Item_Flags
18359     *
18360     * Defines if the item is of any special type (has subitems or it's the
18361     * index of a group), or is just a simple item.
18362     *
18363     * @ingroup Genlist
18364     */
18365    typedef enum _Elm_Genlist_Item_Flags
18366      {
18367         ELM_GENLIST_ITEM_NONE = 0, /**< simple item */
18368         ELM_GENLIST_ITEM_SUBITEMS = (1 << 0), /**< may expand and have child items */
18369         ELM_GENLIST_ITEM_GROUP = (1 << 1) /**< index of a group of items */
18370      } Elm_Genlist_Item_Flags;
18371    typedef struct _Elm_Genlist_Item_Class Elm_Genlist_Item_Class;  /**< Genlist item class definition structs */
18372    #define Elm_Genlist_Item_Class Elm_Gen_Item_Class
18373    typedef struct _Elm_Genlist_Item       Elm_Genlist_Item; /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
18374    #define Elm_Genlist_Item Elm_Gen_Item /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
18375    typedef struct _Elm_Genlist_Item_Class_Func Elm_Genlist_Item_Class_Func; /**< Class functions for genlist item class */
18376    typedef char        *(*Elm_Genlist_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for genlist item classes. */
18377    typedef Evas_Object *(*Elm_Genlist_Item_Content_Get_Cb)  (void *data, Evas_Object *obj, const char *part); /**< Content (swallowed object) fetching class function for genlist item classes. */
18378    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. */
18379    typedef void         (*Elm_Genlist_Item_Del_Cb)      (void *data, Evas_Object *obj); /**< Deletion class function for genlist item classes. */
18380
18381    /**
18382     * @struct _Elm_Genlist_Item_Class
18383     *
18384     * Genlist item class definition structs.
18385     *
18386     * This struct contains the style and fetching functions that will define the
18387     * contents of each item.
18388     *
18389     * @see @ref Genlist_Item_Class
18390     */
18391    struct _Elm_Genlist_Item_Class
18392      {
18393         const char                *item_style; /**< style of this class. */
18394         struct Elm_Genlist_Item_Class_Func
18395           {
18396              Elm_Genlist_Item_Label_Get_Cb  label_get; /**< Label fetching class function for genlist item classes.*/
18397              Elm_Genlist_Item_Content_Get_Cb   content_get; /**< Content fetching class function for genlist item classes. */
18398              Elm_Genlist_Item_State_Get_Cb  state_get; /**< State fetching class function for genlist item classes. */
18399              Elm_Genlist_Item_Del_Cb        del; /**< Deletion class function for genlist item classes. */
18400           } func;
18401      };
18402    #define Elm_Genlist_Item_Class_Func Elm_Gen_Item_Class_Func
18403    /**
18404     * Add a new genlist widget to the given parent Elementary
18405     * (container) object
18406     *
18407     * @param parent The parent object
18408     * @return a new genlist widget handle or @c NULL, on errors
18409     *
18410     * This function inserts a new genlist widget on the canvas.
18411     *
18412     * @see elm_genlist_item_append()
18413     * @see elm_genlist_item_del()
18414     * @see elm_genlist_clear()
18415     *
18416     * @ingroup Genlist
18417     */
18418    EAPI Evas_Object      *elm_genlist_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18419    /**
18420     * Remove all items from a given genlist widget.
18421     *
18422     * @param obj The genlist object
18423     *
18424     * This removes (and deletes) all items in @p obj, leaving it empty.
18425     *
18426     * @see elm_genlist_item_del(), to remove just one item.
18427     *
18428     * @ingroup Genlist
18429     */
18430    EINA_DEPRECATED EAPI void elm_genlist_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
18431    /**
18432     * Enable or disable multi-selection in the genlist
18433     *
18434     * @param obj The genlist object
18435     * @param multi Multi-select enable/disable. Default is disabled.
18436     *
18437     * This enables (@c EINA_TRUE) or disables (@c EINA_FALSE) multi-selection in
18438     * the list. This allows more than 1 item to be selected. To retrieve the list
18439     * of selected items, use elm_genlist_selected_items_get().
18440     *
18441     * @see elm_genlist_selected_items_get()
18442     * @see elm_genlist_multi_select_get()
18443     *
18444     * @ingroup Genlist
18445     */
18446    EAPI void              elm_genlist_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
18447    /**
18448     * Gets if multi-selection in genlist is enabled or disabled.
18449     *
18450     * @param obj The genlist object
18451     * @return Multi-select enabled/disabled
18452     * (@c EINA_TRUE = enabled/@c EINA_FALSE = disabled). Default is @c EINA_FALSE.
18453     *
18454     * @see elm_genlist_multi_select_set()
18455     *
18456     * @ingroup Genlist
18457     */
18458    EAPI Eina_Bool         elm_genlist_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18459    /**
18460     * This sets the horizontal stretching mode.
18461     *
18462     * @param obj The genlist object
18463     * @param mode The mode to use (one of #ELM_LIST_SCROLL or #ELM_LIST_LIMIT).
18464     *
18465     * This sets the mode used for sizing items horizontally. Valid modes
18466     * are #ELM_LIST_LIMIT and #ELM_LIST_SCROLL. The default is
18467     * ELM_LIST_SCROLL. This mode means that if items are too wide to fit,
18468     * the scroller will scroll horizontally. Otherwise items are expanded
18469     * to fill the width of the viewport of the scroller. If it is
18470     * ELM_LIST_LIMIT, items will be expanded to the viewport width and
18471     * limited to that size.
18472     *
18473     * @see elm_genlist_horizontal_get()
18474     *
18475     * @ingroup Genlist
18476     */
18477    EAPI void              elm_genlist_horizontal_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
18478    EINA_DEPRECATED EAPI void              elm_genlist_horizontal_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
18479    /**
18480     * Gets the horizontal stretching mode.
18481     *
18482     * @param obj The genlist object
18483     * @return The mode to use
18484     * (#ELM_LIST_LIMIT, #ELM_LIST_SCROLL)
18485     *
18486     * @see elm_genlist_horizontal_set()
18487     *
18488     * @ingroup Genlist
18489     */
18490    EAPI Elm_List_Mode     elm_genlist_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18491    EINA_DEPRECATED EAPI Elm_List_Mode     elm_genlist_horizontal_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18492    /**
18493     * Set the always select mode.
18494     *
18495     * @param obj The genlist object
18496     * @param always_select The always select mode (@c EINA_TRUE = on, @c
18497     * EINA_FALSE = off). Default is @c EINA_FALSE.
18498     *
18499     * Items will only call their selection func and callback when first
18500     * becoming selected. Any further clicks will do nothing, unless you
18501     * enable always select with elm_genlist_always_select_mode_set().
18502     * This means that, even if selected, every click will make the selected
18503     * callbacks be called.
18504     *
18505     * @see elm_genlist_always_select_mode_get()
18506     *
18507     * @ingroup Genlist
18508     */
18509    EINA_DEPRECATED EAPI void              elm_genlist_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
18510    /**
18511     * Get the always select mode.
18512     *
18513     * @param obj The genlist object
18514     * @return The always select mode
18515     * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18516     *
18517     * @see elm_genlist_always_select_mode_set()
18518     *
18519     * @ingroup Genlist
18520     */
18521    EINA_DEPRECATED EAPI Eina_Bool         elm_genlist_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18522    /**
18523     * Enable/disable the no select mode.
18524     *
18525     * @param obj The genlist object
18526     * @param no_select The no select mode
18527     * (EINA_TRUE = on, EINA_FALSE = off)
18528     *
18529     * This will turn off the ability to select items entirely and they
18530     * will neither appear selected nor call selected callback functions.
18531     *
18532     * @see elm_genlist_no_select_mode_get()
18533     *
18534     * @ingroup Genlist
18535     */
18536    EINA_DEPRECATED EAPI void              elm_genlist_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
18537    /**
18538     * Gets whether the no select mode is enabled.
18539     *
18540     * @param obj The genlist object
18541     * @return The no select mode
18542     * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18543     *
18544     * @see elm_genlist_no_select_mode_set()
18545     *
18546     * @ingroup Genlist
18547     */
18548    EINA_DEPRECATED EAPI Eina_Bool         elm_genlist_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18549    /**
18550     * Enable/disable compress mode.
18551     *
18552     * @param obj The genlist object
18553     * @param compress The compress mode
18554     * (@c EINA_TRUE = on, @c EINA_FALSE = off). Default is @c EINA_FALSE.
18555     *
18556     * This will enable the compress mode where items are "compressed"
18557     * horizontally to fit the genlist scrollable viewport width. This is
18558     * special for genlist.  Do not rely on
18559     * elm_genlist_horizontal_set() being set to @c ELM_LIST_COMPRESS to
18560     * work as genlist needs to handle it specially.
18561     *
18562     * @see elm_genlist_compress_mode_get()
18563     *
18564     * @ingroup Genlist
18565     */
18566    EAPI void              elm_genlist_compress_mode_set(Evas_Object *obj, Eina_Bool compress) EINA_ARG_NONNULL(1);
18567    /**
18568     * Get whether the compress mode is enabled.
18569     *
18570     * @param obj The genlist object
18571     * @return The compress mode
18572     * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18573     *
18574     * @see elm_genlist_compress_mode_set()
18575     *
18576     * @ingroup Genlist
18577     */
18578    EAPI Eina_Bool         elm_genlist_compress_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18579    /**
18580     * Enable/disable height-for-width mode.
18581     *
18582     * @param obj The genlist object
18583     * @param setting The height-for-width mode (@c EINA_TRUE = on,
18584     * @c EINA_FALSE = off). Default is @c EINA_FALSE.
18585     *
18586     * With height-for-width mode the item width will be fixed (restricted
18587     * to a minimum of) to the list width when calculating its size in
18588     * order to allow the height to be calculated based on it. This allows,
18589     * for instance, text block to wrap lines if the Edje part is
18590     * configured with "text.min: 0 1".
18591     *
18592     * @note This mode will make list resize slower as it will have to
18593     *       recalculate every item height again whenever the list width
18594     *       changes!
18595     *
18596     * @note When height-for-width mode is enabled, it also enables
18597     *       compress mode (see elm_genlist_compress_mode_set()) and
18598     *       disables homogeneous (see elm_genlist_homogeneous_set()).
18599     *
18600     * @ingroup Genlist
18601     */
18602    EAPI void              elm_genlist_height_for_width_mode_set(Evas_Object *obj, Eina_Bool height_for_width) EINA_ARG_NONNULL(1);
18603    /**
18604     * Get whether the height-for-width mode is enabled.
18605     *
18606     * @param obj The genlist object
18607     * @return The height-for-width mode (@c EINA_TRUE = on, @c EINA_FALSE =
18608     * off)
18609     *
18610     * @ingroup Genlist
18611     */
18612    EAPI Eina_Bool         elm_genlist_height_for_width_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18613    /**
18614     * Enable/disable horizontal and vertical bouncing effect.
18615     *
18616     * @param obj The genlist object
18617     * @param h_bounce Allow bounce horizontally (@c EINA_TRUE = on, @c
18618     * EINA_FALSE = off). Default is @c EINA_FALSE.
18619     * @param v_bounce Allow bounce vertically (@c EINA_TRUE = on, @c
18620     * EINA_FALSE = off). Default is @c EINA_TRUE.
18621     *
18622     * This will enable or disable the scroller bouncing effect for the
18623     * genlist. See elm_scroller_bounce_set() for details.
18624     *
18625     * @see elm_scroller_bounce_set()
18626     * @see elm_genlist_bounce_get()
18627     *
18628     * @ingroup Genlist
18629     */
18630    EINA_DEPRECATED EAPI void              elm_genlist_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
18631    /**
18632     * Get whether the horizontal and vertical bouncing effect is enabled.
18633     *
18634     * @param obj The genlist object
18635     * @param h_bounce Pointer to a bool to receive if the bounce horizontally
18636     * option is set.
18637     * @param v_bounce Pointer to a bool to receive if the bounce vertically
18638     * option is set.
18639     *
18640     * @see elm_genlist_bounce_set()
18641     *
18642     * @ingroup Genlist
18643     */
18644    EINA_DEPRECATED EAPI void              elm_genlist_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
18645    /**
18646     * Enable/disable homogenous mode.
18647     *
18648     * @param obj The genlist object
18649     * @param homogeneous Assume the items within the genlist are of the
18650     * same height and width (EINA_TRUE = on, EINA_FALSE = off). Default is @c
18651     * EINA_FALSE.
18652     *
18653     * This will enable the homogeneous mode where items are of the same
18654     * height and width so that genlist may do the lazy-loading at its
18655     * maximum (which increases the performance for scrolling the list). This
18656     * implies 'compressed' mode.
18657     *
18658     * @see elm_genlist_compress_mode_set()
18659     * @see elm_genlist_homogeneous_get()
18660     *
18661     * @ingroup Genlist
18662     */
18663    EAPI void              elm_genlist_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
18664    /**
18665     * Get whether the homogenous mode is enabled.
18666     *
18667     * @param obj The genlist object
18668     * @return Assume the items within the genlist are of the same height
18669     * and width (EINA_TRUE = on, EINA_FALSE = off)
18670     *
18671     * @see elm_genlist_homogeneous_set()
18672     *
18673     * @ingroup Genlist
18674     */
18675    EAPI Eina_Bool         elm_genlist_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18676    /**
18677     * Set the maximum number of items within an item block
18678     *
18679     * @param obj The genlist object
18680     * @param n   Maximum number of items within an item block. Default is 32.
18681     *
18682     * This will configure the block count to tune to the target with
18683     * particular performance matrix.
18684     *
18685     * A block of objects will be used to reduce the number of operations due to
18686     * many objects in the screen. It can determine the visibility, or if the
18687     * object has changed, it theme needs to be updated, etc. doing this kind of
18688     * calculation to the entire block, instead of per object.
18689     *
18690     * The default value for the block count is enough for most lists, so unless
18691     * you know you will have a lot of objects visible in the screen at the same
18692     * time, don't try to change this.
18693     *
18694     * @see elm_genlist_block_count_get()
18695     * @see @ref Genlist_Implementation
18696     *
18697     * @ingroup Genlist
18698     */
18699    EAPI void              elm_genlist_block_count_set(Evas_Object *obj, int n) EINA_ARG_NONNULL(1);
18700    /**
18701     * Get the maximum number of items within an item block
18702     *
18703     * @param obj The genlist object
18704     * @return Maximum number of items within an item block
18705     *
18706     * @see elm_genlist_block_count_set()
18707     *
18708     * @ingroup Genlist
18709     */
18710    EAPI int               elm_genlist_block_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18711    /**
18712     * Set the timeout in seconds for the longpress event.
18713     *
18714     * @param obj The genlist object
18715     * @param timeout timeout in seconds. Default is 1.
18716     *
18717     * This option will change how long it takes to send an event "longpressed"
18718     * after the mouse down signal is sent to the list. If this event occurs, no
18719     * "clicked" event will be sent.
18720     *
18721     * @see elm_genlist_longpress_timeout_set()
18722     *
18723     * @ingroup Genlist
18724     */
18725    EAPI void              elm_genlist_longpress_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
18726    /**
18727     * Get the timeout in seconds for the longpress event.
18728     *
18729     * @param obj The genlist object
18730     * @return timeout in seconds
18731     *
18732     * @see elm_genlist_longpress_timeout_get()
18733     *
18734     * @ingroup Genlist
18735     */
18736    EAPI double            elm_genlist_longpress_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18737    /**
18738     * Append a new item in a given genlist widget.
18739     *
18740     * @param obj The genlist object
18741     * @param itc The item class for the item
18742     * @param data The item data
18743     * @param parent The parent item, or NULL if none
18744     * @param flags Item flags
18745     * @param func Convenience function called when the item is selected
18746     * @param func_data Data passed to @p func above.
18747     * @return A handle to the item added or @c NULL if not possible
18748     *
18749     * This adds the given item to the end of the list or the end of
18750     * the children list if the @p parent is given.
18751     *
18752     * @see elm_genlist_item_prepend()
18753     * @see elm_genlist_item_insert_before()
18754     * @see elm_genlist_item_insert_after()
18755     * @see elm_genlist_item_del()
18756     *
18757     * @ingroup Genlist
18758     */
18759    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);
18760    /**
18761     * Prepend a new item in a given genlist widget.
18762     *
18763     * @param obj The genlist object
18764     * @param itc The item class for the item
18765     * @param data The item data
18766     * @param parent The parent item, or NULL if none
18767     * @param flags Item flags
18768     * @param func Convenience function called when the item is selected
18769     * @param func_data Data passed to @p func above.
18770     * @return A handle to the item added or NULL if not possible
18771     *
18772     * This adds an item to the beginning of the list or beginning of the
18773     * children of the parent if given.
18774     *
18775     * @see elm_genlist_item_append()
18776     * @see elm_genlist_item_insert_before()
18777     * @see elm_genlist_item_insert_after()
18778     * @see elm_genlist_item_del()
18779     *
18780     * @ingroup Genlist
18781     */
18782    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);
18783    /**
18784     * Insert an item before another in a genlist widget
18785     *
18786     * @param obj The genlist object
18787     * @param itc The item class for the item
18788     * @param data The item data
18789     * @param before The item to place this new one before.
18790     * @param flags Item flags
18791     * @param func Convenience function called when the item is selected
18792     * @param func_data Data passed to @p func above.
18793     * @return A handle to the item added or @c NULL if not possible
18794     *
18795     * This inserts an item before another in the list. It will be in the
18796     * same tree level or group as the item it is inserted before.
18797     *
18798     * @see elm_genlist_item_append()
18799     * @see elm_genlist_item_prepend()
18800     * @see elm_genlist_item_insert_after()
18801     * @see elm_genlist_item_del()
18802     *
18803     * @ingroup Genlist
18804     */
18805    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);
18806    /**
18807     * Insert an item after another in a genlist widget
18808     *
18809     * @param obj The genlist object
18810     * @param itc The item class for the item
18811     * @param data The item data
18812     * @param after The item to place this new one after.
18813     * @param flags Item flags
18814     * @param func Convenience function called when the item is selected
18815     * @param func_data Data passed to @p func above.
18816     * @return A handle to the item added or @c NULL if not possible
18817     *
18818     * This inserts an item after another in the list. It will be in the
18819     * same tree level or group as the item it is inserted after.
18820     *
18821     * @see elm_genlist_item_append()
18822     * @see elm_genlist_item_prepend()
18823     * @see elm_genlist_item_insert_before()
18824     * @see elm_genlist_item_del()
18825     *
18826     * @ingroup Genlist
18827     */
18828    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);
18829    /**
18830     * Insert a new item into the sorted genlist object
18831     *
18832     * @param obj The genlist object
18833     * @param itc The item class for the item
18834     * @param data The item data
18835     * @param parent The parent item, or NULL if none
18836     * @param flags Item flags
18837     * @param comp The function called for the sort
18838     * @param func Convenience function called when item selected
18839     * @param func_data Data passed to @p func above.
18840     * @return A handle to the item added or NULL if not possible
18841     *
18842     * @ingroup Genlist
18843     */
18844    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);
18845    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);
18846    /* operations to retrieve existing items */
18847    /**
18848     * Get the selectd item in the genlist.
18849     *
18850     * @param obj The genlist object
18851     * @return The selected item, or NULL if none is selected.
18852     *
18853     * This gets the selected item in the list (if multi-selection is enabled, only
18854     * the item that was first selected in the list is returned - which is not very
18855     * useful, so see elm_genlist_selected_items_get() for when multi-selection is
18856     * used).
18857     *
18858     * If no item is selected, NULL is returned.
18859     *
18860     * @see elm_genlist_selected_items_get()
18861     *
18862     * @ingroup Genlist
18863     */
18864    EAPI Elm_Genlist_Item *elm_genlist_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18865    /**
18866     * Get a list of selected items in the genlist.
18867     *
18868     * @param obj The genlist object
18869     * @return The list of selected items, or NULL if none are selected.
18870     *
18871     * It returns a list of the selected items. This list pointer is only valid so
18872     * long as the selection doesn't change (no items are selected or unselected, or
18873     * unselected implicitly by deletion). The list contains Elm_Genlist_Item
18874     * pointers. The order of the items in this list is the order which they were
18875     * selected, i.e. the first item in this list is the first item that was
18876     * selected, and so on.
18877     *
18878     * @note If not in multi-select mode, consider using function
18879     * elm_genlist_selected_item_get() instead.
18880     *
18881     * @see elm_genlist_multi_select_set()
18882     * @see elm_genlist_selected_item_get()
18883     *
18884     * @ingroup Genlist
18885     */
18886    EAPI const Eina_List  *elm_genlist_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18887    /**
18888     * Get the mode item style of items in the genlist
18889     * @param obj The genlist object
18890     * @return The mode item style string, or NULL if none is specified
18891     * 
18892     * This is a constant string and simply defines the name of the
18893     * style that will be used for mode animations. It can be
18894     * @c NULL if you don't plan to use Genlist mode. See
18895     * elm_genlist_item_mode_set() for more info.
18896     * 
18897     * @ingroup Genlist
18898     */
18899    EAPI const char       *elm_genlist_mode_item_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18900    /**
18901     * Set the mode item style of items in the genlist
18902     * @param obj The genlist object
18903     * @param style The mode item style string, or NULL if none is desired
18904     * 
18905     * This is a constant string and simply defines the name of the
18906     * style that will be used for mode animations. It can be
18907     * @c NULL if you don't plan to use Genlist mode. See
18908     * elm_genlist_item_mode_set() for more info.
18909     * 
18910     * @ingroup Genlist
18911     */
18912    EAPI void              elm_genlist_mode_item_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
18913    /**
18914     * Get a list of realized items in genlist
18915     *
18916     * @param obj The genlist object
18917     * @return The list of realized items, nor NULL if none are realized.
18918     *
18919     * This returns a list of the realized items in the genlist. The list
18920     * contains Elm_Genlist_Item pointers. The list must be freed by the
18921     * caller when done with eina_list_free(). The item pointers in the
18922     * list are only valid so long as those items are not deleted or the
18923     * genlist is not deleted.
18924     *
18925     * @see elm_genlist_realized_items_update()
18926     *
18927     * @ingroup Genlist
18928     */
18929    EAPI Eina_List        *elm_genlist_realized_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18930    /**
18931     * Get the item that is at the x, y canvas coords.
18932     *
18933     * @param obj The gelinst object.
18934     * @param x The input x coordinate
18935     * @param y The input y coordinate
18936     * @param posret The position relative to the item returned here
18937     * @return The item at the coordinates or NULL if none
18938     *
18939     * This returns the item at the given coordinates (which are canvas
18940     * relative, not object-relative). If an item is at that coordinate,
18941     * that item handle is returned, and if @p posret is not NULL, the
18942     * integer pointed to is set to a value of -1, 0 or 1, depending if
18943     * the coordinate is on the upper portion of that item (-1), on the
18944     * middle section (0) or on the lower part (1). If NULL is returned as
18945     * an item (no item found there), then posret may indicate -1 or 1
18946     * based if the coordinate is above or below all items respectively in
18947     * the genlist.
18948     *
18949     * @ingroup Genlist
18950     */
18951    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);
18952    /**
18953     * Get the first item in the genlist
18954     *
18955     * This returns the first item in the list.
18956     *
18957     * @param obj The genlist object
18958     * @return The first item, or NULL if none
18959     *
18960     * @ingroup Genlist
18961     */
18962    EINA_DEPRECATED EAPI Elm_Genlist_Item *elm_genlist_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18963    /**
18964     * Get the last item in the genlist
18965     *
18966     * This returns the last item in the list.
18967     *
18968     * @return The last item, or NULL if none
18969     *
18970     * @ingroup Genlist
18971     */
18972    EINA_DEPRECATED EAPI Elm_Genlist_Item *elm_genlist_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18973    /**
18974     * Set the scrollbar policy
18975     *
18976     * @param obj The genlist object
18977     * @param policy_h Horizontal scrollbar policy.
18978     * @param policy_v Vertical scrollbar policy.
18979     *
18980     * This sets the scrollbar visibility policy for the given genlist
18981     * scroller. #ELM_SMART_SCROLLER_POLICY_AUTO means the scrollbar is
18982     * made visible if it is needed, and otherwise kept hidden.
18983     * #ELM_SMART_SCROLLER_POLICY_ON turns it on all the time, and
18984     * #ELM_SMART_SCROLLER_POLICY_OFF always keeps it off. This applies
18985     * respectively for the horizontal and vertical scrollbars. Default is
18986     * #ELM_SMART_SCROLLER_POLICY_AUTO
18987     *
18988     * @see elm_genlist_scroller_policy_get()
18989     *
18990     * @ingroup Genlist
18991     */
18992    EAPI void              elm_genlist_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
18993    /**
18994     * Get the scrollbar policy
18995     *
18996     * @param obj The genlist object
18997     * @param policy_h Pointer to store the horizontal scrollbar policy.
18998     * @param policy_v Pointer to store the vertical scrollbar policy.
18999     *
19000     * @see elm_genlist_scroller_policy_set()
19001     *
19002     * @ingroup Genlist
19003     */
19004    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);
19005    /**
19006     * Get the @b next item in a genlist widget's internal list of items,
19007     * given a handle to one of those items.
19008     *
19009     * @param item The genlist item to fetch next from
19010     * @return The item after @p item, or @c NULL if there's none (and
19011     * on errors)
19012     *
19013     * This returns the item placed after the @p item, on the container
19014     * genlist.
19015     *
19016     * @see elm_genlist_item_prev_get()
19017     *
19018     * @ingroup Genlist
19019     */
19020    EINA_DEPRECATED EAPI Elm_Genlist_Item  *elm_genlist_item_next_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19021    /**
19022     * Get the @b previous item in a genlist widget's internal list of items,
19023     * given a handle to one of those items.
19024     *
19025     * @param item The genlist item to fetch previous from
19026     * @return The item before @p item, or @c NULL if there's none (and
19027     * on errors)
19028     *
19029     * This returns the item placed before the @p item, on the container
19030     * genlist.
19031     *
19032     * @see elm_genlist_item_next_get()
19033     *
19034     * @ingroup Genlist
19035     */
19036    EINA_DEPRECATED EAPI Elm_Genlist_Item  *elm_genlist_item_prev_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19037    /**
19038     * Get the genlist object's handle which contains a given genlist
19039     * item
19040     *
19041     * @param item The item to fetch the container from
19042     * @return The genlist (parent) object
19043     *
19044     * This returns the genlist object itself that an item belongs to.
19045     *
19046     * @ingroup Genlist
19047     */
19048    EINA_DEPRECATED EAPI Evas_Object       *elm_genlist_item_genlist_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19049    /**
19050     * Get the parent item of the given item
19051     *
19052     * @param it The item
19053     * @return The parent of the item or @c NULL if it has no parent.
19054     *
19055     * This returns the item that was specified as parent of the item @p it on
19056     * elm_genlist_item_append() and insertion related functions.
19057     *
19058     * @ingroup Genlist
19059     */
19060    EAPI Elm_Genlist_Item  *elm_genlist_item_parent_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19061    /**
19062     * Remove all sub-items (children) of the given item
19063     *
19064     * @param it The item
19065     *
19066     * This removes all items that are children (and their descendants) of the
19067     * given item @p it.
19068     *
19069     * @see elm_genlist_clear()
19070     * @see elm_genlist_item_del()
19071     *
19072     * @ingroup Genlist
19073     */
19074    EAPI void               elm_genlist_item_subitems_clear(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19075    /**
19076     * Set whether a given genlist item is selected or not
19077     *
19078     * @param it The item
19079     * @param selected Use @c EINA_TRUE, to make it selected, @c
19080     * EINA_FALSE to make it unselected
19081     *
19082     * This sets the selected state of an item. If multi selection is
19083     * not enabled on the containing genlist and @p selected is @c
19084     * EINA_TRUE, any other previously selected items will get
19085     * unselected in favor of this new one.
19086     *
19087     * @see elm_genlist_item_selected_get()
19088     *
19089     * @ingroup Genlist
19090     */
19091    EINA_DEPRECATED EAPI void elm_genlist_item_selected_set(Elm_Genlist_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
19092    /**
19093     * Get whether a given genlist item is selected or not
19094     *
19095     * @param it The item
19096     * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
19097     *
19098     * @see elm_genlist_item_selected_set() for more details
19099     *
19100     * @ingroup Genlist
19101     */
19102    EINA_DEPRECATED EAPI Eina_Bool elm_genlist_item_selected_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19103    /**
19104     * Sets the expanded state of an item.
19105     *
19106     * @param it The item
19107     * @param expanded The expanded state (@c EINA_TRUE expanded, @c EINA_FALSE not expanded).
19108     *
19109     * This function flags the item of type #ELM_GENLIST_ITEM_SUBITEMS as
19110     * expanded or not.
19111     *
19112     * The theme will respond to this change visually, and a signal "expanded" or
19113     * "contracted" will be sent from the genlist with a pointer to the item that
19114     * has been expanded/contracted.
19115     *
19116     * Calling this function won't show or hide any child of this item (if it is
19117     * a parent). You must manually delete and create them on the callbacks fo
19118     * the "expanded" or "contracted" signals.
19119     *
19120     * @see elm_genlist_item_expanded_get()
19121     *
19122     * @ingroup Genlist
19123     */
19124    EAPI void               elm_genlist_item_expanded_set(Elm_Genlist_Item *item, Eina_Bool expanded) EINA_ARG_NONNULL(1);
19125    /**
19126     * Get the expanded state of an item
19127     *
19128     * @param it The item
19129     * @return The expanded state
19130     *
19131     * This gets the expanded state of an item.
19132     *
19133     * @see elm_genlist_item_expanded_set()
19134     *
19135     * @ingroup Genlist
19136     */
19137    EAPI Eina_Bool          elm_genlist_item_expanded_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19138    /**
19139     * Get the depth of expanded item
19140     *
19141     * @param it The genlist item object
19142     * @return The depth of expanded item
19143     *
19144     * @ingroup Genlist
19145     */
19146    EAPI int                elm_genlist_item_expanded_depth_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19147    /**
19148     * Set whether a given genlist item is disabled or not.
19149     *
19150     * @param it The item
19151     * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
19152     * to enable it back.
19153     *
19154     * A disabled item cannot be selected or unselected. It will also
19155     * change its appearance, to signal the user it's disabled.
19156     *
19157     * @see elm_genlist_item_disabled_get()
19158     *
19159     * @ingroup Genlist
19160     */
19161    EAPI void               elm_genlist_item_disabled_set(Elm_Genlist_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
19162    /**
19163     * Get whether a given genlist item is disabled or not.
19164     *
19165     * @param it The item
19166     * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
19167     * (and on errors).
19168     *
19169     * @see elm_genlist_item_disabled_set() for more details
19170     *
19171     * @ingroup Genlist
19172     */
19173    EAPI Eina_Bool          elm_genlist_item_disabled_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19174    /**
19175     * Sets the display only state of an item.
19176     *
19177     * @param it The item
19178     * @param display_only @c EINA_TRUE if the item is display only, @c
19179     * EINA_FALSE otherwise.
19180     *
19181     * A display only item cannot be selected or unselected. It is for
19182     * display only and not selecting or otherwise clicking, dragging
19183     * etc. by the user, thus finger size rules will not be applied to
19184     * this item.
19185     *
19186     * It's good to set group index items to display only state.
19187     *
19188     * @see elm_genlist_item_display_only_get()
19189     *
19190     * @ingroup Genlist
19191     */
19192    EAPI void               elm_genlist_item_display_only_set(Elm_Genlist_Item *it, Eina_Bool display_only) EINA_ARG_NONNULL(1);
19193    /**
19194     * Get the display only state of an item
19195     *
19196     * @param it The item
19197     * @return @c EINA_TRUE if the item is display only, @c
19198     * EINA_FALSE otherwise.
19199     *
19200     * @see elm_genlist_item_display_only_set()
19201     *
19202     * @ingroup Genlist
19203     */
19204    EAPI Eina_Bool          elm_genlist_item_display_only_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19205    /**
19206     * Show the portion of a genlist's internal list containing a given
19207     * item, immediately.
19208     *
19209     * @param it The item to display
19210     *
19211     * This causes genlist to jump to the given item @p it and show it (by
19212     * immediately scrolling to that position), if it is not fully visible.
19213     *
19214     * @see elm_genlist_item_bring_in()
19215     * @see elm_genlist_item_top_show()
19216     * @see elm_genlist_item_middle_show()
19217     *
19218     * @ingroup Genlist
19219     */
19220    EAPI void               elm_genlist_item_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19221    /**
19222     * Animatedly bring in, to the visible are of a genlist, a given
19223     * item on it.
19224     *
19225     * @param it The item to display
19226     *
19227     * This causes genlist to jump to the given item @p it and show it (by
19228     * animatedly scrolling), if it is not fully visible. This may use animation
19229     * to do so and take a period of time
19230     *
19231     * @see elm_genlist_item_show()
19232     * @see elm_genlist_item_top_bring_in()
19233     * @see elm_genlist_item_middle_bring_in()
19234     *
19235     * @ingroup Genlist
19236     */
19237    EAPI void               elm_genlist_item_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19238    /**
19239     * Show the portion of a genlist's internal list containing a given
19240     * item, immediately.
19241     *
19242     * @param it The item to display
19243     *
19244     * This causes genlist to jump to the given item @p it and show it (by
19245     * immediately scrolling to that position), if it is not fully visible.
19246     *
19247     * The item will be positioned at the top of the genlist viewport.
19248     *
19249     * @see elm_genlist_item_show()
19250     * @see elm_genlist_item_top_bring_in()
19251     *
19252     * @ingroup Genlist
19253     */
19254    EAPI void               elm_genlist_item_top_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19255    /**
19256     * Animatedly bring in, to the visible are of a genlist, a given
19257     * item on it.
19258     *
19259     * @param it The item
19260     *
19261     * This causes genlist to jump to the given item @p it and show it (by
19262     * animatedly scrolling), if it is not fully visible. This may use animation
19263     * to do so and take a period of time
19264     *
19265     * The item will be positioned at the top of the genlist viewport.
19266     *
19267     * @see elm_genlist_item_bring_in()
19268     * @see elm_genlist_item_top_show()
19269     *
19270     * @ingroup Genlist
19271     */
19272    EAPI void               elm_genlist_item_top_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19273    /**
19274     * Show the portion of a genlist's internal list containing a given
19275     * item, immediately.
19276     *
19277     * @param it The item to display
19278     *
19279     * This causes genlist to jump to the given item @p it and show it (by
19280     * immediately scrolling to that position), if it is not fully visible.
19281     *
19282     * The item will be positioned at the middle of the genlist viewport.
19283     *
19284     * @see elm_genlist_item_show()
19285     * @see elm_genlist_item_middle_bring_in()
19286     *
19287     * @ingroup Genlist
19288     */
19289    EAPI void               elm_genlist_item_middle_show(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19290    /**
19291     * Animatedly bring in, to the visible are of a genlist, a given
19292     * item on it.
19293     *
19294     * @param it The item
19295     *
19296     * This causes genlist to jump to the given item @p it and show it (by
19297     * animatedly scrolling), if it is not fully visible. This may use animation
19298     * to do so and take a period of time
19299     *
19300     * The item will be positioned at the middle of the genlist viewport.
19301     *
19302     * @see elm_genlist_item_bring_in()
19303     * @see elm_genlist_item_middle_show()
19304     *
19305     * @ingroup Genlist
19306     */
19307    EAPI void               elm_genlist_item_middle_bring_in(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19308    /**
19309     * Remove a genlist item from the its parent, deleting it.
19310     *
19311     * @param item The item to be removed.
19312     * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
19313     *
19314     * @see elm_genlist_clear(), to remove all items in a genlist at
19315     * once.
19316     *
19317     * @ingroup Genlist
19318     */
19319    EAPI void               elm_genlist_item_del(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19320    /**
19321     * Return the data associated to a given genlist item
19322     *
19323     * @param item The genlist item.
19324     * @return the data associated to this item.
19325     *
19326     * This returns the @c data value passed on the
19327     * elm_genlist_item_append() and related item addition calls.
19328     *
19329     * @see elm_genlist_item_append()
19330     * @see elm_genlist_item_data_set()
19331     *
19332     * @ingroup Genlist
19333     */
19334    EAPI void              *elm_genlist_item_data_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19335    /**
19336     * Set the data associated to a given genlist item
19337     *
19338     * @param item The genlist item
19339     * @param data The new data pointer to set on it
19340     *
19341     * This @b overrides the @c data value passed on the
19342     * elm_genlist_item_append() and related item addition calls. This
19343     * function @b won't call elm_genlist_item_update() automatically,
19344     * so you'd issue it afterwards if you want to hove the item
19345     * updated to reflect the that new data.
19346     *
19347     * @see elm_genlist_item_data_get()
19348     *
19349     * @ingroup Genlist
19350     */
19351    EAPI void               elm_genlist_item_data_set(Elm_Genlist_Item *it, const void *data) EINA_ARG_NONNULL(1);
19352    /**
19353     * Tells genlist to "orphan" icons fetchs by the item class
19354     *
19355     * @param it The item
19356     *
19357     * This instructs genlist to release references to icons in the item,
19358     * meaning that they will no longer be managed by genlist and are
19359     * floating "orphans" that can be re-used elsewhere if the user wants
19360     * to.
19361     *
19362     * @ingroup Genlist
19363     */
19364    EAPI void               elm_genlist_item_contents_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19365    EINA_DEPRECATED EAPI void               elm_genlist_item_icons_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19366    /**
19367     * Get the real Evas object created to implement the view of a
19368     * given genlist item
19369     *
19370     * @param item The genlist item.
19371     * @return the Evas object implementing this item's view.
19372     *
19373     * This returns the actual Evas object used to implement the
19374     * specified genlist item's view. This may be @c NULL, as it may
19375     * not have been created or may have been deleted, at any time, by
19376     * the genlist. <b>Do not modify this object</b> (move, resize,
19377     * show, hide, etc.), as the genlist is controlling it. This
19378     * function is for querying, emitting custom signals or hooking
19379     * lower level callbacks for events on that object. Do not delete
19380     * this object under any circumstances.
19381     *
19382     * @see elm_genlist_item_data_get()
19383     *
19384     * @ingroup Genlist
19385     */
19386    EAPI const Evas_Object *elm_genlist_item_object_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19387    /**
19388     * Update the contents of an item
19389     *
19390     * @param it The item
19391     *
19392     * This updates an item by calling all the item class functions again
19393     * to get the icons, labels and states. Use this when the original
19394     * item data has changed and the changes are desired to be reflected.
19395     *
19396     * Use elm_genlist_realized_items_update() to update all already realized
19397     * items.
19398     *
19399     * @see elm_genlist_realized_items_update()
19400     *
19401     * @ingroup Genlist
19402     */
19403    EAPI void               elm_genlist_item_update(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19404    /**
19405     * Update the item class of an item
19406     *
19407     * @param it The item
19408     * @param itc The item class for the item
19409     *
19410     * This sets another class fo the item, changing the way that it is
19411     * displayed. After changing the item class, elm_genlist_item_update() is
19412     * called on the item @p it.
19413     *
19414     * @ingroup Genlist
19415     */
19416    EAPI void               elm_genlist_item_item_class_update(Elm_Genlist_Item *it, const Elm_Genlist_Item_Class *itc) EINA_ARG_NONNULL(1, 2);
19417    EAPI const Elm_Genlist_Item_Class *elm_genlist_item_item_class_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19418    /**
19419     * Set the text to be shown in a given genlist item's tooltips.
19420     *
19421     * @param item The genlist item
19422     * @param text The text to set in the content
19423     *
19424     * This call will setup the text to be used as tooltip to that item
19425     * (analogous to elm_object_tooltip_text_set(), but being item
19426     * tooltips with higher precedence than object tooltips). It can
19427     * have only one tooltip at a time, so any previous tooltip data
19428     * will get removed.
19429     *
19430     * In order to set an icon or something else as a tooltip, look at
19431     * elm_genlist_item_tooltip_content_cb_set().
19432     *
19433     * @ingroup Genlist
19434     */
19435    EAPI void               elm_genlist_item_tooltip_text_set(Elm_Genlist_Item *item, const char *text) EINA_ARG_NONNULL(1);
19436    /**
19437     * Set the content to be shown in a given genlist item's tooltips
19438     *
19439     * @param item The genlist item.
19440     * @param func The function returning the tooltip contents.
19441     * @param data What to provide to @a func as callback data/context.
19442     * @param del_cb Called when data is not needed anymore, either when
19443     *        another callback replaces @p func, the tooltip is unset with
19444     *        elm_genlist_item_tooltip_unset() or the owner @p item
19445     *        dies. This callback receives as its first parameter the
19446     *        given @p data, being @c event_info the item handle.
19447     *
19448     * This call will setup the tooltip's contents to @p item
19449     * (analogous to elm_object_tooltip_content_cb_set(), but being
19450     * item tooltips with higher precedence than object tooltips). It
19451     * can have only one tooltip at a time, so any previous tooltip
19452     * content will get removed. @p func (with @p data) will be called
19453     * every time Elementary needs to show the tooltip and it should
19454     * return a valid Evas object, which will be fully managed by the
19455     * tooltip system, getting deleted when the tooltip is gone.
19456     *
19457     * In order to set just a text as a tooltip, look at
19458     * elm_genlist_item_tooltip_text_set().
19459     *
19460     * @ingroup Genlist
19461     */
19462    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);
19463    /**
19464     * Unset a tooltip from a given genlist item
19465     *
19466     * @param item genlist item to remove a previously set tooltip from.
19467     *
19468     * This call removes any tooltip set on @p item. The callback
19469     * provided as @c del_cb to
19470     * elm_genlist_item_tooltip_content_cb_set() will be called to
19471     * notify it is not used anymore (and have resources cleaned, if
19472     * need be).
19473     *
19474     * @see elm_genlist_item_tooltip_content_cb_set()
19475     *
19476     * @ingroup Genlist
19477     */
19478    EAPI void               elm_genlist_item_tooltip_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19479    /**
19480     * Set a different @b style for a given genlist item's tooltip.
19481     *
19482     * @param item genlist item with tooltip set
19483     * @param style the <b>theme style</b> to use on tooltips (e.g. @c
19484     * "default", @c "transparent", etc)
19485     *
19486     * Tooltips can have <b>alternate styles</b> to be displayed on,
19487     * which are defined by the theme set on Elementary. This function
19488     * works analogously as elm_object_tooltip_style_set(), but here
19489     * applied only to genlist item objects. The default style for
19490     * tooltips is @c "default".
19491     *
19492     * @note before you set a style you should define a tooltip with
19493     *       elm_genlist_item_tooltip_content_cb_set() or
19494     *       elm_genlist_item_tooltip_text_set()
19495     *
19496     * @see elm_genlist_item_tooltip_style_get()
19497     *
19498     * @ingroup Genlist
19499     */
19500    EAPI void               elm_genlist_item_tooltip_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
19501    /**
19502     * Get the style set a given genlist item's tooltip.
19503     *
19504     * @param item genlist item with tooltip already set on.
19505     * @return style the theme style in use, which defaults to
19506     *         "default". If the object does not have a tooltip set,
19507     *         then @c NULL is returned.
19508     *
19509     * @see elm_genlist_item_tooltip_style_set() for more details
19510     *
19511     * @ingroup Genlist
19512     */
19513    EAPI const char        *elm_genlist_item_tooltip_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19514    /**
19515     * @brief Disable size restrictions on an object's tooltip
19516     * @param item The tooltip's anchor object
19517     * @param disable If EINA_TRUE, size restrictions are disabled
19518     * @return EINA_FALSE on failure, EINA_TRUE on success
19519     *
19520     * This function allows a tooltip to expand beyond its parant window's canvas.
19521     * It will instead be limited only by the size of the display.
19522     */
19523    EAPI Eina_Bool          elm_genlist_item_tooltip_size_restrict_disable(Elm_Genlist_Item *item, Eina_Bool disable);
19524    /**
19525     * @brief Retrieve size restriction state of an object's tooltip
19526     * @param item The tooltip's anchor object
19527     * @return If EINA_TRUE, size restrictions are disabled
19528     *
19529     * This function returns whether a tooltip is allowed to expand beyond
19530     * its parant window's canvas.
19531     * It will instead be limited only by the size of the display.
19532     */
19533    EAPI Eina_Bool          elm_genlist_item_tooltip_size_restrict_disabled_get(const Elm_Genlist_Item *item);
19534    /**
19535     * Set the type of mouse pointer/cursor decoration to be shown,
19536     * when the mouse pointer is over the given genlist widget item
19537     *
19538     * @param item genlist item to customize cursor on
19539     * @param cursor the cursor type's name
19540     *
19541     * This function works analogously as elm_object_cursor_set(), but
19542     * here the cursor's changing area is restricted to the item's
19543     * area, and not the whole widget's. Note that that item cursors
19544     * have precedence over widget cursors, so that a mouse over @p
19545     * item will always show cursor @p type.
19546     *
19547     * If this function is called twice for an object, a previously set
19548     * cursor will be unset on the second call.
19549     *
19550     * @see elm_object_cursor_set()
19551     * @see elm_genlist_item_cursor_get()
19552     * @see elm_genlist_item_cursor_unset()
19553     *
19554     * @ingroup Genlist
19555     */
19556    EAPI void               elm_genlist_item_cursor_set(Elm_Genlist_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
19557    /**
19558     * Get the type of mouse pointer/cursor decoration set to be shown,
19559     * when the mouse pointer is over the given genlist widget item
19560     *
19561     * @param item genlist item with custom cursor set
19562     * @return the cursor type's name or @c NULL, if no custom cursors
19563     * were set to @p item (and on errors)
19564     *
19565     * @see elm_object_cursor_get()
19566     * @see elm_genlist_item_cursor_set() for more details
19567     * @see elm_genlist_item_cursor_unset()
19568     *
19569     * @ingroup Genlist
19570     */
19571    EAPI const char        *elm_genlist_item_cursor_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19572    /**
19573     * Unset any custom mouse pointer/cursor decoration set to be
19574     * shown, when the mouse pointer is over the given genlist widget
19575     * item, thus making it show the @b default cursor again.
19576     *
19577     * @param item a genlist item
19578     *
19579     * Use this call to undo any custom settings on this item's cursor
19580     * decoration, bringing it back to defaults (no custom style set).
19581     *
19582     * @see elm_object_cursor_unset()
19583     * @see elm_genlist_item_cursor_set() for more details
19584     *
19585     * @ingroup Genlist
19586     */
19587    EAPI void               elm_genlist_item_cursor_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19588    /**
19589     * Set a different @b style for a given custom cursor set for a
19590     * genlist item.
19591     *
19592     * @param item genlist item with custom cursor set
19593     * @param style the <b>theme style</b> to use (e.g. @c "default",
19594     * @c "transparent", etc)
19595     *
19596     * This function only makes sense when one is using custom mouse
19597     * cursor decorations <b>defined in a theme file</b> , which can
19598     * have, given a cursor name/type, <b>alternate styles</b> on
19599     * it. It works analogously as elm_object_cursor_style_set(), but
19600     * here applied only to genlist item objects.
19601     *
19602     * @warning Before you set a cursor style you should have defined a
19603     *       custom cursor previously on the item, with
19604     *       elm_genlist_item_cursor_set()
19605     *
19606     * @see elm_genlist_item_cursor_engine_only_set()
19607     * @see elm_genlist_item_cursor_style_get()
19608     *
19609     * @ingroup Genlist
19610     */
19611    EAPI void               elm_genlist_item_cursor_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
19612    /**
19613     * Get the current @b style set for a given genlist item's custom
19614     * cursor
19615     *
19616     * @param item genlist item with custom cursor set.
19617     * @return style the cursor style in use. If the object does not
19618     *         have a cursor set, then @c NULL is returned.
19619     *
19620     * @see elm_genlist_item_cursor_style_set() for more details
19621     *
19622     * @ingroup Genlist
19623     */
19624    EAPI const char        *elm_genlist_item_cursor_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19625    /**
19626     * Set if the (custom) cursor for a given genlist item should be
19627     * searched in its theme, also, or should only rely on the
19628     * rendering engine.
19629     *
19630     * @param item item with custom (custom) cursor already set on
19631     * @param engine_only Use @c EINA_TRUE to have cursors looked for
19632     * only on those provided by the rendering engine, @c EINA_FALSE to
19633     * have them searched on the widget's theme, as well.
19634     *
19635     * @note This call is of use only if you've set a custom cursor
19636     * for genlist items, with elm_genlist_item_cursor_set().
19637     *
19638     * @note By default, cursors will only be looked for between those
19639     * provided by the rendering engine.
19640     *
19641     * @ingroup Genlist
19642     */
19643    EAPI void               elm_genlist_item_cursor_engine_only_set(Elm_Genlist_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
19644    /**
19645     * Get if the (custom) cursor for a given genlist item is being
19646     * searched in its theme, also, or is only relying on the rendering
19647     * engine.
19648     *
19649     * @param item a genlist item
19650     * @return @c EINA_TRUE, if cursors are being looked for only on
19651     * those provided by the rendering engine, @c EINA_FALSE if they
19652     * are being searched on the widget's theme, as well.
19653     *
19654     * @see elm_genlist_item_cursor_engine_only_set(), for more details
19655     *
19656     * @ingroup Genlist
19657     */
19658    EAPI Eina_Bool          elm_genlist_item_cursor_engine_only_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19659    /**
19660     * Update the contents of all realized items.
19661     *
19662     * @param obj The genlist object.
19663     *
19664     * This updates all realized items by calling all the item class functions again
19665     * to get the icons, labels and states. Use this when the original
19666     * item data has changed and the changes are desired to be reflected.
19667     *
19668     * To update just one item, use elm_genlist_item_update().
19669     *
19670     * @see elm_genlist_realized_items_get()
19671     * @see elm_genlist_item_update()
19672     *
19673     * @ingroup Genlist
19674     */
19675    EAPI void               elm_genlist_realized_items_update(Evas_Object *obj) EINA_ARG_NONNULL(1);
19676    /**
19677     * Activate a genlist mode on an item
19678     *
19679     * @param item The genlist item
19680     * @param mode Mode name
19681     * @param mode_set Boolean to define set or unset mode.
19682     *
19683     * A genlist mode is a different way of selecting an item. Once a mode is
19684     * activated on an item, any other selected item is immediately unselected.
19685     * This feature provides an easy way of implementing a new kind of animation
19686     * for selecting an item, without having to entirely rewrite the item style
19687     * theme. However, the elm_genlist_selected_* API can't be used to get what
19688     * item is activate for a mode.
19689     *
19690     * The current item style will still be used, but applying a genlist mode to
19691     * an item will select it using a different kind of animation.
19692     *
19693     * The current active item for a mode can be found by
19694     * elm_genlist_mode_item_get().
19695     *
19696     * The characteristics of genlist mode are:
19697     * - Only one mode can be active at any time, and for only one item.
19698     * - Genlist handles deactivating other items when one item is activated.
19699     * - A mode is defined in the genlist theme (edc), and more modes can easily
19700     *   be added.
19701     * - A mode style and the genlist item style are different things. They
19702     *   can be combined to provide a default style to the item, with some kind
19703     *   of animation for that item when the mode is activated.
19704     *
19705     * When a mode is activated on an item, a new view for that item is created.
19706     * The theme of this mode defines the animation that will be used to transit
19707     * the item from the old view to the new view. This second (new) view will be
19708     * active for that item while the mode is active on the item, and will be
19709     * destroyed after the mode is totally deactivated from that item.
19710     *
19711     * @see elm_genlist_mode_get()
19712     * @see elm_genlist_mode_item_get()
19713     *
19714     * @ingroup Genlist
19715     */
19716    EAPI void               elm_genlist_item_mode_set(Elm_Genlist_Item *it, const char *mode_type, Eina_Bool mode_set) EINA_ARG_NONNULL(1, 2);
19717    /**
19718     * Get the last (or current) genlist mode used.
19719     *
19720     * @param obj The genlist object
19721     *
19722     * This function just returns the name of the last used genlist mode. It will
19723     * be the current mode if it's still active.
19724     *
19725     * @see elm_genlist_item_mode_set()
19726     * @see elm_genlist_mode_item_get()
19727     *
19728     * @ingroup Genlist
19729     */
19730    EAPI const char        *elm_genlist_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19731    /**
19732     * Get active genlist mode item
19733     *
19734     * @param obj The genlist object
19735     * @return The active item for that current mode. Or @c NULL if no item is
19736     * activated with any mode.
19737     *
19738     * This function returns the item that was activated with a mode, by the
19739     * function elm_genlist_item_mode_set().
19740     *
19741     * @see elm_genlist_item_mode_set()
19742     * @see elm_genlist_mode_get()
19743     *
19744     * @ingroup Genlist
19745     */
19746    EAPI const Elm_Genlist_Item *elm_genlist_mode_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19747
19748    /**
19749     * Set reorder mode
19750     *
19751     * @param obj The genlist object
19752     * @param reorder_mode The reorder mode
19753     * (EINA_TRUE = on, EINA_FALSE = off)
19754     *
19755     * @ingroup Genlist
19756     */
19757    EAPI void               elm_genlist_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
19758
19759    /**
19760     * Get the reorder mode
19761     *
19762     * @param obj The genlist object
19763     * @return The reorder mode
19764     * (EINA_TRUE = on, EINA_FALSE = off)
19765     *
19766     * @ingroup Genlist
19767     */
19768    EAPI Eina_Bool          elm_genlist_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19769
19770    /**
19771     * @}
19772     */
19773
19774    /**
19775     * @defgroup Check Check
19776     *
19777     * @image html img/widget/check/preview-00.png
19778     * @image latex img/widget/check/preview-00.eps
19779     * @image html img/widget/check/preview-01.png
19780     * @image latex img/widget/check/preview-01.eps
19781     * @image html img/widget/check/preview-02.png
19782     * @image latex img/widget/check/preview-02.eps
19783     *
19784     * @brief The check widget allows for toggling a value between true and
19785     * false.
19786     *
19787     * Check objects are a lot like radio objects in layout and functionality
19788     * except they do not work as a group, but independently and only toggle the
19789     * value of a boolean from false to true (0 or 1). elm_check_state_set() sets
19790     * the boolean state (1 for true, 0 for false), and elm_check_state_get()
19791     * returns the current state. For convenience, like the radio objects, you
19792     * can set a pointer to a boolean directly with elm_check_state_pointer_set()
19793     * for it to modify.
19794     *
19795     * Signals that you can add callbacks for are:
19796     * "changed" - This is called whenever the user changes the state of one of
19797     *             the check object(event_info is NULL).
19798     *
19799     * Default contents parts of the check widget that you can use for are:
19800     * @li "elm.swallow.content" - A icon of the check
19801     *
19802     * Default text parts of the check widget that you can use for are:
19803     * @li "elm.text" - Label of the check
19804     *
19805     * @ref tutorial_check should give you a firm grasp of how to use this widget
19806     * .
19807     * @{
19808     */
19809    /**
19810     * @brief Add a new Check object
19811     *
19812     * @param parent The parent object
19813     * @return The new object or NULL if it cannot be created
19814     */
19815    EAPI Evas_Object *elm_check_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19816    /**
19817     * @brief Set the text label of the check object
19818     *
19819     * @param obj The check object
19820     * @param label The text label string in UTF-8
19821     *
19822     * @deprecated use elm_object_text_set() instead.
19823     */
19824    EINA_DEPRECATED EAPI void         elm_check_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
19825    /**
19826     * @brief Get the text label of the check object
19827     *
19828     * @param obj The check object
19829     * @return The text label string in UTF-8
19830     *
19831     * @deprecated use elm_object_text_get() instead.
19832     */
19833    EINA_DEPRECATED EAPI const char  *elm_check_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19834    /**
19835     * @brief Set the icon object of the check object
19836     *
19837     * @param obj The check object
19838     * @param icon The icon object
19839     *
19840     * Once the icon object is set, a previously set one will be deleted.
19841     * If you want to keep that old content object, use the
19842     * elm_object_content_unset() function.
19843     *
19844     * @deprecated use elm_object_content_set() instead.
19845     */
19846    EINA_DEPRECATED EAPI void         elm_check_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
19847    /**
19848     * @brief Get the icon object of the check object
19849     *
19850     * @param obj The check object
19851     * @return The icon object
19852     */
19853    EINA_DEPRECATED EAPI Evas_Object *elm_check_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19854    /**
19855     * @brief Unset the icon used for the check object
19856     *
19857     * @param obj The check object
19858     * @return The icon object that was being used
19859     *
19860     * Unparent and return the icon object which was set for this widget.
19861     *
19862     * @deprecated use elm_object_content_unset() instead.
19863     */
19864    EINA_DEPRECATED EAPI Evas_Object *elm_check_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
19865    /**
19866     * @brief Set the on/off state of the check object
19867     *
19868     * @param obj The check object
19869     * @param state The state to use (1 == on, 0 == off)
19870     *
19871     * This sets the state of the check. If set
19872     * with elm_check_state_pointer_set() the state of that variable is also
19873     * changed. Calling this @b doesn't cause the "changed" signal to be emited.
19874     */
19875    EAPI void         elm_check_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
19876    /**
19877     * @brief Get the state of the check object
19878     *
19879     * @param obj The check object
19880     * @return The boolean state
19881     */
19882    EAPI Eina_Bool    elm_check_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19883    /**
19884     * @brief Set a convenience pointer to a boolean to change
19885     *
19886     * @param obj The check object
19887     * @param statep Pointer to the boolean to modify
19888     *
19889     * This sets a pointer to a boolean, that, in addition to the check objects
19890     * state will also be modified directly. To stop setting the object pointed
19891     * to simply use NULL as the @p statep parameter. If @p statep is not NULL,
19892     * then when this is called, the check objects state will also be modified to
19893     * reflect the value of the boolean @p statep points to, just like calling
19894     * elm_check_state_set().
19895     */
19896    EAPI void         elm_check_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
19897    EINA_DEPRECATED EAPI void         elm_check_states_labels_set(Evas_Object *obj, const char *ontext, const char *offtext) EINA_ARG_NONNULL(1,2,3);
19898    EINA_DEPRECATED EAPI void         elm_check_states_labels_get(const Evas_Object *obj, const char **ontext, const char **offtext) EINA_ARG_NONNULL(1,2,3);
19899
19900    /**
19901     * @}
19902     */
19903
19904    /**
19905     * @defgroup Radio Radio
19906     *
19907     * @image html img/widget/radio/preview-00.png
19908     * @image latex img/widget/radio/preview-00.eps
19909     *
19910     * @brief Radio is a widget that allows for 1 or more options to be displayed
19911     * and have the user choose only 1 of them.
19912     *
19913     * A radio object contains an indicator, an optional Label and an optional
19914     * icon object. While it's possible to have a group of only one radio they,
19915     * are normally used in groups of 2 or more. To add a radio to a group use
19916     * elm_radio_group_add(). The radio object(s) will select from one of a set
19917     * of integer values, so any value they are configuring needs to be mapped to
19918     * a set of integers. To configure what value that radio object represents,
19919     * use  elm_radio_state_value_set() to set the integer it represents. To set
19920     * the value the whole group(which one is currently selected) is to indicate
19921     * use elm_radio_value_set() on any group member, and to get the groups value
19922     * use elm_radio_value_get(). For convenience the radio objects are also able
19923     * to directly set an integer(int) to the value that is selected. To specify
19924     * the pointer to this integer to modify, use elm_radio_value_pointer_set().
19925     * The radio objects will modify this directly. That implies the pointer must
19926     * point to valid memory for as long as the radio objects exist.
19927     *
19928     * Signals that you can add callbacks for are:
19929     * @li changed - This is called whenever the user changes the state of one of
19930     * the radio objects within the group of radio objects that work together.
19931     *
19932     * Default contents parts of the radio widget that you can use for are:
19933     * @li "elm.swallow.content" - A icon of the radio
19934     *
19935     * @ref tutorial_radio show most of this API in action.
19936     * @{
19937     */
19938    /**
19939     * @brief Add a new radio to the parent
19940     *
19941     * @param parent The parent object
19942     * @return The new object or NULL if it cannot be created
19943     */
19944    EAPI Evas_Object *elm_radio_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19945    /**
19946     * @brief Set the text label of the radio object
19947     *
19948     * @param obj The radio object
19949     * @param label The text label string in UTF-8
19950     *
19951     * @deprecated use elm_object_text_set() instead.
19952     */
19953    EINA_DEPRECATED EAPI void         elm_radio_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
19954    /**
19955     * @brief Get the text label of the radio object
19956     *
19957     * @param obj The radio object
19958     * @return The text label string in UTF-8
19959     *
19960     * @deprecated use elm_object_text_set() instead.
19961     */
19962    EINA_DEPRECATED EAPI const char  *elm_radio_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19963    /**
19964     * @brief Set the icon object of the radio object
19965     *
19966     * @param obj The radio object
19967     * @param icon The icon object
19968     *
19969     * Once the icon object is set, a previously set one will be deleted. If you
19970     * want to keep that old content object, use the elm_radio_icon_unset()
19971     * function.
19972     &
19973     * @deprecated use elm_object_content_set() instead.
19974     */
19975    EINA_DEPRECATED EAPI void         elm_radio_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
19976    /**
19977     * @brief Get the icon object of the radio object
19978     *
19979     * @param obj The radio object
19980     * @return The icon object
19981     *
19982     * @see elm_radio_icon_set()
19983     */
19984    EINA_DEPRECATED EAPI Evas_Object *elm_radio_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19985    /**
19986     * @brief Unset the icon used for the radio object
19987     *
19988     * @param obj The radio object
19989     * @return The icon object that was being used
19990     *
19991     * Unparent and return the icon object which was set for this widget.
19992     *
19993     * @see elm_radio_icon_set()
19994     * @deprecated use elm_object_content_unset() instead.
19995     */
19996    EINA_DEPRECATED EAPI Evas_Object *elm_radio_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
19997    /**
19998     * @brief Add this radio to a group of other radio objects
19999     *
20000     * @param obj The radio object
20001     * @param group Any object whose group the @p obj is to join.
20002     *
20003     * Radio objects work in groups. Each member should have a different integer
20004     * value assigned. In order to have them work as a group, they need to know
20005     * about each other. This adds the given radio object to the group of which
20006     * the group object indicated is a member.
20007     */
20008    EAPI void         elm_radio_group_add(Evas_Object *obj, Evas_Object *group) EINA_ARG_NONNULL(1);
20009    /**
20010     * @brief Set the integer value that this radio object represents
20011     *
20012     * @param obj The radio object
20013     * @param value The value to use if this radio object is selected
20014     *
20015     * This sets the value of the radio.
20016     */
20017    EAPI void         elm_radio_state_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
20018    /**
20019     * @brief Get the integer value that this radio object represents
20020     *
20021     * @param obj The radio object
20022     * @return The value used if this radio object is selected
20023     *
20024     * This gets the value of the radio.
20025     *
20026     * @see elm_radio_value_set()
20027     */
20028    EAPI int          elm_radio_state_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20029    /**
20030     * @brief Set the value of the radio.
20031     *
20032     * @param obj The radio object
20033     * @param value The value to use for the group
20034     *
20035     * This sets the value of the radio group and will also set the value if
20036     * pointed to, to the value supplied, but will not call any callbacks.
20037     */
20038    EAPI void         elm_radio_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
20039    /**
20040     * @brief Get the state of the radio object
20041     *
20042     * @param obj The radio object
20043     * @return The integer state
20044     */
20045    EAPI int          elm_radio_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20046    /**
20047     * @brief Set a convenience pointer to a integer to change
20048     *
20049     * @param obj The radio object
20050     * @param valuep Pointer to the integer to modify
20051     *
20052     * This sets a pointer to a integer, that, in addition to the radio objects
20053     * state will also be modified directly. To stop setting the object pointed
20054     * to simply use NULL as the @p valuep argument. If valuep is not NULL, then
20055     * when this is called, the radio objects state will also be modified to
20056     * reflect the value of the integer valuep points to, just like calling
20057     * elm_radio_value_set().
20058     */
20059    EAPI void         elm_radio_value_pointer_set(Evas_Object *obj, int *valuep) EINA_ARG_NONNULL(1);
20060    /**
20061     * @}
20062     */
20063
20064    /**
20065     * @defgroup Pager Pager
20066     *
20067     * @image html img/widget/pager/preview-00.png
20068     * @image latex img/widget/pager/preview-00.eps
20069     *
20070     * @brief Widget that allows flipping between 1 or more ā€œpagesā€ of objects.
20071     *
20072     * The flipping between ā€œpagesā€ of objects is animated. All content in pager
20073     * is kept in a stack, the last content to be added will be on the top of the
20074     * stack(be visible).
20075     *
20076     * Objects can be pushed or popped from the stack or deleted as normal.
20077     * Pushes and pops will animate (and a pop will delete the object once the
20078     * animation is finished). Any object already in the pager can be promoted to
20079     * the top(from its current stacking position) through the use of
20080     * elm_pager_content_promote(). Objects are pushed to the top with
20081     * elm_pager_content_push() and when the top item is no longer wanted, simply
20082     * pop it with elm_pager_content_pop() and it will also be deleted. If an
20083     * object is no longer needed and is not the top item, just delete it as
20084     * normal. You can query which objects are the top and bottom with
20085     * elm_pager_content_bottom_get() and elm_pager_content_top_get().
20086     *
20087     * Signals that you can add callbacks for are:
20088     * "hide,finished" - when the previous page is hided
20089     *
20090     * This widget has the following styles available:
20091     * @li default
20092     * @li fade
20093     * @li fade_translucide
20094     * @li fade_invisible
20095     * @note This styles affect only the flipping animations, the appearance when
20096     * not animating is unaffected by styles.
20097     *
20098     * @ref tutorial_pager gives a good overview of the usage of the API.
20099     * @{
20100     */
20101    /**
20102     * Add a new pager to the parent
20103     *
20104     * @param parent The parent object
20105     * @return The new object or NULL if it cannot be created
20106     *
20107     * @ingroup Pager
20108     */
20109    EAPI Evas_Object *elm_pager_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20110    /**
20111     * @brief Push an object to the top of the pager stack (and show it).
20112     *
20113     * @param obj The pager object
20114     * @param content The object to push
20115     *
20116     * The object pushed becomes a child of the pager, it will be controlled and
20117     * deleted when the pager is deleted.
20118     *
20119     * @note If the content is already in the stack use
20120     * elm_pager_content_promote().
20121     * @warning Using this function on @p content already in the stack results in
20122     * undefined behavior.
20123     */
20124    EAPI void         elm_pager_content_push(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20125    /**
20126     * @brief Pop the object that is on top of the stack
20127     *
20128     * @param obj The pager object
20129     *
20130     * This pops the object that is on the top(visible) of the pager, makes it
20131     * disappear, then deletes the object. The object that was underneath it on
20132     * the stack will become visible.
20133     */
20134    EAPI void         elm_pager_content_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
20135    /**
20136     * @brief Moves an object already in the pager stack to the top of the stack.
20137     *
20138     * @param obj The pager object
20139     * @param content The object to promote
20140     *
20141     * This will take the @p content and move it to the top of the stack as
20142     * if it had been pushed there.
20143     *
20144     * @note If the content isn't already in the stack use
20145     * elm_pager_content_push().
20146     * @warning Using this function on @p content not already in the stack
20147     * results in undefined behavior.
20148     */
20149    EAPI void         elm_pager_content_promote(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20150    /**
20151     * @brief Return the object at the bottom of the pager stack
20152     *
20153     * @param obj The pager object
20154     * @return The bottom object or NULL if none
20155     */
20156    EAPI Evas_Object *elm_pager_content_bottom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20157    /**
20158     * @brief  Return the object at the top of the pager stack
20159     *
20160     * @param obj The pager object
20161     * @return The top object or NULL if none
20162     */
20163    EAPI Evas_Object *elm_pager_content_top_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20164
20165    /**
20166     * @}
20167     */
20168
20169    /**
20170     * @defgroup Slideshow Slideshow
20171     *
20172     * @image html img/widget/slideshow/preview-00.png
20173     * @image latex img/widget/slideshow/preview-00.eps
20174     *
20175     * This widget, as the name indicates, is a pre-made image
20176     * slideshow panel, with API functions acting on (child) image
20177     * items presentation. Between those actions, are:
20178     * - advance to next/previous image
20179     * - select the style of image transition animation
20180     * - set the exhibition time for each image
20181     * - start/stop the slideshow
20182     *
20183     * The transition animations are defined in the widget's theme,
20184     * consequently new animations can be added without having to
20185     * update the widget's code.
20186     *
20187     * @section Slideshow_Items Slideshow items
20188     *
20189     * For slideshow items, just like for @ref Genlist "genlist" ones,
20190     * the user defines a @b classes, specifying functions that will be
20191     * called on the item's creation and deletion times.
20192     *
20193     * The #Elm_Slideshow_Item_Class structure contains the following
20194     * members:
20195     *
20196     * - @c func.get - When an item is displayed, this function is
20197     *   called, and it's where one should create the item object, de
20198     *   facto. For example, the object can be a pure Evas image object
20199     *   or an Elementary @ref Photocam "photocam" widget. See
20200     *   #SlideshowItemGetFunc.
20201     * - @c func.del - When an item is no more displayed, this function
20202     *   is called, where the user must delete any data associated to
20203     *   the item. See #SlideshowItemDelFunc.
20204     *
20205     * @section Slideshow_Caching Slideshow caching
20206     *
20207     * The slideshow provides facilities to have items adjacent to the
20208     * one being displayed <b>already "realized"</b> (i.e. loaded) for
20209     * you, so that the system does not have to decode image data
20210     * anymore at the time it has to actually switch images on its
20211     * viewport. The user is able to set the numbers of items to be
20212     * cached @b before and @b after the current item, in the widget's
20213     * item list.
20214     *
20215     * Smart events one can add callbacks for are:
20216     *
20217     * - @c "changed" - when the slideshow switches its view to a new
20218     *   item
20219     *
20220     * List of examples for the slideshow widget:
20221     * @li @ref slideshow_example
20222     */
20223
20224    /**
20225     * @addtogroup Slideshow
20226     * @{
20227     */
20228
20229    typedef struct _Elm_Slideshow_Item_Class Elm_Slideshow_Item_Class; /**< Slideshow item class definition struct */
20230    typedef struct _Elm_Slideshow_Item_Class_Func Elm_Slideshow_Item_Class_Func; /**< Class functions for slideshow item classes. */
20231    typedef struct _Elm_Slideshow_Item       Elm_Slideshow_Item; /**< Slideshow item handle */
20232    typedef Evas_Object *(*SlideshowItemGetFunc) (void *data, Evas_Object *obj); /**< Image fetching class function for slideshow item classes. */
20233    typedef void         (*SlideshowItemDelFunc) (void *data, Evas_Object *obj); /**< Deletion class function for slideshow item classes. */
20234
20235    /**
20236     * @struct _Elm_Slideshow_Item_Class
20237     *
20238     * Slideshow item class definition. See @ref Slideshow_Items for
20239     * field details.
20240     */
20241    struct _Elm_Slideshow_Item_Class
20242      {
20243         struct _Elm_Slideshow_Item_Class_Func
20244           {
20245              SlideshowItemGetFunc get;
20246              SlideshowItemDelFunc del;
20247           } func;
20248      }; /**< #Elm_Slideshow_Item_Class member definitions */
20249
20250    /**
20251     * Add a new slideshow widget to the given parent Elementary
20252     * (container) object
20253     *
20254     * @param parent The parent object
20255     * @return A new slideshow widget handle or @c NULL, on errors
20256     *
20257     * This function inserts a new slideshow widget on the canvas.
20258     *
20259     * @ingroup Slideshow
20260     */
20261    EAPI Evas_Object        *elm_slideshow_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20262
20263    /**
20264     * Add (append) a new item in a given slideshow widget.
20265     *
20266     * @param obj The slideshow object
20267     * @param itc The item class for the item
20268     * @param data The item's data
20269     * @return A handle to the item added or @c NULL, on errors
20270     *
20271     * Add a new item to @p obj's internal list of items, appending it.
20272     * The item's class must contain the function really fetching the
20273     * image object to show for this item, which could be an Evas image
20274     * object or an Elementary photo, for example. The @p data
20275     * parameter is going to be passed to both class functions of the
20276     * item.
20277     *
20278     * @see #Elm_Slideshow_Item_Class
20279     * @see elm_slideshow_item_sorted_insert()
20280     *
20281     * @ingroup Slideshow
20282     */
20283    EAPI Elm_Slideshow_Item *elm_slideshow_item_add(Evas_Object *obj, const Elm_Slideshow_Item_Class *itc, const void *data) EINA_ARG_NONNULL(1);
20284
20285    /**
20286     * Insert a new item into the given slideshow widget, using the @p func
20287     * function to sort items (by item handles).
20288     *
20289     * @param obj The slideshow object
20290     * @param itc The item class for the item
20291     * @param data The item's data
20292     * @param func The comparing function to be used to sort slideshow
20293     * items <b>by #Elm_Slideshow_Item item handles</b>
20294     * @return Returns The slideshow item handle, on success, or
20295     * @c NULL, on errors
20296     *
20297     * Add a new item to @p obj's internal list of items, in a position
20298     * determined by the @p func comparing function. The item's class
20299     * must contain the function really fetching the image object to
20300     * show for this item, which could be an Evas image object or an
20301     * Elementary photo, for example. The @p data parameter is going to
20302     * be passed to both class functions of the item.
20303     *
20304     * @see #Elm_Slideshow_Item_Class
20305     * @see elm_slideshow_item_add()
20306     *
20307     * @ingroup Slideshow
20308     */
20309    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);
20310
20311    /**
20312     * Display a given slideshow widget's item, programmatically.
20313     *
20314     * @param obj The slideshow object
20315     * @param item The item to display on @p obj's viewport
20316     *
20317     * The change between the current item and @p item will use the
20318     * transition @p obj is set to use (@see
20319     * elm_slideshow_transition_set()).
20320     *
20321     * @ingroup Slideshow
20322     */
20323    EAPI void                elm_slideshow_show(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
20324
20325    /**
20326     * Slide to the @b next item, in a given slideshow widget
20327     *
20328     * @param obj The slideshow object
20329     *
20330     * The sliding animation @p obj is set to use will be the
20331     * transition effect used, after this call is issued.
20332     *
20333     * @note If the end of the slideshow's internal list of items is
20334     * reached, it'll wrap around to the list's beginning, again.
20335     *
20336     * @ingroup Slideshow
20337     */
20338    EAPI void                elm_slideshow_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
20339
20340    /**
20341     * Slide to the @b previous item, in a given slideshow widget
20342     *
20343     * @param obj The slideshow object
20344     *
20345     * The sliding animation @p obj is set to use will be the
20346     * transition effect used, after this call is issued.
20347     *
20348     * @note If the beginning of the slideshow's internal list of items
20349     * is reached, it'll wrap around to the list's end, again.
20350     *
20351     * @ingroup Slideshow
20352     */
20353    EAPI void                elm_slideshow_previous(Evas_Object *obj) EINA_ARG_NONNULL(1);
20354
20355    /**
20356     * Returns the list of sliding transition/effect names available, for a
20357     * given slideshow widget.
20358     *
20359     * @param obj The slideshow object
20360     * @return The list of transitions (list of @b stringshared strings
20361     * as data)
20362     *
20363     * The transitions, which come from @p obj's theme, must be an EDC
20364     * data item named @c "transitions" on the theme file, with (prefix)
20365     * names of EDC programs actually implementing them.
20366     *
20367     * The available transitions for slideshows on the default theme are:
20368     * - @c "fade" - the current item fades out, while the new one
20369     *   fades in to the slideshow's viewport.
20370     * - @c "black_fade" - the current item fades to black, and just
20371     *   then, the new item will fade in.
20372     * - @c "horizontal" - the current item slides horizontally, until
20373     *   it gets out of the slideshow's viewport, while the new item
20374     *   comes from the left to take its place.
20375     * - @c "vertical" - the current item slides vertically, until it
20376     *   gets out of the slideshow's viewport, while the new item comes
20377     *   from the bottom to take its place.
20378     * - @c "square" - the new item starts to appear from the middle of
20379     *   the current one, but with a tiny size, growing until its
20380     *   target (full) size and covering the old one.
20381     *
20382     * @warning The stringshared strings get no new references
20383     * exclusive to the user grabbing the list, here, so if you'd like
20384     * to use them out of this call's context, you'd better @c
20385     * eina_stringshare_ref() them.
20386     *
20387     * @see elm_slideshow_transition_set()
20388     *
20389     * @ingroup Slideshow
20390     */
20391    EAPI const Eina_List    *elm_slideshow_transitions_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20392
20393    /**
20394     * Set the current slide transition/effect in use for a given
20395     * slideshow widget
20396     *
20397     * @param obj The slideshow object
20398     * @param transition The new transition's name string
20399     *
20400     * If @p transition is implemented in @p obj's theme (i.e., is
20401     * contained in the list returned by
20402     * elm_slideshow_transitions_get()), this new sliding effect will
20403     * be used on the widget.
20404     *
20405     * @see elm_slideshow_transitions_get() for more details
20406     *
20407     * @ingroup Slideshow
20408     */
20409    EAPI void                elm_slideshow_transition_set(Evas_Object *obj, const char *transition) EINA_ARG_NONNULL(1);
20410
20411    /**
20412     * Get the current slide transition/effect in use for a given
20413     * slideshow widget
20414     *
20415     * @param obj The slideshow object
20416     * @return The current transition's name
20417     *
20418     * @see elm_slideshow_transition_set() for more details
20419     *
20420     * @ingroup Slideshow
20421     */
20422    EAPI const char         *elm_slideshow_transition_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20423
20424    /**
20425     * Set the interval between each image transition on a given
20426     * slideshow widget, <b>and start the slideshow, itself</b>
20427     *
20428     * @param obj The slideshow object
20429     * @param timeout The new displaying timeout for images
20430     *
20431     * After this call, the slideshow widget will start cycling its
20432     * view, sequentially and automatically, with the images of the
20433     * items it has. The time between each new image displayed is going
20434     * to be @p timeout, in @b seconds. If a different timeout was set
20435     * previously and an slideshow was in progress, it will continue
20436     * with the new time between transitions, after this call.
20437     *
20438     * @note A value less than or equal to 0 on @p timeout will disable
20439     * the widget's internal timer, thus halting any slideshow which
20440     * could be happening on @p obj.
20441     *
20442     * @see elm_slideshow_timeout_get()
20443     *
20444     * @ingroup Slideshow
20445     */
20446    EAPI void                elm_slideshow_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
20447
20448    /**
20449     * Get the interval set for image transitions on a given slideshow
20450     * widget.
20451     *
20452     * @param obj The slideshow object
20453     * @return Returns the timeout set on it
20454     *
20455     * @see elm_slideshow_timeout_set() for more details
20456     *
20457     * @ingroup Slideshow
20458     */
20459    EAPI double              elm_slideshow_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20460
20461    /**
20462     * Set if, after a slideshow is started, for a given slideshow
20463     * widget, its items should be displayed cyclically or not.
20464     *
20465     * @param obj The slideshow object
20466     * @param loop Use @c EINA_TRUE to make it cycle through items or
20467     * @c EINA_FALSE for it to stop at the end of @p obj's internal
20468     * list of items
20469     *
20470     * @note elm_slideshow_next() and elm_slideshow_previous() will @b
20471     * ignore what is set by this functions, i.e., they'll @b always
20472     * cycle through items. This affects only the "automatic"
20473     * slideshow, as set by elm_slideshow_timeout_set().
20474     *
20475     * @see elm_slideshow_loop_get()
20476     *
20477     * @ingroup Slideshow
20478     */
20479    EAPI void                elm_slideshow_loop_set(Evas_Object *obj, Eina_Bool loop) EINA_ARG_NONNULL(1);
20480
20481    /**
20482     * Get if, after a slideshow is started, for a given slideshow
20483     * widget, its items are to be displayed cyclically or not.
20484     *
20485     * @param obj The slideshow object
20486     * @return @c EINA_TRUE, if the items in @p obj will be cycled
20487     * through or @c EINA_FALSE, otherwise
20488     *
20489     * @see elm_slideshow_loop_set() for more details
20490     *
20491     * @ingroup Slideshow
20492     */
20493    EAPI Eina_Bool           elm_slideshow_loop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20494
20495    /**
20496     * Remove all items from a given slideshow widget
20497     *
20498     * @param obj The slideshow object
20499     *
20500     * This removes (and deletes) all items in @p obj, leaving it
20501     * empty.
20502     *
20503     * @see elm_slideshow_item_del(), to remove just one item.
20504     *
20505     * @ingroup Slideshow
20506     */
20507    EAPI void                elm_slideshow_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
20508
20509    /**
20510     * Get the internal list of items in a given slideshow widget.
20511     *
20512     * @param obj The slideshow object
20513     * @return The list of items (#Elm_Slideshow_Item as data) or
20514     * @c NULL on errors.
20515     *
20516     * This list is @b not to be modified in any way and must not be
20517     * freed. Use the list members with functions like
20518     * elm_slideshow_item_del(), elm_slideshow_item_data_get().
20519     *
20520     * @warning This list is only valid until @p obj object's internal
20521     * items list is changed. It should be fetched again with another
20522     * call to this function when changes happen.
20523     *
20524     * @ingroup Slideshow
20525     */
20526    EAPI const Eina_List    *elm_slideshow_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20527
20528    /**
20529     * Delete a given item from a slideshow widget.
20530     *
20531     * @param item The slideshow item
20532     *
20533     * @ingroup Slideshow
20534     */
20535    EAPI void                elm_slideshow_item_del(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
20536
20537    /**
20538     * Return the data associated with a given slideshow item
20539     *
20540     * @param item The slideshow item
20541     * @return Returns the data associated to this item
20542     *
20543     * @ingroup Slideshow
20544     */
20545    EAPI void               *elm_slideshow_item_data_get(const Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
20546
20547    /**
20548     * Returns the currently displayed item, in a given slideshow widget
20549     *
20550     * @param obj The slideshow object
20551     * @return A handle to the item being displayed in @p obj or
20552     * @c NULL, if none is (and on errors)
20553     *
20554     * @ingroup Slideshow
20555     */
20556    EAPI Elm_Slideshow_Item *elm_slideshow_item_current_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20557
20558    /**
20559     * Get the real Evas object created to implement the view of a
20560     * given slideshow item
20561     *
20562     * @param item The slideshow item.
20563     * @return the Evas object implementing this item's view.
20564     *
20565     * This returns the actual Evas object used to implement the
20566     * specified slideshow item's view. This may be @c NULL, as it may
20567     * not have been created or may have been deleted, at any time, by
20568     * the slideshow. <b>Do not modify this object</b> (move, resize,
20569     * show, hide, etc.), as the slideshow is controlling it. This
20570     * function is for querying, emitting custom signals or hooking
20571     * lower level callbacks for events on that object. Do not delete
20572     * this object under any circumstances.
20573     *
20574     * @see elm_slideshow_item_data_get()
20575     *
20576     * @ingroup Slideshow
20577     */
20578    EAPI Evas_Object*        elm_slideshow_item_object_get(const Elm_Slideshow_Item* item) EINA_ARG_NONNULL(1);
20579
20580    /**
20581     * Get the the item, in a given slideshow widget, placed at
20582     * position @p nth, in its internal items list
20583     *
20584     * @param obj The slideshow object
20585     * @param nth The number of the item to grab a handle to (0 being
20586     * the first)
20587     * @return The item stored in @p obj at position @p nth or @c NULL,
20588     * if there's no item with that index (and on errors)
20589     *
20590     * @ingroup Slideshow
20591     */
20592    EAPI Elm_Slideshow_Item *elm_slideshow_item_nth_get(const Evas_Object *obj, unsigned int nth) EINA_ARG_NONNULL(1);
20593
20594    /**
20595     * Set the current slide layout in use for a given slideshow widget
20596     *
20597     * @param obj The slideshow object
20598     * @param layout The new layout's name string
20599     *
20600     * If @p layout is implemented in @p obj's theme (i.e., is contained
20601     * in the list returned by elm_slideshow_layouts_get()), this new
20602     * images layout will be used on the widget.
20603     *
20604     * @see elm_slideshow_layouts_get() for more details
20605     *
20606     * @ingroup Slideshow
20607     */
20608    EAPI void                elm_slideshow_layout_set(Evas_Object *obj, const char *layout) EINA_ARG_NONNULL(1);
20609
20610    /**
20611     * Get the current slide layout in use for a given slideshow widget
20612     *
20613     * @param obj The slideshow object
20614     * @return The current layout's name
20615     *
20616     * @see elm_slideshow_layout_set() for more details
20617     *
20618     * @ingroup Slideshow
20619     */
20620    EAPI const char         *elm_slideshow_layout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20621
20622    /**
20623     * Returns the list of @b layout names available, for a given
20624     * slideshow widget.
20625     *
20626     * @param obj The slideshow object
20627     * @return The list of layouts (list of @b stringshared strings
20628     * as data)
20629     *
20630     * Slideshow layouts will change how the widget is to dispose each
20631     * image item in its viewport, with regard to cropping, scaling,
20632     * etc.
20633     *
20634     * The layouts, which come from @p obj's theme, must be an EDC
20635     * data item name @c "layouts" on the theme file, with (prefix)
20636     * names of EDC programs actually implementing them.
20637     *
20638     * The available layouts for slideshows on the default theme are:
20639     * - @c "fullscreen" - item images with original aspect, scaled to
20640     *   touch top and down slideshow borders or, if the image's heigh
20641     *   is not enough, left and right slideshow borders.
20642     * - @c "not_fullscreen" - the same behavior as the @c "fullscreen"
20643     *   one, but always leaving 10% of the slideshow's dimensions of
20644     *   distance between the item image's borders and the slideshow
20645     *   borders, for each axis.
20646     *
20647     * @warning The stringshared strings get no new references
20648     * exclusive to the user grabbing the list, here, so if you'd like
20649     * to use them out of this call's context, you'd better @c
20650     * eina_stringshare_ref() them.
20651     *
20652     * @see elm_slideshow_layout_set()
20653     *
20654     * @ingroup Slideshow
20655     */
20656    EAPI const Eina_List    *elm_slideshow_layouts_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20657
20658    /**
20659     * Set the number of items to cache, on a given slideshow widget,
20660     * <b>before the current item</b>
20661     *
20662     * @param obj The slideshow object
20663     * @param count Number of items to cache before the current one
20664     *
20665     * The default value for this property is @c 2. See
20666     * @ref Slideshow_Caching "slideshow caching" for more details.
20667     *
20668     * @see elm_slideshow_cache_before_get()
20669     *
20670     * @ingroup Slideshow
20671     */
20672    EAPI void                elm_slideshow_cache_before_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
20673
20674    /**
20675     * Retrieve the number of items to cache, on a given slideshow widget,
20676     * <b>before the current item</b>
20677     *
20678     * @param obj The slideshow object
20679     * @return The number of items set to be cached before the current one
20680     *
20681     * @see elm_slideshow_cache_before_set() for more details
20682     *
20683     * @ingroup Slideshow
20684     */
20685    EAPI int                 elm_slideshow_cache_before_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20686
20687    /**
20688     * Set the number of items to cache, on a given slideshow widget,
20689     * <b>after the current item</b>
20690     *
20691     * @param obj The slideshow object
20692     * @param count Number of items to cache after the current one
20693     *
20694     * The default value for this property is @c 2. See
20695     * @ref Slideshow_Caching "slideshow caching" for more details.
20696     *
20697     * @see elm_slideshow_cache_after_get()
20698     *
20699     * @ingroup Slideshow
20700     */
20701    EAPI void                elm_slideshow_cache_after_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
20702
20703    /**
20704     * Retrieve the number of items to cache, on a given slideshow widget,
20705     * <b>after the current item</b>
20706     *
20707     * @param obj The slideshow object
20708     * @return The number of items set to be cached after the current one
20709     *
20710     * @see elm_slideshow_cache_after_set() for more details
20711     *
20712     * @ingroup Slideshow
20713     */
20714    EAPI int                 elm_slideshow_cache_after_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20715
20716    /**
20717     * Get the number of items stored in a given slideshow widget
20718     *
20719     * @param obj The slideshow object
20720     * @return The number of items on @p obj, at the moment of this call
20721     *
20722     * @ingroup Slideshow
20723     */
20724    EAPI unsigned int        elm_slideshow_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20725
20726    /**
20727     * @}
20728     */
20729
20730    /**
20731     * @defgroup Fileselector File Selector
20732     *
20733     * @image html img/widget/fileselector/preview-00.png
20734     * @image latex img/widget/fileselector/preview-00.eps
20735     *
20736     * A file selector is a widget that allows a user to navigate
20737     * through a file system, reporting file selections back via its
20738     * API.
20739     *
20740     * It contains shortcut buttons for home directory (@c ~) and to
20741     * jump one directory upwards (..), as well as cancel/ok buttons to
20742     * confirm/cancel a given selection. After either one of those two
20743     * former actions, the file selector will issue its @c "done" smart
20744     * callback.
20745     *
20746     * There's a text entry on it, too, showing the name of the current
20747     * selection. There's the possibility of making it editable, so it
20748     * is useful on file saving dialogs on applications, where one
20749     * gives a file name to save contents to, in a given directory in
20750     * the system. This custom file name will be reported on the @c
20751     * "done" smart callback (explained in sequence).
20752     *
20753     * Finally, it has a view to display file system items into in two
20754     * possible forms:
20755     * - list
20756     * - grid
20757     *
20758     * If Elementary is built with support of the Ethumb thumbnailing
20759     * library, the second form of view will display preview thumbnails
20760     * of files which it supports.
20761     *
20762     * Smart callbacks one can register to:
20763     *
20764     * - @c "selected" - the user has clicked on a file (when not in
20765     *      folders-only mode) or directory (when in folders-only mode)
20766     * - @c "directory,open" - the list has been populated with new
20767     *      content (@c event_info is a pointer to the directory's
20768     *      path, a @b stringshared string)
20769     * - @c "done" - the user has clicked on the "ok" or "cancel"
20770     *      buttons (@c event_info is a pointer to the selection's
20771     *      path, a @b stringshared string)
20772     *
20773     * Here is an example on its usage:
20774     * @li @ref fileselector_example
20775     */
20776
20777    /**
20778     * @addtogroup Fileselector
20779     * @{
20780     */
20781
20782    /**
20783     * Defines how a file selector widget is to layout its contents
20784     * (file system entries).
20785     */
20786    typedef enum _Elm_Fileselector_Mode
20787      {
20788         ELM_FILESELECTOR_LIST = 0, /**< layout as a list */
20789         ELM_FILESELECTOR_GRID, /**< layout as a grid */
20790         ELM_FILESELECTOR_LAST /**< sentinel (helper) value, not used */
20791      } Elm_Fileselector_Mode;
20792
20793    /**
20794     * Add a new file selector widget to the given parent Elementary
20795     * (container) object
20796     *
20797     * @param parent The parent object
20798     * @return a new file selector widget handle or @c NULL, on errors
20799     *
20800     * This function inserts a new file selector widget on the canvas.
20801     *
20802     * @ingroup Fileselector
20803     */
20804    EAPI Evas_Object          *elm_fileselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20805
20806    /**
20807     * Enable/disable the file name entry box where the user can type
20808     * in a name for a file, in a given file selector widget
20809     *
20810     * @param obj The file selector object
20811     * @param is_save @c EINA_TRUE to make the file selector a "saving
20812     * dialog", @c EINA_FALSE otherwise
20813     *
20814     * Having the entry editable is useful on file saving dialogs on
20815     * applications, where one gives a file name to save contents to,
20816     * in a given directory in the system. This custom file name will
20817     * be reported on the @c "done" smart callback.
20818     *
20819     * @see elm_fileselector_is_save_get()
20820     *
20821     * @ingroup Fileselector
20822     */
20823    EAPI void                  elm_fileselector_is_save_set(Evas_Object *obj, Eina_Bool is_save) EINA_ARG_NONNULL(1);
20824
20825    /**
20826     * Get whether the given file selector is in "saving dialog" mode
20827     *
20828     * @param obj The file selector object
20829     * @return @c EINA_TRUE, if the file selector is in "saving dialog"
20830     * mode, @c EINA_FALSE otherwise (and on errors)
20831     *
20832     * @see elm_fileselector_is_save_set() for more details
20833     *
20834     * @ingroup Fileselector
20835     */
20836    EAPI Eina_Bool             elm_fileselector_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20837
20838    /**
20839     * Enable/disable folder-only view for a given file selector widget
20840     *
20841     * @param obj The file selector object
20842     * @param only @c EINA_TRUE to make @p obj only display
20843     * directories, @c EINA_FALSE to make files to be displayed in it
20844     * too
20845     *
20846     * If enabled, the widget's view will only display folder items,
20847     * naturally.
20848     *
20849     * @see elm_fileselector_folder_only_get()
20850     *
20851     * @ingroup Fileselector
20852     */
20853    EAPI void                  elm_fileselector_folder_only_set(Evas_Object *obj, Eina_Bool only) EINA_ARG_NONNULL(1);
20854
20855    /**
20856     * Get whether folder-only view is set for a given file selector
20857     * widget
20858     *
20859     * @param obj The file selector object
20860     * @return only @c EINA_TRUE if @p obj is only displaying
20861     * directories, @c EINA_FALSE if files are being displayed in it
20862     * too (and on errors)
20863     *
20864     * @see elm_fileselector_folder_only_get()
20865     *
20866     * @ingroup Fileselector
20867     */
20868    EAPI Eina_Bool             elm_fileselector_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20869
20870    /**
20871     * Enable/disable the "ok" and "cancel" buttons on a given file
20872     * selector widget
20873     *
20874     * @param obj The file selector object
20875     * @param only @c EINA_TRUE to show them, @c EINA_FALSE to hide.
20876     *
20877     * @note A file selector without those buttons will never emit the
20878     * @c "done" smart event, and is only usable if one is just hooking
20879     * to the other two events.
20880     *
20881     * @see elm_fileselector_buttons_ok_cancel_get()
20882     *
20883     * @ingroup Fileselector
20884     */
20885    EAPI void                  elm_fileselector_buttons_ok_cancel_set(Evas_Object *obj, Eina_Bool buttons) EINA_ARG_NONNULL(1);
20886
20887    /**
20888     * Get whether the "ok" and "cancel" buttons on a given file
20889     * selector widget are being shown.
20890     *
20891     * @param obj The file selector object
20892     * @return @c EINA_TRUE if they are being shown, @c EINA_FALSE
20893     * otherwise (and on errors)
20894     *
20895     * @see elm_fileselector_buttons_ok_cancel_set() for more details
20896     *
20897     * @ingroup Fileselector
20898     */
20899    EAPI Eina_Bool             elm_fileselector_buttons_ok_cancel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20900
20901    /**
20902     * Enable/disable a tree view in the given file selector widget,
20903     * <b>if it's in @c #ELM_FILESELECTOR_LIST mode</b>
20904     *
20905     * @param obj The file selector object
20906     * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
20907     * disable
20908     *
20909     * In a tree view, arrows are created on the sides of directories,
20910     * allowing them to expand in place.
20911     *
20912     * @note If it's in other mode, the changes made by this function
20913     * will only be visible when one switches back to "list" mode.
20914     *
20915     * @see elm_fileselector_expandable_get()
20916     *
20917     * @ingroup Fileselector
20918     */
20919    EAPI void                  elm_fileselector_expandable_set(Evas_Object *obj, Eina_Bool expand) EINA_ARG_NONNULL(1);
20920
20921    /**
20922     * Get whether tree view is enabled for the given file selector
20923     * widget
20924     *
20925     * @param obj The file selector object
20926     * @return @c EINA_TRUE if @p obj is in tree view, @c EINA_FALSE
20927     * otherwise (and or errors)
20928     *
20929     * @see elm_fileselector_expandable_set() for more details
20930     *
20931     * @ingroup Fileselector
20932     */
20933    EAPI Eina_Bool             elm_fileselector_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20934
20935    /**
20936     * Set, programmatically, the @b directory that a given file
20937     * selector widget will display contents from
20938     *
20939     * @param obj The file selector object
20940     * @param path The path to display in @p obj
20941     *
20942     * This will change the @b directory that @p obj is displaying. It
20943     * will also clear the text entry area on the @p obj object, which
20944     * displays select files' names.
20945     *
20946     * @see elm_fileselector_path_get()
20947     *
20948     * @ingroup Fileselector
20949     */
20950    EAPI void                  elm_fileselector_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
20951
20952    /**
20953     * Get the parent directory's path that a given file selector
20954     * widget is displaying
20955     *
20956     * @param obj The file selector object
20957     * @return The (full) path of the directory the file selector is
20958     * displaying, a @b stringshared string
20959     *
20960     * @see elm_fileselector_path_set()
20961     *
20962     * @ingroup Fileselector
20963     */
20964    EAPI const char           *elm_fileselector_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20965
20966    /**
20967     * Set, programmatically, the currently selected file/directory in
20968     * the given file selector widget
20969     *
20970     * @param obj The file selector object
20971     * @param path The (full) path to a file or directory
20972     * @return @c EINA_TRUE on success, @c EINA_FALSE on failure. The
20973     * latter case occurs if the directory or file pointed to do not
20974     * exist.
20975     *
20976     * @see elm_fileselector_selected_get()
20977     *
20978     * @ingroup Fileselector
20979     */
20980    EAPI Eina_Bool             elm_fileselector_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
20981
20982    /**
20983     * Get the currently selected item's (full) path, in the given file
20984     * selector widget
20985     *
20986     * @param obj The file selector object
20987     * @return The absolute path of the selected item, a @b
20988     * stringshared string
20989     *
20990     * @note Custom editions on @p obj object's text entry, if made,
20991     * will appear on the return string of this function, naturally.
20992     *
20993     * @see elm_fileselector_selected_set() for more details
20994     *
20995     * @ingroup Fileselector
20996     */
20997    EAPI const char           *elm_fileselector_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20998
20999    /**
21000     * Set the mode in which a given file selector widget will display
21001     * (layout) file system entries in its view
21002     *
21003     * @param obj The file selector object
21004     * @param mode The mode of the fileselector, being it one of
21005     * #ELM_FILESELECTOR_LIST (default) or #ELM_FILESELECTOR_GRID. The
21006     * first one, naturally, will display the files in a list. The
21007     * latter will make the widget to display its entries in a grid
21008     * form.
21009     *
21010     * @note By using elm_fileselector_expandable_set(), the user may
21011     * trigger a tree view for that list.
21012     *
21013     * @note If Elementary is built with support of the Ethumb
21014     * thumbnailing library, the second form of view will display
21015     * preview thumbnails of files which it supports. You must have
21016     * elm_need_ethumb() called in your Elementary for thumbnailing to
21017     * work, though.
21018     *
21019     * @see elm_fileselector_expandable_set().
21020     * @see elm_fileselector_mode_get().
21021     *
21022     * @ingroup Fileselector
21023     */
21024    EAPI void                  elm_fileselector_mode_set(Evas_Object *obj, Elm_Fileselector_Mode mode) EINA_ARG_NONNULL(1);
21025
21026    /**
21027     * Get the mode in which a given file selector widget is displaying
21028     * (layouting) file system entries in its view
21029     *
21030     * @param obj The fileselector object
21031     * @return The mode in which the fileselector is at
21032     *
21033     * @see elm_fileselector_mode_set() for more details
21034     *
21035     * @ingroup Fileselector
21036     */
21037    EAPI Elm_Fileselector_Mode elm_fileselector_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21038
21039    /**
21040     * @}
21041     */
21042
21043    /**
21044     * @defgroup Progressbar Progress bar
21045     *
21046     * The progress bar is a widget for visually representing the
21047     * progress status of a given job/task.
21048     *
21049     * A progress bar may be horizontal or vertical. It may display an
21050     * icon besides it, as well as primary and @b units labels. The
21051     * former is meant to label the widget as a whole, while the
21052     * latter, which is formatted with floating point values (and thus
21053     * accepts a <c>printf</c>-style format string, like <c>"%1.2f
21054     * units"</c>), is meant to label the widget's <b>progress
21055     * value</b>. Label, icon and unit strings/objects are @b optional
21056     * for progress bars.
21057     *
21058     * A progress bar may be @b inverted, in which state it gets its
21059     * values inverted, with high values being on the left or top and
21060     * low values on the right or bottom, as opposed to normally have
21061     * the low values on the former and high values on the latter,
21062     * respectively, for horizontal and vertical modes.
21063     *
21064     * The @b span of the progress, as set by
21065     * elm_progressbar_span_size_set(), is its length (horizontally or
21066     * vertically), unless one puts size hints on the widget to expand
21067     * on desired directions, by any container. That length will be
21068     * scaled by the object or applications scaling factor. At any
21069     * point code can query the progress bar for its value with
21070     * elm_progressbar_value_get().
21071     *
21072     * Available widget styles for progress bars:
21073     * - @c "default"
21074     * - @c "wheel" (simple style, no text, no progression, only
21075     *      "pulse" effect is available)
21076     *
21077     * Default contents parts of the progressbar widget that you can use for are:
21078     * @li "elm.swallow.content" - A icon of the progressbar
21079     * 
21080     * Here is an example on its usage:
21081     * @li @ref progressbar_example
21082     */
21083
21084    /**
21085     * Add a new progress bar widget to the given parent Elementary
21086     * (container) object
21087     *
21088     * @param parent The parent object
21089     * @return a new progress bar widget handle or @c NULL, on errors
21090     *
21091     * This function inserts a new progress bar widget on the canvas.
21092     *
21093     * @ingroup Progressbar
21094     */
21095    EAPI Evas_Object *elm_progressbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21096
21097    /**
21098     * Set whether a given progress bar widget is at "pulsing mode" or
21099     * not.
21100     *
21101     * @param obj The progress bar object
21102     * @param pulse @c EINA_TRUE to put @p obj in pulsing mode,
21103     * @c EINA_FALSE to put it back to its default one
21104     *
21105     * By default, progress bars will display values from the low to
21106     * high value boundaries. There are, though, contexts in which the
21107     * state of progression of a given task is @b unknown.  For those,
21108     * one can set a progress bar widget to a "pulsing state", to give
21109     * the user an idea that some computation is being held, but
21110     * without exact progress values. In the default theme it will
21111     * animate its bar with the contents filling in constantly and back
21112     * to non-filled, in a loop. To start and stop this pulsing
21113     * animation, one has to explicitly call elm_progressbar_pulse().
21114     *
21115     * @see elm_progressbar_pulse_get()
21116     * @see elm_progressbar_pulse()
21117     *
21118     * @ingroup Progressbar
21119     */
21120    EAPI void         elm_progressbar_pulse_set(Evas_Object *obj, Eina_Bool pulse) EINA_ARG_NONNULL(1);
21121
21122    /**
21123     * Get whether a given progress bar widget is at "pulsing mode" or
21124     * not.
21125     *
21126     * @param obj The progress bar object
21127     * @return @c EINA_TRUE, if @p obj is in pulsing mode, @c EINA_FALSE
21128     * if it's in the default one (and on errors)
21129     *
21130     * @ingroup Progressbar
21131     */
21132    EAPI Eina_Bool    elm_progressbar_pulse_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21133
21134    /**
21135     * Start/stop a given progress bar "pulsing" animation, if its
21136     * under that mode
21137     *
21138     * @param obj The progress bar object
21139     * @param state @c EINA_TRUE, to @b start the pulsing animation,
21140     * @c EINA_FALSE to @b stop it
21141     *
21142     * @note This call won't do anything if @p obj is not under "pulsing mode".
21143     *
21144     * @see elm_progressbar_pulse_set() for more details.
21145     *
21146     * @ingroup Progressbar
21147     */
21148    EAPI void         elm_progressbar_pulse(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
21149
21150    /**
21151     * Set the progress value (in percentage) on a given progress bar
21152     * widget
21153     *
21154     * @param obj The progress bar object
21155     * @param val The progress value (@b must be between @c 0.0 and @c
21156     * 1.0)
21157     *
21158     * Use this call to set progress bar levels.
21159     *
21160     * @note If you passes a value out of the specified range for @p
21161     * val, it will be interpreted as the @b closest of the @b boundary
21162     * values in the range.
21163     *
21164     * @ingroup Progressbar
21165     */
21166    EAPI void         elm_progressbar_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
21167
21168    /**
21169     * Get the progress value (in percentage) on a given progress bar
21170     * widget
21171     *
21172     * @param obj The progress bar object
21173     * @return The value of the progressbar
21174     *
21175     * @see elm_progressbar_value_set() for more details
21176     *
21177     * @ingroup Progressbar
21178     */
21179    EAPI double       elm_progressbar_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21180
21181    /**
21182     * Set the label of a given progress bar widget
21183     *
21184     * @param obj The progress bar object
21185     * @param label The text label string, in UTF-8
21186     *
21187     * @ingroup Progressbar
21188     * @deprecated use elm_object_text_set() instead.
21189     */
21190    EINA_DEPRECATED EAPI void         elm_progressbar_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
21191
21192    /**
21193     * Get the label of a given progress bar widget
21194     *
21195     * @param obj The progressbar object
21196     * @return The text label string, in UTF-8
21197     *
21198     * @ingroup Progressbar
21199     * @deprecated use elm_object_text_set() instead.
21200     */
21201    EINA_DEPRECATED EAPI const char  *elm_progressbar_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21202
21203    /**
21204     * Set the icon object of a given progress bar widget
21205     *
21206     * @param obj The progress bar object
21207     * @param icon The icon object
21208     *
21209     * Use this call to decorate @p obj with an icon next to it.
21210     *
21211     * @note Once the icon object is set, a previously set one will be
21212     * deleted. If you want to keep that old content object, use the
21213     * elm_progressbar_icon_unset() function.
21214     *
21215     * @see elm_progressbar_icon_get()
21216     * @deprecated use elm_object_content_set() instead.
21217     *
21218     * @ingroup Progressbar
21219     */
21220    EINA_DEPRECATED EAPI void         elm_progressbar_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
21221
21222    /**
21223     * Retrieve the icon object set for a given progress bar widget
21224     *
21225     * @param obj The progress bar object
21226     * @return The icon object's handle, if @p obj had one set, or @c NULL,
21227     * otherwise (and on errors)
21228     *
21229     * @see elm_progressbar_icon_set() for more details
21230     * @deprecated use elm_object_content_set() instead.
21231     *
21232     * @ingroup Progressbar
21233     */
21234    EINA_DEPRECATED EAPI Evas_Object *elm_progressbar_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21235
21236    /**
21237     * Unset an icon set on a given progress bar widget
21238     *
21239     * @param obj The progress bar object
21240     * @return The icon object that was being used, if any was set, or
21241     * @c NULL, otherwise (and on errors)
21242     *
21243     * This call will unparent and return the icon object which was set
21244     * for this widget, previously, on success.
21245     *
21246     * @see elm_progressbar_icon_set() for more details
21247     * @deprecated use elm_object_content_unset() instead.
21248     *
21249     * @ingroup Progressbar
21250     */
21251    EINA_DEPRECATED EAPI Evas_Object *elm_progressbar_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
21252
21253    /**
21254     * Set the (exact) length of the bar region of a given progress bar
21255     * widget
21256     *
21257     * @param obj The progress bar object
21258     * @param size The length of the progress bar's bar region
21259     *
21260     * This sets the minimum width (when in horizontal mode) or height
21261     * (when in vertical mode) of the actual bar area of the progress
21262     * bar @p obj. This in turn affects the object's minimum size. Use
21263     * this when you're not setting other size hints expanding on the
21264     * given direction (like weight and alignment hints) and you would
21265     * like it to have a specific size.
21266     *
21267     * @note Icon, label and unit text around @p obj will require their
21268     * own space, which will make @p obj to require more the @p size,
21269     * actually.
21270     *
21271     * @see elm_progressbar_span_size_get()
21272     *
21273     * @ingroup Progressbar
21274     */
21275    EAPI void         elm_progressbar_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
21276
21277    /**
21278     * Get the length set for the bar region of a given progress bar
21279     * widget
21280     *
21281     * @param obj The progress bar object
21282     * @return The length of the progress bar's bar region
21283     *
21284     * If that size was not set previously, with
21285     * elm_progressbar_span_size_set(), this call will return @c 0.
21286     *
21287     * @ingroup Progressbar
21288     */
21289    EAPI Evas_Coord   elm_progressbar_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21290
21291    /**
21292     * Set the format string for a given progress bar widget's units
21293     * label
21294     *
21295     * @param obj The progress bar object
21296     * @param format The format string for @p obj's units label
21297     *
21298     * If @c NULL is passed on @p format, it will make @p obj's units
21299     * area to be hidden completely. If not, it'll set the <b>format
21300     * string</b> for the units label's @b text. The units label is
21301     * provided a floating point value, so the units text is up display
21302     * at most one floating point falue. Note that the units label is
21303     * optional. Use a format string such as "%1.2f meters" for
21304     * example.
21305     *
21306     * @note The default format string for a progress bar is an integer
21307     * percentage, as in @c "%.0f %%".
21308     *
21309     * @see elm_progressbar_unit_format_get()
21310     *
21311     * @ingroup Progressbar
21312     */
21313    EAPI void         elm_progressbar_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
21314
21315    /**
21316     * Retrieve the format string set for a given progress bar widget's
21317     * units label
21318     *
21319     * @param obj The progress bar object
21320     * @return The format set string for @p obj's units label or
21321     * @c NULL, if none was set (and on errors)
21322     *
21323     * @see elm_progressbar_unit_format_set() for more details
21324     *
21325     * @ingroup Progressbar
21326     */
21327    EAPI const char  *elm_progressbar_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21328
21329    /**
21330     * Set the orientation of a given progress bar widget
21331     *
21332     * @param obj The progress bar object
21333     * @param horizontal Use @c EINA_TRUE to make @p obj to be
21334     * @b horizontal, @c EINA_FALSE to make it @b vertical
21335     *
21336     * Use this function to change how your progress bar is to be
21337     * disposed: vertically or horizontally.
21338     *
21339     * @see elm_progressbar_horizontal_get()
21340     *
21341     * @ingroup Progressbar
21342     */
21343    EAPI void         elm_progressbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
21344
21345    /**
21346     * Retrieve the orientation of a given progress bar widget
21347     *
21348     * @param obj The progress bar object
21349     * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
21350     * @c EINA_FALSE if it's @b vertical (and on errors)
21351     *
21352     * @see elm_progressbar_horizontal_set() for more details
21353     *
21354     * @ingroup Progressbar
21355     */
21356    EAPI Eina_Bool    elm_progressbar_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21357
21358    /**
21359     * Invert a given progress bar widget's displaying values order
21360     *
21361     * @param obj The progress bar object
21362     * @param inverted Use @c EINA_TRUE to make @p obj inverted,
21363     * @c EINA_FALSE to bring it back to default, non-inverted values.
21364     *
21365     * A progress bar may be @b inverted, in which state it gets its
21366     * values inverted, with high values being on the left or top and
21367     * low values on the right or bottom, as opposed to normally have
21368     * the low values on the former and high values on the latter,
21369     * respectively, for horizontal and vertical modes.
21370     *
21371     * @see elm_progressbar_inverted_get()
21372     *
21373     * @ingroup Progressbar
21374     */
21375    EAPI void         elm_progressbar_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
21376
21377    /**
21378     * Get whether a given progress bar widget's displaying values are
21379     * inverted or not
21380     *
21381     * @param obj The progress bar object
21382     * @return @c EINA_TRUE, if @p obj has inverted values,
21383     * @c EINA_FALSE otherwise (and on errors)
21384     *
21385     * @see elm_progressbar_inverted_set() for more details
21386     *
21387     * @ingroup Progressbar
21388     */
21389    EAPI Eina_Bool    elm_progressbar_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21390
21391    /**
21392     * @defgroup Separator Separator
21393     *
21394     * @brief Separator is a very thin object used to separate other objects.
21395     *
21396     * A separator can be vertical or horizontal.
21397     *
21398     * @ref tutorial_separator is a good example of how to use a separator.
21399     * @{
21400     */
21401    /**
21402     * @brief Add a separator object to @p parent
21403     *
21404     * @param parent The parent object
21405     *
21406     * @return The separator object, or NULL upon failure
21407     */
21408    EAPI Evas_Object *elm_separator_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21409    /**
21410     * @brief Set the horizontal mode of a separator object
21411     *
21412     * @param obj The separator object
21413     * @param horizontal If true, the separator is horizontal
21414     */
21415    EAPI void         elm_separator_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
21416    /**
21417     * @brief Get the horizontal mode of a separator object
21418     *
21419     * @param obj The separator object
21420     * @return If true, the separator is horizontal
21421     *
21422     * @see elm_separator_horizontal_set()
21423     */
21424    EAPI Eina_Bool    elm_separator_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21425    /**
21426     * @}
21427     */
21428
21429    /**
21430     * @defgroup Spinner Spinner
21431     * @ingroup Elementary
21432     *
21433     * @image html img/widget/spinner/preview-00.png
21434     * @image latex img/widget/spinner/preview-00.eps
21435     *
21436     * A spinner is a widget which allows the user to increase or decrease
21437     * numeric values using arrow buttons, or edit values directly, clicking
21438     * over it and typing the new value.
21439     *
21440     * By default the spinner will not wrap and has a label
21441     * of "%.0f" (just showing the integer value of the double).
21442     *
21443     * A spinner has a label that is formatted with floating
21444     * point values and thus accepts a printf-style format string, like
21445     * ā€œ%1.2f unitsā€.
21446     *
21447     * It also allows specific values to be replaced by pre-defined labels.
21448     *
21449     * Smart callbacks one can register to:
21450     *
21451     * - "changed" - Whenever the spinner value is changed.
21452     * - "delay,changed" - A short time after the value is changed by the user.
21453     *    This will be called only when the user stops dragging for a very short
21454     *    period or when they release their finger/mouse, so it avoids possibly
21455     *    expensive reactions to the value change.
21456     *
21457     * Available styles for it:
21458     * - @c "default";
21459     * - @c "vertical": up/down buttons at the right side and text left aligned.
21460     *
21461     * Here is an example on its usage:
21462     * @ref spinner_example
21463     */
21464
21465    /**
21466     * @addtogroup Spinner
21467     * @{
21468     */
21469
21470    /**
21471     * Add a new spinner widget to the given parent Elementary
21472     * (container) object.
21473     *
21474     * @param parent The parent object.
21475     * @return a new spinner widget handle or @c NULL, on errors.
21476     *
21477     * This function inserts a new spinner widget on the canvas.
21478     *
21479     * @ingroup Spinner
21480     *
21481     */
21482    EAPI Evas_Object *elm_spinner_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21483
21484    /**
21485     * Set the format string of the displayed label.
21486     *
21487     * @param obj The spinner object.
21488     * @param fmt The format string for the label display.
21489     *
21490     * If @c NULL, this sets the format to "%.0f". If not it sets the format
21491     * string for the label text. The label text is provided a floating point
21492     * value, so the label text can display up to 1 floating point value.
21493     * Note that this is optional.
21494     *
21495     * Use a format string such as "%1.2f meters" for example, and it will
21496     * display values like: "3.14 meters" for a value equal to 3.14159.
21497     *
21498     * Default is "%0.f".
21499     *
21500     * @see elm_spinner_label_format_get()
21501     *
21502     * @ingroup Spinner
21503     */
21504    EAPI void         elm_spinner_label_format_set(Evas_Object *obj, const char *fmt) EINA_ARG_NONNULL(1);
21505
21506    /**
21507     * Get the label format of the spinner.
21508     *
21509     * @param obj The spinner object.
21510     * @return The text label format string in UTF-8.
21511     *
21512     * @see elm_spinner_label_format_set() for details.
21513     *
21514     * @ingroup Spinner
21515     */
21516    EAPI const char  *elm_spinner_label_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21517
21518    /**
21519     * Set the minimum and maximum values for the spinner.
21520     *
21521     * @param obj The spinner object.
21522     * @param min The minimum value.
21523     * @param max The maximum value.
21524     *
21525     * Define the allowed range of values to be selected by the user.
21526     *
21527     * If actual value is less than @p min, it will be updated to @p min. If it
21528     * is bigger then @p max, will be updated to @p max. Actual value can be
21529     * get with elm_spinner_value_get().
21530     *
21531     * By default, min is equal to 0, and max is equal to 100.
21532     *
21533     * @warning Maximum must be greater than minimum.
21534     *
21535     * @see elm_spinner_min_max_get()
21536     *
21537     * @ingroup Spinner
21538     */
21539    EAPI void         elm_spinner_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
21540
21541    /**
21542     * Get the minimum and maximum values of the spinner.
21543     *
21544     * @param obj The spinner object.
21545     * @param min Pointer where to store the minimum value.
21546     * @param max Pointer where to store the maximum value.
21547     *
21548     * @note If only one value is needed, the other pointer can be passed
21549     * as @c NULL.
21550     *
21551     * @see elm_spinner_min_max_set() for details.
21552     *
21553     * @ingroup Spinner
21554     */
21555    EAPI void         elm_spinner_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
21556
21557    /**
21558     * Set the step used to increment or decrement the spinner value.
21559     *
21560     * @param obj The spinner object.
21561     * @param step The step value.
21562     *
21563     * This value will be incremented or decremented to the displayed value.
21564     * It will be incremented while the user keep right or top arrow pressed,
21565     * and will be decremented while the user keep left or bottom arrow pressed.
21566     *
21567     * The interval to increment / decrement can be set with
21568     * elm_spinner_interval_set().
21569     *
21570     * By default step value is equal to 1.
21571     *
21572     * @see elm_spinner_step_get()
21573     *
21574     * @ingroup Spinner
21575     */
21576    EAPI void         elm_spinner_step_set(Evas_Object *obj, double step) EINA_ARG_NONNULL(1);
21577
21578    /**
21579     * Get the step used to increment or decrement the spinner value.
21580     *
21581     * @param obj The spinner object.
21582     * @return The step value.
21583     *
21584     * @see elm_spinner_step_get() for more details.
21585     *
21586     * @ingroup Spinner
21587     */
21588    EAPI double       elm_spinner_step_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21589
21590    /**
21591     * Set the value the spinner displays.
21592     *
21593     * @param obj The spinner object.
21594     * @param val The value to be displayed.
21595     *
21596     * Value will be presented on the label following format specified with
21597     * elm_spinner_format_set().
21598     *
21599     * @warning The value must to be between min and max values. This values
21600     * are set by elm_spinner_min_max_set().
21601     *
21602     * @see elm_spinner_value_get().
21603     * @see elm_spinner_format_set().
21604     * @see elm_spinner_min_max_set().
21605     *
21606     * @ingroup Spinner
21607     */
21608    EAPI void         elm_spinner_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
21609
21610    /**
21611     * Get the value displayed by the spinner.
21612     *
21613     * @param obj The spinner object.
21614     * @return The value displayed.
21615     *
21616     * @see elm_spinner_value_set() for details.
21617     *
21618     * @ingroup Spinner
21619     */
21620    EAPI double       elm_spinner_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21621
21622    /**
21623     * Set whether the spinner should wrap when it reaches its
21624     * minimum or maximum value.
21625     *
21626     * @param obj The spinner object.
21627     * @param wrap @c EINA_TRUE to enable wrap or @c EINA_FALSE to
21628     * disable it.
21629     *
21630     * Disabled by default. If disabled, when the user tries to increment the
21631     * value,
21632     * but displayed value plus step value is bigger than maximum value,
21633     * the spinner
21634     * won't allow it. The same happens when the user tries to decrement it,
21635     * but the value less step is less than minimum value.
21636     *
21637     * When wrap is enabled, in such situations it will allow these changes,
21638     * but will get the value that would be less than minimum and subtracts
21639     * from maximum. Or add the value that would be more than maximum to
21640     * the minimum.
21641     *
21642     * E.g.:
21643     * @li min value = 10
21644     * @li max value = 50
21645     * @li step value = 20
21646     * @li displayed value = 20
21647     *
21648     * When the user decrement value (using left or bottom arrow), it will
21649     * displays @c 40, because max - (min - (displayed - step)) is
21650     * @c 50 - (@c 10 - (@c 20 - @c 20)) = @c 40.
21651     *
21652     * @see elm_spinner_wrap_get().
21653     *
21654     * @ingroup Spinner
21655     */
21656    EAPI void         elm_spinner_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
21657
21658    /**
21659     * Get whether the spinner should wrap when it reaches its
21660     * minimum or maximum value.
21661     *
21662     * @param obj The spinner object
21663     * @return @c EINA_TRUE means wrap is enabled. @c EINA_FALSE indicates
21664     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
21665     *
21666     * @see elm_spinner_wrap_set() for details.
21667     *
21668     * @ingroup Spinner
21669     */
21670    EAPI Eina_Bool    elm_spinner_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21671
21672    /**
21673     * Set whether the spinner can be directly edited by the user or not.
21674     *
21675     * @param obj The spinner object.
21676     * @param editable @c EINA_TRUE to allow users to edit it or @c EINA_FALSE to
21677     * don't allow users to edit it directly.
21678     *
21679     * Spinner objects can have edition @b disabled, in which state they will
21680     * be changed only by arrows.
21681     * Useful for contexts
21682     * where you don't want your users to interact with it writting the value.
21683     * Specially
21684     * when using special values, the user can see real value instead
21685     * of special label on edition.
21686     *
21687     * It's enabled by default.
21688     *
21689     * @see elm_spinner_editable_get()
21690     *
21691     * @ingroup Spinner
21692     */
21693    EAPI void         elm_spinner_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
21694
21695    /**
21696     * Get whether the spinner can be directly edited by the user or not.
21697     *
21698     * @param obj The spinner object.
21699     * @return @c EINA_TRUE means edition is enabled. @c EINA_FALSE indicates
21700     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
21701     *
21702     * @see elm_spinner_editable_set() for details.
21703     *
21704     * @ingroup Spinner
21705     */
21706    EAPI Eina_Bool    elm_spinner_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21707
21708    /**
21709     * Set a special string to display in the place of the numerical value.
21710     *
21711     * @param obj The spinner object.
21712     * @param value The value to be replaced.
21713     * @param label The label to be used.
21714     *
21715     * It's useful for cases when a user should select an item that is
21716     * better indicated by a label than a value. For example, weekdays or months.
21717     *
21718     * E.g.:
21719     * @code
21720     * sp = elm_spinner_add(win);
21721     * elm_spinner_min_max_set(sp, 1, 3);
21722     * elm_spinner_special_value_add(sp, 1, "January");
21723     * elm_spinner_special_value_add(sp, 2, "February");
21724     * elm_spinner_special_value_add(sp, 3, "March");
21725     * evas_object_show(sp);
21726     * @endcode
21727     *
21728     * @ingroup Spinner
21729     */
21730    EAPI void         elm_spinner_special_value_add(Evas_Object *obj, double value, const char *label) EINA_ARG_NONNULL(1);
21731
21732    /**
21733     * Set the interval on time updates for an user mouse button hold
21734     * on spinner widgets' arrows.
21735     *
21736     * @param obj The spinner object.
21737     * @param interval The (first) interval value in seconds.
21738     *
21739     * This interval value is @b decreased while the user holds the
21740     * mouse pointer either incrementing or decrementing spinner's value.
21741     *
21742     * This helps the user to get to a given value distant from the
21743     * current one easier/faster, as it will start to change quicker and
21744     * quicker on mouse button holds.
21745     *
21746     * The calculation for the next change interval value, starting from
21747     * the one set with this call, is the previous interval divided by
21748     * @c 1.05, so it decreases a little bit.
21749     *
21750     * The default starting interval value for automatic changes is
21751     * @c 0.85 seconds.
21752     *
21753     * @see elm_spinner_interval_get()
21754     *
21755     * @ingroup Spinner
21756     */
21757    EAPI void         elm_spinner_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
21758
21759    /**
21760     * Get the interval on time updates for an user mouse button hold
21761     * on spinner widgets' arrows.
21762     *
21763     * @param obj The spinner object.
21764     * @return The (first) interval value, in seconds, set on it.
21765     *
21766     * @see elm_spinner_interval_set() for more details.
21767     *
21768     * @ingroup Spinner
21769     */
21770    EAPI double       elm_spinner_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21771
21772    /**
21773     * @}
21774     */
21775
21776    /**
21777     * @defgroup Index Index
21778     *
21779     * @image html img/widget/index/preview-00.png
21780     * @image latex img/widget/index/preview-00.eps
21781     *
21782     * An index widget gives you an index for fast access to whichever
21783     * group of other UI items one might have. It's a list of text
21784     * items (usually letters, for alphabetically ordered access).
21785     *
21786     * Index widgets are by default hidden and just appear when the
21787     * user clicks over it's reserved area in the canvas. In its
21788     * default theme, it's an area one @ref Fingers "finger" wide on
21789     * the right side of the index widget's container.
21790     *
21791     * When items on the index are selected, smart callbacks get
21792     * called, so that its user can make other container objects to
21793     * show a given area or child object depending on the index item
21794     * selected. You'd probably be using an index together with @ref
21795     * List "lists", @ref Genlist "generic lists" or @ref Gengrid
21796     * "general grids".
21797     *
21798     * Smart events one  can add callbacks for are:
21799     * - @c "changed" - When the selected index item changes. @c
21800     *      event_info is the selected item's data pointer.
21801     * - @c "delay,changed" - When the selected index item changes, but
21802     *      after a small idling period. @c event_info is the selected
21803     *      item's data pointer.
21804     * - @c "selected" - When the user releases a mouse button and
21805     *      selects an item. @c event_info is the selected item's data
21806     *      pointer.
21807     * - @c "level,up" - when the user moves a finger from the first
21808     *      level to the second level
21809     * - @c "level,down" - when the user moves a finger from the second
21810     *      level to the first level
21811     *
21812     * The @c "delay,changed" event is so that it'll wait a small time
21813     * before actually reporting those events and, moreover, just the
21814     * last event happening on those time frames will actually be
21815     * reported.
21816     *
21817     * Here are some examples on its usage:
21818     * @li @ref index_example_01
21819     * @li @ref index_example_02
21820     */
21821
21822    /**
21823     * @addtogroup Index
21824     * @{
21825     */
21826
21827    typedef struct _Elm_Index_Item Elm_Index_Item; /**< Opaque handle for items of Elementary index widgets */
21828
21829    /**
21830     * Add a new index widget to the given parent Elementary
21831     * (container) object
21832     *
21833     * @param parent The parent object
21834     * @return a new index widget handle or @c NULL, on errors
21835     *
21836     * This function inserts a new index widget on the canvas.
21837     *
21838     * @ingroup Index
21839     */
21840    EAPI Evas_Object    *elm_index_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21841
21842    /**
21843     * Set whether a given index widget is or not visible,
21844     * programatically.
21845     *
21846     * @param obj The index object
21847     * @param active @c EINA_TRUE to show it, @c EINA_FALSE to hide it
21848     *
21849     * Not to be confused with visible as in @c evas_object_show() --
21850     * visible with regard to the widget's auto hiding feature.
21851     *
21852     * @see elm_index_active_get()
21853     *
21854     * @ingroup Index
21855     */
21856    EAPI void            elm_index_active_set(Evas_Object *obj, Eina_Bool active) EINA_ARG_NONNULL(1);
21857
21858    /**
21859     * Get whether a given index widget is currently visible or not.
21860     *
21861     * @param obj The index object
21862     * @return @c EINA_TRUE, if it's shown, @c EINA_FALSE otherwise
21863     *
21864     * @see elm_index_active_set() for more details
21865     *
21866     * @ingroup Index
21867     */
21868    EAPI Eina_Bool       elm_index_active_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21869
21870    /**
21871     * Set the items level for a given index widget.
21872     *
21873     * @param obj The index object.
21874     * @param level @c 0 or @c 1, the currently implemented levels.
21875     *
21876     * @see elm_index_item_level_get()
21877     *
21878     * @ingroup Index
21879     */
21880    EAPI void            elm_index_item_level_set(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
21881
21882    /**
21883     * Get the items level set for a given index widget.
21884     *
21885     * @param obj The index object.
21886     * @return @c 0 or @c 1, which are the levels @p obj might be at.
21887     *
21888     * @see elm_index_item_level_set() for more information
21889     *
21890     * @ingroup Index
21891     */
21892    EAPI int             elm_index_item_level_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21893
21894    /**
21895     * Returns the last selected item's data, for a given index widget.
21896     *
21897     * @param obj The index object.
21898     * @return The item @b data associated to the last selected item on
21899     * @p obj (or @c NULL, on errors).
21900     *
21901     * @warning The returned value is @b not an #Elm_Index_Item item
21902     * handle, but the data associated to it (see the @c item parameter
21903     * in elm_index_item_append(), as an example).
21904     *
21905     * @ingroup Index
21906     */
21907    EAPI void           *elm_index_item_selected_get(const Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
21908
21909    /**
21910     * Append a new item on a given index widget.
21911     *
21912     * @param obj The index object.
21913     * @param letter Letter under which the item should be indexed
21914     * @param item The item data to set for the index's item
21915     *
21916     * Despite the most common usage of the @p letter argument is for
21917     * single char strings, one could use arbitrary strings as index
21918     * entries.
21919     *
21920     * @c item will be the pointer returned back on @c "changed", @c
21921     * "delay,changed" and @c "selected" smart events.
21922     *
21923     * @ingroup Index
21924     */
21925    EAPI void            elm_index_item_append(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
21926
21927    /**
21928     * Prepend a new item on a given index widget.
21929     *
21930     * @param obj The index object.
21931     * @param letter Letter under which the item should be indexed
21932     * @param item The item data to set for the index's item
21933     *
21934     * Despite the most common usage of the @p letter argument is for
21935     * single char strings, one could use arbitrary strings as index
21936     * entries.
21937     *
21938     * @c item will be the pointer returned back on @c "changed", @c
21939     * "delay,changed" and @c "selected" smart events.
21940     *
21941     * @ingroup Index
21942     */
21943    EAPI void            elm_index_item_prepend(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
21944
21945    /**
21946     * Append a new item, on a given index widget, <b>after the item
21947     * having @p relative as data</b>.
21948     *
21949     * @param obj The index object.
21950     * @param letter Letter under which the item should be indexed
21951     * @param item The item data to set for the index's item
21952     * @param relative The item data of the index item to be the
21953     * predecessor of this new one
21954     *
21955     * Despite the most common usage of the @p letter argument is for
21956     * single char strings, one could use arbitrary strings as index
21957     * entries.
21958     *
21959     * @c item will be the pointer returned back on @c "changed", @c
21960     * "delay,changed" and @c "selected" smart events.
21961     *
21962     * @note If @p relative is @c NULL or if it's not found to be data
21963     * set on any previous item on @p obj, this function will behave as
21964     * elm_index_item_append().
21965     *
21966     * @ingroup Index
21967     */
21968    EAPI void            elm_index_item_append_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
21969
21970    /**
21971     * Prepend a new item, on a given index widget, <b>after the item
21972     * having @p relative as data</b>.
21973     *
21974     * @param obj The index object.
21975     * @param letter Letter under which the item should be indexed
21976     * @param item The item data to set for the index's item
21977     * @param relative The item data of the index item to be the
21978     * successor of this new one
21979     *
21980     * Despite the most common usage of the @p letter argument is for
21981     * single char strings, one could use arbitrary strings as index
21982     * entries.
21983     *
21984     * @c item will be the pointer returned back on @c "changed", @c
21985     * "delay,changed" and @c "selected" smart events.
21986     *
21987     * @note If @p relative is @c NULL or if it's not found to be data
21988     * set on any previous item on @p obj, this function will behave as
21989     * elm_index_item_prepend().
21990     *
21991     * @ingroup Index
21992     */
21993    EAPI void            elm_index_item_prepend_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
21994
21995    /**
21996     * Insert a new item into the given index widget, using @p cmp_func
21997     * function to sort items (by item handles).
21998     *
21999     * @param obj The index object.
22000     * @param letter Letter under which the item should be indexed
22001     * @param item The item data to set for the index's item
22002     * @param cmp_func The comparing function to be used to sort index
22003     * items <b>by #Elm_Index_Item item handles</b>
22004     * @param cmp_data_func A @b fallback function to be called for the
22005     * sorting of index items <b>by item data</b>). It will be used
22006     * when @p cmp_func returns @c 0 (equality), which means an index
22007     * item with provided item data already exists. To decide which
22008     * data item should be pointed to by the index item in question, @p
22009     * cmp_data_func will be used. If @p cmp_data_func returns a
22010     * non-negative value, the previous index item data will be
22011     * replaced by the given @p item pointer. If the previous data need
22012     * to be freed, it should be done by the @p cmp_data_func function,
22013     * because all references to it will be lost. If this function is
22014     * not provided (@c NULL is given), index items will be @b
22015     * duplicated, if @p cmp_func returns @c 0.
22016     *
22017     * Despite the most common usage of the @p letter argument is for
22018     * single char strings, one could use arbitrary strings as index
22019     * entries.
22020     *
22021     * @c item will be the pointer returned back on @c "changed", @c
22022     * "delay,changed" and @c "selected" smart events.
22023     *
22024     * @ingroup Index
22025     */
22026    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);
22027
22028    /**
22029     * Remove an item from a given index widget, <b>to be referenced by
22030     * it's data value</b>.
22031     *
22032     * @param obj The index object
22033     * @param item The item's data pointer for the item to be removed
22034     * from @p obj
22035     *
22036     * If a deletion callback is set, via elm_index_item_del_cb_set(),
22037     * that callback function will be called by this one.
22038     *
22039     * @warning The item to be removed from @p obj will be found via
22040     * its item data pointer, and not by an #Elm_Index_Item handle.
22041     *
22042     * @ingroup Index
22043     */
22044    EAPI void            elm_index_item_del(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
22045
22046    /**
22047     * Find a given index widget's item, <b>using item data</b>.
22048     *
22049     * @param obj The index object
22050     * @param item The item data pointed to by the desired index item
22051     * @return The index item handle, if found, or @c NULL otherwise
22052     *
22053     * @ingroup Index
22054     */
22055    EAPI Elm_Index_Item *elm_index_item_find(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
22056
22057    /**
22058     * Removes @b all items from a given index widget.
22059     *
22060     * @param obj The index object.
22061     *
22062     * If deletion callbacks are set, via elm_index_item_del_cb_set(),
22063     * that callback function will be called for each item in @p obj.
22064     *
22065     * @ingroup Index
22066     */
22067    EAPI void            elm_index_item_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
22068
22069    /**
22070     * Go to a given items level on a index widget
22071     *
22072     * @param obj The index object
22073     * @param level The index level (one of @c 0 or @c 1)
22074     *
22075     * @ingroup Index
22076     */
22077    EAPI void            elm_index_item_go(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
22078
22079    /**
22080     * Return the data associated with a given index widget item
22081     *
22082     * @param it The index widget item handle
22083     * @return The data associated with @p it
22084     *
22085     * @see elm_index_item_data_set()
22086     *
22087     * @ingroup Index
22088     */
22089    EAPI void           *elm_index_item_data_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
22090
22091    /**
22092     * Set the data associated with a given index widget item
22093     *
22094     * @param it The index widget item handle
22095     * @param data The new data pointer to set to @p it
22096     *
22097     * This sets new item data on @p it.
22098     *
22099     * @warning The old data pointer won't be touched by this function, so
22100     * the user had better to free that old data himself/herself.
22101     *
22102     * @ingroup Index
22103     */
22104    EAPI void            elm_index_item_data_set(Elm_Index_Item *it, const void *data) EINA_ARG_NONNULL(1);
22105
22106    /**
22107     * Set the function to be called when a given index widget item is freed.
22108     *
22109     * @param it The item to set the callback on
22110     * @param func The function to call on the item's deletion
22111     *
22112     * When called, @p func will have both @c data and @c event_info
22113     * arguments with the @p it item's data value and, naturally, the
22114     * @c obj argument with a handle to the parent index widget.
22115     *
22116     * @ingroup Index
22117     */
22118    EAPI void            elm_index_item_del_cb_set(Elm_Index_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
22119
22120    /**
22121     * Get the letter (string) set on a given index widget item.
22122     *
22123     * @param it The index item handle
22124     * @return The letter string set on @p it
22125     *
22126     * @ingroup Index
22127     */
22128    EAPI const char     *elm_index_item_letter_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
22129
22130    /**
22131     * @}
22132     */
22133
22134    /**
22135     * @defgroup Photocam Photocam
22136     *
22137     * @image html img/widget/photocam/preview-00.png
22138     * @image latex img/widget/photocam/preview-00.eps
22139     *
22140     * This is a widget specifically for displaying high-resolution digital
22141     * camera photos giving speedy feedback (fast load), low memory footprint
22142     * and zooming and panning as well as fitting logic. It is entirely focused
22143     * on jpeg images, and takes advantage of properties of the jpeg format (via
22144     * evas loader features in the jpeg loader).
22145     *
22146     * Signals that you can add callbacks for are:
22147     * @li "clicked" - This is called when a user has clicked the photo without
22148     *                 dragging around.
22149     * @li "press" - This is called when a user has pressed down on the photo.
22150     * @li "longpressed" - This is called when a user has pressed down on the
22151     *                     photo for a long time without dragging around.
22152     * @li "clicked,double" - This is called when a user has double-clicked the
22153     *                        photo.
22154     * @li "load" - Photo load begins.
22155     * @li "loaded" - This is called when the image file load is complete for the
22156     *                first view (low resolution blurry version).
22157     * @li "load,detail" - Photo detailed data load begins.
22158     * @li "loaded,detail" - This is called when the image file load is complete
22159     *                      for the detailed image data (full resolution needed).
22160     * @li "zoom,start" - Zoom animation started.
22161     * @li "zoom,stop" - Zoom animation stopped.
22162     * @li "zoom,change" - Zoom changed when using an auto zoom mode.
22163     * @li "scroll" - the content has been scrolled (moved)
22164     * @li "scroll,anim,start" - scrolling animation has started
22165     * @li "scroll,anim,stop" - scrolling animation has stopped
22166     * @li "scroll,drag,start" - dragging the contents around has started
22167     * @li "scroll,drag,stop" - dragging the contents around has stopped
22168     *
22169     * @ref tutorial_photocam shows the API in action.
22170     * @{
22171     */
22172    /**
22173     * @brief Types of zoom available.
22174     */
22175    typedef enum _Elm_Photocam_Zoom_Mode
22176      {
22177         ELM_PHOTOCAM_ZOOM_MODE_MANUAL = 0, /**< Zoom controled normally by elm_photocam_zoom_set */
22178         ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT, /**< Zoom until photo fits in photocam */
22179         ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL, /**< Zoom until photo fills photocam */
22180         ELM_PHOTOCAM_ZOOM_MODE_LAST
22181      } Elm_Photocam_Zoom_Mode;
22182    /**
22183     * @brief Add a new Photocam object
22184     *
22185     * @param parent The parent object
22186     * @return The new object or NULL if it cannot be created
22187     */
22188    EAPI Evas_Object           *elm_photocam_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22189    /**
22190     * @brief Set the photo file to be shown
22191     *
22192     * @param obj The photocam object
22193     * @param file The photo file
22194     * @return The return error (see EVAS_LOAD_ERROR_NONE, EVAS_LOAD_ERROR_GENERIC etc.)
22195     *
22196     * This sets (and shows) the specified file (with a relative or absolute
22197     * path) and will return a load error (same error that
22198     * evas_object_image_load_error_get() will return). The image will change and
22199     * adjust its size at this point and begin a background load process for this
22200     * photo that at some time in the future will be displayed at the full
22201     * quality needed.
22202     */
22203    EAPI Evas_Load_Error        elm_photocam_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
22204    /**
22205     * @brief Returns the path of the current image file
22206     *
22207     * @param obj The photocam object
22208     * @return Returns the path
22209     *
22210     * @see elm_photocam_file_set()
22211     */
22212    EAPI const char            *elm_photocam_file_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22213    /**
22214     * @brief Set the zoom level of the photo
22215     *
22216     * @param obj The photocam object
22217     * @param zoom The zoom level to set
22218     *
22219     * This sets the zoom level. 1 will be 1:1 pixel for pixel. 2 will be 2:1
22220     * (that is 2x2 photo pixels will display as 1 on-screen pixel). 4:1 will be
22221     * 4x4 photo pixels as 1 screen pixel, and so on. The @p zoom parameter must
22222     * be greater than 0. It is usggested to stick to powers of 2. (1, 2, 4, 8,
22223     * 16, 32, etc.).
22224     */
22225    EAPI void                   elm_photocam_zoom_set(Evas_Object *obj, double zoom) EINA_ARG_NONNULL(1);
22226    /**
22227     * @brief Get the zoom level of the photo
22228     *
22229     * @param obj The photocam object
22230     * @return The current zoom level
22231     *
22232     * This returns the current zoom level of the photocam object. Note that if
22233     * you set the fill mode to other than ELM_PHOTOCAM_ZOOM_MODE_MANUAL
22234     * (which is the default), the zoom level may be changed at any time by the
22235     * photocam object itself to account for photo size and photocam viewpoer
22236     * size.
22237     *
22238     * @see elm_photocam_zoom_set()
22239     * @see elm_photocam_zoom_mode_set()
22240     */
22241    EAPI double                 elm_photocam_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22242    /**
22243     * @brief Set the zoom mode
22244     *
22245     * @param obj The photocam object
22246     * @param mode The desired mode
22247     *
22248     * This sets the zoom mode to manual or one of several automatic levels.
22249     * Manual (ELM_PHOTOCAM_ZOOM_MODE_MANUAL) means that zoom is set manually by
22250     * elm_photocam_zoom_set() and will stay at that level until changed by code
22251     * or until zoom mode is changed. This is the default mode. The Automatic
22252     * modes will allow the photocam object to automatically adjust zoom mode
22253     * based on properties. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT) will adjust zoom so
22254     * the photo fits EXACTLY inside the scroll frame with no pixels outside this
22255     * area. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL will be similar but ensure no
22256     * pixels within the frame are left unfilled.
22257     */
22258    EAPI void                   elm_photocam_zoom_mode_set(Evas_Object *obj, Elm_Photocam_Zoom_Mode mode) EINA_ARG_NONNULL(1);
22259    /**
22260     * @brief Get the zoom mode
22261     *
22262     * @param obj The photocam object
22263     * @return The current zoom mode
22264     *
22265     * This gets the current zoom mode of the photocam object.
22266     *
22267     * @see elm_photocam_zoom_mode_set()
22268     */
22269    EAPI Elm_Photocam_Zoom_Mode elm_photocam_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22270    /**
22271     * @brief Get the current image pixel width and height
22272     *
22273     * @param obj The photocam object
22274     * @param w A pointer to the width return
22275     * @param h A pointer to the height return
22276     *
22277     * This gets the current photo pixel width and height (for the original).
22278     * The size will be returned in the integers @p w and @p h that are pointed
22279     * to.
22280     */
22281    EAPI void                   elm_photocam_image_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
22282    /**
22283     * @brief Get the area of the image that is currently shown
22284     *
22285     * @param obj
22286     * @param x A pointer to the X-coordinate of region
22287     * @param y A pointer to the Y-coordinate of region
22288     * @param w A pointer to the width
22289     * @param h A pointer to the height
22290     *
22291     * @see elm_photocam_image_region_show()
22292     * @see elm_photocam_image_region_bring_in()
22293     */
22294    EAPI void                   elm_photocam_region_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
22295    /**
22296     * @brief Set the viewed portion of the image
22297     *
22298     * @param obj The photocam object
22299     * @param x X-coordinate of region in image original pixels
22300     * @param y Y-coordinate of region in image original pixels
22301     * @param w Width of region in image original pixels
22302     * @param h Height of region in image original pixels
22303     *
22304     * This shows the region of the image without using animation.
22305     */
22306    EAPI void                   elm_photocam_image_region_show(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
22307    /**
22308     * @brief Bring in the viewed portion of the image
22309     *
22310     * @param obj The photocam object
22311     * @param x X-coordinate of region in image original pixels
22312     * @param y Y-coordinate of region in image original pixels
22313     * @param w Width of region in image original pixels
22314     * @param h Height of region in image original pixels
22315     *
22316     * This shows the region of the image using animation.
22317     */
22318    EAPI void                   elm_photocam_image_region_bring_in(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
22319    /**
22320     * @brief Set the paused state for photocam
22321     *
22322     * @param obj The photocam object
22323     * @param paused The pause state to set
22324     *
22325     * This sets the paused state to on(EINA_TRUE) or off (EINA_FALSE) for
22326     * photocam. The default is off. This will stop zooming using animation on
22327     * zoom levels changes and change instantly. This will stop any existing
22328     * animations that are running.
22329     */
22330    EAPI void                   elm_photocam_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
22331    /**
22332     * @brief Get the paused state for photocam
22333     *
22334     * @param obj The photocam object
22335     * @return The current paused state
22336     *
22337     * This gets the current paused state for the photocam object.
22338     *
22339     * @see elm_photocam_paused_set()
22340     */
22341    EAPI Eina_Bool              elm_photocam_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22342    /**
22343     * @brief Get the internal low-res image used for photocam
22344     *
22345     * @param obj The photocam object
22346     * @return The internal image object handle, or NULL if none exists
22347     *
22348     * This gets the internal image object inside photocam. Do not modify it. It
22349     * is for inspection only, and hooking callbacks to. Nothing else. It may be
22350     * deleted at any time as well.
22351     */
22352    EAPI Evas_Object           *elm_photocam_internal_image_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22353    /**
22354     * @brief Set the photocam scrolling bouncing.
22355     *
22356     * @param obj The photocam object
22357     * @param h_bounce bouncing for horizontal
22358     * @param v_bounce bouncing for vertical
22359     */
22360    EAPI void                   elm_photocam_bounce_set(Evas_Object *obj,  Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
22361    /**
22362     * @brief Get the photocam scrolling bouncing.
22363     *
22364     * @param obj The photocam object
22365     * @param h_bounce bouncing for horizontal
22366     * @param v_bounce bouncing for vertical
22367     *
22368     * @see elm_photocam_bounce_set()
22369     */
22370    EAPI void                   elm_photocam_bounce_get(const Evas_Object *obj,  Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
22371    /**
22372     * @}
22373     */
22374
22375    /**
22376     * @defgroup Map Map
22377     * @ingroup Elementary
22378     *
22379     * @image html img/widget/map/preview-00.png
22380     * @image latex img/widget/map/preview-00.eps
22381     *
22382     * This is a widget specifically for displaying a map. It uses basically
22383     * OpenStreetMap provider http://www.openstreetmap.org/,
22384     * but custom providers can be added.
22385     *
22386     * It supports some basic but yet nice features:
22387     * @li zoom and scroll
22388     * @li markers with content to be displayed when user clicks over it
22389     * @li group of markers
22390     * @li routes
22391     *
22392     * Smart callbacks one can listen to:
22393     *
22394     * - "clicked" - This is called when a user has clicked the map without
22395     *   dragging around.
22396     * - "press" - This is called when a user has pressed down on the map.
22397     * - "longpressed" - This is called when a user has pressed down on the map
22398     *   for a long time without dragging around.
22399     * - "clicked,double" - This is called when a user has double-clicked
22400     *   the map.
22401     * - "load,detail" - Map detailed data load begins.
22402     * - "loaded,detail" - This is called when all currently visible parts of
22403     *   the map are loaded.
22404     * - "zoom,start" - Zoom animation started.
22405     * - "zoom,stop" - Zoom animation stopped.
22406     * - "zoom,change" - Zoom changed when using an auto zoom mode.
22407     * - "scroll" - the content has been scrolled (moved).
22408     * - "scroll,anim,start" - scrolling animation has started.
22409     * - "scroll,anim,stop" - scrolling animation has stopped.
22410     * - "scroll,drag,start" - dragging the contents around has started.
22411     * - "scroll,drag,stop" - dragging the contents around has stopped.
22412     * - "downloaded" - This is called when all currently required map images
22413     *   are downloaded.
22414     * - "route,load" - This is called when route request begins.
22415     * - "route,loaded" - This is called when route request ends.
22416     * - "name,load" - This is called when name request begins.
22417     * - "name,loaded- This is called when name request ends.
22418     *
22419     * Available style for map widget:
22420     * - @c "default"
22421     *
22422     * Available style for markers:
22423     * - @c "radio"
22424     * - @c "radio2"
22425     * - @c "empty"
22426     *
22427     * Available style for marker bubble:
22428     * - @c "default"
22429     *
22430     * List of examples:
22431     * @li @ref map_example_01
22432     * @li @ref map_example_02
22433     * @li @ref map_example_03
22434     */
22435
22436    /**
22437     * @addtogroup Map
22438     * @{
22439     */
22440
22441    /**
22442     * @enum _Elm_Map_Zoom_Mode
22443     * @typedef Elm_Map_Zoom_Mode
22444     *
22445     * Set map's zoom behavior. It can be set to manual or automatic.
22446     *
22447     * Default value is #ELM_MAP_ZOOM_MODE_MANUAL.
22448     *
22449     * Values <b> don't </b> work as bitmask, only one can be choosen.
22450     *
22451     * @note Valid sizes are 2^zoom, consequently the map may be smaller
22452     * than the scroller view.
22453     *
22454     * @see elm_map_zoom_mode_set()
22455     * @see elm_map_zoom_mode_get()
22456     *
22457     * @ingroup Map
22458     */
22459    typedef enum _Elm_Map_Zoom_Mode
22460      {
22461         ELM_MAP_ZOOM_MODE_MANUAL, /**< Zoom controled manually by elm_map_zoom_set(). It's set by default. */
22462         ELM_MAP_ZOOM_MODE_AUTO_FIT, /**< Zoom until map fits inside the scroll frame with no pixels outside this area. */
22463         ELM_MAP_ZOOM_MODE_AUTO_FILL, /**< Zoom until map fills scroll, ensuring no pixels are left unfilled. */
22464         ELM_MAP_ZOOM_MODE_LAST
22465      } Elm_Map_Zoom_Mode;
22466
22467    /**
22468     * @enum _Elm_Map_Route_Sources
22469     * @typedef Elm_Map_Route_Sources
22470     *
22471     * Set route service to be used. By default used source is
22472     * #ELM_MAP_ROUTE_SOURCE_YOURS.
22473     *
22474     * @see elm_map_route_source_set()
22475     * @see elm_map_route_source_get()
22476     *
22477     * @ingroup Map
22478     */
22479    typedef enum _Elm_Map_Route_Sources
22480      {
22481         ELM_MAP_ROUTE_SOURCE_YOURS, /**< Routing service http://www.yournavigation.org/ . Set by default.*/
22482         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. */
22483         ELM_MAP_ROUTE_SOURCE_ORS, /**< Open Route Service: http://www.openrouteservice.org/ . It's not working with Map yet. */
22484         ELM_MAP_ROUTE_SOURCE_LAST
22485      } Elm_Map_Route_Sources;
22486
22487    typedef enum _Elm_Map_Name_Sources
22488      {
22489         ELM_MAP_NAME_SOURCE_NOMINATIM,
22490         ELM_MAP_NAME_SOURCE_LAST
22491      } Elm_Map_Name_Sources;
22492
22493    /**
22494     * @enum _Elm_Map_Route_Type
22495     * @typedef Elm_Map_Route_Type
22496     *
22497     * Set type of transport used on route.
22498     *
22499     * @see elm_map_route_add()
22500     *
22501     * @ingroup Map
22502     */
22503    typedef enum _Elm_Map_Route_Type
22504      {
22505         ELM_MAP_ROUTE_TYPE_MOTOCAR, /**< Route should consider an automobile will be used. */
22506         ELM_MAP_ROUTE_TYPE_BICYCLE, /**< Route should consider a bicycle will be used by the user. */
22507         ELM_MAP_ROUTE_TYPE_FOOT, /**< Route should consider user will be walking. */
22508         ELM_MAP_ROUTE_TYPE_LAST
22509      } Elm_Map_Route_Type;
22510
22511    /**
22512     * @enum _Elm_Map_Route_Method
22513     * @typedef Elm_Map_Route_Method
22514     *
22515     * Set the routing method, what should be priorized, time or distance.
22516     *
22517     * @see elm_map_route_add()
22518     *
22519     * @ingroup Map
22520     */
22521    typedef enum _Elm_Map_Route_Method
22522      {
22523         ELM_MAP_ROUTE_METHOD_FASTEST, /**< Route should priorize time. */
22524         ELM_MAP_ROUTE_METHOD_SHORTEST, /**< Route should priorize distance. */
22525         ELM_MAP_ROUTE_METHOD_LAST
22526      } Elm_Map_Route_Method;
22527
22528    typedef enum _Elm_Map_Name_Method
22529      {
22530         ELM_MAP_NAME_METHOD_SEARCH,
22531         ELM_MAP_NAME_METHOD_REVERSE,
22532         ELM_MAP_NAME_METHOD_LAST
22533      } Elm_Map_Name_Method;
22534
22535    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(). */
22536    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(). */
22537    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(). */
22538    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(). */
22539    typedef struct _Elm_Map_Name            Elm_Map_Name; /**< A handle for specific coordinates. */
22540    typedef struct _Elm_Map_Track           Elm_Map_Track;
22541
22542    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. */
22543    typedef void         (*ElmMapMarkerDelFunc)      (Evas_Object *obj, Elm_Map_Marker *marker, void *data, Evas_Object *o); /**< Function to delete bubble content for marker classes. */
22544    typedef Evas_Object *(*ElmMapMarkerIconGetFunc)  (Evas_Object *obj, Elm_Map_Marker *marker, void *data); /**< Icon fetching class function for marker classes. */
22545    typedef Evas_Object *(*ElmMapGroupIconGetFunc)   (Evas_Object *obj, void *data); /**< Icon fetching class function for markers group classes. */
22546
22547    typedef char        *(*ElmMapModuleSourceFunc) (void);
22548    typedef int          (*ElmMapModuleZoomMinFunc) (void);
22549    typedef int          (*ElmMapModuleZoomMaxFunc) (void);
22550    typedef char        *(*ElmMapModuleUrlFunc) (Evas_Object *obj, int x, int y, int zoom);
22551    typedef int          (*ElmMapModuleRouteSourceFunc) (void);
22552    typedef char        *(*ElmMapModuleRouteUrlFunc) (Evas_Object *obj, char *type_name, int method, double flon, double flat, double tlon, double tlat);
22553    typedef char        *(*ElmMapModuleNameUrlFunc) (Evas_Object *obj, int method, char *name, double lon, double lat);
22554    typedef Eina_Bool    (*ElmMapModuleGeoIntoCoordFunc) (const Evas_Object *obj, int zoom, double lon, double lat, int size, int *x, int *y);
22555    typedef Eina_Bool    (*ElmMapModuleCoordIntoGeoFunc) (const Evas_Object *obj, int zoom, int x, int y, int size, double *lon, double *lat);
22556
22557    /**
22558     * Add a new map widget to the given parent Elementary (container) object.
22559     *
22560     * @param parent The parent object.
22561     * @return a new map widget handle or @c NULL, on errors.
22562     *
22563     * This function inserts a new map widget on the canvas.
22564     *
22565     * @ingroup Map
22566     */
22567    EAPI Evas_Object          *elm_map_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22568
22569    /**
22570     * Set the zoom level of the map.
22571     *
22572     * @param obj The map object.
22573     * @param zoom The zoom level to set.
22574     *
22575     * This sets the zoom level.
22576     *
22577     * It will respect limits defined by elm_map_source_zoom_min_set() and
22578     * elm_map_source_zoom_max_set().
22579     *
22580     * By default these values are 0 (world map) and 18 (maximum zoom).
22581     *
22582     * This function should be used when zoom mode is set to
22583     * #ELM_MAP_ZOOM_MODE_MANUAL. This is the default mode, and can be set
22584     * with elm_map_zoom_mode_set().
22585     *
22586     * @see elm_map_zoom_mode_set().
22587     * @see elm_map_zoom_get().
22588     *
22589     * @ingroup Map
22590     */
22591    EAPI void                  elm_map_zoom_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
22592
22593    /**
22594     * Get the zoom level of the map.
22595     *
22596     * @param obj The map object.
22597     * @return The current zoom level.
22598     *
22599     * This returns the current zoom level of the map object.
22600     *
22601     * Note that if you set the fill mode to other than #ELM_MAP_ZOOM_MODE_MANUAL
22602     * (which is the default), the zoom level may be changed at any time by the
22603     * map object itself to account for map size and map viewport size.
22604     *
22605     * @see elm_map_zoom_set() for details.
22606     *
22607     * @ingroup Map
22608     */
22609    EAPI int                   elm_map_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22610
22611    /**
22612     * Set the zoom mode used by the map object.
22613     *
22614     * @param obj The map object.
22615     * @param mode The zoom mode of the map, being it one of
22616     * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
22617     * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
22618     *
22619     * This sets the zoom mode to manual or one of the automatic levels.
22620     * Manual (#ELM_MAP_ZOOM_MODE_MANUAL) means that zoom is set manually by
22621     * elm_map_zoom_set() and will stay at that level until changed by code
22622     * or until zoom mode is changed. This is the default mode.
22623     *
22624     * The Automatic modes will allow the map object to automatically
22625     * adjust zoom mode based on properties. #ELM_MAP_ZOOM_MODE_AUTO_FIT will
22626     * adjust zoom so the map fits inside the scroll frame with no pixels
22627     * outside this area. #ELM_MAP_ZOOM_MODE_AUTO_FILL will be similar but
22628     * ensure no pixels within the frame are left unfilled. Do not forget that
22629     * the valid sizes are 2^zoom, consequently the map may be smaller than
22630     * the scroller view.
22631     *
22632     * @see elm_map_zoom_set()
22633     *
22634     * @ingroup Map
22635     */
22636    EAPI void                  elm_map_zoom_mode_set(Evas_Object *obj, Elm_Map_Zoom_Mode mode) EINA_ARG_NONNULL(1);
22637
22638    /**
22639     * Get the zoom mode used by the map object.
22640     *
22641     * @param obj The map object.
22642     * @return The zoom mode of the map, being it one of
22643     * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
22644     * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
22645     *
22646     * This function returns the current zoom mode used by the map object.
22647     *
22648     * @see elm_map_zoom_mode_set() for more details.
22649     *
22650     * @ingroup Map
22651     */
22652    EAPI Elm_Map_Zoom_Mode     elm_map_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22653
22654    /**
22655     * Get the current coordinates of the map.
22656     *
22657     * @param obj The map object.
22658     * @param lon Pointer where to store longitude.
22659     * @param lat Pointer where to store latitude.
22660     *
22661     * This gets the current center coordinates of the map object. It can be
22662     * set by elm_map_geo_region_bring_in() and elm_map_geo_region_show().
22663     *
22664     * @see elm_map_geo_region_bring_in()
22665     * @see elm_map_geo_region_show()
22666     *
22667     * @ingroup Map
22668     */
22669    EAPI void                  elm_map_geo_region_get(const Evas_Object *obj, double *lon, double *lat) EINA_ARG_NONNULL(1);
22670
22671    /**
22672     * Animatedly bring in given coordinates to the center of the map.
22673     *
22674     * @param obj The map object.
22675     * @param lon Longitude to center at.
22676     * @param lat Latitude to center at.
22677     *
22678     * This causes map to jump to the given @p lat and @p lon coordinates
22679     * and show it (by scrolling) in the center of the viewport, if it is not
22680     * already centered. This will use animation to do so and take a period
22681     * of time to complete.
22682     *
22683     * @see elm_map_geo_region_show() for a function to avoid animation.
22684     * @see elm_map_geo_region_get()
22685     *
22686     * @ingroup Map
22687     */
22688    EAPI void                  elm_map_geo_region_bring_in(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
22689
22690    /**
22691     * Show the given coordinates at the center of the map, @b immediately.
22692     *
22693     * @param obj The map object.
22694     * @param lon Longitude to center at.
22695     * @param lat Latitude to center at.
22696     *
22697     * This causes map to @b redraw its viewport's contents to the
22698     * region contining the given @p lat and @p lon, that will be moved to the
22699     * center of the map.
22700     *
22701     * @see elm_map_geo_region_bring_in() for a function to move with animation.
22702     * @see elm_map_geo_region_get()
22703     *
22704     * @ingroup Map
22705     */
22706    EAPI void                  elm_map_geo_region_show(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
22707
22708    /**
22709     * Pause or unpause the map.
22710     *
22711     * @param obj The map object.
22712     * @param paused Use @c EINA_TRUE to pause the map @p obj or @c EINA_FALSE
22713     * to unpause it.
22714     *
22715     * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
22716     * for map.
22717     *
22718     * The default is off.
22719     *
22720     * This will stop zooming using animation, changing zoom levels will
22721     * change instantly. This will stop any existing animations that are running.
22722     *
22723     * @see elm_map_paused_get()
22724     *
22725     * @ingroup Map
22726     */
22727    EAPI void                  elm_map_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
22728
22729    /**
22730     * Get a value whether map is paused or not.
22731     *
22732     * @param obj The map object.
22733     * @return @c EINA_TRUE means map is pause. @c EINA_FALSE indicates
22734     * it is not. If @p obj is @c NULL, @c EINA_FALSE is returned.
22735     *
22736     * This gets the current paused state for the map object.
22737     *
22738     * @see elm_map_paused_set() for details.
22739     *
22740     * @ingroup Map
22741     */
22742    EAPI Eina_Bool             elm_map_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22743
22744    /**
22745     * Set to show markers during zoom level changes or not.
22746     *
22747     * @param obj The map object.
22748     * @param paused Use @c EINA_TRUE to @b not show markers or @c EINA_FALSE
22749     * to show them.
22750     *
22751     * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
22752     * for map.
22753     *
22754     * The default is off.
22755     *
22756     * This will stop zooming using animation, changing zoom levels will
22757     * change instantly. This will stop any existing animations that are running.
22758     *
22759     * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
22760     * for the markers.
22761     *
22762     * The default  is off.
22763     *
22764     * Enabling it will force the map to stop displaying the markers during
22765     * zoom level changes. Set to on if you have a large number of markers.
22766     *
22767     * @see elm_map_paused_markers_get()
22768     *
22769     * @ingroup Map
22770     */
22771    EAPI void                  elm_map_paused_markers_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
22772
22773    /**
22774     * Get a value whether markers will be displayed on zoom level changes or not
22775     *
22776     * @param obj The map object.
22777     * @return @c EINA_TRUE means map @b won't display markers or @c EINA_FALSE
22778     * indicates it will. If @p obj is @c NULL, @c EINA_FALSE is returned.
22779     *
22780     * This gets the current markers paused state for the map object.
22781     *
22782     * @see elm_map_paused_markers_set() for details.
22783     *
22784     * @ingroup Map
22785     */
22786    EAPI Eina_Bool             elm_map_paused_markers_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22787
22788    /**
22789     * Get the information of downloading status.
22790     *
22791     * @param obj The map object.
22792     * @param try_num Pointer where to store number of tiles being downloaded.
22793     * @param finish_num Pointer where to store number of tiles successfully
22794     * downloaded.
22795     *
22796     * This gets the current downloading status for the map object, the number
22797     * of tiles being downloaded and the number of tiles already downloaded.
22798     *
22799     * @ingroup Map
22800     */
22801    EAPI void                  elm_map_utils_downloading_status_get(const Evas_Object *obj, int *try_num, int *finish_num) EINA_ARG_NONNULL(1, 2, 3);
22802
22803    /**
22804     * Convert a pixel coordinate (x,y) into a geographic coordinate
22805     * (longitude, latitude).
22806     *
22807     * @param obj The map object.
22808     * @param x the coordinate.
22809     * @param y the coordinate.
22810     * @param size the size in pixels of the map.
22811     * The map is a square and generally his size is : pow(2.0, zoom)*256.
22812     * @param lon Pointer where to store the longitude that correspond to x.
22813     * @param lat Pointer where to store the latitude that correspond to y.
22814     *
22815     * @note Origin pixel point is the top left corner of the viewport.
22816     * Map zoom and size are taken on account.
22817     *
22818     * @see elm_map_utils_convert_geo_into_coord() if you need the inverse.
22819     *
22820     * @ingroup Map
22821     */
22822    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);
22823
22824    /**
22825     * Convert a geographic coordinate (longitude, latitude) into a pixel
22826     * coordinate (x, y).
22827     *
22828     * @param obj The map object.
22829     * @param lon the longitude.
22830     * @param lat the latitude.
22831     * @param size the size in pixels of the map. The map is a square
22832     * and generally his size is : pow(2.0, zoom)*256.
22833     * @param x Pointer where to store the horizontal pixel coordinate that
22834     * correspond to the longitude.
22835     * @param y Pointer where to store the vertical pixel coordinate that
22836     * correspond to the latitude.
22837     *
22838     * @note Origin pixel point is the top left corner of the viewport.
22839     * Map zoom and size are taken on account.
22840     *
22841     * @see elm_map_utils_convert_coord_into_geo() if you need the inverse.
22842     *
22843     * @ingroup Map
22844     */
22845    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);
22846
22847    /**
22848     * Convert a geographic coordinate (longitude, latitude) into a name
22849     * (address).
22850     *
22851     * @param obj The map object.
22852     * @param lon the longitude.
22853     * @param lat the latitude.
22854     * @return name A #Elm_Map_Name handle for this coordinate.
22855     *
22856     * To get the string for this address, elm_map_name_address_get()
22857     * should be used.
22858     *
22859     * @see elm_map_utils_convert_name_into_coord() if you need the inverse.
22860     *
22861     * @ingroup Map
22862     */
22863    EAPI Elm_Map_Name         *elm_map_utils_convert_coord_into_name(const Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
22864
22865    /**
22866     * Convert a name (address) into a geographic coordinate
22867     * (longitude, latitude).
22868     *
22869     * @param obj The map object.
22870     * @param name The address.
22871     * @return name A #Elm_Map_Name handle for this address.
22872     *
22873     * To get the longitude and latitude, elm_map_name_region_get()
22874     * should be used.
22875     *
22876     * @see elm_map_utils_convert_coord_into_name() if you need the inverse.
22877     *
22878     * @ingroup Map
22879     */
22880    EAPI Elm_Map_Name         *elm_map_utils_convert_name_into_coord(const Evas_Object *obj, char *address) EINA_ARG_NONNULL(1, 2);
22881
22882    /**
22883     * Convert a pixel coordinate into a rotated pixel coordinate.
22884     *
22885     * @param obj The map object.
22886     * @param x horizontal coordinate of the point to rotate.
22887     * @param y vertical coordinate of the point to rotate.
22888     * @param cx rotation's center horizontal position.
22889     * @param cy rotation's center vertical position.
22890     * @param degree amount of degrees from 0.0 to 360.0 to rotate arount Z axis.
22891     * @param xx Pointer where to store rotated x.
22892     * @param yy Pointer where to store rotated y.
22893     *
22894     * @ingroup Map
22895     */
22896    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);
22897
22898    /**
22899     * Add a new marker to the map object.
22900     *
22901     * @param obj The map object.
22902     * @param lon The longitude of the marker.
22903     * @param lat The latitude of the marker.
22904     * @param clas The class, to use when marker @b isn't grouped to others.
22905     * @param clas_group The class group, to use when marker is grouped to others
22906     * @param data The data passed to the callbacks.
22907     *
22908     * @return The created marker or @c NULL upon failure.
22909     *
22910     * A marker will be created and shown in a specific point of the map, defined
22911     * by @p lon and @p lat.
22912     *
22913     * It will be displayed using style defined by @p class when this marker
22914     * is displayed alone (not grouped). A new class can be created with
22915     * elm_map_marker_class_new().
22916     *
22917     * If the marker is grouped to other markers, it will be displayed with
22918     * style defined by @p class_group. Markers with the same group are grouped
22919     * if they are close. A new group class can be created with
22920     * elm_map_marker_group_class_new().
22921     *
22922     * Markers created with this method can be deleted with
22923     * elm_map_marker_remove().
22924     *
22925     * A marker can have associated content to be displayed by a bubble,
22926     * when a user click over it, as well as an icon. These objects will
22927     * be fetch using class' callback functions.
22928     *
22929     * @see elm_map_marker_class_new()
22930     * @see elm_map_marker_group_class_new()
22931     * @see elm_map_marker_remove()
22932     *
22933     * @ingroup Map
22934     */
22935    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);
22936
22937    /**
22938     * Set the maximum numbers of markers' content to be displayed in a group.
22939     *
22940     * @param obj The map object.
22941     * @param max The maximum numbers of items displayed in a bubble.
22942     *
22943     * A bubble will be displayed when the user clicks over the group,
22944     * and will place the content of markers that belong to this group
22945     * inside it.
22946     *
22947     * A group can have a long list of markers, consequently the creation
22948     * of the content of the bubble can be very slow.
22949     *
22950     * In order to avoid this, a maximum number of items is displayed
22951     * in a bubble.
22952     *
22953     * By default this number is 30.
22954     *
22955     * Marker with the same group class are grouped if they are close.
22956     *
22957     * @see elm_map_marker_add()
22958     *
22959     * @ingroup Map
22960     */
22961    EAPI void                  elm_map_max_marker_per_group_set(Evas_Object *obj, int max) EINA_ARG_NONNULL(1);
22962
22963    /**
22964     * Remove a marker from the map.
22965     *
22966     * @param marker The marker to remove.
22967     *
22968     * @see elm_map_marker_add()
22969     *
22970     * @ingroup Map
22971     */
22972    EAPI void                  elm_map_marker_remove(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
22973
22974    /**
22975     * Get the current coordinates of the marker.
22976     *
22977     * @param marker marker.
22978     * @param lat Pointer where to store the marker's latitude.
22979     * @param lon Pointer where to store the marker's longitude.
22980     *
22981     * These values are set when adding markers, with function
22982     * elm_map_marker_add().
22983     *
22984     * @see elm_map_marker_add()
22985     *
22986     * @ingroup Map
22987     */
22988    EAPI void                  elm_map_marker_region_get(const Elm_Map_Marker *marker, double *lon, double *lat) EINA_ARG_NONNULL(1);
22989
22990    /**
22991     * Animatedly bring in given marker to the center of the map.
22992     *
22993     * @param marker The marker to center at.
22994     *
22995     * This causes map to jump to the given @p marker's coordinates
22996     * and show it (by scrolling) in the center of the viewport, if it is not
22997     * already centered. This will use animation to do so and take a period
22998     * of time to complete.
22999     *
23000     * @see elm_map_marker_show() for a function to avoid animation.
23001     * @see elm_map_marker_region_get()
23002     *
23003     * @ingroup Map
23004     */
23005    EAPI void                  elm_map_marker_bring_in(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
23006
23007    /**
23008     * Show the given marker at the center of the map, @b immediately.
23009     *
23010     * @param marker The marker to center at.
23011     *
23012     * This causes map to @b redraw its viewport's contents to the
23013     * region contining the given @p marker's coordinates, that will be
23014     * moved to the center of the map.
23015     *
23016     * @see elm_map_marker_bring_in() for a function to move with animation.
23017     * @see elm_map_markers_list_show() if more than one marker need to be
23018     * displayed.
23019     * @see elm_map_marker_region_get()
23020     *
23021     * @ingroup Map
23022     */
23023    EAPI void                  elm_map_marker_show(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
23024
23025    /**
23026     * Move and zoom the map to display a list of markers.
23027     *
23028     * @param markers A list of #Elm_Map_Marker handles.
23029     *
23030     * The map will be centered on the center point of the markers in the list.
23031     * Then the map will be zoomed in order to fit the markers using the maximum
23032     * zoom which allows display of all the markers.
23033     *
23034     * @warning All the markers should belong to the same map object.
23035     *
23036     * @see elm_map_marker_show() to show a single marker.
23037     * @see elm_map_marker_bring_in()
23038     *
23039     * @ingroup Map
23040     */
23041    EAPI void                  elm_map_markers_list_show(Eina_List *markers) EINA_ARG_NONNULL(1);
23042
23043    /**
23044     * Get the Evas object returned by the ElmMapMarkerGetFunc callback
23045     *
23046     * @param marker The marker wich content should be returned.
23047     * @return Return the evas object if it exists, else @c NULL.
23048     *
23049     * To set callback function #ElmMapMarkerGetFunc for the marker class,
23050     * elm_map_marker_class_get_cb_set() should be used.
23051     *
23052     * This content is what will be inside the bubble that will be displayed
23053     * when an user clicks over the marker.
23054     *
23055     * This returns the actual Evas object used to be placed inside
23056     * the bubble. This may be @c NULL, as it may
23057     * not have been created or may have been deleted, at any time, by
23058     * the map. <b>Do not modify this object</b> (move, resize,
23059     * show, hide, etc.), as the map is controlling it. This
23060     * function is for querying, emitting custom signals or hooking
23061     * lower level callbacks for events on that object. Do not delete
23062     * this object under any circumstances.
23063     *
23064     * @ingroup Map
23065     */
23066    EAPI Evas_Object          *elm_map_marker_object_get(const Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
23067
23068    /**
23069     * Update the marker
23070     *
23071     * @param marker The marker to be updated.
23072     *
23073     * If a content is set to this marker, it will call function to delete it,
23074     * #ElmMapMarkerDelFunc, and then will fetch the content again with
23075     * #ElmMapMarkerGetFunc.
23076     *
23077     * These functions are set for the marker class with
23078     * elm_map_marker_class_get_cb_set() and elm_map_marker_class_del_cb_set().
23079     *
23080     * @ingroup Map
23081     */
23082    EAPI void                  elm_map_marker_update(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
23083
23084    /**
23085     * Close all the bubbles opened by the user.
23086     *
23087     * @param obj The map object.
23088     *
23089     * A bubble is displayed with a content fetched with #ElmMapMarkerGetFunc
23090     * when the user clicks on a marker.
23091     *
23092     * This functions is set for the marker class with
23093     * elm_map_marker_class_get_cb_set().
23094     *
23095     * @ingroup Map
23096     */
23097    EAPI void                  elm_map_bubbles_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
23098
23099    /**
23100     * Create a new group class.
23101     *
23102     * @param obj The map object.
23103     * @return Returns the new group class.
23104     *
23105     * Each marker must be associated to a group class. Markers in the same
23106     * group are grouped if they are close.
23107     *
23108     * The group class defines the style of the marker when a marker is grouped
23109     * to others markers. When it is alone, another class will be used.
23110     *
23111     * A group class will need to be provided when creating a marker with
23112     * elm_map_marker_add().
23113     *
23114     * Some properties and functions can be set by class, as:
23115     * - style, with elm_map_group_class_style_set()
23116     * - data - to be associated to the group class. It can be set using
23117     *   elm_map_group_class_data_set().
23118     * - min zoom to display markers, set with
23119     *   elm_map_group_class_zoom_displayed_set().
23120     * - max zoom to group markers, set using
23121     *   elm_map_group_class_zoom_grouped_set().
23122     * - visibility - set if markers will be visible or not, set with
23123     *   elm_map_group_class_hide_set().
23124     * - #ElmMapGroupIconGetFunc - used to fetch icon for markers group classes.
23125     *   It can be set using elm_map_group_class_icon_cb_set().
23126     *
23127     * @see elm_map_marker_add()
23128     * @see elm_map_group_class_style_set()
23129     * @see elm_map_group_class_data_set()
23130     * @see elm_map_group_class_zoom_displayed_set()
23131     * @see elm_map_group_class_zoom_grouped_set()
23132     * @see elm_map_group_class_hide_set()
23133     * @see elm_map_group_class_icon_cb_set()
23134     *
23135     * @ingroup Map
23136     */
23137    EAPI Elm_Map_Group_Class  *elm_map_group_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
23138
23139    /**
23140     * Set the marker's style of a group class.
23141     *
23142     * @param clas The group class.
23143     * @param style The style to be used by markers.
23144     *
23145     * Each marker must be associated to a group class, and will use the style
23146     * defined by such class when grouped to other markers.
23147     *
23148     * The following styles are provided by default theme:
23149     * @li @c radio - blue circle
23150     * @li @c radio2 - green circle
23151     * @li @c empty
23152     *
23153     * @see elm_map_group_class_new() for more details.
23154     * @see elm_map_marker_add()
23155     *
23156     * @ingroup Map
23157     */
23158    EAPI void                  elm_map_group_class_style_set(Elm_Map_Group_Class *clas, const char *style) EINA_ARG_NONNULL(1);
23159
23160    /**
23161     * Set the icon callback function of a group class.
23162     *
23163     * @param clas The group class.
23164     * @param icon_get The callback function that will return the icon.
23165     *
23166     * Each marker must be associated to a group class, and it can display a
23167     * custom icon. The function @p icon_get must return this icon.
23168     *
23169     * @see elm_map_group_class_new() for more details.
23170     * @see elm_map_marker_add()
23171     *
23172     * @ingroup Map
23173     */
23174    EAPI void                  elm_map_group_class_icon_cb_set(Elm_Map_Group_Class *clas, ElmMapGroupIconGetFunc icon_get) EINA_ARG_NONNULL(1);
23175
23176    /**
23177     * Set the data associated to the group class.
23178     *
23179     * @param clas The group class.
23180     * @param data The new user data.
23181     *
23182     * This data will be passed for callback functions, like icon get callback,
23183     * that can be set with elm_map_group_class_icon_cb_set().
23184     *
23185     * If a data was previously set, the object will lose the pointer for it,
23186     * so if needs to be freed, you must do it yourself.
23187     *
23188     * @see elm_map_group_class_new() for more details.
23189     * @see elm_map_group_class_icon_cb_set()
23190     * @see elm_map_marker_add()
23191     *
23192     * @ingroup Map
23193     */
23194    EAPI void                  elm_map_group_class_data_set(Elm_Map_Group_Class *clas, void *data) EINA_ARG_NONNULL(1);
23195
23196    /**
23197     * Set the minimum zoom from where the markers are displayed.
23198     *
23199     * @param clas The group class.
23200     * @param zoom The minimum zoom.
23201     *
23202     * Markers only will be displayed when the map is displayed at @p zoom
23203     * or bigger.
23204     *
23205     * @see elm_map_group_class_new() for more details.
23206     * @see elm_map_marker_add()
23207     *
23208     * @ingroup Map
23209     */
23210    EAPI void                  elm_map_group_class_zoom_displayed_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
23211
23212    /**
23213     * Set the zoom from where the markers are no more grouped.
23214     *
23215     * @param clas The group class.
23216     * @param zoom The maximum zoom.
23217     *
23218     * Markers only will be grouped when the map is displayed at
23219     * less than @p zoom.
23220     *
23221     * @see elm_map_group_class_new() for more details.
23222     * @see elm_map_marker_add()
23223     *
23224     * @ingroup Map
23225     */
23226    EAPI void                  elm_map_group_class_zoom_grouped_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
23227
23228    /**
23229     * Set if the markers associated to the group class @clas are hidden or not.
23230     *
23231     * @param clas The group class.
23232     * @param hide Use @c EINA_TRUE to hide markers or @c EINA_FALSE
23233     * to show them.
23234     *
23235     * If @p hide is @c EINA_TRUE the markers will be hidden, but default
23236     * is to show them.
23237     *
23238     * @ingroup Map
23239     */
23240    EAPI void                  elm_map_group_class_hide_set(Evas_Object *obj, Elm_Map_Group_Class *clas, Eina_Bool hide) EINA_ARG_NONNULL(1, 2);
23241
23242    /**
23243     * Create a new marker class.
23244     *
23245     * @param obj The map object.
23246     * @return Returns the new group class.
23247     *
23248     * Each marker must be associated to a class.
23249     *
23250     * The marker class defines the style of the marker when a marker is
23251     * displayed alone, i.e., not grouped to to others markers. When grouped
23252     * it will use group class style.
23253     *
23254     * A marker class will need to be provided when creating a marker with
23255     * elm_map_marker_add().
23256     *
23257     * Some properties and functions can be set by class, as:
23258     * - style, with elm_map_marker_class_style_set()
23259     * - #ElmMapMarkerIconGetFunc - used to fetch icon for markers classes.
23260     *   It can be set using elm_map_marker_class_icon_cb_set().
23261     * - #ElmMapMarkerGetFunc - used to fetch bubble content for marker classes.
23262     *   Set using elm_map_marker_class_get_cb_set().
23263     * - #ElmMapMarkerDelFunc - used to delete bubble content for marker classes.
23264     *   Set using elm_map_marker_class_del_cb_set().
23265     *
23266     * @see elm_map_marker_add()
23267     * @see elm_map_marker_class_style_set()
23268     * @see elm_map_marker_class_icon_cb_set()
23269     * @see elm_map_marker_class_get_cb_set()
23270     * @see elm_map_marker_class_del_cb_set()
23271     *
23272     * @ingroup Map
23273     */
23274    EAPI Elm_Map_Marker_Class *elm_map_marker_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
23275
23276    /**
23277     * Set the marker's style of a marker class.
23278     *
23279     * @param clas The marker class.
23280     * @param style The style to be used by markers.
23281     *
23282     * Each marker must be associated to a marker class, and will use the style
23283     * defined by such class when alone, i.e., @b not grouped to other markers.
23284     *
23285     * The following styles are provided by default theme:
23286     * @li @c radio
23287     * @li @c radio2
23288     * @li @c empty
23289     *
23290     * @see elm_map_marker_class_new() for more details.
23291     * @see elm_map_marker_add()
23292     *
23293     * @ingroup Map
23294     */
23295    EAPI void                  elm_map_marker_class_style_set(Elm_Map_Marker_Class *clas, const char *style) EINA_ARG_NONNULL(1);
23296
23297    /**
23298     * Set the icon callback function of a marker class.
23299     *
23300     * @param clas The marker class.
23301     * @param icon_get The callback function that will return the icon.
23302     *
23303     * Each marker must be associated to a marker class, and it can display a
23304     * custom icon. The function @p icon_get must return this icon.
23305     *
23306     * @see elm_map_marker_class_new() for more details.
23307     * @see elm_map_marker_add()
23308     *
23309     * @ingroup Map
23310     */
23311    EAPI void                  elm_map_marker_class_icon_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerIconGetFunc icon_get) EINA_ARG_NONNULL(1);
23312
23313    /**
23314     * Set the bubble content callback function of a marker class.
23315     *
23316     * @param clas The marker class.
23317     * @param get The callback function that will return the content.
23318     *
23319     * Each marker must be associated to a marker class, and it can display a
23320     * a content on a bubble that opens when the user click over the marker.
23321     * The function @p get must return this content object.
23322     *
23323     * If this content will need to be deleted, elm_map_marker_class_del_cb_set()
23324     * can be used.
23325     *
23326     * @see elm_map_marker_class_new() for more details.
23327     * @see elm_map_marker_class_del_cb_set()
23328     * @see elm_map_marker_add()
23329     *
23330     * @ingroup Map
23331     */
23332    EAPI void                  elm_map_marker_class_get_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerGetFunc get) EINA_ARG_NONNULL(1);
23333
23334    /**
23335     * Set the callback function used to delete bubble content of a marker class.
23336     *
23337     * @param clas The marker class.
23338     * @param del The callback function that will delete the content.
23339     *
23340     * Each marker must be associated to a marker class, and it can display a
23341     * a content on a bubble that opens when the user click over the marker.
23342     * The function to return such content can be set with
23343     * elm_map_marker_class_get_cb_set().
23344     *
23345     * If this content must be freed, a callback function need to be
23346     * set for that task with this function.
23347     *
23348     * If this callback is defined it will have to delete (or not) the
23349     * object inside, but if the callback is not defined the object will be
23350     * destroyed with evas_object_del().
23351     *
23352     * @see elm_map_marker_class_new() for more details.
23353     * @see elm_map_marker_class_get_cb_set()
23354     * @see elm_map_marker_add()
23355     *
23356     * @ingroup Map
23357     */
23358    EAPI void                  elm_map_marker_class_del_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerDelFunc del) EINA_ARG_NONNULL(1);
23359
23360    /**
23361     * Get the list of available sources.
23362     *
23363     * @param obj The map object.
23364     * @return The source names list.
23365     *
23366     * It will provide a list with all available sources, that can be set as
23367     * current source with elm_map_source_name_set(), or get with
23368     * elm_map_source_name_get().
23369     *
23370     * Available sources:
23371     * @li "Mapnik"
23372     * @li "Osmarender"
23373     * @li "CycleMap"
23374     * @li "Maplint"
23375     *
23376     * @see elm_map_source_name_set() for more details.
23377     * @see elm_map_source_name_get()
23378     *
23379     * @ingroup Map
23380     */
23381    EAPI const char          **elm_map_source_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23382
23383    /**
23384     * Set the source of the map.
23385     *
23386     * @param obj The map object.
23387     * @param source The source to be used.
23388     *
23389     * Map widget retrieves images that composes the map from a web service.
23390     * This web service can be set with this method.
23391     *
23392     * A different service can return a different maps with different
23393     * information and it can use different zoom values.
23394     *
23395     * The @p source_name need to match one of the names provided by
23396     * elm_map_source_names_get().
23397     *
23398     * The current source can be get using elm_map_source_name_get().
23399     *
23400     * @see elm_map_source_names_get()
23401     * @see elm_map_source_name_get()
23402     *
23403     *
23404     * @ingroup Map
23405     */
23406    EAPI void                  elm_map_source_name_set(Evas_Object *obj, const char *source_name) EINA_ARG_NONNULL(1);
23407
23408    /**
23409     * Get the name of currently used source.
23410     *
23411     * @param obj The map object.
23412     * @return Returns the name of the source in use.
23413     *
23414     * @see elm_map_source_name_set() for more details.
23415     *
23416     * @ingroup Map
23417     */
23418    EAPI const char           *elm_map_source_name_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23419
23420    /**
23421     * Set the source of the route service to be used by the map.
23422     *
23423     * @param obj The map object.
23424     * @param source The route service to be used, being it one of
23425     * #ELM_MAP_ROUTE_SOURCE_YOURS (default), #ELM_MAP_ROUTE_SOURCE_MONAV,
23426     * and #ELM_MAP_ROUTE_SOURCE_ORS.
23427     *
23428     * Each one has its own algorithm, so the route retrieved may
23429     * differ depending on the source route. Now, only the default is working.
23430     *
23431     * #ELM_MAP_ROUTE_SOURCE_YOURS is the routing service provided at
23432     * http://www.yournavigation.org/.
23433     *
23434     * #ELM_MAP_ROUTE_SOURCE_MONAV, offers exact routing without heuristic
23435     * assumptions. Its routing core is based on Contraction Hierarchies.
23436     *
23437     * #ELM_MAP_ROUTE_SOURCE_ORS, is provided at http://www.openrouteservice.org/
23438     *
23439     * @see elm_map_route_source_get().
23440     *
23441     * @ingroup Map
23442     */
23443    EAPI void                  elm_map_route_source_set(Evas_Object *obj, Elm_Map_Route_Sources source) EINA_ARG_NONNULL(1);
23444
23445    /**
23446     * Get the current route source.
23447     *
23448     * @param obj The map object.
23449     * @return The source of the route service used by the map.
23450     *
23451     * @see elm_map_route_source_set() for details.
23452     *
23453     * @ingroup Map
23454     */
23455    EAPI Elm_Map_Route_Sources elm_map_route_source_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23456
23457    /**
23458     * Set the minimum zoom of the source.
23459     *
23460     * @param obj The map object.
23461     * @param zoom New minimum zoom value to be used.
23462     *
23463     * By default, it's 0.
23464     *
23465     * @ingroup Map
23466     */
23467    EAPI void                  elm_map_source_zoom_min_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
23468
23469    /**
23470     * Get the minimum zoom of the source.
23471     *
23472     * @param obj The map object.
23473     * @return Returns the minimum zoom of the source.
23474     *
23475     * @see elm_map_source_zoom_min_set() for details.
23476     *
23477     * @ingroup Map
23478     */
23479    EAPI int                   elm_map_source_zoom_min_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23480
23481    /**
23482     * Set the maximum zoom of the source.
23483     *
23484     * @param obj The map object.
23485     * @param zoom New maximum zoom value to be used.
23486     *
23487     * By default, it's 18.
23488     *
23489     * @ingroup Map
23490     */
23491    EAPI void                  elm_map_source_zoom_max_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
23492
23493    /**
23494     * Get the maximum zoom of the source.
23495     *
23496     * @param obj The map object.
23497     * @return Returns the maximum zoom of the source.
23498     *
23499     * @see elm_map_source_zoom_min_set() for details.
23500     *
23501     * @ingroup Map
23502     */
23503    EAPI int                   elm_map_source_zoom_max_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23504
23505    /**
23506     * Set the user agent used by the map object to access routing services.
23507     *
23508     * @param obj The map object.
23509     * @param user_agent The user agent to be used by the map.
23510     *
23511     * User agent is a client application implementing a network protocol used
23512     * in communications within a clientā€“server distributed computing system
23513     *
23514     * The @p user_agent identification string will transmitted in a header
23515     * field @c User-Agent.
23516     *
23517     * @see elm_map_user_agent_get()
23518     *
23519     * @ingroup Map
23520     */
23521    EAPI void                  elm_map_user_agent_set(Evas_Object *obj, const char *user_agent) EINA_ARG_NONNULL(1, 2);
23522
23523    /**
23524     * Get the user agent used by the map object.
23525     *
23526     * @param obj The map object.
23527     * @return The user agent identification string used by the map.
23528     *
23529     * @see elm_map_user_agent_set() for details.
23530     *
23531     * @ingroup Map
23532     */
23533    EAPI const char           *elm_map_user_agent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23534
23535    /**
23536     * Add a new route to the map object.
23537     *
23538     * @param obj The map object.
23539     * @param type The type of transport to be considered when tracing a route.
23540     * @param method The routing method, what should be priorized.
23541     * @param flon The start longitude.
23542     * @param flat The start latitude.
23543     * @param tlon The destination longitude.
23544     * @param tlat The destination latitude.
23545     *
23546     * @return The created route or @c NULL upon failure.
23547     *
23548     * A route will be traced by point on coordinates (@p flat, @p flon)
23549     * to point on coordinates (@p tlat, @p tlon), using the route service
23550     * set with elm_map_route_source_set().
23551     *
23552     * It will take @p type on consideration to define the route,
23553     * depending if the user will be walking or driving, the route may vary.
23554     * One of #ELM_MAP_ROUTE_TYPE_MOTOCAR, #ELM_MAP_ROUTE_TYPE_BICYCLE, or
23555     * #ELM_MAP_ROUTE_TYPE_FOOT need to be used.
23556     *
23557     * Another parameter is what the route should priorize, the minor distance
23558     * or the less time to be spend on the route. So @p method should be one
23559     * of #ELM_MAP_ROUTE_METHOD_SHORTEST or #ELM_MAP_ROUTE_METHOD_FASTEST.
23560     *
23561     * Routes created with this method can be deleted with
23562     * elm_map_route_remove(), colored with elm_map_route_color_set(),
23563     * and distance can be get with elm_map_route_distance_get().
23564     *
23565     * @see elm_map_route_remove()
23566     * @see elm_map_route_color_set()
23567     * @see elm_map_route_distance_get()
23568     * @see elm_map_route_source_set()
23569     *
23570     * @ingroup Map
23571     */
23572    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);
23573
23574    /**
23575     * Remove a route from the map.
23576     *
23577     * @param route The route to remove.
23578     *
23579     * @see elm_map_route_add()
23580     *
23581     * @ingroup Map
23582     */
23583    EAPI void                  elm_map_route_remove(Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23584
23585    /**
23586     * Set the route color.
23587     *
23588     * @param route The route object.
23589     * @param r Red channel value, from 0 to 255.
23590     * @param g Green channel value, from 0 to 255.
23591     * @param b Blue channel value, from 0 to 255.
23592     * @param a Alpha channel value, from 0 to 255.
23593     *
23594     * It uses an additive color model, so each color channel represents
23595     * how much of each primary colors must to be used. 0 represents
23596     * ausence of this color, so if all of the three are set to 0,
23597     * the color will be black.
23598     *
23599     * These component values should be integers in the range 0 to 255,
23600     * (single 8-bit byte).
23601     *
23602     * This sets the color used for the route. By default, it is set to
23603     * solid red (r = 255, g = 0, b = 0, a = 255).
23604     *
23605     * For alpha channel, 0 represents completely transparent, and 255, opaque.
23606     *
23607     * @see elm_map_route_color_get()
23608     *
23609     * @ingroup Map
23610     */
23611    EAPI void                  elm_map_route_color_set(Elm_Map_Route *route, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
23612
23613    /**
23614     * Get the route color.
23615     *
23616     * @param route The route object.
23617     * @param r Pointer where to store the red channel value.
23618     * @param g Pointer where to store the green channel value.
23619     * @param b Pointer where to store the blue channel value.
23620     * @param a Pointer where to store the alpha channel value.
23621     *
23622     * @see elm_map_route_color_set() for details.
23623     *
23624     * @ingroup Map
23625     */
23626    EAPI void                  elm_map_route_color_get(const Elm_Map_Route *route, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
23627
23628    /**
23629     * Get the route distance in kilometers.
23630     *
23631     * @param route The route object.
23632     * @return The distance of route (unit : km).
23633     *
23634     * @ingroup Map
23635     */
23636    EAPI double                elm_map_route_distance_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23637
23638    /**
23639     * Get the information of route nodes.
23640     *
23641     * @param route The route object.
23642     * @return Returns a string with the nodes of route.
23643     *
23644     * @ingroup Map
23645     */
23646    EAPI const char           *elm_map_route_node_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23647
23648    /**
23649     * Get the information of route waypoint.
23650     *
23651     * @param route the route object.
23652     * @return Returns a string with information about waypoint of route.
23653     *
23654     * @ingroup Map
23655     */
23656    EAPI const char           *elm_map_route_waypoint_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23657
23658    /**
23659     * Get the address of the name.
23660     *
23661     * @param name The name handle.
23662     * @return Returns the address string of @p name.
23663     *
23664     * This gets the coordinates of the @p name, created with one of the
23665     * conversion functions.
23666     *
23667     * @see elm_map_utils_convert_name_into_coord()
23668     * @see elm_map_utils_convert_coord_into_name()
23669     *
23670     * @ingroup Map
23671     */
23672    EAPI const char           *elm_map_name_address_get(const Elm_Map_Name *name) EINA_ARG_NONNULL(1);
23673
23674    /**
23675     * Get the current coordinates of the name.
23676     *
23677     * @param name The name handle.
23678     * @param lat Pointer where to store the latitude.
23679     * @param lon Pointer where to store The longitude.
23680     *
23681     * This gets the coordinates of the @p name, created with one of the
23682     * conversion functions.
23683     *
23684     * @see elm_map_utils_convert_name_into_coord()
23685     * @see elm_map_utils_convert_coord_into_name()
23686     *
23687     * @ingroup Map
23688     */
23689    EAPI void                  elm_map_name_region_get(const Elm_Map_Name *name, double *lon, double *lat) EINA_ARG_NONNULL(1);
23690
23691    /**
23692     * Remove a name from the map.
23693     *
23694     * @param name The name to remove.
23695     *
23696     * Basically the struct handled by @p name will be freed, so convertions
23697     * between address and coordinates will be lost.
23698     *
23699     * @see elm_map_utils_convert_name_into_coord()
23700     * @see elm_map_utils_convert_coord_into_name()
23701     *
23702     * @ingroup Map
23703     */
23704    EAPI void                  elm_map_name_remove(Elm_Map_Name *name) EINA_ARG_NONNULL(1);
23705
23706    /**
23707     * Rotate the map.
23708     *
23709     * @param obj The map object.
23710     * @param degree Angle from 0.0 to 360.0 to rotate arount Z axis.
23711     * @param cx Rotation's center horizontal position.
23712     * @param cy Rotation's center vertical position.
23713     *
23714     * @see elm_map_rotate_get()
23715     *
23716     * @ingroup Map
23717     */
23718    EAPI void                  elm_map_rotate_set(Evas_Object *obj, double degree, Evas_Coord cx, Evas_Coord cy) EINA_ARG_NONNULL(1);
23719
23720    /**
23721     * Get the rotate degree of the map
23722     *
23723     * @param obj The map object
23724     * @param degree Pointer where to store degrees from 0.0 to 360.0
23725     * to rotate arount Z axis.
23726     * @param cx Pointer where to store rotation's center horizontal position.
23727     * @param cy Pointer where to store rotation's center vertical position.
23728     *
23729     * @see elm_map_rotate_set() to set map rotation.
23730     *
23731     * @ingroup Map
23732     */
23733    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);
23734
23735    /**
23736     * Enable or disable mouse wheel to be used to zoom in / out the map.
23737     *
23738     * @param obj The map object.
23739     * @param disabled Use @c EINA_TRUE to disable mouse wheel or @c EINA_FALSE
23740     * to enable it.
23741     *
23742     * Mouse wheel can be used for the user to zoom in or zoom out the map.
23743     *
23744     * It's disabled by default.
23745     *
23746     * @see elm_map_wheel_disabled_get()
23747     *
23748     * @ingroup Map
23749     */
23750    EAPI void                  elm_map_wheel_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
23751
23752    /**
23753     * Get a value whether mouse wheel is enabled or not.
23754     *
23755     * @param obj The map object.
23756     * @return @c EINA_TRUE means map is disabled. @c EINA_FALSE indicates
23757     * it is enabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
23758     *
23759     * Mouse wheel can be used for the user to zoom in or zoom out the map.
23760     *
23761     * @see elm_map_wheel_disabled_set() for details.
23762     *
23763     * @ingroup Map
23764     */
23765    EAPI Eina_Bool             elm_map_wheel_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23766
23767 #ifdef ELM_EMAP
23768    /**
23769     * Add a track on the map
23770     *
23771     * @param obj The map object.
23772     * @param emap The emap route object.
23773     * @return The route object. This is an elm object of type Route.
23774     *
23775     * @see elm_route_add() for details.
23776     *
23777     * @ingroup Map
23778     */
23779    EAPI Evas_Object          *elm_map_track_add(Evas_Object *obj, EMap_Route *emap) EINA_ARG_NONNULL(1);
23780 #endif
23781
23782    /**
23783     * Remove a track from the map
23784     *
23785     * @param obj The map object.
23786     * @param route The track to remove.
23787     *
23788     * @ingroup Map
23789     */
23790    EAPI void                  elm_map_track_remove(Evas_Object *obj, Evas_Object *route) EINA_ARG_NONNULL(1);
23791
23792    /**
23793     * @}
23794     */
23795
23796    /* Route */
23797    EAPI Evas_Object *elm_route_add(Evas_Object *parent);
23798 #ifdef ELM_EMAP
23799    EAPI void elm_route_emap_set(Evas_Object *obj, EMap_Route *emap);
23800 #endif
23801    EAPI double elm_route_lon_min_get(Evas_Object *obj);
23802    EAPI double elm_route_lat_min_get(Evas_Object *obj);
23803    EAPI double elm_route_lon_max_get(Evas_Object *obj);
23804    EAPI double elm_route_lat_max_get(Evas_Object *obj);
23805
23806
23807    /**
23808     * @defgroup Panel Panel
23809     *
23810     * @image html img/widget/panel/preview-00.png
23811     * @image latex img/widget/panel/preview-00.eps
23812     *
23813     * @brief A panel is a type of animated container that contains subobjects.
23814     * It can be expanded or contracted by clicking the button on it's edge.
23815     *
23816     * Orientations are as follows:
23817     * @li ELM_PANEL_ORIENT_TOP
23818     * @li ELM_PANEL_ORIENT_LEFT
23819     * @li ELM_PANEL_ORIENT_RIGHT
23820     *
23821     * To set/get/unset the content of the panel, you can use
23822     * elm_object_content_set/get/unset APIs.
23823     * Once the content object is set, a previously set one will be deleted.
23824     * If you want to keep that old content object, use the
23825     * elm_object_content_unset() function
23826     *
23827     * @ref tutorial_panel shows one way to use this widget.
23828     * @{
23829     */
23830    typedef enum _Elm_Panel_Orient
23831      {
23832         ELM_PANEL_ORIENT_TOP, /**< Panel (dis)appears from the top */
23833         ELM_PANEL_ORIENT_BOTTOM, /**< Not implemented */
23834         ELM_PANEL_ORIENT_LEFT, /**< Panel (dis)appears from the left */
23835         ELM_PANEL_ORIENT_RIGHT, /**< Panel (dis)appears from the right */
23836      } Elm_Panel_Orient;
23837    /**
23838     * @brief Adds a panel object
23839     *
23840     * @param parent The parent object
23841     *
23842     * @return The panel object, or NULL on failure
23843     */
23844    EAPI Evas_Object          *elm_panel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23845    /**
23846     * @brief Sets the orientation of the panel
23847     *
23848     * @param parent The parent object
23849     * @param orient The panel orientation. Can be one of the following:
23850     * @li ELM_PANEL_ORIENT_TOP
23851     * @li ELM_PANEL_ORIENT_LEFT
23852     * @li ELM_PANEL_ORIENT_RIGHT
23853     *
23854     * Sets from where the panel will (dis)appear.
23855     */
23856    EAPI void                  elm_panel_orient_set(Evas_Object *obj, Elm_Panel_Orient orient) EINA_ARG_NONNULL(1);
23857    /**
23858     * @brief Get the orientation of the panel.
23859     *
23860     * @param obj The panel object
23861     * @return The Elm_Panel_Orient, or ELM_PANEL_ORIENT_LEFT on failure.
23862     */
23863    EAPI Elm_Panel_Orient      elm_panel_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23864    /**
23865     * @brief Set the content of the panel.
23866     *
23867     * @param obj The panel object
23868     * @param content The panel content
23869     *
23870     * Once the content object is set, a previously set one will be deleted.
23871     * If you want to keep that old content object, use the
23872     * elm_panel_content_unset() function.
23873     */
23874    EINA_DEPRECATED EAPI void                  elm_panel_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
23875    /**
23876     * @brief Get the content of the panel.
23877     *
23878     * @param obj The panel object
23879     * @return The content that is being used
23880     *
23881     * Return the content object which is set for this widget.
23882     *
23883     * @see elm_panel_content_set()
23884     */
23885    EINA_DEPRECATED EAPI Evas_Object          *elm_panel_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23886    /**
23887     * @brief Unset the content of the panel.
23888     *
23889     * @param obj The panel object
23890     * @return The content that was being used
23891     *
23892     * Unparent and return the content object which was set for this widget.
23893     *
23894     * @see elm_panel_content_set()
23895     */
23896    EINA_DEPRECATED EAPI Evas_Object          *elm_panel_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
23897    /**
23898     * @brief Set the state of the panel.
23899     *
23900     * @param obj The panel object
23901     * @param hidden If true, the panel will run the animation to contract
23902     */
23903    EAPI void                  elm_panel_hidden_set(Evas_Object *obj, Eina_Bool hidden) EINA_ARG_NONNULL(1);
23904    /**
23905     * @brief Get the state of the panel.
23906     *
23907     * @param obj The panel object
23908     * @param hidden If true, the panel is in the "hide" state
23909     */
23910    EAPI Eina_Bool             elm_panel_hidden_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23911    /**
23912     * @brief Toggle the hidden state of the panel from code
23913     *
23914     * @param obj The panel object
23915     */
23916    EAPI void                  elm_panel_toggle(Evas_Object *obj) EINA_ARG_NONNULL(1);
23917    /**
23918     * @}
23919     */
23920
23921    /**
23922     * @defgroup Panes Panes
23923     * @ingroup Elementary
23924     *
23925     * @image html img/widget/panes/preview-00.png
23926     * @image latex img/widget/panes/preview-00.eps width=\textwidth
23927     *
23928     * @image html img/panes.png
23929     * @image latex img/panes.eps width=\textwidth
23930     *
23931     * The panes adds a dragable bar between two contents. When dragged
23932     * this bar will resize contents size.
23933     *
23934     * Panes can be displayed vertically or horizontally, and contents
23935     * size proportion can be customized (homogeneous by default).
23936     *
23937     * Smart callbacks one can listen to:
23938     * - "press" - The panes has been pressed (button wasn't released yet).
23939     * - "unpressed" - The panes was released after being pressed.
23940     * - "clicked" - The panes has been clicked>
23941     * - "clicked,double" - The panes has been double clicked
23942     *
23943     * Available styles for it:
23944     * - @c "default"
23945     *
23946     * Default contents parts of the panes widget that you can use for are:
23947     * @li "elm.swallow.left" - A leftside content of the panes
23948     * @li "elm.swallow.right" - A rightside content of the panes
23949     *
23950     * If panes is displayed vertically, left content will be displayed at
23951     * top.
23952     * 
23953     * Here is an example on its usage:
23954     * @li @ref panes_example
23955     */
23956
23957 #define ELM_PANES_CONTENT_LEFT "elm.swallow.left"
23958 #define ELM_PANES_CONTENT_RIGHT "elm.swallow.right"
23959
23960    /**
23961     * @addtogroup Panes
23962     * @{
23963     */
23964
23965    /**
23966     * Add a new panes widget to the given parent Elementary
23967     * (container) object.
23968     *
23969     * @param parent The parent object.
23970     * @return a new panes widget handle or @c NULL, on errors.
23971     *
23972     * This function inserts a new panes widget on the canvas.
23973     *
23974     * @ingroup Panes
23975     */
23976    EAPI Evas_Object          *elm_panes_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23977
23978    /**
23979     * Set the left content of the panes widget.
23980     *
23981     * @param obj The panes object.
23982     * @param content The new left content object.
23983     *
23984     * Once the content object is set, a previously set one will be deleted.
23985     * If you want to keep that old content object, use the
23986     * elm_panes_content_left_unset() function.
23987     *
23988     * If panes is displayed vertically, left content will be displayed at
23989     * top.
23990     *
23991     * @see elm_panes_content_left_get()
23992     * @see elm_panes_content_right_set() to set content on the other side.
23993     *
23994     * @ingroup Panes
23995     */
23996    EINA_DEPRECATED EAPI void                  elm_panes_content_left_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
23997
23998    /**
23999     * Set the right content of the panes widget.
24000     *
24001     * @param obj The panes object.
24002     * @param content The new right content object.
24003     *
24004     * Once the content object is set, a previously set one will be deleted.
24005     * If you want to keep that old content object, use the
24006     * elm_panes_content_right_unset() function.
24007     *
24008     * If panes is displayed vertically, left content will be displayed at
24009     * bottom.
24010     *
24011     * @see elm_panes_content_right_get()
24012     * @see elm_panes_content_left_set() to set content on the other side.
24013     *
24014     * @ingroup Panes
24015     */
24016    EINA_DEPRECATED EAPI void                  elm_panes_content_right_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24017
24018    /**
24019     * Get the left content of the panes.
24020     *
24021     * @param obj The panes object.
24022     * @return The left content object that is being used.
24023     *
24024     * Return the left content object which is set for this widget.
24025     *
24026     * @see elm_panes_content_left_set() for details.
24027     *
24028     * @ingroup Panes
24029     */
24030    EINA_DEPRECATED EAPI Evas_Object          *elm_panes_content_left_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24031
24032    /**
24033     * Get the right content of the panes.
24034     *
24035     * @param obj The panes object
24036     * @return The right content object that is being used
24037     *
24038     * Return the right content object which is set for this widget.
24039     *
24040     * @see elm_panes_content_right_set() for details.
24041     *
24042     * @ingroup Panes
24043     */
24044    EINA_DEPRECATED EAPI Evas_Object          *elm_panes_content_right_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24045
24046    /**
24047     * Unset the left content used for the panes.
24048     *
24049     * @param obj The panes object.
24050     * @return The left content object that was being used.
24051     *
24052     * Unparent and return the left content object which was set for this widget.
24053     *
24054     * @see elm_panes_content_left_set() for details.
24055     * @see elm_panes_content_left_get().
24056     *
24057     * @ingroup Panes
24058     */
24059    EINA_DEPRECATED EAPI Evas_Object          *elm_panes_content_left_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24060
24061    /**
24062     * Unset the right content used for the panes.
24063     *
24064     * @param obj The panes object.
24065     * @return The right content object that was being used.
24066     *
24067     * Unparent and return the right content object which was set for this
24068     * widget.
24069     *
24070     * @see elm_panes_content_right_set() for details.
24071     * @see elm_panes_content_right_get().
24072     *
24073     * @ingroup Panes
24074     */
24075    EAPI Evas_Object          *elm_panes_content_right_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24076
24077    /**
24078     * Get the size proportion of panes widget's left side.
24079     *
24080     * @param obj The panes object.
24081     * @return float value between 0.0 and 1.0 representing size proportion
24082     * of left side.
24083     *
24084     * @see elm_panes_content_left_size_set() for more details.
24085     *
24086     * @ingroup Panes
24087     */
24088    EAPI double                elm_panes_content_left_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24089
24090    /**
24091     * Set the size proportion of panes widget's left side.
24092     *
24093     * @param obj The panes object.
24094     * @param size Value between 0.0 and 1.0 representing size proportion
24095     * of left side.
24096     *
24097     * By default it's homogeneous, i.e., both sides have the same size.
24098     *
24099     * If something different is required, it can be set with this function.
24100     * For example, if the left content should be displayed over
24101     * 75% of the panes size, @p size should be passed as @c 0.75.
24102     * This way, right content will be resized to 25% of panes size.
24103     *
24104     * If displayed vertically, left content is displayed at top, and
24105     * right content at bottom.
24106     *
24107     * @note This proportion will change when user drags the panes bar.
24108     *
24109     * @see elm_panes_content_left_size_get()
24110     *
24111     * @ingroup Panes
24112     */
24113    EAPI void                  elm_panes_content_left_size_set(Evas_Object *obj, double size) EINA_ARG_NONNULL(1);
24114
24115   /**
24116    * Set the orientation of a given panes widget.
24117    *
24118    * @param obj The panes object.
24119    * @param horizontal Use @c EINA_TRUE to make @p obj to be
24120    * @b horizontal, @c EINA_FALSE to make it @b vertical.
24121    *
24122    * Use this function to change how your panes is to be
24123    * disposed: vertically or horizontally.
24124    *
24125    * By default it's displayed horizontally.
24126    *
24127    * @see elm_panes_horizontal_get()
24128    *
24129    * @ingroup Panes
24130    */
24131    EAPI void                  elm_panes_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
24132
24133    /**
24134     * Retrieve the orientation of a given panes widget.
24135     *
24136     * @param obj The panes object.
24137     * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
24138     * @c EINA_FALSE if it's @b vertical (and on errors).
24139     *
24140     * @see elm_panes_horizontal_set() for more details.
24141     *
24142     * @ingroup Panes
24143     */
24144    EAPI Eina_Bool             elm_panes_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24145    EAPI void                  elm_panes_fixed_set(Evas_Object *obj, Eina_Bool fixed) EINA_ARG_NONNULL(1);
24146    EAPI Eina_Bool             elm_panes_fixed_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24147
24148    /**
24149     * @}
24150     */
24151
24152    /**
24153     * @defgroup Flip Flip
24154     *
24155     * @image html img/widget/flip/preview-00.png
24156     * @image latex img/widget/flip/preview-00.eps
24157     *
24158     * This widget holds 2 content objects(Evas_Object): one on the front and one
24159     * on the back. It allows you to flip from front to back and vice-versa using
24160     * various animations.
24161     *
24162     * If either the front or back contents are not set the flip will treat that
24163     * as transparent. So if you wore to set the front content but not the back,
24164     * and then call elm_flip_go() you would see whatever is below the flip.
24165     *
24166     * For a list of supported animations see elm_flip_go().
24167     *
24168     * Signals that you can add callbacks for are:
24169     * "animate,begin" - when a flip animation was started
24170     * "animate,done" - when a flip animation is finished
24171     *
24172     * @ref tutorial_flip show how to use most of the API.
24173     *
24174     * @{
24175     */
24176    typedef enum _Elm_Flip_Mode
24177      {
24178         ELM_FLIP_ROTATE_Y_CENTER_AXIS,
24179         ELM_FLIP_ROTATE_X_CENTER_AXIS,
24180         ELM_FLIP_ROTATE_XZ_CENTER_AXIS,
24181         ELM_FLIP_ROTATE_YZ_CENTER_AXIS,
24182         ELM_FLIP_CUBE_LEFT,
24183         ELM_FLIP_CUBE_RIGHT,
24184         ELM_FLIP_CUBE_UP,
24185         ELM_FLIP_CUBE_DOWN,
24186         ELM_FLIP_PAGE_LEFT,
24187         ELM_FLIP_PAGE_RIGHT,
24188         ELM_FLIP_PAGE_UP,
24189         ELM_FLIP_PAGE_DOWN
24190      } Elm_Flip_Mode;
24191    typedef enum _Elm_Flip_Interaction
24192      {
24193         ELM_FLIP_INTERACTION_NONE,
24194         ELM_FLIP_INTERACTION_ROTATE,
24195         ELM_FLIP_INTERACTION_CUBE,
24196         ELM_FLIP_INTERACTION_PAGE
24197      } Elm_Flip_Interaction;
24198    typedef enum _Elm_Flip_Direction
24199      {
24200         ELM_FLIP_DIRECTION_UP, /**< Allows interaction with the top of the widget */
24201         ELM_FLIP_DIRECTION_DOWN, /**< Allows interaction with the bottom of the widget */
24202         ELM_FLIP_DIRECTION_LEFT, /**< Allows interaction with the left portion of the widget */
24203         ELM_FLIP_DIRECTION_RIGHT /**< Allows interaction with the right portion of the widget */
24204      } Elm_Flip_Direction;
24205    /**
24206     * @brief Add a new flip to the parent
24207     *
24208     * @param parent The parent object
24209     * @return The new object or NULL if it cannot be created
24210     */
24211    EAPI Evas_Object *elm_flip_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24212    /**
24213     * @brief Set the front content of the flip widget.
24214     *
24215     * @param obj The flip object
24216     * @param content The new front content object
24217     *
24218     * Once the content object is set, a previously set one will be deleted.
24219     * If you want to keep that old content object, use the
24220     * elm_flip_content_front_unset() function.
24221     */
24222    EAPI void         elm_flip_content_front_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24223    /**
24224     * @brief Set the back content of the flip widget.
24225     *
24226     * @param obj The flip object
24227     * @param content The new back content object
24228     *
24229     * Once the content object is set, a previously set one will be deleted.
24230     * If you want to keep that old content object, use the
24231     * elm_flip_content_back_unset() function.
24232     */
24233    EAPI void         elm_flip_content_back_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24234    /**
24235     * @brief Get the front content used for the flip
24236     *
24237     * @param obj The flip object
24238     * @return The front content object that is being used
24239     *
24240     * Return the front content object which is set for this widget.
24241     */
24242    EAPI Evas_Object *elm_flip_content_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24243    /**
24244     * @brief Get the back content used for the flip
24245     *
24246     * @param obj The flip object
24247     * @return The back content object that is being used
24248     *
24249     * Return the back content object which is set for this widget.
24250     */
24251    EAPI Evas_Object *elm_flip_content_back_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24252    /**
24253     * @brief Unset the front content used for the flip
24254     *
24255     * @param obj The flip object
24256     * @return The front content object that was being used
24257     *
24258     * Unparent and return the front content object which was set for this widget.
24259     */
24260    EAPI Evas_Object *elm_flip_content_front_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24261    /**
24262     * @brief Unset the back content used for the flip
24263     *
24264     * @param obj The flip object
24265     * @return The back content object that was being used
24266     *
24267     * Unparent and return the back content object which was set for this widget.
24268     */
24269    EAPI Evas_Object *elm_flip_content_back_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24270    /**
24271     * @brief Get flip front visibility state
24272     *
24273     * @param obj The flip objct
24274     * @return EINA_TRUE if front front is showing, EINA_FALSE if the back is
24275     * showing.
24276     */
24277    EAPI Eina_Bool    elm_flip_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24278    /**
24279     * @brief Set flip perspective
24280     *
24281     * @param obj The flip object
24282     * @param foc The coordinate to set the focus on
24283     * @param x The X coordinate
24284     * @param y The Y coordinate
24285     *
24286     * @warning This function currently does nothing.
24287     */
24288    EAPI void         elm_flip_perspective_set(Evas_Object *obj, Evas_Coord foc, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
24289    /**
24290     * @brief Runs the flip animation
24291     *
24292     * @param obj The flip object
24293     * @param mode The mode type
24294     *
24295     * Flips the front and back contents using the @p mode animation. This
24296     * efectively hides the currently visible content and shows the hidden one.
24297     *
24298     * There a number of possible animations to use for the flipping:
24299     * @li ELM_FLIP_ROTATE_X_CENTER_AXIS - Rotate the currently visible content
24300     * around a horizontal axis in the middle of its height, the other content
24301     * is shown as the other side of the flip.
24302     * @li ELM_FLIP_ROTATE_Y_CENTER_AXIS - Rotate the currently visible content
24303     * around a vertical axis in the middle of its width, the other content is
24304     * shown as the other side of the flip.
24305     * @li ELM_FLIP_ROTATE_XZ_CENTER_AXIS - Rotate the currently visible content
24306     * around a diagonal axis in the middle of its width, the other content is
24307     * shown as the other side of the flip.
24308     * @li ELM_FLIP_ROTATE_YZ_CENTER_AXIS - Rotate the currently visible content
24309     * around a diagonal axis in the middle of its height, the other content is
24310     * shown as the other side of the flip.
24311     * @li ELM_FLIP_CUBE_LEFT - Rotate the currently visible content to the left
24312     * as if the flip was a cube, the other content is show as the right face of
24313     * the cube.
24314     * @li ELM_FLIP_CUBE_RIGHT - Rotate the currently visible content to the
24315     * right as if the flip was a cube, the other content is show as the left
24316     * face of the cube.
24317     * @li ELM_FLIP_CUBE_UP - Rotate the currently visible content up as if the
24318     * flip was a cube, the other content is show as the bottom face of the cube.
24319     * @li ELM_FLIP_CUBE_DOWN - Rotate the currently visible content down as if
24320     * the flip was a cube, the other content is show as the upper face of the
24321     * cube.
24322     * @li ELM_FLIP_PAGE_LEFT - Move the currently visible content to the left as
24323     * if the flip was a book, the other content is shown as the page below that.
24324     * @li ELM_FLIP_PAGE_RIGHT - Move the currently visible content to the right
24325     * as if the flip was a book, the other content is shown as the page below
24326     * that.
24327     * @li ELM_FLIP_PAGE_UP - Move the currently visible content up as if the
24328     * flip was a book, the other content is shown as the page below that.
24329     * @li ELM_FLIP_PAGE_DOWN - Move the currently visible content down as if the
24330     * flip was a book, the other content is shown as the page below that.
24331     *
24332     * @image html elm_flip.png
24333     * @image latex elm_flip.eps width=\textwidth
24334     */
24335    EAPI void         elm_flip_go(Evas_Object *obj, Elm_Flip_Mode mode) EINA_ARG_NONNULL(1);
24336    /**
24337     * @brief Set the interactive flip mode
24338     *
24339     * @param obj The flip object
24340     * @param mode The interactive flip mode to use
24341     *
24342     * This sets if the flip should be interactive (allow user to click and
24343     * drag a side of the flip to reveal the back page and cause it to flip).
24344     * By default a flip is not interactive. You may also need to set which
24345     * sides of the flip are "active" for flipping and how much space they use
24346     * (a minimum of a finger size) with elm_flip_interacton_direction_enabled_set()
24347     * and elm_flip_interacton_direction_hitsize_set()
24348     *
24349     * The four avilable mode of interaction are:
24350     * @li ELM_FLIP_INTERACTION_NONE - No interaction is allowed
24351     * @li ELM_FLIP_INTERACTION_ROTATE - Interaction will cause rotate animation
24352     * @li ELM_FLIP_INTERACTION_CUBE - Interaction will cause cube animation
24353     * @li ELM_FLIP_INTERACTION_PAGE - Interaction will cause page animation
24354     *
24355     * @note ELM_FLIP_INTERACTION_ROTATE won't cause
24356     * ELM_FLIP_ROTATE_XZ_CENTER_AXIS or ELM_FLIP_ROTATE_YZ_CENTER_AXIS to
24357     * happen, those can only be acheived with elm_flip_go();
24358     */
24359    EAPI void         elm_flip_interaction_set(Evas_Object *obj, Elm_Flip_Interaction mode);
24360    /**
24361     * @brief Get the interactive flip mode
24362     *
24363     * @param obj The flip object
24364     * @return The interactive flip mode
24365     *
24366     * Returns the interactive flip mode set by elm_flip_interaction_set()
24367     */
24368    EAPI Elm_Flip_Interaction elm_flip_interaction_get(const Evas_Object *obj);
24369    /**
24370     * @brief Set which directions of the flip respond to interactive flip
24371     *
24372     * @param obj The flip object
24373     * @param dir The direction to change
24374     * @param enabled If that direction is enabled or not
24375     *
24376     * By default all directions are disabled, so you may want to enable the
24377     * desired directions for flipping if you need interactive flipping. You must
24378     * call this function once for each direction that should be enabled.
24379     *
24380     * @see elm_flip_interaction_set()
24381     */
24382    EAPI void         elm_flip_interacton_direction_enabled_set(Evas_Object *obj, Elm_Flip_Direction dir, Eina_Bool enabled);
24383    /**
24384     * @brief Get the enabled state of that flip direction
24385     *
24386     * @param obj The flip object
24387     * @param dir The direction to check
24388     * @return If that direction is enabled or not
24389     *
24390     * Gets the enabled state set by elm_flip_interacton_direction_enabled_set()
24391     *
24392     * @see elm_flip_interaction_set()
24393     */
24394    EAPI Eina_Bool    elm_flip_interacton_direction_enabled_get(Evas_Object *obj, Elm_Flip_Direction dir);
24395    /**
24396     * @brief Set the amount of the flip that is sensitive to interactive flip
24397     *
24398     * @param obj The flip object
24399     * @param dir The direction to modify
24400     * @param hitsize The amount of that dimension (0.0 to 1.0) to use
24401     *
24402     * Set the amount of the flip that is sensitive to interactive flip, with 0
24403     * representing no area in the flip and 1 representing the entire flip. There
24404     * is however a consideration to be made in that the area will never be
24405     * smaller than the finger size set(as set in your Elementary configuration).
24406     *
24407     * @see elm_flip_interaction_set()
24408     */
24409    EAPI void         elm_flip_interacton_direction_hitsize_set(Evas_Object *obj, Elm_Flip_Direction dir, double hitsize);
24410    /**
24411     * @brief Get the amount of the flip that is sensitive to interactive flip
24412     *
24413     * @param obj The flip object
24414     * @param dir The direction to check
24415     * @return The size set for that direction
24416     *
24417     * Returns the amount os sensitive area set by
24418     * elm_flip_interacton_direction_hitsize_set().
24419     */
24420    EAPI double       elm_flip_interacton_direction_hitsize_get(Evas_Object *obj, Elm_Flip_Direction dir);
24421    /**
24422     * @}
24423     */
24424
24425    /* scrolledentry */
24426    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24427    EINA_DEPRECATED EAPI void         elm_scrolled_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
24428    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24429    EINA_DEPRECATED EAPI void         elm_scrolled_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
24430    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24431    EINA_DEPRECATED EAPI void         elm_scrolled_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
24432    EINA_DEPRECATED EAPI const char  *elm_scrolled_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24433    EINA_DEPRECATED EAPI void         elm_scrolled_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
24434    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24435    EINA_DEPRECATED EAPI const char  *elm_scrolled_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24436    EINA_DEPRECATED EAPI void         elm_scrolled_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
24437    EINA_DEPRECATED EAPI void         elm_scrolled_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
24438    EINA_DEPRECATED EAPI void         elm_scrolled_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
24439    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24440    EINA_DEPRECATED EAPI void         elm_scrolled_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
24441    EINA_DEPRECATED EAPI void         elm_scrolled_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
24442    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
24443    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
24444    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
24445    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
24446    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24447    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24448    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24449    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24450    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
24451    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
24452    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24453    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24454    EINA_DEPRECATED EAPI const char  *elm_scrolled_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24455    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
24456    EINA_DEPRECATED EAPI int          elm_scrolled_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24457    EINA_DEPRECATED EAPI void         elm_scrolled_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
24458    EINA_DEPRECATED EAPI void         elm_scrolled_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
24459    EINA_DEPRECATED EAPI void         elm_scrolled_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
24460    EINA_DEPRECATED EAPI void         elm_scrolled_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
24461    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);
24462    EINA_DEPRECATED EAPI void         elm_scrolled_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
24463    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24464    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);
24465    EINA_DEPRECATED EAPI void         elm_scrolled_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
24466    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);
24467    EINA_DEPRECATED EAPI void         elm_scrolled_entry_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1, 2);
24468    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24469    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24470    EINA_DEPRECATED EAPI void         elm_scrolled_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
24471    EINA_DEPRECATED EAPI void         elm_scrolled_entry_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1, 2);
24472    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24473    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24474    EINA_DEPRECATED EAPI void         elm_scrolled_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
24475    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);
24476    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);
24477    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);
24478    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);
24479    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);
24480    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);
24481    EINA_DEPRECATED EAPI void         elm_scrolled_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
24482    EINA_DEPRECATED EAPI void         elm_scrolled_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
24483    EINA_DEPRECATED EAPI void         elm_scrolled_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
24484    EINA_DEPRECATED EAPI void         elm_scrolled_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
24485    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24486    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
24487    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cnp_textonly_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
24488
24489    /**
24490     * @defgroup Conformant Conformant
24491     * @ingroup Elementary
24492     *
24493     * @image html img/widget/conformant/preview-00.png
24494     * @image latex img/widget/conformant/preview-00.eps width=\textwidth
24495     *
24496     * @image html img/conformant.png
24497     * @image latex img/conformant.eps width=\textwidth
24498     *
24499     * The aim is to provide a widget that can be used in elementary apps to
24500     * account for space taken up by the indicator, virtual keypad & softkey
24501     * windows when running the illume2 module of E17.
24502     *
24503     * So conformant content will be sized and positioned considering the
24504     * space required for such stuff, and when they popup, as a keyboard
24505     * shows when an entry is selected, conformant content won't change.
24506     *
24507     * Available styles for it:
24508     * - @c "default"
24509     *
24510     * Default contents parts of the conformant widget that you can use for are:
24511     * @li "elm.swallow.content" - A content of the conformant
24512     *
24513     * See how to use this widget in this example:
24514     * @ref conformant_example
24515     */
24516
24517    /**
24518     * @addtogroup Conformant
24519     * @{
24520     */
24521
24522    /**
24523     * Add a new conformant widget to the given parent Elementary
24524     * (container) object.
24525     *
24526     * @param parent The parent object.
24527     * @return A new conformant widget handle or @c NULL, on errors.
24528     *
24529     * This function inserts a new conformant widget on the canvas.
24530     *
24531     * @ingroup Conformant
24532     */
24533    EAPI Evas_Object *elm_conformant_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24534
24535    /**
24536     * Set the content of the conformant widget.
24537     *
24538     * @param obj The conformant object.
24539     * @param content The content to be displayed by the conformant.
24540     *
24541     * Content will be sized and positioned considering the space required
24542     * to display a virtual keyboard. So it won't fill all the conformant
24543     * size. This way is possible to be sure that content won't resize
24544     * or be re-positioned after the keyboard is displayed.
24545     *
24546     * Once the content object is set, a previously set one will be deleted.
24547     * If you want to keep that old content object, use the
24548     * elm_object_content_unset() function.
24549     *
24550     * @see elm_object_content_unset()
24551     * @see elm_object_content_get()
24552     *
24553     * @ingroup Conformant
24554     */
24555    EINA_DEPRECATED EAPI void         elm_conformant_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24556
24557    /**
24558     * Get the content of the conformant widget.
24559     *
24560     * @param obj The conformant object.
24561     * @return The content that is being used.
24562     *
24563     * Return the content object which is set for this widget.
24564     * It won't be unparent from conformant. For that, use
24565     * elm_object_content_unset().
24566     *
24567     * @see elm_object_content_set().
24568     * @see elm_object_content_unset()
24569     *
24570     * @ingroup Conformant
24571     */
24572    EINA_DEPRECATED EAPI Evas_Object *elm_conformant_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24573
24574    /**
24575     * Unset the content of the conformant widget.
24576     *
24577     * @param obj The conformant object.
24578     * @return The content that was being used.
24579     *
24580     * Unparent and return the content object which was set for this widget.
24581     *
24582     * @see elm_object_content_set().
24583     *
24584     * @ingroup Conformant
24585     */
24586    EINA_DEPRECATED EAPI Evas_Object *elm_conformant_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24587
24588    /**
24589     * Returns the Evas_Object that represents the content area.
24590     *
24591     * @param obj The conformant object.
24592     * @return The content area of the widget.
24593     *
24594     * @ingroup Conformant
24595     */
24596    EAPI Evas_Object *elm_conformant_content_area_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24597
24598    /**
24599     * @}
24600     */
24601
24602    /**
24603     * @defgroup Mapbuf Mapbuf
24604     * @ingroup Elementary
24605     *
24606     * @image html img/widget/mapbuf/preview-00.png
24607     * @image latex img/widget/mapbuf/preview-00.eps width=\textwidth
24608     *
24609     * This holds one content object and uses an Evas Map of transformation
24610     * points to be later used with this content. So the content will be
24611     * moved, resized, etc as a single image. So it will improve performance
24612     * when you have a complex interafce, with a lot of elements, and will
24613     * need to resize or move it frequently (the content object and its
24614     * children).
24615     *
24616     * To set/get/unset the content of the mapbuf, you can use 
24617     * elm_object_content_set/get/unset APIs. 
24618     * Once the content object is set, a previously set one will be deleted.
24619     * If you want to keep that old content object, use the
24620     * elm_object_content_unset() function.
24621     *
24622     * To enable map, elm_mapbuf_enabled_set() should be used.
24623     * 
24624     * See how to use this widget in this example:
24625     * @ref mapbuf_example
24626     */
24627
24628    /**
24629     * @addtogroup Mapbuf
24630     * @{
24631     */
24632
24633    /**
24634     * Add a new mapbuf widget to the given parent Elementary
24635     * (container) object.
24636     *
24637     * @param parent The parent object.
24638     * @return A new mapbuf widget handle or @c NULL, on errors.
24639     *
24640     * This function inserts a new mapbuf widget on the canvas.
24641     *
24642     * @ingroup Mapbuf
24643     */
24644    EAPI Evas_Object *elm_mapbuf_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24645
24646    /**
24647     * Set the content of the mapbuf.
24648     *
24649     * @param obj The mapbuf object.
24650     * @param content The content that will be filled in this mapbuf object.
24651     *
24652     * Once the content object is set, a previously set one will be deleted.
24653     * If you want to keep that old content object, use the
24654     * elm_mapbuf_content_unset() function.
24655     *
24656     * To enable map, elm_mapbuf_enabled_set() should be used.
24657     *
24658     * @ingroup Mapbuf
24659     */
24660    EINA_DEPRECATED EAPI void         elm_mapbuf_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24661
24662    /**
24663     * Get the content of the mapbuf.
24664     *
24665     * @param obj The mapbuf object.
24666     * @return The content that is being used.
24667     *
24668     * Return the content object which is set for this widget.
24669     *
24670     * @see elm_mapbuf_content_set() for details.
24671     *
24672     * @ingroup Mapbuf
24673     */
24674    EINA_DEPRECATED EAPI Evas_Object *elm_mapbuf_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24675
24676    /**
24677     * Unset the content of the mapbuf.
24678     *
24679     * @param obj The mapbuf object.
24680     * @return The content that was being used.
24681     *
24682     * Unparent and return the content object which was set for this widget.
24683     *
24684     * @see elm_mapbuf_content_set() for details.
24685     *
24686     * @ingroup Mapbuf
24687     */
24688    EINA_DEPRECATED EAPI Evas_Object *elm_mapbuf_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24689
24690    /**
24691     * Enable or disable the map.
24692     *
24693     * @param obj The mapbuf object.
24694     * @param enabled @c EINA_TRUE to enable map or @c EINA_FALSE to disable it.
24695     *
24696     * This enables the map that is set or disables it. On enable, the object
24697     * geometry will be saved, and the new geometry will change (position and
24698     * size) to reflect the map geometry set.
24699     *
24700     * Also, when enabled, alpha and smooth states will be used, so if the
24701     * content isn't solid, alpha should be enabled, for example, otherwise
24702     * a black retangle will fill the content.
24703     *
24704     * When disabled, the stored map will be freed and geometry prior to
24705     * enabling the map will be restored.
24706     *
24707     * It's disabled by default.
24708     *
24709     * @see elm_mapbuf_alpha_set()
24710     * @see elm_mapbuf_smooth_set()
24711     *
24712     * @ingroup Mapbuf
24713     */
24714    EAPI void         elm_mapbuf_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
24715
24716    /**
24717     * Get a value whether map is enabled or not.
24718     *
24719     * @param obj The mapbuf object.
24720     * @return @c EINA_TRUE means map is enabled. @c EINA_FALSE indicates
24721     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24722     *
24723     * @see elm_mapbuf_enabled_set() for details.
24724     *
24725     * @ingroup Mapbuf
24726     */
24727    EAPI Eina_Bool    elm_mapbuf_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24728
24729    /**
24730     * Enable or disable smooth map rendering.
24731     *
24732     * @param obj The mapbuf object.
24733     * @param smooth @c EINA_TRUE to enable smooth map rendering or @c EINA_FALSE
24734     * to disable it.
24735     *
24736     * This sets smoothing for map rendering. If the object is a type that has
24737     * its own smoothing settings, then both the smooth settings for this object
24738     * and the map must be turned off.
24739     *
24740     * By default smooth maps are enabled.
24741     *
24742     * @ingroup Mapbuf
24743     */
24744    EAPI void         elm_mapbuf_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
24745
24746    /**
24747     * Get a value whether smooth map rendering is enabled or not.
24748     *
24749     * @param obj The mapbuf object.
24750     * @return @c EINA_TRUE means smooth map rendering is enabled. @c EINA_FALSE
24751     * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24752     *
24753     * @see elm_mapbuf_smooth_set() for details.
24754     *
24755     * @ingroup Mapbuf
24756     */
24757    EAPI Eina_Bool    elm_mapbuf_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24758
24759    /**
24760     * Set or unset alpha flag for map rendering.
24761     *
24762     * @param obj The mapbuf object.
24763     * @param alpha @c EINA_TRUE to enable alpha blending or @c EINA_FALSE
24764     * to disable it.
24765     *
24766     * This sets alpha flag for map rendering. If the object is a type that has
24767     * its own alpha settings, then this will take precedence. Only image objects
24768     * have this currently. It stops alpha blending of the map area, and is
24769     * useful if you know the object and/or all sub-objects is 100% solid.
24770     *
24771     * Alpha is enabled by default.
24772     *
24773     * @ingroup Mapbuf
24774     */
24775    EAPI void         elm_mapbuf_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
24776
24777    /**
24778     * Get a value whether alpha blending is enabled or not.
24779     *
24780     * @param obj The mapbuf object.
24781     * @return @c EINA_TRUE means alpha blending is enabled. @c EINA_FALSE
24782     * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24783     *
24784     * @see elm_mapbuf_alpha_set() for details.
24785     *
24786     * @ingroup Mapbuf
24787     */
24788    EAPI Eina_Bool    elm_mapbuf_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24789
24790    /**
24791     * @}
24792     */
24793
24794    /**
24795     * @defgroup Flipselector Flip Selector
24796     *
24797     * @image html img/widget/flipselector/preview-00.png
24798     * @image latex img/widget/flipselector/preview-00.eps
24799     *
24800     * A flip selector is a widget to show a set of @b text items, one
24801     * at a time, with the same sheet switching style as the @ref Clock
24802     * "clock" widget, when one changes the current displaying sheet
24803     * (thus, the "flip" in the name).
24804     *
24805     * User clicks to flip sheets which are @b held for some time will
24806     * make the flip selector to flip continuosly and automatically for
24807     * the user. The interval between flips will keep growing in time,
24808     * so that it helps the user to reach an item which is distant from
24809     * the current selection.
24810     *
24811     * Smart callbacks one can register to:
24812     * - @c "selected" - when the widget's selected text item is changed
24813     * - @c "overflowed" - when the widget's current selection is changed
24814     *   from the first item in its list to the last
24815     * - @c "underflowed" - when the widget's current selection is changed
24816     *   from the last item in its list to the first
24817     *
24818     * Available styles for it:
24819     * - @c "default"
24820     *
24821     * Here is an example on its usage:
24822     * @li @ref flipselector_example
24823     */
24824
24825    /**
24826     * @addtogroup Flipselector
24827     * @{
24828     */
24829
24830    typedef struct _Elm_Flipselector_Item Elm_Flipselector_Item; /**< Item handle for a flip selector widget. */
24831
24832    /**
24833     * Add a new flip selector widget to the given parent Elementary
24834     * (container) widget
24835     *
24836     * @param parent The parent object
24837     * @return a new flip selector widget handle or @c NULL, on errors
24838     *
24839     * This function inserts a new flip selector widget on the canvas.
24840     *
24841     * @ingroup Flipselector
24842     */
24843    EAPI Evas_Object               *elm_flipselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24844
24845    /**
24846     * Programmatically select the next item of a flip selector widget
24847     *
24848     * @param obj The flipselector object
24849     *
24850     * @note The selection will be animated. Also, if it reaches the
24851     * end of its list of member items, it will continue with the first
24852     * one onwards.
24853     *
24854     * @ingroup Flipselector
24855     */
24856    EAPI void                       elm_flipselector_flip_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
24857
24858    /**
24859     * Programmatically select the previous item of a flip selector
24860     * widget
24861     *
24862     * @param obj The flipselector object
24863     *
24864     * @note The selection will be animated.  Also, if it reaches the
24865     * beginning of its list of member items, it will continue with the
24866     * last one backwards.
24867     *
24868     * @ingroup Flipselector
24869     */
24870    EAPI void                       elm_flipselector_flip_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
24871
24872    /**
24873     * Append a (text) item to a flip selector widget
24874     *
24875     * @param obj The flipselector object
24876     * @param label The (text) label of the new item
24877     * @param func Convenience callback function to take place when
24878     * item is selected
24879     * @param data Data passed to @p func, above
24880     * @return A handle to the item added or @c NULL, on errors
24881     *
24882     * The widget's list of labels to show will be appended with the
24883     * given value. If the user wishes so, a callback function pointer
24884     * can be passed, which will get called when this same item is
24885     * selected.
24886     *
24887     * @note The current selection @b won't be modified by appending an
24888     * element to the list.
24889     *
24890     * @note The maximum length of the text label is going to be
24891     * determined <b>by the widget's theme</b>. Strings larger than
24892     * that value are going to be @b truncated.
24893     *
24894     * @ingroup Flipselector
24895     */
24896    EAPI Elm_Flipselector_Item     *elm_flipselector_item_append(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
24897
24898    /**
24899     * Prepend a (text) item to a flip selector widget
24900     *
24901     * @param obj The flipselector object
24902     * @param label The (text) label of the new item
24903     * @param func Convenience callback function to take place when
24904     * item is selected
24905     * @param data Data passed to @p func, above
24906     * @return A handle to the item added or @c NULL, on errors
24907     *
24908     * The widget's list of labels to show will be prepended with the
24909     * given value. If the user wishes so, a callback function pointer
24910     * can be passed, which will get called when this same item is
24911     * selected.
24912     *
24913     * @note The current selection @b won't be modified by prepending
24914     * an element to the list.
24915     *
24916     * @note The maximum length of the text label is going to be
24917     * determined <b>by the widget's theme</b>. Strings larger than
24918     * that value are going to be @b truncated.
24919     *
24920     * @ingroup Flipselector
24921     */
24922    EAPI Elm_Flipselector_Item     *elm_flipselector_item_prepend(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
24923
24924    /**
24925     * Get the internal list of items in a given flip selector widget.
24926     *
24927     * @param obj The flipselector object
24928     * @return The list of items (#Elm_Flipselector_Item as data) or
24929     * @c NULL on errors.
24930     *
24931     * This list is @b not to be modified in any way and must not be
24932     * freed. Use the list members with functions like
24933     * elm_flipselector_item_label_set(),
24934     * elm_flipselector_item_label_get(),
24935     * elm_flipselector_item_del(),
24936     * elm_flipselector_item_selected_get(),
24937     * elm_flipselector_item_selected_set().
24938     *
24939     * @warning This list is only valid until @p obj object's internal
24940     * items list is changed. It should be fetched again with another
24941     * call to this function when changes happen.
24942     *
24943     * @ingroup Flipselector
24944     */
24945    EAPI const Eina_List           *elm_flipselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24946
24947    /**
24948     * Get the first item in the given flip selector widget's list of
24949     * items.
24950     *
24951     * @param obj The flipselector object
24952     * @return The first item or @c NULL, if it has no items (and on
24953     * errors)
24954     *
24955     * @see elm_flipselector_item_append()
24956     * @see elm_flipselector_last_item_get()
24957     *
24958     * @ingroup Flipselector
24959     */
24960    EAPI Elm_Flipselector_Item     *elm_flipselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24961
24962    /**
24963     * Get the last item in the given flip selector widget's list of
24964     * items.
24965     *
24966     * @param obj The flipselector object
24967     * @return The last item or @c NULL, if it has no items (and on
24968     * errors)
24969     *
24970     * @see elm_flipselector_item_prepend()
24971     * @see elm_flipselector_first_item_get()
24972     *
24973     * @ingroup Flipselector
24974     */
24975    EAPI Elm_Flipselector_Item     *elm_flipselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24976
24977    /**
24978     * Get the currently selected item in a flip selector widget.
24979     *
24980     * @param obj The flipselector object
24981     * @return The selected item or @c NULL, if the widget has no items
24982     * (and on erros)
24983     *
24984     * @ingroup Flipselector
24985     */
24986    EAPI Elm_Flipselector_Item     *elm_flipselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24987
24988    /**
24989     * Set whether a given flip selector widget's item should be the
24990     * currently selected one.
24991     *
24992     * @param item The flip selector item
24993     * @param selected @c EINA_TRUE to select it, @c EINA_FALSE to unselect.
24994     *
24995     * This sets whether @p item is or not the selected (thus, under
24996     * display) one. If @p item is different than one under display,
24997     * the latter will be unselected. If the @p item is set to be
24998     * unselected, on the other hand, the @b first item in the widget's
24999     * internal members list will be the new selected one.
25000     *
25001     * @see elm_flipselector_item_selected_get()
25002     *
25003     * @ingroup Flipselector
25004     */
25005    EAPI void                       elm_flipselector_item_selected_set(Elm_Flipselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
25006
25007    /**
25008     * Get whether a given flip selector widget's item is the currently
25009     * selected one.
25010     *
25011     * @param item The flip selector item
25012     * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
25013     * (or on errors).
25014     *
25015     * @see elm_flipselector_item_selected_set()
25016     *
25017     * @ingroup Flipselector
25018     */
25019    EAPI Eina_Bool                  elm_flipselector_item_selected_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
25020
25021    /**
25022     * Delete a given item from a flip selector widget.
25023     *
25024     * @param item The item to delete
25025     *
25026     * @ingroup Flipselector
25027     */
25028    EAPI void                       elm_flipselector_item_del(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
25029
25030    /**
25031     * Get the label of a given flip selector widget's item.
25032     *
25033     * @param item The item to get label from
25034     * @return The text label of @p item or @c NULL, on errors
25035     *
25036     * @see elm_flipselector_item_label_set()
25037     *
25038     * @ingroup Flipselector
25039     */
25040    EAPI const char                *elm_flipselector_item_label_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
25041
25042    /**
25043     * Set the label of a given flip selector widget's item.
25044     *
25045     * @param item The item to set label on
25046     * @param label The text label string, in UTF-8 encoding
25047     *
25048     * @see elm_flipselector_item_label_get()
25049     *
25050     * @ingroup Flipselector
25051     */
25052    EAPI void                       elm_flipselector_item_label_set(Elm_Flipselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
25053
25054    /**
25055     * Gets the item before @p item in a flip selector widget's
25056     * internal list of items.
25057     *
25058     * @param item The item to fetch previous from
25059     * @return The item before the @p item, in its parent's list. If
25060     *         there is no previous item for @p item or there's an
25061     *         error, @c NULL is returned.
25062     *
25063     * @see elm_flipselector_item_next_get()
25064     *
25065     * @ingroup Flipselector
25066     */
25067    EAPI Elm_Flipselector_Item     *elm_flipselector_item_prev_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
25068
25069    /**
25070     * Gets the item after @p item in a flip selector widget's
25071     * internal list of items.
25072     *
25073     * @param item The item to fetch next from
25074     * @return The item after the @p item, in its parent's list. If
25075     *         there is no next item for @p item or there's an
25076     *         error, @c NULL is returned.
25077     *
25078     * @see elm_flipselector_item_next_get()
25079     *
25080     * @ingroup Flipselector
25081     */
25082    EAPI Elm_Flipselector_Item     *elm_flipselector_item_next_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
25083
25084    /**
25085     * Set the interval on time updates for an user mouse button hold
25086     * on a flip selector widget.
25087     *
25088     * @param obj The flip selector object
25089     * @param interval The (first) interval value in seconds
25090     *
25091     * This interval value is @b decreased while the user holds the
25092     * mouse pointer either flipping up or flipping doww a given flip
25093     * selector.
25094     *
25095     * This helps the user to get to a given item distant from the
25096     * current one easier/faster, as it will start to flip quicker and
25097     * quicker on mouse button holds.
25098     *
25099     * The calculation for the next flip interval value, starting from
25100     * the one set with this call, is the previous interval divided by
25101     * 1.05, so it decreases a little bit.
25102     *
25103     * The default starting interval value for automatic flips is
25104     * @b 0.85 seconds.
25105     *
25106     * @see elm_flipselector_interval_get()
25107     *
25108     * @ingroup Flipselector
25109     */
25110    EAPI void                       elm_flipselector_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
25111
25112    /**
25113     * Get the interval on time updates for an user mouse button hold
25114     * on a flip selector widget.
25115     *
25116     * @param obj The flip selector object
25117     * @return The (first) interval value, in seconds, set on it
25118     *
25119     * @see elm_flipselector_interval_set() for more details
25120     *
25121     * @ingroup Flipselector
25122     */
25123    EAPI double                     elm_flipselector_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25124    /**
25125     * @}
25126     */
25127
25128    /**
25129     * @addtogroup Calendar
25130     * @{
25131     */
25132
25133    /**
25134     * @enum _Elm_Calendar_Mark_Repeat
25135     * @typedef Elm_Calendar_Mark_Repeat
25136     *
25137     * Event periodicity, used to define if a mark should be repeated
25138     * @b beyond event's day. It's set when a mark is added.
25139     *
25140     * So, for a mark added to 13th May with periodicity set to WEEKLY,
25141     * there will be marks every week after this date. Marks will be displayed
25142     * at 13th, 20th, 27th, 3rd June ...
25143     *
25144     * Values don't work as bitmask, only one can be choosen.
25145     *
25146     * @see elm_calendar_mark_add()
25147     *
25148     * @ingroup Calendar
25149     */
25150    typedef enum _Elm_Calendar_Mark_Repeat
25151      {
25152         ELM_CALENDAR_UNIQUE, /**< Default value. Marks will be displayed only on event day. */
25153         ELM_CALENDAR_DAILY, /**< Marks will be displayed everyday after event day (inclusive). */
25154         ELM_CALENDAR_WEEKLY, /**< Marks will be displayed every week after event day (inclusive) - i.e. each seven days. */
25155         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*/
25156         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. */
25157      } Elm_Calendar_Mark_Repeat;
25158
25159    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(). */
25160
25161    /**
25162     * Add a new calendar widget to the given parent Elementary
25163     * (container) object.
25164     *
25165     * @param parent The parent object.
25166     * @return a new calendar widget handle or @c NULL, on errors.
25167     *
25168     * This function inserts a new calendar widget on the canvas.
25169     *
25170     * @ref calendar_example_01
25171     *
25172     * @ingroup Calendar
25173     */
25174    EAPI Evas_Object       *elm_calendar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25175
25176    /**
25177     * Get weekdays names displayed by the calendar.
25178     *
25179     * @param obj The calendar object.
25180     * @return Array of seven strings to be used as weekday names.
25181     *
25182     * By default, weekdays abbreviations get from system are displayed:
25183     * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
25184     * The first string is related to Sunday, the second to Monday...
25185     *
25186     * @see elm_calendar_weekdays_name_set()
25187     *
25188     * @ref calendar_example_05
25189     *
25190     * @ingroup Calendar
25191     */
25192    EAPI const char       **elm_calendar_weekdays_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25193
25194    /**
25195     * Set weekdays names to be displayed by the calendar.
25196     *
25197     * @param obj The calendar object.
25198     * @param weekdays Array of seven strings to be used as weekday names.
25199     * @warning It must have 7 elements, or it will access invalid memory.
25200     * @warning The strings must be NULL terminated ('@\0').
25201     *
25202     * By default, weekdays abbreviations get from system are displayed:
25203     * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
25204     *
25205     * The first string should be related to Sunday, the second to Monday...
25206     *
25207     * The usage should be like this:
25208     * @code
25209     *   const char *weekdays[] =
25210     *   {
25211     *      "Sunday", "Monday", "Tuesday", "Wednesday",
25212     *      "Thursday", "Friday", "Saturday"
25213     *   };
25214     *   elm_calendar_weekdays_names_set(calendar, weekdays);
25215     * @endcode
25216     *
25217     * @see elm_calendar_weekdays_name_get()
25218     *
25219     * @ref calendar_example_02
25220     *
25221     * @ingroup Calendar
25222     */
25223    EAPI void               elm_calendar_weekdays_names_set(Evas_Object *obj, const char *weekdays[]) EINA_ARG_NONNULL(1, 2);
25224
25225    /**
25226     * Set the minimum and maximum values for the year
25227     *
25228     * @param obj The calendar object
25229     * @param min The minimum year, greater than 1901;
25230     * @param max The maximum year;
25231     *
25232     * Maximum must be greater than minimum, except if you don't wan't to set
25233     * maximum year.
25234     * Default values are 1902 and -1.
25235     *
25236     * If the maximum year is a negative value, it will be limited depending
25237     * on the platform architecture (year 2037 for 32 bits);
25238     *
25239     * @see elm_calendar_min_max_year_get()
25240     *
25241     * @ref calendar_example_03
25242     *
25243     * @ingroup Calendar
25244     */
25245    EAPI void               elm_calendar_min_max_year_set(Evas_Object *obj, int min, int max) EINA_ARG_NONNULL(1);
25246
25247    /**
25248     * Get the minimum and maximum values for the year
25249     *
25250     * @param obj The calendar object.
25251     * @param min The minimum year.
25252     * @param max The maximum year.
25253     *
25254     * Default values are 1902 and -1.
25255     *
25256     * @see elm_calendar_min_max_year_get() for more details.
25257     *
25258     * @ref calendar_example_05
25259     *
25260     * @ingroup Calendar
25261     */
25262    EAPI void               elm_calendar_min_max_year_get(const Evas_Object *obj, int *min, int *max) EINA_ARG_NONNULL(1);
25263
25264    /**
25265     * Enable or disable day selection
25266     *
25267     * @param obj The calendar object.
25268     * @param enabled @c EINA_TRUE to enable selection or @c EINA_FALSE to
25269     * disable it.
25270     *
25271     * Enabled by default. If disabled, the user still can select months,
25272     * but not days. Selected days are highlighted on calendar.
25273     * It should be used if you won't need such selection for the widget usage.
25274     *
25275     * When a day is selected, or month is changed, smart callbacks for
25276     * signal "changed" will be called.
25277     *
25278     * @see elm_calendar_day_selection_enable_get()
25279     *
25280     * @ref calendar_example_04
25281     *
25282     * @ingroup Calendar
25283     */
25284    EAPI void               elm_calendar_day_selection_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
25285
25286    /**
25287     * Get a value whether day selection is enabled or not.
25288     *
25289     * @see elm_calendar_day_selection_enable_set() for details.
25290     *
25291     * @param obj The calendar object.
25292     * @return EINA_TRUE means day selection is enabled. EINA_FALSE indicates
25293     * it's disabled. If @p obj is NULL, EINA_FALSE is returned.
25294     *
25295     * @ref calendar_example_05
25296     *
25297     * @ingroup Calendar
25298     */
25299    EAPI Eina_Bool          elm_calendar_day_selection_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25300
25301
25302    /**
25303     * Set selected date to be highlighted on calendar.
25304     *
25305     * @param obj The calendar object.
25306     * @param selected_time A @b tm struct to represent the selected date.
25307     *
25308     * Set the selected date, changing the displayed month if needed.
25309     * Selected date changes when the user goes to next/previous month or
25310     * select a day pressing over it on calendar.
25311     *
25312     * @see elm_calendar_selected_time_get()
25313     *
25314     * @ref calendar_example_04
25315     *
25316     * @ingroup Calendar
25317     */
25318    EAPI void               elm_calendar_selected_time_set(Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1);
25319
25320    /**
25321     * Get selected date.
25322     *
25323     * @param obj The calendar object
25324     * @param selected_time A @b tm struct to point to selected date
25325     * @return EINA_FALSE means an error ocurred and returned time shouldn't
25326     * be considered.
25327     *
25328     * Get date selected by the user or set by function
25329     * elm_calendar_selected_time_set().
25330     * Selected date changes when the user goes to next/previous month or
25331     * select a day pressing over it on calendar.
25332     *
25333     * @see elm_calendar_selected_time_get()
25334     *
25335     * @ref calendar_example_05
25336     *
25337     * @ingroup Calendar
25338     */
25339    EAPI Eina_Bool          elm_calendar_selected_time_get(const Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1, 2);
25340
25341    /**
25342     * Set a function to format the string that will be used to display
25343     * month and year;
25344     *
25345     * @param obj The calendar object
25346     * @param format_function Function to set the month-year string given
25347     * the selected date
25348     *
25349     * By default it uses strftime with "%B %Y" format string.
25350     * It should allocate the memory that will be used by the string,
25351     * that will be freed by the widget after usage.
25352     * A pointer to the string and a pointer to the time struct will be provided.
25353     *
25354     * Example:
25355     * @code
25356     * static char *
25357     * _format_month_year(struct tm *selected_time)
25358     * {
25359     *    char buf[32];
25360     *    if (!strftime(buf, sizeof(buf), "%B %Y", selected_time)) return NULL;
25361     *    return strdup(buf);
25362     * }
25363     *
25364     * elm_calendar_format_function_set(calendar, _format_month_year);
25365     * @endcode
25366     *
25367     * @ref calendar_example_02
25368     *
25369     * @ingroup Calendar
25370     */
25371    EAPI void               elm_calendar_format_function_set(Evas_Object *obj, char * (*format_function) (struct tm *stime)) EINA_ARG_NONNULL(1);
25372
25373    /**
25374     * Add a new mark to the calendar
25375     *
25376     * @param obj The calendar object
25377     * @param mark_type A string used to define the type of mark. It will be
25378     * emitted to the theme, that should display a related modification on these
25379     * days representation.
25380     * @param mark_time A time struct to represent the date of inclusion of the
25381     * mark. For marks that repeats it will just be displayed after the inclusion
25382     * date in the calendar.
25383     * @param repeat Repeat the event following this periodicity. Can be a unique
25384     * mark (that don't repeat), daily, weekly, monthly or annually.
25385     * @return The created mark or @p NULL upon failure.
25386     *
25387     * Add a mark that will be drawn in the calendar respecting the insertion
25388     * time and periodicity. It will emit the type as signal to the widget theme.
25389     * Default theme supports "holiday" and "checked", but it can be extended.
25390     *
25391     * It won't immediately update the calendar, drawing the marks.
25392     * For this, call elm_calendar_marks_draw(). However, when user selects
25393     * next or previous month calendar forces marks drawn.
25394     *
25395     * Marks created with this method can be deleted with
25396     * elm_calendar_mark_del().
25397     *
25398     * Example
25399     * @code
25400     * struct tm selected_time;
25401     * time_t current_time;
25402     *
25403     * current_time = time(NULL) + 5 * 84600;
25404     * localtime_r(&current_time, &selected_time);
25405     * elm_calendar_mark_add(cal, "holiday", selected_time,
25406     *     ELM_CALENDAR_ANNUALLY);
25407     *
25408     * current_time = time(NULL) + 1 * 84600;
25409     * localtime_r(&current_time, &selected_time);
25410     * elm_calendar_mark_add(cal, "checked", selected_time, ELM_CALENDAR_UNIQUE);
25411     *
25412     * elm_calendar_marks_draw(cal);
25413     * @endcode
25414     *
25415     * @see elm_calendar_marks_draw()
25416     * @see elm_calendar_mark_del()
25417     *
25418     * @ref calendar_example_06
25419     *
25420     * @ingroup Calendar
25421     */
25422    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);
25423
25424    /**
25425     * Delete mark from the calendar.
25426     *
25427     * @param mark The mark to be deleted.
25428     *
25429     * If deleting all calendar marks is required, elm_calendar_marks_clear()
25430     * should be used instead of getting marks list and deleting each one.
25431     *
25432     * @see elm_calendar_mark_add()
25433     *
25434     * @ref calendar_example_06
25435     *
25436     * @ingroup Calendar
25437     */
25438    EAPI void               elm_calendar_mark_del(Elm_Calendar_Mark *mark) EINA_ARG_NONNULL(1);
25439
25440    /**
25441     * Remove all calendar's marks
25442     *
25443     * @param obj The calendar object.
25444     *
25445     * @see elm_calendar_mark_add()
25446     * @see elm_calendar_mark_del()
25447     *
25448     * @ingroup Calendar
25449     */
25450    EAPI void               elm_calendar_marks_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
25451
25452
25453    /**
25454     * Get a list of all the calendar marks.
25455     *
25456     * @param obj The calendar object.
25457     * @return An @c Eina_List of calendar marks objects, or @c NULL on failure.
25458     *
25459     * @see elm_calendar_mark_add()
25460     * @see elm_calendar_mark_del()
25461     * @see elm_calendar_marks_clear()
25462     *
25463     * @ingroup Calendar
25464     */
25465    EAPI const Eina_List   *elm_calendar_marks_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25466
25467    /**
25468     * Draw calendar marks.
25469     *
25470     * @param obj The calendar object.
25471     *
25472     * Should be used after adding, removing or clearing marks.
25473     * It will go through the entire marks list updating the calendar.
25474     * If lots of marks will be added, add all the marks and then call
25475     * this function.
25476     *
25477     * When the month is changed, i.e. user selects next or previous month,
25478     * marks will be drawed.
25479     *
25480     * @see elm_calendar_mark_add()
25481     * @see elm_calendar_mark_del()
25482     * @see elm_calendar_marks_clear()
25483     *
25484     * @ref calendar_example_06
25485     *
25486     * @ingroup Calendar
25487     */
25488    EAPI void               elm_calendar_marks_draw(Evas_Object *obj) EINA_ARG_NONNULL(1);
25489
25490    /**
25491     * Set a day text color to the same that represents Saturdays.
25492     *
25493     * @param obj The calendar object.
25494     * @param pos The text position. Position is the cell counter, from left
25495     * to right, up to down. It starts on 0 and ends on 41.
25496     *
25497     * @deprecated use elm_calendar_mark_add() instead like:
25498     *
25499     * @code
25500     * struct tm t = { 0, 0, 12, 6, 0, 0, 6, 6, -1 };
25501     * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
25502     * @endcode
25503     *
25504     * @see elm_calendar_mark_add()
25505     *
25506     * @ingroup Calendar
25507     */
25508    EINA_DEPRECATED EAPI void               elm_calendar_text_saturday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25509
25510    /**
25511     * Set a day text color to the same that represents Sundays.
25512     *
25513     * @param obj The calendar object.
25514     * @param pos The text position. Position is the cell counter, from left
25515     * to right, up to down. It starts on 0 and ends on 41.
25516
25517     * @deprecated use elm_calendar_mark_add() instead like:
25518     *
25519     * @code
25520     * struct tm t = { 0, 0, 12, 7, 0, 0, 0, 0, -1 };
25521     * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
25522     * @endcode
25523     *
25524     * @see elm_calendar_mark_add()
25525     *
25526     * @ingroup Calendar
25527     */
25528    EINA_DEPRECATED EAPI void               elm_calendar_text_sunday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25529
25530    /**
25531     * Set a day text color to the same that represents Weekdays.
25532     *
25533     * @param obj The calendar object
25534     * @param pos The text position. Position is the cell counter, from left
25535     * to right, up to down. It starts on 0 and ends on 41.
25536     *
25537     * @deprecated use elm_calendar_mark_add() instead like:
25538     *
25539     * @code
25540     * struct tm t = { 0, 0, 12, 1, 0, 0, 0, 0, -1 };
25541     *
25542     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // monday
25543     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25544     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // tuesday
25545     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25546     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // wednesday
25547     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25548     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // thursday
25549     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25550     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // friday
25551     * @endcode
25552     *
25553     * @see elm_calendar_mark_add()
25554     *
25555     * @ingroup Calendar
25556     */
25557    EINA_DEPRECATED EAPI void               elm_calendar_text_weekday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25558
25559    /**
25560     * Set the interval on time updates for an user mouse button hold
25561     * on calendar widgets' month selection.
25562     *
25563     * @param obj The calendar object
25564     * @param interval The (first) interval value in seconds
25565     *
25566     * This interval value is @b decreased while the user holds the
25567     * mouse pointer either selecting next or previous month.
25568     *
25569     * This helps the user to get to a given month distant from the
25570     * current one easier/faster, as it will start to change quicker and
25571     * quicker on mouse button holds.
25572     *
25573     * The calculation for the next change interval value, starting from
25574     * the one set with this call, is the previous interval divided by
25575     * 1.05, so it decreases a little bit.
25576     *
25577     * The default starting interval value for automatic changes is
25578     * @b 0.85 seconds.
25579     *
25580     * @see elm_calendar_interval_get()
25581     *
25582     * @ingroup Calendar
25583     */
25584    EAPI void               elm_calendar_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
25585
25586    /**
25587     * Get the interval on time updates for an user mouse button hold
25588     * on calendar widgets' month selection.
25589     *
25590     * @param obj The calendar object
25591     * @return The (first) interval value, in seconds, set on it
25592     *
25593     * @see elm_calendar_interval_set() for more details
25594     *
25595     * @ingroup Calendar
25596     */
25597    EAPI double             elm_calendar_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25598
25599    /**
25600     * @}
25601     */
25602
25603    /**
25604     * @defgroup Diskselector Diskselector
25605     * @ingroup Elementary
25606     *
25607     * @image html img/widget/diskselector/preview-00.png
25608     * @image latex img/widget/diskselector/preview-00.eps
25609     *
25610     * A diskselector is a kind of list widget. It scrolls horizontally,
25611     * and can contain label and icon objects. Three items are displayed
25612     * with the selected one in the middle.
25613     *
25614     * It can act like a circular list with round mode and labels can be
25615     * reduced for a defined length for side items.
25616     *
25617     * Smart callbacks one can listen to:
25618     * - "selected" - when item is selected, i.e. scroller stops.
25619     *
25620     * Available styles for it:
25621     * - @c "default"
25622     *
25623     * List of examples:
25624     * @li @ref diskselector_example_01
25625     * @li @ref diskselector_example_02
25626     */
25627
25628    /**
25629     * @addtogroup Diskselector
25630     * @{
25631     */
25632
25633    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(). */
25634
25635    /**
25636     * Add a new diskselector widget to the given parent Elementary
25637     * (container) object.
25638     *
25639     * @param parent The parent object.
25640     * @return a new diskselector widget handle or @c NULL, on errors.
25641     *
25642     * This function inserts a new diskselector widget on the canvas.
25643     *
25644     * @ingroup Diskselector
25645     */
25646    EAPI Evas_Object           *elm_diskselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25647
25648    /**
25649     * Enable or disable round mode.
25650     *
25651     * @param obj The diskselector object.
25652     * @param round @c EINA_TRUE to enable round mode or @c EINA_FALSE to
25653     * disable it.
25654     *
25655     * Disabled by default. If round mode is enabled the items list will
25656     * work like a circle list, so when the user reaches the last item,
25657     * the first one will popup.
25658     *
25659     * @see elm_diskselector_round_get()
25660     *
25661     * @ingroup Diskselector
25662     */
25663    EAPI void                   elm_diskselector_round_set(Evas_Object *obj, Eina_Bool round) EINA_ARG_NONNULL(1);
25664
25665    /**
25666     * Get a value whether round mode is enabled or not.
25667     *
25668     * @see elm_diskselector_round_set() for details.
25669     *
25670     * @param obj The diskselector object.
25671     * @return @c EINA_TRUE means round mode is enabled. @c EINA_FALSE indicates
25672     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
25673     *
25674     * @ingroup Diskselector
25675     */
25676    EAPI Eina_Bool              elm_diskselector_round_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25677
25678    /**
25679     * Get the side labels max length.
25680     *
25681     * @deprecated use elm_diskselector_side_label_length_get() instead:
25682     *
25683     * @param obj The diskselector object.
25684     * @return The max length defined for side labels, or 0 if not a valid
25685     * diskselector.
25686     *
25687     * @ingroup Diskselector
25688     */
25689    EINA_DEPRECATED EAPI int    elm_diskselector_side_label_lenght_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25690
25691    /**
25692     * Set the side labels max length.
25693     *
25694     * @deprecated use elm_diskselector_side_label_length_set() instead:
25695     *
25696     * @param obj The diskselector object.
25697     * @param len The max length defined for side labels.
25698     *
25699     * @ingroup Diskselector
25700     */
25701    EINA_DEPRECATED EAPI void   elm_diskselector_side_label_lenght_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
25702
25703    /**
25704     * Get the side labels max length.
25705     *
25706     * @see elm_diskselector_side_label_length_set() for details.
25707     *
25708     * @param obj The diskselector object.
25709     * @return The max length defined for side labels, or 0 if not a valid
25710     * diskselector.
25711     *
25712     * @ingroup Diskselector
25713     */
25714    EAPI int                    elm_diskselector_side_label_length_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25715
25716    /**
25717     * Set the side labels max length.
25718     *
25719     * @param obj The diskselector object.
25720     * @param len The max length defined for side labels.
25721     *
25722     * Length is the number of characters of items' label that will be
25723     * visible when it's set on side positions. It will just crop
25724     * the string after defined size. E.g.:
25725     *
25726     * An item with label "January" would be displayed on side position as
25727     * "Jan" if max length is set to 3, or "Janu", if this property
25728     * is set to 4.
25729     *
25730     * When it's selected, the entire label will be displayed, except for
25731     * width restrictions. In this case label will be cropped and "..."
25732     * will be concatenated.
25733     *
25734     * Default side label max length is 3.
25735     *
25736     * This property will be applyed over all items, included before or
25737     * later this function call.
25738     *
25739     * @ingroup Diskselector
25740     */
25741    EAPI void                   elm_diskselector_side_label_length_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
25742
25743    /**
25744     * Set the number of items to be displayed.
25745     *
25746     * @param obj The diskselector object.
25747     * @param num The number of items the diskselector will display.
25748     *
25749     * Default value is 3, and also it's the minimun. If @p num is less
25750     * than 3, it will be set to 3.
25751     *
25752     * Also, it can be set on theme, using data item @c display_item_num
25753     * on group "elm/diskselector/item/X", where X is style set.
25754     * E.g.:
25755     *
25756     * group { name: "elm/diskselector/item/X";
25757     * data {
25758     *     item: "display_item_num" "5";
25759     *     }
25760     *
25761     * @ingroup Diskselector
25762     */
25763    EAPI void                   elm_diskselector_display_item_num_set(Evas_Object *obj, int num) EINA_ARG_NONNULL(1);
25764
25765    /**
25766     * Get the number of items in the diskselector object.
25767     *
25768     * @param obj The diskselector object.
25769     *
25770     * @ingroup Diskselector
25771     */
25772    EAPI int                   elm_diskselector_display_item_num_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25773
25774    /**
25775     * Set bouncing behaviour when the scrolled content reaches an edge.
25776     *
25777     * Tell the internal scroller object whether it should bounce or not
25778     * when it reaches the respective edges for each axis.
25779     *
25780     * @param obj The diskselector object.
25781     * @param h_bounce Whether to bounce or not in the horizontal axis.
25782     * @param v_bounce Whether to bounce or not in the vertical axis.
25783     *
25784     * @see elm_scroller_bounce_set()
25785     *
25786     * @ingroup Diskselector
25787     */
25788    EAPI void                   elm_diskselector_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
25789
25790    /**
25791     * Get the bouncing behaviour of the internal scroller.
25792     *
25793     * Get whether the internal scroller should bounce when the edge of each
25794     * axis is reached scrolling.
25795     *
25796     * @param obj The diskselector object.
25797     * @param h_bounce Pointer where to store the bounce state of the horizontal
25798     * axis.
25799     * @param v_bounce Pointer where to store the bounce state of the vertical
25800     * axis.
25801     *
25802     * @see elm_scroller_bounce_get()
25803     * @see elm_diskselector_bounce_set()
25804     *
25805     * @ingroup Diskselector
25806     */
25807    EAPI void                   elm_diskselector_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
25808
25809    /**
25810     * Get the scrollbar policy.
25811     *
25812     * @see elm_diskselector_scroller_policy_get() for details.
25813     *
25814     * @param obj The diskselector object.
25815     * @param policy_h Pointer where to store horizontal scrollbar policy.
25816     * @param policy_v Pointer where to store vertical scrollbar policy.
25817     *
25818     * @ingroup Diskselector
25819     */
25820    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);
25821
25822    /**
25823     * Set the scrollbar policy.
25824     *
25825     * @param obj The diskselector object.
25826     * @param policy_h Horizontal scrollbar policy.
25827     * @param policy_v Vertical scrollbar policy.
25828     *
25829     * This sets the scrollbar visibility policy for the given scroller.
25830     * #ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it
25831     * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
25832     * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
25833     * This applies respectively for the horizontal and vertical scrollbars.
25834     *
25835     * The both are disabled by default, i.e., are set to
25836     * #ELM_SCROLLER_POLICY_OFF.
25837     *
25838     * @ingroup Diskselector
25839     */
25840    EAPI void                   elm_diskselector_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
25841
25842    /**
25843     * Remove all diskselector's items.
25844     *
25845     * @param obj The diskselector object.
25846     *
25847     * @see elm_diskselector_item_del()
25848     * @see elm_diskselector_item_append()
25849     *
25850     * @ingroup Diskselector
25851     */
25852    EAPI void                   elm_diskselector_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
25853
25854    /**
25855     * Get a list of all the diskselector items.
25856     *
25857     * @param obj The diskselector object.
25858     * @return An @c Eina_List of diskselector items, #Elm_Diskselector_Item,
25859     * or @c NULL on failure.
25860     *
25861     * @see elm_diskselector_item_append()
25862     * @see elm_diskselector_item_del()
25863     * @see elm_diskselector_clear()
25864     *
25865     * @ingroup Diskselector
25866     */
25867    EAPI const Eina_List       *elm_diskselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25868
25869    /**
25870     * Appends a new item to the diskselector object.
25871     *
25872     * @param obj The diskselector object.
25873     * @param label The label of the diskselector item.
25874     * @param icon The icon object to use at left side of the item. An
25875     * icon can be any Evas object, but usually it is an icon created
25876     * with elm_icon_add().
25877     * @param func The function to call when the item is selected.
25878     * @param data The data to associate with the item for related callbacks.
25879     *
25880     * @return The created item or @c NULL upon failure.
25881     *
25882     * A new item will be created and appended to the diskselector, i.e., will
25883     * be set as last item. Also, if there is no selected item, it will
25884     * be selected. This will always happens for the first appended item.
25885     *
25886     * If no icon is set, label will be centered on item position, otherwise
25887     * the icon will be placed at left of the label, that will be shifted
25888     * to the right.
25889     *
25890     * Items created with this method can be deleted with
25891     * elm_diskselector_item_del().
25892     *
25893     * Associated @p data can be properly freed when item is deleted if a
25894     * callback function is set with elm_diskselector_item_del_cb_set().
25895     *
25896     * If a function is passed as argument, it will be called everytime this item
25897     * is selected, i.e., the user stops the diskselector with this
25898     * item on center position. If such function isn't needed, just passing
25899     * @c NULL as @p func is enough. The same should be done for @p data.
25900     *
25901     * Simple example (with no function callback or data associated):
25902     * @code
25903     * disk = elm_diskselector_add(win);
25904     * ic = elm_icon_add(win);
25905     * elm_icon_file_set(ic, "path/to/image", NULL);
25906     * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
25907     * elm_diskselector_item_append(disk, "label", ic, NULL, NULL);
25908     * @endcode
25909     *
25910     * @see elm_diskselector_item_del()
25911     * @see elm_diskselector_item_del_cb_set()
25912     * @see elm_diskselector_clear()
25913     * @see elm_icon_add()
25914     *
25915     * @ingroup Diskselector
25916     */
25917    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);
25918
25919
25920    /**
25921     * Delete them item from the diskselector.
25922     *
25923     * @param it The item of diskselector to be deleted.
25924     *
25925     * If deleting all diskselector items is required, elm_diskselector_clear()
25926     * should be used instead of getting items list and deleting each one.
25927     *
25928     * @see elm_diskselector_clear()
25929     * @see elm_diskselector_item_append()
25930     * @see elm_diskselector_item_del_cb_set()
25931     *
25932     * @ingroup Diskselector
25933     */
25934    EAPI void                   elm_diskselector_item_del(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25935
25936    /**
25937     * Set the function called when a diskselector item is freed.
25938     *
25939     * @param it The item to set the callback on
25940     * @param func The function called
25941     *
25942     * If there is a @p func, then it will be called prior item's memory release.
25943     * That will be called with the following arguments:
25944     * @li item's data;
25945     * @li item's Evas object;
25946     * @li item itself;
25947     *
25948     * This way, a data associated to a diskselector item could be properly
25949     * freed.
25950     *
25951     * @ingroup Diskselector
25952     */
25953    EAPI void                   elm_diskselector_item_del_cb_set(Elm_Diskselector_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
25954
25955    /**
25956     * Get the data associated to the item.
25957     *
25958     * @param it The diskselector item
25959     * @return The data associated to @p it
25960     *
25961     * The return value is a pointer to data associated to @p item when it was
25962     * created, with function elm_diskselector_item_append(). If no data
25963     * was passed as argument, it will return @c NULL.
25964     *
25965     * @see elm_diskselector_item_append()
25966     *
25967     * @ingroup Diskselector
25968     */
25969    EAPI void                  *elm_diskselector_item_data_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25970
25971    /**
25972     * Set the icon associated to the item.
25973     *
25974     * @param it The diskselector item
25975     * @param icon The icon object to associate with @p it
25976     *
25977     * The icon object to use at left side of the item. An
25978     * icon can be any Evas object, but usually it is an icon created
25979     * with elm_icon_add().
25980     *
25981     * Once the icon object is set, a previously set one will be deleted.
25982     * @warning Setting the same icon for two items will cause the icon to
25983     * dissapear from the first item.
25984     *
25985     * If an icon was passed as argument on item creation, with function
25986     * elm_diskselector_item_append(), it will be already
25987     * associated to the item.
25988     *
25989     * @see elm_diskselector_item_append()
25990     * @see elm_diskselector_item_icon_get()
25991     *
25992     * @ingroup Diskselector
25993     */
25994    EAPI void                   elm_diskselector_item_icon_set(Elm_Diskselector_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
25995
25996    /**
25997     * Get the icon associated to the item.
25998     *
25999     * @param it The diskselector item
26000     * @return The icon associated to @p it
26001     *
26002     * The return value is a pointer to the icon associated to @p item when it was
26003     * created, with function elm_diskselector_item_append(), or later
26004     * with function elm_diskselector_item_icon_set. If no icon
26005     * was passed as argument, it will return @c NULL.
26006     *
26007     * @see elm_diskselector_item_append()
26008     * @see elm_diskselector_item_icon_set()
26009     *
26010     * @ingroup Diskselector
26011     */
26012    EAPI Evas_Object           *elm_diskselector_item_icon_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26013
26014    /**
26015     * Set the label of item.
26016     *
26017     * @param it The item of diskselector.
26018     * @param label The label of item.
26019     *
26020     * The label to be displayed by the item.
26021     *
26022     * If no icon is set, label will be centered on item position, otherwise
26023     * the icon will be placed at left of the label, that will be shifted
26024     * to the right.
26025     *
26026     * An item with label "January" would be displayed on side position as
26027     * "Jan" if max length is set to 3 with function
26028     * elm_diskselector_side_label_lenght_set(), or "Janu", if this property
26029     * is set to 4.
26030     *
26031     * When this @p item is selected, the entire label will be displayed,
26032     * except for width restrictions.
26033     * In this case label will be cropped and "..." will be concatenated,
26034     * but only for display purposes. It will keep the entire string, so
26035     * if diskselector is resized the remaining characters will be displayed.
26036     *
26037     * If a label was passed as argument on item creation, with function
26038     * elm_diskselector_item_append(), it will be already
26039     * displayed by the item.
26040     *
26041     * @see elm_diskselector_side_label_lenght_set()
26042     * @see elm_diskselector_item_label_get()
26043     * @see elm_diskselector_item_append()
26044     *
26045     * @ingroup Diskselector
26046     */
26047    EAPI void                   elm_diskselector_item_label_set(Elm_Diskselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
26048
26049    /**
26050     * Get the label of item.
26051     *
26052     * @param it The item of diskselector.
26053     * @return The label of item.
26054     *
26055     * The return value is a pointer to the label associated to @p item when it was
26056     * created, with function elm_diskselector_item_append(), or later
26057     * with function elm_diskselector_item_label_set. If no label
26058     * was passed as argument, it will return @c NULL.
26059     *
26060     * @see elm_diskselector_item_label_set() for more details.
26061     * @see elm_diskselector_item_append()
26062     *
26063     * @ingroup Diskselector
26064     */
26065    EAPI const char            *elm_diskselector_item_label_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26066
26067    /**
26068     * Get the selected item.
26069     *
26070     * @param obj The diskselector object.
26071     * @return The selected diskselector item.
26072     *
26073     * The selected item can be unselected with function
26074     * elm_diskselector_item_selected_set(), and the first item of
26075     * diskselector will be selected.
26076     *
26077     * The selected item always will be centered on diskselector, with
26078     * full label displayed, i.e., max lenght set to side labels won't
26079     * apply on the selected item. More details on
26080     * elm_diskselector_side_label_length_set().
26081     *
26082     * @ingroup Diskselector
26083     */
26084    EAPI Elm_Diskselector_Item *elm_diskselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26085
26086    /**
26087     * Set the selected state of an item.
26088     *
26089     * @param it The diskselector item
26090     * @param selected The selected state
26091     *
26092     * This sets the selected state of the given item @p it.
26093     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
26094     *
26095     * If a new item is selected the previosly selected will be unselected.
26096     * Previoulsy selected item can be get with function
26097     * elm_diskselector_selected_item_get().
26098     *
26099     * If the item @p it is unselected, the first item of diskselector will
26100     * be selected.
26101     *
26102     * Selected items will be visible on center position of diskselector.
26103     * So if it was on another position before selected, or was invisible,
26104     * diskselector will animate items until the selected item reaches center
26105     * position.
26106     *
26107     * @see elm_diskselector_item_selected_get()
26108     * @see elm_diskselector_selected_item_get()
26109     *
26110     * @ingroup Diskselector
26111     */
26112    EAPI void                   elm_diskselector_item_selected_set(Elm_Diskselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
26113
26114    /*
26115     * Get whether the @p item is selected or not.
26116     *
26117     * @param it The diskselector item.
26118     * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
26119     * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
26120     *
26121     * @see elm_diskselector_selected_item_set() for details.
26122     * @see elm_diskselector_item_selected_get()
26123     *
26124     * @ingroup Diskselector
26125     */
26126    EAPI Eina_Bool              elm_diskselector_item_selected_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26127
26128    /**
26129     * Get the first item of the diskselector.
26130     *
26131     * @param obj The diskselector object.
26132     * @return The first item, or @c NULL if none.
26133     *
26134     * The list of items follows append order. So it will return the first
26135     * item appended to the widget that wasn't deleted.
26136     *
26137     * @see elm_diskselector_item_append()
26138     * @see elm_diskselector_items_get()
26139     *
26140     * @ingroup Diskselector
26141     */
26142    EAPI Elm_Diskselector_Item *elm_diskselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26143
26144    /**
26145     * Get the last item of the diskselector.
26146     *
26147     * @param obj The diskselector object.
26148     * @return The last item, or @c NULL if none.
26149     *
26150     * The list of items follows append order. So it will return last first
26151     * item appended to the widget that wasn't deleted.
26152     *
26153     * @see elm_diskselector_item_append()
26154     * @see elm_diskselector_items_get()
26155     *
26156     * @ingroup Diskselector
26157     */
26158    EAPI Elm_Diskselector_Item *elm_diskselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26159
26160    /**
26161     * Get the item before @p item in diskselector.
26162     *
26163     * @param it The diskselector item.
26164     * @return The item before @p item, or @c NULL if none or on failure.
26165     *
26166     * The list of items follows append order. So it will return item appended
26167     * just before @p item and that wasn't deleted.
26168     *
26169     * If it is the first item, @c NULL will be returned.
26170     * First item can be get by elm_diskselector_first_item_get().
26171     *
26172     * @see elm_diskselector_item_append()
26173     * @see elm_diskselector_items_get()
26174     *
26175     * @ingroup Diskselector
26176     */
26177    EAPI Elm_Diskselector_Item *elm_diskselector_item_prev_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26178
26179    /**
26180     * Get the item after @p item in diskselector.
26181     *
26182     * @param it The diskselector item.
26183     * @return The item after @p item, or @c NULL if none or on failure.
26184     *
26185     * The list of items follows append order. So it will return item appended
26186     * just after @p item and that wasn't deleted.
26187     *
26188     * If it is the last item, @c NULL will be returned.
26189     * Last item can be get by elm_diskselector_last_item_get().
26190     *
26191     * @see elm_diskselector_item_append()
26192     * @see elm_diskselector_items_get()
26193     *
26194     * @ingroup Diskselector
26195     */
26196    EAPI Elm_Diskselector_Item *elm_diskselector_item_next_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26197
26198    /**
26199     * Set the text to be shown in the diskselector item.
26200     *
26201     * @param item Target item
26202     * @param text The text to set in the content
26203     *
26204     * Setup the text as tooltip to object. The item can have only one tooltip,
26205     * so any previous tooltip data is removed.
26206     *
26207     * @see elm_object_tooltip_text_set() for more details.
26208     *
26209     * @ingroup Diskselector
26210     */
26211    EAPI void                   elm_diskselector_item_tooltip_text_set(Elm_Diskselector_Item *item, const char *text) EINA_ARG_NONNULL(1);
26212
26213    /**
26214     * Set the content to be shown in the tooltip item.
26215     *
26216     * Setup the tooltip to item. The item can have only one tooltip,
26217     * so any previous tooltip data is removed. @p func(with @p data) will
26218     * be called every time that need show the tooltip and it should
26219     * return a valid Evas_Object. This object is then managed fully by
26220     * tooltip system and is deleted when the tooltip is gone.
26221     *
26222     * @param item the diskselector item being attached a tooltip.
26223     * @param func the function used to create the tooltip contents.
26224     * @param data what to provide to @a func as callback data/context.
26225     * @param del_cb called when data is not needed anymore, either when
26226     *        another callback replaces @p func, the tooltip is unset with
26227     *        elm_diskselector_item_tooltip_unset() or the owner @a item
26228     *        dies. This callback receives as the first parameter the
26229     *        given @a data, and @c event_info is the item.
26230     *
26231     * @see elm_object_tooltip_content_cb_set() for more details.
26232     *
26233     * @ingroup Diskselector
26234     */
26235    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);
26236
26237    /**
26238     * Unset tooltip from item.
26239     *
26240     * @param item diskselector item to remove previously set tooltip.
26241     *
26242     * Remove tooltip from item. The callback provided as del_cb to
26243     * elm_diskselector_item_tooltip_content_cb_set() will be called to notify
26244     * it is not used anymore.
26245     *
26246     * @see elm_object_tooltip_unset() for more details.
26247     * @see elm_diskselector_item_tooltip_content_cb_set()
26248     *
26249     * @ingroup Diskselector
26250     */
26251    EAPI void                   elm_diskselector_item_tooltip_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26252
26253
26254    /**
26255     * Sets a different style for this item tooltip.
26256     *
26257     * @note before you set a style you should define a tooltip with
26258     *       elm_diskselector_item_tooltip_content_cb_set() or
26259     *       elm_diskselector_item_tooltip_text_set()
26260     *
26261     * @param item diskselector item with tooltip already set.
26262     * @param style the theme style to use (default, transparent, ...)
26263     *
26264     * @see elm_object_tooltip_style_set() for more details.
26265     *
26266     * @ingroup Diskselector
26267     */
26268    EAPI void                   elm_diskselector_item_tooltip_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
26269
26270    /**
26271     * Get the style for this item tooltip.
26272     *
26273     * @param item diskselector item with tooltip already set.
26274     * @return style the theme style in use, defaults to "default". If the
26275     *         object does not have a tooltip set, then NULL is returned.
26276     *
26277     * @see elm_object_tooltip_style_get() for more details.
26278     * @see elm_diskselector_item_tooltip_style_set()
26279     *
26280     * @ingroup Diskselector
26281     */
26282    EAPI const char            *elm_diskselector_item_tooltip_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26283
26284    /**
26285     * Set the cursor to be shown when mouse is over the diskselector item
26286     *
26287     * @param item Target item
26288     * @param cursor the cursor name to be used.
26289     *
26290     * @see elm_object_cursor_set() for more details.
26291     *
26292     * @ingroup Diskselector
26293     */
26294    EAPI void                   elm_diskselector_item_cursor_set(Elm_Diskselector_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
26295
26296    /**
26297     * Get the cursor to be shown when mouse is over the diskselector item
26298     *
26299     * @param item diskselector item with cursor already set.
26300     * @return the cursor name.
26301     *
26302     * @see elm_object_cursor_get() for more details.
26303     * @see elm_diskselector_cursor_set()
26304     *
26305     * @ingroup Diskselector
26306     */
26307    EAPI const char            *elm_diskselector_item_cursor_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26308
26309
26310    /**
26311     * Unset the cursor to be shown when mouse is over the diskselector item
26312     *
26313     * @param item Target item
26314     *
26315     * @see elm_object_cursor_unset() for more details.
26316     * @see elm_diskselector_cursor_set()
26317     *
26318     * @ingroup Diskselector
26319     */
26320    EAPI void                   elm_diskselector_item_cursor_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26321
26322    /**
26323     * Sets a different style for this item cursor.
26324     *
26325     * @note before you set a style you should define a cursor with
26326     *       elm_diskselector_item_cursor_set()
26327     *
26328     * @param item diskselector item with cursor already set.
26329     * @param style the theme style to use (default, transparent, ...)
26330     *
26331     * @see elm_object_cursor_style_set() for more details.
26332     *
26333     * @ingroup Diskselector
26334     */
26335    EAPI void                   elm_diskselector_item_cursor_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
26336
26337
26338    /**
26339     * Get the style for this item cursor.
26340     *
26341     * @param item diskselector item with cursor already set.
26342     * @return style the theme style in use, defaults to "default". If the
26343     *         object does not have a cursor set, then @c NULL is returned.
26344     *
26345     * @see elm_object_cursor_style_get() for more details.
26346     * @see elm_diskselector_item_cursor_style_set()
26347     *
26348     * @ingroup Diskselector
26349     */
26350    EAPI const char            *elm_diskselector_item_cursor_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26351
26352
26353    /**
26354     * Set if the cursor set should be searched on the theme or should use
26355     * the provided by the engine, only.
26356     *
26357     * @note before you set if should look on theme you should define a cursor
26358     * with elm_diskselector_item_cursor_set().
26359     * By default it will only look for cursors provided by the engine.
26360     *
26361     * @param item widget item with cursor already set.
26362     * @param engine_only boolean to define if cursors set with
26363     * elm_diskselector_item_cursor_set() should be searched only
26364     * between cursors provided by the engine or searched on widget's
26365     * theme as well.
26366     *
26367     * @see elm_object_cursor_engine_only_set() for more details.
26368     *
26369     * @ingroup Diskselector
26370     */
26371    EAPI void                   elm_diskselector_item_cursor_engine_only_set(Elm_Diskselector_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
26372
26373    /**
26374     * Get the cursor engine only usage for this item cursor.
26375     *
26376     * @param item widget item with cursor already set.
26377     * @return engine_only boolean to define it cursors should be looked only
26378     * between the provided by the engine or searched on widget's theme as well.
26379     * If the item does not have a cursor set, then @c EINA_FALSE is returned.
26380     *
26381     * @see elm_object_cursor_engine_only_get() for more details.
26382     * @see elm_diskselector_item_cursor_engine_only_set()
26383     *
26384     * @ingroup Diskselector
26385     */
26386    EAPI Eina_Bool              elm_diskselector_item_cursor_engine_only_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26387
26388    /**
26389     * @}
26390     */
26391
26392    /**
26393     * @defgroup Colorselector Colorselector
26394     *
26395     * @{
26396     *
26397     * @image html img/widget/colorselector/preview-00.png
26398     * @image latex img/widget/colorselector/preview-00.eps
26399     *
26400     * @brief Widget for user to select a color.
26401     *
26402     * Signals that you can add callbacks for are:
26403     * "changed" - When the color value changes(event_info is NULL).
26404     *
26405     * See @ref tutorial_colorselector.
26406     */
26407    /**
26408     * @brief Add a new colorselector to the parent
26409     *
26410     * @param parent The parent object
26411     * @return The new object or NULL if it cannot be created
26412     *
26413     * @ingroup Colorselector
26414     */
26415    EAPI Evas_Object *elm_colorselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26416    /**
26417     * Set a color for the colorselector
26418     *
26419     * @param obj   Colorselector object
26420     * @param r     r-value of color
26421     * @param g     g-value of color
26422     * @param b     b-value of color
26423     * @param a     a-value of color
26424     *
26425     * @ingroup Colorselector
26426     */
26427    EAPI void         elm_colorselector_color_set(Evas_Object *obj, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
26428    /**
26429     * Get a color from the colorselector
26430     *
26431     * @param obj   Colorselector object
26432     * @param r     integer pointer for r-value of color
26433     * @param g     integer pointer for g-value of color
26434     * @param b     integer pointer for b-value of color
26435     * @param a     integer pointer for a-value of color
26436     *
26437     * @ingroup Colorselector
26438     */
26439    EAPI void         elm_colorselector_color_get(const Evas_Object *obj, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
26440    /**
26441     * @}
26442     */
26443
26444    /**
26445     * @defgroup Ctxpopup Ctxpopup
26446     *
26447     * @image html img/widget/ctxpopup/preview-00.png
26448     * @image latex img/widget/ctxpopup/preview-00.eps
26449     *
26450     * @brief Context popup widet.
26451     *
26452     * A ctxpopup is a widget that, when shown, pops up a list of items.
26453     * It automatically chooses an area inside its parent object's view
26454     * (set via elm_ctxpopup_add() and elm_ctxpopup_hover_parent_set()) to
26455     * optimally fit into it. In the default theme, it will also point an
26456     * arrow to it's top left position at the time one shows it. Ctxpopup
26457     * items have a label and/or an icon. It is intended for a small
26458     * number of items (hence the use of list, not genlist).
26459     *
26460     * @note Ctxpopup is a especialization of @ref Hover.
26461     *
26462     * Signals that you can add callbacks for are:
26463     * "dismissed" - the ctxpopup was dismissed
26464     *
26465     * Default contents parts of the ctxpopup widget that you can use for are:
26466     * @li "elm.swallow.content" - A content of the ctxpopup
26467     *
26468     * @ref tutorial_ctxpopup shows the usage of a good deal of the API.
26469     * @{
26470     */
26471    typedef enum _Elm_Ctxpopup_Direction
26472      {
26473         ELM_CTXPOPUP_DIRECTION_DOWN, /**< ctxpopup show appear below clicked
26474                                           area */
26475         ELM_CTXPOPUP_DIRECTION_RIGHT, /**< ctxpopup show appear to the right of
26476                                            the clicked area */
26477         ELM_CTXPOPUP_DIRECTION_LEFT, /**< ctxpopup show appear to the left of
26478                                           the clicked area */
26479         ELM_CTXPOPUP_DIRECTION_UP, /**< ctxpopup show appear above the clicked
26480                                         area */
26481         ELM_CTXPOPUP_DIRECTION_UNKNOWN, /**< ctxpopup does not determine it's direction yet*/
26482      } Elm_Ctxpopup_Direction;
26483
26484    /**
26485     * @brief Add a new Ctxpopup object to the parent.
26486     *
26487     * @param parent Parent object
26488     * @return New object or @c NULL, if it cannot be created
26489     */
26490    EAPI Evas_Object  *elm_ctxpopup_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26491    /**
26492     * @brief Set the Ctxpopup's parent
26493     *
26494     * @param obj The ctxpopup object
26495     * @param area The parent to use
26496     *
26497     * Set the parent object.
26498     *
26499     * @note elm_ctxpopup_add() will automatically call this function
26500     * with its @c parent argument.
26501     *
26502     * @see elm_ctxpopup_add()
26503     * @see elm_hover_parent_set()
26504     */
26505    EAPI void          elm_ctxpopup_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1, 2);
26506    /**
26507     * @brief Get the Ctxpopup's parent
26508     *
26509     * @param obj The ctxpopup object
26510     *
26511     * @see elm_ctxpopup_hover_parent_set() for more information
26512     */
26513    EAPI Evas_Object  *elm_ctxpopup_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26514    /**
26515     * @brief Clear all items in the given ctxpopup object.
26516     *
26517     * @param obj Ctxpopup object
26518     */
26519    EAPI void          elm_ctxpopup_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
26520    /**
26521     * @brief Change the ctxpopup's orientation to horizontal or vertical.
26522     *
26523     * @param obj Ctxpopup object
26524     * @param horizontal @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical
26525     */
26526    EAPI void          elm_ctxpopup_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
26527    /**
26528     * @brief Get the value of current ctxpopup object's orientation.
26529     *
26530     * @param obj Ctxpopup object
26531     * @return @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical mode (or errors)
26532     *
26533     * @see elm_ctxpopup_horizontal_set()
26534     */
26535    EAPI Eina_Bool     elm_ctxpopup_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26536    /**
26537     * @brief Add a new item to a ctxpopup object.
26538     *
26539     * @param obj Ctxpopup object
26540     * @param icon Icon to be set on new item
26541     * @param label The Label of the new item
26542     * @param func Convenience function called when item selected
26543     * @param data Data passed to @p func
26544     * @return A handle to the item added or @c NULL, on errors
26545     *
26546     * @warning Ctxpopup can't hold both an item list and a content at the same
26547     * time. When an item is added, any previous content will be removed.
26548     *
26549     * @see elm_ctxpopup_content_set()
26550     */
26551    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);
26552    /**
26553     * @brief Delete the given item in a ctxpopup object.
26554     *
26555     * @param it Ctxpopup item to be deleted
26556     *
26557     * @see elm_ctxpopup_item_append()
26558     */
26559    EAPI void          elm_ctxpopup_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26560    /**
26561     * @brief Set the ctxpopup item's state as disabled or enabled.
26562     *
26563     * @param it Ctxpopup item to be enabled/disabled
26564     * @param disabled @c EINA_TRUE to disable it, @c EINA_FALSE to enable it
26565     *
26566     * When disabled the item is greyed out to indicate it's state.
26567     */
26568    EAPI void          elm_ctxpopup_item_disabled_set(Elm_Object_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
26569    /**
26570     * @brief Get the ctxpopup item's disabled/enabled state.
26571     *
26572     * @param it Ctxpopup item to be enabled/disabled
26573     * @return disabled @c EINA_TRUE, if disabled, @c EINA_FALSE otherwise
26574     *
26575     * @see elm_ctxpopup_item_disabled_set()
26576     */
26577    EAPI Eina_Bool     elm_ctxpopup_item_disabled_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26578    /**
26579     * @brief Get the icon object for the given ctxpopup item.
26580     *
26581     * @param it Ctxpopup item
26582     * @return icon object or @c NULL, if the item does not have icon or an error
26583     * occurred
26584     *
26585     * @see elm_ctxpopup_item_append()
26586     * @see elm_ctxpopup_item_icon_set()
26587     */
26588    EAPI Evas_Object  *elm_ctxpopup_item_icon_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26589    /**
26590     * @brief Sets the side icon associated with the ctxpopup item
26591     *
26592     * @param it Ctxpopup item
26593     * @param icon Icon object to be set
26594     *
26595     * Once the icon object is set, a previously set one will be deleted.
26596     * @warning Setting the same icon for two items will cause the icon to
26597     * dissapear from the first item.
26598     *
26599     * @see elm_ctxpopup_item_append()
26600     */
26601    EAPI void          elm_ctxpopup_item_icon_set(Elm_Object_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
26602    /**
26603     * @brief Get the label for the given ctxpopup item.
26604     *
26605     * @param it Ctxpopup item
26606     * @return label string or @c NULL, if the item does not have label or an
26607     * error occured
26608     *
26609     * @see elm_ctxpopup_item_append()
26610     * @see elm_ctxpopup_item_label_set()
26611     */
26612    EAPI const char   *elm_ctxpopup_item_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26613    /**
26614     * @brief (Re)set the label on the given ctxpopup item.
26615     *
26616     * @param it Ctxpopup item
26617     * @param label String to set as label
26618     */
26619    EAPI void          elm_ctxpopup_item_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
26620    /**
26621     * @brief Set an elm widget as the content of the ctxpopup.
26622     *
26623     * @param obj Ctxpopup object
26624     * @param content Content to be swallowed
26625     *
26626     * If the content object is already set, a previous one will bedeleted. If
26627     * you want to keep that old content object, use the
26628     * elm_ctxpopup_content_unset() function.
26629     *
26630     * @deprecated use elm_object_content_set()
26631     *
26632     * @warning Ctxpopup can't hold both a item list and a content at the same
26633     * time. When a content is set, any previous items will be removed.
26634     */
26635    EINA_DEPRECATED EAPI void          elm_ctxpopup_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1, 2);
26636    /**
26637     * @brief Unset the ctxpopup content
26638     *
26639     * @param obj Ctxpopup object
26640     * @return The content that was being used
26641     *
26642     * Unparent and return the content object which was set for this widget.
26643     *
26644     * @deprecated use elm_object_content_unset()
26645     *
26646     * @see elm_ctxpopup_content_set()
26647     */
26648    EINA_DEPRECATED EAPI Evas_Object  *elm_ctxpopup_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
26649    /**
26650     * @brief Set the direction priority of a ctxpopup.
26651     *
26652     * @param obj Ctxpopup object
26653     * @param first 1st priority of direction
26654     * @param second 2nd priority of direction
26655     * @param third 3th priority of direction
26656     * @param fourth 4th priority of direction
26657     *
26658     * This functions gives a chance to user to set the priority of ctxpopup
26659     * showing direction. This doesn't guarantee the ctxpopup will appear in the
26660     * requested direction.
26661     *
26662     * @see Elm_Ctxpopup_Direction
26663     */
26664    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);
26665    /**
26666     * @brief Get the direction priority of a ctxpopup.
26667     *
26668     * @param obj Ctxpopup object
26669     * @param first 1st priority of direction to be returned
26670     * @param second 2nd priority of direction to be returned
26671     * @param third 3th priority of direction to be returned
26672     * @param fourth 4th priority of direction to be returned
26673     *
26674     * @see elm_ctxpopup_direction_priority_set() for more information.
26675     */
26676    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);
26677
26678    /**
26679     * @brief Get the current direction of a ctxpopup.
26680     *
26681     * @param obj Ctxpopup object
26682     * @return current direction of a ctxpopup
26683     *
26684     * @warning Once the ctxpopup showed up, the direction would be determined
26685     */
26686    EAPI Elm_Ctxpopup_Direction elm_ctxpopup_direction_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26687
26688    /**
26689     * @}
26690     */
26691
26692    /* transit */
26693    /**
26694     *
26695     * @defgroup Transit Transit
26696     * @ingroup Elementary
26697     *
26698     * Transit is designed to apply various animated transition effects to @c
26699     * Evas_Object, such like translation, rotation, etc. For using these
26700     * effects, create an @ref Elm_Transit and add the desired transition effects.
26701     *
26702     * Once the effects are added into transit, they will be automatically
26703     * managed (their callback will be called until the duration is ended, and
26704     * they will be deleted on completion).
26705     *
26706     * Example:
26707     * @code
26708     * Elm_Transit *trans = elm_transit_add();
26709     * elm_transit_object_add(trans, obj);
26710     * elm_transit_effect_translation_add(trans, 0, 0, 280, 280
26711     * elm_transit_duration_set(transit, 1);
26712     * elm_transit_auto_reverse_set(transit, EINA_TRUE);
26713     * elm_transit_tween_mode_set(transit, ELM_TRANSIT_TWEEN_MODE_DECELERATE);
26714     * elm_transit_repeat_times_set(transit, 3);
26715     * @endcode
26716     *
26717     * Some transition effects are used to change the properties of objects. They
26718     * are:
26719     * @li @ref elm_transit_effect_translation_add
26720     * @li @ref elm_transit_effect_color_add
26721     * @li @ref elm_transit_effect_rotation_add
26722     * @li @ref elm_transit_effect_wipe_add
26723     * @li @ref elm_transit_effect_zoom_add
26724     * @li @ref elm_transit_effect_resizing_add
26725     *
26726     * Other transition effects are used to make one object disappear and another
26727     * object appear on its old place. These effects are:
26728     *
26729     * @li @ref elm_transit_effect_flip_add
26730     * @li @ref elm_transit_effect_resizable_flip_add
26731     * @li @ref elm_transit_effect_fade_add
26732     * @li @ref elm_transit_effect_blend_add
26733     *
26734     * It's also possible to make a transition chain with @ref
26735     * elm_transit_chain_transit_add.
26736     *
26737     * @warning We strongly recommend to use elm_transit just when edje can not do
26738     * the trick. Edje has more advantage than Elm_Transit, it has more flexibility and
26739     * animations can be manipulated inside the theme.
26740     *
26741     * List of examples:
26742     * @li @ref transit_example_01_explained
26743     * @li @ref transit_example_02_explained
26744     * @li @ref transit_example_03_c
26745     * @li @ref transit_example_04_c
26746     *
26747     * @{
26748     */
26749
26750    /**
26751     * @enum Elm_Transit_Tween_Mode
26752     *
26753     * The type of acceleration used in the transition.
26754     */
26755    typedef enum
26756      {
26757         ELM_TRANSIT_TWEEN_MODE_LINEAR, /**< Constant speed */
26758         ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL, /**< Starts slow, increase speed
26759                                              over time, then decrease again
26760                                              and stop slowly */
26761         ELM_TRANSIT_TWEEN_MODE_DECELERATE, /**< Starts fast and decrease
26762                                              speed over time */
26763         ELM_TRANSIT_TWEEN_MODE_ACCELERATE /**< Starts slow and increase speed
26764                                             over time */
26765      } Elm_Transit_Tween_Mode;
26766
26767    /**
26768     * @enum Elm_Transit_Effect_Flip_Axis
26769     *
26770     * The axis where flip effect should be applied.
26771     */
26772    typedef enum
26773      {
26774         ELM_TRANSIT_EFFECT_FLIP_AXIS_X, /**< Flip on X axis */
26775         ELM_TRANSIT_EFFECT_FLIP_AXIS_Y /**< Flip on Y axis */
26776      } Elm_Transit_Effect_Flip_Axis;
26777    /**
26778     * @enum Elm_Transit_Effect_Wipe_Dir
26779     *
26780     * The direction where the wipe effect should occur.
26781     */
26782    typedef enum
26783      {
26784         ELM_TRANSIT_EFFECT_WIPE_DIR_LEFT, /**< Wipe to the left */
26785         ELM_TRANSIT_EFFECT_WIPE_DIR_RIGHT, /**< Wipe to the right */
26786         ELM_TRANSIT_EFFECT_WIPE_DIR_UP, /**< Wipe up */
26787         ELM_TRANSIT_EFFECT_WIPE_DIR_DOWN /**< Wipe down */
26788      } Elm_Transit_Effect_Wipe_Dir;
26789    /** @enum Elm_Transit_Effect_Wipe_Type
26790     *
26791     * Whether the wipe effect should show or hide the object.
26792     */
26793    typedef enum
26794      {
26795         ELM_TRANSIT_EFFECT_WIPE_TYPE_HIDE, /**< Hide the object during the
26796                                              animation */
26797         ELM_TRANSIT_EFFECT_WIPE_TYPE_SHOW /**< Show the object during the
26798                                             animation */
26799      } Elm_Transit_Effect_Wipe_Type;
26800
26801    /**
26802     * @typedef Elm_Transit
26803     *
26804     * The Transit created with elm_transit_add(). This type has the information
26805     * about the objects which the transition will be applied, and the
26806     * transition effects that will be used. It also contains info about
26807     * duration, number of repetitions, auto-reverse, etc.
26808     */
26809    typedef struct _Elm_Transit Elm_Transit;
26810    typedef void Elm_Transit_Effect;
26811    /**
26812     * @typedef Elm_Transit_Effect_Transition_Cb
26813     *
26814     * Transition callback called for this effect on each transition iteration.
26815     */
26816    typedef void (*Elm_Transit_Effect_Transition_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit, double progress);
26817    /**
26818     * Elm_Transit_Effect_End_Cb
26819     *
26820     * Transition callback called for this effect when the transition is over.
26821     */
26822    typedef void (*Elm_Transit_Effect_End_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit);
26823
26824    /**
26825     * Elm_Transit_Del_Cb
26826     *
26827     * A callback called when the transit is deleted.
26828     */
26829    typedef void (*Elm_Transit_Del_Cb) (void *data, Elm_Transit *transit);
26830
26831    /**
26832     * Add new transit.
26833     *
26834     * @note Is not necessary to delete the transit object, it will be deleted at
26835     * the end of its operation.
26836     * @note The transit will start playing when the program enter in the main loop, is not
26837     * necessary to give a start to the transit.
26838     *
26839     * @return The transit object.
26840     *
26841     * @ingroup Transit
26842     */
26843    EAPI Elm_Transit                *elm_transit_add(void);
26844
26845    /**
26846     * Stops the animation and delete the @p transit object.
26847     *
26848     * Call this function if you wants to stop the animation before the duration
26849     * time. Make sure the @p transit object is still alive with
26850     * elm_transit_del_cb_set() function.
26851     * All added effects will be deleted, calling its repective data_free_cb
26852     * functions. The function setted by elm_transit_del_cb_set() will be called.
26853     *
26854     * @see elm_transit_del_cb_set()
26855     *
26856     * @param transit The transit object to be deleted.
26857     *
26858     * @ingroup Transit
26859     * @warning Just call this function if you are sure the transit is alive.
26860     */
26861    EAPI void                        elm_transit_del(Elm_Transit *transit) EINA_ARG_NONNULL(1);
26862
26863    /**
26864     * Add a new effect to the transit.
26865     *
26866     * @note The cb function and the data are the key to the effect. If you try to
26867     * add an already added effect, nothing is done.
26868     * @note After the first addition of an effect in @p transit, if its
26869     * effect list become empty again, the @p transit will be killed by
26870     * elm_transit_del(transit) function.
26871     *
26872     * Exemple:
26873     * @code
26874     * Elm_Transit *transit = elm_transit_add();
26875     * elm_transit_effect_add(transit,
26876     *                        elm_transit_effect_blend_op,
26877     *                        elm_transit_effect_blend_context_new(),
26878     *                        elm_transit_effect_blend_context_free);
26879     * @endcode
26880     *
26881     * @param transit The transit object.
26882     * @param transition_cb The operation function. It is called when the
26883     * animation begins, it is the function that actually performs the animation.
26884     * It is called with the @p data, @p transit and the time progression of the
26885     * animation (a double value between 0.0 and 1.0).
26886     * @param effect The context data of the effect.
26887     * @param end_cb The function to free the context data, it will be called
26888     * at the end of the effect, it must finalize the animation and free the
26889     * @p data.
26890     *
26891     * @ingroup Transit
26892     * @warning The transit free the context data at the and of the transition with
26893     * the data_free_cb function, do not use the context data in another transit.
26894     */
26895    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);
26896
26897    /**
26898     * Delete an added effect.
26899     *
26900     * This function will remove the effect from the @p transit, calling the
26901     * data_free_cb to free the @p data.
26902     *
26903     * @see elm_transit_effect_add()
26904     *
26905     * @note If the effect is not found, nothing is done.
26906     * @note If the effect list become empty, this function will call
26907     * elm_transit_del(transit), that is, it will kill the @p transit.
26908     *
26909     * @param transit The transit object.
26910     * @param transition_cb The operation function.
26911     * @param effect The context data of the effect.
26912     *
26913     * @ingroup Transit
26914     */
26915    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);
26916
26917    /**
26918     * Add new object to apply the effects.
26919     *
26920     * @note After the first addition of an object in @p transit, if its
26921     * object list become empty again, the @p transit will be killed by
26922     * elm_transit_del(transit) function.
26923     * @note If the @p obj belongs to another transit, the @p obj will be
26924     * removed from it and it will only belong to the @p transit. If the old
26925     * transit stays without objects, it will die.
26926     * @note When you add an object into the @p transit, its state from
26927     * evas_object_pass_events_get(obj) is saved, and it is applied when the
26928     * transit ends, if you change this state whith evas_object_pass_events_set()
26929     * after add the object, this state will change again when @p transit stops to
26930     * run.
26931     *
26932     * @param transit The transit object.
26933     * @param obj Object to be animated.
26934     *
26935     * @ingroup Transit
26936     * @warning It is not allowed to add a new object after transit begins to go.
26937     */
26938    EAPI void                        elm_transit_object_add(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
26939
26940    /**
26941     * Removes an added object from the transit.
26942     *
26943     * @note If the @p obj is not in the @p transit, nothing is done.
26944     * @note If the list become empty, this function will call
26945     * elm_transit_del(transit), that is, it will kill the @p transit.
26946     *
26947     * @param transit The transit object.
26948     * @param obj Object to be removed from @p transit.
26949     *
26950     * @ingroup Transit
26951     * @warning It is not allowed to remove objects after transit begins to go.
26952     */
26953    EAPI void                        elm_transit_object_remove(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
26954
26955    /**
26956     * Get the objects of the transit.
26957     *
26958     * @param transit The transit object.
26959     * @return a Eina_List with the objects from the transit.
26960     *
26961     * @ingroup Transit
26962     */
26963    EAPI const Eina_List            *elm_transit_objects_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26964
26965    /**
26966     * Enable/disable keeping up the objects states.
26967     * If it is not kept, the objects states will be reset when transition ends.
26968     *
26969     * @note @p transit can not be NULL.
26970     * @note One state includes geometry, color, map data.
26971     *
26972     * @param transit The transit object.
26973     * @param state_keep Keeping or Non Keeping.
26974     *
26975     * @ingroup Transit
26976     */
26977    EAPI void                        elm_transit_objects_final_state_keep_set(Elm_Transit *transit, Eina_Bool state_keep) EINA_ARG_NONNULL(1);
26978
26979    /**
26980     * Get a value whether the objects states will be reset or not.
26981     *
26982     * @note @p transit can not be NULL
26983     *
26984     * @see elm_transit_objects_final_state_keep_set()
26985     *
26986     * @param transit The transit object.
26987     * @return EINA_TRUE means the states of the objects will be reset.
26988     * If @p transit is NULL, EINA_FALSE is returned
26989     *
26990     * @ingroup Transit
26991     */
26992    EAPI Eina_Bool                   elm_transit_objects_final_state_keep_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26993
26994    /**
26995     * Set the event enabled when transit is operating.
26996     *
26997     * If @p enabled is EINA_TRUE, the objects of the transit will receives
26998     * events from mouse and keyboard during the animation.
26999     * @note When you add an object with elm_transit_object_add(), its state from
27000     * evas_object_pass_events_get(obj) is saved, and it is applied when the
27001     * transit ends, if you change this state with evas_object_pass_events_set()
27002     * after adding the object, this state will change again when @p transit stops
27003     * to run.
27004     *
27005     * @param transit The transit object.
27006     * @param enabled Events are received when enabled is @c EINA_TRUE, and
27007     * ignored otherwise.
27008     *
27009     * @ingroup Transit
27010     */
27011    EAPI void                        elm_transit_event_enabled_set(Elm_Transit *transit, Eina_Bool enabled) EINA_ARG_NONNULL(1);
27012
27013    /**
27014     * Get the value of event enabled status.
27015     *
27016     * @see elm_transit_event_enabled_set()
27017     *
27018     * @param transit The Transit object
27019     * @return EINA_TRUE, when event is enabled. If @p transit is NULL
27020     * EINA_FALSE is returned
27021     *
27022     * @ingroup Transit
27023     */
27024    EAPI Eina_Bool                   elm_transit_event_enabled_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27025
27026    /**
27027     * Set the user-callback function when the transit is deleted.
27028     *
27029     * @note Using this function twice will overwrite the first function setted.
27030     * @note the @p transit object will be deleted after call @p cb function.
27031     *
27032     * @param transit The transit object.
27033     * @param cb Callback function pointer. This function will be called before
27034     * the deletion of the transit.
27035     * @param data Callback funtion user data. It is the @p op parameter.
27036     *
27037     * @ingroup Transit
27038     */
27039    EAPI void                        elm_transit_del_cb_set(Elm_Transit *transit, Elm_Transit_Del_Cb cb, void *data) EINA_ARG_NONNULL(1);
27040
27041    /**
27042     * Set reverse effect automatically.
27043     *
27044     * If auto reverse is setted, after running the effects with the progress
27045     * parameter from 0 to 1, it will call the effecs again with the progress
27046     * from 1 to 0. The transit will last for a time iqual to (2 * duration * repeat),
27047     * where the duration was setted with the function elm_transit_add and
27048     * the repeat with the function elm_transit_repeat_times_set().
27049     *
27050     * @param transit The transit object.
27051     * @param reverse EINA_TRUE means the auto_reverse is on.
27052     *
27053     * @ingroup Transit
27054     */
27055    EAPI void                        elm_transit_auto_reverse_set(Elm_Transit *transit, Eina_Bool reverse) EINA_ARG_NONNULL(1);
27056
27057    /**
27058     * Get if the auto reverse is on.
27059     *
27060     * @see elm_transit_auto_reverse_set()
27061     *
27062     * @param transit The transit object.
27063     * @return EINA_TRUE means auto reverse is on. If @p transit is NULL
27064     * EINA_FALSE is returned
27065     *
27066     * @ingroup Transit
27067     */
27068    EAPI Eina_Bool                   elm_transit_auto_reverse_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27069
27070    /**
27071     * Set the transit repeat count. Effect will be repeated by repeat count.
27072     *
27073     * This function sets the number of repetition the transit will run after
27074     * the first one, that is, if @p repeat is 1, the transit will run 2 times.
27075     * If the @p repeat is a negative number, it will repeat infinite times.
27076     *
27077     * @note If this function is called during the transit execution, the transit
27078     * will run @p repeat times, ignoring the times it already performed.
27079     *
27080     * @param transit The transit object
27081     * @param repeat Repeat count
27082     *
27083     * @ingroup Transit
27084     */
27085    EAPI void                        elm_transit_repeat_times_set(Elm_Transit *transit, int repeat) EINA_ARG_NONNULL(1);
27086
27087    /**
27088     * Get the transit repeat count.
27089     *
27090     * @see elm_transit_repeat_times_set()
27091     *
27092     * @param transit The Transit object.
27093     * @return The repeat count. If @p transit is NULL
27094     * 0 is returned
27095     *
27096     * @ingroup Transit
27097     */
27098    EAPI int                         elm_transit_repeat_times_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27099
27100    /**
27101     * Set the transit animation acceleration type.
27102     *
27103     * This function sets the tween mode of the transit that can be:
27104     * ELM_TRANSIT_TWEEN_MODE_LINEAR - The default mode.
27105     * ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL - Starts in accelerate mode and ends decelerating.
27106     * ELM_TRANSIT_TWEEN_MODE_DECELERATE - The animation will be slowed over time.
27107     * ELM_TRANSIT_TWEEN_MODE_ACCELERATE - The animation will accelerate over time.
27108     *
27109     * @param transit The transit object.
27110     * @param tween_mode The tween type.
27111     *
27112     * @ingroup Transit
27113     */
27114    EAPI void                        elm_transit_tween_mode_set(Elm_Transit *transit, Elm_Transit_Tween_Mode tween_mode) EINA_ARG_NONNULL(1);
27115
27116    /**
27117     * Get the transit animation acceleration type.
27118     *
27119     * @note @p transit can not be NULL
27120     *
27121     * @param transit The transit object.
27122     * @return The tween type. If @p transit is NULL
27123     * ELM_TRANSIT_TWEEN_MODE_LINEAR is returned.
27124     *
27125     * @ingroup Transit
27126     */
27127    EAPI Elm_Transit_Tween_Mode      elm_transit_tween_mode_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27128
27129    /**
27130     * Set the transit animation time
27131     *
27132     * @note @p transit can not be NULL
27133     *
27134     * @param transit The transit object.
27135     * @param duration The animation time.
27136     *
27137     * @ingroup Transit
27138     */
27139    EAPI void                        elm_transit_duration_set(Elm_Transit *transit, double duration) EINA_ARG_NONNULL(1);
27140
27141    /**
27142     * Get the transit animation time
27143     *
27144     * @note @p transit can not be NULL
27145     *
27146     * @param transit The transit object.
27147     *
27148     * @return The transit animation time.
27149     *
27150     * @ingroup Transit
27151     */
27152    EAPI double                      elm_transit_duration_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27153
27154    /**
27155     * Starts the transition.
27156     * Once this API is called, the transit begins to measure the time.
27157     *
27158     * @note @p transit can not be NULL
27159     *
27160     * @param transit The transit object.
27161     *
27162     * @ingroup Transit
27163     */
27164    EAPI void                        elm_transit_go(Elm_Transit *transit) EINA_ARG_NONNULL(1);
27165
27166    /**
27167     * Pause/Resume the transition.
27168     *
27169     * If you call elm_transit_go again, the transit will be started from the
27170     * beginning, and will be unpaused.
27171     *
27172     * @note @p transit can not be NULL
27173     *
27174     * @param transit The transit object.
27175     * @param paused Whether the transition should be paused or not.
27176     *
27177     * @ingroup Transit
27178     */
27179    EAPI void                        elm_transit_paused_set(Elm_Transit *transit, Eina_Bool paused) EINA_ARG_NONNULL(1);
27180
27181    /**
27182     * Get the value of paused status.
27183     *
27184     * @see elm_transit_paused_set()
27185     *
27186     * @note @p transit can not be NULL
27187     *
27188     * @param transit The transit object.
27189     * @return EINA_TRUE means transition is paused. If @p transit is NULL
27190     * EINA_FALSE is returned
27191     *
27192     * @ingroup Transit
27193     */
27194    EAPI Eina_Bool                   elm_transit_paused_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27195
27196    /**
27197     * Get the time progression of the animation (a double value between 0.0 and 1.0).
27198     *
27199     * The value returned is a fraction (current time / total time). It
27200     * represents the progression position relative to the total.
27201     *
27202     * @note @p transit can not be NULL
27203     *
27204     * @param transit The transit object.
27205     *
27206     * @return The time progression value. If @p transit is NULL
27207     * 0 is returned
27208     *
27209     * @ingroup Transit
27210     */
27211    EAPI double                      elm_transit_progress_value_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27212
27213    /**
27214     * Makes the chain relationship between two transits.
27215     *
27216     * @note @p transit can not be NULL. Transit would have multiple chain transits.
27217     * @note @p chain_transit can not be NULL. Chain transits could be chained to the only one transit.
27218     *
27219     * @param transit The transit object.
27220     * @param chain_transit The chain transit object. This transit will be operated
27221     *        after transit is done.
27222     *
27223     * This function adds @p chain_transit transition to a chain after the @p
27224     * transit, and will be started as soon as @p transit ends. See @ref
27225     * transit_example_02_explained for a full example.
27226     *
27227     * @ingroup Transit
27228     */
27229    EAPI void                        elm_transit_chain_transit_add(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1, 2);
27230
27231    /**
27232     * Cut off the chain relationship between two transits.
27233     *
27234     * @note @p transit can not be NULL. Transit would have the chain relationship with @p chain transit.
27235     * @note @p chain_transit can not be NULL. Chain transits should be chained to the @p transit.
27236     *
27237     * @param transit The transit object.
27238     * @param chain_transit The chain transit object.
27239     *
27240     * This function remove the @p chain_transit transition from the @p transit.
27241     *
27242     * @ingroup Transit
27243     */
27244    EAPI void                        elm_transit_chain_transit_del(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1,2);
27245
27246    /**
27247     * Get the current chain transit list.
27248     *
27249     * @note @p transit can not be NULL.
27250     *
27251     * @param transit The transit object.
27252     * @return chain transit list.
27253     *
27254     * @ingroup Transit
27255     */
27256    EAPI Eina_List                  *elm_transit_chain_transits_get(const Elm_Transit *transit);
27257
27258    /**
27259     * Add the Resizing Effect to Elm_Transit.
27260     *
27261     * @note This API is one of the facades. It creates resizing effect context
27262     * and add it's required APIs to elm_transit_effect_add.
27263     *
27264     * @see elm_transit_effect_add()
27265     *
27266     * @param transit Transit object.
27267     * @param from_w Object width size when effect begins.
27268     * @param from_h Object height size when effect begins.
27269     * @param to_w Object width size when effect ends.
27270     * @param to_h Object height size when effect ends.
27271     * @return Resizing effect context data.
27272     *
27273     * @ingroup Transit
27274     */
27275    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);
27276
27277    /**
27278     * Add the Translation Effect to Elm_Transit.
27279     *
27280     * @note This API is one of the facades. It creates translation effect context
27281     * and add it's required APIs to elm_transit_effect_add.
27282     *
27283     * @see elm_transit_effect_add()
27284     *
27285     * @param transit Transit object.
27286     * @param from_dx X Position variation when effect begins.
27287     * @param from_dy Y Position variation when effect begins.
27288     * @param to_dx X Position variation when effect ends.
27289     * @param to_dy Y Position variation when effect ends.
27290     * @return Translation effect context data.
27291     *
27292     * @ingroup Transit
27293     * @warning It is highly recommended just create a transit with this effect when
27294     * the window that the objects of the transit belongs has already been created.
27295     * This is because this effect needs the geometry information about the objects,
27296     * and if the window was not created yet, it can get a wrong information.
27297     */
27298    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);
27299
27300    /**
27301     * Add the Zoom Effect to Elm_Transit.
27302     *
27303     * @note This API is one of the facades. It creates zoom effect context
27304     * and add it's required APIs to elm_transit_effect_add.
27305     *
27306     * @see elm_transit_effect_add()
27307     *
27308     * @param transit Transit object.
27309     * @param from_rate Scale rate when effect begins (1 is current rate).
27310     * @param to_rate Scale rate when effect ends.
27311     * @return Zoom effect context data.
27312     *
27313     * @ingroup Transit
27314     * @warning It is highly recommended just create a transit with this effect when
27315     * the window that the objects of the transit belongs has already been created.
27316     * This is because this effect needs the geometry information about the objects,
27317     * and if the window was not created yet, it can get a wrong information.
27318     */
27319    EAPI Elm_Transit_Effect *elm_transit_effect_zoom_add(Elm_Transit *transit, float from_rate, float to_rate);
27320
27321    /**
27322     * Add the Flip Effect to Elm_Transit.
27323     *
27324     * @note This API is one of the facades. It creates flip effect context
27325     * and add it's required APIs to elm_transit_effect_add.
27326     * @note This effect is applied to each pair of objects in the order they are listed
27327     * in the transit list of objects. The first object in the pair will be the
27328     * "front" object and the second will be the "back" object.
27329     *
27330     * @see elm_transit_effect_add()
27331     *
27332     * @param transit Transit object.
27333     * @param axis Flipping Axis(X or Y).
27334     * @param cw Flipping Direction. EINA_TRUE is clock-wise.
27335     * @return Flip effect context data.
27336     *
27337     * @ingroup Transit
27338     * @warning It is highly recommended just create a transit with this effect when
27339     * the window that the objects of the transit belongs has already been created.
27340     * This is because this effect needs the geometry information about the objects,
27341     * and if the window was not created yet, it can get a wrong information.
27342     */
27343    EAPI Elm_Transit_Effect *elm_transit_effect_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
27344
27345    /**
27346     * Add the Resizable Flip Effect to Elm_Transit.
27347     *
27348     * @note This API is one of the facades. It creates resizable flip effect context
27349     * and add it's required APIs to elm_transit_effect_add.
27350     * @note This effect is applied to each pair of objects in the order they are listed
27351     * in the transit list of objects. The first object in the pair will be the
27352     * "front" object and the second will be the "back" object.
27353     *
27354     * @see elm_transit_effect_add()
27355     *
27356     * @param transit Transit object.
27357     * @param axis Flipping Axis(X or Y).
27358     * @param cw Flipping Direction. EINA_TRUE is clock-wise.
27359     * @return Resizable flip effect context data.
27360     *
27361     * @ingroup Transit
27362     * @warning It is highly recommended just create a transit with this effect when
27363     * the window that the objects of the transit belongs has already been created.
27364     * This is because this effect needs the geometry information about the objects,
27365     * and if the window was not created yet, it can get a wrong information.
27366     */
27367    EAPI Elm_Transit_Effect *elm_transit_effect_resizable_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
27368
27369    /**
27370     * Add the Wipe Effect to Elm_Transit.
27371     *
27372     * @note This API is one of the facades. It creates wipe effect context
27373     * and add it's required APIs to elm_transit_effect_add.
27374     *
27375     * @see elm_transit_effect_add()
27376     *
27377     * @param transit Transit object.
27378     * @param type Wipe type. Hide or show.
27379     * @param dir Wipe Direction.
27380     * @return Wipe effect context data.
27381     *
27382     * @ingroup Transit
27383     * @warning It is highly recommended just create a transit with this effect when
27384     * the window that the objects of the transit belongs has already been created.
27385     * This is because this effect needs the geometry information about the objects,
27386     * and if the window was not created yet, it can get a wrong information.
27387     */
27388    EAPI Elm_Transit_Effect *elm_transit_effect_wipe_add(Elm_Transit *transit, Elm_Transit_Effect_Wipe_Type type, Elm_Transit_Effect_Wipe_Dir dir);
27389
27390    /**
27391     * Add the Color Effect to Elm_Transit.
27392     *
27393     * @note This API is one of the facades. It creates color effect context
27394     * and add it's required APIs to elm_transit_effect_add.
27395     *
27396     * @see elm_transit_effect_add()
27397     *
27398     * @param transit        Transit object.
27399     * @param  from_r        RGB R when effect begins.
27400     * @param  from_g        RGB G when effect begins.
27401     * @param  from_b        RGB B when effect begins.
27402     * @param  from_a        RGB A when effect begins.
27403     * @param  to_r          RGB R when effect ends.
27404     * @param  to_g          RGB G when effect ends.
27405     * @param  to_b          RGB B when effect ends.
27406     * @param  to_a          RGB A when effect ends.
27407     * @return               Color effect context data.
27408     *
27409     * @ingroup Transit
27410     */
27411    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);
27412
27413    /**
27414     * Add the Fade Effect to Elm_Transit.
27415     *
27416     * @note This API is one of the facades. It creates fade effect context
27417     * and add it's required APIs to elm_transit_effect_add.
27418     * @note This effect is applied to each pair of objects in the order they are listed
27419     * in the transit list of objects. The first object in the pair will be the
27420     * "before" object and the second will be the "after" object.
27421     *
27422     * @see elm_transit_effect_add()
27423     *
27424     * @param transit Transit object.
27425     * @return Fade effect context data.
27426     *
27427     * @ingroup Transit
27428     * @warning It is highly recommended just create a transit with this effect when
27429     * the window that the objects of the transit belongs has already been created.
27430     * This is because this effect needs the color information about the objects,
27431     * and if the window was not created yet, it can get a wrong information.
27432     */
27433    EAPI Elm_Transit_Effect *elm_transit_effect_fade_add(Elm_Transit *transit);
27434
27435    /**
27436     * Add the Blend Effect to Elm_Transit.
27437     *
27438     * @note This API is one of the facades. It creates blend effect context
27439     * and add it's required APIs to elm_transit_effect_add.
27440     * @note This effect is applied to each pair of objects in the order they are listed
27441     * in the transit list of objects. The first object in the pair will be the
27442     * "before" object and the second will be the "after" object.
27443     *
27444     * @see elm_transit_effect_add()
27445     *
27446     * @param transit Transit object.
27447     * @return Blend effect context data.
27448     *
27449     * @ingroup Transit
27450     * @warning It is highly recommended just create a transit with this effect when
27451     * the window that the objects of the transit belongs has already been created.
27452     * This is because this effect needs the color information about the objects,
27453     * and if the window was not created yet, it can get a wrong information.
27454     */
27455    EAPI Elm_Transit_Effect *elm_transit_effect_blend_add(Elm_Transit *transit);
27456
27457    /**
27458     * Add the Rotation Effect to Elm_Transit.
27459     *
27460     * @note This API is one of the facades. It creates rotation effect context
27461     * and add it's required APIs to elm_transit_effect_add.
27462     *
27463     * @see elm_transit_effect_add()
27464     *
27465     * @param transit Transit object.
27466     * @param from_degree Degree when effect begins.
27467     * @param to_degree Degree when effect is ends.
27468     * @return Rotation effect context data.
27469     *
27470     * @ingroup Transit
27471     * @warning It is highly recommended just create a transit with this effect when
27472     * the window that the objects of the transit belongs has already been created.
27473     * This is because this effect needs the geometry information about the objects,
27474     * and if the window was not created yet, it can get a wrong information.
27475     */
27476    EAPI Elm_Transit_Effect *elm_transit_effect_rotation_add(Elm_Transit *transit, float from_degree, float to_degree);
27477
27478    /**
27479     * Add the ImageAnimation Effect to Elm_Transit.
27480     *
27481     * @note This API is one of the facades. It creates image animation effect context
27482     * and add it's required APIs to elm_transit_effect_add.
27483     * The @p images parameter is a list images paths. This list and
27484     * its contents will be deleted at the end of the effect by
27485     * elm_transit_effect_image_animation_context_free() function.
27486     *
27487     * Example:
27488     * @code
27489     * char buf[PATH_MAX];
27490     * Eina_List *images = NULL;
27491     * Elm_Transit *transi = elm_transit_add();
27492     *
27493     * snprintf(buf, sizeof(buf), "%s/images/icon_11.png", PACKAGE_DATA_DIR);
27494     * images = eina_list_append(images, eina_stringshare_add(buf));
27495     *
27496     * snprintf(buf, sizeof(buf), "%s/images/logo_small.png", PACKAGE_DATA_DIR);
27497     * images = eina_list_append(images, eina_stringshare_add(buf));
27498     * elm_transit_effect_image_animation_add(transi, images);
27499     *
27500     * @endcode
27501     *
27502     * @see elm_transit_effect_add()
27503     *
27504     * @param transit Transit object.
27505     * @param images Eina_List of images file paths. This list and
27506     * its contents will be deleted at the end of the effect by
27507     * elm_transit_effect_image_animation_context_free() function.
27508     * @return Image Animation effect context data.
27509     *
27510     * @ingroup Transit
27511     */
27512    EAPI Elm_Transit_Effect *elm_transit_effect_image_animation_add(Elm_Transit *transit, Eina_List *images);
27513    /**
27514     * @}
27515     */
27516
27517    typedef struct _Elm_Store                      Elm_Store;
27518    typedef struct _Elm_Store_Filesystem           Elm_Store_Filesystem;
27519    typedef struct _Elm_Store_Item                 Elm_Store_Item;
27520    typedef struct _Elm_Store_Item_Filesystem      Elm_Store_Item_Filesystem;
27521    typedef struct _Elm_Store_Item_Info            Elm_Store_Item_Info;
27522    typedef struct _Elm_Store_Item_Info_Filesystem Elm_Store_Item_Info_Filesystem;
27523    typedef struct _Elm_Store_Item_Mapping         Elm_Store_Item_Mapping;
27524    typedef struct _Elm_Store_Item_Mapping_Empty   Elm_Store_Item_Mapping_Empty;
27525    typedef struct _Elm_Store_Item_Mapping_Icon    Elm_Store_Item_Mapping_Icon;
27526    typedef struct _Elm_Store_Item_Mapping_Photo   Elm_Store_Item_Mapping_Photo;
27527    typedef struct _Elm_Store_Item_Mapping_Custom  Elm_Store_Item_Mapping_Custom;
27528
27529    typedef Eina_Bool (*Elm_Store_Item_List_Cb) (void *data, Elm_Store_Item_Info *info);
27530    typedef void      (*Elm_Store_Item_Fetch_Cb) (void *data, Elm_Store_Item *sti);
27531    typedef void      (*Elm_Store_Item_Unfetch_Cb) (void *data, Elm_Store_Item *sti);
27532    typedef void     *(*Elm_Store_Item_Mapping_Cb) (void *data, Elm_Store_Item *sti, const char *part);
27533
27534    typedef enum
27535      {
27536         ELM_STORE_ITEM_MAPPING_NONE = 0,
27537         ELM_STORE_ITEM_MAPPING_LABEL, // const char * -> label
27538         ELM_STORE_ITEM_MAPPING_STATE, // Eina_Bool -> state
27539         ELM_STORE_ITEM_MAPPING_ICON, // char * -> icon path
27540         ELM_STORE_ITEM_MAPPING_PHOTO, // char * -> photo path
27541         ELM_STORE_ITEM_MAPPING_CUSTOM, // item->custom(it->data, it, part) -> void * (-> any)
27542         // can add more here as needed by common apps
27543         ELM_STORE_ITEM_MAPPING_LAST
27544      } Elm_Store_Item_Mapping_Type;
27545
27546    struct _Elm_Store_Item_Mapping_Icon
27547      {
27548         // FIXME: allow edje file icons
27549         int                   w, h;
27550         Elm_Icon_Lookup_Order lookup_order;
27551         Eina_Bool             standard_name : 1;
27552         Eina_Bool             no_scale : 1;
27553         Eina_Bool             smooth : 1;
27554         Eina_Bool             scale_up : 1;
27555         Eina_Bool             scale_down : 1;
27556      };
27557
27558    struct _Elm_Store_Item_Mapping_Empty
27559      {
27560         Eina_Bool             dummy;
27561      };
27562
27563    struct _Elm_Store_Item_Mapping_Photo
27564      {
27565         int                   size;
27566      };
27567
27568    struct _Elm_Store_Item_Mapping_Custom
27569      {
27570         Elm_Store_Item_Mapping_Cb func;
27571      };
27572
27573    struct _Elm_Store_Item_Mapping
27574      {
27575         Elm_Store_Item_Mapping_Type     type;
27576         const char                     *part;
27577         int                             offset;
27578         union
27579           {
27580              Elm_Store_Item_Mapping_Empty  empty;
27581              Elm_Store_Item_Mapping_Icon   icon;
27582              Elm_Store_Item_Mapping_Photo  photo;
27583              Elm_Store_Item_Mapping_Custom custom;
27584              // add more types here
27585           } details;
27586      };
27587
27588    struct _Elm_Store_Item_Info
27589      {
27590         Elm_Genlist_Item_Class       *item_class;
27591         const Elm_Store_Item_Mapping *mapping;
27592         void                         *data;
27593         char                         *sort_id;
27594      };
27595
27596    struct _Elm_Store_Item_Info_Filesystem
27597      {
27598         Elm_Store_Item_Info  base;
27599         char                *path;
27600      };
27601
27602 #define ELM_STORE_ITEM_MAPPING_END { ELM_STORE_ITEM_MAPPING_NONE, NULL, 0, { .empty = { EINA_TRUE } } }
27603 #define ELM_STORE_ITEM_MAPPING_OFFSET(st, it) offsetof(st, it)
27604
27605    EAPI void                    elm_store_free(Elm_Store *st);
27606
27607    EAPI Elm_Store              *elm_store_filesystem_new(void);
27608    EAPI void                    elm_store_filesystem_directory_set(Elm_Store *st, const char *dir) EINA_ARG_NONNULL(1);
27609    EAPI const char             *elm_store_filesystem_directory_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27610    EAPI const char             *elm_store_item_filesystem_path_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27611
27612    EAPI void                    elm_store_target_genlist_set(Elm_Store *st, Evas_Object *obj) EINA_ARG_NONNULL(1);
27613
27614    EAPI void                    elm_store_cache_set(Elm_Store *st, int max) EINA_ARG_NONNULL(1);
27615    EAPI int                     elm_store_cache_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27616    EAPI void                    elm_store_list_func_set(Elm_Store *st, Elm_Store_Item_List_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
27617    EAPI void                    elm_store_fetch_func_set(Elm_Store *st, Elm_Store_Item_Fetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
27618    EAPI void                    elm_store_fetch_thread_set(Elm_Store *st, Eina_Bool use_thread) EINA_ARG_NONNULL(1);
27619    EAPI Eina_Bool               elm_store_fetch_thread_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27620
27621    EAPI void                    elm_store_unfetch_func_set(Elm_Store *st, Elm_Store_Item_Unfetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
27622    EAPI void                    elm_store_sorted_set(Elm_Store *st, Eina_Bool sorted) EINA_ARG_NONNULL(1);
27623    EAPI Eina_Bool               elm_store_sorted_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27624    EAPI void                    elm_store_item_data_set(Elm_Store_Item *sti, void *data) EINA_ARG_NONNULL(1);
27625    EAPI void                   *elm_store_item_data_get(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27626    EAPI const Elm_Store        *elm_store_item_store_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27627    EAPI const Elm_Genlist_Item *elm_store_item_genlist_item_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27628
27629    /**
27630     * @defgroup SegmentControl SegmentControl
27631     * @ingroup Elementary
27632     *
27633     * @image html img/widget/segment_control/preview-00.png
27634     * @image latex img/widget/segment_control/preview-00.eps width=\textwidth
27635     *
27636     * @image html img/segment_control.png
27637     * @image latex img/segment_control.eps width=\textwidth
27638     *
27639     * Segment control widget is a horizontal control made of multiple segment
27640     * items, each segment item functioning similar to discrete two state button.
27641     * A segment control groups the items together and provides compact
27642     * single button with multiple equal size segments.
27643     *
27644     * Segment item size is determined by base widget
27645     * size and the number of items added.
27646     * Only one segment item can be at selected state. A segment item can display
27647     * combination of Text and any Evas_Object like Images or other widget.
27648     *
27649     * Smart callbacks one can listen to:
27650     * - "changed" - When the user clicks on a segment item which is not
27651     *   previously selected and get selected. The event_info parameter is the
27652     *   segment item pointer.
27653     *
27654     * Available styles for it:
27655     * - @c "default"
27656     *
27657     * Here is an example on its usage:
27658     * @li @ref segment_control_example
27659     */
27660
27661    /**
27662     * @addtogroup SegmentControl
27663     * @{
27664     */
27665
27666    typedef struct _Elm_Segment_Item Elm_Segment_Item; /**< Item handle for a segment control widget. */
27667
27668    /**
27669     * Add a new segment control widget to the given parent Elementary
27670     * (container) object.
27671     *
27672     * @param parent The parent object.
27673     * @return a new segment control widget handle or @c NULL, on errors.
27674     *
27675     * This function inserts a new segment control widget on the canvas.
27676     *
27677     * @ingroup SegmentControl
27678     */
27679    EAPI Evas_Object      *elm_segment_control_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
27680
27681    /**
27682     * Append a new item to the segment control object.
27683     *
27684     * @param obj The segment control object.
27685     * @param icon The icon object to use for the left side of the item. An
27686     * icon can be any Evas object, but usually it is an icon created
27687     * with elm_icon_add().
27688     * @param label The label of the item.
27689     *        Note that, NULL is different from empty string "".
27690     * @return The created item or @c NULL upon failure.
27691     *
27692     * A new item will be created and appended to the segment control, i.e., will
27693     * be set as @b last item.
27694     *
27695     * If it should be inserted at another position,
27696     * elm_segment_control_item_insert_at() should be used instead.
27697     *
27698     * Items created with this function can be deleted with function
27699     * elm_segment_control_item_del() or elm_segment_control_item_del_at().
27700     *
27701     * @note @p label set to @c NULL is different from empty string "".
27702     * If an item
27703     * only has icon, it will be displayed bigger and centered. If it has
27704     * icon and label, even that an empty string, icon will be smaller and
27705     * positioned at left.
27706     *
27707     * Simple example:
27708     * @code
27709     * sc = elm_segment_control_add(win);
27710     * ic = elm_icon_add(win);
27711     * elm_icon_file_set(ic, "path/to/image", NULL);
27712     * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
27713     * elm_segment_control_item_add(sc, ic, "label");
27714     * evas_object_show(sc);
27715     * @endcode
27716     *
27717     * @see elm_segment_control_item_insert_at()
27718     * @see elm_segment_control_item_del()
27719     *
27720     * @ingroup SegmentControl
27721     */
27722    EAPI Elm_Segment_Item *elm_segment_control_item_add(Evas_Object *obj, Evas_Object *icon, const char *label) EINA_ARG_NONNULL(1);
27723
27724    /**
27725     * Insert a new item to the segment control object at specified position.
27726     *
27727     * @param obj The segment control object.
27728     * @param icon The icon object to use for the left side of the item. An
27729     * icon can be any Evas object, but usually it is an icon created
27730     * with elm_icon_add().
27731     * @param label The label of the item.
27732     * @param index Item position. Value should be between 0 and items count.
27733     * @return The created item or @c NULL upon failure.
27734
27735     * Index values must be between @c 0, when item will be prepended to
27736     * segment control, and items count, that can be get with
27737     * elm_segment_control_item_count_get(), case when item will be appended
27738     * to segment control, just like elm_segment_control_item_add().
27739     *
27740     * Items created with this function can be deleted with function
27741     * elm_segment_control_item_del() or elm_segment_control_item_del_at().
27742     *
27743     * @note @p label set to @c NULL is different from empty string "".
27744     * If an item
27745     * only has icon, it will be displayed bigger and centered. If it has
27746     * icon and label, even that an empty string, icon will be smaller and
27747     * positioned at left.
27748     *
27749     * @see elm_segment_control_item_add()
27750     * @see elm_segment_control_item_count_get()
27751     * @see elm_segment_control_item_del()
27752     *
27753     * @ingroup SegmentControl
27754     */
27755    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);
27756
27757    /**
27758     * Remove a segment control item from its parent, deleting it.
27759     *
27760     * @param it The item to be removed.
27761     *
27762     * Items can be added with elm_segment_control_item_add() or
27763     * elm_segment_control_item_insert_at().
27764     *
27765     * @ingroup SegmentControl
27766     */
27767    EAPI void              elm_segment_control_item_del(Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
27768
27769    /**
27770     * Remove a segment control item at given index from its parent,
27771     * deleting it.
27772     *
27773     * @param obj The segment control object.
27774     * @param index The position of the segment control item to be deleted.
27775     *
27776     * Items can be added with elm_segment_control_item_add() or
27777     * elm_segment_control_item_insert_at().
27778     *
27779     * @ingroup SegmentControl
27780     */
27781    EAPI void              elm_segment_control_item_del_at(Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
27782
27783    /**
27784     * Get the Segment items count from segment control.
27785     *
27786     * @param obj The segment control object.
27787     * @return Segment items count.
27788     *
27789     * It will just return the number of items added to segment control @p obj.
27790     *
27791     * @ingroup SegmentControl
27792     */
27793    EAPI int               elm_segment_control_item_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27794
27795    /**
27796     * Get the item placed at specified index.
27797     *
27798     * @param obj The segment control object.
27799     * @param index The index of the segment item.
27800     * @return The segment control item or @c NULL on failure.
27801     *
27802     * Index is the position of an item in segment control widget. Its
27803     * range is from @c 0 to <tt> count - 1 </tt>.
27804     * Count is the number of items, that can be get with
27805     * elm_segment_control_item_count_get().
27806     *
27807     * @ingroup SegmentControl
27808     */
27809    EAPI Elm_Segment_Item *elm_segment_control_item_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
27810
27811    /**
27812     * Get the label of item.
27813     *
27814     * @param obj The segment control object.
27815     * @param index The index of the segment item.
27816     * @return The label of the item at @p index.
27817     *
27818     * The return value is a pointer to the label associated to the item when
27819     * it was created, with function elm_segment_control_item_add(), or later
27820     * with function elm_segment_control_item_label_set. If no label
27821     * was passed as argument, it will return @c NULL.
27822     *
27823     * @see elm_segment_control_item_label_set() for more details.
27824     * @see elm_segment_control_item_add()
27825     *
27826     * @ingroup SegmentControl
27827     */
27828    EAPI const char       *elm_segment_control_item_label_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
27829
27830    /**
27831     * Set the label of item.
27832     *
27833     * @param it The item of segment control.
27834     * @param text The label of item.
27835     *
27836     * The label to be displayed by the item.
27837     * Label will be at right of the icon (if set).
27838     *
27839     * If a label was passed as argument on item creation, with function
27840     * elm_control_segment_item_add(), it will be already
27841     * displayed by the item.
27842     *
27843     * @see elm_segment_control_item_label_get()
27844     * @see elm_segment_control_item_add()
27845     *
27846     * @ingroup SegmentControl
27847     */
27848    EAPI void              elm_segment_control_item_label_set(Elm_Segment_Item* it, const char* label) EINA_ARG_NONNULL(1);
27849
27850    /**
27851     * Get the icon associated to the item.
27852     *
27853     * @param obj The segment control object.
27854     * @param index The index of the segment item.
27855     * @return The left side icon associated to the item at @p index.
27856     *
27857     * The return value is a pointer to the icon associated to the item when
27858     * it was created, with function elm_segment_control_item_add(), or later
27859     * with function elm_segment_control_item_icon_set(). If no icon
27860     * was passed as argument, it will return @c NULL.
27861     *
27862     * @see elm_segment_control_item_add()
27863     * @see elm_segment_control_item_icon_set()
27864     *
27865     * @ingroup SegmentControl
27866     */
27867    EAPI Evas_Object      *elm_segment_control_item_icon_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
27868
27869    /**
27870     * Set the icon associated to the item.
27871     *
27872     * @param it The segment control item.
27873     * @param icon The icon object to associate with @p it.
27874     *
27875     * The icon object to use at left side of the item. An
27876     * icon can be any Evas object, but usually it is an icon created
27877     * with elm_icon_add().
27878     *
27879     * Once the icon object is set, a previously set one will be deleted.
27880     * @warning Setting the same icon for two items will cause the icon to
27881     * dissapear from the first item.
27882     *
27883     * If an icon was passed as argument on item creation, with function
27884     * elm_segment_control_item_add(), it will be already
27885     * associated to the item.
27886     *
27887     * @see elm_segment_control_item_add()
27888     * @see elm_segment_control_item_icon_get()
27889     *
27890     * @ingroup SegmentControl
27891     */
27892    EAPI void              elm_segment_control_item_icon_set(Elm_Segment_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
27893
27894    /**
27895     * Get the index of an item.
27896     *
27897     * @param it The segment control item.
27898     * @return The position of item in segment control widget.
27899     *
27900     * Index is the position of an item in segment control widget. Its
27901     * range is from @c 0 to <tt> count - 1 </tt>.
27902     * Count is the number of items, that can be get with
27903     * elm_segment_control_item_count_get().
27904     *
27905     * @ingroup SegmentControl
27906     */
27907    EAPI int               elm_segment_control_item_index_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
27908
27909    /**
27910     * Get the base object of the item.
27911     *
27912     * @param it The segment control item.
27913     * @return The base object associated with @p it.
27914     *
27915     * Base object is the @c Evas_Object that represents that item.
27916     *
27917     * @ingroup SegmentControl
27918     */
27919    EAPI Evas_Object      *elm_segment_control_item_object_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
27920
27921    /**
27922     * Get the selected item.
27923     *
27924     * @param obj The segment control object.
27925     * @return The selected item or @c NULL if none of segment items is
27926     * selected.
27927     *
27928     * The selected item can be unselected with function
27929     * elm_segment_control_item_selected_set().
27930     *
27931     * The selected item always will be highlighted on segment control.
27932     *
27933     * @ingroup SegmentControl
27934     */
27935    EAPI Elm_Segment_Item *elm_segment_control_item_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27936
27937    /**
27938     * Set the selected state of an item.
27939     *
27940     * @param it The segment control item
27941     * @param select The selected state
27942     *
27943     * This sets the selected state of the given item @p it.
27944     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
27945     *
27946     * If a new item is selected the previosly selected will be unselected.
27947     * Previoulsy selected item can be get with function
27948     * elm_segment_control_item_selected_get().
27949     *
27950     * The selected item always will be highlighted on segment control.
27951     *
27952     * @see elm_segment_control_item_selected_get()
27953     *
27954     * @ingroup SegmentControl
27955     */
27956    EAPI void              elm_segment_control_item_selected_set(Elm_Segment_Item *it, Eina_Bool select) EINA_ARG_NONNULL(1);
27957
27958    /**
27959     * @}
27960     */
27961
27962    /**
27963     * @defgroup Grid Grid
27964     *
27965     * The grid is a grid layout widget that lays out a series of children as a
27966     * fixed "grid" of widgets using a given percentage of the grid width and
27967     * height each using the child object.
27968     *
27969     * The Grid uses a "Virtual resolution" that is stretched to fill the grid
27970     * widgets size itself. The default is 100 x 100, so that means the
27971     * position and sizes of children will effectively be percentages (0 to 100)
27972     * of the width or height of the grid widget
27973     *
27974     * @{
27975     */
27976
27977    /**
27978     * Add a new grid to the parent
27979     *
27980     * @param parent The parent object
27981     * @return The new object or NULL if it cannot be created
27982     *
27983     * @ingroup Grid
27984     */
27985    EAPI Evas_Object *elm_grid_add(Evas_Object *parent);
27986
27987    /**
27988     * Set the virtual size of the grid
27989     *
27990     * @param obj The grid object
27991     * @param w The virtual width of the grid
27992     * @param h The virtual height of the grid
27993     *
27994     * @ingroup Grid
27995     */
27996    EAPI void         elm_grid_size_set(Evas_Object *obj, int w, int h);
27997
27998    /**
27999     * Get the virtual size of the grid
28000     *
28001     * @param obj The grid object
28002     * @param w Pointer to integer to store the virtual width of the grid
28003     * @param h Pointer to integer to store the virtual height of the grid
28004     *
28005     * @ingroup Grid
28006     */
28007    EAPI void         elm_grid_size_get(Evas_Object *obj, int *w, int *h);
28008
28009    /**
28010     * Pack child at given position and size
28011     *
28012     * @param obj The grid object
28013     * @param subobj The child to pack
28014     * @param x The virtual x coord at which to pack it
28015     * @param y The virtual y coord at which to pack it
28016     * @param w The virtual width at which to pack it
28017     * @param h The virtual height at which to pack it
28018     *
28019     * @ingroup Grid
28020     */
28021    EAPI void         elm_grid_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h);
28022
28023    /**
28024     * Unpack a child from a grid object
28025     *
28026     * @param obj The grid object
28027     * @param subobj The child to unpack
28028     *
28029     * @ingroup Grid
28030     */
28031    EAPI void         elm_grid_unpack(Evas_Object *obj, Evas_Object *subobj);
28032
28033    /**
28034     * Faster way to remove all child objects from a grid object.
28035     *
28036     * @param obj The grid object
28037     * @param clear If true, it will delete just removed children
28038     *
28039     * @ingroup Grid
28040     */
28041    EAPI void         elm_grid_clear(Evas_Object *obj, Eina_Bool clear);
28042
28043    /**
28044     * Set packing of an existing child at to position and size
28045     *
28046     * @param subobj The child to set packing of
28047     * @param x The virtual x coord at which to pack it
28048     * @param y The virtual y coord at which to pack it
28049     * @param w The virtual width at which to pack it
28050     * @param h The virtual height at which to pack it
28051     *
28052     * @ingroup Grid
28053     */
28054    EAPI void         elm_grid_pack_set(Evas_Object *subobj, int x, int y, int w, int h);
28055
28056    /**
28057     * get packing of a child
28058     *
28059     * @param subobj The child to query
28060     * @param x Pointer to integer to store the virtual x coord
28061     * @param y Pointer to integer to store the virtual y coord
28062     * @param w Pointer to integer to store the virtual width
28063     * @param h Pointer to integer to store the virtual height
28064     *
28065     * @ingroup Grid
28066     */
28067    EAPI void         elm_grid_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h);
28068
28069    /**
28070     * @}
28071     */
28072
28073    EAPI Evas_Object *elm_factory_add(Evas_Object *parent);
28074    EINA_DEPRECATED EAPI void         elm_factory_content_set(Evas_Object *obj, Evas_Object *content);
28075    EINA_DEPRECATED EAPI Evas_Object *elm_factory_content_get(const Evas_Object *obj);
28076    EAPI void         elm_factory_maxmin_mode_set(Evas_Object *obj, Eina_Bool enabled);
28077    EAPI Eina_Bool    elm_factory_maxmin_mode_get(const Evas_Object *obj);
28078    EAPI void         elm_factory_maxmin_reset_set(Evas_Object *obj);
28079
28080    /**
28081     * @defgroup Video Video
28082     *
28083     * @addtogroup Video
28084     * @{
28085     *
28086     * Elementary comes with two object that help design application that need
28087     * to display video. The main one, Elm_Video, display a video by using Emotion.
28088     * It does embedded the video inside an Edje object, so you can do some
28089     * animation depending on the video state change. It does also implement a
28090     * ressource management policy to remove this burden from the application writer.
28091     *
28092     * The second one, Elm_Player is a video player that need to be linked with and Elm_Video.
28093     * It take care of updating its content according to Emotion event and provide a
28094     * way to theme itself. It also does automatically raise the priority of the
28095     * linked Elm_Video so it will use the video decoder if available. It also does
28096     * activate the remember function on the linked Elm_Video object.
28097     *
28098     * Signals that you can add callback for are :
28099     *
28100     * "forward,clicked" - the user clicked the forward button.
28101     * "info,clicked" - the user clicked the info button.
28102     * "next,clicked" - the user clicked the next button.
28103     * "pause,clicked" - the user clicked the pause button.
28104     * "play,clicked" - the user clicked the play button.
28105     * "prev,clicked" - the user clicked the prev button.
28106     * "rewind,clicked" - the user clicked the rewind button.
28107     * "stop,clicked" - the user clicked the stop button.
28108     * 
28109     * To set the video of the player, you can use elm_object_content_set() API.
28110     * 
28111     */
28112
28113    /**
28114     * @brief Add a new Elm_Player object to the given parent Elementary (container) object.
28115     *
28116     * @param parent The parent object
28117     * @return a new player widget handle or @c NULL, on errors.
28118     *
28119     * This function inserts a new player widget on the canvas.
28120     *
28121     * @see elm_object_content_set()
28122     *
28123     * @ingroup Video
28124     */
28125    EAPI Evas_Object *elm_player_add(Evas_Object *parent);
28126
28127    /**
28128     * @brief Link a Elm_Payer with an Elm_Video object.
28129     *
28130     * @param player the Elm_Player object.
28131     * @param video The Elm_Video object.
28132     *
28133     * This mean that action on the player widget will affect the
28134     * video object and the state of the video will be reflected in
28135     * the player itself.
28136     *
28137     * @see elm_player_add()
28138     * @see elm_video_add()
28139     *
28140     * @ingroup Video
28141     */
28142    EINA_DEPRECATED EAPI void elm_player_video_set(Evas_Object *player, Evas_Object *video);
28143
28144    /**
28145     * @brief Add a new Elm_Video object to the given parent Elementary (container) object.
28146     *
28147     * @param parent The parent object
28148     * @return a new video widget handle or @c NULL, on errors.
28149     *
28150     * This function inserts a new video widget on the canvas.
28151     *
28152     * @seeelm_video_file_set()
28153     * @see elm_video_uri_set()
28154     *
28155     * @ingroup Video
28156     */
28157    EAPI Evas_Object *elm_video_add(Evas_Object *parent);
28158
28159    /**
28160     * @brief Define the file that will be the video source.
28161     *
28162     * @param video The video object to define the file for.
28163     * @param filename The file to target.
28164     *
28165     * This function will explicitly define a filename as a source
28166     * for the video of the Elm_Video object.
28167     *
28168     * @see elm_video_uri_set()
28169     * @see elm_video_add()
28170     * @see elm_player_add()
28171     *
28172     * @ingroup Video
28173     */
28174    EAPI void elm_video_file_set(Evas_Object *video, const char *filename);
28175
28176    /**
28177     * @brief Define the uri that will be the video source.
28178     *
28179     * @param video The video object to define the file for.
28180     * @param uri The uri to target.
28181     *
28182     * This function will define an uri as a source for the video of the
28183     * Elm_Video object. URI could be remote source of video, like http:// or local source
28184     * like for example WebCam who are most of the time v4l2:// (but that depend and
28185     * you should use Emotion API to request and list the available Webcam on your system).
28186     *
28187     * @see elm_video_file_set()
28188     * @see elm_video_add()
28189     * @see elm_player_add()
28190     *
28191     * @ingroup Video
28192     */
28193    EAPI void elm_video_uri_set(Evas_Object *video, const char *uri);
28194
28195    /**
28196     * @brief Get the underlying Emotion object.
28197     *
28198     * @param video The video object to proceed the request on.
28199     * @return the underlying Emotion object.
28200     *
28201     * @ingroup Video
28202     */
28203    EAPI Evas_Object *elm_video_emotion_get(const Evas_Object *video);
28204
28205    /**
28206     * @brief Start to play the video
28207     *
28208     * @param video The video object to proceed the request on.
28209     *
28210     * Start to play the video and cancel all suspend state.
28211     *
28212     * @ingroup Video
28213     */
28214    EAPI void elm_video_play(Evas_Object *video);
28215
28216    /**
28217     * @brief Pause the video
28218     *
28219     * @param video The video object to proceed the request on.
28220     *
28221     * Pause the video and start a timer to trigger suspend mode.
28222     *
28223     * @ingroup Video
28224     */
28225    EAPI void elm_video_pause(Evas_Object *video);
28226
28227    /**
28228     * @brief Stop the video
28229     *
28230     * @param video The video object to proceed the request on.
28231     *
28232     * Stop the video and put the emotion in deep sleep mode.
28233     *
28234     * @ingroup Video
28235     */
28236    EAPI void elm_video_stop(Evas_Object *video);
28237
28238    /**
28239     * @brief Is the video actually playing.
28240     *
28241     * @param video The video object to proceed the request on.
28242     * @return EINA_TRUE if the video is actually playing.
28243     *
28244     * You should consider watching event on the object instead of polling
28245     * the object state.
28246     *
28247     * @ingroup Video
28248     */
28249    EAPI Eina_Bool elm_video_is_playing(const Evas_Object *video);
28250
28251    /**
28252     * @brief Is it possible to seek inside the video.
28253     *
28254     * @param video The video object to proceed the request on.
28255     * @return EINA_TRUE if is possible to seek inside the video.
28256     *
28257     * @ingroup Video
28258     */
28259    EAPI Eina_Bool elm_video_is_seekable(const Evas_Object *video);
28260
28261    /**
28262     * @brief Is the audio muted.
28263     *
28264     * @param video The video object to proceed the request on.
28265     * @return EINA_TRUE if the audio is muted.
28266     *
28267     * @ingroup Video
28268     */
28269    EAPI Eina_Bool elm_video_audio_mute_get(const Evas_Object *video);
28270
28271    /**
28272     * @brief Change the mute state of the Elm_Video object.
28273     *
28274     * @param video The video object to proceed the request on.
28275     * @param mute The new mute state.
28276     *
28277     * @ingroup Video
28278     */
28279    EAPI void elm_video_audio_mute_set(Evas_Object *video, Eina_Bool mute);
28280
28281    /**
28282     * @brief Get the audio level of the current video.
28283     *
28284     * @param video The video object to proceed the request on.
28285     * @return the current audio level.
28286     *
28287     * @ingroup Video
28288     */
28289    EAPI double elm_video_audio_level_get(const Evas_Object *video);
28290
28291    /**
28292     * @brief Set the audio level of anElm_Video object.
28293     *
28294     * @param video The video object to proceed the request on.
28295     * @param volume The new audio volume.
28296     *
28297     * @ingroup Video
28298     */
28299    EAPI void elm_video_audio_level_set(Evas_Object *video, double volume);
28300
28301    EAPI double elm_video_play_position_get(const Evas_Object *video);
28302    EAPI void elm_video_play_position_set(Evas_Object *video, double position);
28303    EAPI double elm_video_play_length_get(const Evas_Object *video);
28304    EAPI void elm_video_remember_position_set(Evas_Object *video, Eina_Bool remember);
28305    EAPI Eina_Bool elm_video_remember_position_get(const Evas_Object *video);
28306    EAPI const char *elm_video_title_get(const Evas_Object *video);
28307    /**
28308     * @}
28309     */
28310
28311    /**
28312     * @defgroup Naviframe Naviframe
28313     * @ingroup Elementary
28314     *
28315     * @brief Naviframe is a kind of view manager for the applications.
28316     *
28317     * Naviframe provides functions to switch different pages with stack
28318     * mechanism. It means if one page(item) needs to be changed to the new one,
28319     * then naviframe would push the new page to it's internal stack. Of course,
28320     * it can be back to the previous page by popping the top page. Naviframe
28321     * provides some transition effect while the pages are switching (same as
28322     * pager).
28323     *
28324     * Since each item could keep the different styles, users could keep the
28325     * same look & feel for the pages or different styles for the items in it's
28326     * application.
28327     *
28328     * Signals that you can add callback for are:
28329     * @li "transition,finished" - When the transition is finished in changing
28330     *     the item
28331     * @li "title,clicked" - User clicked title area
28332     *
28333     * Default contents parts of the naviframe items that you can use for are:
28334     * @li "elm.swallow.content" - A main content of the page
28335     * @li "elm.swallow.icon" - A icon in the title area
28336     * @li "elm.swallow.prev_btn" - A button to go to the previous page
28337     * @li "elm.swallow.next_btn" - A button to go to the next page
28338     *
28339     * Default text parts of the naviframe items that you can use for are:
28340     * @li "elm.text.title" - Title label in the title area
28341     * @li "elm.text.subtitle" - Sub-title label in the title area
28342     *
28343     * @ref tutorial_naviframe gives a good overview of the usage of the API.
28344     */
28345
28346 #define ELM_NAVIFRAME_ITEM_CONTENT_ICON "elm.swallow.icon"
28347 #define ELM_NAVIFRAME_ITEM_CONTENT_PREV_BTN "elm.swallow.prev_btn"
28348 #define ELM_NAVIFRAME_ITEM_CONTNET_NEXT_BTN "elm.swallow.next_btn"
28349 #define ELM_NAVIFRAME_ITEM_TEXT_SUBTITLE "elm.text.subtitle"
28350
28351    /**
28352     * @addtogroup Naviframe
28353     * @{
28354     */
28355
28356    /**
28357     * @brief Add a new Naviframe object to the parent.
28358     *
28359     * @param parent Parent object
28360     * @return New object or @c NULL, if it cannot be created
28361     *
28362     * @ingroup Naviframe
28363     */
28364    EAPI Evas_Object        *elm_naviframe_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
28365    /**
28366     * @brief Push a new item to the top of the naviframe stack (and show it).
28367     *
28368     * @param obj The naviframe object
28369     * @param title_label The label in the title area. The name of the title
28370     *        label part is "elm.text.title"
28371     * @param prev_btn The button to go to the previous item. If it is NULL,
28372     *        then naviframe will create a back button automatically. The name of
28373     *        the prev_btn part is "elm.swallow.prev_btn"
28374     * @param next_btn The button to go to the next item. Or It could be just an
28375     *        extra function button. The name of the next_btn part is
28376     *        "elm.swallow.next_btn"
28377     * @param content The main content object. The name of content part is
28378     *        "elm.swallow.content"
28379     * @param item_style The current item style name. @c NULL would be default.
28380     * @return The created item or @c NULL upon failure.
28381     *
28382     * The item pushed becomes one page of the naviframe, this item will be
28383     * deleted when it is popped.
28384     *
28385     * @see also elm_naviframe_item_style_set()
28386     * @see also elm_naviframe_item_insert_before()
28387     * @see also elm_naviframe_item_insert_after()
28388     *
28389     * The following styles are available for this item:
28390     * @li @c "default"
28391     *
28392     * @ingroup Naviframe
28393     */
28394    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);
28395     /**
28396     * @brief Insert a new item into the naviframe before item @p before.
28397     *
28398     * @param before The naviframe item to insert before.
28399     * @param title_label The label in the title area. The name of the title
28400     *        label part is "elm.text.title"
28401     * @param prev_btn The button to go to the previous item. If it is NULL,
28402     *        then naviframe will create a back button automatically. The name of
28403     *        the prev_btn part is "elm.swallow.prev_btn"
28404     * @param next_btn The button to go to the next item. Or It could be just an
28405     *        extra function button. The name of the next_btn part is
28406     *        "elm.swallow.next_btn"
28407     * @param content The main content object. The name of content part is
28408     *        "elm.swallow.content"
28409     * @param item_style The current item style name. @c NULL would be default.
28410     * @return The created item or @c NULL upon failure.
28411     *
28412     * The item is inserted into the naviframe straight away without any 
28413     * transition operations. This item will be deleted when it is popped. 
28414     *
28415     * @see also elm_naviframe_item_style_set()
28416     * @see also elm_naviframe_item_push()
28417     * @see also elm_naviframe_item_insert_after()
28418     *
28419     * The following styles are available for this item:
28420     * @li @c "default"
28421     *
28422     * @ingroup Naviframe
28423     */
28424    EAPI Elm_Object_Item    *elm_naviframe_item_insert_before(Elm_Object_Item *before, const char *title_label, Evas_Object *prev_btn, Evas_Object *next_btn, Evas_Object *content, const char *item_style) EINA_ARG_NONNULL(1, 5);
28425    /**
28426     * @brief Insert a new item into the naviframe after item @p after.
28427     *
28428     * @param after The naviframe item to insert after.
28429     * @param title_label The label in the title area. The name of the title
28430     *        label part is "elm.text.title"
28431     * @param prev_btn The button to go to the previous item. If it is NULL,
28432     *        then naviframe will create a back button automatically. The name of
28433     *        the prev_btn part is "elm.swallow.prev_btn"
28434     * @param next_btn The button to go to the next item. Or It could be just an
28435     *        extra function button. The name of the next_btn part is
28436     *        "elm.swallow.next_btn"
28437     * @param content The main content object. The name of content part is
28438     *        "elm.swallow.content"
28439     * @param item_style The current item style name. @c NULL would be default.
28440     * @return The created item or @c NULL upon failure.
28441     *
28442     * The item is inserted into the naviframe straight away without any 
28443     * transition operations. This item will be deleted when it is popped. 
28444     *
28445     * @see also elm_naviframe_item_style_set()
28446     * @see also elm_naviframe_item_push()
28447     * @see also elm_naviframe_item_insert_before()
28448     *
28449     * The following styles are available for this item:
28450     * @li @c "default"
28451     *
28452     * @ingroup Naviframe
28453     */
28454    EAPI Elm_Object_Item    *elm_naviframe_item_insert_after(Elm_Object_Item *after, const char *title_label, Evas_Object *prev_btn, Evas_Object *next_btn, Evas_Object *content, const char *item_style) EINA_ARG_NONNULL(1, 5);
28455    /**
28456     * @brief Pop an item that is on top of the stack
28457     *
28458     * @param obj The naviframe object
28459     * @return @c NULL or the content object(if the
28460     *         elm_naviframe_content_preserve_on_pop_get is true).
28461     *
28462     * This pops an item that is on the top(visible) of the naviframe, makes it
28463     * disappear, then deletes the item. The item that was underneath it on the
28464     * stack will become visible.
28465     *
28466     * @see also elm_naviframe_content_preserve_on_pop_get()
28467     *
28468     * @ingroup Naviframe
28469     */
28470    EAPI Evas_Object        *elm_naviframe_item_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
28471    /**
28472     * @brief Pop the items between the top and the above one on the given item.
28473     *
28474     * @param it The naviframe item
28475     *
28476     * @ingroup Naviframe
28477     */
28478    EAPI void                elm_naviframe_item_pop_to(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28479    /**
28480    * Promote an item already in the naviframe stack to the top of the stack
28481    *
28482    * @param it The naviframe item
28483    *
28484    * This will take the indicated item and promote it to the top of the stack
28485    * as if it had been pushed there. The item must already be inside the
28486    * naviframe stack to work.
28487    *
28488    */
28489    EAPI void                elm_naviframe_item_promote(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28490    /**
28491     * @brief Delete the given item instantly.
28492     *
28493     * @param it The naviframe item
28494     *
28495     * This just deletes the given item from the naviframe item list instantly.
28496     * So this would not emit any signals for view transitions but just change
28497     * the current view if the given item is a top one.
28498     *
28499     * @ingroup Naviframe
28500     */
28501    EAPI void                elm_naviframe_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28502    /**
28503     * @brief preserve the content objects when items are popped.
28504     *
28505     * @param obj The naviframe object
28506     * @param preserve Enable the preserve mode if EINA_TRUE, disable otherwise
28507     *
28508     * @see also elm_naviframe_content_preserve_on_pop_get()
28509     *
28510     * @ingroup Naviframe
28511     */
28512    EAPI void                elm_naviframe_content_preserve_on_pop_set(Evas_Object *obj, Eina_Bool preserve) EINA_ARG_NONNULL(1);
28513    /**
28514     * @brief Get a value whether preserve mode is enabled or not.
28515     *
28516     * @param obj The naviframe object
28517     * @return If @c EINA_TRUE, preserve mode is enabled
28518     *
28519     * @see also elm_naviframe_content_preserve_on_pop_set()
28520     *
28521     * @ingroup Naviframe
28522     */
28523    EAPI Eina_Bool           elm_naviframe_content_preserve_on_pop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28524    /**
28525     * @brief Get a top item on the naviframe stack
28526     *
28527     * @param obj The naviframe object
28528     * @return The top item on the naviframe stack or @c NULL, if the stack is
28529     *         empty
28530     *
28531     * @ingroup Naviframe
28532     */
28533    EAPI Elm_Object_Item    *elm_naviframe_top_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28534    /**
28535     * @brief Get a bottom item on the naviframe stack
28536     *
28537     * @param obj The naviframe object
28538     * @return The bottom item on the naviframe stack or @c NULL, if the stack is
28539     *         empty
28540     *
28541     * @ingroup Naviframe
28542     */
28543    EAPI Elm_Object_Item    *elm_naviframe_bottom_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28544    /**
28545     * @brief Set an item style
28546     *
28547     * @param obj The naviframe item
28548     * @param item_style The current item style name. @c NULL would be default
28549     *
28550     * The following styles are available for this item:
28551     * @li @c "default"
28552     *
28553     * @see also elm_naviframe_item_style_get()
28554     *
28555     * @ingroup Naviframe
28556     */
28557    EAPI void                elm_naviframe_item_style_set(Elm_Object_Item *it, const char *item_style) EINA_ARG_NONNULL(1);
28558    /**
28559     * @brief Get an item style
28560     *
28561     * @param obj The naviframe item
28562     * @return The current item style name
28563     *
28564     * @see also elm_naviframe_item_style_set()
28565     *
28566     * @ingroup Naviframe
28567     */
28568    EAPI const char         *elm_naviframe_item_style_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28569    /**
28570     * @brief Show/Hide the title area
28571     *
28572     * @param it The naviframe item
28573     * @param visible If @c EINA_TRUE, title area will be visible, hidden
28574     *        otherwise
28575     *
28576     * When the title area is invisible, then the controls would be hidden so as     * to expand the content area to full-size.
28577     *
28578     * @see also elm_naviframe_item_title_visible_get()
28579     *
28580     * @ingroup Naviframe
28581     */
28582    EAPI void                elm_naviframe_item_title_visible_set(Elm_Object_Item *it, Eina_Bool visible) EINA_ARG_NONNULL(1);
28583    /**
28584     * @brief Get a value whether title area is visible or not.
28585     *
28586     * @param it The naviframe item
28587     * @return If @c EINA_TRUE, title area is visible
28588     *
28589     * @see also elm_naviframe_item_title_visible_set()
28590     *
28591     * @ingroup Naviframe
28592     */
28593    EAPI Eina_Bool           elm_naviframe_item_title_visible_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28594
28595    /**
28596     * @brief Set creating prev button automatically or not
28597     *
28598     * @param obj The naviframe object
28599     * @param auto_pushed If @c EINA_TRUE, the previous button(back button) will
28600     *        be created internally when you pass the @c NULL to the prev_btn
28601     *        parameter in elm_naviframe_item_push
28602     *
28603     * @see also elm_naviframe_item_push()
28604     */
28605    EAPI void                elm_naviframe_prev_btn_auto_pushed_set(Evas_Object *obj, Eina_Bool auto_pushed) EINA_ARG_NONNULL(1);
28606    /**
28607     * @brief Get a value whether prev button(back button) will be auto pushed or
28608     *        not.
28609     *
28610     * @param obj The naviframe object
28611     * @return If @c EINA_TRUE, prev button will be auto pushed.
28612     *
28613     * @see also elm_naviframe_item_push()
28614     *           elm_naviframe_prev_btn_auto_pushed_set()
28615     */
28616    EAPI Eina_Bool           elm_naviframe_prev_btn_auto_pushed_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28617    /**
28618     * @brief Get a list of all the naviframe items.
28619     *
28620     * @param obj The naviframe object
28621     * @return An Eina_Inlist* of naviframe items, #Elm_Object_Item,
28622     * or @c NULL on failure.
28623     */
28624    EAPI Eina_Inlist        *elm_naviframe_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28625
28626    /**
28627     * @}
28628     */
28629
28630 #ifdef __cplusplus
28631 }
28632 #endif
28633
28634 #endif