84a9154ad8f1734ec6609b863bff560dfd0ade74
[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_EMAP_DEF@ ELM_EMAP
316 @ELM_DEBUG_DEF@ ELM_DEBUG
317 @ELM_ALLOCA_H_DEF@ ELM_ALLOCA_H
318 @ELM_LIBINTL_H_DEF@ ELM_LIBINTL_H
319
320 /* Standard headers for standard system calls etc. */
321 #include <stdio.h>
322 #include <stdlib.h>
323 #include <unistd.h>
324 #include <string.h>
325 #include <sys/types.h>
326 #include <sys/stat.h>
327 #include <sys/time.h>
328 #include <sys/param.h>
329 #include <dlfcn.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
418 /* allow usage from c++ */
419 #ifdef __cplusplus
420 extern "C" {
421 #endif
422
423 #define ELM_VERSION_MAJOR @VMAJ@
424 #define ELM_VERSION_MINOR @VMIN@
425
426    typedef struct _Elm_Version
427      {
428         int major;
429         int minor;
430         int micro;
431         int revision;
432      } Elm_Version;
433
434    EAPI extern Elm_Version *elm_version;
435
436 /* handy macros */
437 #define ELM_RECTS_INTERSECT(x, y, w, h, xx, yy, ww, hh) (((x) < ((xx) + (ww))) && ((y) < ((yy) + (hh))) && (((x) + (w)) > (xx)) && (((y) + (h)) > (yy)))
438 #define ELM_PI 3.14159265358979323846
439
440    /**
441     * @defgroup General General
442     *
443     * @brief General Elementary API. Functions that don't relate to
444     * Elementary objects specifically.
445     *
446     * Here are documented functions which init/shutdown the library,
447     * that apply to generic Elementary objects, that deal with
448     * configuration, et cetera.
449     *
450     * @ref general_functions_example_page "This" example contemplates
451     * some of these functions.
452     */
453
454    /**
455     * @addtogroup General
456     * @{
457     */
458
459   /**
460    * Defines couple of standard Evas_Object layers to be used
461    * with evas_object_layer_set().
462    *
463    * @note whenever extending with new values, try to keep some padding
464    *       to siblings so there is room for further extensions.
465    */
466   typedef enum _Elm_Object_Layer
467     {
468        ELM_OBJECT_LAYER_BACKGROUND = EVAS_LAYER_MIN + 64, /**< where to place backgrounds */
469        ELM_OBJECT_LAYER_DEFAULT = 0, /**< Evas_Object default layer (and thus for Elementary) */
470        ELM_OBJECT_LAYER_FOCUS = EVAS_LAYER_MAX - 128, /**< where focus object visualization is */
471        ELM_OBJECT_LAYER_TOOLTIP = EVAS_LAYER_MAX - 64, /**< where to show tooltips */
472        ELM_OBJECT_LAYER_CURSOR = EVAS_LAYER_MAX - 32, /**< where to show cursors */
473        ELM_OBJECT_LAYER_LAST /**< last layer known by Elementary */
474     } Elm_Object_Layer;
475
476 /**************************************************************************/
477    EAPI extern int ELM_ECORE_EVENT_ETHUMB_CONNECT;
478
479    /**
480     * Emitted when any Elementary's policy value is changed.
481     */
482    EAPI extern int ELM_EVENT_POLICY_CHANGED;
483
484    /**
485     * @typedef Elm_Event_Policy_Changed
486     *
487     * Data on the event when an Elementary policy has changed
488     */
489     typedef struct _Elm_Event_Policy_Changed Elm_Event_Policy_Changed;
490
491    /**
492     * @struct _Elm_Event_Policy_Changed
493     *
494     * Data on the event when an Elementary policy has changed
495     */
496     struct _Elm_Event_Policy_Changed
497      {
498         unsigned int policy; /**< the policy identifier */
499         int          new_value; /**< value the policy had before the change */
500         int          old_value; /**< new value the policy got */
501     };
502
503    /**
504     * Policy identifiers.
505     */
506     typedef enum _Elm_Policy
507     {
508         ELM_POLICY_QUIT, /**< under which circumstances the application
509                           * should quit automatically. @see
510                           * Elm_Policy_Quit.
511                           */
512         ELM_POLICY_LAST
513     } Elm_Policy; /**< Elementary policy identifiers/groups enumeration.  @see elm_policy_set()
514  */
515
516    typedef enum _Elm_Policy_Quit
517      {
518         ELM_POLICY_QUIT_NONE = 0, /**< never quit the application
519                                    * automatically */
520         ELM_POLICY_QUIT_LAST_WINDOW_CLOSED /**< quit when the
521                                             * application's last
522                                             * window is closed */
523      } Elm_Policy_Quit; /**< Possible values for the #ELM_POLICY_QUIT policy */
524
525    typedef enum _Elm_Focus_Direction
526      {
527         ELM_FOCUS_PREVIOUS,
528         ELM_FOCUS_NEXT
529      } Elm_Focus_Direction;
530
531    typedef enum _Elm_Text_Format
532      {
533         ELM_TEXT_FORMAT_PLAIN_UTF8,
534         ELM_TEXT_FORMAT_MARKUP_UTF8
535      } Elm_Text_Format;
536
537    /**
538     * Line wrapping types.
539     */
540    typedef enum _Elm_Wrap_Type
541      {
542         ELM_WRAP_NONE = 0, /**< No wrap - value is zero */
543         ELM_WRAP_CHAR, /**< Char wrap - wrap between characters */
544         ELM_WRAP_WORD, /**< Word wrap - wrap in allowed wrapping points (as defined in the unicode standard) */
545         ELM_WRAP_MIXED, /**< Mixed wrap - Word wrap, and if that fails, char wrap. */
546         ELM_WRAP_LAST
547      } Elm_Wrap_Type;
548
549    typedef enum
550      {
551         ELM_INPUT_PANEL_LAYOUT_NORMAL,          /**< Default layout */
552         ELM_INPUT_PANEL_LAYOUT_NUMBER,          /**< Number layout */
553         ELM_INPUT_PANEL_LAYOUT_EMAIL,           /**< Email layout */
554         ELM_INPUT_PANEL_LAYOUT_URL,             /**< URL layout */
555         ELM_INPUT_PANEL_LAYOUT_PHONENUMBER,     /**< Phone Number layout */
556         ELM_INPUT_PANEL_LAYOUT_IP,              /**< IP layout */
557         ELM_INPUT_PANEL_LAYOUT_MONTH,           /**< Month layout */
558         ELM_INPUT_PANEL_LAYOUT_NUMBERONLY,      /**< Number Only layout */
559         ELM_INPUT_PANEL_LAYOUT_INVALID
560      } Elm_Input_Panel_Layout;
561
562    typedef enum
563      {
564         ELM_AUTOCAPITAL_TYPE_NONE,
565         ELM_AUTOCAPITAL_TYPE_WORD,
566         ELM_AUTOCAPITAL_TYPE_SENTENCE,
567         ELM_AUTOCAPITAL_TYPE_ALLCHARACTER,
568      } Elm_Autocapital_Type;
569
570    /**
571     * @typedef Elm_Object_Item
572     * An Elementary Object item handle.
573     * @ingroup General
574     */
575    typedef struct _Elm_Object_Item Elm_Object_Item;
576
577
578    /**
579     * Called back when a widget's tooltip is activated and needs content.
580     * @param data user-data given to elm_object_tooltip_content_cb_set()
581     * @param obj owner widget.
582     */
583    typedef Evas_Object *(*Elm_Tooltip_Content_Cb) (void *data, Evas_Object *obj);
584
585    /**
586     * Called back when a widget's item tooltip is activated and needs content.
587     * @param data user-data given to elm_object_tooltip_content_cb_set()
588     * @param obj owner widget.
589     * @param item context dependent item. As an example, if tooltip was
590     *        set on Elm_List_Item, then it is of this type.
591     */
592    typedef Evas_Object *(*Elm_Tooltip_Item_Content_Cb) (void *data, Evas_Object *obj, void *item);
593
594    typedef Eina_Bool (*Elm_Event_Cb) (void *data, Evas_Object *obj, Evas_Object *src, Evas_Callback_Type type, void *event_info);
595
596 #ifndef ELM_LIB_QUICKLAUNCH
597 #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 */
598 #else
599 #define ELM_MAIN() int main(int argc, char **argv) {return elm_quicklaunch_fallback(argc, argv);} /**< macro to be used after the elm_main() function */
600 #endif
601
602 /**************************************************************************/
603    /* General calls */
604
605    /**
606     * Initialize Elementary
607     *
608     * @param[in] argc System's argument count value
609     * @param[in] argv System's pointer to array of argument strings
610     * @return The init counter value.
611     *
612     * This function initializes Elementary and increments a counter of
613     * the number of calls to it. It returns the new counter's value.
614     *
615     * @warning This call is exported only for use by the @c ELM_MAIN()
616     * macro. There is no need to use this if you use this macro (which
617     * is highly advisable). An elm_main() should contain the entry
618     * point code for your application, having the same prototype as
619     * elm_init(), and @b not being static (putting the @c EAPI symbol
620     * in front of its type declaration is advisable). The @c
621     * ELM_MAIN() call should be placed just after it.
622     *
623     * Example:
624     * @dontinclude bg_example_01.c
625     * @skip static void
626     * @until ELM_MAIN
627     *
628     * See the full @ref bg_example_01_c "example".
629     *
630     * @see elm_shutdown().
631     * @ingroup General
632     */
633    EAPI int          elm_init(int argc, char **argv);
634
635    /**
636     * Shut down Elementary
637     *
638     * @return The init counter value.
639     *
640     * This should be called at the end of your application, just
641     * before it ceases to do any more processing. This will clean up
642     * any permanent resources your application may have allocated via
643     * Elementary that would otherwise persist.
644     *
645     * @see elm_init() for an example
646     *
647     * @ingroup General
648     */
649    EAPI int          elm_shutdown(void);
650
651    /**
652     * Run Elementary's main loop
653     *
654     * This call should be issued just after all initialization is
655     * completed. This function will not return until elm_exit() is
656     * called. It will keep looping, running the main
657     * (event/processing) loop for Elementary.
658     *
659     * @see elm_init() for an example
660     *
661     * @ingroup General
662     */
663    EAPI void         elm_run(void);
664
665    /**
666     * Exit Elementary's main loop
667     *
668     * If this call is issued, it will flag the main loop to cease
669     * processing and return back to its parent function (usually your
670     * elm_main() function).
671     *
672     * @see elm_init() for an example. There, just after a request to
673     * close the window comes, the main loop will be left.
674     *
675     * @note By using the appropriate #ELM_POLICY_QUIT on your Elementary
676     * applications, you'll be able to get this function called automatically for you.
677     *
678     * @ingroup General
679     */
680    EAPI void         elm_exit(void);
681
682    /**
683     * Provide information in order to make Elementary determine the @b
684     * run time location of the software in question, so other data files
685     * such as images, sound files, executable utilities, libraries,
686     * modules and locale files can be found.
687     *
688     * @param mainfunc This is your application's main function name,
689     *        whose binary's location is to be found. Providing @c NULL
690     *        will make Elementary not to use it
691     * @param dom This will be used as the application's "domain", in the
692     *        form of a prefix to any environment variables that may
693     *        override prefix detection and the directory name, inside the
694     *        standard share or data directories, where the software's
695     *        data files will be looked for.
696     * @param checkfile This is an (optional) magic file's path to check
697     *        for existence (and it must be located in the data directory,
698     *        under the share directory provided above). Its presence will
699     *        help determine the prefix found was correct. Pass @c NULL if
700     *        the check is not to be done.
701     *
702     * This function allows one to re-locate the application somewhere
703     * else after compilation, if the developer wishes for easier
704     * distribution of pre-compiled binaries.
705     *
706     * The prefix system is designed to locate where the given software is
707     * installed (under a common path prefix) at run time and then report
708     * specific locations of this prefix and common directories inside
709     * this prefix like the binary, library, data and locale directories,
710     * through the @c elm_app_*_get() family of functions.
711     *
712     * Call elm_app_info_set() early on before you change working
713     * directory or anything about @c argv[0], so it gets accurate
714     * information.
715     *
716     * It will then try and trace back which file @p mainfunc comes from,
717     * if provided, to determine the application's prefix directory.
718     *
719     * The @p dom parameter provides a string prefix to prepend before
720     * environment variables, allowing a fallback to @b specific
721     * environment variables to locate the software. You would most
722     * probably provide a lowercase string there, because it will also
723     * serve as directory domain, explained next. For environment
724     * variables purposes, this string is made uppercase. For example if
725     * @c "myapp" is provided as the prefix, then the program would expect
726     * @c "MYAPP_PREFIX" as a master environment variable to specify the
727     * exact install prefix for the software, or more specific environment
728     * variables like @c "MYAPP_BIN_DIR", @c "MYAPP_LIB_DIR", @c
729     * "MYAPP_DATA_DIR" and @c "MYAPP_LOCALE_DIR", which could be set by
730     * the user or scripts before launching. If not provided (@c NULL),
731     * environment variables will not be used to override compiled-in
732     * defaults or auto detections.
733     *
734     * The @p dom string also provides a subdirectory inside the system
735     * shared data directory for data files. For example, if the system
736     * directory is @c /usr/local/share, then this directory name is
737     * appended, creating @c /usr/local/share/myapp, if it @p was @c
738     * "myapp". It is expected that the application installs data files in
739     * this directory.
740     *
741     * The @p checkfile is a file name or path of something inside the
742     * share or data directory to be used to test that the prefix
743     * detection worked. For example, your app will install a wallpaper
744     * image as @c /usr/local/share/myapp/images/wallpaper.jpg and so to
745     * check that this worked, provide @c "images/wallpaper.jpg" as the @p
746     * checkfile string.
747     *
748     * @see elm_app_compile_bin_dir_set()
749     * @see elm_app_compile_lib_dir_set()
750     * @see elm_app_compile_data_dir_set()
751     * @see elm_app_compile_locale_set()
752     * @see elm_app_prefix_dir_get()
753     * @see elm_app_bin_dir_get()
754     * @see elm_app_lib_dir_get()
755     * @see elm_app_data_dir_get()
756     * @see elm_app_locale_dir_get()
757     */
758    EAPI void         elm_app_info_set(void *mainfunc, const char *dom, const char *checkfile);
759
760    /**
761     * Provide information on the @b fallback application's binaries
762     * directory, in scenarios where they get overriden by
763     * elm_app_info_set().
764     *
765     * @param dir The path to the default binaries directory (compile time
766     * one)
767     *
768     * @note Elementary will as well use this path to determine actual
769     * names of binaries' directory paths, maybe changing it to be @c
770     * something/local/bin instead of @c something/bin, only, for
771     * example.
772     *
773     * @warning You should call this function @b before
774     * elm_app_info_set().
775     */
776    EAPI void         elm_app_compile_bin_dir_set(const char *dir);
777
778    /**
779     * Provide information on the @b fallback application's libraries
780     * directory, on scenarios where they get overriden by
781     * elm_app_info_set().
782     *
783     * @param dir The path to the default libraries directory (compile
784     * time one)
785     *
786     * @note Elementary will as well use this path to determine actual
787     * names of libraries' directory paths, maybe changing it to be @c
788     * something/lib32 or @c something/lib64 instead of @c something/lib,
789     * only, for example.
790     *
791     * @warning You should call this function @b before
792     * elm_app_info_set().
793     */
794    EAPI void         elm_app_compile_lib_dir_set(const char *dir);
795
796    /**
797     * Provide information on the @b fallback application's data
798     * directory, on scenarios where they get overriden by
799     * elm_app_info_set().
800     *
801     * @param dir The path to the default data directory (compile time
802     * one)
803     *
804     * @note Elementary will as well use this path to determine actual
805     * names of data directory paths, maybe changing it to be @c
806     * something/local/share instead of @c something/share, only, for
807     * example.
808     *
809     * @warning You should call this function @b before
810     * elm_app_info_set().
811     */
812    EAPI void         elm_app_compile_data_dir_set(const char *dir);
813
814    /**
815     * Provide information on the @b fallback application's locale
816     * directory, on scenarios where they get overriden by
817     * elm_app_info_set().
818     *
819     * @param dir The path to the default locale directory (compile time
820     * one)
821     *
822     * @warning You should call this function @b before
823     * elm_app_info_set().
824     */
825    EAPI void         elm_app_compile_locale_set(const char *dir);
826
827    /**
828     * Retrieve the application's run time prefix directory, as set by
829     * elm_app_info_set() and the way (environment) the application was
830     * run from.
831     *
832     * @return The directory prefix the application is actually using.
833     */
834    EAPI const char  *elm_app_prefix_dir_get(void);
835
836    /**
837     * Retrieve the application's run time binaries prefix directory, as
838     * set by elm_app_info_set() and the way (environment) the application
839     * was run from.
840     *
841     * @return The binaries directory prefix the application is actually
842     * using.
843     */
844    EAPI const char  *elm_app_bin_dir_get(void);
845
846    /**
847     * Retrieve the application's run time libraries prefix directory, as
848     * set by elm_app_info_set() and the way (environment) the application
849     * was run from.
850     *
851     * @return The libraries directory prefix the application is actually
852     * using.
853     */
854    EAPI const char  *elm_app_lib_dir_get(void);
855
856    /**
857     * Retrieve the application's run time data prefix directory, as
858     * set by elm_app_info_set() and the way (environment) the application
859     * was run from.
860     *
861     * @return The data directory prefix the application is actually
862     * using.
863     */
864    EAPI const char  *elm_app_data_dir_get(void);
865
866    /**
867     * Retrieve the application's run time locale prefix directory, as
868     * set by elm_app_info_set() and the way (environment) the application
869     * was run from.
870     *
871     * @return The locale directory prefix the application is actually
872     * using.
873     */
874    EAPI const char  *elm_app_locale_dir_get(void);
875
876    EAPI void         elm_quicklaunch_mode_set(Eina_Bool ql_on);
877    EAPI Eina_Bool    elm_quicklaunch_mode_get(void);
878    EAPI int          elm_quicklaunch_init(int argc, char **argv);
879    EAPI int          elm_quicklaunch_sub_init(int argc, char **argv);
880    EAPI int          elm_quicklaunch_sub_shutdown(void);
881    EAPI int          elm_quicklaunch_shutdown(void);
882    EAPI void         elm_quicklaunch_seed(void);
883    EAPI Eina_Bool    elm_quicklaunch_prepare(int argc, char **argv);
884    EAPI Eina_Bool    elm_quicklaunch_fork(int argc, char **argv, char *cwd, void (postfork_func) (void *data), void *postfork_data);
885    EAPI void         elm_quicklaunch_cleanup(void);
886    EAPI int          elm_quicklaunch_fallback(int argc, char **argv);
887    EAPI char        *elm_quicklaunch_exe_path_get(const char *exe);
888
889    EAPI Eina_Bool    elm_need_efreet(void);
890    EAPI Eina_Bool    elm_need_e_dbus(void);
891    EAPI Eina_Bool    elm_need_ethumb(void);
892
893    /**
894     * Set a new policy's value (for a given policy group/identifier).
895     *
896     * @param policy policy identifier, as in @ref Elm_Policy.
897     * @param value policy value, which depends on the identifier
898     *
899     * @return @c EINA_TRUE on success or @c EINA_FALSE, on error.
900     *
901     * Elementary policies define applications' behavior,
902     * somehow. These behaviors are divided in policy groups (see
903     * #Elm_Policy enumeration). This call will emit the Ecore event
904     * #ELM_EVENT_POLICY_CHANGED, which can be hooked at with
905     * handlers. An #Elm_Event_Policy_Changed struct will be passed,
906     * then.
907     *
908     * @note Currently, we have only one policy identifier/group
909     * (#ELM_POLICY_QUIT), which has two possible values.
910     *
911     * @ingroup General
912     */
913    EAPI Eina_Bool    elm_policy_set(unsigned int policy, int value);
914
915    /**
916     * Gets the policy value for given policy identifier.
917     *
918     * @param policy policy identifier, as in #Elm_Policy.
919     * @return The currently set policy value, for that
920     * identifier. Will be @c 0 if @p policy passed is invalid.
921     *
922     * @ingroup General
923     */
924    EAPI int          elm_policy_get(unsigned int policy);
925
926    /**
927     * Change the language of the current application
928     *
929     * The @p lang passed must be the full name of the locale to use, for
930     * example "en_US.utf8" or "es_ES@euro".
931     *
932     * Changing language with this function will make Elementary run through
933     * all its widgets, translating strings set with
934     * elm_object_domain_translatable_text_part_set(). This way, an entire
935     * UI can have its language changed without having to restart the program.
936     *
937     * For more complex cases, like having formatted strings that need
938     * translation, widgets will also emit a "language,changed" signal that
939     * the user can listen to to manually translate the text.
940     *
941     * @param lang Language to set, must be the full name of the locale
942     *
943     * @ingroup General
944     */
945    EAPI void         elm_language_set(const char *lang);
946
947    /**
948     * Set a label of an object
949     *
950     * @param obj The Elementary object
951     * @param part The text part name to set (NULL for the default label)
952     * @param label The new text of the label
953     *
954     * @note Elementary objects may have many labels (e.g. Action Slider)
955     *
956     * @ingroup General
957     */
958    EAPI void         elm_object_text_part_set(Evas_Object *obj, const char *part, const char *label);
959
960 #define elm_object_text_set(obj, label) elm_object_text_part_set((obj), NULL, (label))
961
962    /**
963     * Get a label of an object
964     *
965     * @param obj The Elementary object
966     * @param part The text part name to get (NULL for the default label)
967     * @return text of the label or NULL for any error
968     *
969     * @note Elementary objects may have many labels (e.g. Action Slider)
970     *
971     * @ingroup General
972     */
973    EAPI const char  *elm_object_text_part_get(const Evas_Object *obj, const char *part);
974
975 #define elm_object_text_get(obj) elm_object_text_part_get((obj), NULL)
976
977    /**
978     * Set the text for an objects part, marking it as translatable
979     *
980     * The string to set as @p text must be the original one. Do not pass the
981     * return of @c gettext() here. Elementary will translate the string
982     * internally and set it on the object using elm_object_text_part_set(),
983     * also storing the original string so that it can be automatically
984     * translated when the language is changed with elm_language_set().
985     *
986     * The @p domain will be stored along to find the translation in the
987     * correct catalog. It can be NULL, in which case it will use whatever
988     * domain was set by the application with @c textdomain(). This is useful
989     * in case you are building a library on top of Elementary that will have
990     * its own translatable strings, that should not be mixed with those of
991     * programs using the library.
992     *
993     * @param obj The object
994     * @param part The name of the part to set
995     * @param domain The translation domain to use
996     * @param text The original, non-translated text to set
997     *
998     * @ingroup General
999     */
1000    EAPI void         elm_object_domain_translatable_text_part_set(Evas_Object *obj, const char *part, const char *domain, const char *text);
1001
1002 #define elm_object_domain_translatable_text_set(obj, domain, text) elm_object_domain_translatable_text_part_set((obj), NULL, (domain), (text))
1003
1004 #define elm_object_translatable_text_set(obj, text) elm_object_domain_translatable_text_part_set((obj), NULL, NULL, (text))
1005
1006    /**
1007     * Gets the original string set as translatable for an object
1008     *
1009     * When setting translated strings, the function elm_object_text_part_get()
1010     * will return the translation returned by @c gettext(). To get the
1011     * original string use this function.
1012     *
1013     * @param obj The object
1014     * @param part The name of the part that was set
1015     *
1016     * @return The original, untranslated string
1017     *
1018     * @ingroup General
1019     */
1020    EAPI const char  *elm_object_translatable_text_part_get(const Evas_Object *obj, const char *part);
1021
1022 #define elm_object_translatable_text_get(obj) elm_object_translatable_text_part_get((obj), NULL)
1023
1024    /**
1025     * Set a content of an object
1026     *
1027     * @param obj The Elementary object
1028     * @param part The content part name to set (NULL for the default content)
1029     * @param content The new content of the object
1030     *
1031     * @note Elementary objects may have many contents
1032     *
1033     * @ingroup General
1034     */
1035    EAPI void elm_object_content_part_set(Evas_Object *obj, const char *part, Evas_Object *content);
1036
1037 #define elm_object_content_set(obj, content) elm_object_content_part_set((obj), NULL, (content))
1038
1039    /**
1040     * Get a content of an object
1041     *
1042     * @param obj The Elementary object
1043     * @param item The content part name to get (NULL for the default content)
1044     * @return content of the object or NULL for any error
1045     *
1046     * @note Elementary objects may have many contents
1047     *
1048     * @ingroup General
1049     */
1050    EAPI Evas_Object *elm_object_content_part_get(const Evas_Object *obj, const char *part);
1051
1052 #define elm_object_content_get(obj) elm_object_content_part_get((obj), NULL)
1053
1054    /**
1055     * Unset a content of an object
1056     *
1057     * @param obj The Elementary object
1058     * @param item The content part name to unset (NULL for the default content)
1059     *
1060     * @note Elementary objects may have many contents
1061     *
1062     * @ingroup General
1063     */
1064    EAPI Evas_Object *elm_object_content_part_unset(Evas_Object *obj, const char *part);
1065
1066 #define elm_object_content_unset(obj) elm_object_content_part_unset((obj), NULL)
1067
1068    /**
1069     * Set a content of an object item
1070     *
1071     * @param it The Elementary object item
1072     * @param part The content part name to set (NULL for the default content)
1073     * @param content The new content of the object item
1074     *
1075     * @note Elementary object items may have many contents
1076     *
1077     * @ingroup General
1078     */
1079    EAPI void elm_object_item_content_part_set(Elm_Object_Item *it, const char *part, Evas_Object *content);
1080
1081 #define elm_object_item_content_set(it, content) elm_object_item_content_part_set((it), NULL, (content))
1082
1083    /**
1084     * Get a content of an object item
1085     *
1086     * @param it The Elementary object item
1087     * @param part The content part name to unset (NULL for the default content)
1088     * @return content of the object item or NULL for any error
1089     *
1090     * @note Elementary object items may have many contents
1091     *
1092     * @ingroup General
1093     */
1094    EAPI Evas_Object *elm_object_item_content_part_get(const Elm_Object_Item *it, const char *part);
1095
1096 #define elm_object_item_content_get(it) elm_object_item_content_part_get((it), NULL)
1097
1098    /**
1099     * Unset a content of an object item
1100     *
1101     * @param it The Elementary object item
1102     * @param part The content part name to unset (NULL for the default content)
1103     *
1104     * @note Elementary object items may have many contents
1105     *
1106     * @ingroup General
1107     */
1108    EAPI Evas_Object *elm_object_item_content_part_unset(Elm_Object_Item *it, const char *part);
1109
1110 #define elm_object_item_content_unset(it, content) elm_object_item_content_part_unset((it), (content))
1111
1112    /**
1113     * Set a label of an object item
1114     *
1115     * @param it The Elementary object item
1116     * @param part The text part name to set (NULL for the default label)
1117     * @param label The new text of the label
1118     *
1119     * @note Elementary object items may have many labels
1120     *
1121     * @ingroup General
1122     */
1123    EAPI void elm_object_item_text_part_set(Elm_Object_Item *it, const char *part, const char *label);
1124
1125 #define elm_object_item_text_set(it, label) elm_object_item_text_part_set((it), NULL, (label))
1126
1127    /**
1128     * Get a label of an object item
1129     *
1130     * @param it The Elementary object item
1131     * @param part The text part name to get (NULL for the default label)
1132     * @return text of the label or NULL for any error
1133     *
1134     * @note Elementary object items may have many labels
1135     *
1136     * @ingroup General
1137     */
1138    EAPI const char *elm_object_item_text_part_get(const Elm_Object_Item *it, const char *part);
1139
1140 #define elm_object_item_text_get(it) elm_object_item_text_part_get((it), NULL)
1141
1142    /**
1143     * Set the text to read out when in accessibility mode
1144     *
1145     * @param obj The object which is to be described
1146     * @param txt The text that describes the widget to people with poor or no vision
1147     *
1148     * @ingroup General
1149     */
1150    EAPI void elm_object_access_info_set(Evas_Object *obj, const char *txt);
1151
1152    /**
1153     * Set the text to read out when in accessibility mode
1154     *
1155     * @param it The object item which is to be described
1156     * @param txt The text that describes the widget to people with poor or no vision
1157     *
1158     * @ingroup General
1159     */
1160    EAPI void elm_object_item_access_info_set(Elm_Object_Item *it, const char *txt);
1161
1162    /**
1163     * Get the data associated with an object item
1164     * @param it The object item
1165     * @return The data associated with @p it
1166     *
1167     * @ingroup General
1168     */
1169    EAPI void *elm_object_item_data_get(const Elm_Object_Item *it);
1170
1171    /**
1172     * Set the data associated with an object item
1173     * @param it The object item
1174     * @param data The data to be associated with @p it
1175     *
1176     * @ingroup General
1177     */
1178    EAPI void elm_object_item_data_set(Elm_Object_Item *it, void *data);
1179
1180    /**
1181     * Send a signal to the edje object of the widget item.
1182     *
1183     * This function sends a signal to the edje object of the obj item. An
1184     * edje program can respond to a signal by specifying matching
1185     * 'signal' and 'source' fields.
1186     *
1187     * @param it The Elementary object item
1188     * @param emission The signal's name.
1189     * @param source The signal's source.
1190     * @ingroup General
1191     */
1192    EAPI void             elm_object_item_signal_emit(Elm_Object_Item *it, const char *emission, const char *source) EINA_ARG_NONNULL(1);
1193
1194    /**
1195     * @}
1196     */
1197
1198    /**
1199     * @defgroup Caches Caches
1200     *
1201     * These are functions which let one fine-tune some cache values for
1202     * Elementary applications, thus allowing for performance adjustments.
1203     *
1204     * @{
1205     */
1206
1207    /**
1208     * @brief Flush all caches.
1209     *
1210     * Frees all data that was in cache and is not currently being used to reduce
1211     * memory usage. This frees Edje's, Evas' and Eet's cache. This is equivalent
1212     * to calling all of the following functions:
1213     * @li edje_file_cache_flush()
1214     * @li edje_collection_cache_flush()
1215     * @li eet_clearcache()
1216     * @li evas_image_cache_flush()
1217     * @li evas_font_cache_flush()
1218     * @li evas_render_dump()
1219     * @note Evas caches are flushed for every canvas associated with a window.
1220     *
1221     * @ingroup Caches
1222     */
1223    EAPI void         elm_all_flush(void);
1224
1225    /**
1226     * Get the configured cache flush interval time
1227     *
1228     * This gets the globally configured cache flush interval time, in
1229     * ticks
1230     *
1231     * @return The cache flush interval time
1232     * @ingroup Caches
1233     *
1234     * @see elm_all_flush()
1235     */
1236    EAPI int          elm_cache_flush_interval_get(void);
1237
1238    /**
1239     * Set the configured cache flush interval time
1240     *
1241     * This sets the globally configured cache flush interval time, in ticks
1242     *
1243     * @param size The cache flush interval time
1244     * @ingroup Caches
1245     *
1246     * @see elm_all_flush()
1247     */
1248    EAPI void         elm_cache_flush_interval_set(int size);
1249
1250    /**
1251     * Set the configured cache flush interval time for all applications on the
1252     * display
1253     *
1254     * This sets the globally configured cache flush interval time -- in ticks
1255     * -- for all applications on the display.
1256     *
1257     * @param size The cache flush interval time
1258     * @ingroup Caches
1259     */
1260    EAPI void         elm_cache_flush_interval_all_set(int size);
1261
1262    /**
1263     * Get the configured cache flush enabled state
1264     *
1265     * This gets the globally configured cache flush state - if it is enabled
1266     * or not. When cache flushing is enabled, elementary will regularly
1267     * (see elm_cache_flush_interval_get() ) flush caches and dump data out of
1268     * memory and allow usage to re-seed caches and data in memory where it
1269     * can do so. An idle application will thus minimise its memory usage as
1270     * data will be freed from memory and not be re-loaded as it is idle and
1271     * not rendering or doing anything graphically right now.
1272     *
1273     * @return The cache flush state
1274     * @ingroup Caches
1275     *
1276     * @see elm_all_flush()
1277     */
1278    EAPI Eina_Bool    elm_cache_flush_enabled_get(void);
1279
1280    /**
1281     * Set the configured cache flush enabled state
1282     *
1283     * This sets the globally configured cache flush enabled state.
1284     *
1285     * @param size The cache flush enabled state
1286     * @ingroup Caches
1287     *
1288     * @see elm_all_flush()
1289     */
1290    EAPI void         elm_cache_flush_enabled_set(Eina_Bool enabled);
1291
1292    /**
1293     * Set the configured cache flush enabled state for all applications on the
1294     * display
1295     *
1296     * This sets the globally configured cache flush enabled state for all
1297     * applications on the display.
1298     *
1299     * @param size The cache flush enabled state
1300     * @ingroup Caches
1301     */
1302    EAPI void         elm_cache_flush_enabled_all_set(Eina_Bool enabled);
1303
1304    /**
1305     * Get the configured font cache size
1306     *
1307     * This gets the globally configured font cache size, in bytes.
1308     *
1309     * @return The font cache size
1310     * @ingroup Caches
1311     */
1312    EAPI int          elm_font_cache_get(void);
1313
1314    /**
1315     * Set the configured font cache size
1316     *
1317     * This sets the globally configured font cache size, in bytes
1318     *
1319     * @param size The font cache size
1320     * @ingroup Caches
1321     */
1322    EAPI void         elm_font_cache_set(int size);
1323
1324    /**
1325     * Set the configured font cache size for all applications on the
1326     * display
1327     *
1328     * This sets the globally configured font cache size -- in bytes
1329     * -- for all applications on the display.
1330     *
1331     * @param size The font cache size
1332     * @ingroup Caches
1333     */
1334    EAPI void         elm_font_cache_all_set(int size);
1335
1336    /**
1337     * Get the configured image cache size
1338     *
1339     * This gets the globally configured image cache size, in bytes
1340     *
1341     * @return The image cache size
1342     * @ingroup Caches
1343     */
1344    EAPI int          elm_image_cache_get(void);
1345
1346    /**
1347     * Set the configured image cache size
1348     *
1349     * This sets the globally configured image cache size, in bytes
1350     *
1351     * @param size The image cache size
1352     * @ingroup Caches
1353     */
1354    EAPI void         elm_image_cache_set(int size);
1355
1356    /**
1357     * Set the configured image cache size for all applications on the
1358     * display
1359     *
1360     * This sets the globally configured image cache size -- in bytes
1361     * -- for all applications on the display.
1362     *
1363     * @param size The image cache size
1364     * @ingroup Caches
1365     */
1366    EAPI void         elm_image_cache_all_set(int size);
1367
1368    /**
1369     * Get the configured edje file cache size.
1370     *
1371     * This gets the globally configured edje file cache size, in number
1372     * of files.
1373     *
1374     * @return The edje file cache size
1375     * @ingroup Caches
1376     */
1377    EAPI int          elm_edje_file_cache_get(void);
1378
1379    /**
1380     * Set the configured edje file cache size
1381     *
1382     * This sets the globally configured edje file cache size, in number
1383     * of files.
1384     *
1385     * @param size The edje file cache size
1386     * @ingroup Caches
1387     */
1388    EAPI void         elm_edje_file_cache_set(int size);
1389
1390    /**
1391     * Set the configured edje file cache size for all applications on the
1392     * display
1393     *
1394     * This sets the globally configured edje file cache size -- in number
1395     * of files -- for all applications on the display.
1396     *
1397     * @param size The edje file cache size
1398     * @ingroup Caches
1399     */
1400    EAPI void         elm_edje_file_cache_all_set(int size);
1401
1402    /**
1403     * Get the configured edje collections (groups) cache size.
1404     *
1405     * This gets the globally configured edje collections cache size, in
1406     * number of collections.
1407     *
1408     * @return The edje collections cache size
1409     * @ingroup Caches
1410     */
1411    EAPI int          elm_edje_collection_cache_get(void);
1412
1413    /**
1414     * Set the configured edje collections (groups) cache size
1415     *
1416     * This sets the globally configured edje collections cache size, in
1417     * number of collections.
1418     *
1419     * @param size The edje collections cache size
1420     * @ingroup Caches
1421     */
1422    EAPI void         elm_edje_collection_cache_set(int size);
1423
1424    /**
1425     * Set the configured edje collections (groups) cache size for all
1426     * applications on the display
1427     *
1428     * This sets the globally configured edje collections cache size -- in
1429     * number of collections -- for all applications on the display.
1430     *
1431     * @param size The edje collections cache size
1432     * @ingroup Caches
1433     */
1434    EAPI void         elm_edje_collection_cache_all_set(int size);
1435
1436    /**
1437     * @}
1438     */
1439
1440    /**
1441     * @defgroup Scaling Widget Scaling
1442     *
1443     * Different widgets can be scaled independently. These functions
1444     * allow you to manipulate this scaling on a per-widget basis. The
1445     * object and all its children get their scaling factors multiplied
1446     * by the scale factor set. This is multiplicative, in that if a
1447     * child also has a scale size set it is in turn multiplied by its
1448     * parent's scale size. @c 1.0 means ā€œdon't scaleā€, @c 2.0 is
1449     * double size, @c 0.5 is half, etc.
1450     *
1451     * @ref general_functions_example_page "This" example contemplates
1452     * some of these functions.
1453     */
1454
1455    /**
1456     * Set the scaling factor for a given Elementary object
1457     *
1458     * @param obj The Elementary to operate on
1459     * @param scale Scale factor (from @c 0.0 up, with @c 1.0 meaning
1460     * no scaling)
1461     *
1462     * @ingroup Scaling
1463     */
1464    EAPI void         elm_object_scale_set(Evas_Object *obj, double scale) EINA_ARG_NONNULL(1);
1465
1466    /**
1467     * Get the scaling factor for a given Elementary object
1468     *
1469     * @param obj The object
1470     * @return The scaling factor set by elm_object_scale_set()
1471     *
1472     * @ingroup Scaling
1473     */
1474    EAPI double       elm_object_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1475
1476    /**
1477     * @defgroup Password_last_show Password last input show
1478     *
1479     * Last show feature of password mode enables user to view
1480     * the last input entered for few seconds before masking it.
1481     * These functions allow to set this feature in password mode
1482     * of entry widget and also allow to manipulate the duration
1483     * for which the input has to be visible.
1484     *
1485     * @{
1486     */
1487
1488    /**
1489     * Get show last setting of password mode.
1490     *
1491     * This gets the show last input setting of password mode which might be
1492     * enabled or disabled.
1493     *
1494     * @return @c EINA_TRUE, if the last input show setting is enabled, @c EINA_FALSE
1495     *            if it's disabled.
1496     * @ingroup Password_last_show
1497     */
1498    EAPI Eina_Bool elm_password_show_last_get(void);
1499
1500    /**
1501     * Set show last setting in password mode.
1502     *
1503     * This enables or disables show last setting of password mode.
1504     *
1505     * @param password_show_last If EINA_TRUE enable's last input show in password mode.
1506     * @see elm_password_show_last_timeout_set()
1507     * @ingroup Password_last_show
1508     */
1509    EAPI void elm_password_show_last_set(Eina_Bool password_show_last);
1510
1511    /**
1512     * Get's the timeout value in last show password mode.
1513     *
1514     * This gets the time out value for which the last input entered in password
1515     * mode will be visible.
1516     *
1517     * @return The timeout value of last show password mode.
1518     * @ingroup Password_last_show
1519     */
1520    EAPI double elm_password_show_last_timeout_get(void);
1521
1522    /**
1523     * Set's the timeout value in last show password mode.
1524     *
1525     * This sets the time out value for which the last input entered in password
1526     * mode will be visible.
1527     *
1528     * @param password_show_last_timeout The timeout value.
1529     * @see elm_password_show_last_set()
1530     * @ingroup Password_last_show
1531     */
1532    EAPI void elm_password_show_last_timeout_set(double password_show_last_timeout);
1533
1534    /**
1535     * @}
1536     */
1537
1538    /**
1539     * @defgroup UI-Mirroring Selective Widget mirroring
1540     *
1541     * These functions allow you to set ui-mirroring on specific
1542     * widgets or the whole interface. Widgets can be in one of two
1543     * modes, automatic and manual.  Automatic means they'll be changed
1544     * according to the system mirroring mode and manual means only
1545     * explicit changes will matter. You are not supposed to change
1546     * mirroring state of a widget set to automatic, will mostly work,
1547     * but the behavior is not really defined.
1548     *
1549     * @{
1550     */
1551
1552    /**
1553     * Get the system mirrored mode. This determines the default mirrored mode
1554     * of widgets.
1555     *
1556     * @return EINA_TRUE if mirrored is set, EINA_FALSE otherwise
1557     */
1558    EAPI Eina_Bool    elm_object_mirrored_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1559
1560    /**
1561     * Set the system mirrored mode. This determines the default mirrored mode
1562     * of widgets.
1563     *
1564     * @param mirrored EINA_TRUE to set mirrored mode, EINA_FALSE to unset it.
1565     */
1566    EAPI void         elm_object_mirrored_set(Evas_Object *obj, Eina_Bool mirrored) EINA_ARG_NONNULL(1);
1567
1568    /**
1569     * Returns the widget's mirrored mode setting.
1570     *
1571     * @param obj The widget.
1572     * @return mirrored mode setting of the object.
1573     *
1574     **/
1575    EAPI Eina_Bool    elm_object_mirrored_automatic_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1576
1577    /**
1578     * Sets the widget's mirrored mode setting.
1579     * When widget in automatic mode, it follows the system mirrored mode set by
1580     * elm_mirrored_set().
1581     * @param obj The widget.
1582     * @param automatic EINA_TRUE for auto mirrored mode. EINA_FALSE for manual.
1583     */
1584    EAPI void         elm_object_mirrored_automatic_set(Evas_Object *obj, Eina_Bool automatic) EINA_ARG_NONNULL(1);
1585
1586    /**
1587     * @}
1588     */
1589
1590    /**
1591     * Set the style to use by a widget
1592     *
1593     * Sets the style name that will define the appearance of a widget. Styles
1594     * vary from widget to widget and may also be defined by other themes
1595     * by means of extensions and overlays.
1596     *
1597     * @param obj The Elementary widget to style
1598     * @param style The style name to use
1599     *
1600     * @see elm_theme_extension_add()
1601     * @see elm_theme_extension_del()
1602     * @see elm_theme_overlay_add()
1603     * @see elm_theme_overlay_del()
1604     *
1605     * @ingroup Styles
1606     */
1607    EAPI void         elm_object_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
1608    /**
1609     * Get the style used by the widget
1610     *
1611     * This gets the style being used for that widget. Note that the string
1612     * pointer is only valid as longas the object is valid and the style doesn't
1613     * change.
1614     *
1615     * @param obj The Elementary widget to query for its style
1616     * @return The style name used
1617     *
1618     * @see elm_object_style_set()
1619     *
1620     * @ingroup Styles
1621     */
1622    EAPI const char  *elm_object_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1623
1624    /**
1625     * @defgroup Styles Styles
1626     *
1627     * Widgets can have different styles of look. These generic API's
1628     * set styles of widgets, if they support them (and if the theme(s)
1629     * do).
1630     *
1631     * @ref general_functions_example_page "This" example contemplates
1632     * some of these functions.
1633     */
1634
1635    /**
1636     * Set the disabled state of an Elementary object.
1637     *
1638     * @param obj The Elementary object to operate on
1639     * @param disabled The state to put in in: @c EINA_TRUE for
1640     *        disabled, @c EINA_FALSE for enabled
1641     *
1642     * Elementary objects can be @b disabled, in which state they won't
1643     * receive input and, in general, will be themed differently from
1644     * their normal state, usually greyed out. Useful for contexts
1645     * where you don't want your users to interact with some of the
1646     * parts of you interface.
1647     *
1648     * This sets the state for the widget, either disabling it or
1649     * enabling it back.
1650     *
1651     * @ingroup Styles
1652     */
1653    EAPI void         elm_object_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
1654
1655    /**
1656     * Get the disabled state of an Elementary object.
1657     *
1658     * @param obj The Elementary object to operate on
1659     * @return @c EINA_TRUE, if the widget is disabled, @c EINA_FALSE
1660     *            if it's enabled (or on errors)
1661     *
1662     * This gets the state of the widget, which might be enabled or disabled.
1663     *
1664     * @ingroup Styles
1665     */
1666    EAPI Eina_Bool    elm_object_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1667
1668    /**
1669     * @defgroup WidgetNavigation Widget Tree Navigation.
1670     *
1671     * How to check if an Evas Object is an Elementary widget? How to
1672     * get the first elementary widget that is parent of the given
1673     * object?  These are all covered in widget tree navigation.
1674     *
1675     * @ref general_functions_example_page "This" example contemplates
1676     * some of these functions.
1677     */
1678
1679    /**
1680     * Check if the given Evas Object is an Elementary widget.
1681     *
1682     * @param obj the object to query.
1683     * @return @c EINA_TRUE if it is an elementary widget variant,
1684     *         @c EINA_FALSE otherwise
1685     * @ingroup WidgetNavigation
1686     */
1687    EAPI Eina_Bool    elm_object_widget_check(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1688
1689    /**
1690     * Get the first parent of the given object that is an Elementary
1691     * widget.
1692     *
1693     * @param obj the Elementary object to query parent from.
1694     * @return the parent object that is an Elementary widget, or @c
1695     *         NULL, if it was not found.
1696     *
1697     * Use this to query for an object's parent widget.
1698     *
1699     * @note Most of Elementary users wouldn't be mixing non-Elementary
1700     * smart objects in the objects tree of an application, as this is
1701     * an advanced usage of Elementary with Evas. So, except for the
1702     * application's window, which is the root of that tree, all other
1703     * objects would have valid Elementary widget parents.
1704     *
1705     * @ingroup WidgetNavigation
1706     */
1707    EAPI Evas_Object *elm_object_parent_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1708
1709    /**
1710     * Get the top level parent of an Elementary widget.
1711     *
1712     * @param obj The object to query.
1713     * @return The top level Elementary widget, or @c NULL if parent cannot be
1714     * found.
1715     * @ingroup WidgetNavigation
1716     */
1717    EAPI Evas_Object *elm_object_top_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1718
1719    /**
1720     * Get the string that represents this Elementary widget.
1721     *
1722     * @note Elementary is weird and exposes itself as a single
1723     *       Evas_Object_Smart_Class of type "elm_widget", so
1724     *       evas_object_type_get() always return that, making debug and
1725     *       language bindings hard. This function tries to mitigate this
1726     *       problem, but the solution is to change Elementary to use
1727     *       proper inheritance.
1728     *
1729     * @param obj the object to query.
1730     * @return Elementary widget name, or @c NULL if not a valid widget.
1731     * @ingroup WidgetNavigation
1732     */
1733    EAPI const char  *elm_object_widget_type_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1734
1735    /**
1736     * @defgroup Config Elementary Config
1737     *
1738     * Elementary configuration is formed by a set options bounded to a
1739     * given @ref Profile profile, like @ref Theme theme, @ref Fingers
1740     * "finger size", etc. These are functions with which one syncronizes
1741     * changes made to those values to the configuration storing files, de
1742     * facto. You most probably don't want to use the functions in this
1743     * group unlees you're writing an elementary configuration manager.
1744     *
1745     * @{
1746     */
1747    EAPI double       elm_scale_get(void);
1748    EAPI void         elm_scale_set(double scale);
1749    EAPI void         elm_scale_all_set(double scale);
1750
1751    /**
1752     * Save back Elementary's configuration, so that it will persist on
1753     * future sessions.
1754     *
1755     * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
1756     * @ingroup Config
1757     *
1758     * This function will take effect -- thus, do I/O -- immediately. Use
1759     * it when you want to apply all configuration changes at once. The
1760     * current configuration set will get saved onto the current profile
1761     * configuration file.
1762     *
1763     */
1764    EAPI Eina_Bool    elm_mirrored_get(void);
1765    EAPI void         elm_mirrored_set(Eina_Bool mirrored);
1766
1767    /**
1768     * Reload Elementary's configuration, bounded to current selected
1769     * profile.
1770     *
1771     * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
1772     * @ingroup Config
1773     *
1774     * Useful when you want to force reloading of configuration values for
1775     * a profile. If one removes user custom configuration directories,
1776     * for example, it will force a reload with system values insted.
1777     *
1778     */
1779    EAPI Eina_Bool    elm_config_save(void);
1780    EAPI void         elm_config_reload(void);
1781
1782    /**
1783     * @}
1784     */
1785
1786    /**
1787     * @defgroup Profile Elementary Profile
1788     *
1789     * Profiles are pre-set options that affect the whole look-and-feel of
1790     * Elementary-based applications. There are, for example, profiles
1791     * aimed at desktop computer applications and others aimed at mobile,
1792     * touchscreen-based ones. You most probably don't want to use the
1793     * functions in this group unlees you're writing an elementary
1794     * configuration manager.
1795     *
1796     * @{
1797     */
1798
1799    /**
1800     * Get Elementary's profile in use.
1801     *
1802     * This gets the global profile that is applied to all Elementary
1803     * applications.
1804     *
1805     * @return The profile's name
1806     * @ingroup Profile
1807     */
1808    EAPI const char  *elm_profile_current_get(void);
1809
1810    /**
1811     * Get an Elementary's profile directory path in the filesystem. One
1812     * may want to fetch a system profile's dir or an user one (fetched
1813     * inside $HOME).
1814     *
1815     * @param profile The profile's name
1816     * @param is_user Whether to lookup for an user profile (@c EINA_TRUE)
1817     *                or a system one (@c EINA_FALSE)
1818     * @return The profile's directory path.
1819     * @ingroup Profile
1820     *
1821     * @note You must free it with elm_profile_dir_free().
1822     */
1823    EAPI const char  *elm_profile_dir_get(const char *profile, Eina_Bool is_user);
1824
1825    /**
1826     * Free an Elementary's profile directory path, as returned by
1827     * elm_profile_dir_get().
1828     *
1829     * @param p_dir The profile's path
1830     * @ingroup Profile
1831     *
1832     */
1833    EAPI void         elm_profile_dir_free(const char *p_dir);
1834
1835    /**
1836     * Get Elementary's list of available profiles.
1837     *
1838     * @return The profiles list. List node data are the profile name
1839     *         strings.
1840     * @ingroup Profile
1841     *
1842     * @note One must free this list, after usage, with the function
1843     *       elm_profile_list_free().
1844     */
1845    EAPI Eina_List   *elm_profile_list_get(void);
1846
1847    /**
1848     * Free Elementary's list of available profiles.
1849     *
1850     * @param l The profiles list, as returned by elm_profile_list_get().
1851     * @ingroup Profile
1852     *
1853     */
1854    EAPI void         elm_profile_list_free(Eina_List *l);
1855
1856    /**
1857     * Set Elementary's profile.
1858     *
1859     * This sets the global profile that is applied to Elementary
1860     * applications. Just the process the call comes from will be
1861     * affected.
1862     *
1863     * @param profile The profile's name
1864     * @ingroup Profile
1865     *
1866     */
1867    EAPI void         elm_profile_set(const char *profile);
1868
1869    /**
1870     * Set Elementary's profile.
1871     *
1872     * This sets the global profile that is applied to all Elementary
1873     * applications. All running Elementary windows will be affected.
1874     *
1875     * @param profile The profile's name
1876     * @ingroup Profile
1877     *
1878     */
1879    EAPI void         elm_profile_all_set(const char *profile);
1880
1881    /**
1882     * @}
1883     */
1884
1885    /**
1886     * @defgroup Engine Elementary Engine
1887     *
1888     * These are functions setting and querying which rendering engine
1889     * Elementary will use for drawing its windows' pixels.
1890     *
1891     * The following are the available engines:
1892     * @li "software_x11"
1893     * @li "fb"
1894     * @li "directfb"
1895     * @li "software_16_x11"
1896     * @li "software_8_x11"
1897     * @li "xrender_x11"
1898     * @li "opengl_x11"
1899     * @li "software_gdi"
1900     * @li "software_16_wince_gdi"
1901     * @li "sdl"
1902     * @li "software_16_sdl"
1903     * @li "opengl_sdl"
1904     * @li "buffer"
1905     * @li "ews"
1906     *
1907     * @{
1908     */
1909
1910    /**
1911     * @brief Get Elementary's rendering engine in use.
1912     *
1913     * @return The rendering engine's name
1914     * @note there's no need to free the returned string, here.
1915     *
1916     * This gets the global rendering engine that is applied to all Elementary
1917     * applications.
1918     *
1919     * @see elm_engine_set()
1920     */
1921    EAPI const char  *elm_engine_current_get(void);
1922
1923    /**
1924     * @brief Set Elementary's rendering engine for use.
1925     *
1926     * @param engine The rendering engine's name
1927     *
1928     * This sets global rendering engine that is applied to all Elementary
1929     * applications. Note that it will take effect only to Elementary windows
1930     * created after this is called.
1931     *
1932     * @see elm_win_add()
1933     */
1934    EAPI void         elm_engine_set(const char *engine);
1935
1936    /**
1937     * @}
1938     */
1939
1940    /**
1941     * @defgroup Fonts Elementary Fonts
1942     *
1943     * These are functions dealing with font rendering, selection and the
1944     * like for Elementary applications. One might fetch which system
1945     * fonts are there to use and set custom fonts for individual classes
1946     * of UI items containing text (text classes).
1947     *
1948     * @{
1949     */
1950
1951   typedef struct _Elm_Text_Class
1952     {
1953        const char *name;
1954        const char *desc;
1955     } Elm_Text_Class;
1956
1957   typedef struct _Elm_Font_Overlay
1958     {
1959        const char     *text_class;
1960        const char     *font;
1961        Evas_Font_Size  size;
1962     } Elm_Font_Overlay;
1963
1964   typedef struct _Elm_Font_Properties
1965     {
1966        const char *name;
1967        Eina_List  *styles;
1968     } Elm_Font_Properties;
1969
1970    /**
1971     * Get Elementary's list of supported text classes.
1972     *
1973     * @return The text classes list, with @c Elm_Text_Class blobs as data.
1974     * @ingroup Fonts
1975     *
1976     * Release the list with elm_text_classes_list_free().
1977     */
1978    EAPI const Eina_List     *elm_text_classes_list_get(void);
1979
1980    /**
1981     * Free Elementary's list of supported text classes.
1982     *
1983     * @ingroup Fonts
1984     *
1985     * @see elm_text_classes_list_get().
1986     */
1987    EAPI void                 elm_text_classes_list_free(const Eina_List *list);
1988
1989    /**
1990     * Get Elementary's list of font overlays, set with
1991     * elm_font_overlay_set().
1992     *
1993     * @return The font overlays list, with @c Elm_Font_Overlay blobs as
1994     * data.
1995     *
1996     * @ingroup Fonts
1997     *
1998     * For each text class, one can set a <b>font overlay</b> for it,
1999     * overriding the default font properties for that class coming from
2000     * the theme in use. There is no need to free this list.
2001     *
2002     * @see elm_font_overlay_set() and elm_font_overlay_unset().
2003     */
2004    EAPI const Eina_List     *elm_font_overlay_list_get(void);
2005
2006    /**
2007     * Set a font overlay for a given Elementary text class.
2008     *
2009     * @param text_class Text class name
2010     * @param font Font name and style string
2011     * @param size Font size
2012     *
2013     * @ingroup Fonts
2014     *
2015     * @p font has to be in the format returned by
2016     * elm_font_fontconfig_name_get(). @see elm_font_overlay_list_get()
2017     * and elm_font_overlay_unset().
2018     */
2019    EAPI void                 elm_font_overlay_set(const char *text_class, const char *font, Evas_Font_Size size);
2020
2021    /**
2022     * Unset a font overlay for a given Elementary text class.
2023     *
2024     * @param text_class Text class name
2025     *
2026     * @ingroup Fonts
2027     *
2028     * This will bring back text elements belonging to text class
2029     * @p text_class back to their default font settings.
2030     */
2031    EAPI void                 elm_font_overlay_unset(const char *text_class);
2032
2033    /**
2034     * Apply the changes made with elm_font_overlay_set() and
2035     * elm_font_overlay_unset() on the current Elementary window.
2036     *
2037     * @ingroup Fonts
2038     *
2039     * This applies all font overlays set to all objects in the UI.
2040     */
2041    EAPI void                 elm_font_overlay_apply(void);
2042
2043    /**
2044     * Apply the changes made with elm_font_overlay_set() and
2045     * elm_font_overlay_unset() on all Elementary application windows.
2046     *
2047     * @ingroup Fonts
2048     *
2049     * This applies all font overlays set to all objects in the UI.
2050     */
2051    EAPI void                 elm_font_overlay_all_apply(void);
2052
2053    /**
2054     * Translate a font (family) name string in fontconfig's font names
2055     * syntax into an @c Elm_Font_Properties struct.
2056     *
2057     * @param font The font name and styles string
2058     * @return the font properties struct
2059     *
2060     * @ingroup Fonts
2061     *
2062     * @note The reverse translation can be achived with
2063     * elm_font_fontconfig_name_get(), for one style only (single font
2064     * instance, not family).
2065     */
2066    EAPI Elm_Font_Properties *elm_font_properties_get(const char *font) EINA_ARG_NONNULL(1);
2067
2068    /**
2069     * Free font properties return by elm_font_properties_get().
2070     *
2071     * @param efp the font properties struct
2072     *
2073     * @ingroup Fonts
2074     */
2075    EAPI void                 elm_font_properties_free(Elm_Font_Properties *efp) EINA_ARG_NONNULL(1);
2076
2077    /**
2078     * Translate a font name, bound to a style, into fontconfig's font names
2079     * syntax.
2080     *
2081     * @param name The font (family) name
2082     * @param style The given style (may be @c NULL)
2083     *
2084     * @return the font name and style string
2085     *
2086     * @ingroup Fonts
2087     *
2088     * @note The reverse translation can be achived with
2089     * elm_font_properties_get(), for one style only (single font
2090     * instance, not family).
2091     */
2092    EAPI const char          *elm_font_fontconfig_name_get(const char *name, const char *style) EINA_ARG_NONNULL(1);
2093
2094    /**
2095     * Free the font string return by elm_font_fontconfig_name_get().
2096     *
2097     * @param efp the font properties struct
2098     *
2099     * @ingroup Fonts
2100     */
2101    EAPI void                 elm_font_fontconfig_name_free(const char *name) EINA_ARG_NONNULL(1);
2102
2103    /**
2104     * Create a font hash table of available system fonts.
2105     *
2106     * One must call it with @p list being the return value of
2107     * evas_font_available_list(). The hash will be indexed by font
2108     * (family) names, being its values @c Elm_Font_Properties blobs.
2109     *
2110     * @param list The list of available system fonts, as returned by
2111     * evas_font_available_list().
2112     * @return the font hash.
2113     *
2114     * @ingroup Fonts
2115     *
2116     * @note The user is supposed to get it populated at least with 3
2117     * default font families (Sans, Serif, Monospace), which should be
2118     * present on most systems.
2119     */
2120    EAPI Eina_Hash           *elm_font_available_hash_add(Eina_List *list);
2121
2122    /**
2123     * Free the hash return by elm_font_available_hash_add().
2124     *
2125     * @param hash the hash to be freed.
2126     *
2127     * @ingroup Fonts
2128     */
2129    EAPI void                 elm_font_available_hash_del(Eina_Hash *hash);
2130
2131    /**
2132     * @}
2133     */
2134
2135    /**
2136     * @defgroup Fingers Fingers
2137     *
2138     * Elementary is designed to be finger-friendly for touchscreens,
2139     * and so in addition to scaling for display resolution, it can
2140     * also scale based on finger "resolution" (or size). You can then
2141     * customize the granularity of the areas meant to receive clicks
2142     * on touchscreens.
2143     *
2144     * Different profiles may have pre-set values for finger sizes.
2145     *
2146     * @ref general_functions_example_page "This" example contemplates
2147     * some of these functions.
2148     *
2149     * @{
2150     */
2151
2152    /**
2153     * Get the configured "finger size"
2154     *
2155     * @return The finger size
2156     *
2157     * This gets the globally configured finger size, <b>in pixels</b>
2158     *
2159     * @ingroup Fingers
2160     */
2161    EAPI Evas_Coord       elm_finger_size_get(void);
2162
2163    /**
2164     * Set the configured finger size
2165     *
2166     * This sets the globally configured finger size in pixels
2167     *
2168     * @param size The finger size
2169     * @ingroup Fingers
2170     */
2171    EAPI void             elm_finger_size_set(Evas_Coord size);
2172
2173    /**
2174     * Set the configured finger size for all applications on the display
2175     *
2176     * This sets the globally configured finger size in pixels for all
2177     * applications on the display
2178     *
2179     * @param size The finger size
2180     * @ingroup Fingers
2181     */
2182    EAPI void             elm_finger_size_all_set(Evas_Coord size);
2183
2184    /**
2185     * @}
2186     */
2187
2188    /**
2189     * @defgroup Focus Focus
2190     *
2191     * An Elementary application has, at all times, one (and only one)
2192     * @b focused object. This is what determines where the input
2193     * events go to within the application's window. Also, focused
2194     * objects can be decorated differently, in order to signal to the
2195     * user where the input is, at a given moment.
2196     *
2197     * Elementary applications also have the concept of <b>focus
2198     * chain</b>: one can cycle through all the windows' focusable
2199     * objects by input (tab key) or programmatically. The default
2200     * focus chain for an application is the one define by the order in
2201     * which the widgets where added in code. One will cycle through
2202     * top level widgets, and, for each one containg sub-objects, cycle
2203     * through them all, before returning to the level
2204     * above. Elementary also allows one to set @b custom focus chains
2205     * for their applications.
2206     *
2207     * Besides the focused decoration a widget may exhibit, when it
2208     * gets focus, Elementary has a @b global focus highlight object
2209     * that can be enabled for a window. If one chooses to do so, this
2210     * extra highlight effect will surround the current focused object,
2211     * too.
2212     *
2213     * @note Some Elementary widgets are @b unfocusable, after
2214     * creation, by their very nature: they are not meant to be
2215     * interacted with input events, but are there just for visual
2216     * purposes.
2217     *
2218     * @ref general_functions_example_page "This" example contemplates
2219     * some of these functions.
2220     */
2221
2222    /**
2223     * Get the enable status of the focus highlight
2224     *
2225     * This gets whether the highlight on focused objects is enabled or not
2226     * @ingroup Focus
2227     */
2228    EAPI Eina_Bool        elm_focus_highlight_enabled_get(void);
2229
2230    /**
2231     * Set the enable status of the focus highlight
2232     *
2233     * Set whether to show or not the highlight on focused objects
2234     * @param enable Enable highlight if EINA_TRUE, disable otherwise
2235     * @ingroup Focus
2236     */
2237    EAPI void             elm_focus_highlight_enabled_set(Eina_Bool enable);
2238
2239    /**
2240     * Get the enable status of the highlight animation
2241     *
2242     * Get whether the focus highlight, if enabled, will animate its switch from
2243     * one object to the next
2244     * @ingroup Focus
2245     */
2246    EAPI Eina_Bool        elm_focus_highlight_animate_get(void);
2247
2248    /**
2249     * Set the enable status of the highlight animation
2250     *
2251     * Set whether the focus highlight, if enabled, will animate its switch from
2252     * one object to the next
2253     * @param animate Enable animation if EINA_TRUE, disable otherwise
2254     * @ingroup Focus
2255     */
2256    EAPI void             elm_focus_highlight_animate_set(Eina_Bool animate);
2257
2258    /**
2259     * Get the whether an Elementary object has the focus or not.
2260     *
2261     * @param obj The Elementary object to get the information from
2262     * @return @c EINA_TRUE, if the object is focused, @c EINA_FALSE if
2263     *            not (and on errors).
2264     *
2265     * @see elm_object_focus_set()
2266     *
2267     * @ingroup Focus
2268     */
2269    EAPI Eina_Bool        elm_object_focus_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2270
2271    /**
2272     * Make a given Elementary object the focused one.
2273     *
2274     * @param obj The Elementary object to make focused.
2275     *
2276     * @note This object, if it can handle focus, will take the focus
2277     * away from the one who had it previously and will, for now on, be
2278     * the one receiving input events.
2279     *
2280     * @see elm_object_focus_get()
2281     *
2282     * @ingroup Focus
2283     */
2284    EAPI void             elm_object_focus(Evas_Object *obj) EINA_ARG_NONNULL(1);
2285
2286    /**
2287     * Remove the focus from an Elementary object
2288     *
2289     * @param obj The Elementary to take focus from
2290     *
2291     * This removes the focus from @p obj, passing it back to the
2292     * previous element in the focus chain list.
2293     *
2294     * @see elm_object_focus() and elm_object_focus_custom_chain_get()
2295     *
2296     * @ingroup Focus
2297     */
2298    EAPI void             elm_object_unfocus(Evas_Object *obj) EINA_ARG_NONNULL(1);
2299
2300    /**
2301     * Set the ability for an Element object to be focused
2302     *
2303     * @param obj The Elementary object to operate on
2304     * @param enable @c EINA_TRUE if the object can be focused, @c
2305     *        EINA_FALSE if not (and on errors)
2306     *
2307     * This sets whether the object @p obj is able to take focus or
2308     * not. Unfocusable objects do nothing when programmatically
2309     * focused, being the nearest focusable parent object the one
2310     * really getting focus. Also, when they receive mouse input, they
2311     * will get the event, but not take away the focus from where it
2312     * was previously.
2313     *
2314     * @ingroup Focus
2315     */
2316    EAPI void             elm_object_focus_allow_set(Evas_Object *obj, Eina_Bool enable) EINA_ARG_NONNULL(1);
2317
2318    /**
2319     * Get whether an Elementary object is focusable or not
2320     *
2321     * @param obj The Elementary object to operate on
2322     * @return @c EINA_TRUE if the object is allowed to be focused, @c
2323     *             EINA_FALSE if not (and on errors)
2324     *
2325     * @note Objects which are meant to be interacted with by input
2326     * events are created able to be focused, by default. All the
2327     * others are not.
2328     *
2329     * @ingroup Focus
2330     */
2331    EAPI Eina_Bool        elm_object_focus_allow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2332
2333    /**
2334     * Set custom focus chain.
2335     *
2336     * This function overwrites any previous custom focus chain within
2337     * the list of objects. The previous list will be deleted and this list
2338     * will be managed by elementary. After it is set, don't modify it.
2339     *
2340     * @note On focus cycle, only will be evaluated children of this container.
2341     *
2342     * @param obj The container object
2343     * @param objs Chain of objects to pass focus
2344     * @ingroup Focus
2345     */
2346    EAPI void             elm_object_focus_custom_chain_set(Evas_Object *obj, Eina_List *objs) EINA_ARG_NONNULL(1);
2347
2348    /**
2349     * Unset a custom focus chain on a given Elementary widget
2350     *
2351     * @param obj The container object to remove focus chain from
2352     *
2353     * Any focus chain previously set on @p obj (for its child objects)
2354     * is removed entirely after this call.
2355     *
2356     * @ingroup Focus
2357     */
2358    EAPI void             elm_object_focus_custom_chain_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2359
2360    /**
2361     * Get custom focus chain
2362     *
2363     * @param obj The container object
2364     * @ingroup Focus
2365     */
2366    EAPI const Eina_List *elm_object_focus_custom_chain_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2367
2368    /**
2369     * Append object to custom focus chain.
2370     *
2371     * @note If relative_child equal to NULL or not in custom chain, the object
2372     * will be added in end.
2373     *
2374     * @note On focus cycle, only will be evaluated children of this container.
2375     *
2376     * @param obj The container object
2377     * @param child The child to be added in custom chain
2378     * @param relative_child The relative object to position the child
2379     * @ingroup Focus
2380     */
2381    EAPI void             elm_object_focus_custom_chain_append(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
2382
2383    /**
2384     * Prepend object to custom focus chain.
2385     *
2386     * @note If relative_child equal to NULL or not in custom chain, the object
2387     * will be added in begin.
2388     *
2389     * @note On focus cycle, only will be evaluated children of this container.
2390     *
2391     * @param obj The container object
2392     * @param child The child to be added in custom chain
2393     * @param relative_child The relative object to position the child
2394     * @ingroup Focus
2395     */
2396    EAPI void             elm_object_focus_custom_chain_prepend(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
2397
2398    /**
2399     * Give focus to next object in object tree.
2400     *
2401     * Give focus to next object in focus chain of one object sub-tree.
2402     * If the last object of chain already have focus, the focus will go to the
2403     * first object of chain.
2404     *
2405     * @param obj The object root of sub-tree
2406     * @param dir Direction to cycle the focus
2407     *
2408     * @ingroup Focus
2409     */
2410    EAPI void             elm_object_focus_cycle(Evas_Object *obj, Elm_Focus_Direction dir) EINA_ARG_NONNULL(1);
2411
2412    /**
2413     * Give focus to near object in one direction.
2414     *
2415     * Give focus to near object in direction of one object.
2416     * If none focusable object in given direction, the focus will not change.
2417     *
2418     * @param obj The reference object
2419     * @param x Horizontal component of direction to focus
2420     * @param y Vertical component of direction to focus
2421     *
2422     * @ingroup Focus
2423     */
2424    EAPI void             elm_object_focus_direction_go(Evas_Object *obj, int x, int y) EINA_ARG_NONNULL(1);
2425
2426    /**
2427     * Make the elementary object and its children to be unfocusable
2428     * (or focusable).
2429     *
2430     * @param obj The Elementary object to operate on
2431     * @param tree_unfocusable @c EINA_TRUE for unfocusable,
2432     *        @c EINA_FALSE for focusable.
2433     *
2434     * This sets whether the object @p obj and its children objects
2435     * are able to take focus or not. If the tree is set as unfocusable,
2436     * newest focused object which is not in this tree will get focus.
2437     * This API can be helpful for an object to be deleted.
2438     * When an object will be deleted soon, it and its children may not
2439     * want to get focus (by focus reverting or by other focus controls).
2440     * Then, just use this API before deleting.
2441     *
2442     * @see elm_object_tree_unfocusable_get()
2443     *
2444     * @ingroup Focus
2445     */
2446    EAPI void             elm_object_tree_unfocusable_set(Evas_Object *obj, Eina_Bool tree_unfocusable); EINA_ARG_NONNULL(1);
2447
2448    /**
2449     * Get whether an Elementary object and its children are unfocusable or not.
2450     *
2451     * @param obj The Elementary object to get the information from
2452     * @return @c EINA_TRUE, if the tree is unfocussable,
2453     *         @c EINA_FALSE if not (and on errors).
2454     *
2455     * @see elm_object_tree_unfocusable_set()
2456     *
2457     * @ingroup Focus
2458     */
2459    EAPI Eina_Bool        elm_object_tree_unfocusable_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
2460
2461    /**
2462     * @defgroup Scrolling Scrolling
2463     *
2464     * These are functions setting how scrollable views in Elementary
2465     * widgets should behave on user interaction.
2466     *
2467     * @{
2468     */
2469
2470    /**
2471     * Get whether scrollers should bounce when they reach their
2472     * viewport's edge during a scroll.
2473     *
2474     * @return the thumb scroll bouncing state
2475     *
2476     * This is the default behavior for touch screens, in general.
2477     * @ingroup Scrolling
2478     */
2479    EAPI Eina_Bool        elm_scroll_bounce_enabled_get(void);
2480
2481    /**
2482     * Set whether scrollers should bounce when they reach their
2483     * viewport's edge during a scroll.
2484     *
2485     * @param enabled the thumb scroll bouncing state
2486     *
2487     * @see elm_thumbscroll_bounce_enabled_get()
2488     * @ingroup Scrolling
2489     */
2490    EAPI void             elm_scroll_bounce_enabled_set(Eina_Bool enabled);
2491
2492    /**
2493     * Set whether scrollers should bounce when they reach their
2494     * viewport's edge during a scroll, for all Elementary application
2495     * windows.
2496     *
2497     * @param enabled the thumb scroll bouncing state
2498     *
2499     * @see elm_thumbscroll_bounce_enabled_get()
2500     * @ingroup Scrolling
2501     */
2502    EAPI void             elm_scroll_bounce_enabled_all_set(Eina_Bool enabled);
2503
2504    /**
2505     * Get the amount of inertia a scroller will impose at bounce
2506     * animations.
2507     *
2508     * @return the thumb scroll bounce friction
2509     *
2510     * @ingroup Scrolling
2511     */
2512    EAPI double           elm_scroll_bounce_friction_get(void);
2513
2514    /**
2515     * Set the amount of inertia a scroller will impose at bounce
2516     * animations.
2517     *
2518     * @param friction the thumb scroll bounce friction
2519     *
2520     * @see elm_thumbscroll_bounce_friction_get()
2521     * @ingroup Scrolling
2522     */
2523    EAPI void             elm_scroll_bounce_friction_set(double friction);
2524
2525    /**
2526     * Set the amount of inertia a scroller will impose at bounce
2527     * animations, for all Elementary application windows.
2528     *
2529     * @param friction the thumb scroll bounce friction
2530     *
2531     * @see elm_thumbscroll_bounce_friction_get()
2532     * @ingroup Scrolling
2533     */
2534    EAPI void             elm_scroll_bounce_friction_all_set(double friction);
2535
2536    /**
2537     * Get the amount of inertia a <b>paged</b> scroller will impose at
2538     * page fitting animations.
2539     *
2540     * @return the page scroll friction
2541     *
2542     * @ingroup Scrolling
2543     */
2544    EAPI double           elm_scroll_page_scroll_friction_get(void);
2545
2546    /**
2547     * Set the amount of inertia a <b>paged</b> scroller will impose at
2548     * page fitting animations.
2549     *
2550     * @param friction the page scroll friction
2551     *
2552     * @see elm_thumbscroll_page_scroll_friction_get()
2553     * @ingroup Scrolling
2554     */
2555    EAPI void             elm_scroll_page_scroll_friction_set(double friction);
2556
2557    /**
2558     * Set the amount of inertia a <b>paged</b> scroller will impose at
2559     * page fitting animations, for all Elementary application windows.
2560     *
2561     * @param friction the page scroll friction
2562     *
2563     * @see elm_thumbscroll_page_scroll_friction_get()
2564     * @ingroup Scrolling
2565     */
2566    EAPI void             elm_scroll_page_scroll_friction_all_set(double friction);
2567
2568    /**
2569     * Get the amount of inertia a scroller will impose at region bring
2570     * animations.
2571     *
2572     * @return the bring in scroll friction
2573     *
2574     * @ingroup Scrolling
2575     */
2576    EAPI double           elm_scroll_bring_in_scroll_friction_get(void);
2577
2578    /**
2579     * Set the amount of inertia a scroller will impose at region bring
2580     * animations.
2581     *
2582     * @param friction the bring in scroll friction
2583     *
2584     * @see elm_thumbscroll_bring_in_scroll_friction_get()
2585     * @ingroup Scrolling
2586     */
2587    EAPI void             elm_scroll_bring_in_scroll_friction_set(double friction);
2588
2589    /**
2590     * Set the amount of inertia a scroller will impose at region bring
2591     * animations, for all Elementary application windows.
2592     *
2593     * @param friction the bring in scroll friction
2594     *
2595     * @see elm_thumbscroll_bring_in_scroll_friction_get()
2596     * @ingroup Scrolling
2597     */
2598    EAPI void             elm_scroll_bring_in_scroll_friction_all_set(double friction);
2599
2600    /**
2601     * Get the amount of inertia scrollers will impose at animations
2602     * triggered by Elementary widgets' zooming API.
2603     *
2604     * @return the zoom friction
2605     *
2606     * @ingroup Scrolling
2607     */
2608    EAPI double           elm_scroll_zoom_friction_get(void);
2609
2610    /**
2611     * Set the amount of inertia scrollers will impose at animations
2612     * triggered by Elementary widgets' zooming API.
2613     *
2614     * @param friction the zoom friction
2615     *
2616     * @see elm_thumbscroll_zoom_friction_get()
2617     * @ingroup Scrolling
2618     */
2619    EAPI void             elm_scroll_zoom_friction_set(double friction);
2620
2621    /**
2622     * Set the amount of inertia scrollers will impose at animations
2623     * triggered by Elementary widgets' zooming API, for all Elementary
2624     * application windows.
2625     *
2626     * @param friction the zoom friction
2627     *
2628     * @see elm_thumbscroll_zoom_friction_get()
2629     * @ingroup Scrolling
2630     */
2631    EAPI void             elm_scroll_zoom_friction_all_set(double friction);
2632
2633    /**
2634     * Get whether scrollers should be draggable from any point in their
2635     * views.
2636     *
2637     * @return the thumb scroll state
2638     *
2639     * @note This is the default behavior for touch screens, in general.
2640     * @note All other functions namespaced with "thumbscroll" will only
2641     *       have effect if this mode is enabled.
2642     *
2643     * @ingroup Scrolling
2644     */
2645    EAPI Eina_Bool        elm_scroll_thumbscroll_enabled_get(void);
2646
2647    /**
2648     * Set whether scrollers should be draggable from any point in their
2649     * views.
2650     *
2651     * @param enabled the thumb scroll state
2652     *
2653     * @see elm_thumbscroll_enabled_get()
2654     * @ingroup Scrolling
2655     */
2656    EAPI void             elm_scroll_thumbscroll_enabled_set(Eina_Bool enabled);
2657
2658    /**
2659     * Set whether scrollers should be draggable from any point in their
2660     * views, for all Elementary application windows.
2661     *
2662     * @param enabled the thumb scroll state
2663     *
2664     * @see elm_thumbscroll_enabled_get()
2665     * @ingroup Scrolling
2666     */
2667    EAPI void             elm_scroll_thumbscroll_enabled_all_set(Eina_Bool enabled);
2668
2669    /**
2670     * Get the number of pixels one should travel while dragging a
2671     * scroller's view to actually trigger scrolling.
2672     *
2673     * @return the thumb scroll threshould
2674     *
2675     * One would use higher values for touch screens, in general, because
2676     * of their inherent imprecision.
2677     * @ingroup Scrolling
2678     */
2679    EAPI unsigned int     elm_scroll_thumbscroll_threshold_get(void);
2680
2681    /**
2682     * Set the number of pixels one should travel while dragging a
2683     * scroller's view to actually trigger scrolling.
2684     *
2685     * @param threshold the thumb scroll threshould
2686     *
2687     * @see elm_thumbscroll_threshould_get()
2688     * @ingroup Scrolling
2689     */
2690    EAPI void             elm_scroll_thumbscroll_threshold_set(unsigned int threshold);
2691
2692    /**
2693     * Set the number of pixels one should travel while dragging a
2694     * scroller's view to actually trigger scrolling, for all Elementary
2695     * application windows.
2696     *
2697     * @param threshold the thumb scroll threshould
2698     *
2699     * @see elm_thumbscroll_threshould_get()
2700     * @ingroup Scrolling
2701     */
2702    EAPI void             elm_scroll_thumbscroll_threshold_all_set(unsigned int threshold);
2703
2704    /**
2705     * Get the minimum speed of mouse cursor movement which will trigger
2706     * list self scrolling animation after a mouse up event
2707     * (pixels/second).
2708     *
2709     * @return the thumb scroll momentum threshould
2710     *
2711     * @ingroup Scrolling
2712     */
2713    EAPI double           elm_scroll_thumbscroll_momentum_threshold_get(void);
2714
2715    /**
2716     * Set the minimum speed of mouse cursor movement which will trigger
2717     * list self scrolling animation after a mouse up event
2718     * (pixels/second).
2719     *
2720     * @param threshold the thumb scroll momentum threshould
2721     *
2722     * @see elm_thumbscroll_momentum_threshould_get()
2723     * @ingroup Scrolling
2724     */
2725    EAPI void             elm_scroll_thumbscroll_momentum_threshold_set(double threshold);
2726
2727    /**
2728     * Set the minimum speed of mouse cursor movement which will trigger
2729     * list self scrolling animation after a mouse up event
2730     * (pixels/second), for all Elementary application windows.
2731     *
2732     * @param threshold the thumb scroll momentum threshould
2733     *
2734     * @see elm_thumbscroll_momentum_threshould_get()
2735     * @ingroup Scrolling
2736     */
2737    EAPI void             elm_scroll_thumbscroll_momentum_threshold_all_set(double threshold);
2738
2739    /**
2740     * Get the amount of inertia a scroller will impose at self scrolling
2741     * animations.
2742     *
2743     * @return the thumb scroll friction
2744     *
2745     * @ingroup Scrolling
2746     */
2747    EAPI double           elm_scroll_thumbscroll_friction_get(void);
2748
2749    /**
2750     * Set the amount of inertia a scroller will impose at self scrolling
2751     * animations.
2752     *
2753     * @param friction the thumb scroll friction
2754     *
2755     * @see elm_thumbscroll_friction_get()
2756     * @ingroup Scrolling
2757     */
2758    EAPI void             elm_scroll_thumbscroll_friction_set(double friction);
2759
2760    /**
2761     * Set the amount of inertia a scroller will impose at self scrolling
2762     * animations, for all Elementary application windows.
2763     *
2764     * @param friction the thumb scroll friction
2765     *
2766     * @see elm_thumbscroll_friction_get()
2767     * @ingroup Scrolling
2768     */
2769    EAPI void             elm_scroll_thumbscroll_friction_all_set(double friction);
2770
2771    /**
2772     * Get the amount of lag between your actual mouse cursor dragging
2773     * movement and a scroller's view movement itself, while pushing it
2774     * into bounce state manually.
2775     *
2776     * @return the thumb scroll border friction
2777     *
2778     * @ingroup Scrolling
2779     */
2780    EAPI double           elm_scroll_thumbscroll_border_friction_get(void);
2781
2782    /**
2783     * Set the amount of lag between your actual mouse cursor dragging
2784     * movement and a scroller's view movement itself, while pushing it
2785     * into bounce state manually.
2786     *
2787     * @param friction the thumb scroll border friction. @c 0.0 for
2788     *        perfect synchrony between two movements, @c 1.0 for maximum
2789     *        lag.
2790     *
2791     * @see elm_thumbscroll_border_friction_get()
2792     * @note parameter value will get bound to 0.0 - 1.0 interval, always
2793     *
2794     * @ingroup Scrolling
2795     */
2796    EAPI void             elm_scroll_thumbscroll_border_friction_set(double friction);
2797
2798    /**
2799     * Set the amount of lag between your actual mouse cursor dragging
2800     * movement and a scroller's view movement itself, while pushing it
2801     * into bounce state manually, for all Elementary application windows.
2802     *
2803     * @param friction the thumb scroll border friction. @c 0.0 for
2804     *        perfect synchrony between two movements, @c 1.0 for maximum
2805     *        lag.
2806     *
2807     * @see elm_thumbscroll_border_friction_get()
2808     * @note parameter value will get bound to 0.0 - 1.0 interval, always
2809     *
2810     * @ingroup Scrolling
2811     */
2812    EAPI void             elm_scroll_thumbscroll_border_friction_all_set(double friction);
2813
2814    /**
2815     * Get the sensitivity amount which is be multiplied by the length of
2816     * mouse dragging.
2817     *
2818     * @return the thumb scroll sensitivity friction
2819     *
2820     * @ingroup Scrolling
2821     */
2822    EAPI double           elm_scroll_thumbscroll_sensitivity_friction_get(void);
2823
2824    /**
2825     * Set the sensitivity amount which is be multiplied by the length of
2826     * mouse dragging.
2827     *
2828     * @param friction the thumb scroll sensitivity friction. @c 0.1 for
2829     *        minimun sensitivity, @c 1.0 for maximum sensitivity. 0.25
2830     *        is proper.
2831     *
2832     * @see elm_thumbscroll_sensitivity_friction_get()
2833     * @note parameter value will get bound to 0.1 - 1.0 interval, always
2834     *
2835     * @ingroup Scrolling
2836     */
2837    EAPI void             elm_scroll_thumbscroll_sensitivity_friction_set(double friction);
2838
2839    /**
2840     * Set the sensitivity amount which is be multiplied by the length of
2841     * mouse dragging, for all Elementary application windows.
2842     *
2843     * @param friction the thumb scroll sensitivity friction. @c 0.1 for
2844     *        minimun sensitivity, @c 1.0 for maximum sensitivity. 0.25
2845     *        is proper.
2846     *
2847     * @see elm_thumbscroll_sensitivity_friction_get()
2848     * @note parameter value will get bound to 0.1 - 1.0 interval, always
2849     *
2850     * @ingroup Scrolling
2851     */
2852    EAPI void             elm_scroll_thumbscroll_sensitivity_friction_all_set(double friction);
2853
2854    /**
2855     * @}
2856     */
2857
2858    /**
2859     * @defgroup Scrollhints Scrollhints
2860     *
2861     * Objects when inside a scroller can scroll, but this may not always be
2862     * desirable in certain situations. This allows an object to hint to itself
2863     * and parents to "not scroll" in one of 2 ways. If any child object of a
2864     * scroller has pushed a scroll freeze or hold then it affects all parent
2865     * scrollers until all children have released them.
2866     *
2867     * 1. To hold on scrolling. This means just flicking and dragging may no
2868     * longer scroll, but pressing/dragging near an edge of the scroller will
2869     * still scroll. This is automatically used by the entry object when
2870     * selecting text.
2871     *
2872     * 2. To totally freeze scrolling. This means it stops. until
2873     * popped/released.
2874     *
2875     * @{
2876     */
2877
2878    /**
2879     * Push the scroll hold by 1
2880     *
2881     * This increments the scroll hold count by one. If it is more than 0 it will
2882     * take effect on the parents of the indicated object.
2883     *
2884     * @param obj The object
2885     * @ingroup Scrollhints
2886     */
2887    EAPI void             elm_object_scroll_hold_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
2888
2889    /**
2890     * Pop the scroll hold by 1
2891     *
2892     * This decrements the scroll hold count by one. If it is more than 0 it will
2893     * take effect on the parents of the indicated object.
2894     *
2895     * @param obj The object
2896     * @ingroup Scrollhints
2897     */
2898    EAPI void             elm_object_scroll_hold_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
2899
2900    /**
2901     * Push the scroll freeze by 1
2902     *
2903     * This increments the scroll freeze count by one. If it is more
2904     * than 0 it will take effect on the parents of the indicated
2905     * object.
2906     *
2907     * @param obj The object
2908     * @ingroup Scrollhints
2909     */
2910    EAPI void             elm_object_scroll_freeze_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
2911
2912    /**
2913     * Pop the scroll freeze by 1
2914     *
2915     * This decrements the scroll freeze count by one. If it is more
2916     * than 0 it will take effect on the parents of the indicated
2917     * object.
2918     *
2919     * @param obj The object
2920     * @ingroup Scrollhints
2921     */
2922    EAPI void             elm_object_scroll_freeze_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
2923
2924    /**
2925     * Lock the scrolling of the given widget (and thus all parents)
2926     *
2927     * This locks the given object from scrolling in the X axis (and implicitly
2928     * also locks all parent scrollers too from doing the same).
2929     *
2930     * @param obj The object
2931     * @param lock The lock state (1 == locked, 0 == unlocked)
2932     * @ingroup Scrollhints
2933     */
2934    EAPI void             elm_object_scroll_lock_x_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
2935
2936    /**
2937     * Lock the scrolling of the given widget (and thus all parents)
2938     *
2939     * This locks the given object from scrolling in the Y axis (and implicitly
2940     * also locks all parent scrollers too from doing the same).
2941     *
2942     * @param obj The object
2943     * @param lock The lock state (1 == locked, 0 == unlocked)
2944     * @ingroup Scrollhints
2945     */
2946    EAPI void             elm_object_scroll_lock_y_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
2947
2948    /**
2949     * Get the scrolling lock of the given widget
2950     *
2951     * This gets the lock for X axis scrolling.
2952     *
2953     * @param obj The object
2954     * @ingroup Scrollhints
2955     */
2956    EAPI Eina_Bool        elm_object_scroll_lock_x_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2957
2958    /**
2959     * Get the scrolling lock of the given widget
2960     *
2961     * This gets the lock for X axis scrolling.
2962     *
2963     * @param obj The object
2964     * @ingroup Scrollhints
2965     */
2966    EAPI Eina_Bool        elm_object_scroll_lock_y_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2967
2968    /**
2969     * @}
2970     */
2971
2972    /**
2973     * Send a signal to the widget edje object.
2974     *
2975     * This function sends a signal to the edje object of the obj. An
2976     * edje program can respond to a signal by specifying matching
2977     * 'signal' and 'source' fields.
2978     *
2979     * @param obj The object
2980     * @param emission The signal's name.
2981     * @param source The signal's source.
2982     * @ingroup General
2983     */
2984    EAPI void             elm_object_signal_emit(Evas_Object *obj, const char *emission, const char *source) EINA_ARG_NONNULL(1);
2985    EAPI void             elm_object_signal_callback_add(Evas_Object *obj, const char *emission, const char *source, void (*func) (void *data, Evas_Object *o, const char *emission, const char *source), void *data) EINA_ARG_NONNULL(1, 4);
2986    EAPI void            *elm_object_signal_callback_del(Evas_Object *obj, const char *emission, const char *source, void (*func) (void *data, Evas_Object *o, const char *emission, const char *source)) EINA_ARG_NONNULL(1, 4);
2987
2988    /**
2989     * Add a callback for a signal emitted by widget edje object.
2990     *
2991     * This function connects a callback function to a signal emitted by the
2992     * edje object of the obj.
2993     * Globs can occur in either the emission or source name.
2994     *
2995     * @param obj The object
2996     * @param emission The signal's name.
2997     * @param source The signal's source.
2998     * @param func The callback function to be executed when the signal is
2999     * emitted.
3000     * @param data A pointer to data to pass in to the callback function.
3001     * @ingroup General
3002     */
3003    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);
3004
3005    /**
3006     * Remove a signal-triggered callback from a widget edje object.
3007     *
3008     * This function removes a callback, previoulsy attached to a
3009     * signal emitted by the edje object of the obj.  The parameters
3010     * emission, source and func must match exactly those passed to a
3011     * previous call to elm_object_signal_callback_add(). The data
3012     * pointer that was passed to this call will be returned.
3013     *
3014     * @param obj The object
3015     * @param emission The signal's name.
3016     * @param source The signal's source.
3017     * @param func The callback function to be executed when the signal is
3018     * emitted.
3019     * @return The data pointer
3020     * @ingroup General
3021     */
3022    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);
3023
3024    /**
3025     * Add a callback for input events (key up, key down, mouse wheel)
3026     * on a given Elementary widget
3027     *
3028     * @param obj The widget to add an event callback on
3029     * @param func The callback function to be executed when the event
3030     * happens
3031     * @param data Data to pass in to @p func
3032     *
3033     * Every widget in an Elementary interface set to receive focus,
3034     * with elm_object_focus_allow_set(), will propagate @b all of its
3035     * key up, key down and mouse wheel input events up to its parent
3036     * object, and so on. All of the focusable ones in this chain which
3037     * had an event callback set, with this call, will be able to treat
3038     * those events. There are two ways of making the propagation of
3039     * these event upwards in the tree of widgets to @b cease:
3040     * - Just return @c EINA_TRUE on @p func. @c EINA_FALSE will mean
3041     *   the event was @b not processed, so the propagation will go on.
3042     * - The @c event_info pointer passed to @p func will contain the
3043     *   event's structure and, if you OR its @c event_flags inner
3044     *   value to @c EVAS_EVENT_FLAG_ON_HOLD, you're telling Elementary
3045     *   one has already handled it, thus killing the event's
3046     *   propagation, too.
3047     *
3048     * @note Your event callback will be issued on those events taking
3049     * place only if no other child widget of @obj has consumed the
3050     * event already.
3051     *
3052     * @note Not to be confused with @c
3053     * evas_object_event_callback_add(), which will add event callbacks
3054     * per type on general Evas objects (no event propagation
3055     * infrastructure taken in account).
3056     *
3057     * @note Not to be confused with @c
3058     * elm_object_signal_callback_add(), which will add callbacks to @b
3059     * signals coming from a widget's theme, not input events.
3060     *
3061     * @note Not to be confused with @c
3062     * edje_object_signal_callback_add(), which does the same as
3063     * elm_object_signal_callback_add(), but directly on an Edje
3064     * object.
3065     *
3066     * @note Not to be confused with @c
3067     * evas_object_smart_callback_add(), which adds callbacks to smart
3068     * objects' <b>smart events</b>, and not input events.
3069     *
3070     * @see elm_object_event_callback_del()
3071     *
3072     * @ingroup General
3073     */
3074    EAPI void             elm_object_event_callback_add(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
3075
3076    /**
3077     * Remove an event callback from a widget.
3078     *
3079     * This function removes a callback, previoulsy attached to event emission
3080     * by the @p obj.
3081     * The parameters func and data must match exactly those passed to
3082     * a previous call to elm_object_event_callback_add(). The data pointer that
3083     * was passed to this call will be returned.
3084     *
3085     * @param obj The object
3086     * @param func The callback function to be executed when the event is
3087     * emitted.
3088     * @param data Data to pass in to the callback function.
3089     * @return The data pointer
3090     * @ingroup General
3091     */
3092    EAPI void            *elm_object_event_callback_del(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
3093
3094    /**
3095     * Adjust size of an element for finger usage.
3096     *
3097     * @param times_w How many fingers should fit horizontally
3098     * @param w Pointer to the width size to adjust
3099     * @param times_h How many fingers should fit vertically
3100     * @param h Pointer to the height size to adjust
3101     *
3102     * This takes width and height sizes (in pixels) as input and a
3103     * size multiple (which is how many fingers you want to place
3104     * within the area, being "finger" the size set by
3105     * elm_finger_size_set()), and adjusts the size to be large enough
3106     * to accommodate the resulting size -- if it doesn't already
3107     * accommodate it. On return the @p w and @p h sizes pointed to by
3108     * these parameters will be modified, on those conditions.
3109     *
3110     * @note This is kind of a low level Elementary call, most useful
3111     * on size evaluation times for widgets. An external user wouldn't
3112     * be calling, most of the time.
3113     *
3114     * @ingroup Fingers
3115     */
3116    EAPI void             elm_coords_finger_size_adjust(int times_w, Evas_Coord *w, int times_h, Evas_Coord *h);
3117
3118    /**
3119     * Get the duration for occuring long press event.
3120     *
3121     * @return Timeout for long press event
3122     * @ingroup Longpress
3123     */
3124    EAPI double           elm_longpress_timeout_get(void);
3125
3126    /**
3127     * Set the duration for occuring long press event.
3128     *
3129     * @param lonpress_timeout Timeout for long press event
3130     * @ingroup Longpress
3131     */
3132    EAPI void             elm_longpress_timeout_set(double longpress_timeout);
3133
3134    /**
3135     * @defgroup Debug Debug
3136     * don't use it unless you are sure
3137     *
3138     * @{
3139     */
3140
3141    /**
3142     * Print Tree object hierarchy in stdout
3143     *
3144     * @param obj The root object
3145     * @ingroup Debug
3146     */
3147    EAPI void             elm_object_tree_dump(const Evas_Object *top);
3148    EAPI void             elm_object_tree_dot_dump(const Evas_Object *top, const char *file);
3149
3150    EAPI void             elm_autocapitalization_allow_all_set(Eina_Bool autocap);
3151    EAPI void             elm_autoperiod_allow_all_set(Eina_Bool autoperiod);
3152    /**
3153     * Print Elm Objects tree hierarchy in file as dot(graphviz) syntax.
3154     *
3155     * @param obj The root object
3156     * @param file The path of output file
3157     * @ingroup Debug
3158     */
3159    EAPI void             elm_object_tree_dot_dump(const Evas_Object *top, const char *file);
3160
3161    /**
3162     * @}
3163     */
3164
3165    /**
3166     * @defgroup Theme Theme
3167     *
3168     * Elementary uses Edje to theme its widgets, naturally. But for the most
3169     * part this is hidden behind a simpler interface that lets the user set
3170     * extensions and choose the style of widgets in a much easier way.
3171     *
3172     * Instead of thinking in terms of paths to Edje files and their groups
3173     * each time you want to change the appearance of a widget, Elementary
3174     * works so you can add any theme file with extensions or replace the
3175     * main theme at one point in the application, and then just set the style
3176     * of widgets with elm_object_style_set() and related functions. Elementary
3177     * will then look in its list of themes for a matching group and apply it,
3178     * and when the theme changes midway through the application, all widgets
3179     * will be updated accordingly.
3180     *
3181     * There are three concepts you need to know to understand how Elementary
3182     * theming works: default theme, extensions and overlays.
3183     *
3184     * Default theme, obviously enough, is the one that provides the default
3185     * look of all widgets. End users can change the theme used by Elementary
3186     * by setting the @c ELM_THEME environment variable before running an
3187     * application, or globally for all programs using the @c elementary_config
3188     * utility. Applications can change the default theme using elm_theme_set(),
3189     * but this can go against the user wishes, so it's not an adviced practice.
3190     *
3191     * Ideally, applications should find everything they need in the already
3192     * provided theme, but there may be occasions when that's not enough and
3193     * custom styles are required to correctly express the idea. For this
3194     * cases, Elementary has extensions.
3195     *
3196     * Extensions allow the application developer to write styles of its own
3197     * to apply to some widgets. This requires knowledge of how each widget
3198     * is themed, as extensions will always replace the entire group used by
3199     * the widget, so important signals and parts need to be there for the
3200     * object to behave properly (see documentation of Edje for details).
3201     * Once the theme for the extension is done, the application needs to add
3202     * it to the list of themes Elementary will look into, using
3203     * elm_theme_extension_add(), and set the style of the desired widgets as
3204     * he would normally with elm_object_style_set().
3205     *
3206     * Overlays, on the other hand, can replace the look of all widgets by
3207     * overriding the default style. Like extensions, it's up to the application
3208     * developer to write the theme for the widgets it wants, the difference
3209     * being that when looking for the theme, Elementary will check first the
3210     * list of overlays, then the set theme and lastly the list of extensions,
3211     * so with overlays it's possible to replace the default view and every
3212     * widget will be affected. This is very much alike to setting the whole
3213     * theme for the application and will probably clash with the end user
3214     * options, not to mention the risk of ending up with not matching styles
3215     * across the program. Unless there's a very special reason to use them,
3216     * overlays should be avoided for the resons exposed before.
3217     *
3218     * All these theme lists are handled by ::Elm_Theme instances. Elementary
3219     * keeps one default internally and every function that receives one of
3220     * these can be called with NULL to refer to this default (except for
3221     * elm_theme_free()). It's possible to create a new instance of a
3222     * ::Elm_Theme to set other theme for a specific widget (and all of its
3223     * children), but this is as discouraged, if not even more so, than using
3224     * overlays. Don't use this unless you really know what you are doing.
3225     *
3226     * But to be less negative about things, you can look at the following
3227     * examples:
3228     * @li @ref theme_example_01 "Using extensions"
3229     * @li @ref theme_example_02 "Using overlays"
3230     *
3231     * @{
3232     */
3233    /**
3234     * @typedef Elm_Theme
3235     *
3236     * Opaque handler for the list of themes Elementary looks for when
3237     * rendering widgets.
3238     *
3239     * Stay out of this unless you really know what you are doing. For most
3240     * cases, sticking to the default is all a developer needs.
3241     */
3242    typedef struct _Elm_Theme Elm_Theme;
3243
3244    /**
3245     * Create a new specific theme
3246     *
3247     * This creates an empty specific theme that only uses the default theme. A
3248     * specific theme has its own private set of extensions and overlays too
3249     * (which are empty by default). Specific themes do not fall back to themes
3250     * of parent objects. They are not intended for this use. Use styles, overlays
3251     * and extensions when needed, but avoid specific themes unless there is no
3252     * other way (example: you want to have a preview of a new theme you are
3253     * selecting in a "theme selector" window. The preview is inside a scroller
3254     * and should display what the theme you selected will look like, but not
3255     * actually apply it yet. The child of the scroller will have a specific
3256     * theme set to show this preview before the user decides to apply it to all
3257     * applications).
3258     */
3259    EAPI Elm_Theme       *elm_theme_new(void);
3260    /**
3261     * Free a specific theme
3262     *
3263     * @param th The theme to free
3264     *
3265     * This frees a theme created with elm_theme_new().
3266     */
3267    EAPI void             elm_theme_free(Elm_Theme *th);
3268    /**
3269     * Copy the theme fom the source to the destination theme
3270     *
3271     * @param th The source theme to copy from
3272     * @param thdst The destination theme to copy data to
3273     *
3274     * This makes a one-time static copy of all the theme config, extensions
3275     * and overlays from @p th to @p thdst. If @p th references a theme, then
3276     * @p thdst is also set to reference it, with all the theme settings,
3277     * overlays and extensions that @p th had.
3278     */
3279    EAPI void             elm_theme_copy(Elm_Theme *th, Elm_Theme *thdst);
3280    /**
3281     * Tell the source theme to reference the ref theme
3282     *
3283     * @param th The theme that will do the referencing
3284     * @param thref The theme that is the reference source
3285     *
3286     * This clears @p th to be empty and then sets it to refer to @p thref
3287     * so @p th acts as an override to @p thref, but where its overrides
3288     * don't apply, it will fall through to @p thref for configuration.
3289     */
3290    EAPI void             elm_theme_ref_set(Elm_Theme *th, Elm_Theme *thref);
3291    /**
3292     * Return the theme referred to
3293     *
3294     * @param th The theme to get the reference from
3295     * @return The referenced theme handle
3296     *
3297     * This gets the theme set as the reference theme by elm_theme_ref_set().
3298     * If no theme is set as a reference, NULL is returned.
3299     */
3300    EAPI Elm_Theme       *elm_theme_ref_get(Elm_Theme *th);
3301    /**
3302     * Return the default theme
3303     *
3304     * @return The default theme handle
3305     *
3306     * This returns the internal default theme setup handle that all widgets
3307     * use implicitly unless a specific theme is set. This is also often use
3308     * as a shorthand of NULL.
3309     */
3310    EAPI Elm_Theme       *elm_theme_default_get(void);
3311    /**
3312     * Prepends a theme overlay to the list of overlays
3313     *
3314     * @param th The theme to add to, or if NULL, the default theme
3315     * @param item The Edje file path to be used
3316     *
3317     * Use this if your application needs to provide some custom overlay theme
3318     * (An Edje file that replaces some default styles of widgets) where adding
3319     * new styles, or changing system theme configuration is not possible. Do
3320     * NOT use this instead of a proper system theme configuration. Use proper
3321     * configuration files, profiles, environment variables etc. to set a theme
3322     * so that the theme can be altered by simple confiugration by a user. Using
3323     * this call to achieve that effect is abusing the API and will create lots
3324     * of trouble.
3325     *
3326     * @see elm_theme_extension_add()
3327     */
3328    EAPI void             elm_theme_overlay_add(Elm_Theme *th, const char *item);
3329    /**
3330     * Delete a theme overlay from the list of overlays
3331     *
3332     * @param th The theme to delete from, or if NULL, the default theme
3333     * @param item The name of the theme overlay
3334     *
3335     * @see elm_theme_overlay_add()
3336     */
3337    EAPI void             elm_theme_overlay_del(Elm_Theme *th, const char *item);
3338    /**
3339     * Appends a theme extension to the list of extensions.
3340     *
3341     * @param th The theme to add to, or if NULL, the default theme
3342     * @param item The Edje file path to be used
3343     *
3344     * This is intended when an application needs more styles of widgets or new
3345     * widget themes that the default does not provide (or may not provide). The
3346     * application has "extended" usage by coming up with new custom style names
3347     * for widgets for specific uses, but as these are not "standard", they are
3348     * not guaranteed to be provided by a default theme. This means the
3349     * application is required to provide these extra elements itself in specific
3350     * Edje files. This call adds one of those Edje files to the theme search
3351     * path to be search after the default theme. The use of this call is
3352     * encouraged when default styles do not meet the needs of the application.
3353     * Use this call instead of elm_theme_overlay_add() for almost all cases.
3354     *
3355     * @see elm_object_style_set()
3356     */
3357    EAPI void             elm_theme_extension_add(Elm_Theme *th, const char *item);
3358    /**
3359     * Deletes a theme extension from the list of extensions.
3360     *
3361     * @param th The theme to delete from, or if NULL, the default theme
3362     * @param item The name of the theme extension
3363     *
3364     * @see elm_theme_extension_add()
3365     */
3366    EAPI void             elm_theme_extension_del(Elm_Theme *th, const char *item);
3367    /**
3368     * Set the theme search order for the given theme
3369     *
3370     * @param th The theme to set the search order, or if NULL, the default theme
3371     * @param theme Theme search string
3372     *
3373     * This sets the search string for the theme in path-notation from first
3374     * theme to search, to last, delimited by the : character. Example:
3375     *
3376     * "shiny:/path/to/file.edj:default"
3377     *
3378     * See the ELM_THEME environment variable for more information.
3379     *
3380     * @see elm_theme_get()
3381     * @see elm_theme_list_get()
3382     */
3383    EAPI void             elm_theme_set(Elm_Theme *th, const char *theme);
3384    /**
3385     * Return the theme search order
3386     *
3387     * @param th The theme to get the search order, or if NULL, the default theme
3388     * @return The internal search order path
3389     *
3390     * This function returns a colon separated string of theme elements as
3391     * returned by elm_theme_list_get().
3392     *
3393     * @see elm_theme_set()
3394     * @see elm_theme_list_get()
3395     */
3396    EAPI const char      *elm_theme_get(Elm_Theme *th);
3397    /**
3398     * Return a list of theme elements to be used in a theme.
3399     *
3400     * @param th Theme to get the list of theme elements from.
3401     * @return The internal list of theme elements
3402     *
3403     * This returns the internal list of theme elements (will only be valid as
3404     * long as the theme is not modified by elm_theme_set() or theme is not
3405     * freed by elm_theme_free(). This is a list of strings which must not be
3406     * altered as they are also internal. If @p th is NULL, then the default
3407     * theme element list is returned.
3408     *
3409     * A theme element can consist of a full or relative path to a .edj file,
3410     * or a name, without extension, for a theme to be searched in the known
3411     * theme paths for Elemementary.
3412     *
3413     * @see elm_theme_set()
3414     * @see elm_theme_get()
3415     */
3416    EAPI const Eina_List *elm_theme_list_get(const Elm_Theme *th);
3417    /**
3418     * Return the full patrh for a theme element
3419     *
3420     * @param f The theme element name
3421     * @param in_search_path Pointer to a boolean to indicate if item is in the search path or not
3422     * @return The full path to the file found.
3423     *
3424     * This returns a string you should free with free() on success, NULL on
3425     * failure. This will search for the given theme element, and if it is a
3426     * full or relative path element or a simple searchable name. The returned
3427     * path is the full path to the file, if searched, and the file exists, or it
3428     * is simply the full path given in the element or a resolved path if
3429     * relative to home. The @p in_search_path boolean pointed to is set to
3430     * EINA_TRUE if the file was a searchable file andis in the search path,
3431     * and EINA_FALSE otherwise.
3432     */
3433    EAPI char            *elm_theme_list_item_path_get(const char *f, Eina_Bool *in_search_path);
3434    /**
3435     * Flush the current theme.
3436     *
3437     * @param th Theme to flush
3438     *
3439     * This flushes caches that let elementary know where to find theme elements
3440     * in the given theme. If @p th is NULL, then the default theme is flushed.
3441     * Call this function if source theme data has changed in such a way as to
3442     * make any caches Elementary kept invalid.
3443     */
3444    EAPI void             elm_theme_flush(Elm_Theme *th);
3445    /**
3446     * This flushes all themes (default and specific ones).
3447     *
3448     * This will flush all themes in the current application context, by calling
3449     * elm_theme_flush() on each of them.
3450     */
3451    EAPI void             elm_theme_full_flush(void);
3452    /**
3453     * Set the theme for all elementary using applications on the current display
3454     *
3455     * @param theme The name of the theme to use. Format same as the ELM_THEME
3456     * environment variable.
3457     */
3458    EAPI void             elm_theme_all_set(const char *theme);
3459    /**
3460     * Return a list of theme elements in the theme search path
3461     *
3462     * @return A list of strings that are the theme element names.
3463     *
3464     * This lists all available theme files in the standard Elementary search path
3465     * for theme elements, and returns them in alphabetical order as theme
3466     * element names in a list of strings. Free this with
3467     * elm_theme_name_available_list_free() when you are done with the list.
3468     */
3469    EAPI Eina_List       *elm_theme_name_available_list_new(void);
3470    /**
3471     * Free the list returned by elm_theme_name_available_list_new()
3472     *
3473     * This frees the list of themes returned by
3474     * elm_theme_name_available_list_new(). Once freed the list should no longer
3475     * be used. a new list mys be created.
3476     */
3477    EAPI void             elm_theme_name_available_list_free(Eina_List *list);
3478    /**
3479     * Set a specific theme to be used for this object and its children
3480     *
3481     * @param obj The object to set the theme on
3482     * @param th The theme to set
3483     *
3484     * This sets a specific theme that will be used for the given object and any
3485     * child objects it has. If @p th is NULL then the theme to be used is
3486     * cleared and the object will inherit its theme from its parent (which
3487     * ultimately will use the default theme if no specific themes are set).
3488     *
3489     * Use special themes with great care as this will annoy users and make
3490     * configuration difficult. Avoid any custom themes at all if it can be
3491     * helped.
3492     */
3493    EAPI void             elm_object_theme_set(Evas_Object *obj, Elm_Theme *th) EINA_ARG_NONNULL(1);
3494    /**
3495     * Get the specific theme to be used
3496     *
3497     * @param obj The object to get the specific theme from
3498     * @return The specifc theme set.
3499     *
3500     * This will return a specific theme set, or NULL if no specific theme is
3501     * set on that object. It will not return inherited themes from parents, only
3502     * the specific theme set for that specific object. See elm_object_theme_set()
3503     * for more information.
3504     */
3505    EAPI Elm_Theme       *elm_object_theme_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3506
3507    /**
3508     * Get a data item from a theme
3509     *
3510     * @param th The theme, or NULL for default theme
3511     * @param key The data key to search with
3512     * @return The data value, or NULL on failure
3513     *
3514     * This function is used to return data items from edc in @p th, an overlay, or an extension.
3515     * It works the same way as edje_file_data_get() except that the return is stringshared.
3516     */
3517    EAPI const char      *elm_theme_data_get(Elm_Theme *th, const char *key) EINA_ARG_NONNULL(2);
3518    /**
3519     * @}
3520     */
3521
3522    /* win */
3523    /** @defgroup Win Win
3524     *
3525     * @image html img/widget/win/preview-00.png
3526     * @image latex img/widget/win/preview-00.eps
3527     *
3528     * The window class of Elementary.  Contains functions to manipulate
3529     * windows. The Evas engine used to render the window contents is specified
3530     * in the system or user elementary config files (whichever is found last),
3531     * and can be overridden with the ELM_ENGINE environment variable for
3532     * testing.  Engines that may be supported (depending on Evas and Ecore-Evas
3533     * compilation setup and modules actually installed at runtime) are (listed
3534     * in order of best supported and most likely to be complete and work to
3535     * lowest quality).
3536     *
3537     * @li "x11", "x", "software-x11", "software_x11" (Software rendering in X11)
3538     * @li "gl", "opengl", "opengl-x11", "opengl_x11" (OpenGL or OpenGL-ES2
3539     * rendering in X11)
3540     * @li "shot:..." (Virtual screenshot renderer - renders to output file and
3541     * exits)
3542     * @li "fb", "software-fb", "software_fb" (Linux framebuffer direct software
3543     * rendering)
3544     * @li "sdl", "software-sdl", "software_sdl" (SDL software rendering to SDL
3545     * buffer)
3546     * @li "gl-sdl", "gl_sdl", "opengl-sdl", "opengl_sdl" (OpenGL or OpenGL-ES2
3547     * rendering using SDL as the buffer)
3548     * @li "gdi", "software-gdi", "software_gdi" (Windows WIN32 rendering via
3549     * GDI with software)
3550     * @li "dfb", "directfb" (Rendering to a DirectFB window)
3551     * @li "x11-8", "x8", "software-8-x11", "software_8_x11" (Rendering in
3552     * grayscale using dedicated 8bit software engine in X11)
3553     * @li "x11-16", "x16", "software-16-x11", "software_16_x11" (Rendering in
3554     * X11 using 16bit software engine)
3555     * @li "wince-gdi", "software-16-wince-gdi", "software_16_wince_gdi"
3556     * (Windows CE rendering via GDI with 16bit software renderer)
3557     * @li "sdl-16", "software-16-sdl", "software_16_sdl" (Rendering to SDL
3558     * buffer with 16bit software renderer)
3559     * @li "ews" (rendering to EWS - Ecore + Evas Single Process Windowing System)
3560     *
3561     * All engines use a simple string to select the engine to render, EXCEPT
3562     * the "shot" engine. This actually encodes the output of the virtual
3563     * screenshot and how long to delay in the engine string. The engine string
3564     * is encoded in the following way:
3565     *
3566     *   "shot:[delay=XX][:][repeat=DDD][:][file=XX]"
3567     *
3568     * Where options are separated by a ":" char if more than one option is
3569     * given, with delay, if provided being the first option and file the last
3570     * (order is important). The delay specifies how long to wait after the
3571     * window is shown before doing the virtual "in memory" rendering and then
3572     * save the output to the file specified by the file option (and then exit).
3573     * If no delay is given, the default is 0.5 seconds. If no file is given the
3574     * default output file is "out.png". Repeat option is for continous
3575     * capturing screenshots. Repeat range is from 1 to 999 and filename is
3576     * fixed to "out001.png" Some examples of using the shot engine:
3577     *
3578     *   ELM_ENGINE="shot:delay=1.0:repeat=5:file=elm_test.png" elementary_test
3579     *   ELM_ENGINE="shot:delay=1.0:file=elm_test.png" elementary_test
3580     *   ELM_ENGINE="shot:file=elm_test2.png" elementary_test
3581     *   ELM_ENGINE="shot:delay=2.0" elementary_test
3582     *   ELM_ENGINE="shot:" elementary_test
3583     *
3584     * Signals that you can add callbacks for are:
3585     *
3586     * @li "delete,request": the user requested to close the window. See
3587     * elm_win_autodel_set().
3588     * @li "focus,in": window got focus
3589     * @li "focus,out": window lost focus
3590     * @li "moved": window that holds the canvas was moved
3591     *
3592     * Examples:
3593     * @li @ref win_example_01
3594     *
3595     * @{
3596     */
3597    /**
3598     * Defines the types of window that can be created
3599     *
3600     * These are hints set on the window so that a running Window Manager knows
3601     * how the window should be handled and/or what kind of decorations it
3602     * should have.
3603     *
3604     * Currently, only the X11 backed engines use them.
3605     */
3606    typedef enum _Elm_Win_Type
3607      {
3608         ELM_WIN_BASIC, /**< A normal window. Indicates a normal, top-level
3609                          window. Almost every window will be created with this
3610                          type. */
3611         ELM_WIN_DIALOG_BASIC, /**< Used for simple dialog windows/ */
3612         ELM_WIN_DESKTOP, /**< For special desktop windows, like a background
3613                            window holding desktop icons. */
3614         ELM_WIN_DOCK, /**< The window is used as a dock or panel. Usually would
3615                         be kept on top of any other window by the Window
3616                         Manager. */
3617         ELM_WIN_TOOLBAR, /**< The window is used to hold a floating toolbar, or
3618                            similar. */
3619         ELM_WIN_MENU, /**< Similar to #ELM_WIN_TOOLBAR. */
3620         ELM_WIN_UTILITY, /**< A persistent utility window, like a toolbox or
3621                            pallete. */
3622         ELM_WIN_SPLASH, /**< Splash window for a starting up application. */
3623         ELM_WIN_DROPDOWN_MENU, /**< The window is a dropdown menu, as when an
3624                                  entry in a menubar is clicked. Typically used
3625                                  with elm_win_override_set(). This hint exists
3626                                  for completion only, as the EFL way of
3627                                  implementing a menu would not normally use a
3628                                  separate window for its contents. */
3629         ELM_WIN_POPUP_MENU, /**< Like #ELM_WIN_DROPDOWN_MENU, but for the menu
3630                               triggered by right-clicking an object. */
3631         ELM_WIN_TOOLTIP, /**< The window is a tooltip. A short piece of
3632                            explanatory text that typically appear after the
3633                            mouse cursor hovers over an object for a while.
3634                            Typically used with elm_win_override_set() and also
3635                            not very commonly used in the EFL. */
3636         ELM_WIN_NOTIFICATION, /**< A notification window, like a warning about
3637                                 battery life or a new E-Mail received. */
3638         ELM_WIN_COMBO, /**< A window holding the contents of a combo box. Not
3639                          usually used in the EFL. */
3640         ELM_WIN_DND, /**< Used to indicate the window is a representation of an
3641                        object being dragged across different windows, or even
3642                        applications. Typically used with
3643                        elm_win_override_set(). */
3644         ELM_WIN_INLINED_IMAGE, /**< The window is rendered onto an image
3645                                  buffer. No actual window is created for this
3646                                  type, instead the window and all of its
3647                                  contents will be rendered to an image buffer.
3648                                  This allows to have children window inside a
3649                                  parent one just like any other object would
3650                                  be, and do other things like applying @c
3651                                  Evas_Map effects to it. This is the only type
3652                                  of window that requires the @c parent
3653                                  parameter of elm_win_add() to be a valid @c
3654                                  Evas_Object. */
3655      } Elm_Win_Type;
3656
3657    /**
3658     * The differents layouts that can be requested for the virtual keyboard.
3659     *
3660     * When the application window is being managed by Illume, it may request
3661     * any of the following layouts for the virtual keyboard.
3662     */
3663    typedef enum _Elm_Win_Keyboard_Mode
3664      {
3665         ELM_WIN_KEYBOARD_UNKNOWN, /**< Unknown keyboard state */
3666         ELM_WIN_KEYBOARD_OFF, /**< Request to deactivate the keyboard */
3667         ELM_WIN_KEYBOARD_ON, /**< Enable keyboard with default layout */
3668         ELM_WIN_KEYBOARD_ALPHA, /**< Alpha (a-z) keyboard layout */
3669         ELM_WIN_KEYBOARD_NUMERIC, /**< Numeric keyboard layout */
3670         ELM_WIN_KEYBOARD_PIN, /**< PIN keyboard layout */
3671         ELM_WIN_KEYBOARD_PHONE_NUMBER, /**< Phone keyboard layout */
3672         ELM_WIN_KEYBOARD_HEX, /**< Hexadecimal numeric keyboard layout */
3673         ELM_WIN_KEYBOARD_TERMINAL, /**< Full (QUERTY) keyboard layout */
3674         ELM_WIN_KEYBOARD_PASSWORD, /**< Password keyboard layout */
3675         ELM_WIN_KEYBOARD_IP, /**< IP keyboard layout */
3676         ELM_WIN_KEYBOARD_HOST, /**< Host keyboard layout */
3677         ELM_WIN_KEYBOARD_FILE, /**< File keyboard layout */
3678         ELM_WIN_KEYBOARD_URL, /**< URL keyboard layout */
3679         ELM_WIN_KEYBOARD_KEYPAD, /**< Keypad layout */
3680         ELM_WIN_KEYBOARD_J2ME /**< J2ME keyboard layout */
3681      } Elm_Win_Keyboard_Mode;
3682
3683    /**
3684     * Available commands that can be sent to the Illume manager.
3685     *
3686     * When running under an Illume session, a window may send commands to the
3687     * Illume manager to perform different actions.
3688     */
3689    typedef enum _Elm_Illume_Command
3690      {
3691         ELM_ILLUME_COMMAND_FOCUS_BACK, /**< Reverts focus to the previous
3692                                          window */
3693         ELM_ILLUME_COMMAND_FOCUS_FORWARD, /**< Sends focus to the next window\
3694                                             in the list */
3695         ELM_ILLUME_COMMAND_FOCUS_HOME, /**< Hides all windows to show the Home
3696                                          screen */
3697         ELM_ILLUME_COMMAND_CLOSE /**< Closes the currently active window */
3698      } Elm_Illume_Command;
3699
3700    /**
3701     * Adds a window object. If this is the first window created, pass NULL as
3702     * @p parent.
3703     *
3704     * @param parent Parent object to add the window to, or NULL
3705     * @param name The name of the window
3706     * @param type The window type, one of #Elm_Win_Type.
3707     *
3708     * The @p parent paramter can be @c NULL for every window @p type except
3709     * #ELM_WIN_INLINED_IMAGE, which needs a parent to retrieve the canvas on
3710     * which the image object will be created.
3711     *
3712     * @return The created object, or NULL on failure
3713     */
3714    EAPI Evas_Object *elm_win_add(Evas_Object *parent, const char *name, Elm_Win_Type type);
3715    /**
3716     * Add @p subobj as a resize object of window @p obj.
3717     *
3718     *
3719     * Setting an object as a resize object of the window means that the
3720     * @p subobj child's size and position will be controlled by the window
3721     * directly. That is, the object will be resized to match the window size
3722     * and should never be moved or resized manually by the developer.
3723     *
3724     * In addition, resize objects of the window control what the minimum size
3725     * of it will be, as well as whether it can or not be resized by the user.
3726     *
3727     * For the end user to be able to resize a window by dragging the handles
3728     * or borders provided by the Window Manager, or using any other similar
3729     * mechanism, all of the resize objects in the window should have their
3730     * evas_object_size_hint_weight_set() set to EVAS_HINT_EXPAND.
3731     *
3732     * @param obj The window object
3733     * @param subobj The resize object to add
3734     */
3735    EAPI void         elm_win_resize_object_add(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3736    /**
3737     * Delete @p subobj as a resize object of window @p obj.
3738     *
3739     * This function removes the object @p subobj from the resize objects of
3740     * the window @p obj. It will not delete the object itself, which will be
3741     * left unmanaged and should be deleted by the developer, manually handled
3742     * or set as child of some other container.
3743     *
3744     * @param obj The window object
3745     * @param subobj The resize object to add
3746     */
3747    EAPI void         elm_win_resize_object_del(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3748    /**
3749     * Set the title of the window
3750     *
3751     * @param obj The window object
3752     * @param title The title to set
3753     */
3754    EAPI void         elm_win_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
3755    /**
3756     * Get the title of the window
3757     *
3758     * The returned string is an internal one and should not be freed or
3759     * modified. It will also be rendered invalid if a new title is set or if
3760     * the window is destroyed.
3761     *
3762     * @param obj The window object
3763     * @return The title
3764     */
3765    EAPI const char  *elm_win_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3766    /**
3767     * Set the window's autodel state.
3768     *
3769     * When closing the window in any way outside of the program control, like
3770     * pressing the X button in the titlebar or using a command from the
3771     * Window Manager, a "delete,request" signal is emitted to indicate that
3772     * this event occurred and the developer can take any action, which may
3773     * include, or not, destroying the window object.
3774     *
3775     * When the @p autodel parameter is set, the window will be automatically
3776     * destroyed when this event occurs, after the signal is emitted.
3777     * If @p autodel is @c EINA_FALSE, then the window will not be destroyed
3778     * and is up to the program to do so when it's required.
3779     *
3780     * @param obj The window object
3781     * @param autodel If true, the window will automatically delete itself when
3782     * closed
3783     */
3784    EAPI void         elm_win_autodel_set(Evas_Object *obj, Eina_Bool autodel) EINA_ARG_NONNULL(1);
3785    /**
3786     * Get the window's autodel state.
3787     *
3788     * @param obj The window object
3789     * @return If the window will automatically delete itself when closed
3790     *
3791     * @see elm_win_autodel_set()
3792     */
3793    EAPI Eina_Bool    elm_win_autodel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3794    /**
3795     * Activate a window object.
3796     *
3797     * This function sends a request to the Window Manager to activate the
3798     * window pointed by @p obj. If honored by the WM, the window will receive
3799     * the keyboard focus.
3800     *
3801     * @note This is just a request that a Window Manager may ignore, so calling
3802     * this function does not ensure in any way that the window will be the
3803     * active one after it.
3804     *
3805     * @param obj The window object
3806     */
3807    EAPI void         elm_win_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
3808    /**
3809     * Lower a window object.
3810     *
3811     * Places the window pointed by @p obj at the bottom of the stack, so that
3812     * no other window is covered by it.
3813     *
3814     * If elm_win_override_set() is not set, the Window Manager may ignore this
3815     * request.
3816     *
3817     * @param obj The window object
3818     */
3819    EAPI void         elm_win_lower(Evas_Object *obj) EINA_ARG_NONNULL(1);
3820    /**
3821     * Raise a window object.
3822     *
3823     * Places the window pointed by @p obj at the top of the stack, so that it's
3824     * not covered by any other window.
3825     *
3826     * If elm_win_override_set() is not set, the Window Manager may ignore this
3827     * request.
3828     *
3829     * @param obj The window object
3830     */
3831    EAPI void         elm_win_raise(Evas_Object *obj) EINA_ARG_NONNULL(1);
3832    /**
3833     * Set the borderless state of a window.
3834     *
3835     * This function requests the Window Manager to not draw any decoration
3836     * around the window.
3837     *
3838     * @param obj The window object
3839     * @param borderless If true, the window is borderless
3840     */
3841    EAPI void         elm_win_borderless_set(Evas_Object *obj, Eina_Bool borderless) EINA_ARG_NONNULL(1);
3842    /**
3843     * Get the borderless state of a window.
3844     *
3845     * @param obj The window object
3846     * @return If true, the window is borderless
3847     */
3848    EAPI Eina_Bool    elm_win_borderless_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3849    /**
3850     * Set the shaped state of a window.
3851     *
3852     * Shaped windows, when supported, will render the parts of the window that
3853     * has no content, transparent.
3854     *
3855     * If @p shaped is EINA_FALSE, then it is strongly adviced to have some
3856     * background object or cover the entire window in any other way, or the
3857     * parts of the canvas that have no data will show framebuffer artifacts.
3858     *
3859     * @param obj The window object
3860     * @param shaped If true, the window is shaped
3861     *
3862     * @see elm_win_alpha_set()
3863     */
3864    EAPI void         elm_win_shaped_set(Evas_Object *obj, Eina_Bool shaped) EINA_ARG_NONNULL(1);
3865    /**
3866     * Get the shaped state of a window.
3867     *
3868     * @param obj The window object
3869     * @return If true, the window is shaped
3870     *
3871     * @see elm_win_shaped_set()
3872     */
3873    EAPI Eina_Bool    elm_win_shaped_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3874    /**
3875     * Set the alpha channel state of a window.
3876     *
3877     * If @p alpha is EINA_TRUE, the alpha channel of the canvas will be enabled
3878     * possibly making parts of the window completely or partially transparent.
3879     * This is also subject to the underlying system supporting it, like for
3880     * example, running under a compositing manager. If no compositing is
3881     * available, enabling this option will instead fallback to using shaped
3882     * windows, with elm_win_shaped_set().
3883     *
3884     * @param obj The window object
3885     * @param alpha If true, the window has an alpha channel
3886     *
3887     * @see elm_win_alpha_set()
3888     */
3889    EAPI void         elm_win_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
3890    /**
3891     * Get the transparency state of a window.
3892     *
3893     * @param obj The window object
3894     * @return If true, the window is transparent
3895     *
3896     * @see elm_win_transparent_set()
3897     */
3898    EAPI Eina_Bool    elm_win_transparent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3899    /**
3900     * Set the transparency state of a window.
3901     *
3902     * Use elm_win_alpha_set() instead.
3903     *
3904     * @param obj The window object
3905     * @param transparent If true, the window is transparent
3906     *
3907     * @see elm_win_alpha_set()
3908     */
3909    EAPI void         elm_win_transparent_set(Evas_Object *obj, Eina_Bool transparent) EINA_ARG_NONNULL(1);
3910    /**
3911     * Get the alpha channel state of a window.
3912     *
3913     * @param obj The window object
3914     * @return If true, the window has an alpha channel
3915     */
3916    EAPI Eina_Bool    elm_win_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3917    /**
3918     * Set the override state of a window.
3919     *
3920     * A window with @p override set to EINA_TRUE will not be managed by the
3921     * Window Manager. This means that no decorations of any kind will be shown
3922     * for it, moving and resizing must be handled by the application, as well
3923     * as the window visibility.
3924     *
3925     * This should not be used for normal windows, and even for not so normal
3926     * ones, it should only be used when there's a good reason and with a lot
3927     * of care. Mishandling override windows may result situations that
3928     * disrupt the normal workflow of the end user.
3929     *
3930     * @param obj The window object
3931     * @param override If true, the window is overridden
3932     */
3933    EAPI void         elm_win_override_set(Evas_Object *obj, Eina_Bool override) EINA_ARG_NONNULL(1);
3934    /**
3935     * Get the override state of a window.
3936     *
3937     * @param obj The window object
3938     * @return If true, the window is overridden
3939     *
3940     * @see elm_win_override_set()
3941     */
3942    EAPI Eina_Bool    elm_win_override_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3943    /**
3944     * Set the fullscreen state of a window.
3945     *
3946     * @param obj The window object
3947     * @param fullscreen If true, the window is fullscreen
3948     */
3949    EAPI void         elm_win_fullscreen_set(Evas_Object *obj, Eina_Bool fullscreen) EINA_ARG_NONNULL(1);
3950    /**
3951     * Get the fullscreen state of a window.
3952     *
3953     * @param obj The window object
3954     * @return If true, the window is fullscreen
3955     */
3956    EAPI Eina_Bool    elm_win_fullscreen_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3957    /**
3958     * Set the maximized state of a window.
3959     *
3960     * @param obj The window object
3961     * @param maximized If true, the window is maximized
3962     */
3963    EAPI void         elm_win_maximized_set(Evas_Object *obj, Eina_Bool maximized) EINA_ARG_NONNULL(1);
3964    /**
3965     * Get the maximized state of a window.
3966     *
3967     * @param obj The window object
3968     * @return If true, the window is maximized
3969     */
3970    EAPI Eina_Bool    elm_win_maximized_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3971    /**
3972     * Set the iconified state of a window.
3973     *
3974     * @param obj The window object
3975     * @param iconified If true, the window is iconified
3976     */
3977    EAPI void         elm_win_iconified_set(Evas_Object *obj, Eina_Bool iconified) EINA_ARG_NONNULL(1);
3978    /**
3979     * Get the iconified state of a window.
3980     *
3981     * @param obj The window object
3982     * @return If true, the window is iconified
3983     */
3984    EAPI Eina_Bool    elm_win_iconified_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3985    /**
3986     * Set the layer of the window.
3987     *
3988     * What this means exactly will depend on the underlying engine used.
3989     *
3990     * In the case of X11 backed engines, the value in @p layer has the
3991     * following meanings:
3992     * @li < 3: The window will be placed below all others.
3993     * @li > 5: The window will be placed above all others.
3994     * @li other: The window will be placed in the default layer.
3995     *
3996     * @param obj The window object
3997     * @param layer The layer of the window
3998     */
3999    EAPI void         elm_win_layer_set(Evas_Object *obj, int layer) EINA_ARG_NONNULL(1);
4000    /**
4001     * Get the layer of the window.
4002     *
4003     * @param obj The window object
4004     * @return The layer of the window
4005     *
4006     * @see elm_win_layer_set()
4007     */
4008    EAPI int          elm_win_layer_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4009    /**
4010     * Set the rotation of the window.
4011     *
4012     * Most engines only work with multiples of 90.
4013     *
4014     * This function is used to set the orientation of the window @p obj to
4015     * match that of the screen. The window itself will be resized to adjust
4016     * to the new geometry of its contents. If you want to keep the window size,
4017     * see elm_win_rotation_with_resize_set().
4018     *
4019     * @param obj The window object
4020     * @param rotation The rotation of the window, in degrees (0-360),
4021     * counter-clockwise.
4022     */
4023    EAPI void         elm_win_rotation_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
4024    /**
4025     * Rotates the window and resizes it.
4026     *
4027     * Like elm_win_rotation_set(), but it also resizes the window's contents so
4028     * that they fit inside the current window geometry.
4029     *
4030     * @param obj The window object
4031     * @param layer The rotation of the window in degrees (0-360),
4032     * counter-clockwise.
4033     */
4034    EAPI void         elm_win_rotation_with_resize_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
4035    /**
4036     * Get the rotation of the window.
4037     *
4038     * @param obj The window object
4039     * @return The rotation of the window in degrees (0-360)
4040     *
4041     * @see elm_win_rotation_set()
4042     * @see elm_win_rotation_with_resize_set()
4043     */
4044    EAPI int          elm_win_rotation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4045    /**
4046     * Set the sticky state of the window.
4047     *
4048     * Hints the Window Manager that the window in @p obj should be left fixed
4049     * at its position even when the virtual desktop it's on moves or changes.
4050     *
4051     * @param obj The window object
4052     * @param sticky If true, the window's sticky state is enabled
4053     */
4054    EAPI void         elm_win_sticky_set(Evas_Object *obj, Eina_Bool sticky) EINA_ARG_NONNULL(1);
4055    /**
4056     * Get the sticky state of the window.
4057     *
4058     * @param obj The window object
4059     * @return If true, the window's sticky state is enabled
4060     *
4061     * @see elm_win_sticky_set()
4062     */
4063    EAPI Eina_Bool    elm_win_sticky_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4064    /**
4065     * Set if this window is an illume conformant window
4066     *
4067     * @param obj The window object
4068     * @param conformant The conformant flag (1 = conformant, 0 = non-conformant)
4069     */
4070    EAPI void         elm_win_conformant_set(Evas_Object *obj, Eina_Bool conformant) EINA_ARG_NONNULL(1);
4071    /**
4072     * Get if this window is an illume conformant window
4073     *
4074     * @param obj The window object
4075     * @return A boolean if this window is illume conformant or not
4076     */
4077    EAPI Eina_Bool    elm_win_conformant_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4078    /**
4079     * Set a window to be an illume quickpanel window
4080     *
4081     * By default window objects are not quickpanel windows.
4082     *
4083     * @param obj The window object
4084     * @param quickpanel The quickpanel flag (1 = quickpanel, 0 = normal window)
4085     */
4086    EAPI void         elm_win_quickpanel_set(Evas_Object *obj, Eina_Bool quickpanel) EINA_ARG_NONNULL(1);
4087    /**
4088     * Get if this window is a quickpanel or not
4089     *
4090     * @param obj The window object
4091     * @return A boolean if this window is a quickpanel or not
4092     */
4093    EAPI Eina_Bool    elm_win_quickpanel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4094    /**
4095     * Set the major priority of a quickpanel window
4096     *
4097     * @param obj The window object
4098     * @param priority The major priority for this quickpanel
4099     */
4100    EAPI void         elm_win_quickpanel_priority_major_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
4101    /**
4102     * Get the major priority of a quickpanel window
4103     *
4104     * @param obj The window object
4105     * @return The major priority of this quickpanel
4106     */
4107    EAPI int          elm_win_quickpanel_priority_major_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4108    /**
4109     * Set the minor priority of a quickpanel window
4110     *
4111     * @param obj The window object
4112     * @param priority The minor priority for this quickpanel
4113     */
4114    EAPI void         elm_win_quickpanel_priority_minor_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
4115    /**
4116     * Get the minor priority of a quickpanel window
4117     *
4118     * @param obj The window object
4119     * @return The minor priority of this quickpanel
4120     */
4121    EAPI int          elm_win_quickpanel_priority_minor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4122    /**
4123     * Set which zone this quickpanel should appear in
4124     *
4125     * @param obj The window object
4126     * @param zone The requested zone for this quickpanel
4127     */
4128    EAPI void         elm_win_quickpanel_zone_set(Evas_Object *obj, int zone) EINA_ARG_NONNULL(1);
4129    /**
4130     * Get which zone this quickpanel should appear in
4131     *
4132     * @param obj The window object
4133     * @return The requested zone for this quickpanel
4134     */
4135    EAPI int          elm_win_quickpanel_zone_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4136    /**
4137     * Set the window to be skipped by keyboard focus
4138     *
4139     * This sets the window to be skipped by normal keyboard input. This means
4140     * a window manager will be asked to not focus this window as well as omit
4141     * it from things like the taskbar, pager, "alt-tab" list etc. etc.
4142     *
4143     * Call this and enable it on a window BEFORE you show it for the first time,
4144     * otherwise it may have no effect.
4145     *
4146     * Use this for windows that have only output information or might only be
4147     * interacted with by the mouse or fingers, and never for typing input.
4148     * Be careful that this may have side-effects like making the window
4149     * non-accessible in some cases unless the window is specially handled. Use
4150     * this with care.
4151     *
4152     * @param obj The window object
4153     * @param skip The skip flag state (EINA_TRUE if it is to be skipped)
4154     */
4155    EAPI void         elm_win_prop_focus_skip_set(Evas_Object *obj, Eina_Bool skip) EINA_ARG_NONNULL(1);
4156    /**
4157     * Send a command to the windowing environment
4158     *
4159     * This is intended to work in touchscreen or small screen device
4160     * environments where there is a more simplistic window management policy in
4161     * place. This uses the window object indicated to select which part of the
4162     * environment to control (the part that this window lives in), and provides
4163     * a command and an optional parameter structure (use NULL for this if not
4164     * needed).
4165     *
4166     * @param obj The window object that lives in the environment to control
4167     * @param command The command to send
4168     * @param params Optional parameters for the command
4169     */
4170    EAPI void         elm_win_illume_command_send(Evas_Object *obj, Elm_Illume_Command command, void *params) EINA_ARG_NONNULL(1);
4171    /**
4172     * Get the inlined image object handle
4173     *
4174     * When you create a window with elm_win_add() of type ELM_WIN_INLINED_IMAGE,
4175     * then the window is in fact an evas image object inlined in the parent
4176     * canvas. You can get this object (be careful to not manipulate it as it
4177     * is under control of elementary), and use it to do things like get pixel
4178     * data, save the image to a file, etc.
4179     *
4180     * @param obj The window object to get the inlined image from
4181     * @return The inlined image object, or NULL if none exists
4182     */
4183    EAPI Evas_Object *elm_win_inlined_image_object_get(Evas_Object *obj);
4184    /**
4185     * Set the enabled status for the focus highlight in a window
4186     *
4187     * This function will enable or disable the focus highlight only for the
4188     * given window, regardless of the global setting for it
4189     *
4190     * @param obj The window where to enable the highlight
4191     * @param enabled The enabled value for the highlight
4192     */
4193    EAPI void         elm_win_focus_highlight_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
4194    /**
4195     * Get the enabled value of the focus highlight for this window
4196     *
4197     * @param obj The window in which to check if the focus highlight is enabled
4198     *
4199     * @return EINA_TRUE if enabled, EINA_FALSE otherwise
4200     */
4201    EAPI Eina_Bool    elm_win_focus_highlight_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4202    /**
4203     * Set the style for the focus highlight on this window
4204     *
4205     * Sets the style to use for theming the highlight of focused objects on
4206     * the given window. If @p style is NULL, the default will be used.
4207     *
4208     * @param obj The window where to set the style
4209     * @param style The style to set
4210     */
4211    EAPI void         elm_win_focus_highlight_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
4212    /**
4213     * Get the style set for the focus highlight object
4214     *
4215     * Gets the style set for this windows highilght object, or NULL if none
4216     * is set.
4217     *
4218     * @param obj The window to retrieve the highlights style from
4219     *
4220     * @return The style set or NULL if none was. Default is used in that case.
4221     */
4222    EAPI const char  *elm_win_focus_highlight_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4223    EAPI void         elm_win_indicator_state_set(Evas_Object *obj, int show_state);
4224    EAPI int          elm_win_indicator_state_get(Evas_Object *obj);
4225    /*...
4226     * ecore_x_icccm_hints_set -> accepts_focus (add to ecore_evas)
4227     * ecore_x_icccm_hints_set -> window_group (add to ecore_evas)
4228     * ecore_x_icccm_size_pos_hints_set -> request_pos (add to ecore_evas)
4229     * ecore_x_icccm_client_leader_set -> l (add to ecore_evas)
4230     * ecore_x_icccm_window_role_set -> role (add to ecore_evas)
4231     * ecore_x_icccm_transient_for_set -> forwin (add to ecore_evas)
4232     * ecore_x_netwm_window_type_set -> type (add to ecore_evas)
4233     *
4234     * (add to ecore_x) set netwm argb icon! (add to ecore_evas)
4235     * (blank mouse, private mouse obj, defaultmouse)
4236     *
4237     */
4238    /**
4239     * Sets the keyboard mode of the window.
4240     *
4241     * @param obj The window object
4242     * @param mode The mode to set, one of #Elm_Win_Keyboard_Mode
4243     */
4244    EAPI void                  elm_win_keyboard_mode_set(Evas_Object *obj, Elm_Win_Keyboard_Mode mode) EINA_ARG_NONNULL(1);
4245    /**
4246     * Gets the keyboard mode of the window.
4247     *
4248     * @param obj The window object
4249     * @return The mode, one of #Elm_Win_Keyboard_Mode
4250     */
4251    EAPI Elm_Win_Keyboard_Mode elm_win_keyboard_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4252    /**
4253     * Sets whether the window is a keyboard.
4254     *
4255     * @param obj The window object
4256     * @param is_keyboard If true, the window is a virtual keyboard
4257     */
4258    EAPI void                  elm_win_keyboard_win_set(Evas_Object *obj, Eina_Bool is_keyboard) EINA_ARG_NONNULL(1);
4259    /**
4260     * Gets whether the window is a keyboard.
4261     *
4262     * @param obj The window object
4263     * @return If the window is a virtual keyboard
4264     */
4265    EAPI Eina_Bool             elm_win_keyboard_win_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4266
4267    /**
4268     * Get the screen position of a window.
4269     *
4270     * @param obj The window object
4271     * @param x The int to store the x coordinate to
4272     * @param y The int to store the y coordinate to
4273     */
4274    EAPI void                  elm_win_screen_position_get(const Evas_Object *obj, int *x, int *y) EINA_ARG_NONNULL(1);
4275    /**
4276     * @}
4277     */
4278
4279    /**
4280     * @defgroup Inwin Inwin
4281     *
4282     * @image html img/widget/inwin/preview-00.png
4283     * @image latex img/widget/inwin/preview-00.eps
4284     * @image html img/widget/inwin/preview-01.png
4285     * @image latex img/widget/inwin/preview-01.eps
4286     * @image html img/widget/inwin/preview-02.png
4287     * @image latex img/widget/inwin/preview-02.eps
4288     *
4289     * An inwin is a window inside a window that is useful for a quick popup.
4290     * It does not hover.
4291     *
4292     * It works by creating an object that will occupy the entire window, so it
4293     * must be created using an @ref Win "elm_win" as parent only. The inwin
4294     * object can be hidden or restacked below every other object if it's
4295     * needed to show what's behind it without destroying it. If this is done,
4296     * the elm_win_inwin_activate() function can be used to bring it back to
4297     * full visibility again.
4298     *
4299     * There are three styles available in the default theme. These are:
4300     * @li default: The inwin is sized to take over most of the window it's
4301     * placed in.
4302     * @li minimal: The size of the inwin will be the minimum necessary to show
4303     * its contents.
4304     * @li minimal_vertical: Horizontally, the inwin takes as much space as
4305     * possible, but it's sized vertically the most it needs to fit its\
4306     * contents.
4307     *
4308     * Some examples of Inwin can be found in the following:
4309     * @li @ref inwin_example_01
4310     *
4311     * @{
4312     */
4313    /**
4314     * Adds an inwin to the current window
4315     *
4316     * The @p obj used as parent @b MUST be an @ref Win "Elementary Window".
4317     * Never call this function with anything other than the top-most window
4318     * as its parameter, unless you are fond of undefined behavior.
4319     *
4320     * After creating the object, the widget will set itself as resize object
4321     * for the window with elm_win_resize_object_add(), so when shown it will
4322     * appear to cover almost the entire window (how much of it depends on its
4323     * content and the style used). It must not be added into other container
4324     * objects and it needs not be moved or resized manually.
4325     *
4326     * @param parent The parent object
4327     * @return The new object or NULL if it cannot be created
4328     */
4329    EAPI Evas_Object          *elm_win_inwin_add(Evas_Object *obj) EINA_ARG_NONNULL(1);
4330    /**
4331     * Activates an inwin object, ensuring its visibility
4332     *
4333     * This function will make sure that the inwin @p obj is completely visible
4334     * by calling evas_object_show() and evas_object_raise() on it, to bring it
4335     * to the front. It also sets the keyboard focus to it, which will be passed
4336     * onto its content.
4337     *
4338     * The object's theme will also receive the signal "elm,action,show" with
4339     * source "elm".
4340     *
4341     * @param obj The inwin to activate
4342     */
4343    EAPI void                  elm_win_inwin_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
4344    /**
4345     * Set the content of an inwin object.
4346     *
4347     * Once the content object is set, a previously set one will be deleted.
4348     * If you want to keep that old content object, use the
4349     * elm_win_inwin_content_unset() function.
4350     *
4351     * @param obj The inwin object
4352     * @param content The object to set as content
4353     */
4354    EAPI void                  elm_win_inwin_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
4355    /**
4356     * Get the content of an inwin object.
4357     *
4358     * Return the content object which is set for this widget.
4359     *
4360     * The returned object is valid as long as the inwin is still alive and no
4361     * other content is set on it. Deleting the object will notify the inwin
4362     * about it and this one will be left empty.
4363     *
4364     * If you need to remove an inwin's content to be reused somewhere else,
4365     * see elm_win_inwin_content_unset().
4366     *
4367     * @param obj The inwin object
4368     * @return The content that is being used
4369     */
4370    EAPI Evas_Object          *elm_win_inwin_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4371    /**
4372     * Unset the content of an inwin object.
4373     *
4374     * Unparent and return the content object which was set for this widget.
4375     *
4376     * @param obj The inwin object
4377     * @return The content that was being used
4378     */
4379    EAPI Evas_Object          *elm_win_inwin_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4380    /**
4381     * @}
4382     */
4383    /* X specific calls - won't work on non-x engines (return 0) */
4384
4385    /**
4386     * Get the Ecore_X_Window of an Evas_Object
4387     *
4388     * @param obj The object
4389     *
4390     * @return The Ecore_X_Window of @p obj
4391     *
4392     * @ingroup Win
4393     */
4394    EAPI Ecore_X_Window elm_win_xwindow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4395
4396    /* smart callbacks called:
4397     * "delete,request" - the user requested to delete the window
4398     * "focus,in" - window got focus
4399     * "focus,out" - window lost focus
4400     * "moved" - window that holds the canvas was moved
4401     */
4402
4403    /**
4404     * @defgroup Bg Bg
4405     *
4406     * @image html img/widget/bg/preview-00.png
4407     * @image latex img/widget/bg/preview-00.eps
4408     *
4409     * @brief Background object, used for setting a solid color, image or Edje
4410     * group as background to a window or any container object.
4411     *
4412     * The bg object is used for setting a solid background to a window or
4413     * packing into any container object. It works just like an image, but has
4414     * some properties useful to a background, like setting it to tiled,
4415     * centered, scaled or stretched.
4416     * 
4417     * Default contents parts of the bg widget that you can use for are:
4418     * @li "elm.swallow.content" - overlay of the bg
4419     *
4420     * Here is some sample code using it:
4421     * @li @ref bg_01_example_page
4422     * @li @ref bg_02_example_page
4423     * @li @ref bg_03_example_page
4424     */
4425
4426    /* bg */
4427    typedef enum _Elm_Bg_Option
4428      {
4429         ELM_BG_OPTION_CENTER,  /**< center the background */
4430         ELM_BG_OPTION_SCALE,   /**< scale the background retaining aspect ratio */
4431         ELM_BG_OPTION_STRETCH, /**< stretch the background to fill */
4432         ELM_BG_OPTION_TILE     /**< tile background at its original size */
4433      } Elm_Bg_Option;
4434
4435    /**
4436     * Add a new background to the parent
4437     *
4438     * @param parent The parent object
4439     * @return The new object or NULL if it cannot be created
4440     *
4441     * @ingroup Bg
4442     */
4443    EAPI Evas_Object  *elm_bg_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4444
4445    /**
4446     * Set the file (image or edje) used for the background
4447     *
4448     * @param obj The bg object
4449     * @param file The file path
4450     * @param group Optional key (group in Edje) within the file
4451     *
4452     * This sets the image file used in the background object. The image (or edje)
4453     * will be stretched (retaining aspect if its an image file) to completely fill
4454     * the bg object. This may mean some parts are not visible.
4455     *
4456     * @note  Once the image of @p obj is set, a previously set one will be deleted,
4457     * even if @p file is NULL.
4458     *
4459     * @ingroup Bg
4460     */
4461    EAPI void          elm_bg_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
4462
4463    /**
4464     * Get the file (image or edje) used for the background
4465     *
4466     * @param obj The bg object
4467     * @param file The file path
4468     * @param group Optional key (group in Edje) within the file
4469     *
4470     * @ingroup Bg
4471     */
4472    EAPI void          elm_bg_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4473
4474    /**
4475     * Set the option used for the background image
4476     *
4477     * @param obj The bg object
4478     * @param option The desired background option (TILE, SCALE)
4479     *
4480     * This sets the option used for manipulating the display of the background
4481     * image. The image can be tiled or scaled.
4482     *
4483     * @ingroup Bg
4484     */
4485    EAPI void          elm_bg_option_set(Evas_Object *obj, Elm_Bg_Option option) EINA_ARG_NONNULL(1);
4486
4487    /**
4488     * Get the option used for the background image
4489     *
4490     * @param obj The bg object
4491     * @return The desired background option (CENTER, SCALE, STRETCH or TILE)
4492     *
4493     * @ingroup Bg
4494     */
4495    EAPI Elm_Bg_Option elm_bg_option_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4496    /**
4497     * Set the option used for the background color
4498     *
4499     * @param obj The bg object
4500     * @param r
4501     * @param g
4502     * @param b
4503     *
4504     * This sets the color used for the background rectangle. Its range goes
4505     * from 0 to 255.
4506     *
4507     * @ingroup Bg
4508     */
4509    EAPI void          elm_bg_color_set(Evas_Object *obj, int r, int g, int b) EINA_ARG_NONNULL(1);
4510    /**
4511     * Get the option used for the background color
4512     *
4513     * @param obj The bg object
4514     * @param r
4515     * @param g
4516     * @param b
4517     *
4518     * @ingroup Bg
4519     */
4520    EAPI void          elm_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b) EINA_ARG_NONNULL(1);
4521
4522    /**
4523     * Set the overlay object used for the background object.
4524     *
4525     * @param obj The bg object
4526     * @param overlay The overlay object
4527     *
4528     * This provides a way for elm_bg to have an 'overlay' that will be on top
4529     * of the bg. Once the over object is set, a previously set one will be
4530     * deleted, even if you set the new one to NULL. If you want to keep that
4531     * old content object, use the elm_bg_overlay_unset() function.
4532     *
4533     * @ingroup Bg
4534     */
4535
4536    EINA_DEPRECATED EAPI void          elm_bg_overlay_set(Evas_Object *obj, Evas_Object *overlay) EINA_ARG_NONNULL(1);
4537
4538    /**
4539     * Get the overlay object used for the background object.
4540     *
4541     * @param obj The bg object
4542     * @return The content that is being used
4543     *
4544     * Return the content object which is set for this widget
4545     *
4546     * @ingroup Bg
4547     */
4548    EINA_DEPRECATED EAPI Evas_Object  *elm_bg_overlay_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4549
4550    /**
4551     * Get the overlay object used for the background object.
4552     *
4553     * @param obj The bg object
4554     * @return The content that was being used
4555     *
4556     * Unparent and return the overlay object which was set for this widget
4557     *
4558     * @ingroup Bg
4559     */
4560    EINA_DEPRECATED EAPI Evas_Object  *elm_bg_overlay_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4561
4562    /**
4563     * Set the size of the pixmap representation of the image.
4564     *
4565     * This option just makes sense if an image is going to be set in the bg.
4566     *
4567     * @param obj The bg object
4568     * @param w The new width of the image pixmap representation.
4569     * @param h The new height of the image pixmap representation.
4570     *
4571     * This function sets a new size for pixmap representation of the given bg
4572     * image. It allows the image to be loaded already in the specified size,
4573     * reducing the memory usage and load time when loading a big image with load
4574     * size set to a smaller size.
4575     *
4576     * NOTE: this is just a hint, the real size of the pixmap may differ
4577     * depending on the type of image being loaded, being bigger than requested.
4578     *
4579     * @ingroup Bg
4580     */
4581    EAPI void          elm_bg_load_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
4582    /* smart callbacks called:
4583     */
4584
4585    /**
4586     * @defgroup Icon Icon
4587     *
4588     * @image html img/widget/icon/preview-00.png
4589     * @image latex img/widget/icon/preview-00.eps
4590     *
4591     * An object that provides standard icon images (delete, edit, arrows, etc.)
4592     * or a custom file (PNG, JPG, EDJE, etc.) used for an icon.
4593     *
4594     * The icon image requested can be in the elementary theme, or in the
4595     * freedesktop.org paths. It's possible to set the order of preference from
4596     * where the image will be used.
4597     *
4598     * This API is very similar to @ref Image, but with ready to use images.
4599     *
4600     * Default images provided by the theme are described below.
4601     *
4602     * The first list contains icons that were first intended to be used in
4603     * toolbars, but can be used in many other places too:
4604     * @li home
4605     * @li close
4606     * @li apps
4607     * @li arrow_up
4608     * @li arrow_down
4609     * @li arrow_left
4610     * @li arrow_right
4611     * @li chat
4612     * @li clock
4613     * @li delete
4614     * @li edit
4615     * @li refresh
4616     * @li folder
4617     * @li file
4618     *
4619     * Now some icons that were designed to be used in menus (but again, you can
4620     * use them anywhere else):
4621     * @li menu/home
4622     * @li menu/close
4623     * @li menu/apps
4624     * @li menu/arrow_up
4625     * @li menu/arrow_down
4626     * @li menu/arrow_left
4627     * @li menu/arrow_right
4628     * @li menu/chat
4629     * @li menu/clock
4630     * @li menu/delete
4631     * @li menu/edit
4632     * @li menu/refresh
4633     * @li menu/folder
4634     * @li menu/file
4635     *
4636     * And here we have some media player specific icons:
4637     * @li media_player/forward
4638     * @li media_player/info
4639     * @li media_player/next
4640     * @li media_player/pause
4641     * @li media_player/play
4642     * @li media_player/prev
4643     * @li media_player/rewind
4644     * @li media_player/stop
4645     *
4646     * Signals that you can add callbacks for are:
4647     *
4648     * "clicked" - This is called when a user has clicked the icon
4649     *
4650     * An example of usage for this API follows:
4651     * @li @ref tutorial_icon
4652     */
4653
4654    /**
4655     * @addtogroup Icon
4656     * @{
4657     */
4658
4659    typedef enum _Elm_Icon_Type
4660      {
4661         ELM_ICON_NONE,
4662         ELM_ICON_FILE,
4663         ELM_ICON_STANDARD
4664      } Elm_Icon_Type;
4665    /**
4666     * @enum _Elm_Icon_Lookup_Order
4667     * @typedef Elm_Icon_Lookup_Order
4668     *
4669     * Lookup order used by elm_icon_standard_set(). Should look for icons in the
4670     * theme, FDO paths, or both?
4671     *
4672     * @ingroup Icon
4673     */
4674    typedef enum _Elm_Icon_Lookup_Order
4675      {
4676         ELM_ICON_LOOKUP_FDO_THEME, /**< icon look up order: freedesktop, theme */
4677         ELM_ICON_LOOKUP_THEME_FDO, /**< icon look up order: theme, freedesktop */
4678         ELM_ICON_LOOKUP_FDO,       /**< icon look up order: freedesktop */
4679         ELM_ICON_LOOKUP_THEME      /**< icon look up order: theme */
4680      } Elm_Icon_Lookup_Order;
4681
4682    /**
4683     * Add a new icon object to the parent.
4684     *
4685     * @param parent The parent object
4686     * @return The new object or NULL if it cannot be created
4687     *
4688     * @see elm_icon_file_set()
4689     *
4690     * @ingroup Icon
4691     */
4692    EAPI Evas_Object          *elm_icon_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4693    /**
4694     * Set the file that will be used as icon.
4695     *
4696     * @param obj The icon object
4697     * @param file The path to file that will be used as icon image
4698     * @param group The group that the icon belongs to an edje file
4699     *
4700     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4701     *
4702     * @note The icon image set by this function can be changed by
4703     * elm_icon_standard_set().
4704     *
4705     * @see elm_icon_file_get()
4706     *
4707     * @ingroup Icon
4708     */
4709    EAPI Eina_Bool             elm_icon_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
4710    /**
4711     * Set a location in memory to be used as an icon
4712     *
4713     * @param obj The icon object
4714     * @param img The binary data that will be used as an image
4715     * @param size The size of binary data @p img
4716     * @param format Optional format of @p img to pass to the image loader
4717     * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
4718     *
4719     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4720     *
4721     * @note The icon image set by this function can be changed by
4722     * elm_icon_standard_set().
4723     *
4724     * @ingroup Icon
4725     */
4726    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);
4727    /**
4728     * Get the file that will be used as icon.
4729     *
4730     * @param obj The icon object
4731     * @param file The path to file that will be used as the icon image
4732     * @param group The group that the icon belongs to, in edje file
4733     *
4734     * @see elm_icon_file_set()
4735     *
4736     * @ingroup Icon
4737     */
4738    EAPI void                  elm_icon_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4739    EAPI void                  elm_icon_thumb_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
4740    /**
4741     * Set the icon by icon standards names.
4742     *
4743     * @param obj The icon object
4744     * @param name The icon name
4745     *
4746     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4747     *
4748     * For example, freedesktop.org defines standard icon names such as "home",
4749     * "network", etc. There can be different icon sets to match those icon
4750     * keys. The @p name given as parameter is one of these "keys", and will be
4751     * used to look in the freedesktop.org paths and elementary theme. One can
4752     * change the lookup order with elm_icon_order_lookup_set().
4753     *
4754     * If name is not found in any of the expected locations and it is the
4755     * absolute path of an image file, this image will be used.
4756     *
4757     * @note The icon image set by this function can be changed by
4758     * elm_icon_file_set().
4759     *
4760     * @see elm_icon_standard_get()
4761     * @see elm_icon_file_set()
4762     *
4763     * @ingroup Icon
4764     */
4765    EAPI Eina_Bool             elm_icon_standard_set(Evas_Object *obj, const char *name) EINA_ARG_NONNULL(1);
4766    /**
4767     * Get the icon name set by icon standard names.
4768     *
4769     * @param obj The icon object
4770     * @return The icon name
4771     *
4772     * If the icon image was set using elm_icon_file_set() instead of
4773     * elm_icon_standard_set(), then this function will return @c NULL.
4774     *
4775     * @see elm_icon_standard_set()
4776     *
4777     * @ingroup Icon
4778     */
4779    EAPI const char           *elm_icon_standard_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4780    /**
4781     * Set the smooth scaling for an icon object.
4782     *
4783     * @param obj The icon object
4784     * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
4785     * otherwise. Default is @c EINA_TRUE.
4786     *
4787     * Set the scaling algorithm to be used when scaling the icon image. Smooth
4788     * scaling provides a better resulting image, but is slower.
4789     *
4790     * The smooth scaling should be disabled when making animations that change
4791     * the icon size, since they will be faster. Animations that don't require
4792     * resizing of the icon can keep the smooth scaling enabled (even if the icon
4793     * is already scaled, since the scaled icon image will be cached).
4794     *
4795     * @see elm_icon_smooth_get()
4796     *
4797     * @ingroup Icon
4798     */
4799    EAPI void                  elm_icon_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
4800    /**
4801     * Get whether smooth scaling is enabled for an icon object.
4802     *
4803     * @param obj The icon object
4804     * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
4805     *
4806     * @see elm_icon_smooth_set()
4807     *
4808     * @ingroup Icon
4809     */
4810    EAPI Eina_Bool             elm_icon_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4811    /**
4812     * Disable scaling of this object.
4813     *
4814     * @param obj The icon object.
4815     * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
4816     * otherwise. Default is @c EINA_FALSE.
4817     *
4818     * This function disables scaling of the icon object through the function
4819     * elm_object_scale_set(). However, this does not affect the object
4820     * size/resize in any way. For that effect, take a look at
4821     * elm_icon_scale_set().
4822     *
4823     * @see elm_icon_no_scale_get()
4824     * @see elm_icon_scale_set()
4825     * @see elm_object_scale_set()
4826     *
4827     * @ingroup Icon
4828     */
4829    EAPI void                  elm_icon_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
4830    /**
4831     * Get whether scaling is disabled on the object.
4832     *
4833     * @param obj The icon object
4834     * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
4835     *
4836     * @see elm_icon_no_scale_set()
4837     *
4838     * @ingroup Icon
4839     */
4840    EAPI Eina_Bool             elm_icon_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4841    /**
4842     * Set if the object is (up/down) resizable.
4843     *
4844     * @param obj The icon object
4845     * @param scale_up A bool to set if the object is resizable up. Default is
4846     * @c EINA_TRUE.
4847     * @param scale_down A bool to set if the object is resizable down. Default
4848     * is @c EINA_TRUE.
4849     *
4850     * This function limits the icon object resize ability. If @p scale_up is set to
4851     * @c EINA_FALSE, the object can't have its height or width resized to a value
4852     * higher than the original icon size. Same is valid for @p scale_down.
4853     *
4854     * @see elm_icon_scale_get()
4855     *
4856     * @ingroup Icon
4857     */
4858    EAPI void                  elm_icon_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
4859    /**
4860     * Get if the object is (up/down) resizable.
4861     *
4862     * @param obj The icon object
4863     * @param scale_up A bool to set if the object is resizable up
4864     * @param scale_down A bool to set if the object is resizable down
4865     *
4866     * @see elm_icon_scale_set()
4867     *
4868     * @ingroup Icon
4869     */
4870    EAPI void                  elm_icon_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
4871    /**
4872     * Get the object's image size
4873     *
4874     * @param obj The icon object
4875     * @param w A pointer to store the width in
4876     * @param h A pointer to store the height in
4877     *
4878     * @ingroup Icon
4879     */
4880    EAPI void                  elm_icon_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
4881    /**
4882     * Set if the icon fill the entire object area.
4883     *
4884     * @param obj The icon object
4885     * @param fill_outside @c EINA_TRUE if the object is filled outside,
4886     * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
4887     *
4888     * When the icon object is resized to a different aspect ratio from the
4889     * original icon image, the icon image will still keep its aspect. This flag
4890     * tells how the image should fill the object's area. They are: keep the
4891     * entire icon inside the limits of height and width of the object (@p
4892     * fill_outside is @c EINA_FALSE) or let the extra width or height go outside
4893     * of the object, and the icon will fill the entire object (@p fill_outside
4894     * is @c EINA_TRUE).
4895     *
4896     * @note Unlike @ref Image, there's no option in icon to set the aspect ratio
4897     * retain property to false. Thus, the icon image will always keep its
4898     * original aspect ratio.
4899     *
4900     * @see elm_icon_fill_outside_get()
4901     * @see elm_image_fill_outside_set()
4902     *
4903     * @ingroup Icon
4904     */
4905    EAPI void                  elm_icon_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
4906    /**
4907     * Get if the object is filled outside.
4908     *
4909     * @param obj The icon object
4910     * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
4911     *
4912     * @see elm_icon_fill_outside_set()
4913     *
4914     * @ingroup Icon
4915     */
4916    EAPI Eina_Bool             elm_icon_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4917    /**
4918     * Set the prescale size for the icon.
4919     *
4920     * @param obj The icon object
4921     * @param size The prescale size. This value is used for both width and
4922     * height.
4923     *
4924     * This function sets a new size for pixmap representation of the given
4925     * icon. It allows the icon to be loaded already in the specified size,
4926     * reducing the memory usage and load time when loading a big icon with load
4927     * size set to a smaller size.
4928     *
4929     * It's equivalent to the elm_bg_load_size_set() function for bg.
4930     *
4931     * @note this is just a hint, the real size of the pixmap may differ
4932     * depending on the type of icon being loaded, being bigger than requested.
4933     *
4934     * @see elm_icon_prescale_get()
4935     * @see elm_bg_load_size_set()
4936     *
4937     * @ingroup Icon
4938     */
4939    EAPI void                  elm_icon_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
4940    /**
4941     * Get the prescale size for the icon.
4942     *
4943     * @param obj The icon object
4944     * @return The prescale size
4945     *
4946     * @see elm_icon_prescale_set()
4947     *
4948     * @ingroup Icon
4949     */
4950    EAPI int                   elm_icon_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4951    /**
4952     * Sets the icon lookup order used by elm_icon_standard_set().
4953     *
4954     * @param obj The icon object
4955     * @param order The icon lookup order (can be one of
4956     * ELM_ICON_LOOKUP_FDO_THEME, ELM_ICON_LOOKUP_THEME_FDO, ELM_ICON_LOOKUP_FDO
4957     * or ELM_ICON_LOOKUP_THEME)
4958     *
4959     * @see elm_icon_order_lookup_get()
4960     * @see Elm_Icon_Lookup_Order
4961     *
4962     * @ingroup Icon
4963     */
4964    EAPI void                  elm_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
4965    /**
4966     * Gets the icon lookup order.
4967     *
4968     * @param obj The icon object
4969     * @return The icon lookup order
4970     *
4971     * @see elm_icon_order_lookup_set()
4972     * @see Elm_Icon_Lookup_Order
4973     *
4974     * @ingroup Icon
4975     */
4976    EAPI Elm_Icon_Lookup_Order elm_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4977    /**
4978     * Get if the icon supports animation or not.
4979     *
4980     * @param obj The icon object
4981     * @return @c EINA_TRUE if the icon supports animation,
4982     *         @c EINA_FALSE otherwise.
4983     *
4984     * Return if this elm icon's image can be animated. Currently Evas only
4985     * supports gif animation. If the return value is EINA_FALSE, other
4986     * elm_icon_animated_XXX APIs won't work.
4987     * @ingroup Icon
4988     */
4989    EAPI Eina_Bool           elm_icon_animated_available_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4990    /**
4991     * Set animation mode of the icon.
4992     *
4993     * @param obj The icon object
4994     * @param anim @c EINA_TRUE if the object do animation job,
4995     * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
4996     *
4997     * Since the default animation mode is set to EINA_FALSE, 
4998     * the icon is shown without animation.
4999     * This might be desirable when the application developer wants to show
5000     * a snapshot of the animated icon.
5001     * Set it to EINA_TRUE when the icon needs to be animated.
5002     * @ingroup Icon
5003     */
5004    EAPI void                elm_icon_animated_set(Evas_Object *obj, Eina_Bool animated) EINA_ARG_NONNULL(1);
5005    /**
5006     * Get animation mode of the icon.
5007     *
5008     * @param obj The icon object
5009     * @return The animation mode of the icon object
5010     * @see elm_icon_animated_set
5011     * @ingroup Icon
5012     */
5013    EAPI Eina_Bool           elm_icon_animated_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5014    /**
5015     * Set animation play mode of the icon.
5016     *
5017     * @param obj The icon object
5018     * @param play @c EINA_TRUE the object play animation images,
5019     * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5020     *
5021     * To play elm icon's animation, set play to EINA_TURE.
5022     * For example, you make gif player using this set/get API and click event.
5023     *
5024     * 1. Click event occurs
5025     * 2. Check play flag using elm_icon_animaged_play_get
5026     * 3. If elm icon was playing, set play to EINA_FALSE.
5027     *    Then animation will be stopped and vice versa
5028     * @ingroup Icon
5029     */
5030    EAPI void                elm_icon_animated_play_set(Evas_Object *obj, Eina_Bool play) EINA_ARG_NONNULL(1);
5031    /**
5032     * Get animation play mode of the icon.
5033     *
5034     * @param obj The icon object
5035     * @return The play mode of the icon object
5036     *
5037     * @see elm_icon_animated_play_get
5038     * @ingroup Icon
5039     */
5040    EAPI Eina_Bool           elm_icon_animated_play_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5041
5042    /* compatibility code to avoid API and ABI breaks */
5043    EINA_DEPRECATED EAPI extern inline void elm_icon_anim_set(Evas_Object *obj, Eina_Bool animated)
5044      {
5045         elm_icon_animated_set(obj, animated);
5046      }
5047
5048    EINA_DEPRECATED EAPI extern inline Eina_Bool elm_icon_anim_get(const Evas_Object *obj)
5049      {
5050         return elm_icon_animated_get(obj);
5051      }
5052
5053    EINA_DEPRECATED EAPI extern inline void elm_icon_anim_play_set(Evas_Object *obj, Eina_Bool play)
5054      {
5055         elm_icon_animated_play_set(obj, play);
5056      }
5057
5058    EINA_DEPRECATED EAPI extern inline Eina_Bool elm_icon_anim_play_get(const Evas_Object *obj)
5059      {
5060         return elm_icon_animated_play_get(obj);
5061      }
5062
5063    /**
5064     * @}
5065     */
5066
5067    /**
5068     * @defgroup Image Image
5069     *
5070     * @image html img/widget/image/preview-00.png
5071     * @image latex img/widget/image/preview-00.eps
5072
5073     *
5074     * An object that allows one to load an image file to it. It can be used
5075     * anywhere like any other elementary widget.
5076     *
5077     * This widget provides most of the functionality provided from @ref Bg or @ref
5078     * Icon, but with a slightly different API (use the one that fits better your
5079     * needs).
5080     *
5081     * The features not provided by those two other image widgets are:
5082     * @li allowing to get the basic @c Evas_Object with elm_image_object_get();
5083     * @li change the object orientation with elm_image_orient_set();
5084     * @li and turning the image editable with elm_image_editable_set().
5085     *
5086     * Signals that you can add callbacks for are:
5087     *
5088     * @li @c "clicked" - This is called when a user has clicked the image
5089     *
5090     * An example of usage for this API follows:
5091     * @li @ref tutorial_image
5092     */
5093
5094    /**
5095     * @addtogroup Image
5096     * @{
5097     */
5098
5099    /**
5100     * @enum _Elm_Image_Orient
5101     * @typedef Elm_Image_Orient
5102     *
5103     * Possible orientation options for elm_image_orient_set().
5104     *
5105     * @image html elm_image_orient_set.png
5106     * @image latex elm_image_orient_set.eps width=\textwidth
5107     *
5108     * @ingroup Image
5109     */
5110    typedef enum _Elm_Image_Orient
5111      {
5112         ELM_IMAGE_ORIENT_NONE, /**< no orientation change */
5113         ELM_IMAGE_ROTATE_90_CW, /**< rotate 90 degrees clockwise */
5114         ELM_IMAGE_ROTATE_180_CW, /**< rotate 180 degrees clockwise */
5115         ELM_IMAGE_ROTATE_90_CCW, /**< rotate 90 degrees counter-clockwise (i.e. 270 degrees clockwise) */
5116         ELM_IMAGE_FLIP_HORIZONTAL, /**< flip image horizontally */
5117         ELM_IMAGE_FLIP_VERTICAL, /**< flip image vertically */
5118         ELM_IMAGE_FLIP_TRANSPOSE, /**< flip the image along the y = (side - x) line*/
5119         ELM_IMAGE_FLIP_TRANSVERSE /**< flip the image along the y = x line */
5120      } Elm_Image_Orient;
5121
5122    /**
5123     * Add a new image to the parent.
5124     *
5125     * @param parent The parent object
5126     * @return The new object or NULL if it cannot be created
5127     *
5128     * @see elm_image_file_set()
5129     *
5130     * @ingroup Image
5131     */
5132    EAPI Evas_Object     *elm_image_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5133    /**
5134     * Set the file that will be used as image.
5135     *
5136     * @param obj The image object
5137     * @param file The path to file that will be used as image
5138     * @param group The group that the image belongs in edje file (if it's an
5139     * edje image)
5140     *
5141     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
5142     *
5143     * @see elm_image_file_get()
5144     *
5145     * @ingroup Image
5146     */
5147    EAPI Eina_Bool        elm_image_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
5148    /**
5149     * Get the file that will be used as image.
5150     *
5151     * @param obj The image object
5152     * @param file The path to file
5153     * @param group The group that the image belongs in edje file
5154     *
5155     * @see elm_image_file_set()
5156     *
5157     * @ingroup Image
5158     */
5159    EAPI void             elm_image_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
5160    /**
5161     * Set the smooth effect for an image.
5162     *
5163     * @param obj The image object
5164     * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
5165     * otherwise. Default is @c EINA_TRUE.
5166     *
5167     * Set the scaling algorithm to be used when scaling the image. Smooth
5168     * scaling provides a better resulting image, but is slower.
5169     *
5170     * The smooth scaling should be disabled when making animations that change
5171     * the image size, since it will be faster. Animations that don't require
5172     * resizing of the image can keep the smooth scaling enabled (even if the
5173     * image is already scaled, since the scaled image will be cached).
5174     *
5175     * @see elm_image_smooth_get()
5176     *
5177     * @ingroup Image
5178     */
5179    EAPI void             elm_image_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
5180    /**
5181     * Get the smooth effect for an image.
5182     *
5183     * @param obj The image object
5184     * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
5185     *
5186     * @see elm_image_smooth_get()
5187     *
5188     * @ingroup Image
5189     */
5190    EAPI Eina_Bool        elm_image_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5191
5192    /**
5193     * Gets the current size of the image.
5194     *
5195     * @param obj The image object.
5196     * @param w Pointer to store width, or NULL.
5197     * @param h Pointer to store height, or NULL.
5198     *
5199     * This is the real size of the image, not the size of the object.
5200     *
5201     * On error, neither w or h will be written.
5202     *
5203     * @ingroup Image
5204     */
5205    EAPI void             elm_image_object_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
5206    /**
5207     * Disable scaling of this object.
5208     *
5209     * @param obj The image object.
5210     * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
5211     * otherwise. Default is @c EINA_FALSE.
5212     *
5213     * This function disables scaling of the elm_image widget through the
5214     * function elm_object_scale_set(). However, this does not affect the widget
5215     * size/resize in any way. For that effect, take a look at
5216     * elm_image_scale_set().
5217     *
5218     * @see elm_image_no_scale_get()
5219     * @see elm_image_scale_set()
5220     * @see elm_object_scale_set()
5221     *
5222     * @ingroup Image
5223     */
5224    EAPI void             elm_image_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
5225    /**
5226     * Get whether scaling is disabled on the object.
5227     *
5228     * @param obj The image object
5229     * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
5230     *
5231     * @see elm_image_no_scale_set()
5232     *
5233     * @ingroup Image
5234     */
5235    EAPI Eina_Bool        elm_image_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5236    /**
5237     * Set if the object is (up/down) resizable.
5238     *
5239     * @param obj The image object
5240     * @param scale_up A bool to set if the object is resizable up. Default is
5241     * @c EINA_TRUE.
5242     * @param scale_down A bool to set if the object is resizable down. Default
5243     * is @c EINA_TRUE.
5244     *
5245     * This function limits the image resize ability. If @p scale_up is set to
5246     * @c EINA_FALSE, the object can't have its height or width resized to a value
5247     * higher than the original image size. Same is valid for @p scale_down.
5248     *
5249     * @see elm_image_scale_get()
5250     *
5251     * @ingroup Image
5252     */
5253    EAPI void             elm_image_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
5254    /**
5255     * Get if the object is (up/down) resizable.
5256     *
5257     * @param obj The image object
5258     * @param scale_up A bool to set if the object is resizable up
5259     * @param scale_down A bool to set if the object is resizable down
5260     *
5261     * @see elm_image_scale_set()
5262     *
5263     * @ingroup Image
5264     */
5265    EAPI void             elm_image_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
5266    /**
5267     * Set if the image fills the entire object area, when keeping the aspect ratio.
5268     *
5269     * @param obj The image object
5270     * @param fill_outside @c EINA_TRUE if the object is filled outside,
5271     * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5272     *
5273     * When the image should keep its aspect ratio even if resized to another
5274     * aspect ratio, there are two possibilities to resize it: keep the entire
5275     * image inside the limits of height and width of the object (@p fill_outside
5276     * is @c EINA_FALSE) or let the extra width or height go outside of the object,
5277     * and the image will fill the entire object (@p fill_outside is @c EINA_TRUE).
5278     *
5279     * @note This option will have no effect if
5280     * elm_image_aspect_ratio_retained_set() is set to @c EINA_FALSE.
5281     *
5282     * @see elm_image_fill_outside_get()
5283     * @see elm_image_aspect_ratio_retained_set()
5284     *
5285     * @ingroup Image
5286     */
5287    EAPI void             elm_image_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
5288    /**
5289     * Get if the object is filled outside
5290     *
5291     * @param obj The image object
5292     * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
5293     *
5294     * @see elm_image_fill_outside_set()
5295     *
5296     * @ingroup Image
5297     */
5298    EAPI Eina_Bool        elm_image_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5299    /**
5300     * Set the prescale size for the image
5301     *
5302     * @param obj The image object
5303     * @param size The prescale size. This value is used for both width and
5304     * height.
5305     *
5306     * This function sets a new size for pixmap representation of the given
5307     * image. It allows the image to be loaded already in the specified size,
5308     * reducing the memory usage and load time when loading a big image with load
5309     * size set to a smaller size.
5310     *
5311     * It's equivalent to the elm_bg_load_size_set() function for bg.
5312     *
5313     * @note this is just a hint, the real size of the pixmap may differ
5314     * depending on the type of image being loaded, being bigger than requested.
5315     *
5316     * @see elm_image_prescale_get()
5317     * @see elm_bg_load_size_set()
5318     *
5319     * @ingroup Image
5320     */
5321    EAPI void             elm_image_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
5322    /**
5323     * Get the prescale size for the image
5324     *
5325     * @param obj The image object
5326     * @return The prescale size
5327     *
5328     * @see elm_image_prescale_set()
5329     *
5330     * @ingroup Image
5331     */
5332    EAPI int              elm_image_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5333    /**
5334     * Set the image orientation.
5335     *
5336     * @param obj The image object
5337     * @param orient The image orientation @ref Elm_Image_Orient
5338     *  Default is #ELM_IMAGE_ORIENT_NONE.
5339     *
5340     * This function allows to rotate or flip the given image.
5341     *
5342     * @see elm_image_orient_get()
5343     * @see @ref Elm_Image_Orient
5344     *
5345     * @ingroup Image
5346     */
5347    EAPI void             elm_image_orient_set(Evas_Object *obj, Elm_Image_Orient orient) EINA_ARG_NONNULL(1);
5348    /**
5349     * Get the image orientation.
5350     *
5351     * @param obj The image object
5352     * @return The image orientation @ref Elm_Image_Orient
5353     *
5354     * @see elm_image_orient_set()
5355     * @see @ref Elm_Image_Orient
5356     *
5357     * @ingroup Image
5358     */
5359    EAPI Elm_Image_Orient elm_image_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5360    /**
5361     * Make the image 'editable'.
5362     *
5363     * @param obj Image object.
5364     * @param set Turn on or off editability. Default is @c EINA_FALSE.
5365     *
5366     * This means the image is a valid drag target for drag and drop, and can be
5367     * cut or pasted too.
5368     *
5369     * @ingroup Image
5370     */
5371    EAPI void             elm_image_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
5372    /**
5373     * Check if the image 'editable'.
5374     *
5375     * @param obj Image object.
5376     * @return Editability.
5377     *
5378     * A return value of EINA_TRUE means the image is a valid drag target
5379     * for drag and drop, and can be cut or pasted too.
5380     *
5381     * @ingroup Image
5382     */
5383    EAPI Eina_Bool        elm_image_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5384    /**
5385     * Get the basic Evas_Image object from this object (widget).
5386     *
5387     * @param obj The image object to get the inlined image from
5388     * @return The inlined image object, or NULL if none exists
5389     *
5390     * This function allows one to get the underlying @c Evas_Object of type
5391     * Image from this elementary widget. It can be useful to do things like get
5392     * the pixel data, save the image to a file, etc.
5393     *
5394     * @note Be careful to not manipulate it, as it is under control of
5395     * elementary.
5396     *
5397     * @ingroup Image
5398     */
5399    EAPI Evas_Object     *elm_image_object_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5400    /**
5401     * Set whether the original aspect ratio of the image should be kept on resize.
5402     *
5403     * @param obj The image object.
5404     * @param retained @c EINA_TRUE if the image should retain the aspect,
5405     * @c EINA_FALSE otherwise.
5406     *
5407     * The original aspect ratio (width / height) of the image is usually
5408     * distorted to match the object's size. Enabling this option will retain
5409     * this original aspect, and the way that the image is fit into the object's
5410     * area depends on the option set by elm_image_fill_outside_set().
5411     *
5412     * @see elm_image_aspect_ratio_retained_get()
5413     * @see elm_image_fill_outside_set()
5414     *
5415     * @ingroup Image
5416     */
5417    EAPI void             elm_image_aspect_ratio_retained_set(Evas_Object *obj, Eina_Bool retained) EINA_ARG_NONNULL(1);
5418    /**
5419     * Get if the object retains the original aspect ratio.
5420     *
5421     * @param obj The image object.
5422     * @return @c EINA_TRUE if the object keeps the original aspect, @c EINA_FALSE
5423     * otherwise.
5424     *
5425     * @ingroup Image
5426     */
5427    EAPI Eina_Bool        elm_image_aspect_ratio_retained_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5428
5429    /**
5430     * @}
5431     */
5432
5433    /* glview */
5434    typedef void (*Elm_GLView_Func_Cb)(Evas_Object *obj);
5435
5436    /* old API compatibility */
5437    typedef Elm_GLView_Func_Cb Elm_GLView_Func;
5438
5439    typedef enum _Elm_GLView_Mode
5440      {
5441         ELM_GLVIEW_ALPHA   = 1,
5442         ELM_GLVIEW_DEPTH   = 2,
5443         ELM_GLVIEW_STENCIL = 4
5444      } Elm_GLView_Mode;
5445
5446    /**
5447     * Defines a policy for the glview resizing.
5448     *
5449     * @note Default is ELM_GLVIEW_RESIZE_POLICY_RECREATE
5450     */
5451    typedef enum _Elm_GLView_Resize_Policy
5452      {
5453         ELM_GLVIEW_RESIZE_POLICY_RECREATE = 1,      /**< Resize the internal surface along with the image */
5454         ELM_GLVIEW_RESIZE_POLICY_SCALE    = 2       /**< Only reize the internal image and not the surface */
5455      } Elm_GLView_Resize_Policy;
5456
5457    typedef enum _Elm_GLView_Render_Policy
5458      {
5459         ELM_GLVIEW_RENDER_POLICY_ON_DEMAND = 1,     /**< Render only when there is a need for redrawing */
5460         ELM_GLVIEW_RENDER_POLICY_ALWAYS    = 2      /**< Render always even when it is not visible */
5461      } Elm_GLView_Render_Policy;
5462
5463    /**
5464     * @defgroup GLView
5465     *
5466     * A simple GLView widget that allows GL rendering.
5467     *
5468     * Signals that you can add callbacks for are:
5469     *
5470     * @{
5471     */
5472
5473    /**
5474     * Add a new glview to the parent
5475     *
5476     * @param parent The parent object
5477     * @return The new object or NULL if it cannot be created
5478     *
5479     * @ingroup GLView
5480     */
5481    EAPI Evas_Object     *elm_glview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5482
5483    /**
5484     * Sets the size of the glview
5485     *
5486     * @param obj The glview object
5487     * @param width width of the glview object
5488     * @param height height of the glview object
5489     *
5490     * @ingroup GLView
5491     */
5492    EAPI void             elm_glview_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
5493
5494    /**
5495     * Gets the size of the glview.
5496     *
5497     * @param obj The glview object
5498     * @param width width of the glview object
5499     * @param height height of the glview object
5500     *
5501     * Note that this function returns the actual image size of the
5502     * glview.  This means that when the scale policy is set to
5503     * ELM_GLVIEW_RESIZE_POLICY_SCALE, it'll return the non-scaled
5504     * size.
5505     *
5506     * @ingroup GLView
5507     */
5508    EAPI void             elm_glview_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
5509
5510    /**
5511     * Gets the gl api struct for gl rendering
5512     *
5513     * @param obj The glview object
5514     * @return The api object or NULL if it cannot be created
5515     *
5516     * @ingroup GLView
5517     */
5518    EAPI Evas_GL_API     *elm_glview_gl_api_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5519
5520    /**
5521     * Set the mode of the GLView. Supports Three simple modes.
5522     *
5523     * @param obj The glview object
5524     * @param mode The mode Options OR'ed enabling Alpha, Depth, Stencil.
5525     * @return True if set properly.
5526     *
5527     * @ingroup GLView
5528     */
5529    EAPI Eina_Bool        elm_glview_mode_set(Evas_Object *obj, Elm_GLView_Mode mode) EINA_ARG_NONNULL(1);
5530
5531    /**
5532     * Set the resize policy for the glview object.
5533     *
5534     * @param obj The glview object.
5535     * @param policy The scaling policy.
5536     *
5537     * By default, the resize policy is set to
5538     * ELM_GLVIEW_RESIZE_POLICY_RECREATE.  When resize is called it
5539     * destroys the previous surface and recreates the newly specified
5540     * size. If the policy is set to ELM_GLVIEW_RESIZE_POLICY_SCALE,
5541     * however, glview only scales the image object and not the underlying
5542     * GL Surface.
5543     *
5544     * @ingroup GLView
5545     */
5546    EAPI Eina_Bool        elm_glview_resize_policy_set(Evas_Object *obj, Elm_GLView_Resize_Policy policy) EINA_ARG_NONNULL(1);
5547
5548    /**
5549     * Set the render policy for the glview object.
5550     *
5551     * @param obj The glview object.
5552     * @param policy The render policy.
5553     *
5554     * By default, the render policy is set to
5555     * ELM_GLVIEW_RENDER_POLICY_ON_DEMAND.  This policy is set such
5556     * that during the render loop, glview is only redrawn if it needs
5557     * to be redrawn. (i.e. When it is visible) If the policy is set to
5558     * ELM_GLVIEWW_RENDER_POLICY_ALWAYS, it redraws regardless of
5559     * whether it is visible/need redrawing or not.
5560     *
5561     * @ingroup GLView
5562     */
5563    EAPI Eina_Bool        elm_glview_render_policy_set(Evas_Object *obj, Elm_GLView_Render_Policy policy) EINA_ARG_NONNULL(1);
5564
5565    /**
5566     * Set the init function that runs once in the main loop.
5567     *
5568     * @param obj The glview object.
5569     * @param func The init function to be registered.
5570     *
5571     * The registered init function gets called once during the render loop.
5572     *
5573     * @ingroup GLView
5574     */
5575    EAPI void             elm_glview_init_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5576
5577    /**
5578     * Set the render function that runs in the main loop.
5579     *
5580     * @param obj The glview object.
5581     * @param func The delete function to be registered.
5582     *
5583     * The registered del function gets called when GLView object is deleted.
5584     *
5585     * @ingroup GLView
5586     */
5587    EAPI void             elm_glview_del_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5588
5589    /**
5590     * Set the resize function that gets called when resize happens.
5591     *
5592     * @param obj The glview object.
5593     * @param func The resize function to be registered.
5594     *
5595     * @ingroup GLView
5596     */
5597    EAPI void             elm_glview_resize_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5598
5599    /**
5600     * Set the render function that runs in the main loop.
5601     *
5602     * @param obj The glview object.
5603     * @param func The render function to be registered.
5604     *
5605     * @ingroup GLView
5606     */
5607    EAPI void             elm_glview_render_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5608
5609    /**
5610     * Notifies that there has been changes in the GLView.
5611     *
5612     * @param obj The glview object.
5613     *
5614     * @ingroup GLView
5615     */
5616    EAPI void             elm_glview_changed_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
5617
5618    /**
5619     * @}
5620     */
5621
5622    /* box */
5623    /**
5624     * @defgroup Box Box
5625     *
5626     * @image html img/widget/box/preview-00.png
5627     * @image latex img/widget/box/preview-00.eps width=\textwidth
5628     *
5629     * @image html img/box.png
5630     * @image latex img/box.eps width=\textwidth
5631     *
5632     * A box arranges objects in a linear fashion, governed by a layout function
5633     * that defines the details of this arrangement.
5634     *
5635     * By default, the box will use an internal function to set the layout to
5636     * a single row, either vertical or horizontal. This layout is affected
5637     * by a number of parameters, such as the homogeneous flag set by
5638     * elm_box_homogeneous_set(), the values given by elm_box_padding_set() and
5639     * elm_box_align_set() and the hints set to each object in the box.
5640     *
5641     * For this default layout, it's possible to change the orientation with
5642     * elm_box_horizontal_set(). The box will start in the vertical orientation,
5643     * placing its elements ordered from top to bottom. When horizontal is set,
5644     * the order will go from left to right. If the box is set to be
5645     * homogeneous, every object in it will be assigned the same space, that
5646     * of the largest object. Padding can be used to set some spacing between
5647     * the cell given to each object. The alignment of the box, set with
5648     * elm_box_align_set(), determines how the bounding box of all the elements
5649     * will be placed within the space given to the box widget itself.
5650     *
5651     * The size hints of each object also affect how they are placed and sized
5652     * within the box. evas_object_size_hint_min_set() will give the minimum
5653     * size the object can have, and the box will use it as the basis for all
5654     * latter calculations. Elementary widgets set their own minimum size as
5655     * needed, so there's rarely any need to use it manually.
5656     *
5657     * evas_object_size_hint_weight_set(), when not in homogeneous mode, is
5658     * used to tell whether the object will be allocated the minimum size it
5659     * needs or if the space given to it should be expanded. It's important
5660     * to realize that expanding the size given to the object is not the same
5661     * thing as resizing the object. It could very well end being a small
5662     * widget floating in a much larger empty space. If not set, the weight
5663     * for objects will normally be 0.0 for both axis, meaning the widget will
5664     * not be expanded. To take as much space possible, set the weight to
5665     * EVAS_HINT_EXPAND (defined to 1.0) for the desired axis to expand.
5666     *
5667     * Besides how much space each object is allocated, it's possible to control
5668     * how the widget will be placed within that space using
5669     * evas_object_size_hint_align_set(). By default, this value will be 0.5
5670     * for both axis, meaning the object will be centered, but any value from
5671     * 0.0 (left or top, for the @c x and @c y axis, respectively) to 1.0
5672     * (right or bottom) can be used. The special value EVAS_HINT_FILL, which
5673     * is -1.0, means the object will be resized to fill the entire space it
5674     * was allocated.
5675     *
5676     * In addition, customized functions to define the layout can be set, which
5677     * allow the application developer to organize the objects within the box
5678     * in any number of ways.
5679     *
5680     * The special elm_box_layout_transition() function can be used
5681     * to switch from one layout to another, animating the motion of the
5682     * children of the box.
5683     *
5684     * @note Objects should not be added to box objects using _add() calls.
5685     *
5686     * Some examples on how to use boxes follow:
5687     * @li @ref box_example_01
5688     * @li @ref box_example_02
5689     *
5690     * @{
5691     */
5692    /**
5693     * @typedef Elm_Box_Transition
5694     *
5695     * Opaque handler containing the parameters to perform an animated
5696     * transition of the layout the box uses.
5697     *
5698     * @see elm_box_transition_new()
5699     * @see elm_box_layout_set()
5700     * @see elm_box_layout_transition()
5701     */
5702    typedef struct _Elm_Box_Transition Elm_Box_Transition;
5703
5704    /**
5705     * Add a new box to the parent
5706     *
5707     * By default, the box will be in vertical mode and non-homogeneous.
5708     *
5709     * @param parent The parent object
5710     * @return The new object or NULL if it cannot be created
5711     */
5712    EAPI Evas_Object        *elm_box_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5713    /**
5714     * Set the horizontal orientation
5715     *
5716     * By default, box object arranges their contents vertically from top to
5717     * bottom.
5718     * By calling this function with @p horizontal as EINA_TRUE, the box will
5719     * become horizontal, arranging contents from left to right.
5720     *
5721     * @note This flag is ignored if a custom layout function is set.
5722     *
5723     * @param obj The box object
5724     * @param horizontal The horizontal flag (EINA_TRUE = horizontal,
5725     * EINA_FALSE = vertical)
5726     */
5727    EAPI void                elm_box_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
5728    /**
5729     * Get the horizontal orientation
5730     *
5731     * @param obj The box object
5732     * @return EINA_TRUE if the box is set to horizintal mode, EINA_FALSE otherwise
5733     */
5734    EAPI Eina_Bool           elm_box_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5735    /**
5736     * Set the box to arrange its children homogeneously
5737     *
5738     * If enabled, homogeneous layout makes all items the same size, according
5739     * to the size of the largest of its children.
5740     *
5741     * @note This flag is ignored if a custom layout function is set.
5742     *
5743     * @param obj The box object
5744     * @param homogeneous The homogeneous flag
5745     */
5746    EAPI void                elm_box_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
5747    /**
5748     * Get whether the box is using homogeneous mode or not
5749     *
5750     * @param obj The box object
5751     * @return EINA_TRUE if it's homogeneous, EINA_FALSE otherwise
5752     */
5753    EAPI Eina_Bool           elm_box_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5754    EINA_DEPRECATED EAPI void elm_box_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
5755    EINA_DEPRECATED EAPI Eina_Bool elm_box_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5756    /**
5757     * Add an object to the beginning of the pack list
5758     *
5759     * Pack @p subobj into the box @p obj, placing it first in the list of
5760     * children objects. The actual position the object will get on screen
5761     * depends on the layout used. If no custom layout is set, it will be at
5762     * the top or left, depending if the box is vertical or horizontal,
5763     * respectively.
5764     *
5765     * @param obj The box object
5766     * @param subobj The object to add to the box
5767     *
5768     * @see elm_box_pack_end()
5769     * @see elm_box_pack_before()
5770     * @see elm_box_pack_after()
5771     * @see elm_box_unpack()
5772     * @see elm_box_unpack_all()
5773     * @see elm_box_clear()
5774     */
5775    EAPI void                elm_box_pack_start(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5776    /**
5777     * Add an object at the end of the pack list
5778     *
5779     * Pack @p subobj into the box @p obj, placing it last in the list of
5780     * children objects. The actual position the object will get on screen
5781     * depends on the layout used. If no custom layout is set, it will be at
5782     * the bottom or right, depending if the box is vertical or horizontal,
5783     * respectively.
5784     *
5785     * @param obj The box object
5786     * @param subobj The object to add to the box
5787     *
5788     * @see elm_box_pack_start()
5789     * @see elm_box_pack_before()
5790     * @see elm_box_pack_after()
5791     * @see elm_box_unpack()
5792     * @see elm_box_unpack_all()
5793     * @see elm_box_clear()
5794     */
5795    EAPI void                elm_box_pack_end(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5796    /**
5797     * Adds an object to the box before the indicated object
5798     *
5799     * This will add the @p subobj to the box indicated before the object
5800     * indicated with @p before. If @p before is not already in the box, results
5801     * are undefined. Before means either to the left of the indicated object or
5802     * above it depending on orientation.
5803     *
5804     * @param obj The box object
5805     * @param subobj The object to add to the box
5806     * @param before The object before which to add it
5807     *
5808     * @see elm_box_pack_start()
5809     * @see elm_box_pack_end()
5810     * @see elm_box_pack_after()
5811     * @see elm_box_unpack()
5812     * @see elm_box_unpack_all()
5813     * @see elm_box_clear()
5814     */
5815    EAPI void                elm_box_pack_before(Evas_Object *obj, Evas_Object *subobj, Evas_Object *before) EINA_ARG_NONNULL(1);
5816    /**
5817     * Adds an object to the box after the indicated object
5818     *
5819     * This will add the @p subobj to the box indicated after the object
5820     * indicated with @p after. If @p after is not already in the box, results
5821     * are undefined. After means either to the right of the indicated object or
5822     * below it depending on orientation.
5823     *
5824     * @param obj The box object
5825     * @param subobj The object to add to the box
5826     * @param after The object after which to add it
5827     *
5828     * @see elm_box_pack_start()
5829     * @see elm_box_pack_end()
5830     * @see elm_box_pack_before()
5831     * @see elm_box_unpack()
5832     * @see elm_box_unpack_all()
5833     * @see elm_box_clear()
5834     */
5835    EAPI void                elm_box_pack_after(Evas_Object *obj, Evas_Object *subobj, Evas_Object *after) EINA_ARG_NONNULL(1);
5836    /**
5837     * Clear the box of all children
5838     *
5839     * Remove all the elements contained by the box, deleting the respective
5840     * objects.
5841     *
5842     * @param obj The box object
5843     *
5844     * @see elm_box_unpack()
5845     * @see elm_box_unpack_all()
5846     */
5847    EAPI void                elm_box_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
5848    /**
5849     * Unpack a box item
5850     *
5851     * Remove the object given by @p subobj from the box @p obj without
5852     * deleting it.
5853     *
5854     * @param obj The box object
5855     *
5856     * @see elm_box_unpack_all()
5857     * @see elm_box_clear()
5858     */
5859    EAPI void                elm_box_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5860    /**
5861     * Remove all items from the box, without deleting them
5862     *
5863     * Clear the box from all children, but don't delete the respective objects.
5864     * If no other references of the box children exist, the objects will never
5865     * be deleted, and thus the application will leak the memory. Make sure
5866     * when using this function that you hold a reference to all the objects
5867     * in the box @p obj.
5868     *
5869     * @param obj The box object
5870     *
5871     * @see elm_box_clear()
5872     * @see elm_box_unpack()
5873     */
5874    EAPI void                elm_box_unpack_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
5875    /**
5876     * Retrieve a list of the objects packed into the box
5877     *
5878     * Returns a new @c Eina_List with a pointer to @c Evas_Object in its nodes.
5879     * The order of the list corresponds to the packing order the box uses.
5880     *
5881     * You must free this list with eina_list_free() once you are done with it.
5882     *
5883     * @param obj The box object
5884     */
5885    EAPI const Eina_List    *elm_box_children_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5886    /**
5887     * Set the space (padding) between the box's elements.
5888     *
5889     * Extra space in pixels that will be added between a box child and its
5890     * neighbors after its containing cell has been calculated. This padding
5891     * is set for all elements in the box, besides any possible padding that
5892     * individual elements may have through their size hints.
5893     *
5894     * @param obj The box object
5895     * @param horizontal The horizontal space between elements
5896     * @param vertical The vertical space between elements
5897     */
5898    EAPI void                elm_box_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
5899    /**
5900     * Get the space (padding) between the box's elements.
5901     *
5902     * @param obj The box object
5903     * @param horizontal The horizontal space between elements
5904     * @param vertical The vertical space between elements
5905     *
5906     * @see elm_box_padding_set()
5907     */
5908    EAPI void                elm_box_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
5909    /**
5910     * Set the alignment of the whole bouding box of contents.
5911     *
5912     * Sets how the bounding box containing all the elements of the box, after
5913     * their sizes and position has been calculated, will be aligned within
5914     * the space given for the whole box widget.
5915     *
5916     * @param obj The box object
5917     * @param horizontal The horizontal alignment of elements
5918     * @param vertical The vertical alignment of elements
5919     */
5920    EAPI void                elm_box_align_set(Evas_Object *obj, double horizontal, double vertical) EINA_ARG_NONNULL(1);
5921    /**
5922     * Get the alignment of the whole bouding box of contents.
5923     *
5924     * @param obj The box object
5925     * @param horizontal The horizontal alignment of elements
5926     * @param vertical The vertical alignment of elements
5927     *
5928     * @see elm_box_align_set()
5929     */
5930    EAPI void                elm_box_align_get(const Evas_Object *obj, double *horizontal, double *vertical) EINA_ARG_NONNULL(1);
5931
5932    /**
5933     * Set the layout defining function to be used by the box
5934     *
5935     * Whenever anything changes that requires the box in @p obj to recalculate
5936     * the size and position of its elements, the function @p cb will be called
5937     * to determine what the layout of the children will be.
5938     *
5939     * Once a custom function is set, everything about the children layout
5940     * is defined by it. The flags set by elm_box_horizontal_set() and
5941     * elm_box_homogeneous_set() no longer have any meaning, and the values
5942     * given by elm_box_padding_set() and elm_box_align_set() are up to this
5943     * layout function to decide if they are used and how. These last two
5944     * will be found in the @c priv parameter, of type @c Evas_Object_Box_Data,
5945     * passed to @p cb. The @c Evas_Object the function receives is not the
5946     * Elementary widget, but the internal Evas Box it uses, so none of the
5947     * functions described here can be used on it.
5948     *
5949     * Any of the layout functions in @c Evas can be used here, as well as the
5950     * special elm_box_layout_transition().
5951     *
5952     * The final @p data argument received by @p cb is the same @p data passed
5953     * here, and the @p free_data function will be called to free it
5954     * whenever the box is destroyed or another layout function is set.
5955     *
5956     * Setting @p cb to NULL will revert back to the default layout function.
5957     *
5958     * @param obj The box object
5959     * @param cb The callback function used for layout
5960     * @param data Data that will be passed to layout function
5961     * @param free_data Function called to free @p data
5962     *
5963     * @see elm_box_layout_transition()
5964     */
5965    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);
5966    /**
5967     * Special layout function that animates the transition from one layout to another
5968     *
5969     * Normally, when switching the layout function for a box, this will be
5970     * reflected immediately on screen on the next render, but it's also
5971     * possible to do this through an animated transition.
5972     *
5973     * This is done by creating an ::Elm_Box_Transition and setting the box
5974     * layout to this function.
5975     *
5976     * For example:
5977     * @code
5978     * Elm_Box_Transition *t = elm_box_transition_new(1.0,
5979     *                            evas_object_box_layout_vertical, // start
5980     *                            NULL, // data for initial layout
5981     *                            NULL, // free function for initial data
5982     *                            evas_object_box_layout_horizontal, // end
5983     *                            NULL, // data for final layout
5984     *                            NULL, // free function for final data
5985     *                            anim_end, // will be called when animation ends
5986     *                            NULL); // data for anim_end function\
5987     * elm_box_layout_set(box, elm_box_layout_transition, t,
5988     *                    elm_box_transition_free);
5989     * @endcode
5990     *
5991     * @note This function can only be used with elm_box_layout_set(). Calling
5992     * it directly will not have the expected results.
5993     *
5994     * @see elm_box_transition_new
5995     * @see elm_box_transition_free
5996     * @see elm_box_layout_set
5997     */
5998    EAPI void                elm_box_layout_transition(Evas_Object *obj, Evas_Object_Box_Data *priv, void *data);
5999    /**
6000     * Create a new ::Elm_Box_Transition to animate the switch of layouts
6001     *
6002     * If you want to animate the change from one layout to another, you need
6003     * to set the layout function of the box to elm_box_layout_transition(),
6004     * passing as user data to it an instance of ::Elm_Box_Transition with the
6005     * necessary information to perform this animation. The free function to
6006     * set for the layout is elm_box_transition_free().
6007     *
6008     * The parameters to create an ::Elm_Box_Transition sum up to how long
6009     * will it be, in seconds, a layout function to describe the initial point,
6010     * another for the final position of the children and one function to be
6011     * called when the whole animation ends. This last function is useful to
6012     * set the definitive layout for the box, usually the same as the end
6013     * layout for the animation, but could be used to start another transition.
6014     *
6015     * @param start_layout The layout function that will be used to start the animation
6016     * @param start_layout_data The data to be passed the @p start_layout function
6017     * @param start_layout_free_data Function to free @p start_layout_data
6018     * @param end_layout The layout function that will be used to end the animation
6019     * @param end_layout_free_data The data to be passed the @p end_layout function
6020     * @param end_layout_free_data Function to free @p end_layout_data
6021     * @param transition_end_cb Callback function called when animation ends
6022     * @param transition_end_data Data to be passed to @p transition_end_cb
6023     * @return An instance of ::Elm_Box_Transition
6024     *
6025     * @see elm_box_transition_new
6026     * @see elm_box_layout_transition
6027     */
6028    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);
6029    /**
6030     * Free a Elm_Box_Transition instance created with elm_box_transition_new().
6031     *
6032     * This function is mostly useful as the @c free_data parameter in
6033     * elm_box_layout_set() when elm_box_layout_transition().
6034     *
6035     * @param data The Elm_Box_Transition instance to be freed.
6036     *
6037     * @see elm_box_transition_new
6038     * @see elm_box_layout_transition
6039     */
6040    EAPI void                elm_box_transition_free(void *data);
6041    /**
6042     * @}
6043     */
6044
6045    /* button */
6046    /**
6047     * @defgroup Button Button
6048     *
6049     * @image html img/widget/button/preview-00.png
6050     * @image latex img/widget/button/preview-00.eps
6051     * @image html img/widget/button/preview-01.png
6052     * @image latex img/widget/button/preview-01.eps
6053     * @image html img/widget/button/preview-02.png
6054     * @image latex img/widget/button/preview-02.eps
6055     *
6056     * This is a push-button. Press it and run some function. It can contain
6057     * a simple label and icon object and it also has an autorepeat feature.
6058     *
6059     * This widgets emits the following signals:
6060     * @li "clicked": the user clicked the button (press/release).
6061     * @li "repeated": the user pressed the button without releasing it.
6062     * @li "pressed": button was pressed.
6063     * @li "unpressed": button was released after being pressed.
6064     * In all three cases, the @c event parameter of the callback will be
6065     * @c NULL.
6066     *
6067     * Also, defined in the default theme, the button has the following styles
6068     * available:
6069     * @li default: a normal button.
6070     * @li anchor: Like default, but the button fades away when the mouse is not
6071     * over it, leaving only the text or icon.
6072     * @li hoversel_vertical: Internally used by @ref Hoversel to give a
6073     * continuous look across its options.
6074     * @li hoversel_vertical_entry: Another internal for @ref Hoversel.
6075     *
6076     * Default contents parts of the button widget that you can use for are:
6077     * @li "elm.swallow.content" - A icon of the button
6078     *
6079     * Default text parts of the button widget that you can use for are:
6080     * @li "elm.text" - Label of the button
6081     *
6082     * Follow through a complete example @ref button_example_01 "here".
6083     * @{
6084     */
6085
6086    typedef enum
6087      {
6088         UIControlStateDefault,
6089         UIControlStateHighlighted,
6090         UIControlStateDisabled,
6091         UIControlStateFocused,
6092         UIControlStateReserved
6093      } UIControlState;
6094
6095    /**
6096     * Add a new button to the parent's canvas
6097     *
6098     * @param parent The parent object
6099     * @return The new object or NULL if it cannot be created
6100     */
6101    EAPI Evas_Object *elm_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6102    /**
6103     * Set the label used in the button
6104     *
6105     * The passed @p label can be NULL to clean any existing text in it and
6106     * leave the button as an icon only object.
6107     *
6108     * @param obj The button object
6109     * @param label The text will be written on the button
6110     * @deprecated use elm_object_text_set() instead.
6111     */
6112    EINA_DEPRECATED EAPI void         elm_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6113    /**
6114     * Get the label set for the button
6115     *
6116     * The string returned is an internal pointer and should not be freed or
6117     * altered. It will also become invalid when the button is destroyed.
6118     * The string returned, if not NULL, is a stringshare, so if you need to
6119     * keep it around even after the button is destroyed, you can use
6120     * eina_stringshare_ref().
6121     *
6122     * @param obj The button object
6123     * @return The text set to the label, or NULL if nothing is set
6124     * @deprecated use elm_object_text_set() instead.
6125     */
6126    EINA_DEPRECATED EAPI const char  *elm_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6127    /**
6128     * Set the label for each state of button
6129     *
6130     * The passed @p label can be NULL to clean any existing text in it and
6131     * leave the button as an icon only object for the state.
6132     *
6133     * @param obj The button object
6134     * @param label The text will be written on the button
6135     * @param state The state of button
6136     *
6137     * @ingroup Button
6138     */
6139    EINA_DEPRECATED EAPI void         elm_button_label_set_for_state(Evas_Object *obj, const char *label, UIControlState state) EINA_ARG_NONNULL(1);
6140    /**
6141     * Get the label of button for each state
6142     *
6143     * The string returned is an internal pointer and should not be freed or
6144     * altered. It will also become invalid when the button is destroyed.
6145     * The string returned, if not NULL, is a stringshare, so if you need to
6146     * keep it around even after the button is destroyed, you can use
6147     * eina_stringshare_ref().
6148     *
6149     * @param obj The button object
6150     * @param state The state of button
6151     * @return The title of button for state
6152     *
6153     * @ingroup Button
6154     */
6155    EINA_DEPRECATED EAPI const char  *elm_button_label_get_for_state(const Evas_Object *obj, UIControlState state) EINA_ARG_NONNULL(1);
6156    /**
6157     * Set the icon used for the button
6158     *
6159     * Setting a new icon will delete any other that was previously set, making
6160     * any reference to them invalid. If you need to maintain the previous
6161     * object alive, unset it first with elm_button_icon_unset().
6162     *
6163     * @param obj The button object
6164     * @param icon The icon object for the button
6165     */
6166    EAPI void         elm_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6167    /**
6168     * Get the icon used for the button
6169     *
6170     * Return the icon object which is set for this widget. If the button is
6171     * destroyed or another icon is set, the returned object will be deleted
6172     * and any reference to it will be invalid.
6173     *
6174     * @param obj The button object
6175     * @return The icon object that is being used
6176     *
6177     * @see elm_button_icon_unset()
6178     */
6179    EAPI Evas_Object *elm_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6180    /**
6181     * Remove the icon set without deleting it and return the object
6182     *
6183     * This function drops the reference the button holds of the icon object
6184     * and returns this last object. It is used in case you want to remove any
6185     * icon, or set another one, without deleting the actual object. The button
6186     * will be left without an icon set.
6187     *
6188     * @param obj The button object
6189     * @return The icon object that was being used
6190     */
6191    EAPI Evas_Object *elm_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6192    /**
6193     * Turn on/off the autorepeat event generated when the button is kept pressed
6194     *
6195     * When off, no autorepeat is performed and buttons emit a normal @c clicked
6196     * signal when they are clicked.
6197     *
6198     * When on, keeping a button pressed will continuously emit a @c repeated
6199     * signal until the button is released. The time it takes until it starts
6200     * emitting the signal is given by
6201     * elm_button_autorepeat_initial_timeout_set(), and the time between each
6202     * new emission by elm_button_autorepeat_gap_timeout_set().
6203     *
6204     * @param obj The button object
6205     * @param on  A bool to turn on/off the event
6206     */
6207    EAPI void         elm_button_autorepeat_set(Evas_Object *obj, Eina_Bool on) EINA_ARG_NONNULL(1);
6208    /**
6209     * Get whether the autorepeat feature is enabled
6210     *
6211     * @param obj The button object
6212     * @return EINA_TRUE if autorepeat is on, EINA_FALSE otherwise
6213     *
6214     * @see elm_button_autorepeat_set()
6215     */
6216    EAPI Eina_Bool    elm_button_autorepeat_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6217    /**
6218     * Set the initial timeout before the autorepeat event is generated
6219     *
6220     * Sets the timeout, in seconds, since the button is pressed until the
6221     * first @c repeated signal is emitted. If @p t is 0.0 or less, there
6222     * won't be any delay and the even will be fired the moment the button is
6223     * pressed.
6224     *
6225     * @param obj The button object
6226     * @param t   Timeout in seconds
6227     *
6228     * @see elm_button_autorepeat_set()
6229     * @see elm_button_autorepeat_gap_timeout_set()
6230     */
6231    EAPI void         elm_button_autorepeat_initial_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
6232    /**
6233     * Get the initial timeout before the autorepeat event is generated
6234     *
6235     * @param obj The button object
6236     * @return Timeout in seconds
6237     *
6238     * @see elm_button_autorepeat_initial_timeout_set()
6239     */
6240    EAPI double       elm_button_autorepeat_initial_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6241    /**
6242     * Set the interval between each generated autorepeat event
6243     *
6244     * After the first @c repeated event is fired, all subsequent ones will
6245     * follow after a delay of @p t seconds for each.
6246     *
6247     * @param obj The button object
6248     * @param t   Interval in seconds
6249     *
6250     * @see elm_button_autorepeat_initial_timeout_set()
6251     */
6252    EAPI void         elm_button_autorepeat_gap_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
6253    /**
6254     * Get the interval between each generated autorepeat event
6255     *
6256     * @param obj The button object
6257     * @return Interval in seconds
6258     */
6259    EAPI double       elm_button_autorepeat_gap_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6260    /**
6261     * @}
6262     */
6263
6264    /**
6265     * @defgroup File_Selector_Button File Selector Button
6266     *
6267     * @image html img/widget/fileselector_button/preview-00.png
6268     * @image latex img/widget/fileselector_button/preview-00.eps
6269     * @image html img/widget/fileselector_button/preview-01.png
6270     * @image latex img/widget/fileselector_button/preview-01.eps
6271     * @image html img/widget/fileselector_button/preview-02.png
6272     * @image latex img/widget/fileselector_button/preview-02.eps
6273     *
6274     * This is a button that, when clicked, creates an Elementary
6275     * window (or inner window) <b> with a @ref Fileselector "file
6276     * selector widget" within</b>. When a file is chosen, the (inner)
6277     * window is closed and the button emits a signal having the
6278     * selected file as it's @c event_info.
6279     *
6280     * This widget encapsulates operations on its internal file
6281     * selector on its own API. There is less control over its file
6282     * selector than that one would have instatiating one directly.
6283     *
6284     * The following styles are available for this button:
6285     * @li @c "default"
6286     * @li @c "anchor"
6287     * @li @c "hoversel_vertical"
6288     * @li @c "hoversel_vertical_entry"
6289     *
6290     * Smart callbacks one can register to:
6291     * - @c "file,chosen" - the user has selected a path, whose string
6292     *   pointer comes as the @c event_info data (a stringshared
6293     *   string)
6294     *
6295     * Here is an example on its usage:
6296     * @li @ref fileselector_button_example
6297     *
6298     * @see @ref File_Selector_Entry for a similar widget.
6299     * @{
6300     */
6301
6302    /**
6303     * Add a new file selector button widget to the given parent
6304     * Elementary (container) object
6305     *
6306     * @param parent The parent object
6307     * @return a new file selector button widget handle or @c NULL, on
6308     * errors
6309     */
6310    EAPI Evas_Object *elm_fileselector_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6311
6312    /**
6313     * Set the label for a given file selector button widget
6314     *
6315     * @param obj The file selector button widget
6316     * @param label The text label to be displayed on @p obj
6317     *
6318     * @deprecated use elm_object_text_set() instead.
6319     */
6320    EINA_DEPRECATED EAPI void         elm_fileselector_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6321
6322    /**
6323     * Get the label set for a given file selector button widget
6324     *
6325     * @param obj The file selector button widget
6326     * @return The button label
6327     *
6328     * @deprecated use elm_object_text_set() instead.
6329     */
6330    EINA_DEPRECATED EAPI const char  *elm_fileselector_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6331
6332    /**
6333     * Set the icon on a given file selector button widget
6334     *
6335     * @param obj The file selector button widget
6336     * @param icon The icon object for the button
6337     *
6338     * Once the icon object is set, a previously set one will be
6339     * deleted. If you want to keep the latter, use the
6340     * elm_fileselector_button_icon_unset() function.
6341     *
6342     * @see elm_fileselector_button_icon_get()
6343     */
6344    EAPI void         elm_fileselector_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6345
6346    /**
6347     * Get the icon set for a given file selector button widget
6348     *
6349     * @param obj The file selector button widget
6350     * @return The icon object currently set on @p obj or @c NULL, if
6351     * none is
6352     *
6353     * @see elm_fileselector_button_icon_set()
6354     */
6355    EAPI Evas_Object *elm_fileselector_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6356
6357    /**
6358     * Unset the icon used in a given file selector button widget
6359     *
6360     * @param obj The file selector button widget
6361     * @return The icon object that was being used on @p obj or @c
6362     * NULL, on errors
6363     *
6364     * Unparent and return the icon object which was set for this
6365     * widget.
6366     *
6367     * @see elm_fileselector_button_icon_set()
6368     */
6369    EAPI Evas_Object *elm_fileselector_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6370
6371    /**
6372     * Set the title for a given file selector button widget's window
6373     *
6374     * @param obj The file selector button widget
6375     * @param title The title string
6376     *
6377     * This will change the window's title, when the file selector pops
6378     * out after a click on the button. Those windows have the default
6379     * (unlocalized) value of @c "Select a file" as titles.
6380     *
6381     * @note It will only take any effect if the file selector
6382     * button widget is @b not under "inwin mode".
6383     *
6384     * @see elm_fileselector_button_window_title_get()
6385     */
6386    EAPI void         elm_fileselector_button_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6387
6388    /**
6389     * Get the title set for a given file selector button widget's
6390     * window
6391     *
6392     * @param obj The file selector button widget
6393     * @return Title of the file selector button's window
6394     *
6395     * @see elm_fileselector_button_window_title_get() for more details
6396     */
6397    EAPI const char  *elm_fileselector_button_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6398
6399    /**
6400     * Set the size of a given file selector button widget's window,
6401     * holding the file selector itself.
6402     *
6403     * @param obj The file selector button widget
6404     * @param width The window's width
6405     * @param height The window's height
6406     *
6407     * @note it will only take any effect if the file selector button
6408     * widget is @b not under "inwin mode". The default size for the
6409     * window (when applicable) is 400x400 pixels.
6410     *
6411     * @see elm_fileselector_button_window_size_get()
6412     */
6413    EAPI void         elm_fileselector_button_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6414
6415    /**
6416     * Get the size of a given file selector button widget's window,
6417     * holding the file selector itself.
6418     *
6419     * @param obj The file selector button widget
6420     * @param width Pointer into which to store the width value
6421     * @param height Pointer into which to store the height value
6422     *
6423     * @note Use @c NULL pointers on the size values you're not
6424     * interested in: they'll be ignored by the function.
6425     *
6426     * @see elm_fileselector_button_window_size_set(), for more details
6427     */
6428    EAPI void         elm_fileselector_button_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6429
6430    /**
6431     * Set the initial file system path for a given file selector
6432     * button widget
6433     *
6434     * @param obj The file selector button widget
6435     * @param path The path string
6436     *
6437     * It must be a <b>directory</b> path, which will have the contents
6438     * displayed initially in the file selector's view, when invoked
6439     * from @p obj. The default initial path is the @c "HOME"
6440     * environment variable's value.
6441     *
6442     * @see elm_fileselector_button_path_get()
6443     */
6444    EAPI void         elm_fileselector_button_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6445
6446    /**
6447     * Get the initial file system path set for a given file selector
6448     * button widget
6449     *
6450     * @param obj The file selector button widget
6451     * @return path The path string
6452     *
6453     * @see elm_fileselector_button_path_set() for more details
6454     */
6455    EAPI const char  *elm_fileselector_button_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6456
6457    /**
6458     * Enable/disable a tree view in the given file selector button
6459     * widget's internal file selector
6460     *
6461     * @param obj The file selector button widget
6462     * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
6463     * disable
6464     *
6465     * This has the same effect as elm_fileselector_expandable_set(),
6466     * but now applied to a file selector button's internal file
6467     * selector.
6468     *
6469     * @note There's no way to put a file selector button's internal
6470     * file selector in "grid mode", as one may do with "pure" file
6471     * selectors.
6472     *
6473     * @see elm_fileselector_expandable_get()
6474     */
6475    EAPI void         elm_fileselector_button_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6476
6477    /**
6478     * Get whether tree view is enabled for the given file selector
6479     * button widget's internal file selector
6480     *
6481     * @param obj The file selector button widget
6482     * @return @c EINA_TRUE if @p obj widget's internal file selector
6483     * is in tree view, @c EINA_FALSE otherwise (and or errors)
6484     *
6485     * @see elm_fileselector_expandable_set() for more details
6486     */
6487    EAPI Eina_Bool    elm_fileselector_button_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6488
6489    /**
6490     * Set whether a given file selector button widget's internal file
6491     * selector is to display folders only or the directory contents,
6492     * as well.
6493     *
6494     * @param obj The file selector button widget
6495     * @param only @c EINA_TRUE to make @p obj widget's internal file
6496     * selector only display directories, @c EINA_FALSE to make files
6497     * to be displayed in it too
6498     *
6499     * This has the same effect as elm_fileselector_folder_only_set(),
6500     * but now applied to a file selector button's internal file
6501     * selector.
6502     *
6503     * @see elm_fileselector_folder_only_get()
6504     */
6505    EAPI void         elm_fileselector_button_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6506
6507    /**
6508     * Get whether a given file selector button widget's internal file
6509     * selector is displaying folders only or the directory contents,
6510     * as well.
6511     *
6512     * @param obj The file selector button widget
6513     * @return @c EINA_TRUE if @p obj widget's internal file
6514     * selector is only displaying directories, @c EINA_FALSE if files
6515     * are being displayed in it too (and on errors)
6516     *
6517     * @see elm_fileselector_button_folder_only_set() for more details
6518     */
6519    EAPI Eina_Bool    elm_fileselector_button_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6520
6521    /**
6522     * Enable/disable the file name entry box where the user can type
6523     * in a name for a file, in a given file selector button widget's
6524     * internal file selector.
6525     *
6526     * @param obj The file selector button widget
6527     * @param is_save @c EINA_TRUE to make @p obj widget's internal
6528     * file selector a "saving dialog", @c EINA_FALSE otherwise
6529     *
6530     * This has the same effect as elm_fileselector_is_save_set(),
6531     * but now applied to a file selector button's internal file
6532     * selector.
6533     *
6534     * @see elm_fileselector_is_save_get()
6535     */
6536    EAPI void         elm_fileselector_button_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6537
6538    /**
6539     * Get whether the given file selector button widget's internal
6540     * file selector is in "saving dialog" mode
6541     *
6542     * @param obj The file selector button widget
6543     * @return @c EINA_TRUE, if @p obj widget's internal file selector
6544     * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
6545     * errors)
6546     *
6547     * @see elm_fileselector_button_is_save_set() for more details
6548     */
6549    EAPI Eina_Bool    elm_fileselector_button_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6550
6551    /**
6552     * Set whether a given file selector button widget's internal file
6553     * selector will raise an Elementary "inner window", instead of a
6554     * dedicated Elementary window. By default, it won't.
6555     *
6556     * @param obj The file selector button widget
6557     * @param value @c EINA_TRUE to make it use an inner window, @c
6558     * EINA_TRUE to make it use a dedicated window
6559     *
6560     * @see elm_win_inwin_add() for more information on inner windows
6561     * @see elm_fileselector_button_inwin_mode_get()
6562     */
6563    EAPI void         elm_fileselector_button_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6564
6565    /**
6566     * Get whether a given file selector button widget's internal file
6567     * selector will raise an Elementary "inner window", instead of a
6568     * dedicated Elementary window.
6569     *
6570     * @param obj The file selector button widget
6571     * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
6572     * if it will use a dedicated window
6573     *
6574     * @see elm_fileselector_button_inwin_mode_set() for more details
6575     */
6576    EAPI Eina_Bool    elm_fileselector_button_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6577
6578    /**
6579     * @}
6580     */
6581
6582     /**
6583     * @defgroup File_Selector_Entry File Selector Entry
6584     *
6585     * @image html img/widget/fileselector_entry/preview-00.png
6586     * @image latex img/widget/fileselector_entry/preview-00.eps
6587     *
6588     * This is an entry made to be filled with or display a <b>file
6589     * system path string</b>. Besides the entry itself, the widget has
6590     * a @ref File_Selector_Button "file selector button" on its side,
6591     * which will raise an internal @ref Fileselector "file selector widget",
6592     * when clicked, for path selection aided by file system
6593     * navigation.
6594     *
6595     * This file selector may appear in an Elementary window or in an
6596     * inner window. When a file is chosen from it, the (inner) window
6597     * is closed and the selected file's path string is exposed both as
6598     * an smart event and as the new text on the entry.
6599     *
6600     * This widget encapsulates operations on its internal file
6601     * selector on its own API. There is less control over its file
6602     * selector than that one would have instatiating one directly.
6603     *
6604     * Smart callbacks one can register to:
6605     * - @c "changed" - The text within the entry was changed
6606     * - @c "activated" - The entry has had editing finished and
6607     *   changes are to be "committed"
6608     * - @c "press" - The entry has been clicked
6609     * - @c "longpressed" - The entry has been clicked (and held) for a
6610     *   couple seconds
6611     * - @c "clicked" - The entry has been clicked
6612     * - @c "clicked,double" - The entry has been double clicked
6613     * - @c "focused" - The entry has received focus
6614     * - @c "unfocused" - The entry has lost focus
6615     * - @c "selection,paste" - A paste action has occurred on the
6616     *   entry
6617     * - @c "selection,copy" - A copy action has occurred on the entry
6618     * - @c "selection,cut" - A cut action has occurred on the entry
6619     * - @c "unpressed" - The file selector entry's button was released
6620     *   after being pressed.
6621     * - @c "file,chosen" - The user has selected a path via the file
6622     *   selector entry's internal file selector, whose string pointer
6623     *   comes as the @c event_info data (a stringshared string)
6624     *
6625     * Here is an example on its usage:
6626     * @li @ref fileselector_entry_example
6627     *
6628     * @see @ref File_Selector_Button for a similar widget.
6629     * @{
6630     */
6631
6632    /**
6633     * Add a new file selector entry widget to the given parent
6634     * Elementary (container) object
6635     *
6636     * @param parent The parent object
6637     * @return a new file selector entry widget handle or @c NULL, on
6638     * errors
6639     */
6640    EAPI Evas_Object *elm_fileselector_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6641
6642    /**
6643     * Set the label for a given file selector entry widget's button
6644     *
6645     * @param obj The file selector entry widget
6646     * @param label The text label to be displayed on @p obj widget's
6647     * button
6648     *
6649     * @deprecated use elm_object_text_set() instead.
6650     */
6651    EINA_DEPRECATED EAPI void         elm_fileselector_entry_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6652
6653    /**
6654     * Get the label set for a given file selector entry widget's button
6655     *
6656     * @param obj The file selector entry widget
6657     * @return The widget button's label
6658     *
6659     * @deprecated use elm_object_text_set() instead.
6660     */
6661    EINA_DEPRECATED EAPI const char  *elm_fileselector_entry_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6662
6663    /**
6664     * Set the icon on a given file selector entry widget's button
6665     *
6666     * @param obj The file selector entry widget
6667     * @param icon The icon object for the entry's button
6668     *
6669     * Once the icon object is set, a previously set one will be
6670     * deleted. If you want to keep the latter, use the
6671     * elm_fileselector_entry_button_icon_unset() function.
6672     *
6673     * @see elm_fileselector_entry_button_icon_get()
6674     */
6675    EAPI void         elm_fileselector_entry_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6676
6677    /**
6678     * Get the icon set for a given file selector entry widget's button
6679     *
6680     * @param obj The file selector entry widget
6681     * @return The icon object currently set on @p obj widget's button
6682     * or @c NULL, if none is
6683     *
6684     * @see elm_fileselector_entry_button_icon_set()
6685     */
6686    EAPI Evas_Object *elm_fileselector_entry_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6687
6688    /**
6689     * Unset the icon used in a given file selector entry widget's
6690     * button
6691     *
6692     * @param obj The file selector entry widget
6693     * @return The icon object that was being used on @p obj widget's
6694     * button or @c NULL, on errors
6695     *
6696     * Unparent and return the icon object which was set for this
6697     * widget's button.
6698     *
6699     * @see elm_fileselector_entry_button_icon_set()
6700     */
6701    EAPI Evas_Object *elm_fileselector_entry_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6702
6703    /**
6704     * Set the title for a given file selector entry widget's window
6705     *
6706     * @param obj The file selector entry widget
6707     * @param title The title string
6708     *
6709     * This will change the window's title, when the file selector pops
6710     * out after a click on the entry's button. Those windows have the
6711     * default (unlocalized) value of @c "Select a file" as titles.
6712     *
6713     * @note It will only take any effect if the file selector
6714     * entry widget is @b not under "inwin mode".
6715     *
6716     * @see elm_fileselector_entry_window_title_get()
6717     */
6718    EAPI void         elm_fileselector_entry_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6719
6720    /**
6721     * Get the title set for a given file selector entry widget's
6722     * window
6723     *
6724     * @param obj The file selector entry widget
6725     * @return Title of the file selector entry's window
6726     *
6727     * @see elm_fileselector_entry_window_title_get() for more details
6728     */
6729    EAPI const char  *elm_fileselector_entry_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6730
6731    /**
6732     * Set the size of a given file selector entry widget's window,
6733     * holding the file selector itself.
6734     *
6735     * @param obj The file selector entry widget
6736     * @param width The window's width
6737     * @param height The window's height
6738     *
6739     * @note it will only take any effect if the file selector entry
6740     * widget is @b not under "inwin mode". The default size for the
6741     * window (when applicable) is 400x400 pixels.
6742     *
6743     * @see elm_fileselector_entry_window_size_get()
6744     */
6745    EAPI void         elm_fileselector_entry_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6746
6747    /**
6748     * Get the size of a given file selector entry widget's window,
6749     * holding the file selector itself.
6750     *
6751     * @param obj The file selector entry widget
6752     * @param width Pointer into which to store the width value
6753     * @param height Pointer into which to store the height value
6754     *
6755     * @note Use @c NULL pointers on the size values you're not
6756     * interested in: they'll be ignored by the function.
6757     *
6758     * @see elm_fileselector_entry_window_size_set(), for more details
6759     */
6760    EAPI void         elm_fileselector_entry_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6761
6762    /**
6763     * Set the initial file system path and the entry's path string for
6764     * a given file selector entry widget
6765     *
6766     * @param obj The file selector entry widget
6767     * @param path The path string
6768     *
6769     * It must be a <b>directory</b> path, which will have the contents
6770     * displayed initially in the file selector's view, when invoked
6771     * from @p obj. The default initial path is the @c "HOME"
6772     * environment variable's value.
6773     *
6774     * @see elm_fileselector_entry_path_get()
6775     */
6776    EAPI void         elm_fileselector_entry_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6777
6778    /**
6779     * Get the entry's path string for a given file selector entry
6780     * widget
6781     *
6782     * @param obj The file selector entry widget
6783     * @return path The path string
6784     *
6785     * @see elm_fileselector_entry_path_set() for more details
6786     */
6787    EAPI const char  *elm_fileselector_entry_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6788
6789    /**
6790     * Enable/disable a tree view in the given file selector entry
6791     * widget's internal file selector
6792     *
6793     * @param obj The file selector entry widget
6794     * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
6795     * disable
6796     *
6797     * This has the same effect as elm_fileselector_expandable_set(),
6798     * but now applied to a file selector entry's internal file
6799     * selector.
6800     *
6801     * @note There's no way to put a file selector entry's internal
6802     * file selector in "grid mode", as one may do with "pure" file
6803     * selectors.
6804     *
6805     * @see elm_fileselector_expandable_get()
6806     */
6807    EAPI void         elm_fileselector_entry_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6808
6809    /**
6810     * Get whether tree view is enabled for the given file selector
6811     * entry widget's internal file selector
6812     *
6813     * @param obj The file selector entry widget
6814     * @return @c EINA_TRUE if @p obj widget's internal file selector
6815     * is in tree view, @c EINA_FALSE otherwise (and or errors)
6816     *
6817     * @see elm_fileselector_expandable_set() for more details
6818     */
6819    EAPI Eina_Bool    elm_fileselector_entry_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6820
6821    /**
6822     * Set whether a given file selector entry widget's internal file
6823     * selector is to display folders only or the directory contents,
6824     * as well.
6825     *
6826     * @param obj The file selector entry widget
6827     * @param only @c EINA_TRUE to make @p obj widget's internal file
6828     * selector only display directories, @c EINA_FALSE to make files
6829     * to be displayed in it too
6830     *
6831     * This has the same effect as elm_fileselector_folder_only_set(),
6832     * but now applied to a file selector entry's internal file
6833     * selector.
6834     *
6835     * @see elm_fileselector_folder_only_get()
6836     */
6837    EAPI void         elm_fileselector_entry_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6838
6839    /**
6840     * Get whether a given file selector entry widget's internal file
6841     * selector is displaying folders only or the directory contents,
6842     * as well.
6843     *
6844     * @param obj The file selector entry widget
6845     * @return @c EINA_TRUE if @p obj widget's internal file
6846     * selector is only displaying directories, @c EINA_FALSE if files
6847     * are being displayed in it too (and on errors)
6848     *
6849     * @see elm_fileselector_entry_folder_only_set() for more details
6850     */
6851    EAPI Eina_Bool    elm_fileselector_entry_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6852
6853    /**
6854     * Enable/disable the file name entry box where the user can type
6855     * in a name for a file, in a given file selector entry widget's
6856     * internal file selector.
6857     *
6858     * @param obj The file selector entry widget
6859     * @param is_save @c EINA_TRUE to make @p obj widget's internal
6860     * file selector a "saving dialog", @c EINA_FALSE otherwise
6861     *
6862     * This has the same effect as elm_fileselector_is_save_set(),
6863     * but now applied to a file selector entry's internal file
6864     * selector.
6865     *
6866     * @see elm_fileselector_is_save_get()
6867     */
6868    EAPI void         elm_fileselector_entry_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6869
6870    /**
6871     * Get whether the given file selector entry widget's internal
6872     * file selector is in "saving dialog" mode
6873     *
6874     * @param obj The file selector entry widget
6875     * @return @c EINA_TRUE, if @p obj widget's internal file selector
6876     * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
6877     * errors)
6878     *
6879     * @see elm_fileselector_entry_is_save_set() for more details
6880     */
6881    EAPI Eina_Bool    elm_fileselector_entry_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6882
6883    /**
6884     * Set whether a given file selector entry widget's internal file
6885     * selector will raise an Elementary "inner window", instead of a
6886     * dedicated Elementary window. By default, it won't.
6887     *
6888     * @param obj The file selector entry widget
6889     * @param value @c EINA_TRUE to make it use an inner window, @c
6890     * EINA_TRUE to make it use a dedicated window
6891     *
6892     * @see elm_win_inwin_add() for more information on inner windows
6893     * @see elm_fileselector_entry_inwin_mode_get()
6894     */
6895    EAPI void         elm_fileselector_entry_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6896
6897    /**
6898     * Get whether a given file selector entry widget's internal file
6899     * selector will raise an Elementary "inner window", instead of a
6900     * dedicated Elementary window.
6901     *
6902     * @param obj The file selector entry widget
6903     * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
6904     * if it will use a dedicated window
6905     *
6906     * @see elm_fileselector_entry_inwin_mode_set() for more details
6907     */
6908    EAPI Eina_Bool    elm_fileselector_entry_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6909
6910    /**
6911     * Set the initial file system path for a given file selector entry
6912     * widget
6913     *
6914     * @param obj The file selector entry widget
6915     * @param path The path string
6916     *
6917     * It must be a <b>directory</b> path, which will have the contents
6918     * displayed initially in the file selector's view, when invoked
6919     * from @p obj. The default initial path is the @c "HOME"
6920     * environment variable's value.
6921     *
6922     * @see elm_fileselector_entry_path_get()
6923     */
6924    EAPI void         elm_fileselector_entry_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6925
6926    /**
6927     * Get the parent directory's path to the latest file selection on
6928     * a given filer selector entry widget
6929     *
6930     * @param obj The file selector object
6931     * @return The (full) path of the directory of the last selection
6932     * on @p obj widget, a @b stringshared string
6933     *
6934     * @see elm_fileselector_entry_path_set()
6935     */
6936    EAPI const char  *elm_fileselector_entry_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6937
6938    /**
6939     * @}
6940     */
6941
6942    /**
6943     * @defgroup Scroller Scroller
6944     *
6945     * A scroller holds a single object and "scrolls it around". This means that
6946     * it allows the user to use a scrollbar (or a finger) to drag the viewable
6947     * region around, allowing to move through a much larger object that is
6948     * contained in the scroller. The scroller will always have a small minimum
6949     * size by default as it won't be limited by the contents of the scroller.
6950     *
6951     * Signals that you can add callbacks for are:
6952     * @li "edge,left" - the left edge of the content has been reached
6953     * @li "edge,right" - the right edge of the content has been reached
6954     * @li "edge,top" - the top edge of the content has been reached
6955     * @li "edge,bottom" - the bottom edge of the content has been reached
6956     * @li "scroll" - the content has been scrolled (moved)
6957     * @li "scroll,anim,start" - scrolling animation has started
6958     * @li "scroll,anim,stop" - scrolling animation has stopped
6959     * @li "scroll,drag,start" - dragging the contents around has started
6960     * @li "scroll,drag,stop" - dragging the contents around has stopped
6961     * @note The "scroll,anim,*" and "scroll,drag,*" signals are only emitted by
6962     * user intervetion.
6963     *
6964     * @note When Elemementary is in embedded mode the scrollbars will not be
6965     * dragable, they appear merely as indicators of how much has been scrolled.
6966     * @note When Elementary is in desktop mode the thumbscroll(a.k.a.
6967     * fingerscroll) won't work.
6968     *
6969     * To set/get/unset the content of the panel, you can use
6970     * elm_object_content_set/get/unset APIs.
6971     * Once the content object is set, a previously set one will be deleted.
6972     * If you want to keep that old content object, use the
6973     * elm_object_content_unset() function
6974     *
6975     * In @ref tutorial_scroller you'll find an example of how to use most of
6976     * this API.
6977     * @{
6978     */
6979    /**
6980     * @brief Type that controls when scrollbars should appear.
6981     *
6982     * @see elm_scroller_policy_set()
6983     */
6984    typedef enum _Elm_Scroller_Policy
6985      {
6986         ELM_SCROLLER_POLICY_AUTO = 0, /**< Show scrollbars as needed */
6987         ELM_SCROLLER_POLICY_ON, /**< Always show scrollbars */
6988         ELM_SCROLLER_POLICY_OFF, /**< Never show scrollbars */
6989         ELM_SCROLLER_POLICY_LAST
6990      } Elm_Scroller_Policy;
6991    /**
6992     * @brief Add a new scroller to the parent
6993     *
6994     * @param parent The parent object
6995     * @return The new object or NULL if it cannot be created
6996     */
6997    EAPI Evas_Object *elm_scroller_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6998    /**
6999     * @brief Set the content of the scroller widget (the object to be scrolled around).
7000     *
7001     * @param obj The scroller object
7002     * @param content The new content object
7003     *
7004     * Once the content object is set, a previously set one will be deleted.
7005     * If you want to keep that old content object, use the
7006     * elm_scroller_content_unset() function.
7007     * @deprecated See elm_object_content_set()
7008     */
7009    EINA_DEPRECATED EAPI void         elm_scroller_content_set(Evas_Object *obj, Evas_Object *child) EINA_ARG_NONNULL(1);
7010    /**
7011     * @brief Get the content of the scroller widget
7012     *
7013     * @param obj The slider object
7014     * @return The content that is being used
7015     *
7016     * Return the content object which is set for this widget
7017     *
7018     * @see elm_scroller_content_set()
7019     * @deprecated use elm_object_content_get() instead.
7020     */
7021    EINA_DEPRECATED EAPI Evas_Object *elm_scroller_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7022    /**
7023     * @brief Unset the content of the scroller widget
7024     *
7025     * @param obj The slider object
7026     * @return The content that was being used
7027     *
7028     * Unparent and return the content object which was set for this widget
7029     *
7030     * @see elm_scroller_content_set()
7031     * @deprecated use elm_object_content_unset() instead.
7032     */
7033    EINA_DEPRECATED EAPI Evas_Object *elm_scroller_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7034    /**
7035     * @brief Set custom theme elements for the scroller
7036     *
7037     * @param obj The scroller object
7038     * @param widget The widget name to use (default is "scroller")
7039     * @param base The base name to use (default is "base")
7040     */
7041    EAPI void         elm_scroller_custom_widget_base_theme_set(Evas_Object *obj, const char *widget, const char *base) EINA_ARG_NONNULL(1, 2, 3);
7042    /**
7043     * @brief Make the scroller minimum size limited to the minimum size of the content
7044     *
7045     * @param obj The scroller object
7046     * @param w Enable limiting minimum size horizontally
7047     * @param h Enable limiting minimum size vertically
7048     *
7049     * By default the scroller will be as small as its design allows,
7050     * irrespective of its content. This will make the scroller minimum size the
7051     * right size horizontally and/or vertically to perfectly fit its content in
7052     * that direction.
7053     */
7054    EAPI void         elm_scroller_content_min_limit(Evas_Object *obj, Eina_Bool w, Eina_Bool h) EINA_ARG_NONNULL(1);
7055    /**
7056     * @brief Show a specific virtual region within the scroller content object
7057     *
7058     * @param obj The scroller object
7059     * @param x X coordinate of the region
7060     * @param y Y coordinate of the region
7061     * @param w Width of the region
7062     * @param h Height of the region
7063     *
7064     * This will ensure all (or part if it does not fit) of the designated
7065     * region in the virtual content object (0, 0 starting at the top-left of the
7066     * virtual content object) is shown within the scroller.
7067     */
7068    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);
7069    /**
7070     * @brief Set the scrollbar visibility policy
7071     *
7072     * @param obj The scroller object
7073     * @param policy_h Horizontal scrollbar policy
7074     * @param policy_v Vertical scrollbar policy
7075     *
7076     * This sets the scrollbar visibility policy for the given scroller.
7077     * ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it is
7078     * needed, and otherwise kept hidden. ELM_SCROLLER_POLICY_ON turns it on all
7079     * the time, and ELM_SCROLLER_POLICY_OFF always keeps it off. This applies
7080     * respectively for the horizontal and vertical scrollbars.
7081     */
7082    EAPI void         elm_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
7083    /**
7084     * @brief Gets scrollbar visibility policy
7085     *
7086     * @param obj The scroller object
7087     * @param policy_h Horizontal scrollbar policy
7088     * @param policy_v Vertical scrollbar policy
7089     *
7090     * @see elm_scroller_policy_set()
7091     */
7092    EAPI void         elm_scroller_policy_get(const Evas_Object *obj, Elm_Scroller_Policy *policy_h, Elm_Scroller_Policy *policy_v) EINA_ARG_NONNULL(1);
7093    /**
7094     * @brief Get the currently visible content region
7095     *
7096     * @param obj The scroller object
7097     * @param x X coordinate of the region
7098     * @param y Y coordinate of the region
7099     * @param w Width of the region
7100     * @param h Height of the region
7101     *
7102     * This gets the current region in the content object that is visible through
7103     * the scroller. The region co-ordinates are returned in the @p x, @p y, @p
7104     * w, @p h values pointed to.
7105     *
7106     * @note All coordinates are relative to the content.
7107     *
7108     * @see elm_scroller_region_show()
7109     */
7110    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);
7111    /**
7112     * @brief Get the size of the content object
7113     *
7114     * @param obj The scroller object
7115     * @param w Width of the content object.
7116     * @param h Height of the content object.
7117     *
7118     * This gets the size of the content object of the scroller.
7119     */
7120    EAPI void         elm_scroller_child_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
7121    /**
7122     * @brief Set bouncing behavior
7123     *
7124     * @param obj The scroller object
7125     * @param h_bounce Allow bounce horizontally
7126     * @param v_bounce Allow bounce vertically
7127     *
7128     * When scrolling, the scroller may "bounce" when reaching an edge of the
7129     * content object. This is a visual way to indicate the end has been reached.
7130     * This is enabled by default for both axis. This API will set if it is enabled
7131     * for the given axis with the boolean parameters for each axis.
7132     */
7133    EAPI void         elm_scroller_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
7134    /**
7135     * @brief Get the bounce behaviour
7136     *
7137     * @param obj The Scroller object
7138     * @param h_bounce Will the scroller bounce horizontally or not
7139     * @param v_bounce Will the scroller bounce vertically or not
7140     *
7141     * @see elm_scroller_bounce_set()
7142     */
7143    EAPI void         elm_scroller_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
7144    /**
7145     * @brief Set scroll page size relative to viewport size.
7146     *
7147     * @param obj The scroller object
7148     * @param h_pagerel The horizontal page relative size
7149     * @param v_pagerel The vertical page relative size
7150     *
7151     * The scroller is capable of limiting scrolling by the user to "pages". That
7152     * is to jump by and only show a "whole page" at a time as if the continuous
7153     * area of the scroller content is split into page sized pieces. This sets
7154     * the size of a page relative to the viewport of the scroller. 1.0 is "1
7155     * viewport" is size (horizontally or vertically). 0.0 turns it off in that
7156     * axis. This is mutually exclusive with page size
7157     * (see elm_scroller_page_size_set()  for more information). Likewise 0.5
7158     * is "half a viewport". Sane usable values are normally between 0.0 and 1.0
7159     * including 1.0. If you only want 1 axis to be page "limited", use 0.0 for
7160     * the other axis.
7161     */
7162    EAPI void         elm_scroller_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
7163    /**
7164     * @brief Set scroll page size.
7165     *
7166     * @param obj The scroller object
7167     * @param h_pagesize The horizontal page size
7168     * @param v_pagesize The vertical page size
7169     *
7170     * This sets the page size to an absolute fixed value, with 0 turning it off
7171     * for that axis.
7172     *
7173     * @see elm_scroller_page_relative_set()
7174     */
7175    EAPI void         elm_scroller_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
7176    /**
7177     * @brief Show a specific virtual region within the scroller content object.
7178     *
7179     * @param obj The scroller object
7180     * @param x X coordinate of the region
7181     * @param y Y coordinate of the region
7182     * @param w Width of the region
7183     * @param h Height of the region
7184     *
7185     * This will ensure all (or part if it does not fit) of the designated
7186     * region in the virtual content object (0, 0 starting at the top-left of the
7187     * virtual content object) is shown within the scroller. Unlike
7188     * elm_scroller_region_show(), this allow the scroller to "smoothly slide"
7189     * to this location (if configuration in general calls for transitions). It
7190     * may not jump immediately to the new location and make take a while and
7191     * show other content along the way.
7192     *
7193     * @see elm_scroller_region_show()
7194     */
7195    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);
7196    /**
7197     * @brief Set event propagation on a scroller
7198     *
7199     * @param obj The scroller object
7200     * @param propagation If propagation is enabled or not
7201     *
7202     * This enables or disabled event propagation from the scroller content to
7203     * the scroller and its parent. By default event propagation is disabled.
7204     */
7205    EAPI void         elm_scroller_propagate_events_set(Evas_Object *obj, Eina_Bool propagation) EINA_ARG_NONNULL(1);
7206    /**
7207     * @brief Get event propagation for a scroller
7208     *
7209     * @param obj The scroller object
7210     * @return The propagation state
7211     *
7212     * This gets the event propagation for a scroller.
7213     *
7214     * @see elm_scroller_propagate_events_set()
7215     */
7216    EAPI Eina_Bool    elm_scroller_propagate_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7217    /**
7218     * @brief Set scrolling gravity on a scroller
7219     *
7220     * @param obj The scroller object
7221     * @param x The scrolling horizontal gravity
7222     * @param y The scrolling vertical gravity
7223     *
7224     * The gravity, defines how the scroller will adjust its view
7225     * when the size of the scroller contents increase.
7226     *
7227     * The scroller will adjust the view to glue itself as follows.
7228     *
7229     *  x=0.0, for showing the left most region of the content.
7230     *  x=1.0, for showing the right most region of the content.
7231     *  y=0.0, for showing the bottom most region of the content.
7232     *  y=1.0, for showing the top most region of the content.
7233     *
7234     * Default values for x and y are 0.0
7235     */
7236    EAPI void         elm_scroller_gravity_set(Evas_Object *obj, double x, double y) EINA_ARG_NONNULL(1);
7237    /**
7238     * @brief Get scrolling gravity values for a scroller
7239     *
7240     * @param obj The scroller object
7241     * @param x The scrolling horizontal gravity
7242     * @param y The scrolling vertical gravity
7243     *
7244     * This gets gravity values for a scroller.
7245     *
7246     * @see elm_scroller_gravity_set()
7247     *
7248     */
7249    EAPI void         elm_scroller_gravity_get(const Evas_Object *obj, double *x, double *y) EINA_ARG_NONNULL(1);
7250    /**
7251     * @}
7252     */
7253
7254    /**
7255     * @defgroup Label Label
7256     *
7257     * @image html img/widget/label/preview-00.png
7258     * @image latex img/widget/label/preview-00.eps
7259     *
7260     * @brief Widget to display text, with simple html-like markup.
7261     *
7262     * The Label widget @b doesn't allow text to overflow its boundaries, if the
7263     * text doesn't fit the geometry of the label it will be ellipsized or be
7264     * cut. Elementary provides several themes for this widget:
7265     * @li default - No animation
7266     * @li marker - Centers the text in the label and make it bold by default
7267     * @li slide_long - The entire text appears from the right of the screen and
7268     * slides until it disappears in the left of the screen(reappering on the
7269     * right again).
7270     * @li slide_short - The text appears in the left of the label and slides to
7271     * the right to show the overflow. When all of the text has been shown the
7272     * position is reset.
7273     * @li slide_bounce - The text appears in the left of the label and slides to
7274     * the right to show the overflow. When all of the text has been shown the
7275     * animation reverses, moving the text to the left.
7276     *
7277     * Custom themes can of course invent new markup tags and style them any way
7278     * they like.
7279     *
7280     * The following signals may be emitted by the label widget:
7281     * @li "language,changed": The program's language changed.
7282     *
7283     * See @ref tutorial_label for a demonstration of how to use a label widget.
7284     * @{
7285     */
7286    /**
7287     * @brief Add a new label to the parent
7288     *
7289     * @param parent The parent object
7290     * @return The new object or NULL if it cannot be created
7291     */
7292    EAPI Evas_Object *elm_label_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7293    /**
7294     * @brief Set the label on the label object
7295     *
7296     * @param obj The label object
7297     * @param label The label will be used on the label object
7298     * @deprecated See elm_object_text_set()
7299     */
7300    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 */
7301    /**
7302     * @brief Get the label used on the label object
7303     *
7304     * @param obj The label object
7305     * @return The string inside the label
7306     * @deprecated See elm_object_text_get()
7307     */
7308    EINA_DEPRECATED EAPI const char *elm_label_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1); /* deprecated, use elm_object_text_get instead */
7309    /**
7310     * @brief Set the wrapping behavior of the label
7311     *
7312     * @param obj The label object
7313     * @param wrap To wrap text or not
7314     *
7315     * By default no wrapping is done. Possible values for @p wrap are:
7316     * @li ELM_WRAP_NONE - No wrapping
7317     * @li ELM_WRAP_CHAR - wrap between characters
7318     * @li ELM_WRAP_WORD - wrap between words
7319     * @li ELM_WRAP_MIXED - Word wrap, and if that fails, char wrap
7320     */
7321    EAPI void         elm_label_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
7322    /**
7323     * @brief Get the wrapping behavior of the label
7324     *
7325     * @param obj The label object
7326     * @return Wrap type
7327     *
7328     * @see elm_label_line_wrap_set()
7329     */
7330    EAPI Elm_Wrap_Type elm_label_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7331    /**
7332     * @brief Set wrap width of the label
7333     *
7334     * @param obj The label object
7335     * @param w The wrap width in pixels at a minimum where words need to wrap
7336     *
7337     * This function sets the maximum width size hint of the label.
7338     *
7339     * @warning This is only relevant if the label is inside a container.
7340     */
7341    EAPI void         elm_label_wrap_width_set(Evas_Object *obj, Evas_Coord w) EINA_ARG_NONNULL(1);
7342    /**
7343     * @brief Get wrap width of the label
7344     *
7345     * @param obj The label object
7346     * @return The wrap width in pixels at a minimum where words need to wrap
7347     *
7348     * @see elm_label_wrap_width_set()
7349     */
7350    EAPI Evas_Coord   elm_label_wrap_width_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7351    /**
7352     * @brief Set wrap height of the label
7353     *
7354     * @param obj The label object
7355     * @param h The wrap height in pixels at a minimum where words need to wrap
7356     *
7357     * This function sets the maximum height size hint of the label.
7358     *
7359     * @warning This is only relevant if the label is inside a container.
7360     */
7361    EAPI void         elm_label_wrap_height_set(Evas_Object *obj, Evas_Coord h) EINA_ARG_NONNULL(1);
7362    /**
7363     * @brief get wrap width of the label
7364     *
7365     * @param obj The label object
7366     * @return The wrap height in pixels at a minimum where words need to wrap
7367     */
7368    EAPI Evas_Coord   elm_label_wrap_height_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7369    /**
7370     * @brief Set the font size on the label object.
7371     *
7372     * @param obj The label object
7373     * @param size font size
7374     *
7375     * @warning NEVER use this. It is for hyper-special cases only. use styles
7376     * instead. e.g. "big", "medium", "small" - or better name them by use:
7377     * "title", "footnote", "quote" etc.
7378     */
7379    EAPI void         elm_label_fontsize_set(Evas_Object *obj, int fontsize) EINA_ARG_NONNULL(1);
7380    /**
7381     * @brief Set the text color on the label object
7382     *
7383     * @param obj The label object
7384     * @param r Red property background color of The label object
7385     * @param g Green property background color of The label object
7386     * @param b Blue property background color of The label object
7387     * @param a Alpha property background color of The label object
7388     *
7389     * @warning NEVER use this. It is for hyper-special cases only. use styles
7390     * instead. e.g. "big", "medium", "small" - or better name them by use:
7391     * "title", "footnote", "quote" etc.
7392     */
7393    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);
7394    /**
7395     * @brief Set the text align on the label object
7396     *
7397     * @param obj The label object
7398     * @param align align mode ("left", "center", "right")
7399     *
7400     * @warning NEVER use this. It is for hyper-special cases only. use styles
7401     * instead. e.g. "big", "medium", "small" - or better name them by use:
7402     * "title", "footnote", "quote" etc.
7403     */
7404    EAPI void         elm_label_text_align_set(Evas_Object *obj, const char *alignmode) EINA_ARG_NONNULL(1);
7405    /**
7406     * @brief Set background color of the label
7407     *
7408     * @param obj The label object
7409     * @param r Red property background color of The label object
7410     * @param g Green property background color of The label object
7411     * @param b Blue property background color of The label object
7412     * @param a Alpha property background alpha of The label object
7413     *
7414     * @warning NEVER use this. It is for hyper-special cases only. use styles
7415     * instead. e.g. "big", "medium", "small" - or better name them by use:
7416     * "title", "footnote", "quote" etc.
7417     */
7418    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);
7419    /**
7420     * @brief Set the ellipsis behavior of the label
7421     *
7422     * @param obj The label object
7423     * @param ellipsis To ellipsis text or not
7424     *
7425     * If set to true and the text doesn't fit in the label an ellipsis("...")
7426     * will be shown at the end of the widget.
7427     *
7428     * @warning This doesn't work with slide(elm_label_slide_set()) or if the
7429     * choosen wrap method was ELM_WRAP_WORD.
7430     */
7431    EAPI void         elm_label_ellipsis_set(Evas_Object *obj, Eina_Bool ellipsis) EINA_ARG_NONNULL(1);
7432    EINA_DEPRECATED EAPI void elm_label_wrap_mode_set(Evas_Object *obj, Eina_Bool wrapmode) EINA_ARG_NONNULL(1);
7433    /**
7434     * @brief Set the text slide of the label
7435     *
7436     * @param obj The label object
7437     * @param slide To start slide or stop
7438     *
7439     * If set to true, the text of the label will slide/scroll through the length of
7440     * label.
7441     *
7442     * @warning This only works with the themes "slide_short", "slide_long" and
7443     * "slide_bounce".
7444     */
7445    EAPI void         elm_label_slide_set(Evas_Object *obj, Eina_Bool slide) EINA_ARG_NONNULL(1);
7446    /**
7447     * @brief Get the text slide mode of the label
7448     *
7449     * @param obj The label object
7450     * @return slide slide mode value
7451     *
7452     * @see elm_label_slide_set()
7453     */
7454    EAPI Eina_Bool    elm_label_slide_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7455    /**
7456     * @brief Set the slide duration(speed) of the label
7457     *
7458     * @param obj The label object
7459     * @return The duration in seconds in moving text from slide begin position
7460     * to slide end position
7461     */
7462    EAPI void         elm_label_slide_duration_set(Evas_Object *obj, double duration) EINA_ARG_NONNULL(1);
7463    /**
7464     * @brief Get the slide duration(speed) of the label
7465     *
7466     * @param obj The label object
7467     * @return The duration time in moving text from slide begin position to slide end position
7468     *
7469     * @see elm_label_slide_duration_set()
7470     */
7471    EAPI double       elm_label_slide_duration_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7472    /**
7473     * @}
7474     */
7475
7476    /**
7477     * @defgroup Toggle Toggle
7478     *
7479     * @image html img/widget/toggle/preview-00.png
7480     * @image latex img/widget/toggle/preview-00.eps
7481     *
7482     * @brief A toggle is a slider which can be used to toggle between
7483     * two values.  It has two states: on and off.
7484     *
7485     * This widget is deprecated. Please use elm_check_add() instead using the
7486     * toggle style like:
7487     * 
7488     * @code
7489     * obj = elm_check_add(parent);
7490     * elm_object_style_set(obj, "toggle");
7491     * elm_object_text_part_set(obj, "on", "ON");
7492     * elm_object_text_part_set(obj, "off", "OFF");
7493     * @endcode
7494     * 
7495     * Signals that you can add callbacks for are:
7496     * @li "changed" - Whenever the toggle value has been changed.  Is not called
7497     *                 until the toggle is released by the cursor (assuming it
7498     *                 has been triggered by the cursor in the first place).
7499     *
7500     * @ref tutorial_toggle show how to use a toggle.
7501     * @{
7502     */
7503    /**
7504     * @brief Add a toggle to @p parent.
7505     *
7506     * @param parent The parent object
7507     *
7508     * @return The toggle object
7509     */
7510    EAPI Evas_Object *elm_toggle_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7511    /**
7512     * @brief Sets the label to be displayed with the toggle.
7513     *
7514     * @param obj The toggle object
7515     * @param label The label to be displayed
7516     *
7517     * @deprecated use elm_object_text_set() instead.
7518     */
7519    EINA_DEPRECATED EAPI void         elm_toggle_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7520    /**
7521     * @brief Gets the label of the toggle
7522     *
7523     * @param obj  toggle object
7524     * @return The label of the toggle
7525     *
7526     * @deprecated use elm_object_text_get() instead.
7527     */
7528    EINA_DEPRECATED EAPI const char  *elm_toggle_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7529    /**
7530     * @brief Set the icon used for the toggle
7531     *
7532     * @param obj The toggle object
7533     * @param icon The icon object for the button
7534     *
7535     * Once the icon object is set, a previously set one will be deleted
7536     * If you want to keep that old content object, use the
7537     * elm_toggle_icon_unset() function.
7538     *
7539     * @deprecated use elm_object_content_set() instead.
7540     */
7541    EAPI void         elm_toggle_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
7542    /**
7543     * @brief Get the icon used for the toggle
7544     *
7545     * @param obj The toggle object
7546     * @return The icon object that is being used
7547     *
7548     * Return the icon object which is set for this widget.
7549     *
7550     * @see elm_toggle_icon_set()
7551     *
7552     * @deprecated use elm_object_content_get() instead.
7553     */
7554    EAPI Evas_Object *elm_toggle_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7555    /**
7556     * @brief Unset the icon used for the toggle
7557     *
7558     * @param obj The toggle object
7559     * @return The icon object that was being used
7560     *
7561     * Unparent and return the icon object which was set for this widget.
7562     *
7563     * @see elm_toggle_icon_set()
7564     *
7565     * @deprecated use elm_object_content_unset() instead.
7566     */
7567    EAPI Evas_Object *elm_toggle_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7568    /**
7569     * @brief Sets the labels to be associated with the on and off states of the toggle.
7570     *
7571     * @param obj The toggle object
7572     * @param onlabel The label displayed when the toggle is in the "on" state
7573     * @param offlabel The label displayed when the toggle is in the "off" state
7574     *
7575     * @deprecated use elm_object_text_part_set() for "on" and "off" parts
7576     * instead.
7577     */
7578    EAPI void         elm_toggle_states_labels_set(Evas_Object *obj, const char *onlabel, const char *offlabel) EINA_ARG_NONNULL(1);
7579    /**
7580     * @brief Gets the labels associated with the on and off states of the
7581     * toggle.
7582     *
7583     * @param obj The toggle object
7584     * @param onlabel A char** to place the onlabel of @p obj into
7585     * @param offlabel A char** to place the offlabel of @p obj into
7586     *
7587     * @deprecated use elm_object_text_part_get() for "on" and "off" parts
7588     * instead.
7589     */
7590    EAPI void         elm_toggle_states_labels_get(const Evas_Object *obj, const char **onlabel, const char **offlabel) EINA_ARG_NONNULL(1);
7591    /**
7592     * @brief Sets the state of the toggle to @p state.
7593     *
7594     * @param obj The toggle object
7595     * @param state The state of @p obj
7596     *
7597     * @deprecated use elm_check_state_set() instead.
7598     */
7599    EAPI void         elm_toggle_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
7600    /**
7601     * @brief Gets the state of the toggle to @p state.
7602     *
7603     * @param obj The toggle object
7604     * @return The state of @p obj
7605     *
7606     * @deprecated use elm_check_state_get() instead.
7607     */
7608    EAPI Eina_Bool    elm_toggle_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7609    /**
7610     * @brief Sets the state pointer of the toggle to @p statep.
7611     *
7612     * @param obj The toggle object
7613     * @param statep The state pointer of @p obj
7614     *
7615     * @deprecated use elm_check_state_pointer_set() instead.
7616     */
7617    EAPI void         elm_toggle_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
7618    /**
7619     * @}
7620     */
7621
7622    /**
7623     * @page tutorial_frame Frame example
7624     * @dontinclude frame_example_01.c
7625     *
7626     * In this example we are going to create 4 Frames with different styles and
7627     * add a rectangle of different color in each.
7628     *
7629     * We start we the usual setup code:
7630     * @until show(bg)
7631     *
7632     * And then create one rectangle:
7633     * @until show
7634     *
7635     * To add it in our first frame, which since it doesn't have it's style
7636     * specifically set uses the default style:
7637     * @until show
7638     *
7639     * And then create another rectangle:
7640     * @until show
7641     *
7642     * To add it in our second frame, which uses the "pad_small" style, note that
7643     * even tough we are setting a text for this frame it won't be show, only the
7644     * default style shows the Frame's title:
7645     * @until show
7646     * @note The "pad_small", "pad_medium", "pad_large" and "pad_huge" styles are
7647     * very similar, their only difference is the size of the empty area around
7648     * the content of the frame.
7649     *
7650     * And then create yet another rectangle:
7651     * @until show
7652     *
7653     * To add it in our third frame, which uses the "outdent_top" style, note
7654     * that even tough we are setting a text for this frame it won't be show,
7655     * only the default style shows the Frame's title:
7656     * @until show
7657     *
7658     * And then create one last rectangle:
7659     * @until show
7660     *
7661     * To add it in our fourth and final frame, which uses the "outdent_bottom"
7662     * style, note that even tough we are setting a text for this frame it won't
7663     * be show, only the default style shows the Frame's title:
7664     * @until show
7665     *
7666     * And now we are left with just some more setup code:
7667     * @until ELM_MAIN()
7668     *
7669     * Our example will look like this:
7670     * @image html screenshots/frame_example_01.png
7671     * @image latex screenshots/frame_example_01.eps
7672     *
7673     * @example frame_example_01.c
7674     */
7675    /**
7676     * @defgroup Frame Frame
7677     *
7678     * @brief Frame is a widget that holds some content and has a title.
7679     *
7680     * The default look is a frame with a title, but Frame supports multple
7681     * styles:
7682     * @li default
7683     * @li pad_small
7684     * @li pad_medium
7685     * @li pad_large
7686     * @li pad_huge
7687     * @li outdent_top
7688     * @li outdent_bottom
7689     *
7690     * Of all this styles only default shows the title. Frame emits no signals.
7691     *
7692     * Default contents parts of the frame widget that you can use for are:
7693     * @li "elm.swallow.content" - A content of the frame
7694     *
7695     * Default text parts of the frame widget that you can use for are:
7696     * @li "elm.text" - Label of the frame
7697     *
7698     * For a detailed example see the @ref tutorial_frame.
7699     *
7700     * @{
7701     */
7702    /**
7703     * @brief Add a new frame to the parent
7704     *
7705     * @param parent The parent object
7706     * @return The new object or NULL if it cannot be created
7707     */
7708    EAPI Evas_Object *elm_frame_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7709    /**
7710     * @brief Set the frame label
7711     *
7712     * @param obj The frame object
7713     * @param label The label of this frame object
7714     *
7715     * @deprecated use elm_object_text_set() instead.
7716     */
7717    EINA_DEPRECATED EAPI void         elm_frame_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7718    /**
7719     * @brief Get the frame label
7720     *
7721     * @param obj The frame object
7722     *
7723     * @return The label of this frame objet or NULL if unable to get frame
7724     *
7725     * @deprecated use elm_object_text_get() instead.
7726     */
7727    EINA_DEPRECATED EAPI const char  *elm_frame_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7728    /**
7729     * @brief Set the content of the frame widget
7730     *
7731     * Once the content object is set, a previously set one will be deleted.
7732     * If you want to keep that old content object, use the
7733     * elm_frame_content_unset() function.
7734     *
7735     * @param obj The frame object
7736     * @param content The content will be filled in this frame object
7737     */
7738    EINA_DEPRECATED EAPI void         elm_frame_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
7739    /**
7740     * @brief Get the content of the frame widget
7741     *
7742     * Return the content object which is set for this widget
7743     *
7744     * @param obj The frame object
7745     * @return The content that is being used
7746     */
7747    EINA_DEPRECATED EAPI Evas_Object *elm_frame_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7748    /**
7749     * @brief Unset the content of the frame widget
7750     *
7751     * Unparent and return the content object which was set for this widget
7752     *
7753     * @param obj The frame object
7754     * @return The content that was being used
7755     */
7756    EINA_DEPRECATED EAPI Evas_Object *elm_frame_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7757    /**
7758     * @}
7759     */
7760
7761    /**
7762     * @defgroup Table Table
7763     *
7764     * A container widget to arrange other widgets in a table where items can
7765     * also span multiple columns or rows - even overlap (and then be raised or
7766     * lowered accordingly to adjust stacking if they do overlap).
7767     *
7768     * For a Table widget the row/column count is not fixed.
7769     * The table widget adjusts itself when subobjects are added to it dynamically.
7770     *
7771     * The followin are examples of how to use a table:
7772     * @li @ref tutorial_table_01
7773     * @li @ref tutorial_table_02
7774     *
7775     * @{
7776     */
7777    /**
7778     * @brief Add a new table to the parent
7779     *
7780     * @param parent The parent object
7781     * @return The new object or NULL if it cannot be created
7782     */
7783    EAPI Evas_Object *elm_table_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7784    /**
7785     * @brief Set the homogeneous layout in the table
7786     *
7787     * @param obj The layout object
7788     * @param homogeneous A boolean to set if the layout is homogeneous in the
7789     * table (EINA_TRUE = homogeneous,  EINA_FALSE = no homogeneous)
7790     */
7791    EAPI void         elm_table_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
7792    /**
7793     * @brief Get the current table homogeneous mode.
7794     *
7795     * @param obj The table object
7796     * @return A boolean to indicating if the layout is homogeneous in the table
7797     * (EINA_TRUE = homogeneous,  EINA_FALSE = no homogeneous)
7798     */
7799    EAPI Eina_Bool    elm_table_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7800    /**
7801     * @warning <b>Use elm_table_homogeneous_set() instead</b>
7802     */
7803    EINA_DEPRECATED EAPI void elm_table_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
7804    /**
7805     * @warning <b>Use elm_table_homogeneous_get() instead</b>
7806     */
7807    EINA_DEPRECATED EAPI Eina_Bool elm_table_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7808    /**
7809     * @brief Set padding between cells.
7810     *
7811     * @param obj The layout object.
7812     * @param horizontal set the horizontal padding.
7813     * @param vertical set the vertical padding.
7814     *
7815     * Default value is 0.
7816     */
7817    EAPI void         elm_table_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
7818    /**
7819     * @brief Get padding between cells.
7820     *
7821     * @param obj The layout object.
7822     * @param horizontal set the horizontal padding.
7823     * @param vertical set the vertical padding.
7824     */
7825    EAPI void         elm_table_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
7826    /**
7827     * @brief Add a subobject on the table with the coordinates passed
7828     *
7829     * @param obj The table object
7830     * @param subobj The subobject to be added to the table
7831     * @param x Row number
7832     * @param y Column number
7833     * @param w rowspan
7834     * @param h colspan
7835     *
7836     * @note All positioning inside the table is relative to rows and columns, so
7837     * a value of 0 for x and y, means the top left cell of the table, and a
7838     * value of 1 for w and h means @p subobj only takes that 1 cell.
7839     */
7840    EAPI void         elm_table_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
7841    /**
7842     * @brief Remove child from table.
7843     *
7844     * @param obj The table object
7845     * @param subobj The subobject
7846     */
7847    EAPI void         elm_table_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
7848    /**
7849     * @brief Faster way to remove all child objects from a table object.
7850     *
7851     * @param obj The table object
7852     * @param clear If true, will delete children, else just remove from table.
7853     */
7854    EAPI void         elm_table_clear(Evas_Object *obj, Eina_Bool clear) EINA_ARG_NONNULL(1);
7855    /**
7856     * @brief Set the packing location of an existing child of the table
7857     *
7858     * @param subobj The subobject to be modified in the table
7859     * @param x Row number
7860     * @param y Column number
7861     * @param w rowspan
7862     * @param h colspan
7863     *
7864     * Modifies the position of an object already in the table.
7865     *
7866     * @note All positioning inside the table is relative to rows and columns, so
7867     * a value of 0 for x and y, means the top left cell of the table, and a
7868     * value of 1 for w and h means @p subobj only takes that 1 cell.
7869     */
7870    EAPI void         elm_table_pack_set(Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
7871    /**
7872     * @brief Get the packing location of an existing child of the table
7873     *
7874     * @param subobj The subobject to be modified in the table
7875     * @param x Row number
7876     * @param y Column number
7877     * @param w rowspan
7878     * @param h colspan
7879     *
7880     * @see elm_table_pack_set()
7881     */
7882    EAPI void         elm_table_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
7883    /**
7884     * @}
7885     */
7886
7887    /**
7888     * @defgroup Gengrid Gengrid (Generic grid)
7889     *
7890     * This widget aims to position objects in a grid layout while
7891     * actually creating and rendering only the visible ones, using the
7892     * same idea as the @ref Genlist "genlist": the user defines a @b
7893     * class for each item, specifying functions that will be called at
7894     * object creation, deletion, etc. When those items are selected by
7895     * the user, a callback function is issued. Users may interact with
7896     * a gengrid via the mouse (by clicking on items to select them and
7897     * clicking on the grid's viewport and swiping to pan the whole
7898     * view) or via the keyboard, navigating through item with the
7899     * arrow keys.
7900     *
7901     * @section Gengrid_Layouts Gengrid layouts
7902     *
7903     * Gengrid may layout its items in one of two possible layouts:
7904     * - horizontal or
7905     * - vertical.
7906     *
7907     * When in "horizontal mode", items will be placed in @b columns,
7908     * from top to bottom and, when the space for a column is filled,
7909     * another one is started on the right, thus expanding the grid
7910     * horizontally, making for horizontal scrolling. When in "vertical
7911     * mode" , though, items will be placed in @b rows, from left to
7912     * right and, when the space for a row is filled, another one is
7913     * started below, thus expanding the grid vertically (and making
7914     * for vertical scrolling).
7915     *
7916     * @section Gengrid_Items Gengrid items
7917     *
7918     * An item in a gengrid can have 0 or more text labels (they can be
7919     * regular text or textblock Evas objects - that's up to the style
7920     * to determine), 0 or more icons (which are simply objects
7921     * swallowed into the gengrid item's theming Edje object) and 0 or
7922     * more <b>boolean states</b>, which have the behavior left to the
7923     * user to define. The Edje part names for each of these properties
7924     * will be looked up, in the theme file for the gengrid, under the
7925     * Edje (string) data items named @c "labels", @c "icons" and @c
7926     * "states", respectively. For each of those properties, if more
7927     * than one part is provided, they must have names listed separated
7928     * by spaces in the data fields. For the default gengrid item
7929     * theme, we have @b one label part (@c "elm.text"), @b two icon
7930     * parts (@c "elm.swalllow.icon" and @c "elm.swallow.end") and @b
7931     * no state parts.
7932     *
7933     * A gengrid item may be at one of several styles. Elementary
7934     * provides one by default - "default", but this can be extended by
7935     * system or application custom themes/overlays/extensions (see
7936     * @ref Theme "themes" for more details).
7937     *
7938     * @section Gengrid_Item_Class Gengrid item classes
7939     *
7940     * In order to have the ability to add and delete items on the fly,
7941     * gengrid implements a class (callback) system where the
7942     * application provides a structure with information about that
7943     * type of item (gengrid may contain multiple different items with
7944     * different classes, states and styles). Gengrid will call the
7945     * functions in this struct (methods) when an item is "realized"
7946     * (i.e., created dynamically, while the user is scrolling the
7947     * grid). All objects will simply be deleted when no longer needed
7948     * with evas_object_del(). The #Elm_GenGrid_Item_Class structure
7949     * contains the following members:
7950     * - @c item_style - This is a constant string and simply defines
7951     * the name of the item style. It @b must be specified and the
7952     * default should be @c "default".
7953     * - @c func.label_get - This function is called when an item
7954     * object is actually created. The @c data parameter will point to
7955     * the same data passed to elm_gengrid_item_append() and related
7956     * item creation functions. The @c obj parameter is the gengrid
7957     * object itself, while the @c part one is the name string of one
7958     * of the existing text parts in the Edje group implementing the
7959     * item's theme. This function @b must return a strdup'()ed string,
7960     * as the caller will free() it when done. See
7961     * #Elm_Gengrid_Item_Label_Get_Cb.
7962     * - @c func.content_get - This function is called when an item object
7963     * is actually created. The @c data parameter will point to the
7964     * same data passed to elm_gengrid_item_append() and related item
7965     * creation functions. The @c obj parameter is the gengrid object
7966     * itself, while the @c part one is the name string of one of the
7967     * existing (content) swallow parts in the Edje group implementing the
7968     * item's theme. It must return @c NULL, when no content is desired,
7969     * or a valid object handle, otherwise. The object will be deleted
7970     * by the gengrid on its deletion or when the item is "unrealized".
7971     * See #Elm_Gengrid_Item_Content_Get_Cb.
7972     * - @c func.state_get - This function is called when an item
7973     * object is actually created. The @c data parameter will point to
7974     * the same data passed to elm_gengrid_item_append() and related
7975     * item creation functions. The @c obj parameter is the gengrid
7976     * object itself, while the @c part one is the name string of one
7977     * of the state parts in the Edje group implementing the item's
7978     * theme. Return @c EINA_FALSE for false/off or @c EINA_TRUE for
7979     * true/on. Gengrids will emit a signal to its theming Edje object
7980     * with @c "elm,state,XXX,active" and @c "elm" as "emission" and
7981     * "source" arguments, respectively, when the state is true (the
7982     * default is false), where @c XXX is the name of the (state) part.
7983     * See #Elm_Gengrid_Item_State_Get_Cb.
7984     * - @c func.del - This is called when elm_gengrid_item_del() is
7985     * called on an item or elm_gengrid_clear() is called on the
7986     * gengrid. This is intended for use when gengrid items are
7987     * deleted, so any data attached to the item (e.g. its data
7988     * parameter on creation) can be deleted. See #Elm_Gengrid_Item_Del_Cb.
7989     *
7990     * @section Gengrid_Usage_Hints Usage hints
7991     *
7992     * If the user wants to have multiple items selected at the same
7993     * time, elm_gengrid_multi_select_set() will permit it. If the
7994     * gengrid is single-selection only (the default), then
7995     * elm_gengrid_select_item_get() will return the selected item or
7996     * @c NULL, if none is selected. If the gengrid is under
7997     * multi-selection, then elm_gengrid_selected_items_get() will
7998     * return a list (that is only valid as long as no items are
7999     * modified (added, deleted, selected or unselected) of child items
8000     * on a gengrid.
8001     *
8002     * If an item changes (internal (boolean) state, label or content 
8003     * changes), then use elm_gengrid_item_update() to have gengrid
8004     * update the item with the new state. A gengrid will re-"realize"
8005     * the item, thus calling the functions in the
8006     * #Elm_Gengrid_Item_Class set for that item.
8007     *
8008     * To programmatically (un)select an item, use
8009     * elm_gengrid_item_selected_set(). To get its selected state use
8010     * elm_gengrid_item_selected_get(). To make an item disabled
8011     * (unable to be selected and appear differently) use
8012     * elm_gengrid_item_disabled_set() to set this and
8013     * elm_gengrid_item_disabled_get() to get the disabled state.
8014     *
8015     * Grid cells will only have their selection smart callbacks called
8016     * when firstly getting selected. Any further clicks will do
8017     * nothing, unless you enable the "always select mode", with
8018     * elm_gengrid_always_select_mode_set(), thus making every click to
8019     * issue selection callbacks. elm_gengrid_no_select_mode_set() will
8020     * turn off the ability to select items entirely in the widget and
8021     * they will neither appear selected nor call the selection smart
8022     * callbacks.
8023     *
8024     * Remember that you can create new styles and add your own theme
8025     * augmentation per application with elm_theme_extension_add(). If
8026     * you absolutely must have a specific style that overrides any
8027     * theme the user or system sets up you can use
8028     * elm_theme_overlay_add() to add such a file.
8029     *
8030     * @section Gengrid_Smart_Events Gengrid smart events
8031     *
8032     * Smart events that you can add callbacks for are:
8033     * - @c "activated" - The user has double-clicked or pressed
8034     *   (enter|return|spacebar) on an item. The @c event_info parameter
8035     *   is the gengrid item that was activated.
8036     * - @c "clicked,double" - The user has double-clicked an item.
8037     *   The @c event_info parameter is the gengrid item that was double-clicked.
8038     * - @c "longpressed" - This is called when the item is pressed for a certain
8039     *   amount of time. By default it's 1 second.
8040     * - @c "selected" - The user has made an item selected. The
8041     *   @c event_info parameter is the gengrid item that was selected.
8042     * - @c "unselected" - The user has made an item unselected. The
8043     *   @c event_info parameter is the gengrid item that was unselected.
8044     * - @c "realized" - This is called when the item in the gengrid
8045     *   has its implementing Evas object instantiated, de facto. @c
8046     *   event_info is the gengrid item that was created. The object
8047     *   may be deleted at any time, so it is highly advised to the
8048     *   caller @b not to use the object pointer returned from
8049     *   elm_gengrid_item_object_get(), because it may point to freed
8050     *   objects.
8051     * - @c "unrealized" - This is called when the implementing Evas
8052     *   object for this item is deleted. @c event_info is the gengrid
8053     *   item that was deleted.
8054     * - @c "changed" - Called when an item is added, removed, resized
8055     *   or moved and when the gengrid is resized or gets "horizontal"
8056     *   property changes.
8057     * - @c "scroll,anim,start" - This is called when scrolling animation has
8058     *   started.
8059     * - @c "scroll,anim,stop" - This is called when scrolling animation has
8060     *   stopped.
8061     * - @c "drag,start,up" - Called when the item in the gengrid has
8062     *   been dragged (not scrolled) up.
8063     * - @c "drag,start,down" - Called when the item in the gengrid has
8064     *   been dragged (not scrolled) down.
8065     * - @c "drag,start,left" - Called when the item in the gengrid has
8066     *   been dragged (not scrolled) left.
8067     * - @c "drag,start,right" - Called when the item in the gengrid has
8068     *   been dragged (not scrolled) right.
8069     * - @c "drag,stop" - Called when the item in the gengrid has
8070     *   stopped being dragged.
8071     * - @c "drag" - Called when the item in the gengrid is being
8072     *   dragged.
8073     * - @c "scroll" - called when the content has been scrolled
8074     *   (moved).
8075     * - @c "scroll,drag,start" - called when dragging the content has
8076     *   started.
8077     * - @c "scroll,drag,stop" - called when dragging the content has
8078     *   stopped.
8079     * - @c "edge,top" - This is called when the gengrid is scrolled until
8080     *   the top edge.
8081     * - @c "edge,bottom" - This is called when the gengrid is scrolled
8082     *   until the bottom edge.
8083     * - @c "edge,left" - This is called when the gengrid is scrolled
8084     *   until the left edge.
8085     * - @c "edge,right" - This is called when the gengrid is scrolled
8086     *   until the right edge.
8087     *
8088     * List of gengrid examples:
8089     * @li @ref gengrid_example
8090     */
8091
8092    /**
8093     * @addtogroup Gengrid
8094     * @{
8095     */
8096
8097    typedef struct _Elm_Gengrid_Item_Class Elm_Gengrid_Item_Class; /**< Gengrid item class definition structs */
8098    typedef struct _Elm_Gengrid_Item Elm_Gengrid_Item; /**< Gengrid item handles */
8099    typedef struct _Elm_Gengrid_Item_Class_Func Elm_Gengrid_Item_Class_Func; /**< Class functions for gengrid item classes. */
8100    typedef char        *(*Elm_Gengrid_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for gengrid item classes. */
8101    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. */
8102    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. */
8103    typedef void         (*Elm_Gengrid_Item_Del_Cb)      (void *data, Evas_Object *obj); /**< Deletion class function for gengrid item classes. */
8104
8105    /* temporary compatibility code */
8106    typedef Elm_Gengrid_Item_Label_Get_Cb GridItemLabelGetFunc EINA_DEPRECATED;
8107    typedef Elm_Gengrid_Item_Content_Get_Cb GridItemIconGetFunc EINA_DEPRECATED;
8108    typedef Elm_Gengrid_Item_State_Get_Cb GridItemStateGetFunc EINA_DEPRECATED;
8109    typedef Elm_Gengrid_Item_Del_Cb GridItemDelFunc EINA_DEPRECATED;
8110
8111    /**
8112     * @struct _Elm_Gengrid_Item_Class
8113     *
8114     * Gengrid item class definition. See @ref Gengrid_Item_Class for
8115     * field details.
8116     */
8117    struct _Elm_Gengrid_Item_Class
8118      {
8119         const char             *item_style;
8120         struct _Elm_Gengrid_Item_Class_Func
8121           {
8122              Elm_Gengrid_Item_Label_Get_Cb label_get;
8123              Elm_Gengrid_Item_Content_Get_Cb icon_get;
8124              Elm_Gengrid_Item_State_Get_Cb state_get;
8125              Elm_Gengrid_Item_Del_Cb       del;
8126           } func;
8127      }; /**< #Elm_Gengrid_Item_Class member definitions */
8128    /**
8129     * Add a new gengrid widget to the given parent Elementary
8130     * (container) object
8131     *
8132     * @param parent The parent object
8133     * @return a new gengrid widget handle or @c NULL, on errors
8134     *
8135     * This function inserts a new gengrid widget on the canvas.
8136     *
8137     * @see elm_gengrid_item_size_set()
8138     * @see elm_gengrid_group_item_size_set()
8139     * @see elm_gengrid_horizontal_set()
8140     * @see elm_gengrid_item_append()
8141     * @see elm_gengrid_item_del()
8142     * @see elm_gengrid_clear()
8143     *
8144     * @ingroup Gengrid
8145     */
8146    EAPI Evas_Object       *elm_gengrid_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8147
8148    /**
8149     * Set the size for the items of a given gengrid widget
8150     *
8151     * @param obj The gengrid object.
8152     * @param w The items' width.
8153     * @param h The items' height;
8154     *
8155     * A gengrid, after creation, has still no information on the size
8156     * to give to each of its cells. So, you most probably will end up
8157     * with squares one @ref Fingers "finger" wide, the default
8158     * size. Use this function to force a custom size for you items,
8159     * making them as big as you wish.
8160     *
8161     * @see elm_gengrid_item_size_get()
8162     *
8163     * @ingroup Gengrid
8164     */
8165    EAPI void               elm_gengrid_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
8166
8167    /**
8168     * Get the size set for the items of a given gengrid widget
8169     *
8170     * @param obj The gengrid object.
8171     * @param w Pointer to a variable where to store the items' width.
8172     * @param h Pointer to a variable where to store the items' height.
8173     *
8174     * @note Use @c NULL pointers on the size values you're not
8175     * interested in: they'll be ignored by the function.
8176     *
8177     * @see elm_gengrid_item_size_get() for more details
8178     *
8179     * @ingroup Gengrid
8180     */
8181    EAPI void               elm_gengrid_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
8182
8183    /**
8184     * Set the items grid's alignment within a given gengrid widget
8185     *
8186     * @param obj The gengrid object.
8187     * @param align_x Alignment in the horizontal axis (0 <= align_x <= 1).
8188     * @param align_y Alignment in the vertical axis (0 <= align_y <= 1).
8189     *
8190     * This sets the alignment of the whole grid of items of a gengrid
8191     * within its given viewport. By default, those values are both
8192     * 0.5, meaning that the gengrid will have its items grid placed
8193     * exactly in the middle of its viewport.
8194     *
8195     * @note If given alignment values are out of the cited ranges,
8196     * they'll be changed to the nearest boundary values on the valid
8197     * ranges.
8198     *
8199     * @see elm_gengrid_align_get()
8200     *
8201     * @ingroup Gengrid
8202     */
8203    EAPI void               elm_gengrid_align_set(Evas_Object *obj, double align_x, double align_y) EINA_ARG_NONNULL(1);
8204
8205    /**
8206     * Get the items grid's alignment values within a given gengrid
8207     * widget
8208     *
8209     * @param obj The gengrid object.
8210     * @param align_x Pointer to a variable where to store the
8211     * horizontal alignment.
8212     * @param align_y Pointer to a variable where to store the vertical
8213     * alignment.
8214     *
8215     * @note Use @c NULL pointers on the alignment values you're not
8216     * interested in: they'll be ignored by the function.
8217     *
8218     * @see elm_gengrid_align_set() for more details
8219     *
8220     * @ingroup Gengrid
8221     */
8222    EAPI void               elm_gengrid_align_get(const Evas_Object *obj, double *align_x, double *align_y) EINA_ARG_NONNULL(1);
8223
8224    /**
8225     * Set whether a given gengrid widget is or not able have items
8226     * @b reordered
8227     *
8228     * @param obj The gengrid object
8229     * @param reorder_mode Use @c EINA_TRUE to turn reoderding on,
8230     * @c EINA_FALSE to turn it off
8231     *
8232     * If a gengrid is set to allow reordering, a click held for more
8233     * than 0.5 over a given item will highlight it specially,
8234     * signalling the gengrid has entered the reordering state. From
8235     * that time on, the user will be able to, while still holding the
8236     * mouse button down, move the item freely in the gengrid's
8237     * viewport, replacing to said item to the locations it goes to.
8238     * The replacements will be animated and, whenever the user
8239     * releases the mouse button, the item being replaced gets a new
8240     * definitive place in the grid.
8241     *
8242     * @see elm_gengrid_reorder_mode_get()
8243     *
8244     * @ingroup Gengrid
8245     */
8246    EAPI void               elm_gengrid_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
8247
8248    /**
8249     * Get whether a given gengrid widget is or not able have items
8250     * @b reordered
8251     *
8252     * @param obj The gengrid object
8253     * @return @c EINA_TRUE, if reoderding is on, @c EINA_FALSE if it's
8254     * off
8255     *
8256     * @see elm_gengrid_reorder_mode_set() for more details
8257     *
8258     * @ingroup Gengrid
8259     */
8260    EAPI Eina_Bool          elm_gengrid_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8261
8262    /**
8263     * Append a new item in a given gengrid widget.
8264     *
8265     * @param obj The gengrid object.
8266     * @param gic The item class for the item.
8267     * @param data The item data.
8268     * @param func Convenience function called when the item is
8269     * selected.
8270     * @param func_data Data to be passed to @p func.
8271     * @return A handle to the item added or @c NULL, on errors.
8272     *
8273     * This adds an item to the beginning of the gengrid.
8274     *
8275     * @see elm_gengrid_item_prepend()
8276     * @see elm_gengrid_item_insert_before()
8277     * @see elm_gengrid_item_insert_after()
8278     * @see elm_gengrid_item_del()
8279     *
8280     * @ingroup Gengrid
8281     */
8282    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);
8283
8284    /**
8285     * Prepend a new item in a given gengrid widget.
8286     *
8287     * @param obj The gengrid object.
8288     * @param gic The item class for the item.
8289     * @param data The item data.
8290     * @param func Convenience function called when the item is
8291     * selected.
8292     * @param func_data Data to be passed to @p func.
8293     * @return A handle to the item added or @c NULL, on errors.
8294     *
8295     * This adds an item to the end of the gengrid.
8296     *
8297     * @see elm_gengrid_item_append()
8298     * @see elm_gengrid_item_insert_before()
8299     * @see elm_gengrid_item_insert_after()
8300     * @see elm_gengrid_item_del()
8301     *
8302     * @ingroup Gengrid
8303     */
8304    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);
8305
8306    /**
8307     * Insert an item before another in a gengrid widget
8308     *
8309     * @param obj The gengrid object.
8310     * @param gic The item class for the item.
8311     * @param data The item data.
8312     * @param relative The item to place this new one before.
8313     * @param func Convenience function called when the item is
8314     * selected.
8315     * @param func_data Data to be passed to @p func.
8316     * @return A handle to the item added or @c NULL, on errors.
8317     *
8318     * This inserts an item before another in the gengrid.
8319     *
8320     * @see elm_gengrid_item_append()
8321     * @see elm_gengrid_item_prepend()
8322     * @see elm_gengrid_item_insert_after()
8323     * @see elm_gengrid_item_del()
8324     *
8325     * @ingroup Gengrid
8326     */
8327    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);
8328
8329    /**
8330     * Insert an item after another in a gengrid widget
8331     *
8332     * @param obj The gengrid object.
8333     * @param gic The item class for the item.
8334     * @param data The item data.
8335     * @param relative The item to place this new one after.
8336     * @param func Convenience function called when the item is
8337     * selected.
8338     * @param func_data Data to be passed to @p func.
8339     * @return A handle to the item added or @c NULL, on errors.
8340     *
8341     * This inserts an item after another in the gengrid.
8342     *
8343     * @see elm_gengrid_item_append()
8344     * @see elm_gengrid_item_prepend()
8345     * @see elm_gengrid_item_insert_after()
8346     * @see elm_gengrid_item_del()
8347     *
8348     * @ingroup Gengrid
8349     */
8350    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);
8351
8352    /**
8353     * Insert an item in a gengrid widget using a user-defined sort function.
8354     *
8355     * @param obj The gengrid object.
8356     * @param gic The item class for the item.
8357     * @param data The item data.
8358     * @param comp User defined comparison function that defines the sort order based on
8359     * Elm_Gen_Item and its data param.
8360     * @param func Convenience function called when the item is selected.
8361     * @param func_data Data to be passed to @p func.
8362     * @return A handle to the item added or @c NULL, on errors.
8363     *
8364     * This inserts an item in the gengrid based on user defined comparison function.
8365     *
8366     * @see elm_gengrid_item_append()
8367     * @see elm_gengrid_item_prepend()
8368     * @see elm_gengrid_item_insert_after()
8369     * @see elm_gengrid_item_del()
8370     * @see elm_gengrid_item_direct_sorted_insert()
8371     *
8372     * @ingroup Gengrid
8373     */
8374    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);
8375
8376    /**
8377     * Insert an item in a gengrid widget using a user-defined sort function.
8378     *
8379     * @param obj The gengrid object.
8380     * @param gic The item class for the item.
8381     * @param data The item data.
8382     * @param comp User defined comparison function that defines the sort order based on
8383     * Elm_Gen_Item.
8384     * @param func Convenience function called when the item is selected.
8385     * @param func_data Data to be passed to @p func.
8386     * @return A handle to the item added or @c NULL, on errors.
8387     *
8388     * This inserts an item in the gengrid based on user defined comparison function.
8389     *
8390     * @see elm_gengrid_item_append()
8391     * @see elm_gengrid_item_prepend()
8392     * @see elm_gengrid_item_insert_after()
8393     * @see elm_gengrid_item_del()
8394     * @see elm_gengrid_item_sorted_insert()
8395     *
8396     * @ingroup Gengrid
8397     */
8398    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);
8399
8400    /**
8401     * Set whether items on a given gengrid widget are to get their
8402     * selection callbacks issued for @b every subsequent selection
8403     * click on them or just for the first click.
8404     *
8405     * @param obj The gengrid object
8406     * @param always_select @c EINA_TRUE to make items "always
8407     * selected", @c EINA_FALSE, otherwise
8408     *
8409     * By default, grid items will only call their selection callback
8410     * function when firstly getting selected, any subsequent further
8411     * clicks will do nothing. With this call, you make those
8412     * subsequent clicks also to issue the selection callbacks.
8413     *
8414     * @note <b>Double clicks</b> will @b always be reported on items.
8415     *
8416     * @see elm_gengrid_always_select_mode_get()
8417     *
8418     * @ingroup Gengrid
8419     */
8420    EAPI void               elm_gengrid_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
8421
8422    /**
8423     * Get whether items on a given gengrid widget have their selection
8424     * callbacks issued for @b every subsequent selection click on them
8425     * or just for the first click.
8426     *
8427     * @param obj The gengrid object.
8428     * @return @c EINA_TRUE if the gengrid items are "always selected",
8429     * @c EINA_FALSE, otherwise
8430     *
8431     * @see elm_gengrid_always_select_mode_set() for more details
8432     *
8433     * @ingroup Gengrid
8434     */
8435    EAPI Eina_Bool          elm_gengrid_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8436
8437    /**
8438     * Set whether items on a given gengrid widget can be selected or not.
8439     *
8440     * @param obj The gengrid object
8441     * @param no_select @c EINA_TRUE to make items selectable,
8442     * @c EINA_FALSE otherwise
8443     *
8444     * This will make items in @p obj selectable or not. In the latter
8445     * case, any user interaction on the gengrid items will neither make
8446     * them appear selected nor them call their selection callback
8447     * functions.
8448     *
8449     * @see elm_gengrid_no_select_mode_get()
8450     *
8451     * @ingroup Gengrid
8452     */
8453    EAPI void               elm_gengrid_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
8454
8455    /**
8456     * Get whether items on a given gengrid widget can be selected or
8457     * not.
8458     *
8459     * @param obj The gengrid object
8460     * @return @c EINA_TRUE, if items are selectable, @c EINA_FALSE
8461     * otherwise
8462     *
8463     * @see elm_gengrid_no_select_mode_set() for more details
8464     *
8465     * @ingroup Gengrid
8466     */
8467    EAPI Eina_Bool          elm_gengrid_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8468
8469    /**
8470     * Enable or disable multi-selection in a given gengrid widget
8471     *
8472     * @param obj The gengrid object.
8473     * @param multi @c EINA_TRUE, to enable multi-selection,
8474     * @c EINA_FALSE to disable it.
8475     *
8476     * Multi-selection is the ability to have @b more than one
8477     * item selected, on a given gengrid, simultaneously. When it is
8478     * enabled, a sequence of clicks on different items will make them
8479     * all selected, progressively. A click on an already selected item
8480     * will unselect it. If interacting via the keyboard,
8481     * multi-selection is enabled while holding the "Shift" key.
8482     *
8483     * @note By default, multi-selection is @b disabled on gengrids
8484     *
8485     * @see elm_gengrid_multi_select_get()
8486     *
8487     * @ingroup Gengrid
8488     */
8489    EAPI void               elm_gengrid_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
8490
8491    /**
8492     * Get whether multi-selection is enabled or disabled for a given
8493     * gengrid widget
8494     *
8495     * @param obj The gengrid object.
8496     * @return @c EINA_TRUE, if multi-selection is enabled, @c
8497     * EINA_FALSE otherwise
8498     *
8499     * @see elm_gengrid_multi_select_set() for more details
8500     *
8501     * @ingroup Gengrid
8502     */
8503    EAPI Eina_Bool          elm_gengrid_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8504
8505    /**
8506     * Enable or disable bouncing effect for a given gengrid widget
8507     *
8508     * @param obj The gengrid object
8509     * @param h_bounce @c EINA_TRUE, to enable @b horizontal bouncing,
8510     * @c EINA_FALSE to disable it
8511     * @param v_bounce @c EINA_TRUE, to enable @b vertical bouncing,
8512     * @c EINA_FALSE to disable it
8513     *
8514     * The bouncing effect occurs whenever one reaches the gengrid's
8515     * edge's while panning it -- it will scroll past its limits a
8516     * little bit and return to the edge again, in a animated for,
8517     * automatically.
8518     *
8519     * @note By default, gengrids have bouncing enabled on both axis
8520     *
8521     * @see elm_gengrid_bounce_get()
8522     *
8523     * @ingroup Gengrid
8524     */
8525    EAPI void               elm_gengrid_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
8526
8527    /**
8528     * Get whether bouncing effects are enabled or disabled, for a
8529     * given gengrid widget, on each axis
8530     *
8531     * @param obj The gengrid object
8532     * @param h_bounce Pointer to a variable where to store the
8533     * horizontal bouncing flag.
8534     * @param v_bounce Pointer to a variable where to store the
8535     * vertical bouncing flag.
8536     *
8537     * @see elm_gengrid_bounce_set() for more details
8538     *
8539     * @ingroup Gengrid
8540     */
8541    EAPI void               elm_gengrid_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
8542
8543    /**
8544     * Set a given gengrid widget's scrolling page size, relative to
8545     * its viewport size.
8546     *
8547     * @param obj The gengrid object
8548     * @param h_pagerel The horizontal page (relative) size
8549     * @param v_pagerel The vertical page (relative) size
8550     *
8551     * The gengrid's scroller is capable of binding scrolling by the
8552     * user to "pages". It means that, while scrolling and, specially
8553     * after releasing the mouse button, the grid will @b snap to the
8554     * nearest displaying page's area. When page sizes are set, the
8555     * grid's continuous content area is split into (equal) page sized
8556     * pieces.
8557     *
8558     * This function sets the size of a page <b>relatively to the
8559     * viewport dimensions</b> of the gengrid, for each axis. A value
8560     * @c 1.0 means "the exact viewport's size", in that axis, while @c
8561     * 0.0 turns paging off in that axis. Likewise, @c 0.5 means "half
8562     * a viewport". Sane usable values are, than, between @c 0.0 and @c
8563     * 1.0. Values beyond those will make it behave behave
8564     * inconsistently. If you only want one axis to snap to pages, use
8565     * the value @c 0.0 for the other one.
8566     *
8567     * There is a function setting page size values in @b absolute
8568     * values, too -- elm_gengrid_page_size_set(). Naturally, its use
8569     * is mutually exclusive to this one.
8570     *
8571     * @see elm_gengrid_page_relative_get()
8572     *
8573     * @ingroup Gengrid
8574     */
8575    EAPI void               elm_gengrid_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
8576
8577    /**
8578     * Get a given gengrid widget's scrolling page size, relative to
8579     * its viewport size.
8580     *
8581     * @param obj The gengrid object
8582     * @param h_pagerel Pointer to a variable where to store the
8583     * horizontal page (relative) size
8584     * @param v_pagerel Pointer to a variable where to store the
8585     * vertical page (relative) size
8586     *
8587     * @see elm_gengrid_page_relative_set() for more details
8588     *
8589     * @ingroup Gengrid
8590     */
8591    EAPI void               elm_gengrid_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel) EINA_ARG_NONNULL(1);
8592
8593    /**
8594     * Set a given gengrid widget's scrolling page size
8595     *
8596     * @param obj The gengrid object
8597     * @param h_pagerel The horizontal page size, in pixels
8598     * @param v_pagerel The vertical page size, in pixels
8599     *
8600     * The gengrid's scroller is capable of binding scrolling by the
8601     * user to "pages". It means that, while scrolling and, specially
8602     * after releasing the mouse button, the grid will @b snap to the
8603     * nearest displaying page's area. When page sizes are set, the
8604     * grid's continuous content area is split into (equal) page sized
8605     * pieces.
8606     *
8607     * This function sets the size of a page of the gengrid, in pixels,
8608     * for each axis. Sane usable values are, between @c 0 and the
8609     * dimensions of @p obj, for each axis. Values beyond those will
8610     * make it behave behave inconsistently. If you only want one axis
8611     * to snap to pages, use the value @c 0 for the other one.
8612     *
8613     * There is a function setting page size values in @b relative
8614     * values, too -- elm_gengrid_page_relative_set(). Naturally, its
8615     * use is mutually exclusive to this one.
8616     *
8617     * @ingroup Gengrid
8618     */
8619    EAPI void               elm_gengrid_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
8620
8621    /**
8622     * Set the direction in which a given gengrid widget will expand while
8623     * placing its items.
8624     *
8625     * @param obj The gengrid object.
8626     * @param setting @c EINA_TRUE to make the gengrid expand
8627     * horizontally, @c EINA_FALSE to expand vertically.
8628     *
8629     * When in "horizontal mode" (@c EINA_TRUE), items will be placed
8630     * in @b columns, from top to bottom and, when the space for a
8631     * column is filled, another one is started on the right, thus
8632     * expanding the grid horizontally. When in "vertical mode"
8633     * (@c EINA_FALSE), though, items will be placed in @b rows, from left
8634     * to right and, when the space for a row is filled, another one is
8635     * started below, thus expanding the grid vertically.
8636     *
8637     * @see elm_gengrid_horizontal_get()
8638     *
8639     * @ingroup Gengrid
8640     */
8641    EAPI void               elm_gengrid_horizontal_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
8642
8643    /**
8644     * Get for what direction a given gengrid widget will expand while
8645     * placing its items.
8646     *
8647     * @param obj The gengrid object.
8648     * @return @c EINA_TRUE, if @p obj is set to expand horizontally,
8649     * @c EINA_FALSE if it's set to expand vertically.
8650     *
8651     * @see elm_gengrid_horizontal_set() for more detais
8652     *
8653     * @ingroup Gengrid
8654     */
8655    EAPI Eina_Bool          elm_gengrid_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8656
8657    /**
8658     * Get the first item in a given gengrid widget
8659     *
8660     * @param obj The gengrid object
8661     * @return The first item's handle or @c NULL, if there are no
8662     * items in @p obj (and on errors)
8663     *
8664     * This returns the first item in the @p obj's internal list of
8665     * items.
8666     *
8667     * @see elm_gengrid_last_item_get()
8668     *
8669     * @ingroup Gengrid
8670     */
8671    EAPI Elm_Gengrid_Item  *elm_gengrid_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8672
8673    /**
8674     * Get the last item in a given gengrid widget
8675     *
8676     * @param obj The gengrid object
8677     * @return The last item's handle or @c NULL, if there are no
8678     * items in @p obj (and on errors)
8679     *
8680     * This returns the last item in the @p obj's internal list of
8681     * items.
8682     *
8683     * @see elm_gengrid_first_item_get()
8684     *
8685     * @ingroup Gengrid
8686     */
8687    EAPI Elm_Gengrid_Item  *elm_gengrid_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8688
8689    /**
8690     * Get the @b next item in a gengrid widget's internal list of items,
8691     * given a handle to one of those items.
8692     *
8693     * @param item The gengrid item to fetch next from
8694     * @return The item after @p item, or @c NULL if there's none (and
8695     * on errors)
8696     *
8697     * This returns the item placed after the @p item, on the container
8698     * gengrid.
8699     *
8700     * @see elm_gengrid_item_prev_get()
8701     *
8702     * @ingroup Gengrid
8703     */
8704    EAPI Elm_Gengrid_Item  *elm_gengrid_item_next_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8705
8706    /**
8707     * Get the @b previous item in a gengrid widget's internal list of items,
8708     * given a handle to one of those items.
8709     *
8710     * @param item The gengrid item to fetch previous from
8711     * @return The item before @p item, or @c NULL if there's none (and
8712     * on errors)
8713     *
8714     * This returns the item placed before the @p item, on the container
8715     * gengrid.
8716     *
8717     * @see elm_gengrid_item_next_get()
8718     *
8719     * @ingroup Gengrid
8720     */
8721    EAPI Elm_Gengrid_Item  *elm_gengrid_item_prev_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8722
8723    /**
8724     * Get the gengrid object's handle which contains a given gengrid
8725     * item
8726     *
8727     * @param item The item to fetch the container from
8728     * @return The gengrid (parent) object
8729     *
8730     * This returns the gengrid object itself that an item belongs to.
8731     *
8732     * @ingroup Gengrid
8733     */
8734    EAPI Evas_Object       *elm_gengrid_item_gengrid_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8735
8736    /**
8737     * Remove a gengrid item from its parent, deleting it.
8738     *
8739     * @param item The item to be removed.
8740     * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
8741     *
8742     * @see elm_gengrid_clear(), to remove all items in a gengrid at
8743     * once.
8744     *
8745     * @ingroup Gengrid
8746     */
8747    EAPI void               elm_gengrid_item_del(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8748
8749    /**
8750     * Update the contents of a given gengrid item
8751     *
8752     * @param item The gengrid item
8753     *
8754     * This updates an item by calling all the item class functions
8755     * again to get the contents, labels and states. Use this when the
8756     * original item data has changed and you want the changes to be
8757     * reflected.
8758     *
8759     * @ingroup Gengrid
8760     */
8761    EAPI void               elm_gengrid_item_update(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8762
8763    /**
8764     * Get the Gengrid Item class for the given Gengrid Item.
8765     *
8766     * @param item The gengrid item
8767     *
8768     * This returns the Gengrid_Item_Class for the given item. It can be used to examine
8769     * the function pointers and item_style.
8770     *
8771     * @ingroup Gengrid
8772     */
8773    EAPI const Elm_Gengrid_Item_Class *elm_gengrid_item_item_class_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8774
8775    /**
8776     * Get the Gengrid Item class for the given Gengrid Item.
8777     *
8778     * This sets the Gengrid_Item_Class for the given item. It can be used to examine
8779     * the function pointers and item_style.
8780     *
8781     * @param item The gengrid item
8782     * @param gic The gengrid item class describing the function pointers and the item style.
8783     *
8784     * @ingroup Gengrid
8785     */
8786    EAPI void               elm_gengrid_item_item_class_set(Elm_Gengrid_Item *item, const Elm_Gengrid_Item_Class *gic) EINA_ARG_NONNULL(1, 2);
8787
8788    /**
8789     * Return the data associated to a given gengrid item
8790     *
8791     * @param item The gengrid item.
8792     * @return the data associated with this item.
8793     *
8794     * This returns the @c data value passed on the
8795     * elm_gengrid_item_append() and related item addition calls.
8796     *
8797     * @see elm_gengrid_item_append()
8798     * @see elm_gengrid_item_data_set()
8799     *
8800     * @ingroup Gengrid
8801     */
8802    EAPI void              *elm_gengrid_item_data_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8803
8804    /**
8805     * Set the data associated with a given gengrid item
8806     *
8807     * @param item The gengrid item
8808     * @param data The data pointer to set on it
8809     *
8810     * This @b overrides the @c data value passed on the
8811     * elm_gengrid_item_append() and related item addition calls. This
8812     * function @b won't call elm_gengrid_item_update() automatically,
8813     * so you'd issue it afterwards if you want to have the item
8814     * updated to reflect the new data.
8815     *
8816     * @see elm_gengrid_item_data_get()
8817     * @see elm_gengrid_item_update()
8818     *
8819     * @ingroup Gengrid
8820     */
8821    EAPI void               elm_gengrid_item_data_set(Elm_Gengrid_Item *item, const void *data) EINA_ARG_NONNULL(1);
8822
8823    /**
8824     * Get a given gengrid item's position, relative to the whole
8825     * gengrid's grid area.
8826     *
8827     * @param item The Gengrid item.
8828     * @param x Pointer to variable to store the item's <b>row number</b>.
8829     * @param y Pointer to variable to store the item's <b>column number</b>.
8830     *
8831     * This returns the "logical" position of the item within the
8832     * gengrid. For example, @c (0, 1) would stand for first row,
8833     * second column.
8834     *
8835     * @ingroup Gengrid
8836     */
8837    EAPI void               elm_gengrid_item_pos_get(const Elm_Gengrid_Item *item, unsigned int *x, unsigned int *y) EINA_ARG_NONNULL(1);
8838
8839    /**
8840     * Set whether a given gengrid item is selected or not
8841     *
8842     * @param item The gengrid item
8843     * @param selected Use @c EINA_TRUE, to make it selected, @c
8844     * EINA_FALSE to make it unselected
8845     *
8846     * This sets the selected state of an item. If multi-selection is
8847     * not enabled on the containing gengrid and @p selected is @c
8848     * EINA_TRUE, any other previously selected items will get
8849     * unselected in favor of this new one.
8850     *
8851     * @see elm_gengrid_item_selected_get()
8852     *
8853     * @ingroup Gengrid
8854     */
8855    EAPI void               elm_gengrid_item_selected_set(Elm_Gengrid_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
8856
8857    /**
8858     * Get whether a given gengrid item is selected or not
8859     *
8860     * @param item The gengrid item
8861     * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
8862     *
8863     * This API returns EINA_TRUE for all the items selected in multi-select mode as well.
8864     *
8865     * @see elm_gengrid_item_selected_set() for more details
8866     *
8867     * @ingroup Gengrid
8868     */
8869    EAPI Eina_Bool          elm_gengrid_item_selected_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8870
8871    /**
8872     * Get the real Evas object created to implement the view of a
8873     * given gengrid item
8874     *
8875     * @param item The gengrid item.
8876     * @return the Evas object implementing this item's view.
8877     *
8878     * This returns the actual Evas object used to implement the
8879     * specified gengrid item's view. This may be @c NULL, as it may
8880     * not have been created or may have been deleted, at any time, by
8881     * the gengrid. <b>Do not modify this object</b> (move, resize,
8882     * show, hide, etc.), as the gengrid is controlling it. This
8883     * function is for querying, emitting custom signals or hooking
8884     * lower level callbacks for events on that object. Do not delete
8885     * this object under any circumstances.
8886     *
8887     * @see elm_gengrid_item_data_get()
8888     *
8889     * @ingroup Gengrid
8890     */
8891    EAPI const Evas_Object *elm_gengrid_item_object_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8892
8893    /**
8894     * Show the portion of a gengrid's internal grid containing a given
8895     * item, @b immediately.
8896     *
8897     * @param item The item to display
8898     *
8899     * This causes gengrid to @b redraw its viewport's contents to the
8900     * region contining the given @p item item, if it is not fully
8901     * visible.
8902     *
8903     * @see elm_gengrid_item_bring_in()
8904     *
8905     * @ingroup Gengrid
8906     */
8907    EAPI void               elm_gengrid_item_show(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8908
8909    /**
8910     * Animatedly bring in, to the visible area of a gengrid, a given
8911     * item on it.
8912     *
8913     * @param item The gengrid item to display
8914     *
8915     * This causes gengrid to jump to the given @p item and show
8916     * it (by scrolling), if it is not fully visible. This will use
8917     * animation to do so and take a period of time to complete.
8918     *
8919     * @see elm_gengrid_item_show()
8920     *
8921     * @ingroup Gengrid
8922     */
8923    EAPI void               elm_gengrid_item_bring_in(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8924
8925    /**
8926     * Set whether a given gengrid item is disabled or not.
8927     *
8928     * @param item The gengrid item
8929     * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
8930     * to enable it back.
8931     *
8932     * A disabled item cannot be selected or unselected. It will also
8933     * change its appearance, to signal the user it's disabled.
8934     *
8935     * @see elm_gengrid_item_disabled_get()
8936     *
8937     * @ingroup Gengrid
8938     */
8939    EAPI void               elm_gengrid_item_disabled_set(Elm_Gengrid_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
8940
8941    /**
8942     * Get whether a given gengrid item is disabled or not.
8943     *
8944     * @param item The gengrid item
8945     * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
8946     * (and on errors).
8947     *
8948     * @see elm_gengrid_item_disabled_set() for more details
8949     *
8950     * @ingroup Gengrid
8951     */
8952    EAPI Eina_Bool          elm_gengrid_item_disabled_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8953
8954    /**
8955     * Set the text to be shown in a given gengrid item's tooltips.
8956     *
8957     * @param item The gengrid item
8958     * @param text The text to set in the content
8959     *
8960     * This call will setup the text to be used as tooltip to that item
8961     * (analogous to elm_object_tooltip_text_set(), but being item
8962     * tooltips with higher precedence than object tooltips). It can
8963     * have only one tooltip at a time, so any previous tooltip data
8964     * will get removed.
8965     *
8966     * @ingroup Gengrid
8967     */
8968    EAPI void               elm_gengrid_item_tooltip_text_set(Elm_Gengrid_Item *item, const char *text) EINA_ARG_NONNULL(1);
8969
8970    /**
8971     * Set the content to be shown in a given gengrid item's tooltip
8972     *
8973     * @param item The gengrid item.
8974     * @param func The function returning the tooltip contents.
8975     * @param data What to provide to @a func as callback data/context.
8976     * @param del_cb Called when data is not needed anymore, either when
8977     *        another callback replaces @p func, the tooltip is unset with
8978     *        elm_gengrid_item_tooltip_unset() or the owner @p item
8979     *        dies. This callback receives as its first parameter the
8980     *        given @p data, being @c event_info the item handle.
8981     *
8982     * This call will setup the tooltip's contents to @p item
8983     * (analogous to elm_object_tooltip_content_cb_set(), but being
8984     * item tooltips with higher precedence than object tooltips). It
8985     * can have only one tooltip at a time, so any previous tooltip
8986     * content will get removed. @p func (with @p data) will be called
8987     * every time Elementary needs to show the tooltip and it should
8988     * return a valid Evas object, which will be fully managed by the
8989     * tooltip system, getting deleted when the tooltip is gone.
8990     *
8991     * @ingroup Gengrid
8992     */
8993    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);
8994
8995    /**
8996     * Unset a tooltip from a given gengrid item
8997     *
8998     * @param item gengrid item to remove a previously set tooltip from.
8999     *
9000     * This call removes any tooltip set on @p item. The callback
9001     * provided as @c del_cb to
9002     * elm_gengrid_item_tooltip_content_cb_set() will be called to
9003     * notify it is not used anymore (and have resources cleaned, if
9004     * need be).
9005     *
9006     * @see elm_gengrid_item_tooltip_content_cb_set()
9007     *
9008     * @ingroup Gengrid
9009     */
9010    EAPI void               elm_gengrid_item_tooltip_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9011
9012    /**
9013     * Set a different @b style for a given gengrid item's tooltip.
9014     *
9015     * @param item gengrid item with tooltip set
9016     * @param style the <b>theme style</b> to use on tooltips (e.g. @c
9017     * "default", @c "transparent", etc)
9018     *
9019     * Tooltips can have <b>alternate styles</b> to be displayed on,
9020     * which are defined by the theme set on Elementary. This function
9021     * works analogously as elm_object_tooltip_style_set(), but here
9022     * applied only to gengrid item objects. The default style for
9023     * tooltips is @c "default".
9024     *
9025     * @note before you set a style you should define a tooltip with
9026     *       elm_gengrid_item_tooltip_content_cb_set() or
9027     *       elm_gengrid_item_tooltip_text_set()
9028     *
9029     * @see elm_gengrid_item_tooltip_style_get()
9030     *
9031     * @ingroup Gengrid
9032     */
9033    EAPI void               elm_gengrid_item_tooltip_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
9034
9035    /**
9036     * Get the style set a given gengrid item's tooltip.
9037     *
9038     * @param item gengrid item with tooltip already set on.
9039     * @return style the theme style in use, which defaults to
9040     *         "default". If the object does not have a tooltip set,
9041     *         then @c NULL is returned.
9042     *
9043     * @see elm_gengrid_item_tooltip_style_set() for more details
9044     *
9045     * @ingroup Gengrid
9046     */
9047    EAPI const char        *elm_gengrid_item_tooltip_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9048    /**
9049     * Set the type of mouse pointer/cursor decoration to be shown,
9050     * when the mouse pointer is over the given gengrid widget item
9051     *
9052     * @param item gengrid item to customize cursor on
9053     * @param cursor the cursor type's name
9054     *
9055     * This function works analogously as elm_object_cursor_set(), but
9056     * here the cursor's changing area is restricted to the item's
9057     * area, and not the whole widget's. Note that that item cursors
9058     * have precedence over widget cursors, so that a mouse over @p
9059     * item will always show cursor @p type.
9060     *
9061     * If this function is called twice for an object, a previously set
9062     * cursor will be unset on the second call.
9063     *
9064     * @see elm_object_cursor_set()
9065     * @see elm_gengrid_item_cursor_get()
9066     * @see elm_gengrid_item_cursor_unset()
9067     *
9068     * @ingroup Gengrid
9069     */
9070    EAPI void               elm_gengrid_item_cursor_set(Elm_Gengrid_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
9071
9072    /**
9073     * Get the type of mouse pointer/cursor decoration set to be shown,
9074     * when the mouse pointer is over the given gengrid widget item
9075     *
9076     * @param item gengrid item with custom cursor set
9077     * @return the cursor type's name or @c NULL, if no custom cursors
9078     * were set to @p item (and on errors)
9079     *
9080     * @see elm_object_cursor_get()
9081     * @see elm_gengrid_item_cursor_set() for more details
9082     * @see elm_gengrid_item_cursor_unset()
9083     *
9084     * @ingroup Gengrid
9085     */
9086    EAPI const char        *elm_gengrid_item_cursor_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9087
9088    /**
9089     * Unset any custom mouse pointer/cursor decoration set to be
9090     * shown, when the mouse pointer is over the given gengrid widget
9091     * item, thus making it show the @b default cursor again.
9092     *
9093     * @param item a gengrid item
9094     *
9095     * Use this call to undo any custom settings on this item's cursor
9096     * decoration, bringing it back to defaults (no custom style set).
9097     *
9098     * @see elm_object_cursor_unset()
9099     * @see elm_gengrid_item_cursor_set() for more details
9100     *
9101     * @ingroup Gengrid
9102     */
9103    EAPI void               elm_gengrid_item_cursor_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9104
9105    /**
9106     * Set a different @b style for a given custom cursor set for a
9107     * gengrid item.
9108     *
9109     * @param item gengrid item with custom cursor set
9110     * @param style the <b>theme style</b> to use (e.g. @c "default",
9111     * @c "transparent", etc)
9112     *
9113     * This function only makes sense when one is using custom mouse
9114     * cursor decorations <b>defined in a theme file</b> , which can
9115     * have, given a cursor name/type, <b>alternate styles</b> on
9116     * it. It works analogously as elm_object_cursor_style_set(), but
9117     * here applied only to gengrid item objects.
9118     *
9119     * @warning Before you set a cursor style you should have defined a
9120     *       custom cursor previously on the item, with
9121     *       elm_gengrid_item_cursor_set()
9122     *
9123     * @see elm_gengrid_item_cursor_engine_only_set()
9124     * @see elm_gengrid_item_cursor_style_get()
9125     *
9126     * @ingroup Gengrid
9127     */
9128    EAPI void               elm_gengrid_item_cursor_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
9129
9130    /**
9131     * Get the current @b style set for a given gengrid item's custom
9132     * cursor
9133     *
9134     * @param item gengrid item with custom cursor set.
9135     * @return style the cursor style in use. If the object does not
9136     *         have a cursor set, then @c NULL is returned.
9137     *
9138     * @see elm_gengrid_item_cursor_style_set() for more details
9139     *
9140     * @ingroup Gengrid
9141     */
9142    EAPI const char        *elm_gengrid_item_cursor_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9143
9144    /**
9145     * Set if the (custom) cursor for a given gengrid item should be
9146     * searched in its theme, also, or should only rely on the
9147     * rendering engine.
9148     *
9149     * @param item item with custom (custom) cursor already set on
9150     * @param engine_only Use @c EINA_TRUE to have cursors looked for
9151     * only on those provided by the rendering engine, @c EINA_FALSE to
9152     * have them searched on the widget's theme, as well.
9153     *
9154     * @note This call is of use only if you've set a custom cursor
9155     * for gengrid items, with elm_gengrid_item_cursor_set().
9156     *
9157     * @note By default, cursors will only be looked for between those
9158     * provided by the rendering engine.
9159     *
9160     * @ingroup Gengrid
9161     */
9162    EAPI void               elm_gengrid_item_cursor_engine_only_set(Elm_Gengrid_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
9163
9164    /**
9165     * Get if the (custom) cursor for a given gengrid item is being
9166     * searched in its theme, also, or is only relying on the rendering
9167     * engine.
9168     *
9169     * @param item a gengrid item
9170     * @return @c EINA_TRUE, if cursors are being looked for only on
9171     * those provided by the rendering engine, @c EINA_FALSE if they
9172     * are being searched on the widget's theme, as well.
9173     *
9174     * @see elm_gengrid_item_cursor_engine_only_set(), for more details
9175     *
9176     * @ingroup Gengrid
9177     */
9178    EAPI Eina_Bool          elm_gengrid_item_cursor_engine_only_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9179
9180    /**
9181     * Remove all items from a given gengrid widget
9182     *
9183     * @param obj The gengrid object.
9184     *
9185     * This removes (and deletes) all items in @p obj, leaving it
9186     * empty.
9187     *
9188     * @see elm_gengrid_item_del(), to remove just one item.
9189     *
9190     * @ingroup Gengrid
9191     */
9192    EAPI void               elm_gengrid_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
9193
9194    /**
9195     * Get the selected item in a given gengrid widget
9196     *
9197     * @param obj The gengrid object.
9198     * @return The selected item's handleor @c NULL, if none is
9199     * selected at the moment (and on errors)
9200     *
9201     * This returns the selected item in @p obj. If multi selection is
9202     * enabled on @p obj (@see elm_gengrid_multi_select_set()), only
9203     * the first item in the list is selected, which might not be very
9204     * useful. For that case, see elm_gengrid_selected_items_get().
9205     *
9206     * @ingroup Gengrid
9207     */
9208    EAPI Elm_Gengrid_Item  *elm_gengrid_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9209
9210    /**
9211     * Get <b>a list</b> of selected items in a given gengrid
9212     *
9213     * @param obj The gengrid object.
9214     * @return The list of selected items or @c NULL, if none is
9215     * selected at the moment (and on errors)
9216     *
9217     * This returns a list of the selected items, in the order that
9218     * they appear in the grid. This list is only valid as long as no
9219     * more items are selected or unselected (or unselected implictly
9220     * by deletion). The list contains #Elm_Gengrid_Item pointers as
9221     * data, naturally.
9222     *
9223     * @see elm_gengrid_selected_item_get()
9224     *
9225     * @ingroup Gengrid
9226     */
9227    EAPI const Eina_List   *elm_gengrid_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9228
9229    /**
9230     * @}
9231     */
9232
9233    /**
9234     * @defgroup Clock Clock
9235     *
9236     * @image html img/widget/clock/preview-00.png
9237     * @image latex img/widget/clock/preview-00.eps
9238     *
9239     * This is a @b digital clock widget. In its default theme, it has a
9240     * vintage "flipping numbers clock" appearance, which will animate
9241     * sheets of individual algarisms individually as time goes by.
9242     *
9243     * A newly created clock will fetch system's time (already
9244     * considering local time adjustments) to start with, and will tick
9245     * accondingly. It may or may not show seconds.
9246     *
9247     * Clocks have an @b edition mode. When in it, the sheets will
9248     * display extra arrow indications on the top and bottom and the
9249     * user may click on them to raise or lower the time values. After
9250     * it's told to exit edition mode, it will keep ticking with that
9251     * new time set (it keeps the difference from local time).
9252     *
9253     * Also, when under edition mode, user clicks on the cited arrows
9254     * which are @b held for some time will make the clock to flip the
9255     * sheet, thus editing the time, continuosly and automatically for
9256     * the user. The interval between sheet flips will keep growing in
9257     * time, so that it helps the user to reach a time which is distant
9258     * from the one set.
9259     *
9260     * The time display is, by default, in military mode (24h), but an
9261     * am/pm indicator may be optionally shown, too, when it will
9262     * switch to 12h.
9263     *
9264     * Smart callbacks one can register to:
9265     * - "changed" - the clock's user changed the time
9266     *
9267     * Here is an example on its usage:
9268     * @li @ref clock_example
9269     */
9270
9271    /**
9272     * @addtogroup Clock
9273     * @{
9274     */
9275
9276    /**
9277     * Identifiers for which clock digits should be editable, when a
9278     * clock widget is in edition mode. Values may be ORed together to
9279     * make a mask, naturally.
9280     *
9281     * @see elm_clock_edit_set()
9282     * @see elm_clock_digit_edit_set()
9283     */
9284    typedef enum _Elm_Clock_Digedit
9285      {
9286         ELM_CLOCK_NONE         = 0, /**< Default value. Means that all digits are editable, when in edition mode. */
9287         ELM_CLOCK_HOUR_DECIMAL = 1 << 0, /**< Decimal algarism of hours value should be editable */
9288         ELM_CLOCK_HOUR_UNIT    = 1 << 1, /**< Unit algarism of hours value should be editable */
9289         ELM_CLOCK_MIN_DECIMAL  = 1 << 2, /**< Decimal algarism of minutes value should be editable */
9290         ELM_CLOCK_MIN_UNIT     = 1 << 3, /**< Unit algarism of minutes value should be editable */
9291         ELM_CLOCK_SEC_DECIMAL  = 1 << 4, /**< Decimal algarism of seconds value should be editable */
9292         ELM_CLOCK_SEC_UNIT     = 1 << 5, /**< Unit algarism of seconds value should be editable */
9293         ELM_CLOCK_ALL          = (1 << 6) - 1 /**< All digits should be editable */
9294      } Elm_Clock_Digedit;
9295
9296    /**
9297     * Add a new clock widget to the given parent Elementary
9298     * (container) object
9299     *
9300     * @param parent The parent object
9301     * @return a new clock widget handle or @c NULL, on errors
9302     *
9303     * This function inserts a new clock widget on the canvas.
9304     *
9305     * @ingroup Clock
9306     */
9307    EAPI Evas_Object      *elm_clock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9308
9309    /**
9310     * Set a clock widget's time, programmatically
9311     *
9312     * @param obj The clock widget object
9313     * @param hrs The hours to set
9314     * @param min The minutes to set
9315     * @param sec The secondes to set
9316     *
9317     * This function updates the time that is showed by the clock
9318     * widget.
9319     *
9320     *  Values @b must be set within the following ranges:
9321     * - 0 - 23, for hours
9322     * - 0 - 59, for minutes
9323     * - 0 - 59, for seconds,
9324     *
9325     * even if the clock is not in "military" mode.
9326     *
9327     * @warning The behavior for values set out of those ranges is @b
9328     * undefined.
9329     *
9330     * @ingroup Clock
9331     */
9332    EAPI void              elm_clock_time_set(Evas_Object *obj, int hrs, int min, int sec) EINA_ARG_NONNULL(1);
9333
9334    /**
9335     * Get a clock widget's time values
9336     *
9337     * @param obj The clock object
9338     * @param[out] hrs Pointer to the variable to get the hours value
9339     * @param[out] min Pointer to the variable to get the minutes value
9340     * @param[out] sec Pointer to the variable to get the seconds value
9341     *
9342     * This function gets the time set for @p obj, returning
9343     * it on the variables passed as the arguments to function
9344     *
9345     * @note Use @c NULL pointers on the time values you're not
9346     * interested in: they'll be ignored by the function.
9347     *
9348     * @ingroup Clock
9349     */
9350    EAPI void              elm_clock_time_get(const Evas_Object *obj, int *hrs, int *min, int *sec) EINA_ARG_NONNULL(1);
9351
9352    /**
9353     * Set whether a given clock widget is under <b>edition mode</b> or
9354     * under (default) displaying-only mode.
9355     *
9356     * @param obj The clock object
9357     * @param edit @c EINA_TRUE to put it in edition, @c EINA_FALSE to
9358     * put it back to "displaying only" mode
9359     *
9360     * This function makes a clock's time to be editable or not <b>by
9361     * user interaction</b>. When in edition mode, clocks @b stop
9362     * ticking, until one brings them back to canonical mode. The
9363     * elm_clock_digit_edit_set() function will influence which digits
9364     * of the clock will be editable. By default, all of them will be
9365     * (#ELM_CLOCK_NONE).
9366     *
9367     * @note am/pm sheets, if being shown, will @b always be editable
9368     * under edition mode.
9369     *
9370     * @see elm_clock_edit_get()
9371     *
9372     * @ingroup Clock
9373     */
9374    EAPI void              elm_clock_edit_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
9375
9376    /**
9377     * Retrieve whether a given clock widget is under <b>edition
9378     * mode</b> or under (default) displaying-only mode.
9379     *
9380     * @param obj The clock object
9381     * @param edit @c EINA_TRUE, if it's in edition mode, @c EINA_FALSE
9382     * otherwise
9383     *
9384     * This function retrieves whether the clock's time can be edited
9385     * or not by user interaction.
9386     *
9387     * @see elm_clock_edit_set() for more details
9388     *
9389     * @ingroup Clock
9390     */
9391    EAPI Eina_Bool         elm_clock_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9392
9393    /**
9394     * Set what digits of the given clock widget should be editable
9395     * when in edition mode.
9396     *
9397     * @param obj The clock object
9398     * @param digedit Bit mask indicating the digits to be editable
9399     * (values in #Elm_Clock_Digedit).
9400     *
9401     * If the @p digedit param is #ELM_CLOCK_NONE, editing will be
9402     * disabled on @p obj (same effect as elm_clock_edit_set(), with @c
9403     * EINA_FALSE).
9404     *
9405     * @see elm_clock_digit_edit_get()
9406     *
9407     * @ingroup Clock
9408     */
9409    EAPI void              elm_clock_digit_edit_set(Evas_Object *obj, Elm_Clock_Digedit digedit) EINA_ARG_NONNULL(1);
9410
9411    /**
9412     * Retrieve what digits of the given clock widget should be
9413     * editable when in edition mode.
9414     *
9415     * @param obj The clock object
9416     * @return Bit mask indicating the digits to be editable
9417     * (values in #Elm_Clock_Digedit).
9418     *
9419     * @see elm_clock_digit_edit_set() for more details
9420     *
9421     * @ingroup Clock
9422     */
9423    EAPI Elm_Clock_Digedit elm_clock_digit_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9424
9425    /**
9426     * Set if the given clock widget must show hours in military or
9427     * am/pm mode
9428     *
9429     * @param obj The clock object
9430     * @param am_pm @c EINA_TRUE to put it in am/pm mode, @c EINA_FALSE
9431     * to military mode
9432     *
9433     * This function sets if the clock must show hours in military or
9434     * am/pm mode. In some countries like Brazil the military mode
9435     * (00-24h-format) is used, in opposition to the USA, where the
9436     * am/pm mode is more commonly used.
9437     *
9438     * @see elm_clock_show_am_pm_get()
9439     *
9440     * @ingroup Clock
9441     */
9442    EAPI void              elm_clock_show_am_pm_set(Evas_Object *obj, Eina_Bool am_pm) EINA_ARG_NONNULL(1);
9443
9444    /**
9445     * Get if the given clock widget shows hours in military or am/pm
9446     * mode
9447     *
9448     * @param obj The clock object
9449     * @return @c EINA_TRUE, if in am/pm mode, @c EINA_FALSE if in
9450     * military
9451     *
9452     * This function gets if the clock shows hours in military or am/pm
9453     * mode.
9454     *
9455     * @see elm_clock_show_am_pm_set() for more details
9456     *
9457     * @ingroup Clock
9458     */
9459    EAPI Eina_Bool         elm_clock_show_am_pm_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9460
9461    /**
9462     * Set if the given clock widget must show time with seconds or not
9463     *
9464     * @param obj The clock object
9465     * @param seconds @c EINA_TRUE to show seconds, @c EINA_FALSE otherwise
9466     *
9467     * This function sets if the given clock must show or not elapsed
9468     * seconds. By default, they are @b not shown.
9469     *
9470     * @see elm_clock_show_seconds_get()
9471     *
9472     * @ingroup Clock
9473     */
9474    EAPI void              elm_clock_show_seconds_set(Evas_Object *obj, Eina_Bool seconds) EINA_ARG_NONNULL(1);
9475
9476    /**
9477     * Get whether the given clock widget is showing time with seconds
9478     * or not
9479     *
9480     * @param obj The clock object
9481     * @return @c EINA_TRUE if it's showing seconds, @c EINA_FALSE otherwise
9482     *
9483     * This function gets whether @p obj is showing or not the elapsed
9484     * seconds.
9485     *
9486     * @see elm_clock_show_seconds_set()
9487     *
9488     * @ingroup Clock
9489     */
9490    EAPI Eina_Bool         elm_clock_show_seconds_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9491
9492    /**
9493     * Set the interval on time updates for an user mouse button hold
9494     * on clock widgets' time edition.
9495     *
9496     * @param obj The clock object
9497     * @param interval The (first) interval value in seconds
9498     *
9499     * This interval value is @b decreased while the user holds the
9500     * mouse pointer either incrementing or decrementing a given the
9501     * clock digit's value.
9502     *
9503     * This helps the user to get to a given time distant from the
9504     * current one easier/faster, as it will start to flip quicker and
9505     * quicker on mouse button holds.
9506     *
9507     * The calculation for the next flip interval value, starting from
9508     * the one set with this call, is the previous interval divided by
9509     * 1.05, so it decreases a little bit.
9510     *
9511     * The default starting interval value for automatic flips is
9512     * @b 0.85 seconds.
9513     *
9514     * @see elm_clock_interval_get()
9515     *
9516     * @ingroup Clock
9517     */
9518    EAPI void              elm_clock_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
9519
9520    /**
9521     * Get the interval on time updates for an user mouse button hold
9522     * on clock widgets' time edition.
9523     *
9524     * @param obj The clock object
9525     * @return The (first) interval value, in seconds, set on it
9526     *
9527     * @see elm_clock_interval_set() for more details
9528     *
9529     * @ingroup Clock
9530     */
9531    EAPI double            elm_clock_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9532
9533    /**
9534     * @}
9535     */
9536
9537    /**
9538     * @defgroup Layout Layout
9539     *
9540     * @image html img/widget/layout/preview-00.png
9541     * @image latex img/widget/layout/preview-00.eps width=\textwidth
9542     *
9543     * @image html img/layout-predefined.png
9544     * @image latex img/layout-predefined.eps width=\textwidth
9545     *
9546     * This is a container widget that takes a standard Edje design file and
9547     * wraps it very thinly in a widget.
9548     *
9549     * An Edje design (theme) file has a very wide range of possibilities to
9550     * describe the behavior of elements added to the Layout. Check out the Edje
9551     * documentation and the EDC reference to get more information about what can
9552     * be done with Edje.
9553     *
9554     * Just like @ref List, @ref Box, and other container widgets, any
9555     * object added to the Layout will become its child, meaning that it will be
9556     * deleted if the Layout is deleted, move if the Layout is moved, and so on.
9557     *
9558     * The Layout widget can contain as many Contents, Boxes or Tables as
9559     * described in its theme file. For instance, objects can be added to
9560     * different Tables by specifying the respective Table part names. The same
9561     * is valid for Content and Box.
9562     *
9563     * The objects added as child of the Layout will behave as described in the
9564     * part description where they were added. There are 3 possible types of
9565     * parts where a child can be added:
9566     *
9567     * @section secContent Content (SWALLOW part)
9568     *
9569     * Only one object can be added to the @c SWALLOW part (but you still can
9570     * have many @c SWALLOW parts and one object on each of them). Use the @c
9571     * elm_object_content_set/get/unset functions to set, retrieve and unset 
9572     * objects as content of the @c SWALLOW. After being set to this part, the 
9573     * object size, position, visibility, clipping and other description 
9574     * properties will be totally controled by the description of the given part 
9575     * (inside the Edje theme file).
9576     *
9577     * One can use @c evas_object_size_hint_* functions on the child to have some
9578     * kind of control over its behavior, but the resulting behavior will still
9579     * depend heavily on the @c SWALLOW part description.
9580     *
9581     * The Edje theme also can change the part description, based on signals or
9582     * scripts running inside the theme. This change can also be animated. All of
9583     * this will affect the child object set as content accordingly. The object
9584     * size will be changed if the part size is changed, it will animate move if
9585     * the part is moving, and so on.
9586     *
9587     * The following picture demonstrates a Layout widget with a child object
9588     * added to its @c SWALLOW:
9589     *
9590     * @image html layout_swallow.png
9591     * @image latex layout_swallow.eps width=\textwidth
9592     *
9593     * @section secBox Box (BOX part)
9594     *
9595     * An Edje @c BOX part is very similar to the Elementary @ref Box widget. It
9596     * allows one to add objects to the box and have them distributed along its
9597     * area, accordingly to the specified @a layout property (now by @a layout we
9598     * mean the chosen layouting design of the Box, not the Layout widget
9599     * itself).
9600     *
9601     * A similar effect for having a box with its position, size and other things
9602     * controled by the Layout theme would be to create an Elementary @ref Box
9603     * widget and add it as a Content in the @c SWALLOW part.
9604     *
9605     * The main difference of using the Layout Box is that its behavior, the box
9606     * properties like layouting format, padding, align, etc. will be all
9607     * controled by the theme. This means, for example, that a signal could be
9608     * sent to the Layout theme (with elm_object_signal_emit()) and the theme
9609     * handled the signal by changing the box padding, or align, or both. Using
9610     * the Elementary @ref Box widget is not necessarily harder or easier, it
9611     * just depends on the circunstances and requirements.
9612     *
9613     * The Layout Box can be used through the @c elm_layout_box_* set of
9614     * functions.
9615     *
9616     * The following picture demonstrates a Layout widget with many child objects
9617     * added to its @c BOX part:
9618     *
9619     * @image html layout_box.png
9620     * @image latex layout_box.eps width=\textwidth
9621     *
9622     * @section secTable Table (TABLE part)
9623     *
9624     * Just like the @ref secBox, the Layout Table is very similar to the
9625     * Elementary @ref Table widget. It allows one to add objects to the Table
9626     * specifying the row and column where the object should be added, and any
9627     * column or row span if necessary.
9628     *
9629     * Again, we could have this design by adding a @ref Table widget to the @c
9630     * SWALLOW part using elm_object_content_part_set(). The same difference happens
9631     * here when choosing to use the Layout Table (a @c TABLE part) instead of
9632     * the @ref Table plus @c SWALLOW part. It's just a matter of convenience.
9633     *
9634     * The Layout Table can be used through the @c elm_layout_table_* set of
9635     * functions.
9636     *
9637     * The following picture demonstrates a Layout widget with many child objects
9638     * added to its @c TABLE part:
9639     *
9640     * @image html layout_table.png
9641     * @image latex layout_table.eps width=\textwidth
9642     *
9643     * @section secPredef Predefined Layouts
9644     *
9645     * Another interesting thing about the Layout widget is that it offers some
9646     * predefined themes that come with the default Elementary theme. These
9647     * themes can be set by the call elm_layout_theme_set(), and provide some
9648     * basic functionality depending on the theme used.
9649     *
9650     * Most of them already send some signals, some already provide a toolbar or
9651     * back and next buttons.
9652     *
9653     * These are available predefined theme layouts. All of them have class = @c
9654     * layout, group = @c application, and style = one of the following options:
9655     *
9656     * @li @c toolbar-content - application with toolbar and main content area
9657     * @li @c toolbar-content-back - application with toolbar and main content
9658     * area with a back button and title area
9659     * @li @c toolbar-content-back-next - application with toolbar and main
9660     * content area with a back and next buttons and title area
9661     * @li @c content-back - application with a main content area with a back
9662     * button and title area
9663     * @li @c content-back-next - application with a main content area with a
9664     * back and next buttons and title area
9665     * @li @c toolbar-vbox - application with toolbar and main content area as a
9666     * vertical box
9667     * @li @c toolbar-table - application with toolbar and main content area as a
9668     * table
9669     *
9670     * @section secExamples Examples
9671     *
9672     * Some examples of the Layout widget can be found here:
9673     * @li @ref layout_example_01
9674     * @li @ref layout_example_02
9675     * @li @ref layout_example_03
9676     * @li @ref layout_example_edc
9677     *
9678     */
9679
9680    /**
9681     * Add a new layout to the parent
9682     *
9683     * @param parent The parent object
9684     * @return The new object or NULL if it cannot be created
9685     *
9686     * @see elm_layout_file_set()
9687     * @see elm_layout_theme_set()
9688     *
9689     * @ingroup Layout
9690     */
9691    EAPI Evas_Object       *elm_layout_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9692    /**
9693     * Set the file that will be used as layout
9694     *
9695     * @param obj The layout object
9696     * @param file The path to file (edj) that will be used as layout
9697     * @param group The group that the layout belongs in edje file
9698     *
9699     * @return (1 = success, 0 = error)
9700     *
9701     * @ingroup Layout
9702     */
9703    EAPI Eina_Bool          elm_layout_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
9704    /**
9705     * Set the edje group from the elementary theme that will be used as layout
9706     *
9707     * @param obj The layout object
9708     * @param clas the clas of the group
9709     * @param group the group
9710     * @param style the style to used
9711     *
9712     * @return (1 = success, 0 = error)
9713     *
9714     * @ingroup Layout
9715     */
9716    EAPI Eina_Bool          elm_layout_theme_set(Evas_Object *obj, const char *clas, const char *group, const char *style) EINA_ARG_NONNULL(1);
9717    /**
9718     * Set the layout content.
9719     *
9720     * @param obj The layout object
9721     * @param swallow The swallow part name in the edje file
9722     * @param content The child that will be added in this layout object
9723     *
9724     * Once the content object is set, a previously set one will be deleted.
9725     * If you want to keep that old content object, use the
9726     * elm_object_content_part_unset() function.
9727     *
9728     * @note In an Edje theme, the part used as a content container is called @c
9729     * SWALLOW. This is why the parameter name is called @p swallow, but it is
9730     * expected to be a part name just like the second parameter of
9731     * elm_layout_box_append().
9732     *
9733     * @see elm_layout_box_append()
9734     * @see elm_object_content_part_get()
9735     * @see elm_object_content_part_unset()
9736     * @see @ref secBox
9737     *
9738     * @ingroup Layout
9739     */
9740    EAPI void               elm_layout_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
9741    /**
9742     * Get the child object in the given content part.
9743     *
9744     * @param obj The layout object
9745     * @param swallow The SWALLOW part to get its content
9746     *
9747     * @return The swallowed object or NULL if none or an error occurred
9748     *
9749     * @see elm_object_content_part_set()
9750     *
9751     * @ingroup Layout
9752     */
9753    EAPI Evas_Object       *elm_layout_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
9754    /**
9755     * Unset the layout content.
9756     *
9757     * @param obj The layout object
9758     * @param swallow The swallow part name in the edje file
9759     * @return The content that was being used
9760     *
9761     * Unparent and return the content object which was set for this part.
9762     *
9763     * @see elm_object_content_part_set()
9764     *
9765     * @ingroup Layout
9766     */
9767    EAPI Evas_Object       *elm_layout_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
9768    /**
9769     * Set the text of the given part
9770     *
9771     * @param obj The layout object
9772     * @param part The TEXT part where to set the text
9773     * @param text The text to set
9774     *
9775     * @ingroup Layout
9776     * @deprecated use elm_object_text_* instead.
9777     */
9778    EINA_DEPRECATED EAPI void               elm_layout_text_set(Evas_Object *obj, const char *part, const char *text) EINA_ARG_NONNULL(1);
9779    /**
9780     * Get the text set in the given part
9781     *
9782     * @param obj The layout object
9783     * @param part The TEXT part to retrieve the text off
9784     *
9785     * @return The text set in @p part
9786     *
9787     * @ingroup Layout
9788     * @deprecated use elm_object_text_* instead.
9789     */
9790    EINA_DEPRECATED EAPI const char        *elm_layout_text_get(const Evas_Object *obj, const char *part) EINA_ARG_NONNULL(1);
9791    /**
9792     * Append child to layout box part.
9793     *
9794     * @param obj the layout object
9795     * @param part the box part to which the object will be appended.
9796     * @param child the child object to append to box.
9797     *
9798     * Once the object is appended, it will become child of the layout. Its
9799     * lifetime will be bound to the layout, whenever the layout dies the child
9800     * will be deleted automatically. One should use elm_layout_box_remove() to
9801     * make this layout forget about the object.
9802     *
9803     * @see elm_layout_box_prepend()
9804     * @see elm_layout_box_insert_before()
9805     * @see elm_layout_box_insert_at()
9806     * @see elm_layout_box_remove()
9807     *
9808     * @ingroup Layout
9809     */
9810    EAPI void               elm_layout_box_append(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
9811    /**
9812     * Prepend child to layout box part.
9813     *
9814     * @param obj the layout object
9815     * @param part the box part to prepend.
9816     * @param child the child object to prepend to box.
9817     *
9818     * Once the object is prepended, it will become child of the layout. Its
9819     * lifetime will be bound to the layout, whenever the layout dies the child
9820     * will be deleted automatically. One should use elm_layout_box_remove() to
9821     * make this layout forget about the object.
9822     *
9823     * @see elm_layout_box_append()
9824     * @see elm_layout_box_insert_before()
9825     * @see elm_layout_box_insert_at()
9826     * @see elm_layout_box_remove()
9827     *
9828     * @ingroup Layout
9829     */
9830    EAPI void               elm_layout_box_prepend(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
9831    /**
9832     * Insert child to layout box part before a reference object.
9833     *
9834     * @param obj the layout object
9835     * @param part the box part to insert.
9836     * @param child the child object to insert into box.
9837     * @param reference another reference object to insert before in box.
9838     *
9839     * Once the object is inserted, it will become child of the layout. Its
9840     * lifetime will be bound to the layout, whenever the layout dies the child
9841     * will be deleted automatically. One should use elm_layout_box_remove() to
9842     * make this layout forget about the object.
9843     *
9844     * @see elm_layout_box_append()
9845     * @see elm_layout_box_prepend()
9846     * @see elm_layout_box_insert_before()
9847     * @see elm_layout_box_remove()
9848     *
9849     * @ingroup Layout
9850     */
9851    EAPI void               elm_layout_box_insert_before(Evas_Object *obj, const char *part, Evas_Object *child, const Evas_Object *reference) EINA_ARG_NONNULL(1);
9852    /**
9853     * Insert child to layout box part at a given position.
9854     *
9855     * @param obj the layout object
9856     * @param part the box part to insert.
9857     * @param child the child object to insert into box.
9858     * @param pos the numeric position >=0 to insert the child.
9859     *
9860     * Once the object is inserted, it will become child of the layout. Its
9861     * lifetime will be bound to the layout, whenever the layout dies the child
9862     * will be deleted automatically. One should use elm_layout_box_remove() to
9863     * make this layout forget about the object.
9864     *
9865     * @see elm_layout_box_append()
9866     * @see elm_layout_box_prepend()
9867     * @see elm_layout_box_insert_before()
9868     * @see elm_layout_box_remove()
9869     *
9870     * @ingroup Layout
9871     */
9872    EAPI void               elm_layout_box_insert_at(Evas_Object *obj, const char *part, Evas_Object *child, unsigned int pos) EINA_ARG_NONNULL(1);
9873    /**
9874     * Remove a child of the given part box.
9875     *
9876     * @param obj The layout object
9877     * @param part The box part name to remove child.
9878     * @param child The object to remove from box.
9879     * @return The object that was being used, or NULL if not found.
9880     *
9881     * The object will be removed from the box part and its lifetime will
9882     * not be handled by the layout anymore. This is equivalent to
9883     * elm_object_content_part_unset() for box.
9884     *
9885     * @see elm_layout_box_append()
9886     * @see elm_layout_box_remove_all()
9887     *
9888     * @ingroup Layout
9889     */
9890    EAPI Evas_Object       *elm_layout_box_remove(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1, 2, 3);
9891    /**
9892     * Remove all child of the given part box.
9893     *
9894     * @param obj The layout object
9895     * @param part The box part name to remove child.
9896     * @param clear If EINA_TRUE, then all objects will be deleted as
9897     *        well, otherwise they will just be removed and will be
9898     *        dangling on the canvas.
9899     *
9900     * The objects will be removed from the box part and their lifetime will
9901     * not be handled by the layout anymore. This is equivalent to
9902     * elm_layout_box_remove() for all box children.
9903     *
9904     * @see elm_layout_box_append()
9905     * @see elm_layout_box_remove()
9906     *
9907     * @ingroup Layout
9908     */
9909    EAPI void               elm_layout_box_remove_all(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
9910    /**
9911     * Insert child to layout table part.
9912     *
9913     * @param obj the layout object
9914     * @param part the box part to pack child.
9915     * @param child_obj the child object to pack into table.
9916     * @param col the column to which the child should be added. (>= 0)
9917     * @param row the row to which the child should be added. (>= 0)
9918     * @param colspan how many columns should be used to store this object. (>=
9919     *        1)
9920     * @param rowspan how many rows should be used to store this object. (>= 1)
9921     *
9922     * Once the object is inserted, it will become child of the table. Its
9923     * lifetime will be bound to the layout, and whenever the layout dies the
9924     * child will be deleted automatically. One should use
9925     * elm_layout_table_remove() to make this layout forget about the object.
9926     *
9927     * If @p colspan or @p rowspan are bigger than 1, that object will occupy
9928     * more space than a single cell. For instance, the following code:
9929     * @code
9930     * elm_layout_table_pack(layout, "table_part", child, 0, 1, 3, 1);
9931     * @endcode
9932     *
9933     * Would result in an object being added like the following picture:
9934     *
9935     * @image html layout_colspan.png
9936     * @image latex layout_colspan.eps width=\textwidth
9937     *
9938     * @see elm_layout_table_unpack()
9939     * @see elm_layout_table_clear()
9940     *
9941     * @ingroup Layout
9942     */
9943    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);
9944    /**
9945     * Unpack (remove) a child of the given part table.
9946     *
9947     * @param obj The layout object
9948     * @param part The table part name to remove child.
9949     * @param child_obj The object to remove from table.
9950     * @return The object that was being used, or NULL if not found.
9951     *
9952     * The object will be unpacked from the table part and its lifetime
9953     * will not be handled by the layout anymore. This is equivalent to
9954     * elm_object_content_part_unset() for table.
9955     *
9956     * @see elm_layout_table_pack()
9957     * @see elm_layout_table_clear()
9958     *
9959     * @ingroup Layout
9960     */
9961    EAPI Evas_Object       *elm_layout_table_unpack(Evas_Object *obj, const char *part, Evas_Object *child_obj) EINA_ARG_NONNULL(1, 2, 3);
9962    /**
9963     * Remove all child of the given part table.
9964     *
9965     * @param obj The layout object
9966     * @param part The table part name to remove child.
9967     * @param clear If EINA_TRUE, then all objects will be deleted as
9968     *        well, otherwise they will just be removed and will be
9969     *        dangling on the canvas.
9970     *
9971     * The objects will be removed from the table part and their lifetime will
9972     * not be handled by the layout anymore. This is equivalent to
9973     * elm_layout_table_unpack() for all table children.
9974     *
9975     * @see elm_layout_table_pack()
9976     * @see elm_layout_table_unpack()
9977     *
9978     * @ingroup Layout
9979     */
9980    EAPI void               elm_layout_table_clear(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
9981    /**
9982     * Get the edje layout
9983     *
9984     * @param obj The layout object
9985     *
9986     * @return A Evas_Object with the edje layout settings loaded
9987     * with function elm_layout_file_set
9988     *
9989     * This returns the edje object. It is not expected to be used to then
9990     * swallow objects via edje_object_part_swallow() for example. Use
9991     * elm_object_content_part_set() instead so child object handling and sizing is
9992     * done properly.
9993     *
9994     * @note This function should only be used if you really need to call some
9995     * low level Edje function on this edje object. All the common stuff (setting
9996     * text, emitting signals, hooking callbacks to signals, etc.) can be done
9997     * with proper elementary functions.
9998     *
9999     * @see elm_object_signal_callback_add()
10000     * @see elm_object_signal_emit()
10001     * @see elm_object_text_part_set()
10002     * @see elm_object_content_part_set()
10003     * @see elm_layout_box_append()
10004     * @see elm_layout_table_pack()
10005     * @see elm_layout_data_get()
10006     *
10007     * @ingroup Layout
10008     */
10009    EAPI Evas_Object       *elm_layout_edje_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10010    /**
10011     * Get the edje data from the given layout
10012     *
10013     * @param obj The layout object
10014     * @param key The data key
10015     *
10016     * @return The edje data string
10017     *
10018     * This function fetches data specified inside the edje theme of this layout.
10019     * This function return NULL if data is not found.
10020     *
10021     * In EDC this comes from a data block within the group block that @p
10022     * obj was loaded from. E.g.
10023     *
10024     * @code
10025     * collections {
10026     *   group {
10027     *     name: "a_group";
10028     *     data {
10029     *       item: "key1" "value1";
10030     *       item: "key2" "value2";
10031     *     }
10032     *   }
10033     * }
10034     * @endcode
10035     *
10036     * @ingroup Layout
10037     */
10038    EAPI const char        *elm_layout_data_get(const Evas_Object *obj, const char *key) EINA_ARG_NONNULL(1, 2);
10039    /**
10040     * Eval sizing
10041     *
10042     * @param obj The layout object
10043     *
10044     * Manually forces a sizing re-evaluation. This is useful when the minimum
10045     * size required by the edje theme of this layout has changed. The change on
10046     * the minimum size required by the edje theme is not immediately reported to
10047     * the elementary layout, so one needs to call this function in order to tell
10048     * the widget (layout) that it needs to reevaluate its own size.
10049     *
10050     * The minimum size of the theme is calculated based on minimum size of
10051     * parts, the size of elements inside containers like box and table, etc. All
10052     * of this can change due to state changes, and that's when this function
10053     * should be called.
10054     *
10055     * Also note that a standard signal of "size,eval" "elm" emitted from the
10056     * edje object will cause this to happen too.
10057     *
10058     * @ingroup Layout
10059     */
10060    EAPI void               elm_layout_sizing_eval(Evas_Object *obj) EINA_ARG_NONNULL(1);
10061
10062    /**
10063     * Sets a specific cursor for an edje part.
10064     *
10065     * @param obj The layout object.
10066     * @param part_name a part from loaded edje group.
10067     * @param cursor cursor name to use, see Elementary_Cursor.h
10068     *
10069     * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10070     *         part not exists or it has "mouse_events: 0".
10071     *
10072     * @ingroup Layout
10073     */
10074    EAPI Eina_Bool          elm_layout_part_cursor_set(Evas_Object *obj, const char *part_name, const char *cursor) EINA_ARG_NONNULL(1, 2);
10075
10076    /**
10077     * Get the cursor to be shown when mouse is over an edje part
10078     *
10079     * @param obj The layout object.
10080     * @param part_name a part from loaded edje group.
10081     * @return the cursor name.
10082     *
10083     * @ingroup Layout
10084     */
10085    EAPI const char        *elm_layout_part_cursor_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10086
10087    /**
10088     * Unsets a cursor previously set with elm_layout_part_cursor_set().
10089     *
10090     * @param obj The layout object.
10091     * @param part_name a part from loaded edje group, that had a cursor set
10092     *        with elm_layout_part_cursor_set().
10093     *
10094     * @ingroup Layout
10095     */
10096    EAPI void               elm_layout_part_cursor_unset(Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10097
10098    /**
10099     * Sets a specific cursor style for an edje part.
10100     *
10101     * @param obj The layout object.
10102     * @param part_name a part from loaded edje group.
10103     * @param style the theme style to use (default, transparent, ...)
10104     *
10105     * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10106     *         part not exists or it did not had a cursor set.
10107     *
10108     * @ingroup Layout
10109     */
10110    EAPI Eina_Bool          elm_layout_part_cursor_style_set(Evas_Object *obj, const char *part_name, const char *style) EINA_ARG_NONNULL(1, 2);
10111
10112    /**
10113     * Gets a specific cursor style for an edje part.
10114     *
10115     * @param obj The layout object.
10116     * @param part_name a part from loaded edje group.
10117     *
10118     * @return the theme style in use, defaults to "default". If the
10119     *         object does not have a cursor set, then NULL is returned.
10120     *
10121     * @ingroup Layout
10122     */
10123    EAPI const char        *elm_layout_part_cursor_style_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10124
10125    /**
10126     * Sets if the cursor set should be searched on the theme or should use
10127     * the provided by the engine, only.
10128     *
10129     * @note before you set if should look on theme you should define a
10130     * cursor with elm_layout_part_cursor_set(). By default it will only
10131     * look for cursors provided by the engine.
10132     *
10133     * @param obj The layout object.
10134     * @param part_name a part from loaded edje group.
10135     * @param engine_only if cursors should be just provided by the engine
10136     *        or should also search on widget's theme as well
10137     *
10138     * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10139     *         part not exists or it did not had a cursor set.
10140     *
10141     * @ingroup Layout
10142     */
10143    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);
10144
10145    /**
10146     * Gets a specific cursor engine_only for an edje part.
10147     *
10148     * @param obj The layout object.
10149     * @param part_name a part from loaded edje group.
10150     *
10151     * @return whenever the cursor is just provided by engine or also from theme.
10152     *
10153     * @ingroup Layout
10154     */
10155    EAPI Eina_Bool          elm_layout_part_cursor_engine_only_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10156
10157 /**
10158  * @def elm_layout_icon_set
10159  * Convienience macro to set the icon object in a layout that follows the
10160  * Elementary naming convention for its parts.
10161  *
10162  * @ingroup Layout
10163  */
10164 #define elm_layout_icon_set(_ly, _obj) \
10165   do { \
10166     const char *sig; \
10167     elm_layout_content_set((_ly), "elm.swallow.icon", (_obj)); \
10168     if ((_obj)) sig = "elm,state,icon,visible"; \
10169     else sig = "elm,state,icon,hidden"; \
10170     elm_object_signal_emit((_ly), sig, "elm"); \
10171   } while (0)
10172
10173 /**
10174  * @def elm_layout_icon_get
10175  * Convienience macro to get the icon object from a layout that follows the
10176  * Elementary naming convention for its parts.
10177  *
10178  * @ingroup Layout
10179  */
10180 #define elm_layout_icon_get(_ly) \
10181   elm_layout_content_get((_ly), "elm.swallow.icon")
10182
10183 /**
10184  * @def elm_layout_end_set
10185  * Convienience macro to set the end object in a layout that follows the
10186  * Elementary naming convention for its parts.
10187  *
10188  * @ingroup Layout
10189  */
10190 #define elm_layout_end_set(_ly, _obj) \
10191   do { \
10192     const char *sig; \
10193     elm_layout_content_set((_ly), "elm.swallow.end", (_obj)); \
10194     if ((_obj)) sig = "elm,state,end,visible"; \
10195     else sig = "elm,state,end,hidden"; \
10196     elm_object_signal_emit((_ly), sig, "elm"); \
10197   } while (0)
10198
10199 /**
10200  * @def elm_layout_end_get
10201  * Convienience macro to get the end object in a layout that follows the
10202  * Elementary naming convention for its parts.
10203  *
10204  * @ingroup Layout
10205  */
10206 #define elm_layout_end_get(_ly) \
10207   elm_layout_content_get((_ly), "elm.swallow.end")
10208
10209 /**
10210  * @def elm_layout_label_set
10211  * Convienience macro to set the label in a layout that follows the
10212  * Elementary naming convention for its parts.
10213  *
10214  * @ingroup Layout
10215  * @deprecated use elm_object_text_* instead.
10216  */
10217 #define elm_layout_label_set(_ly, _txt) \
10218   elm_layout_text_set((_ly), "elm.text", (_txt))
10219
10220 /**
10221  * @def elm_layout_label_get
10222  * Convenience macro to get the label in a layout that follows the
10223  * Elementary naming convention for its parts.
10224  *
10225  * @ingroup Layout
10226  * @deprecated use elm_object_text_* instead.
10227  */
10228 #define elm_layout_label_get(_ly) \
10229   elm_layout_text_get((_ly), "elm.text")
10230
10231    /* smart callbacks called:
10232     * "theme,changed" - when elm theme is changed.
10233     */
10234
10235    /**
10236     * @defgroup Notify Notify
10237     *
10238     * @image html img/widget/notify/preview-00.png
10239     * @image latex img/widget/notify/preview-00.eps
10240     *
10241     * Display a container in a particular region of the parent(top, bottom,
10242     * etc).  A timeout can be set to automatically hide the notify. This is so
10243     * that, after an evas_object_show() on a notify object, if a timeout was set
10244     * on it, it will @b automatically get hidden after that time.
10245     *
10246     * Signals that you can add callbacks for are:
10247     * @li "timeout" - when timeout happens on notify and it's hidden
10248     * @li "block,clicked" - when a click outside of the notify happens
10249     *
10250     * Default contents parts of the notify widget that you can use for are:
10251     * @li "elm.swallow.content" - A content of the notify
10252     *
10253     * @ref tutorial_notify show usage of the API.
10254     *
10255     * @{
10256     */
10257    /**
10258     * @brief Possible orient values for notify.
10259     *
10260     * This values should be used in conjunction to elm_notify_orient_set() to
10261     * set the position in which the notify should appear(relative to its parent)
10262     * and in conjunction with elm_notify_orient_get() to know where the notify
10263     * is appearing.
10264     */
10265    typedef enum _Elm_Notify_Orient
10266      {
10267         ELM_NOTIFY_ORIENT_TOP, /**< Notify should appear in the top of parent, default */
10268         ELM_NOTIFY_ORIENT_CENTER, /**< Notify should appear in the center of parent */
10269         ELM_NOTIFY_ORIENT_BOTTOM, /**< Notify should appear in the bottom of parent */
10270         ELM_NOTIFY_ORIENT_LEFT, /**< Notify should appear in the left of parent */
10271         ELM_NOTIFY_ORIENT_RIGHT, /**< Notify should appear in the right of parent */
10272         ELM_NOTIFY_ORIENT_TOP_LEFT, /**< Notify should appear in the top left of parent */
10273         ELM_NOTIFY_ORIENT_TOP_RIGHT, /**< Notify should appear in the top right of parent */
10274         ELM_NOTIFY_ORIENT_BOTTOM_LEFT, /**< Notify should appear in the bottom left of parent */
10275         ELM_NOTIFY_ORIENT_BOTTOM_RIGHT, /**< Notify should appear in the bottom right of parent */
10276         ELM_NOTIFY_ORIENT_LAST /**< Sentinel value, @b don't use */
10277      } Elm_Notify_Orient;
10278    /**
10279     * @brief Add a new notify to the parent
10280     *
10281     * @param parent The parent object
10282     * @return The new object or NULL if it cannot be created
10283     */
10284    EAPI Evas_Object      *elm_notify_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10285    /**
10286     * @brief Set the content of the notify widget
10287     *
10288     * @param obj The notify object
10289     * @param content The content will be filled in this notify object
10290     *
10291     * Once the content object is set, a previously set one will be deleted. If
10292     * you want to keep that old content object, use the
10293     * elm_notify_content_unset() function.
10294     */
10295    EINA_DEPRECATED EAPI void              elm_notify_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
10296    /**
10297     * @brief Unset the content of the notify widget
10298     *
10299     * @param obj The notify object
10300     * @return The content that was being used
10301     *
10302     * Unparent and return the content object which was set for this widget
10303     *
10304     * @see elm_notify_content_set()
10305     */
10306    EINA_DEPRECATED EAPI Evas_Object      *elm_notify_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
10307    /**
10308     * @brief Return the content of the notify widget
10309     *
10310     * @param obj The notify object
10311     * @return The content that is being used
10312     *
10313     * @see elm_notify_content_set()
10314     */
10315    EINA_DEPRECATED EAPI Evas_Object      *elm_notify_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10316    /**
10317     * @brief Set the notify parent
10318     *
10319     * @param obj The notify object
10320     * @param content The new parent
10321     *
10322     * Once the parent object is set, a previously set one will be disconnected
10323     * and replaced.
10324     */
10325    EAPI void              elm_notify_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10326    /**
10327     * @brief Get the notify parent
10328     *
10329     * @param obj The notify object
10330     * @return The parent
10331     *
10332     * @see elm_notify_parent_set()
10333     */
10334    EAPI Evas_Object      *elm_notify_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10335    /**
10336     * @brief Set the orientation
10337     *
10338     * @param obj The notify object
10339     * @param orient The new orientation
10340     *
10341     * Sets the position in which the notify will appear in its parent.
10342     *
10343     * @see @ref Elm_Notify_Orient for possible values.
10344     */
10345    EAPI void              elm_notify_orient_set(Evas_Object *obj, Elm_Notify_Orient orient) EINA_ARG_NONNULL(1);
10346    /**
10347     * @brief Return the orientation
10348     * @param obj The notify object
10349     * @return The orientation of the notification
10350     *
10351     * @see elm_notify_orient_set()
10352     * @see Elm_Notify_Orient
10353     */
10354    EAPI Elm_Notify_Orient elm_notify_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10355    /**
10356     * @brief Set the time interval after which the notify window is going to be
10357     * hidden.
10358     *
10359     * @param obj The notify object
10360     * @param time The timeout in seconds
10361     *
10362     * This function sets a timeout and starts the timer controlling when the
10363     * notify is hidden. Since calling evas_object_show() on a notify restarts
10364     * the timer controlling when the notify is hidden, setting this before the
10365     * notify is shown will in effect mean starting the timer when the notify is
10366     * shown.
10367     *
10368     * @note Set a value <= 0.0 to disable a running timer.
10369     *
10370     * @note If the value > 0.0 and the notify is previously visible, the
10371     * timer will be started with this value, canceling any running timer.
10372     */
10373    EAPI void              elm_notify_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
10374    /**
10375     * @brief Return the timeout value (in seconds)
10376     * @param obj the notify object
10377     *
10378     * @see elm_notify_timeout_set()
10379     */
10380    EAPI double            elm_notify_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10381    /**
10382     * @brief Sets whether events should be passed to by a click outside
10383     * its area.
10384     *
10385     * @param obj The notify object
10386     * @param repeats EINA_TRUE Events are repeats, else no
10387     *
10388     * When true if the user clicks outside the window the events will be caught
10389     * by the others widgets, else the events are blocked.
10390     *
10391     * @note The default value is EINA_TRUE.
10392     */
10393    EAPI void              elm_notify_repeat_events_set(Evas_Object *obj, Eina_Bool repeat) EINA_ARG_NONNULL(1);
10394    /**
10395     * @brief Return true if events are repeat below the notify object
10396     * @param obj the notify object
10397     *
10398     * @see elm_notify_repeat_events_set()
10399     */
10400    EAPI Eina_Bool         elm_notify_repeat_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10401    /**
10402     * @}
10403     */
10404
10405    /**
10406     * @defgroup Hover Hover
10407     *
10408     * @image html img/widget/hover/preview-00.png
10409     * @image latex img/widget/hover/preview-00.eps
10410     *
10411     * A Hover object will hover over its @p parent object at the @p target
10412     * location. Anything in the background will be given a darker coloring to
10413     * indicate that the hover object is on top (at the default theme). When the
10414     * hover is clicked it is dismissed(hidden), if the contents of the hover are
10415     * clicked that @b doesn't cause the hover to be dismissed.
10416     *
10417     * A Hover object has two parents. One parent that owns it during creation
10418     * and the other parent being the one over which the hover object spans.
10419     *
10420     *
10421     * @note The hover object will take up the entire space of @p target
10422     * object.
10423     *
10424     * Elementary has the following styles for the hover widget:
10425     * @li default
10426     * @li popout
10427     * @li menu
10428     * @li hoversel_vertical
10429     *
10430     * The following are the available position for content:
10431     * @li left
10432     * @li top-left
10433     * @li top
10434     * @li top-right
10435     * @li right
10436     * @li bottom-right
10437     * @li bottom
10438     * @li bottom-left
10439     * @li middle
10440     * @li smart
10441     *
10442     * Signals that you can add callbacks for are:
10443     * @li "clicked" - the user clicked the empty space in the hover to dismiss
10444     * @li "smart,changed" - a content object placed under the "smart"
10445     *                   policy was replaced to a new slot direction.
10446     *
10447     * See @ref tutorial_hover for more information.
10448     *
10449     * @{
10450     */
10451    typedef enum _Elm_Hover_Axis
10452      {
10453         ELM_HOVER_AXIS_NONE, /**< ELM_HOVER_AXIS_NONE -- no prefered orientation */
10454         ELM_HOVER_AXIS_HORIZONTAL, /**< ELM_HOVER_AXIS_HORIZONTAL -- horizontal */
10455         ELM_HOVER_AXIS_VERTICAL, /**< ELM_HOVER_AXIS_VERTICAL -- vertical */
10456         ELM_HOVER_AXIS_BOTH /**< ELM_HOVER_AXIS_BOTH -- both */
10457      } Elm_Hover_Axis;
10458    /**
10459     * @brief Adds a hover object to @p parent
10460     *
10461     * @param parent The parent object
10462     * @return The hover object or NULL if one could not be created
10463     */
10464    EAPI Evas_Object *elm_hover_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10465    /**
10466     * @brief Sets the target object for the hover.
10467     *
10468     * @param obj The hover object
10469     * @param target The object to center the hover onto. The hover
10470     *
10471     * This function will cause the hover to be centered on the target object.
10472     */
10473    EAPI void         elm_hover_target_set(Evas_Object *obj, Evas_Object *target) EINA_ARG_NONNULL(1);
10474    /**
10475     * @brief Gets the target object for the hover.
10476     *
10477     * @param obj The hover object
10478     * @param parent The object to locate the hover over.
10479     *
10480     * @see elm_hover_target_set()
10481     */
10482    EAPI Evas_Object *elm_hover_target_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10483    /**
10484     * @brief Sets the parent object for the hover.
10485     *
10486     * @param obj The hover object
10487     * @param parent The object to locate the hover over.
10488     *
10489     * This function will cause the hover to take up the entire space that the
10490     * parent object fills.
10491     */
10492    EAPI void         elm_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10493    /**
10494     * @brief Gets the parent object for the hover.
10495     *
10496     * @param obj The hover object
10497     * @return The parent object to locate the hover over.
10498     *
10499     * @see elm_hover_parent_set()
10500     */
10501    EAPI Evas_Object *elm_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10502    /**
10503     * @brief Sets the content of the hover object and the direction in which it
10504     * will pop out.
10505     *
10506     * @param obj The hover object
10507     * @param swallow The direction that the object will be displayed
10508     * at. Accepted values are "left", "top-left", "top", "top-right",
10509     * "right", "bottom-right", "bottom", "bottom-left", "middle" and
10510     * "smart".
10511     * @param content The content to place at @p swallow
10512     *
10513     * Once the content object is set for a given direction, a previously
10514     * set one (on the same direction) will be deleted. If you want to
10515     * keep that old content object, use the elm_hover_content_unset()
10516     * function.
10517     *
10518     * All directions may have contents at the same time, except for
10519     * "smart". This is a special placement hint and its use case
10520     * independs of the calculations coming from
10521     * elm_hover_best_content_location_get(). Its use is for cases when
10522     * one desires only one hover content, but with a dinamic special
10523     * placement within the hover area. The content's geometry, whenever
10524     * it changes, will be used to decide on a best location not
10525     * extrapolating the hover's parent object view to show it in (still
10526     * being the hover's target determinant of its medium part -- move and
10527     * resize it to simulate finger sizes, for example). If one of the
10528     * directions other than "smart" are used, a previously content set
10529     * using it will be deleted, and vice-versa.
10530     */
10531    EAPI void         elm_hover_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
10532    /**
10533     * @brief Get the content of the hover object, in a given direction.
10534     *
10535     * Return the content object which was set for this widget in the
10536     * @p swallow direction.
10537     *
10538     * @param obj The hover object
10539     * @param swallow The direction that the object was display at.
10540     * @return The content that was being used
10541     *
10542     * @see elm_hover_content_set()
10543     */
10544    EAPI Evas_Object *elm_hover_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10545    /**
10546     * @brief Unset the content of the hover object, in a given direction.
10547     *
10548     * Unparent and return the content object set at @p swallow direction.
10549     *
10550     * @param obj The hover object
10551     * @param swallow The direction that the object was display at.
10552     * @return The content that was being used.
10553     *
10554     * @see elm_hover_content_set()
10555     */
10556    EAPI Evas_Object *elm_hover_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10557    /**
10558     * @brief Returns the best swallow location for content in the hover.
10559     *
10560     * @param obj The hover object
10561     * @param pref_axis The preferred orientation axis for the hover object to use
10562     * @return The edje location to place content into the hover or @c
10563     *         NULL, on errors.
10564     *
10565     * Best is defined here as the location at which there is the most available
10566     * space.
10567     *
10568     * @p pref_axis may be one of
10569     * - @c ELM_HOVER_AXIS_NONE -- no prefered orientation
10570     * - @c ELM_HOVER_AXIS_HORIZONTAL -- horizontal
10571     * - @c ELM_HOVER_AXIS_VERTICAL -- vertical
10572     * - @c ELM_HOVER_AXIS_BOTH -- both
10573     *
10574     * If ELM_HOVER_AXIS_HORIZONTAL is choosen the returned position will
10575     * nescessarily be along the horizontal axis("left" or "right"). If
10576     * ELM_HOVER_AXIS_VERTICAL is choosen the returned position will nescessarily
10577     * be along the vertical axis("top" or "bottom"). Chossing
10578     * ELM_HOVER_AXIS_BOTH or ELM_HOVER_AXIS_NONE has the same effect and the
10579     * returned position may be in either axis.
10580     *
10581     * @see elm_hover_content_set()
10582     */
10583    EAPI const char  *elm_hover_best_content_location_get(const Evas_Object *obj, Elm_Hover_Axis pref_axis) EINA_ARG_NONNULL(1);
10584    /**
10585     * @}
10586     */
10587
10588    /* entry */
10589    /**
10590     * @defgroup Entry Entry
10591     *
10592     * @image html img/widget/entry/preview-00.png
10593     * @image latex img/widget/entry/preview-00.eps width=\textwidth
10594     * @image html img/widget/entry/preview-01.png
10595     * @image latex img/widget/entry/preview-01.eps width=\textwidth
10596     * @image html img/widget/entry/preview-02.png
10597     * @image latex img/widget/entry/preview-02.eps width=\textwidth
10598     * @image html img/widget/entry/preview-03.png
10599     * @image latex img/widget/entry/preview-03.eps width=\textwidth
10600     *
10601     * An entry is a convenience widget which shows a box that the user can
10602     * enter text into. Entries by default don't scroll, so they grow to
10603     * accomodate the entire text, resizing the parent window as needed. This
10604     * can be changed with the elm_entry_scrollable_set() function.
10605     *
10606     * They can also be single line or multi line (the default) and when set
10607     * to multi line mode they support text wrapping in any of the modes
10608     * indicated by #Elm_Wrap_Type.
10609     *
10610     * Other features include password mode, filtering of inserted text with
10611     * elm_entry_text_filter_append() and related functions, inline "items" and
10612     * formatted markup text.
10613     *
10614     * @section entry-markup Formatted text
10615     *
10616     * The markup tags supported by the Entry are defined by the theme, but
10617     * even when writing new themes or extensions it's a good idea to stick to
10618     * a sane default, to maintain coherency and avoid application breakages.
10619     * Currently defined by the default theme are the following tags:
10620     * @li \<br\>: Inserts a line break.
10621     * @li \<ps\>: Inserts a paragraph separator. This is preferred over line
10622     * breaks.
10623     * @li \<tab\>: Inserts a tab.
10624     * @li \<em\>...\</em\>: Emphasis. Sets the @em oblique style for the
10625     * enclosed text.
10626     * @li \<b\>...\</b\>: Sets the @b bold style for the enclosed text.
10627     * @li \<link\>...\</link\>: Underlines the enclosed text.
10628     * @li \<hilight\>...\</hilight\>: Hilights the enclosed text.
10629     *
10630     * @section entry-special Special markups
10631     *
10632     * Besides those used to format text, entries support two special markup
10633     * tags used to insert clickable portions of text or items inlined within
10634     * the text.
10635     *
10636     * @subsection entry-anchors Anchors
10637     *
10638     * Anchors are similar to HTML anchors. Text can be surrounded by \<a\> and
10639     * \</a\> tags and an event will be generated when this text is clicked,
10640     * like this:
10641     *
10642     * @code
10643     * This text is outside <a href=anc-01>but this one is an anchor</a>
10644     * @endcode
10645     *
10646     * The @c href attribute in the opening tag gives the name that will be
10647     * used to identify the anchor and it can be any valid utf8 string.
10648     *
10649     * When an anchor is clicked, an @c "anchor,clicked" signal is emitted with
10650     * an #Elm_Entry_Anchor_Info in the @c event_info parameter for the
10651     * callback function. The same applies for "anchor,in" (mouse in), "anchor,out"
10652     * (mouse out), "anchor,down" (mouse down), and "anchor,up" (mouse up) events on
10653     * an anchor.
10654     *
10655     * @subsection entry-items Items
10656     *
10657     * Inlined in the text, any other @c Evas_Object can be inserted by using
10658     * \<item\> tags this way:
10659     *
10660     * @code
10661     * <item size=16x16 vsize=full href=emoticon/haha></item>
10662     * @endcode
10663     *
10664     * Just like with anchors, the @c href identifies each item, but these need,
10665     * in addition, to indicate their size, which is done using any one of
10666     * @c size, @c absize or @c relsize attributes. These attributes take their
10667     * value in the WxH format, where W is the width and H the height of the
10668     * item.
10669     *
10670     * @li absize: Absolute pixel size for the item. Whatever value is set will
10671     * be the item's size regardless of any scale value the object may have
10672     * been set to. The final line height will be adjusted to fit larger items.
10673     * @li size: Similar to @c absize, but it's adjusted to the scale value set
10674     * for the object.
10675     * @li relsize: Size is adjusted for the item to fit within the current
10676     * line height.
10677     *
10678     * Besides their size, items are specificed a @c vsize value that affects
10679     * how their final size and position are calculated. The possible values
10680     * are:
10681     * @li ascent: Item will be placed within the line's baseline and its
10682     * ascent. That is, the height between the line where all characters are
10683     * positioned and the highest point in the line. For @c size and @c absize
10684     * items, the descent value will be added to the total line height to make
10685     * them fit. @c relsize items will be adjusted to fit within this space.
10686     * @li full: Items will be placed between the descent and ascent, or the
10687     * lowest point in the line and its highest.
10688     *
10689     * The next image shows different configurations of items and how they
10690     * are the previously mentioned options affect their sizes. In all cases,
10691     * the green line indicates the ascent, blue for the baseline and red for
10692     * the descent.
10693     *
10694     * @image html entry_item.png
10695     * @image latex entry_item.eps width=\textwidth
10696     *
10697     * And another one to show how size differs from absize. In the first one,
10698     * the scale value is set to 1.0, while the second one is using one of 2.0.
10699     *
10700     * @image html entry_item_scale.png
10701     * @image latex entry_item_scale.eps width=\textwidth
10702     *
10703     * After the size for an item is calculated, the entry will request an
10704     * object to place in its space. For this, the functions set with
10705     * elm_entry_item_provider_append() and related functions will be called
10706     * in order until one of them returns a @c non-NULL value. If no providers
10707     * are available, or all of them return @c NULL, then the entry falls back
10708     * to one of the internal defaults, provided the name matches with one of
10709     * them.
10710     *
10711     * All of the following are currently supported:
10712     *
10713     * - emoticon/angry
10714     * - emoticon/angry-shout
10715     * - emoticon/crazy-laugh
10716     * - emoticon/evil-laugh
10717     * - emoticon/evil
10718     * - emoticon/goggle-smile
10719     * - emoticon/grumpy
10720     * - emoticon/grumpy-smile
10721     * - emoticon/guilty
10722     * - emoticon/guilty-smile
10723     * - emoticon/haha
10724     * - emoticon/half-smile
10725     * - emoticon/happy-panting
10726     * - emoticon/happy
10727     * - emoticon/indifferent
10728     * - emoticon/kiss
10729     * - emoticon/knowing-grin
10730     * - emoticon/laugh
10731     * - emoticon/little-bit-sorry
10732     * - emoticon/love-lots
10733     * - emoticon/love
10734     * - emoticon/minimal-smile
10735     * - emoticon/not-happy
10736     * - emoticon/not-impressed
10737     * - emoticon/omg
10738     * - emoticon/opensmile
10739     * - emoticon/smile
10740     * - emoticon/sorry
10741     * - emoticon/squint-laugh
10742     * - emoticon/surprised
10743     * - emoticon/suspicious
10744     * - emoticon/tongue-dangling
10745     * - emoticon/tongue-poke
10746     * - emoticon/uh
10747     * - emoticon/unhappy
10748     * - emoticon/very-sorry
10749     * - emoticon/what
10750     * - emoticon/wink
10751     * - emoticon/worried
10752     * - emoticon/wtf
10753     *
10754     * Alternatively, an item may reference an image by its path, using
10755     * the URI form @c file:///path/to/an/image.png and the entry will then
10756     * use that image for the item.
10757     *
10758     * @section entry-files Loading and saving files
10759     *
10760     * Entries have convinience functions to load text from a file and save
10761     * changes back to it after a short delay. The automatic saving is enabled
10762     * by default, but can be disabled with elm_entry_autosave_set() and files
10763     * can be loaded directly as plain text or have any markup in them
10764     * recognized. See elm_entry_file_set() for more details.
10765     *
10766     * @section entry-signals Emitted signals
10767     *
10768     * This widget emits the following signals:
10769     *
10770     * @li "changed": The text within the entry was changed.
10771     * @li "changed,user": The text within the entry was changed because of user interaction.
10772     * @li "activated": The enter key was pressed on a single line entry.
10773     * @li "press": A mouse button has been pressed on the entry.
10774     * @li "longpressed": A mouse button has been pressed and held for a couple
10775     * seconds.
10776     * @li "clicked": The entry has been clicked (mouse press and release).
10777     * @li "clicked,double": The entry has been double clicked.
10778     * @li "clicked,triple": The entry has been triple clicked.
10779     * @li "focused": The entry has received focus.
10780     * @li "unfocused": The entry has lost focus.
10781     * @li "selection,paste": A paste of the clipboard contents was requested.
10782     * @li "selection,copy": A copy of the selected text into the clipboard was
10783     * requested.
10784     * @li "selection,cut": A cut of the selected text into the clipboard was
10785     * requested.
10786     * @li "selection,start": A selection has begun and no previous selection
10787     * existed.
10788     * @li "selection,changed": The current selection has changed.
10789     * @li "selection,cleared": The current selection has been cleared.
10790     * @li "cursor,changed": The cursor has changed position.
10791     * @li "anchor,clicked": An anchor has been clicked. The event_info
10792     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10793     * @li "anchor,in": Mouse cursor has moved into an anchor. The event_info
10794     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10795     * @li "anchor,out": Mouse cursor has moved out of an anchor. The event_info
10796     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10797     * @li "anchor,up": Mouse button has been unpressed on an anchor. The event_info
10798     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10799     * @li "anchor,down": Mouse button has been pressed on an anchor. The event_info
10800     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10801     * @li "preedit,changed": The preedit string has changed.
10802     * @li "language,changed": Program language changed.
10803     *
10804     * @section entry-examples
10805     *
10806     * An overview of the Entry API can be seen in @ref entry_example_01
10807     *
10808     * @{
10809     */
10810    /**
10811     * @typedef Elm_Entry_Anchor_Info
10812     *
10813     * The info sent in the callback for the "anchor,clicked" signals emitted
10814     * by entries.
10815     */
10816    typedef struct _Elm_Entry_Anchor_Info Elm_Entry_Anchor_Info;
10817    /**
10818     * @struct _Elm_Entry_Anchor_Info
10819     *
10820     * The info sent in the callback for the "anchor,clicked" signals emitted
10821     * by entries.
10822     */
10823    struct _Elm_Entry_Anchor_Info
10824      {
10825         const char *name; /**< The name of the anchor, as stated in its href */
10826         int         button; /**< The mouse button used to click on it */
10827         Evas_Coord  x, /**< Anchor geometry, relative to canvas */
10828                     y, /**< Anchor geometry, relative to canvas */
10829                     w, /**< Anchor geometry, relative to canvas */
10830                     h; /**< Anchor geometry, relative to canvas */
10831      };
10832    /**
10833     * @typedef Elm_Entry_Filter_Cb
10834     * This callback type is used by entry filters to modify text.
10835     * @param data The data specified as the last param when adding the filter
10836     * @param entry The entry object
10837     * @param text A pointer to the location of the text being filtered. This data can be modified,
10838     * but any additional allocations must be managed by the user.
10839     * @see elm_entry_text_filter_append
10840     * @see elm_entry_text_filter_prepend
10841     */
10842    typedef void (*Elm_Entry_Filter_Cb)(void *data, Evas_Object *entry, char **text);
10843
10844    /**
10845     * This adds an entry to @p parent object.
10846     *
10847     * By default, entries are:
10848     * @li not scrolled
10849     * @li multi-line
10850     * @li word wrapped
10851     * @li autosave is enabled
10852     *
10853     * @param parent The parent object
10854     * @return The new object or NULL if it cannot be created
10855     */
10856    EAPI Evas_Object *elm_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10857    /**
10858     * Sets the entry to single line mode.
10859     *
10860     * In single line mode, entries don't ever wrap when the text reaches the
10861     * edge, and instead they keep growing horizontally. Pressing the @c Enter
10862     * key will generate an @c "activate" event instead of adding a new line.
10863     *
10864     * When @p single_line is @c EINA_FALSE, line wrapping takes effect again
10865     * and pressing enter will break the text into a different line
10866     * without generating any events.
10867     *
10868     * @param obj The entry object
10869     * @param single_line If true, the text in the entry
10870     * will be on a single line.
10871     */
10872    EAPI void         elm_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
10873    /**
10874     * Gets whether the entry is set to be single line.
10875     *
10876     * @param obj The entry object
10877     * @return single_line If true, the text in the entry is set to display
10878     * on a single line.
10879     *
10880     * @see elm_entry_single_line_set()
10881     */
10882    EAPI Eina_Bool    elm_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10883    /**
10884     * Sets the entry to password mode.
10885     *
10886     * In password mode, entries are implicitly single line and the display of
10887     * any text in them is replaced with asterisks (*).
10888     *
10889     * @param obj The entry object
10890     * @param password If true, password mode is enabled.
10891     */
10892    EAPI void         elm_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
10893    /**
10894     * Gets whether the entry is set to password mode.
10895     *
10896     * @param obj The entry object
10897     * @return If true, the entry is set to display all characters
10898     * as asterisks (*).
10899     *
10900     * @see elm_entry_password_set()
10901     */
10902    EAPI Eina_Bool    elm_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10903    /**
10904     * This sets the text displayed within the entry to @p entry.
10905     *
10906     * @param obj The entry object
10907     * @param entry The text to be displayed
10908     *
10909     * @deprecated Use elm_object_text_set() instead.
10910     * @note Using this function bypasses text filters
10911     */
10912    EAPI void         elm_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
10913    /**
10914     * This returns the text currently shown in object @p entry.
10915     * See also elm_entry_entry_set().
10916     *
10917     * @param obj The entry object
10918     * @return The currently displayed text or NULL on failure
10919     *
10920     * @deprecated Use elm_object_text_get() instead.
10921     */
10922    EAPI const char  *elm_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10923    /**
10924     * Appends @p entry to the text of the entry.
10925     *
10926     * Adds the text in @p entry to the end of any text already present in the
10927     * widget.
10928     *
10929     * The appended text is subject to any filters set for the widget.
10930     *
10931     * @param obj The entry object
10932     * @param entry The text to be displayed
10933     *
10934     * @see elm_entry_text_filter_append()
10935     */
10936    EAPI void         elm_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
10937    /**
10938     * Gets whether the entry is empty.
10939     *
10940     * Empty means no text at all. If there are any markup tags, like an item
10941     * tag for which no provider finds anything, and no text is displayed, this
10942     * function still returns EINA_FALSE.
10943     *
10944     * @param obj The entry object
10945     * @return EINA_TRUE if the entry is empty, EINA_FALSE otherwise.
10946     */
10947    EAPI Eina_Bool    elm_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10948    /**
10949     * Gets any selected text within the entry.
10950     *
10951     * If there's any selected text in the entry, this function returns it as
10952     * a string in markup format. NULL is returned if no selection exists or
10953     * if an error occurred.
10954     *
10955     * The returned value points to an internal string and should not be freed
10956     * or modified in any way. If the @p entry object is deleted or its
10957     * contents are changed, the returned pointer should be considered invalid.
10958     *
10959     * @param obj The entry object
10960     * @return The selected text within the entry or NULL on failure
10961     */
10962    EAPI const char  *elm_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10963    /**
10964     * Inserts the given text into the entry at the current cursor position.
10965     *
10966     * This inserts text at the cursor position as if it was typed
10967     * by the user (note that this also allows markup which a user
10968     * can't just "type" as it would be converted to escaped text, so this
10969     * call can be used to insert things like emoticon items or bold push/pop
10970     * tags, other font and color change tags etc.)
10971     *
10972     * If any selection exists, it will be replaced by the inserted text.
10973     *
10974     * The inserted text is subject to any filters set for the widget.
10975     *
10976     * @param obj The entry object
10977     * @param entry The text to insert
10978     *
10979     * @see elm_entry_text_filter_append()
10980     */
10981    EAPI void         elm_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
10982    /**
10983     * Set the line wrap type to use on multi-line entries.
10984     *
10985     * Sets the wrap type used by the entry to any of the specified in
10986     * #Elm_Wrap_Type. This tells how the text will be implicitly cut into a new
10987     * line (without inserting a line break or paragraph separator) when it
10988     * reaches the far edge of the widget.
10989     *
10990     * Note that this only makes sense for multi-line entries. A widget set
10991     * to be single line will never wrap.
10992     *
10993     * @param obj The entry object
10994     * @param wrap The wrap mode to use. See #Elm_Wrap_Type for details on them
10995     */
10996    EAPI void         elm_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
10997    EINA_DEPRECATED EAPI void         elm_entry_line_char_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
10998    /**
10999     * Gets the wrap mode the entry was set to use.
11000     *
11001     * @param obj The entry object
11002     * @return Wrap type
11003     *
11004     * @see also elm_entry_line_wrap_set()
11005     */
11006    EAPI Elm_Wrap_Type elm_entry_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11007    /**
11008     * Sets if the entry is to be editable or not.
11009     *
11010     * By default, entries are editable and when focused, any text input by the
11011     * user will be inserted at the current cursor position. But calling this
11012     * function with @p editable as EINA_FALSE will prevent the user from
11013     * inputting text into the entry.
11014     *
11015     * The only way to change the text of a non-editable entry is to use
11016     * elm_object_text_set(), elm_entry_entry_insert() and other related
11017     * functions.
11018     *
11019     * @param obj The entry object
11020     * @param editable If EINA_TRUE, user input will be inserted in the entry,
11021     * if not, the entry is read-only and no user input is allowed.
11022     */
11023    EAPI void         elm_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
11024    /**
11025     * Gets whether the entry is editable or not.
11026     *
11027     * @param obj The entry object
11028     * @return If true, the entry is editable by the user.
11029     * If false, it is not editable by the user
11030     *
11031     * @see elm_entry_editable_set()
11032     */
11033    EAPI Eina_Bool    elm_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11034    /**
11035     * This drops any existing text selection within the entry.
11036     *
11037     * @param obj The entry object
11038     */
11039    EAPI void         elm_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
11040    /**
11041     * This selects all text within the entry.
11042     *
11043     * @param obj The entry object
11044     */
11045    EAPI void         elm_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
11046    /**
11047     * This moves the cursor one place to the right within the entry.
11048     *
11049     * @param obj The entry object
11050     * @return EINA_TRUE upon success, EINA_FALSE upon failure
11051     */
11052    EAPI Eina_Bool    elm_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
11053    /**
11054     * This moves the cursor one place to the left within the entry.
11055     *
11056     * @param obj The entry object
11057     * @return EINA_TRUE upon success, EINA_FALSE upon failure
11058     */
11059    EAPI Eina_Bool    elm_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
11060    /**
11061     * This moves the cursor one line up within the entry.
11062     *
11063     * @param obj The entry object
11064     * @return EINA_TRUE upon success, EINA_FALSE upon failure
11065     */
11066    EAPI Eina_Bool    elm_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
11067    /**
11068     * This moves the cursor one line down within the entry.
11069     *
11070     * @param obj The entry object
11071     * @return EINA_TRUE upon success, EINA_FALSE upon failure
11072     */
11073    EAPI Eina_Bool    elm_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
11074    /**
11075     * This moves the cursor to the beginning of the entry.
11076     *
11077     * @param obj The entry object
11078     */
11079    EAPI void         elm_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11080    /**
11081     * This moves the cursor to the end of the entry.
11082     *
11083     * @param obj The entry object
11084     */
11085    EAPI void         elm_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11086    /**
11087     * This moves the cursor to the beginning of the current line.
11088     *
11089     * @param obj The entry object
11090     */
11091    EAPI void         elm_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11092    /**
11093     * This moves the cursor to the end of the current line.
11094     *
11095     * @param obj The entry object
11096     */
11097    EAPI void         elm_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11098    /**
11099     * This begins a selection within the entry as though
11100     * the user were holding down the mouse button to make a selection.
11101     *
11102     * @param obj The entry object
11103     */
11104    EAPI void         elm_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
11105    /**
11106     * This ends a selection within the entry as though
11107     * the user had just released the mouse button while making a selection.
11108     *
11109     * @param obj The entry object
11110     */
11111    EAPI void         elm_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
11112    /**
11113     * Gets whether a format node exists at the current cursor position.
11114     *
11115     * A format node is anything that defines how the text is rendered. It can
11116     * be a visible format node, such as a line break or a paragraph separator,
11117     * or an invisible one, such as bold begin or end tag.
11118     * This function returns whether any format node exists at the current
11119     * cursor position.
11120     *
11121     * @param obj The entry object
11122     * @return EINA_TRUE if the current cursor position contains a format node,
11123     * EINA_FALSE otherwise.
11124     *
11125     * @see elm_entry_cursor_is_visible_format_get()
11126     */
11127    EAPI Eina_Bool    elm_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11128    /**
11129     * Gets if the current cursor position holds a visible format node.
11130     *
11131     * @param obj The entry object
11132     * @return EINA_TRUE if the current cursor is a visible format, EINA_FALSE
11133     * if it's an invisible one or no format exists.
11134     *
11135     * @see elm_entry_cursor_is_format_get()
11136     */
11137    EAPI Eina_Bool    elm_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11138    /**
11139     * Gets the character pointed by the cursor at its current position.
11140     *
11141     * This function returns a string with the utf8 character stored at the
11142     * current cursor position.
11143     * Only the text is returned, any format that may exist will not be part
11144     * of the return value.
11145     *
11146     * @param obj The entry object
11147     * @return The text pointed by the cursors.
11148     */
11149    EAPI const char  *elm_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11150    /**
11151     * This function returns the geometry of the cursor.
11152     *
11153     * It's useful if you want to draw something on the cursor (or where it is),
11154     * or for example in the case of scrolled entry where you want to show the
11155     * cursor.
11156     *
11157     * @param obj The entry object
11158     * @param x returned geometry
11159     * @param y returned geometry
11160     * @param w returned geometry
11161     * @param h returned geometry
11162     * @return EINA_TRUE upon success, EINA_FALSE upon failure
11163     */
11164    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);
11165    /**
11166     * Sets the cursor position in the entry to the given value
11167     *
11168     * The value in @p pos is the index of the character position within the
11169     * contents of the string as returned by elm_entry_cursor_pos_get().
11170     *
11171     * @param obj The entry object
11172     * @param pos The position of the cursor
11173     */
11174    EAPI void         elm_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
11175    /**
11176     * Retrieves the current position of the cursor in the entry
11177     *
11178     * @param obj The entry object
11179     * @return The cursor position
11180     */
11181    EAPI int          elm_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11182    /**
11183     * This executes a "cut" action on the selected text in the entry.
11184     *
11185     * @param obj The entry object
11186     */
11187    EAPI void         elm_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
11188    /**
11189     * This executes a "copy" action on the selected text in the entry.
11190     *
11191     * @param obj The entry object
11192     */
11193    EAPI void         elm_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
11194    /**
11195     * This executes a "paste" action in the entry.
11196     *
11197     * @param obj The entry object
11198     */
11199    EAPI void         elm_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
11200    /**
11201     * This clears and frees the items in a entry's contextual (longpress)
11202     * menu.
11203     *
11204     * @param obj The entry object
11205     *
11206     * @see elm_entry_context_menu_item_add()
11207     */
11208    EAPI void         elm_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
11209    /**
11210     * This adds an item to the entry's contextual menu.
11211     *
11212     * A longpress on an entry will make the contextual menu show up, if this
11213     * hasn't been disabled with elm_entry_context_menu_disabled_set().
11214     * By default, this menu provides a few options like enabling selection mode,
11215     * which is useful on embedded devices that need to be explicit about it,
11216     * and when a selection exists it also shows the copy and cut actions.
11217     *
11218     * With this function, developers can add other options to this menu to
11219     * perform any action they deem necessary.
11220     *
11221     * @param obj The entry object
11222     * @param label The item's text label
11223     * @param icon_file The item's icon file
11224     * @param icon_type The item's icon type
11225     * @param func The callback to execute when the item is clicked
11226     * @param data The data to associate with the item for related functions
11227     */
11228    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);
11229    /**
11230     * This disables the entry's contextual (longpress) menu.
11231     *
11232     * @param obj The entry object
11233     * @param disabled If true, the menu is disabled
11234     */
11235    EAPI void         elm_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
11236    /**
11237     * This returns whether the entry's contextual (longpress) menu is
11238     * disabled.
11239     *
11240     * @param obj The entry object
11241     * @return If true, the menu is disabled
11242     */
11243    EAPI Eina_Bool    elm_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11244    /**
11245     * This appends a custom item provider to the list for that entry
11246     *
11247     * This appends the given callback. The list is walked from beginning to end
11248     * with each function called given the item href string in the text. If the
11249     * function returns an object handle other than NULL (it should create an
11250     * object to do this), then this object is used to replace that item. If
11251     * not the next provider is called until one provides an item object, or the
11252     * default provider in entry does.
11253     *
11254     * @param obj The entry object
11255     * @param func The function called to provide the item object
11256     * @param data The data passed to @p func
11257     *
11258     * @see @ref entry-items
11259     */
11260    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);
11261    /**
11262     * This prepends a custom item provider to the list for that entry
11263     *
11264     * This prepends the given callback. See elm_entry_item_provider_append() for
11265     * more information
11266     *
11267     * @param obj The entry object
11268     * @param func The function called to provide the item object
11269     * @param data The data passed to @p func
11270     */
11271    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);
11272    /**
11273     * This removes a custom item provider to the list for that entry
11274     *
11275     * This removes the given callback. See elm_entry_item_provider_append() for
11276     * more information
11277     *
11278     * @param obj The entry object
11279     * @param func The function called to provide the item object
11280     * @param data The data passed to @p func
11281     */
11282    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);
11283    /**
11284     * Append a filter function for text inserted in the entry
11285     *
11286     * Append the given callback to the list. This functions will be called
11287     * whenever any text is inserted into the entry, with the text to be inserted
11288     * as a parameter. The callback function is free to alter the text in any way
11289     * it wants, but it must remember to free the given pointer and update it.
11290     * If the new text is to be discarded, the function can free it and set its
11291     * text parameter to NULL. This will also prevent any following filters from
11292     * being called.
11293     *
11294     * @param obj The entry object
11295     * @param func The function to use as text filter
11296     * @param data User data to pass to @p func
11297     */
11298    EAPI void         elm_entry_text_filter_append(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11299    /**
11300     * Prepend a filter function for text insdrted in the entry
11301     *
11302     * Prepend the given callback to the list. See elm_entry_text_filter_append()
11303     * for more information
11304     *
11305     * @param obj The entry object
11306     * @param func The function to use as text filter
11307     * @param data User data to pass to @p func
11308     */
11309    EAPI void         elm_entry_text_filter_prepend(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11310    /**
11311     * Remove a filter from the list
11312     *
11313     * Removes the given callback from the filter list. See
11314     * elm_entry_text_filter_append() for more information.
11315     *
11316     * @param obj The entry object
11317     * @param func The filter function to remove
11318     * @param data The user data passed when adding the function
11319     */
11320    EAPI void         elm_entry_text_filter_remove(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11321    /**
11322     * This converts a markup (HTML-like) string into UTF-8.
11323     *
11324     * The returned string is a malloc'ed buffer and it should be freed when
11325     * not needed anymore.
11326     *
11327     * @param s The string (in markup) to be converted
11328     * @return The converted string (in UTF-8). It should be freed.
11329     */
11330    EAPI char        *elm_entry_markup_to_utf8(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
11331    /**
11332     * This converts a UTF-8 string into markup (HTML-like).
11333     *
11334     * The returned string is a malloc'ed buffer and it should be freed when
11335     * not needed anymore.
11336     *
11337     * @param s The string (in UTF-8) to be converted
11338     * @return The converted string (in markup). It should be freed.
11339     */
11340    EAPI char        *elm_entry_utf8_to_markup(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
11341    /**
11342     * This sets the file (and implicitly loads it) for the text to display and
11343     * then edit. All changes are written back to the file after a short delay if
11344     * the entry object is set to autosave (which is the default).
11345     *
11346     * If the entry had any other file set previously, any changes made to it
11347     * will be saved if the autosave feature is enabled, otherwise, the file
11348     * will be silently discarded and any non-saved changes will be lost.
11349     *
11350     * @param obj The entry object
11351     * @param file The path to the file to load and save
11352     * @param format The file format
11353     */
11354    EAPI void         elm_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
11355    /**
11356     * Gets the file being edited by the entry.
11357     *
11358     * This function can be used to retrieve any file set on the entry for
11359     * edition, along with the format used to load and save it.
11360     *
11361     * @param obj The entry object
11362     * @param file The path to the file to load and save
11363     * @param format The file format
11364     */
11365    EAPI void         elm_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
11366    /**
11367     * This function writes any changes made to the file set with
11368     * elm_entry_file_set()
11369     *
11370     * @param obj The entry object
11371     */
11372    EAPI void         elm_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
11373    /**
11374     * This sets the entry object to 'autosave' the loaded text file or not.
11375     *
11376     * @param obj The entry object
11377     * @param autosave Autosave the loaded file or not
11378     *
11379     * @see elm_entry_file_set()
11380     */
11381    EAPI void         elm_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
11382    /**
11383     * This gets the entry object's 'autosave' status.
11384     *
11385     * @param obj The entry object
11386     * @return Autosave the loaded file or not
11387     *
11388     * @see elm_entry_file_set()
11389     */
11390    EAPI Eina_Bool    elm_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11391    /**
11392     * Control pasting of text and images for the widget.
11393     *
11394     * Normally the entry allows both text and images to be pasted.  By setting
11395     * textonly to be true, this prevents images from being pasted.
11396     *
11397     * Note this only changes the behaviour of text.
11398     *
11399     * @param obj The entry object
11400     * @param textonly paste mode - EINA_TRUE is text only, EINA_FALSE is
11401     * text+image+other.
11402     */
11403    EAPI void         elm_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
11404    /**
11405     * Getting elm_entry text paste/drop mode.
11406     *
11407     * In textonly mode, only text may be pasted or dropped into the widget.
11408     *
11409     * @param obj The entry object
11410     * @return If the widget only accepts text from pastes.
11411     */
11412    EAPI Eina_Bool    elm_entry_cnp_textonly_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11413    /**
11414     * Enable or disable scrolling in entry
11415     *
11416     * Normally the entry is not scrollable unless you enable it with this call.
11417     *
11418     * @param obj The entry object
11419     * @param scroll EINA_TRUE if it is to be scrollable, EINA_FALSE otherwise
11420     */
11421    EAPI void         elm_entry_scrollable_set(Evas_Object *obj, Eina_Bool scroll);
11422    /**
11423     * Get the scrollable state of the entry
11424     *
11425     * Normally the entry is not scrollable. This gets the scrollable state
11426     * of the entry. See elm_entry_scrollable_set() for more information.
11427     *
11428     * @param obj The entry object
11429     * @return The scrollable state
11430     */
11431    EAPI Eina_Bool    elm_entry_scrollable_get(const Evas_Object *obj);
11432    /**
11433     * This sets a widget to be displayed to the left of a scrolled entry.
11434     *
11435     * @param obj The scrolled entry object
11436     * @param icon The widget to display on the left side of the scrolled
11437     * entry.
11438     *
11439     * @note A previously set widget will be destroyed.
11440     * @note If the object being set does not have minimum size hints set,
11441     * it won't get properly displayed.
11442     *
11443     * @see elm_entry_end_set()
11444     */
11445    EAPI void         elm_entry_icon_set(Evas_Object *obj, Evas_Object *icon);
11446    /**
11447     * Gets the leftmost widget of the scrolled entry. This object is
11448     * owned by the scrolled entry and should not be modified.
11449     *
11450     * @param obj The scrolled entry object
11451     * @return the left widget inside the scroller
11452     */
11453    EAPI Evas_Object *elm_entry_icon_get(const Evas_Object *obj);
11454    /**
11455     * Unset the leftmost widget of the scrolled entry, unparenting and
11456     * returning it.
11457     *
11458     * @param obj The scrolled entry object
11459     * @return the previously set icon sub-object of this entry, on
11460     * success.
11461     *
11462     * @see elm_entry_icon_set()
11463     */
11464    EAPI Evas_Object *elm_entry_icon_unset(Evas_Object *obj);
11465    /**
11466     * Sets the visibility of the left-side widget of the scrolled entry,
11467     * set by elm_entry_icon_set().
11468     *
11469     * @param obj The scrolled entry object
11470     * @param setting EINA_TRUE if the object should be displayed,
11471     * EINA_FALSE if not.
11472     */
11473    EAPI void         elm_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting);
11474    /**
11475     * This sets a widget to be displayed to the end of a scrolled entry.
11476     *
11477     * @param obj The scrolled entry object
11478     * @param end The widget to display on the right side of the scrolled
11479     * entry.
11480     *
11481     * @note A previously set widget will be destroyed.
11482     * @note If the object being set does not have minimum size hints set,
11483     * it won't get properly displayed.
11484     *
11485     * @see elm_entry_icon_set
11486     */
11487    EAPI void         elm_entry_end_set(Evas_Object *obj, Evas_Object *end);
11488    /**
11489     * Gets the endmost widget of the scrolled entry. This object is owned
11490     * by the scrolled entry and should not be modified.
11491     *
11492     * @param obj The scrolled entry object
11493     * @return the right widget inside the scroller
11494     */
11495    EAPI Evas_Object *elm_entry_end_get(const Evas_Object *obj);
11496    /**
11497     * Unset the endmost widget of the scrolled entry, unparenting and
11498     * returning it.
11499     *
11500     * @param obj The scrolled entry object
11501     * @return the previously set icon sub-object of this entry, on
11502     * success.
11503     *
11504     * @see elm_entry_icon_set()
11505     */
11506    EAPI Evas_Object *elm_entry_end_unset(Evas_Object *obj);
11507    /**
11508     * Sets the visibility of the end widget of the scrolled entry, set by
11509     * elm_entry_end_set().
11510     *
11511     * @param obj The scrolled entry object
11512     * @param setting EINA_TRUE if the object should be displayed,
11513     * EINA_FALSE if not.
11514     */
11515    EAPI void         elm_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting);
11516    /**
11517     * This sets the scrolled entry's scrollbar policy (ie. enabling/disabling
11518     * them).
11519     *
11520     * Setting an entry to single-line mode with elm_entry_single_line_set()
11521     * will automatically disable the display of scrollbars when the entry
11522     * moves inside its scroller.
11523     *
11524     * @param obj The scrolled entry object
11525     * @param h The horizontal scrollbar policy to apply
11526     * @param v The vertical scrollbar policy to apply
11527     */
11528    EAPI void         elm_entry_scrollbar_policy_set(Evas_Object *obj, Elm_Scroller_Policy h, Elm_Scroller_Policy v);
11529    /**
11530     * This enables/disables bouncing within the entry.
11531     *
11532     * This function sets whether the entry will bounce when scrolling reaches
11533     * the end of the contained entry.
11534     *
11535     * @param obj The scrolled entry object
11536     * @param h The horizontal bounce state
11537     * @param v The vertical bounce state
11538     */
11539    EAPI void         elm_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
11540    /**
11541     * Get the bounce mode
11542     *
11543     * @param obj The Entry object
11544     * @param h_bounce Allow bounce horizontally
11545     * @param v_bounce Allow bounce vertically
11546     */
11547    EAPI void         elm_entry_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
11548
11549    /* pre-made filters for entries */
11550    /**
11551     * @typedef Elm_Entry_Filter_Limit_Size
11552     *
11553     * Data for the elm_entry_filter_limit_size() entry filter.
11554     */
11555    typedef struct _Elm_Entry_Filter_Limit_Size Elm_Entry_Filter_Limit_Size;
11556    /**
11557     * @struct _Elm_Entry_Filter_Limit_Size
11558     *
11559     * Data for the elm_entry_filter_limit_size() entry filter.
11560     */
11561    struct _Elm_Entry_Filter_Limit_Size
11562      {
11563         int max_char_count; /**< The maximum number of characters allowed. */
11564         int max_byte_count; /**< The maximum number of bytes allowed*/
11565      };
11566    /**
11567     * Filter inserted text based on user defined character and byte limits
11568     *
11569     * Add this filter to an entry to limit the characters that it will accept
11570     * based the the contents of the provided #Elm_Entry_Filter_Limit_Size.
11571     * The funtion works on the UTF-8 representation of the string, converting
11572     * it from the set markup, thus not accounting for any format in it.
11573     *
11574     * The user must create an #Elm_Entry_Filter_Limit_Size structure and pass
11575     * it as data when setting the filter. In it, it's possible to set limits
11576     * by character count or bytes (any of them is disabled if 0), and both can
11577     * be set at the same time. In that case, it first checks for characters,
11578     * then bytes.
11579     *
11580     * The function will cut the inserted text in order to allow only the first
11581     * number of characters that are still allowed. The cut is made in
11582     * characters, even when limiting by bytes, in order to always contain
11583     * valid ones and avoid half unicode characters making it in.
11584     *
11585     * This filter, like any others, does not apply when setting the entry text
11586     * directly with elm_object_text_set() (or the deprecated
11587     * elm_entry_entry_set()).
11588     */
11589    EAPI void         elm_entry_filter_limit_size(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 2, 3);
11590    /**
11591     * @typedef Elm_Entry_Filter_Accept_Set
11592     *
11593     * Data for the elm_entry_filter_accept_set() entry filter.
11594     */
11595    typedef struct _Elm_Entry_Filter_Accept_Set Elm_Entry_Filter_Accept_Set;
11596    /**
11597     * @struct _Elm_Entry_Filter_Accept_Set
11598     *
11599     * Data for the elm_entry_filter_accept_set() entry filter.
11600     */
11601    struct _Elm_Entry_Filter_Accept_Set
11602      {
11603         const char *accepted; /**< Set of characters accepted in the entry. */
11604         const char *rejected; /**< Set of characters rejected from the entry. */
11605      };
11606    /**
11607     * Filter inserted text based on accepted or rejected sets of characters
11608     *
11609     * Add this filter to an entry to restrict the set of accepted characters
11610     * based on the sets in the provided #Elm_Entry_Filter_Accept_Set.
11611     * This structure contains both accepted and rejected sets, but they are
11612     * mutually exclusive.
11613     *
11614     * The @c accepted set takes preference, so if it is set, the filter will
11615     * only work based on the accepted characters, ignoring anything in the
11616     * @c rejected value. If @c accepted is @c NULL, then @c rejected is used.
11617     *
11618     * In both cases, the function filters by matching utf8 characters to the
11619     * raw markup text, so it can be used to remove formatting tags.
11620     *
11621     * This filter, like any others, does not apply when setting the entry text
11622     * directly with elm_object_text_set() (or the deprecated
11623     * elm_entry_entry_set()).
11624     */
11625    EAPI void         elm_entry_filter_accept_set(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 3);
11626    /**
11627     * Set the input panel layout of the entry
11628     *
11629     * @param obj The entry object
11630     * @param layout layout type
11631     */
11632    EAPI void elm_entry_input_panel_layout_set(Evas_Object *obj, Elm_Input_Panel_Layout layout) EINA_ARG_NONNULL(1);
11633    /**
11634     * Get the input panel layout of the entry
11635     *
11636     * @param obj The entry object
11637     * @return layout type
11638     *
11639     * @see elm_entry_input_panel_layout_set
11640     */
11641    EAPI Elm_Input_Panel_Layout elm_entry_input_panel_layout_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
11642    /**
11643     * Set the autocapitalization type on the immodule.
11644     *
11645     * @param obj The entry object
11646     * @param autocapital_type The type of autocapitalization
11647     */
11648    EAPI void         elm_entry_autocapital_type_set(Evas_Object *obj, Elm_Autocapital_Type autocapital_type) EINA_ARG_NONNULL(1);
11649    /**
11650     * Retrieve the autocapitalization type on the immodule.
11651     *
11652     * @param obj The entry object
11653     * @return autocapitalization type
11654     */
11655    EAPI Elm_Autocapital_Type elm_entry_autocapital_type_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
11656    /**
11657     * Sets the attribute to show the input panel automatically.
11658     *
11659     * @param obj The entry object
11660     * @param enabled If true, the input panel is appeared when entry is clicked or has a focus
11661     */
11662    EAPI void elm_entry_input_panel_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
11663    /**
11664     * Retrieve the attribute to show the input panel automatically.
11665     *
11666     * @param obj The entry object
11667     * @return EINA_TRUE if input panel will be appeared when the entry is clicked or has a focus, EINA_FALSE otherwise
11668     */
11669    EAPI Eina_Bool elm_entry_input_panel_enabled_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
11670
11671    EAPI void         elm_entry_background_color_set(Evas_Object *obj, unsigned int r, unsigned int g, unsigned int b, unsigned int a);
11672    EAPI void         elm_entry_autocapitalization_set(Evas_Object *obj, Eina_Bool autocap);
11673    EAPI void         elm_entry_autoperiod_set(Evas_Object *obj, Eina_Bool autoperiod);
11674    EAPI void         elm_entry_autoenable_returnkey_set(Evas_Object *obj, Eina_Bool on);
11675    EAPI Ecore_IMF_Context *elm_entry_imf_context_get(Evas_Object *obj);
11676    EAPI void         elm_entry_matchlist_set(Evas_Object *obj, Eina_List *match_list, Eina_Bool case_sensitive);
11677    EAPI void         elm_entry_magnifier_type_set(Evas_Object *obj, int type) EINA_ARG_NONNULL(1);
11678
11679    EINA_DEPRECATED EAPI void         elm_entry_wrap_width_set(Evas_Object *obj, Evas_Coord w);
11680    EINA_DEPRECATED EAPI Evas_Coord   elm_entry_wrap_width_get(const Evas_Object *obj);
11681    EINA_DEPRECATED EAPI void         elm_entry_fontsize_set(Evas_Object *obj, int fontsize);
11682    EINA_DEPRECATED EAPI void         elm_entry_text_color_set(Evas_Object *obj, unsigned int r, unsigned int g, unsigned int b, unsigned int a);
11683    EINA_DEPRECATED EAPI void         elm_entry_text_align_set(Evas_Object *obj, const char *alignmode);
11684
11685    /**
11686     * @}
11687     */
11688
11689    /* composite widgets - these basically put together basic widgets above
11690     * in convenient packages that do more than basic stuff */
11691
11692    /* anchorview */
11693    /**
11694     * @defgroup Anchorview Anchorview
11695     *
11696     * @image html img/widget/anchorview/preview-00.png
11697     * @image latex img/widget/anchorview/preview-00.eps
11698     *
11699     * Anchorview is for displaying text that contains markup with anchors
11700     * like <c>\<a href=1234\>something\</\></c> in it.
11701     *
11702     * Besides being styled differently, the anchorview widget provides the
11703     * necessary functionality so that clicking on these anchors brings up a
11704     * popup with user defined content such as "call", "add to contacts" or
11705     * "open web page". This popup is provided using the @ref Hover widget.
11706     *
11707     * This widget is very similar to @ref Anchorblock, so refer to that
11708     * widget for an example. The only difference Anchorview has is that the
11709     * widget is already provided with scrolling functionality, so if the
11710     * text set to it is too large to fit in the given space, it will scroll,
11711     * whereas the @ref Anchorblock widget will keep growing to ensure all the
11712     * text can be displayed.
11713     *
11714     * This widget emits the following signals:
11715     * @li "anchor,clicked": will be called when an anchor is clicked. The
11716     * @p event_info parameter on the callback will be a pointer of type
11717     * ::Elm_Entry_Anchorview_Info.
11718     *
11719     * See @ref Anchorblock for an example on how to use both of them.
11720     *
11721     * @see Anchorblock
11722     * @see Entry
11723     * @see Hover
11724     *
11725     * @{
11726     */
11727    /**
11728     * @typedef Elm_Entry_Anchorview_Info
11729     *
11730     * The info sent in the callback for "anchor,clicked" signals emitted by
11731     * the Anchorview widget.
11732     */
11733    typedef struct _Elm_Entry_Anchorview_Info Elm_Entry_Anchorview_Info;
11734    /**
11735     * @struct _Elm_Entry_Anchorview_Info
11736     *
11737     * The info sent in the callback for "anchor,clicked" signals emitted by
11738     * the Anchorview widget.
11739     */
11740    struct _Elm_Entry_Anchorview_Info
11741      {
11742         const char     *name; /**< Name of the anchor, as indicated in its href
11743                                    attribute */
11744         int             button; /**< The mouse button used to click on it */
11745         Evas_Object    *hover; /**< The hover object to use for the popup */
11746         struct {
11747              Evas_Coord    x, y, w, h;
11748         } anchor, /**< Geometry selection of text used as anchor */
11749           hover_parent; /**< Geometry of the object used as parent by the
11750                              hover */
11751         Eina_Bool       hover_left : 1; /**< Hint indicating if there's space
11752                                              for content on the left side of
11753                                              the hover. Before calling the
11754                                              callback, the widget will make the
11755                                              necessary calculations to check
11756                                              which sides are fit to be set with
11757                                              content, based on the position the
11758                                              hover is activated and its distance
11759                                              to the edges of its parent object
11760                                              */
11761         Eina_Bool       hover_right : 1; /**< Hint indicating content fits on
11762                                               the right side of the hover.
11763                                               See @ref hover_left */
11764         Eina_Bool       hover_top : 1; /**< Hint indicating content fits on top
11765                                             of the hover. See @ref hover_left */
11766         Eina_Bool       hover_bottom : 1; /**< Hint indicating content fits
11767                                                below the hover. See @ref
11768                                                hover_left */
11769      };
11770    /**
11771     * Add a new Anchorview object
11772     *
11773     * @param parent The parent object
11774     * @return The new object or NULL if it cannot be created
11775     */
11776    EAPI Evas_Object *elm_anchorview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11777    /**
11778     * Set the text to show in the anchorview
11779     *
11780     * Sets the text of the anchorview to @p text. This text can include markup
11781     * format tags, including <c>\<a href=anchorname\></c> to begin a segment of
11782     * text that will be specially styled and react to click events, ended with
11783     * either of \</a\> or \</\>. When clicked, the anchor will emit an
11784     * "anchor,clicked" signal that you can attach a callback to with
11785     * evas_object_smart_callback_add(). The name of the anchor given in the
11786     * event info struct will be the one set in the href attribute, in this
11787     * case, anchorname.
11788     *
11789     * Other markup can be used to style the text in different ways, but it's
11790     * up to the style defined in the theme which tags do what.
11791     * @deprecated use elm_object_text_set() instead.
11792     */
11793    EINA_DEPRECATED EAPI void         elm_anchorview_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
11794    /**
11795     * Get the markup text set for the anchorview
11796     *
11797     * Retrieves the text set on the anchorview, with markup tags included.
11798     *
11799     * @param obj The anchorview object
11800     * @return The markup text set or @c NULL if nothing was set or an error
11801     * occurred
11802     * @deprecated use elm_object_text_set() instead.
11803     */
11804    EINA_DEPRECATED EAPI const char  *elm_anchorview_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11805    /**
11806     * Set the parent of the hover popup
11807     *
11808     * Sets the parent object to use by the hover created by the anchorview
11809     * when an anchor is clicked. See @ref Hover for more details on this.
11810     * If no parent is set, the same anchorview object will be used.
11811     *
11812     * @param obj The anchorview object
11813     * @param parent The object to use as parent for the hover
11814     */
11815    EAPI void         elm_anchorview_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
11816    /**
11817     * Get the parent of the hover popup
11818     *
11819     * Get the object used as parent for the hover created by the anchorview
11820     * widget. See @ref Hover for more details on this.
11821     *
11822     * @param obj The anchorview object
11823     * @return The object used as parent for the hover, NULL if none is set.
11824     */
11825    EAPI Evas_Object *elm_anchorview_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11826    /**
11827     * Set the style that the hover should use
11828     *
11829     * When creating the popup hover, anchorview will request that it's
11830     * themed according to @p style.
11831     *
11832     * @param obj The anchorview object
11833     * @param style The style to use for the underlying hover
11834     *
11835     * @see elm_object_style_set()
11836     */
11837    EAPI void         elm_anchorview_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
11838    /**
11839     * Get the style that the hover should use
11840     *
11841     * Get the style the hover created by anchorview will use.
11842     *
11843     * @param obj The anchorview object
11844     * @return The style to use by the hover. NULL means the default is used.
11845     *
11846     * @see elm_object_style_set()
11847     */
11848    EAPI const char  *elm_anchorview_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11849    /**
11850     * Ends the hover popup in the anchorview
11851     *
11852     * When an anchor is clicked, the anchorview widget will create a hover
11853     * object to use as a popup with user provided content. This function
11854     * terminates this popup, returning the anchorview to its normal state.
11855     *
11856     * @param obj The anchorview object
11857     */
11858    EAPI void         elm_anchorview_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
11859    /**
11860     * Set bouncing behaviour when the scrolled content reaches an edge
11861     *
11862     * Tell the internal scroller object whether it should bounce or not
11863     * when it reaches the respective edges for each axis.
11864     *
11865     * @param obj The anchorview object
11866     * @param h_bounce Whether to bounce or not in the horizontal axis
11867     * @param v_bounce Whether to bounce or not in the vertical axis
11868     *
11869     * @see elm_scroller_bounce_set()
11870     */
11871    EAPI void         elm_anchorview_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
11872    /**
11873     * Get the set bouncing behaviour of the internal scroller
11874     *
11875     * Get whether the internal scroller should bounce when the edge of each
11876     * axis is reached scrolling.
11877     *
11878     * @param obj The anchorview object
11879     * @param h_bounce Pointer where to store the bounce state of the horizontal
11880     *                 axis
11881     * @param v_bounce Pointer where to store the bounce state of the vertical
11882     *                 axis
11883     *
11884     * @see elm_scroller_bounce_get()
11885     */
11886    EAPI void         elm_anchorview_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
11887    /**
11888     * Appends a custom item provider to the given anchorview
11889     *
11890     * Appends the given function to the list of items providers. This list is
11891     * called, one function at a time, with the given @p data pointer, the
11892     * anchorview object and, in the @p item parameter, the item name as
11893     * referenced in its href string. Following functions in the list will be
11894     * called in order until one of them returns something different to NULL,
11895     * which should be an Evas_Object which will be used in place of the item
11896     * element.
11897     *
11898     * Items in the markup text take the form \<item relsize=16x16 vsize=full
11899     * href=item/name\>\</item\>
11900     *
11901     * @param obj The anchorview object
11902     * @param func The function to add to the list of providers
11903     * @param data User data that will be passed to the callback function
11904     *
11905     * @see elm_entry_item_provider_append()
11906     */
11907    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);
11908    /**
11909     * Prepend a custom item provider to the given anchorview
11910     *
11911     * Like elm_anchorview_item_provider_append(), but it adds the function
11912     * @p func to the beginning of the list, instead of the end.
11913     *
11914     * @param obj The anchorview object
11915     * @param func The function to add to the list of providers
11916     * @param data User data that will be passed to the callback function
11917     */
11918    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);
11919    /**
11920     * Remove a custom item provider from the list of the given anchorview
11921     *
11922     * Removes the function and data pairing that matches @p func and @p data.
11923     * That is, unless the same function and same user data are given, the
11924     * function will not be removed from the list. This allows us to add the
11925     * same callback several times, with different @p data pointers and be
11926     * able to remove them later without conflicts.
11927     *
11928     * @param obj The anchorview object
11929     * @param func The function to remove from the list
11930     * @param data The data matching the function to remove from the list
11931     */
11932    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);
11933    /**
11934     * @}
11935     */
11936
11937    /* anchorblock */
11938    /**
11939     * @defgroup Anchorblock Anchorblock
11940     *
11941     * @image html img/widget/anchorblock/preview-00.png
11942     * @image latex img/widget/anchorblock/preview-00.eps
11943     *
11944     * Anchorblock is for displaying text that contains markup with anchors
11945     * like <c>\<a href=1234\>something\</\></c> in it.
11946     *
11947     * Besides being styled differently, the anchorblock widget provides the
11948     * necessary functionality so that clicking on these anchors brings up a
11949     * popup with user defined content such as "call", "add to contacts" or
11950     * "open web page". This popup is provided using the @ref Hover widget.
11951     *
11952     * This widget emits the following signals:
11953     * @li "anchor,clicked": will be called when an anchor is clicked. The
11954     * @p event_info parameter on the callback will be a pointer of type
11955     * ::Elm_Entry_Anchorblock_Info.
11956     *
11957     * @see Anchorview
11958     * @see Entry
11959     * @see Hover
11960     *
11961     * Since examples are usually better than plain words, we might as well
11962     * try @ref tutorial_anchorblock_example "one".
11963     */
11964    /**
11965     * @addtogroup Anchorblock
11966     * @{
11967     */
11968    /**
11969     * @typedef Elm_Entry_Anchorblock_Info
11970     *
11971     * The info sent in the callback for "anchor,clicked" signals emitted by
11972     * the Anchorblock widget.
11973     */
11974    typedef struct _Elm_Entry_Anchorblock_Info Elm_Entry_Anchorblock_Info;
11975    /**
11976     * @struct _Elm_Entry_Anchorblock_Info
11977     *
11978     * The info sent in the callback for "anchor,clicked" signals emitted by
11979     * the Anchorblock widget.
11980     */
11981    struct _Elm_Entry_Anchorblock_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 Anchorblock 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_anchorblock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12018    /**
12019     * Set the text to show in the anchorblock
12020     *
12021     * Sets the text of the anchorblock to @p text. This text can include markup
12022     * format tags, including <c>\<a href=anchorname\></a></c> to begin a segment
12023     * of text that will be specially styled and react to click events, ended
12024     * with 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_anchorblock_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
12035    /**
12036     * Get the markup text set for the anchorblock
12037     *
12038     * Retrieves the text set on the anchorblock, with markup tags included.
12039     *
12040     * @param obj The anchorblock 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_anchorblock_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 anchorblock
12050     * when an anchor is clicked. See @ref Hover for more details on this.
12051     *
12052     * @param obj The anchorblock object
12053     * @param parent The object to use as parent for the hover
12054     */
12055    EAPI void         elm_anchorblock_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
12056    /**
12057     * Get the parent of the hover popup
12058     *
12059     * Get the object used as parent for the hover created by the anchorblock
12060     * widget. See @ref Hover for more details on this.
12061     * If no parent is set, the same anchorblock object will be used.
12062     *
12063     * @param obj The anchorblock object
12064     * @return The object used as parent for the hover, NULL if none is set.
12065     */
12066    EAPI Evas_Object *elm_anchorblock_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, anchorblock will request that it's
12071     * themed according to @p style.
12072     *
12073     * @param obj The anchorblock object
12074     * @param style The style to use for the underlying hover
12075     *
12076     * @see elm_object_style_set()
12077     */
12078    EAPI void         elm_anchorblock_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 anchorblock will use.
12083     *
12084     * @param obj The anchorblock 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_anchorblock_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12090    /**
12091     * Ends the hover popup in the anchorblock
12092     *
12093     * When an anchor is clicked, the anchorblock widget will create a hover
12094     * object to use as a popup with user provided content. This function
12095     * terminates this popup, returning the anchorblock to its normal state.
12096     *
12097     * @param obj The anchorblock object
12098     */
12099    EAPI void         elm_anchorblock_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
12100    /**
12101     * Appends a custom item provider to the given anchorblock
12102     *
12103     * Appends the given function to the list of items providers. This list is
12104     * called, one function at a time, with the given @p data pointer, the
12105     * anchorblock object and, in the @p item parameter, the item name as
12106     * referenced in its href string. Following functions in the list will be
12107     * called in order until one of them returns something different to NULL,
12108     * which should be an Evas_Object which will be used in place of the item
12109     * element.
12110     *
12111     * Items in the markup text take the form \<item relsize=16x16 vsize=full
12112     * href=item/name\>\</item\>
12113     *
12114     * @param obj The anchorblock object
12115     * @param func The function to add to the list of providers
12116     * @param data User data that will be passed to the callback function
12117     *
12118     * @see elm_entry_item_provider_append()
12119     */
12120    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);
12121    /**
12122     * Prepend a custom item provider to the given anchorblock
12123     *
12124     * Like elm_anchorblock_item_provider_append(), but it adds the function
12125     * @p func to the beginning of the list, instead of the end.
12126     *
12127     * @param obj The anchorblock object
12128     * @param func The function to add to the list of providers
12129     * @param data User data that will be passed to the callback function
12130     */
12131    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);
12132    /**
12133     * Remove a custom item provider from the list of the given anchorblock
12134     *
12135     * Removes the function and data pairing that matches @p func and @p data.
12136     * That is, unless the same function and same user data are given, the
12137     * function will not be removed from the list. This allows us to add the
12138     * same callback several times, with different @p data pointers and be
12139     * able to remove them later without conflicts.
12140     *
12141     * @param obj The anchorblock object
12142     * @param func The function to remove from the list
12143     * @param data The data matching the function to remove from the list
12144     */
12145    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);
12146    /**
12147     * @}
12148     */
12149
12150    /**
12151     * @defgroup Bubble Bubble
12152     *
12153     * @image html img/widget/bubble/preview-00.png
12154     * @image latex img/widget/bubble/preview-00.eps
12155     * @image html img/widget/bubble/preview-01.png
12156     * @image latex img/widget/bubble/preview-01.eps
12157     * @image html img/widget/bubble/preview-02.png
12158     * @image latex img/widget/bubble/preview-02.eps
12159     *
12160     * @brief The Bubble is a widget to show text similar to how speech is
12161     * represented in comics.
12162     *
12163     * The bubble widget contains 5 important visual elements:
12164     * @li The frame is a rectangle with rounded edjes and an "arrow".
12165     * @li The @p icon is an image to which the frame's arrow points to.
12166     * @li The @p label is a text which appears to the right of the icon if the
12167     * corner is "top_left" or "bottom_left" and is right aligned to the frame
12168     * otherwise.
12169     * @li The @p info is a text which appears to the right of the label. Info's
12170     * font is of a ligther color than label.
12171     * @li The @p content is an evas object that is shown inside the frame.
12172     *
12173     * The position of the arrow, icon, label and info depends on which corner is
12174     * selected. The four available corners are:
12175     * @li "top_left" - Default
12176     * @li "top_right"
12177     * @li "bottom_left"
12178     * @li "bottom_right"
12179     *
12180     * Signals that you can add callbacks for are:
12181     * @li "clicked" - This is called when a user has clicked the bubble.
12182     *
12183     * For an example of using a buble see @ref bubble_01_example_page "this".
12184     *
12185     * @{
12186     */
12187    /**
12188     * Add a new bubble to the parent
12189     *
12190     * @param parent The parent object
12191     * @return The new object or NULL if it cannot be created
12192     *
12193     * This function adds a text bubble to the given parent evas object.
12194     */
12195    EAPI Evas_Object *elm_bubble_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12196    /**
12197     * Set the label of the bubble
12198     *
12199     * @param obj The bubble object
12200     * @param label The string to set in the label
12201     *
12202     * This function sets the title of the bubble. Where this appears depends on
12203     * the selected corner.
12204     * @deprecated use elm_object_text_set() instead.
12205     */
12206    EINA_DEPRECATED EAPI void         elm_bubble_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
12207    /**
12208     * Get the label of the bubble
12209     *
12210     * @param obj The bubble object
12211     * @return The string of set in the label
12212     *
12213     * This function gets the title of the bubble.
12214     * @deprecated use elm_object_text_get() instead.
12215     */
12216    EINA_DEPRECATED EAPI const char  *elm_bubble_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12217    /**
12218     * Set the info of the bubble
12219     *
12220     * @param obj The bubble object
12221     * @param info The given info about the bubble
12222     *
12223     * This function sets the info of the bubble. Where this appears depends on
12224     * the selected corner.
12225     * @deprecated use elm_object_text_part_set() instead. (with "info" as the parameter).
12226     */
12227    EINA_DEPRECATED EAPI void         elm_bubble_info_set(Evas_Object *obj, const char *info) EINA_ARG_NONNULL(1);
12228    /**
12229     * Get the info of the bubble
12230     *
12231     * @param obj The bubble object
12232     *
12233     * @return The "info" string of the bubble
12234     *
12235     * This function gets the info text.
12236     * @deprecated use elm_object_text_part_get() instead. (with "info" as the parameter).
12237     */
12238    EINA_DEPRECATED EAPI const char  *elm_bubble_info_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12239    /**
12240     * Set the content to be shown in the bubble
12241     *
12242     * Once the content object is set, a previously set one will be deleted.
12243     * If you want to keep the old content object, use the
12244     * elm_bubble_content_unset() function.
12245     *
12246     * @param obj The bubble object
12247     * @param content The given content of the bubble
12248     *
12249     * This function sets the content shown on the middle of the bubble.
12250     */
12251    EAPI void         elm_bubble_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
12252    /**
12253     * Get the content shown in the bubble
12254     *
12255     * Return the content object which is set for this widget.
12256     *
12257     * @param obj The bubble object
12258     * @return The content that is being used
12259     */
12260    EAPI Evas_Object *elm_bubble_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12261    /**
12262     * Unset the content shown in the bubble
12263     *
12264     * Unparent and return the content object which was set for this widget.
12265     *
12266     * @param obj The bubble object
12267     * @return The content that was being used
12268     */
12269    EAPI Evas_Object *elm_bubble_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12270    /**
12271     * Set the icon of the bubble
12272     *
12273     * Once the icon object is set, a previously set one will be deleted.
12274     * If you want to keep the old content object, use the
12275     * elm_icon_content_unset() function.
12276     *
12277     * @param obj The bubble object
12278     * @param icon The given icon for the bubble
12279     */
12280    EAPI void         elm_bubble_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
12281    /**
12282     * Get the icon of the bubble
12283     *
12284     * @param obj The bubble object
12285     * @return The icon for the bubble
12286     *
12287     * This function gets the icon shown on the top left of bubble.
12288     */
12289    EAPI Evas_Object *elm_bubble_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12290    /**
12291     * Unset the icon of the bubble
12292     *
12293     * Unparent and return the icon object which was set for this widget.
12294     *
12295     * @param obj The bubble object
12296     * @return The icon that was being used
12297     */
12298    EAPI Evas_Object *elm_bubble_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12299    /**
12300     * Set the corner of the bubble
12301     *
12302     * @param obj The bubble object.
12303     * @param corner The given corner for the bubble.
12304     *
12305     * This function sets the corner of the bubble. The corner will be used to
12306     * determine where the arrow in the frame points to and where label, icon and
12307     * info are shown.
12308     *
12309     * Possible values for corner are:
12310     * @li "top_left" - Default
12311     * @li "top_right"
12312     * @li "bottom_left"
12313     * @li "bottom_right"
12314     */
12315    EAPI void         elm_bubble_corner_set(Evas_Object *obj, const char *corner) EINA_ARG_NONNULL(1, 2);
12316    /**
12317     * Get the corner of the bubble
12318     *
12319     * @param obj The bubble object.
12320     * @return The given corner for the bubble.
12321     *
12322     * This function gets the selected corner of the bubble.
12323     */
12324    EAPI const char  *elm_bubble_corner_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12325
12326    EINA_DEPRECATED EAPI void         elm_bubble_sweep_layout_set(Evas_Object *obj, Evas_Object *sweep) EINA_ARG_NONNULL(1);
12327    EINA_DEPRECATED EAPI Evas_Object *elm_bubble_sweep_layout_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12328
12329    /**
12330     * @}
12331     */
12332
12333    /**
12334     * @defgroup Photo Photo
12335     *
12336     * For displaying the photo of a person (contact). Simple, yet
12337     * with a very specific purpose.
12338     *
12339     * Signals that you can add callbacks for are:
12340     *
12341     * "clicked" - This is called when a user has clicked the photo
12342     * "drag,start" - Someone started dragging the image out of the object
12343     * "drag,end" - Dragged item was dropped (somewhere)
12344     *
12345     * @{
12346     */
12347
12348    /**
12349     * Add a new photo to the parent
12350     *
12351     * @param parent The parent object
12352     * @return The new object or NULL if it cannot be created
12353     *
12354     * @ingroup Photo
12355     */
12356    EAPI Evas_Object *elm_photo_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12357
12358    /**
12359     * Set the file that will be used as photo
12360     *
12361     * @param obj The photo object
12362     * @param file The path to file that will be used as photo
12363     *
12364     * @return (1 = success, 0 = error)
12365     *
12366     * @ingroup Photo
12367     */
12368    EAPI Eina_Bool    elm_photo_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
12369
12370    /**
12371     * Set the size that will be used on the photo
12372     *
12373     * @param obj The photo object
12374     * @param size The size that the photo will be
12375     *
12376     * @ingroup Photo
12377     */
12378    EAPI void         elm_photo_size_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
12379
12380    /**
12381     * Set if the photo should be completely visible or not.
12382     *
12383     * @param obj The photo object
12384     * @param fill if true the photo will be completely visible
12385     *
12386     * @ingroup Photo
12387     */
12388    EAPI void         elm_photo_fill_inside_set(Evas_Object *obj, Eina_Bool fill) EINA_ARG_NONNULL(1);
12389
12390    /**
12391     * Set editability of the photo.
12392     *
12393     * An editable photo can be dragged to or from, and can be cut or
12394     * pasted too.  Note that pasting an image or dropping an item on
12395     * the image will delete the existing content.
12396     *
12397     * @param obj The photo object.
12398     * @param set To set of clear editablity.
12399     */
12400    EAPI void         elm_photo_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
12401
12402    /**
12403     * @}
12404     */
12405
12406    /* gesture layer */
12407    /**
12408     * @defgroup Elm_Gesture_Layer Gesture Layer
12409     * Gesture Layer Usage:
12410     *
12411     * Use Gesture Layer to detect gestures.
12412     * The advantage is that you don't have to implement
12413     * gesture detection, just set callbacks of gesture state.
12414     * By using gesture layer we make standard interface.
12415     *
12416     * In order to use Gesture Layer you start with @ref elm_gesture_layer_add
12417     * with a parent object parameter.
12418     * Next 'activate' gesture layer with a @ref elm_gesture_layer_attach
12419     * call. Usually with same object as target (2nd parameter).
12420     *
12421     * Now you need to tell gesture layer what gestures you follow.
12422     * This is done with @ref elm_gesture_layer_cb_set call.
12423     * By setting the callback you actually saying to gesture layer:
12424     * I would like to know when the gesture @ref Elm_Gesture_Types
12425     * switches to state @ref Elm_Gesture_State.
12426     *
12427     * Next, you need to implement the actual action that follows the input
12428     * in your callback.
12429     *
12430     * Note that if you like to stop being reported about a gesture, just set
12431     * all callbacks referring this gesture to NULL.
12432     * (again with @ref elm_gesture_layer_cb_set)
12433     *
12434     * The information reported by gesture layer to your callback is depending
12435     * on @ref Elm_Gesture_Types:
12436     * @ref Elm_Gesture_Taps_Info is the info reported for tap gestures:
12437     * @ref ELM_GESTURE_N_TAPS, @ref ELM_GESTURE_N_LONG_TAPS,
12438     * @ref ELM_GESTURE_N_DOUBLE_TAPS, @ref ELM_GESTURE_N_TRIPLE_TAPS.
12439     *
12440     * @ref Elm_Gesture_Momentum_Info is info reported for momentum gestures:
12441     * @ref ELM_GESTURE_MOMENTUM.
12442     *
12443     * @ref Elm_Gesture_Line_Info is the info reported for line gestures:
12444     * (this also contains @ref Elm_Gesture_Momentum_Info internal structure)
12445     * @ref ELM_GESTURE_N_LINES, @ref ELM_GESTURE_N_FLICKS.
12446     * Note that we consider a flick as a line-gesture that should be completed
12447     * in flick-time-limit as defined in @ref Config.
12448     *
12449     * @ref Elm_Gesture_Zoom_Info is the info reported for @ref ELM_GESTURE_ZOOM gesture.
12450     *
12451     * @ref Elm_Gesture_Rotate_Info is the info reported for @ref ELM_GESTURE_ROTATE gesture.
12452     *
12453     *
12454     * Gesture Layer Tweaks:
12455     *
12456     * Note that line, flick, gestures can start without the need to remove fingers from surface.
12457     * When user fingers rests on same-spot gesture is ended and starts again when fingers moved.
12458     *
12459     * Setting glayer_continues_enable to false in @ref Config will change this behavior
12460     * so gesture starts when user touches (a *DOWN event) touch-surface
12461     * and ends when no fingers touches surface (a *UP event).
12462     */
12463
12464    /**
12465     * @enum _Elm_Gesture_Types
12466     * Enum of supported gesture types.
12467     * @ingroup Elm_Gesture_Layer
12468     */
12469    enum _Elm_Gesture_Types
12470      {
12471         ELM_GESTURE_FIRST = 0,
12472
12473         ELM_GESTURE_N_TAPS, /**< N fingers single taps */
12474         ELM_GESTURE_N_LONG_TAPS, /**< N fingers single long-taps */
12475         ELM_GESTURE_N_DOUBLE_TAPS, /**< N fingers double-single taps */
12476         ELM_GESTURE_N_TRIPLE_TAPS, /**< N fingers triple-single taps */
12477
12478         ELM_GESTURE_MOMENTUM, /**< Reports momentum in the dircetion of move */
12479
12480         ELM_GESTURE_N_LINES, /**< N fingers line gesture */
12481         ELM_GESTURE_N_FLICKS, /**< N fingers flick gesture */
12482
12483         ELM_GESTURE_ZOOM, /**< Zoom */
12484         ELM_GESTURE_ROTATE, /**< Rotate */
12485
12486         ELM_GESTURE_LAST
12487      };
12488
12489    /**
12490     * @typedef Elm_Gesture_Types
12491     * gesture types enum
12492     * @ingroup Elm_Gesture_Layer
12493     */
12494    typedef enum _Elm_Gesture_Types Elm_Gesture_Types;
12495
12496    /**
12497     * @enum _Elm_Gesture_State
12498     * Enum of gesture states.
12499     * @ingroup Elm_Gesture_Layer
12500     */
12501    enum _Elm_Gesture_State
12502      {
12503         ELM_GESTURE_STATE_UNDEFINED = -1, /**< Gesture not STARTed */
12504         ELM_GESTURE_STATE_START,          /**< Gesture STARTed     */
12505         ELM_GESTURE_STATE_MOVE,           /**< Gesture is ongoing  */
12506         ELM_GESTURE_STATE_END,            /**< Gesture completed   */
12507         ELM_GESTURE_STATE_ABORT    /**< Onging gesture was ABORTed */
12508      };
12509
12510    /**
12511     * @typedef Elm_Gesture_State
12512     * gesture states enum
12513     * @ingroup Elm_Gesture_Layer
12514     */
12515    typedef enum _Elm_Gesture_State Elm_Gesture_State;
12516
12517    /**
12518     * @struct _Elm_Gesture_Taps_Info
12519     * Struct holds taps info for user
12520     * @ingroup Elm_Gesture_Layer
12521     */
12522    struct _Elm_Gesture_Taps_Info
12523      {
12524         Evas_Coord x, y;         /**< Holds center point between fingers */
12525         unsigned int n;          /**< Number of fingers tapped           */
12526         unsigned int timestamp;  /**< event timestamp       */
12527      };
12528
12529    /**
12530     * @typedef Elm_Gesture_Taps_Info
12531     * holds taps info for user
12532     * @ingroup Elm_Gesture_Layer
12533     */
12534    typedef struct _Elm_Gesture_Taps_Info Elm_Gesture_Taps_Info;
12535
12536    /**
12537     * @struct _Elm_Gesture_Momentum_Info
12538     * Struct holds momentum info for user
12539     * x1 and y1 are not necessarily in sync
12540     * x1 holds x value of x direction starting point
12541     * and same holds for y1.
12542     * This is noticeable when doing V-shape movement
12543     * @ingroup Elm_Gesture_Layer
12544     */
12545    struct _Elm_Gesture_Momentum_Info
12546      {  /* Report line ends, timestamps, and momentum computed        */
12547         Evas_Coord x1; /**< Final-swipe direction starting point on X */
12548         Evas_Coord y1; /**< Final-swipe direction starting point on Y */
12549         Evas_Coord x2; /**< Final-swipe direction ending point on X   */
12550         Evas_Coord y2; /**< Final-swipe direction ending point on Y   */
12551
12552         unsigned int tx; /**< Timestamp of start of final x-swipe */
12553         unsigned int ty; /**< Timestamp of start of final y-swipe */
12554
12555         Evas_Coord mx; /**< Momentum on X */
12556         Evas_Coord my; /**< Momentum on Y */
12557
12558         unsigned int n;  /**< Number of fingers */
12559      };
12560
12561    /**
12562     * @typedef Elm_Gesture_Momentum_Info
12563     * holds momentum info for user
12564     * @ingroup Elm_Gesture_Layer
12565     */
12566     typedef struct _Elm_Gesture_Momentum_Info Elm_Gesture_Momentum_Info;
12567
12568    /**
12569     * @struct _Elm_Gesture_Line_Info
12570     * Struct holds line info for user
12571     * @ingroup Elm_Gesture_Layer
12572     */
12573    struct _Elm_Gesture_Line_Info
12574      {  /* Report line ends, timestamps, and momentum computed      */
12575         Elm_Gesture_Momentum_Info momentum; /**< Line momentum info */
12576         /* FIXME should be radians, bot degrees */
12577         double angle;              /**< Angle (direction) of lines  */
12578      };
12579
12580    /**
12581     * @typedef Elm_Gesture_Line_Info
12582     * Holds line info for user
12583     * @ingroup Elm_Gesture_Layer
12584     */
12585     typedef struct  _Elm_Gesture_Line_Info Elm_Gesture_Line_Info;
12586
12587    /**
12588     * @struct _Elm_Gesture_Zoom_Info
12589     * Struct holds zoom info for user
12590     * @ingroup Elm_Gesture_Layer
12591     */
12592    struct _Elm_Gesture_Zoom_Info
12593      {
12594         Evas_Coord x, y;       /**< Holds zoom center point reported to user  */
12595         Evas_Coord radius; /**< Holds radius between fingers reported to user */
12596         double zoom;            /**< Zoom value: 1.0 means no zoom             */
12597         double momentum;        /**< Zoom momentum: zoom growth per second (NOT YET SUPPORTED) */
12598      };
12599
12600    /**
12601     * @typedef Elm_Gesture_Zoom_Info
12602     * Holds zoom info for user
12603     * @ingroup Elm_Gesture_Layer
12604     */
12605    typedef struct _Elm_Gesture_Zoom_Info Elm_Gesture_Zoom_Info;
12606
12607    /**
12608     * @struct _Elm_Gesture_Rotate_Info
12609     * Struct holds rotation info for user
12610     * @ingroup Elm_Gesture_Layer
12611     */
12612    struct _Elm_Gesture_Rotate_Info
12613      {
12614         Evas_Coord x, y;   /**< Holds zoom center point reported to user      */
12615         Evas_Coord radius; /**< Holds radius between fingers reported to user */
12616         double base_angle; /**< Holds start-angle */
12617         double angle;      /**< Rotation value: 0.0 means no rotation         */
12618         double momentum;   /**< Rotation momentum: rotation done per second (NOT YET SUPPORTED) */
12619      };
12620
12621    /**
12622     * @typedef Elm_Gesture_Rotate_Info
12623     * Holds rotation info for user
12624     * @ingroup Elm_Gesture_Layer
12625     */
12626    typedef struct _Elm_Gesture_Rotate_Info Elm_Gesture_Rotate_Info;
12627
12628    /**
12629     * @typedef Elm_Gesture_Event_Cb
12630     * User callback used to stream gesture info from gesture layer
12631     * @param data user data
12632     * @param event_info gesture report info
12633     * Returns a flag field to be applied on the causing event.
12634     * You should probably return EVAS_EVENT_FLAG_ON_HOLD if your widget acted
12635     * upon the event, in an irreversible way.
12636     *
12637     * @ingroup Elm_Gesture_Layer
12638     */
12639    typedef Evas_Event_Flags (*Elm_Gesture_Event_Cb) (void *data, void *event_info);
12640
12641    /**
12642     * Use function to set callbacks to be notified about
12643     * change of state of gesture.
12644     * When a user registers a callback with this function
12645     * this means this gesture has to be tested.
12646     *
12647     * When ALL callbacks for a gesture are set to NULL
12648     * it means user isn't interested in gesture-state
12649     * and it will not be tested.
12650     *
12651     * @param obj Pointer to gesture-layer.
12652     * @param idx The gesture you would like to track its state.
12653     * @param cb callback function pointer.
12654     * @param cb_type what event this callback tracks: START, MOVE, END, ABORT.
12655     * @param data user info to be sent to callback (usually, Smart Data)
12656     *
12657     * @ingroup Elm_Gesture_Layer
12658     */
12659    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);
12660
12661    /**
12662     * Call this function to get repeat-events settings.
12663     *
12664     * @param obj Pointer to gesture-layer.
12665     *
12666     * @return repeat events settings.
12667     * @see elm_gesture_layer_hold_events_set()
12668     * @ingroup Elm_Gesture_Layer
12669     */
12670    EAPI Eina_Bool elm_gesture_layer_hold_events_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
12671
12672    /**
12673     * This function called in order to make gesture-layer repeat events.
12674     * Set this of you like to get the raw events only if gestures were not detected.
12675     * Clear this if you like gesture layer to fwd events as testing gestures.
12676     *
12677     * @param obj Pointer to gesture-layer.
12678     * @param r Repeat: TRUE/FALSE
12679     *
12680     * @ingroup Elm_Gesture_Layer
12681     */
12682    EAPI void elm_gesture_layer_hold_events_set(Evas_Object *obj, Eina_Bool r) EINA_ARG_NONNULL(1);
12683
12684    /**
12685     * This function sets step-value for zoom action.
12686     * Set step to any positive value.
12687     * Cancel step setting by setting to 0.0
12688     *
12689     * @param obj Pointer to gesture-layer.
12690     * @param s new zoom step value.
12691     *
12692     * @ingroup Elm_Gesture_Layer
12693     */
12694    EAPI void elm_gesture_layer_zoom_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
12695
12696    /**
12697     * This function sets step-value for rotate action.
12698     * Set step to any positive value.
12699     * Cancel step setting by setting to 0.0
12700     *
12701     * @param obj Pointer to gesture-layer.
12702     * @param s new roatate step value.
12703     *
12704     * @ingroup Elm_Gesture_Layer
12705     */
12706    EAPI void elm_gesture_layer_rotate_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
12707
12708    /**
12709     * This function called to attach gesture-layer to an Evas_Object.
12710     * @param obj Pointer to gesture-layer.
12711     * @param t Pointer to underlying object (AKA Target)
12712     *
12713     * @return TRUE, FALSE on success, failure.
12714     *
12715     * @ingroup Elm_Gesture_Layer
12716     */
12717    EAPI Eina_Bool elm_gesture_layer_attach(Evas_Object *obj, Evas_Object *t) EINA_ARG_NONNULL(1, 2);
12718
12719    /**
12720     * Call this function to construct a new gesture-layer object.
12721     * This does not activate the gesture layer. You have to
12722     * call elm_gesture_layer_attach in order to 'activate' gesture-layer.
12723     *
12724     * @param parent the parent object.
12725     *
12726     * @return Pointer to new gesture-layer object.
12727     *
12728     * @ingroup Elm_Gesture_Layer
12729     */
12730    EAPI Evas_Object *elm_gesture_layer_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12731
12732    /**
12733     * @defgroup Thumb Thumb
12734     *
12735     * @image html img/widget/thumb/preview-00.png
12736     * @image latex img/widget/thumb/preview-00.eps
12737     *
12738     * A thumb object is used for displaying the thumbnail of an image or video.
12739     * You must have compiled Elementary with Ethumb_Client support and the DBus
12740     * service must be present and auto-activated in order to have thumbnails to
12741     * be generated.
12742     *
12743     * Once the thumbnail object becomes visible, it will check if there is a
12744     * previously generated thumbnail image for the file set on it. If not, it
12745     * will start generating this thumbnail.
12746     *
12747     * Different config settings will cause different thumbnails to be generated
12748     * even on the same file.
12749     *
12750     * Generated thumbnails are stored under @c $HOME/.thumbnails/. Check the
12751     * Ethumb documentation to change this path, and to see other configuration
12752     * options.
12753     *
12754     * Signals that you can add callbacks for are:
12755     *
12756     * - "clicked" - This is called when a user has clicked the thumb without dragging
12757     *             around.
12758     * - "clicked,double" - This is called when a user has double-clicked the thumb.
12759     * - "press" - This is called when a user has pressed down the thumb.
12760     * - "generate,start" - The thumbnail generation started.
12761     * - "generate,stop" - The generation process stopped.
12762     * - "generate,error" - The generation failed.
12763     * - "load,error" - The thumbnail image loading failed.
12764     *
12765     * available styles:
12766     * - default
12767     * - noframe
12768     *
12769     * An example of use of thumbnail:
12770     *
12771     * - @ref thumb_example_01
12772     */
12773
12774    /**
12775     * @addtogroup Thumb
12776     * @{
12777     */
12778
12779    /**
12780     * @enum _Elm_Thumb_Animation_Setting
12781     * @typedef Elm_Thumb_Animation_Setting
12782     *
12783     * Used to set if a video thumbnail is animating or not.
12784     *
12785     * @ingroup Thumb
12786     */
12787    typedef enum _Elm_Thumb_Animation_Setting
12788      {
12789         ELM_THUMB_ANIMATION_START = 0, /**< Play animation once */
12790         ELM_THUMB_ANIMATION_LOOP,      /**< Keep playing animation until stop is requested */
12791         ELM_THUMB_ANIMATION_STOP,      /**< Stop playing the animation */
12792         ELM_THUMB_ANIMATION_LAST
12793      } Elm_Thumb_Animation_Setting;
12794
12795    /**
12796     * Add a new thumb object to the parent.
12797     *
12798     * @param parent The parent object.
12799     * @return The new object or NULL if it cannot be created.
12800     *
12801     * @see elm_thumb_file_set()
12802     * @see elm_thumb_ethumb_client_get()
12803     *
12804     * @ingroup Thumb
12805     */
12806    EAPI Evas_Object                 *elm_thumb_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12807    /**
12808     * Reload thumbnail if it was generated before.
12809     *
12810     * @param obj The thumb object to reload
12811     *
12812     * This is useful if the ethumb client configuration changed, like its
12813     * size, aspect or any other property one set in the handle returned
12814     * by elm_thumb_ethumb_client_get().
12815     *
12816     * If the options didn't change, the thumbnail won't be generated again, but
12817     * the old one will still be used.
12818     *
12819     * @see elm_thumb_file_set()
12820     *
12821     * @ingroup Thumb
12822     */
12823    EAPI void                         elm_thumb_reload(Evas_Object *obj) EINA_ARG_NONNULL(1);
12824    /**
12825     * Set the file that will be used as thumbnail.
12826     *
12827     * @param obj The thumb object.
12828     * @param file The path to file that will be used as thumb.
12829     * @param key The key used in case of an EET file.
12830     *
12831     * The file can be an image or a video (in that case, acceptable extensions are:
12832     * avi, mp4, ogv, mov, mpg and wmv). To start the video animation, use the
12833     * function elm_thumb_animate().
12834     *
12835     * @see elm_thumb_file_get()
12836     * @see elm_thumb_reload()
12837     * @see elm_thumb_animate()
12838     *
12839     * @ingroup Thumb
12840     */
12841    EAPI void                         elm_thumb_file_set(Evas_Object *obj, const char *file, const char *key) EINA_ARG_NONNULL(1);
12842    /**
12843     * Get the image or video path and key used to generate the thumbnail.
12844     *
12845     * @param obj The thumb object.
12846     * @param file Pointer to filename.
12847     * @param key Pointer to key.
12848     *
12849     * @see elm_thumb_file_set()
12850     * @see elm_thumb_path_get()
12851     *
12852     * @ingroup Thumb
12853     */
12854    EAPI void                         elm_thumb_file_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
12855    /**
12856     * Get the path and key to the image or video generated by ethumb.
12857     *
12858     * One just need to make sure that the thumbnail was generated before getting
12859     * its path; otherwise, the path will be NULL. One way to do that is by asking
12860     * for the path when/after the "generate,stop" smart callback is called.
12861     *
12862     * @param obj The thumb object.
12863     * @param file Pointer to thumb path.
12864     * @param key Pointer to thumb key.
12865     *
12866     * @see elm_thumb_file_get()
12867     *
12868     * @ingroup Thumb
12869     */
12870    EAPI void                         elm_thumb_path_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
12871    /**
12872     * Set the animation state for the thumb object. If its content is an animated
12873     * video, you may start/stop the animation or tell it to play continuously and
12874     * looping.
12875     *
12876     * @param obj The thumb object.
12877     * @param setting The animation setting.
12878     *
12879     * @see elm_thumb_file_set()
12880     *
12881     * @ingroup Thumb
12882     */
12883    EAPI void                         elm_thumb_animate_set(Evas_Object *obj, Elm_Thumb_Animation_Setting s) EINA_ARG_NONNULL(1);
12884    /**
12885     * Get the animation state for the thumb object.
12886     *
12887     * @param obj The thumb object.
12888     * @return getting The animation setting or @c ELM_THUMB_ANIMATION_LAST,
12889     * on errors.
12890     *
12891     * @see elm_thumb_animate_set()
12892     *
12893     * @ingroup Thumb
12894     */
12895    EAPI Elm_Thumb_Animation_Setting  elm_thumb_animate_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12896    /**
12897     * Get the ethumb_client handle so custom configuration can be made.
12898     *
12899     * @return Ethumb_Client instance or NULL.
12900     *
12901     * This must be called before the objects are created to be sure no object is
12902     * visible and no generation started.
12903     *
12904     * Example of usage:
12905     *
12906     * @code
12907     * #include <Elementary.h>
12908     * #ifndef ELM_LIB_QUICKLAUNCH
12909     * EAPI_MAIN int
12910     * elm_main(int argc, char **argv)
12911     * {
12912     *    Ethumb_Client *client;
12913     *
12914     *    elm_need_ethumb();
12915     *
12916     *    // ... your code
12917     *
12918     *    client = elm_thumb_ethumb_client_get();
12919     *    if (!client)
12920     *      {
12921     *         ERR("could not get ethumb_client");
12922     *         return 1;
12923     *      }
12924     *    ethumb_client_size_set(client, 100, 100);
12925     *    ethumb_client_crop_align_set(client, 0.5, 0.5);
12926     *    // ... your code
12927     *
12928     *    // Create elm_thumb objects here
12929     *
12930     *    elm_run();
12931     *    elm_shutdown();
12932     *    return 0;
12933     * }
12934     * #endif
12935     * ELM_MAIN()
12936     * @endcode
12937     *
12938     * @note There's only one client handle for Ethumb, so once a configuration
12939     * change is done to it, any other request for thumbnails (for any thumbnail
12940     * object) will use that configuration. Thus, this configuration is global.
12941     *
12942     * @ingroup Thumb
12943     */
12944    EAPI void                        *elm_thumb_ethumb_client_get(void);
12945    /**
12946     * Get the ethumb_client connection state.
12947     *
12948     * @return EINA_TRUE if the client is connected to the server or EINA_FALSE
12949     * otherwise.
12950     */
12951    EAPI Eina_Bool                    elm_thumb_ethumb_client_connected(void);
12952    /**
12953     * Make the thumbnail 'editable'.
12954     *
12955     * @param obj Thumb object.
12956     * @param set Turn on or off editability. Default is @c EINA_FALSE.
12957     *
12958     * This means the thumbnail is a valid drag target for drag and drop, and can be
12959     * cut or pasted too.
12960     *
12961     * @see elm_thumb_editable_get()
12962     *
12963     * @ingroup Thumb
12964     */
12965    EAPI Eina_Bool                    elm_thumb_editable_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
12966    EAPI Eina_Bool                    elm_thumb_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12967    /**
12968     * Make the thumbnail 'editable'.
12969     *
12970     * @param obj Thumb object.
12971     * @return Editability.
12972     *
12973     * This means the thumbnail is a valid drag target for drag and drop, and can be
12974     * cut or pasted too.
12975     *
12976     * @see elm_thumb_editable_set()
12977     *
12978     * @ingroup Thumb
12979     */
12980    EAPI Eina_Bool                    elm_thumb_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12981
12982    /**
12983     * @}
12984     */
12985
12986 #if 0
12987    /**
12988     * @defgroup Web Web
12989     *
12990     * @image html img/widget/web/preview-00.png
12991     * @image latex img/widget/web/preview-00.eps
12992     *
12993     * A web object is used for displaying web pages (HTML/CSS/JS)
12994     * using WebKit-EFL. You must have compiled Elementary with
12995     * ewebkit support.
12996     *
12997     * Signals that you can add callbacks for are:
12998     * @li "download,request": A file download has been requested. Event info is
12999     * a pointer to a Elm_Web_Download
13000     * @li "editorclient,contents,changed": Editor client's contents changed
13001     * @li "editorclient,selection,changed": Editor client's selection changed
13002     * @li "frame,created": A new frame was created. Event info is an
13003     * Evas_Object which can be handled with WebKit's ewk_frame API
13004     * @li "icon,received": An icon was received by the main frame
13005     * @li "inputmethod,changed": Input method changed. Event info is an
13006     * Eina_Bool indicating whether it's enabled or not
13007     * @li "js,windowobject,clear": JS window object has been cleared
13008     * @li "link,hover,in": Mouse cursor is hovering over a link. Event info
13009     * is a char *link[2], where the first string contains the URL the link
13010     * points to, and the second one the title of the link
13011     * @li "link,hover,out": Mouse cursor left the link
13012     * @li "load,document,finished": Loading of a document finished. Event info
13013     * is the frame that finished loading
13014     * @li "load,error": Load failed. Event info is a pointer to
13015     * Elm_Web_Frame_Load_Error
13016     * @li "load,finished": Load finished. Event info is NULL on success, on
13017     * error it's a pointer to Elm_Web_Frame_Load_Error
13018     * @li "load,newwindow,show": A new window was created and is ready to be
13019     * shown
13020     * @li "load,progress": Overall load progress. Event info is a pointer to
13021     * a double containing a value between 0.0 and 1.0
13022     * @li "load,provisional": Started provisional load
13023     * @li "load,started": Loading of a document started
13024     * @li "menubar,visible,get": Queries if the menubar is visible. Event info
13025     * is a pointer to Eina_Bool where the callback should set EINA_TRUE if
13026     * the menubar is visible, or EINA_FALSE in case it's not
13027     * @li "menubar,visible,set": Informs menubar visibility. Event info is
13028     * an Eina_Bool indicating the visibility
13029     * @li "popup,created": A dropdown widget was activated, requesting its
13030     * popup menu to be created. Event info is a pointer to Elm_Web_Menu
13031     * @li "popup,willdelete": The web object is ready to destroy the popup
13032     * object created. Event info is a pointer to Elm_Web_Menu
13033     * @li "ready": Page is fully loaded
13034     * @li "scrollbars,visible,get": Queries visibility of scrollbars. Event
13035     * info is a pointer to Eina_Bool where the visibility state should be set
13036     * @li "scrollbars,visible,set": Informs scrollbars visibility. Event info
13037     * is an Eina_Bool with the visibility state set
13038     * @li "statusbar,text,set": Text of the statusbar changed. Even info is
13039     * a string with the new text
13040     * @li "statusbar,visible,get": Queries visibility of the status bar.
13041     * Event info is a pointer to Eina_Bool where the visibility state should be
13042     * set.
13043     * @li "statusbar,visible,set": Informs statusbar visibility. Event info is
13044     * an Eina_Bool with the visibility value
13045     * @li "title,changed": Title of the main frame changed. Event info is a
13046     * string with the new title
13047     * @li "toolbars,visible,get": Queries visibility of toolbars. Event info
13048     * is a pointer to Eina_Bool where the visibility state should be set
13049     * @li "toolbars,visible,set": Informs the visibility of toolbars. Event
13050     * info is an Eina_Bool with the visibility state
13051     * @li "tooltip,text,set": Show and set text of a tooltip. Event info is
13052     * a string with the text to show
13053     * @li "uri,changed": URI of the main frame changed. Event info is a string
13054     * with the new URI
13055     * @li "view,resized": The web object internal's view changed sized
13056     * @li "windows,close,request": A JavaScript request to close the current
13057     * window was requested
13058     * @li "zoom,animated,end": Animated zoom finished
13059     *
13060     * available styles:
13061     * - default
13062     *
13063     * An example of use of web:
13064     *
13065     * - @ref web_example_01 TBD
13066     */
13067
13068    /**
13069     * @addtogroup Web
13070     * @{
13071     */
13072
13073    /**
13074     * Structure used to report load errors.
13075     *
13076     * Load errors are reported as signal by elm_web. All the strings are
13077     * temporary references and should @b not be used after the signal
13078     * callback returns. If it's required, make copies with strdup() or
13079     * eina_stringshare_add() (they are not even guaranteed to be
13080     * stringshared, so must use eina_stringshare_add() and not
13081     * eina_stringshare_ref()).
13082     */
13083    typedef struct _Elm_Web_Frame_Load_Error Elm_Web_Frame_Load_Error;
13084    /**
13085     * Structure used to report load errors.
13086     *
13087     * Load errors are reported as signal by elm_web. All the strings are
13088     * temporary references and should @b not be used after the signal
13089     * callback returns. If it's required, make copies with strdup() or
13090     * eina_stringshare_add() (they are not even guaranteed to be
13091     * stringshared, so must use eina_stringshare_add() and not
13092     * eina_stringshare_ref()).
13093     */
13094    struct _Elm_Web_Frame_Load_Error
13095      {
13096         int code; /**< Numeric error code */
13097         Eina_Bool is_cancellation; /**< Error produced by cancelling a request */
13098         const char *domain; /**< Error domain name */
13099         const char *description; /**< Error description (already localized) */
13100         const char *failing_url; /**< The URL that failed to load */
13101         Evas_Object *frame; /**< Frame object that produced the error */
13102      };
13103
13104    /**
13105     * The possibles types that the items in a menu can be
13106     */
13107    typedef enum _Elm_Web_Menu_Item_Type
13108      {
13109         ELM_WEB_MENU_SEPARATOR,
13110         ELM_WEB_MENU_GROUP,
13111         ELM_WEB_MENU_OPTION
13112      } Elm_Web_Menu_Item_Type;
13113
13114    /**
13115     * Structure describing the items in a menu
13116     */
13117    typedef struct _Elm_Web_Menu_Item Elm_Web_Menu_Item;
13118    /**
13119     * Structure describing the items in a menu
13120     */
13121    struct _Elm_Web_Menu_Item
13122      {
13123         const char *text; /**< The text for the item */
13124         Elm_Web_Menu_Item_Type type; /**< The type of the item */
13125      };
13126
13127    /**
13128     * Structure describing the menu of a popup
13129     *
13130     * This structure will be passed as the @c event_info for the "popup,create"
13131     * signal, which is emitted when a dropdown menu is opened. Users wanting
13132     * to handle these popups by themselves should listen to this signal and
13133     * set the @c handled property of the struct to @c EINA_TRUE. Leaving this
13134     * property as @c EINA_FALSE means that the user will not handle the popup
13135     * and the default implementation will be used.
13136     *
13137     * When the popup is ready to be dismissed, a "popup,willdelete" signal
13138     * will be emitted to notify the user that it can destroy any objects and
13139     * free all data related to it.
13140     *
13141     * @see elm_web_popup_selected_set()
13142     * @see elm_web_popup_destroy()
13143     */
13144    typedef struct _Elm_Web_Menu Elm_Web_Menu;
13145    /**
13146     * Structure describing the menu of a popup
13147     *
13148     * This structure will be passed as the @c event_info for the "popup,create"
13149     * signal, which is emitted when a dropdown menu is opened. Users wanting
13150     * to handle these popups by themselves should listen to this signal and
13151     * set the @c handled property of the struct to @c EINA_TRUE. Leaving this
13152     * property as @c EINA_FALSE means that the user will not handle the popup
13153     * and the default implementation will be used.
13154     *
13155     * When the popup is ready to be dismissed, a "popup,willdelete" signal
13156     * will be emitted to notify the user that it can destroy any objects and
13157     * free all data related to it.
13158     *
13159     * @see elm_web_popup_selected_set()
13160     * @see elm_web_popup_destroy()
13161     */
13162    struct _Elm_Web_Menu
13163      {
13164         Eina_List *items; /**< List of #Elm_Web_Menu_Item */
13165         int x; /**< The X position of the popup, relative to the elm_web object */
13166         int y; /**< The Y position of the popup, relative to the elm_web object */
13167         int width; /**< Width of the popup menu */
13168         int height; /**< Height of the popup menu */
13169
13170         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. */
13171      };
13172
13173    typedef struct _Elm_Web_Download Elm_Web_Download;
13174    struct _Elm_Web_Download
13175      {
13176         const char *url;
13177      };
13178
13179    /**
13180     * Types of zoom available.
13181     */
13182    typedef enum _Elm_Web_Zoom_Mode
13183      {
13184         ELM_WEB_ZOOM_MODE_MANUAL = 0, /**< Zoom controled normally by elm_web_zoom_set */
13185         ELM_WEB_ZOOM_MODE_AUTO_FIT, /**< Zoom until content fits in web object */
13186         ELM_WEB_ZOOM_MODE_AUTO_FILL, /**< Zoom until content fills web object */
13187         ELM_WEB_ZOOM_MODE_LAST
13188      } Elm_Web_Zoom_Mode;
13189    /**
13190     * Opaque handler containing the features (such as statusbar, menubar, etc)
13191     * that are to be set on a newly requested window.
13192     */
13193    typedef struct _Elm_Web_Window_Features Elm_Web_Window_Features;
13194    /**
13195     * Callback type for the create_window hook.
13196     *
13197     * The function parameters are:
13198     * @li @p data User data pointer set when setting the hook function
13199     * @li @p obj The elm_web object requesting the new window
13200     * @li @p js Set to @c EINA_TRUE if the request was originated from
13201     * JavaScript. @c EINA_FALSE otherwise.
13202     * @li @p window_features A pointer of #Elm_Web_Window_Features indicating
13203     * the features requested for the new window.
13204     *
13205     * The returned value of the function should be the @c elm_web widget where
13206     * the request will be loaded. That is, if a new window or tab is created,
13207     * the elm_web widget in it should be returned, and @b NOT the window
13208     * object.
13209     * Returning @c NULL should cancel the request.
13210     *
13211     * @see elm_web_window_create_hook_set()
13212     */
13213    typedef Evas_Object *(*Elm_Web_Window_Open)(void *data, Evas_Object *obj, Eina_Bool js, const Elm_Web_Window_Features *window_features);
13214    /**
13215     * Callback type for the JS alert hook.
13216     *
13217     * The function parameters are:
13218     * @li @p data User data pointer set when setting the hook function
13219     * @li @p obj The elm_web object requesting the new window
13220     * @li @p message The message to show in the alert dialog
13221     *
13222     * The function should return the object representing the alert dialog.
13223     * Elm_Web will run a second main loop to handle the dialog and normal
13224     * flow of the application will be restored when the object is deleted, so
13225     * the user should handle the popup properly in order to delete the object
13226     * when the action is finished.
13227     * If the function returns @c NULL the popup will be ignored.
13228     *
13229     * @see elm_web_dialog_alert_hook_set()
13230     */
13231    typedef Evas_Object *(*Elm_Web_Dialog_Alert)(void *data, Evas_Object *obj, const char *message);
13232    /**
13233     * Callback type for the JS confirm hook.
13234     *
13235     * The function parameters are:
13236     * @li @p data User data pointer set when setting the hook function
13237     * @li @p obj The elm_web object requesting the new window
13238     * @li @p message The message to show in the confirm dialog
13239     * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13240     * the user selected @c Ok, @c EINA_FALSE otherwise.
13241     *
13242     * The function should return the object representing the confirm dialog.
13243     * Elm_Web will run a second main loop to handle the dialog and normal
13244     * flow of the application will be restored when the object is deleted, so
13245     * the user should handle the popup properly in order to delete the object
13246     * when the action is finished.
13247     * If the function returns @c NULL the popup will be ignored.
13248     *
13249     * @see elm_web_dialog_confirm_hook_set()
13250     */
13251    typedef Evas_Object *(*Elm_Web_Dialog_Confirm)(void *data, Evas_Object *obj, const char *message, Eina_Bool *ret);
13252    /**
13253     * Callback type for the JS prompt hook.
13254     *
13255     * The function parameters are:
13256     * @li @p data User data pointer set when setting the hook function
13257     * @li @p obj The elm_web object requesting the new window
13258     * @li @p message The message to show in the prompt dialog
13259     * @li @p def_value The default value to present the user in the entry
13260     * @li @p value Pointer where to store the value given by the user. Must
13261     * be a malloc'ed string or @c NULL if the user cancelled the popup.
13262     * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13263     * the user selected @c Ok, @c EINA_FALSE otherwise.
13264     *
13265     * The function should return the object representing the prompt dialog.
13266     * Elm_Web will run a second main loop to handle the dialog and normal
13267     * flow of the application will be restored when the object is deleted, so
13268     * the user should handle the popup properly in order to delete the object
13269     * when the action is finished.
13270     * If the function returns @c NULL the popup will be ignored.
13271     *
13272     * @see elm_web_dialog_prompt_hook_set()
13273     */
13274    typedef Evas_Object *(*Elm_Web_Dialog_Prompt)(void *data, Evas_Object *obj, const char *message, const char *def_value, char **value, Eina_Bool *ret);
13275    /**
13276     * Callback type for the JS file selector hook.
13277     *
13278     * The function parameters are:
13279     * @li @p data User data pointer set when setting the hook function
13280     * @li @p obj The elm_web object requesting the new window
13281     * @li @p allows_multiple @c EINA_TRUE if multiple files can be selected.
13282     * @li @p accept_types Mime types accepted
13283     * @li @p selected Pointer where to store the list of malloc'ed strings
13284     * containing the path to each file selected. Must be @c NULL if the file
13285     * dialog is cancelled
13286     * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13287     * the user selected @c Ok, @c EINA_FALSE otherwise.
13288     *
13289     * The function should return the object representing the file selector
13290     * dialog.
13291     * Elm_Web will run a second main loop to handle the dialog and normal
13292     * flow of the application will be restored when the object is deleted, so
13293     * the user should handle the popup properly in order to delete the object
13294     * when the action is finished.
13295     * If the function returns @c NULL the popup will be ignored.
13296     *
13297     * @see elm_web_dialog_file selector_hook_set()
13298     */
13299    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);
13300    /**
13301     * Callback type for the JS console message hook.
13302     *
13303     * When a console message is added from JavaScript, any set function to the
13304     * console message hook will be called for the user to handle. There is no
13305     * default implementation of this hook.
13306     *
13307     * The function parameters are:
13308     * @li @p data User data pointer set when setting the hook function
13309     * @li @p obj The elm_web object that originated the message
13310     * @li @p message The message sent
13311     * @li @p line_number The line number
13312     * @li @p source_id Source id
13313     *
13314     * @see elm_web_console_message_hook_set()
13315     */
13316    typedef void (*Elm_Web_Console_Message)(void *data, Evas_Object *obj, const char *message, unsigned int line_number, const char *source_id);
13317    /**
13318     * Add a new web object to the parent.
13319     *
13320     * @param parent The parent object.
13321     * @return The new object or NULL if it cannot be created.
13322     *
13323     * @see elm_web_uri_set()
13324     * @see elm_web_webkit_view_get()
13325     */
13326    EAPI Evas_Object                 *elm_web_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13327
13328    /**
13329     * Get internal ewk_view object from web object.
13330     *
13331     * Elementary may not provide some low level features of EWebKit,
13332     * instead of cluttering the API with proxy methods we opted to
13333     * return the internal reference. Be careful using it as it may
13334     * interfere with elm_web behavior.
13335     *
13336     * @param obj The web object.
13337     * @return The internal ewk_view object or NULL if it does not
13338     *         exist. (Failure to create or Elementary compiled without
13339     *         ewebkit)
13340     *
13341     * @see elm_web_add()
13342     */
13343    EAPI Evas_Object                 *elm_web_webkit_view_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13344
13345    /**
13346     * Sets the function to call when a new window is requested
13347     *
13348     * This hook will be called when a request to create a new window is
13349     * issued from the web page loaded.
13350     * There is no default implementation for this feature, so leaving this
13351     * unset or passing @c NULL in @p func will prevent new windows from
13352     * opening.
13353     *
13354     * @param obj The web object where to set the hook function
13355     * @param func The hook function to be called when a window is requested
13356     * @param data User data
13357     */
13358    EAPI void                         elm_web_window_create_hook_set(Evas_Object *obj, Elm_Web_Window_Open func, void *data);
13359    /**
13360     * Sets the function to call when an alert dialog
13361     *
13362     * This hook will be called when a JavaScript alert dialog is requested.
13363     * If no function is set or @c NULL is passed in @p func, the default
13364     * implementation will take place.
13365     *
13366     * @param obj The web object where to set the hook function
13367     * @param func The callback function to be used
13368     * @param data User data
13369     *
13370     * @see elm_web_inwin_mode_set()
13371     */
13372    EAPI void                         elm_web_dialog_alert_hook_set(Evas_Object *obj, Elm_Web_Dialog_Alert func, void *data);
13373    /**
13374     * Sets the function to call when an confirm dialog
13375     *
13376     * This hook will be called when a JavaScript confirm dialog is requested.
13377     * If no function is set or @c NULL is passed in @p func, the default
13378     * implementation will take place.
13379     *
13380     * @param obj The web object where to set the hook function
13381     * @param func The callback function to be used
13382     * @param data User data
13383     *
13384     * @see elm_web_inwin_mode_set()
13385     */
13386    EAPI void                         elm_web_dialog_confirm_hook_set(Evas_Object *obj, Elm_Web_Dialog_Confirm func, void *data);
13387    /**
13388     * Sets the function to call when an prompt dialog
13389     *
13390     * This hook will be called when a JavaScript prompt dialog is requested.
13391     * If no function is set or @c NULL is passed in @p func, the default
13392     * implementation will take place.
13393     *
13394     * @param obj The web object where to set the hook function
13395     * @param func The callback function to be used
13396     * @param data User data
13397     *
13398     * @see elm_web_inwin_mode_set()
13399     */
13400    EAPI void                         elm_web_dialog_prompt_hook_set(Evas_Object *obj, Elm_Web_Dialog_Prompt func, void *data);
13401    /**
13402     * Sets the function to call when an file selector dialog
13403     *
13404     * This hook will be called when a JavaScript file selector dialog is
13405     * requested.
13406     * If no function is set or @c NULL is passed in @p func, the default
13407     * implementation will take place.
13408     *
13409     * @param obj The web object where to set the hook function
13410     * @param func The callback function to be used
13411     * @param data User data
13412     *
13413     * @see elm_web_inwin_mode_set()
13414     */
13415    EAPI void                         elm_web_dialog_file_selector_hook_set(Evas_Object *obj, Elm_Web_Dialog_File_Selector func, void *data);
13416    /**
13417     * Sets the function to call when a console message is emitted from JS
13418     *
13419     * This hook will be called when a console message is emitted from
13420     * JavaScript. There is no default implementation for this feature.
13421     *
13422     * @param obj The web object where to set the hook function
13423     * @param func The callback function to be used
13424     * @param data User data
13425     */
13426    EAPI void                         elm_web_console_message_hook_set(Evas_Object *obj, Elm_Web_Console_Message func, void *data);
13427    /**
13428     * Gets the status of the tab propagation
13429     *
13430     * @param obj The web object to query
13431     * @return EINA_TRUE if tab propagation is enabled, EINA_FALSE otherwise
13432     *
13433     * @see elm_web_tab_propagate_set()
13434     */
13435    EAPI Eina_Bool                    elm_web_tab_propagate_get(const Evas_Object *obj);
13436    /**
13437     * Sets whether to use tab propagation
13438     *
13439     * If tab propagation is enabled, whenever the user presses the Tab key,
13440     * Elementary will handle it and switch focus to the next widget.
13441     * The default value is disabled, where WebKit will handle the Tab key to
13442     * cycle focus though its internal objects, jumping to the next widget
13443     * only when that cycle ends.
13444     *
13445     * @param obj The web object
13446     * @param propagate Whether to propagate Tab keys to Elementary or not
13447     */
13448    EAPI void                         elm_web_tab_propagate_set(Evas_Object *obj, Eina_Bool propagate);
13449    /**
13450     * Sets the URI for the web object
13451     *
13452     * It must be a full URI, with resource included, in the form
13453     * http://www.enlightenment.org or file:///tmp/something.html
13454     *
13455     * @param obj The web object
13456     * @param uri The URI to set
13457     * @return EINA_TRUE if the URI could be, EINA_FALSE if an error occurred
13458     */
13459    EAPI Eina_Bool                    elm_web_uri_set(Evas_Object *obj, const char *uri);
13460    /**
13461     * Gets the current URI for the object
13462     *
13463     * The returned string must not be freed and is guaranteed to be
13464     * stringshared.
13465     *
13466     * @param obj The web object
13467     * @return A stringshared internal string with the current URI, or NULL on
13468     * failure
13469     */
13470    EAPI const char                  *elm_web_uri_get(const Evas_Object *obj);
13471    /**
13472     * Gets the current title
13473     *
13474     * The returned string must not be freed and is guaranteed to be
13475     * stringshared.
13476     *
13477     * @param obj The web object
13478     * @return A stringshared internal string with the current title, or NULL on
13479     * failure
13480     */
13481    EAPI const char                  *elm_web_title_get(const Evas_Object *obj);
13482    /**
13483     * Sets the background color to be used by the web object
13484     *
13485     * This is the color that will be used by default when the loaded page
13486     * does not set it's own. Color values are pre-multiplied.
13487     *
13488     * @param obj The web object
13489     * @param r Red component
13490     * @param g Green component
13491     * @param b Blue component
13492     * @param a Alpha component
13493     */
13494    EAPI void                         elm_web_bg_color_set(Evas_Object *obj, int r, int g, int b, int a);
13495    /**
13496     * Gets the background color to be used by the web object
13497     *
13498     * This is the color that will be used by default when the loaded page
13499     * does not set it's own. Color values are pre-multiplied.
13500     *
13501     * @param obj The web object
13502     * @param r Red component
13503     * @param g Green component
13504     * @param b Blue component
13505     * @param a Alpha component
13506     */
13507    EAPI void                         elm_web_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b, int *a);
13508    /**
13509     * Gets a copy of the currently selected text
13510     *
13511     * The string returned must be freed by the user when it's done with it.
13512     *
13513     * @param obj The web object
13514     * @return A newly allocated string, or NULL if nothing is selected or an
13515     * error occurred
13516     */
13517    EAPI char                        *elm_view_selection_get(const Evas_Object *obj);
13518    /**
13519     * Tells the web object which index in the currently open popup was selected
13520     *
13521     * When the user handles the popup creation from the "popup,created" signal,
13522     * it needs to tell the web object which item was selected by calling this
13523     * function with the index corresponding to the item.
13524     *
13525     * @param obj The web object
13526     * @param index The index selected
13527     *
13528     * @see elm_web_popup_destroy()
13529     */
13530    EAPI void                         elm_web_popup_selected_set(Evas_Object *obj, int index);
13531    /**
13532     * Dismisses an open dropdown popup
13533     *
13534     * When the popup from a dropdown widget is to be dismissed, either after
13535     * selecting an option or to cancel it, this function must be called, which
13536     * will later emit an "popup,willdelete" signal to notify the user that
13537     * any memory and objects related to this popup can be freed.
13538     *
13539     * @param obj The web object
13540     * @return EINA_TRUE if the menu was successfully destroyed, or EINA_FALSE
13541     * if there was no menu to destroy
13542     */
13543    EAPI Eina_Bool                    elm_web_popup_destroy(Evas_Object *obj);
13544    /**
13545     * Searches the given string in a document.
13546     *
13547     * @param obj The web object where to search the text
13548     * @param string String to search
13549     * @param case_sensitive If search should be case sensitive or not
13550     * @param forward If search is from cursor and on or backwards
13551     * @param wrap If search should wrap at the end
13552     *
13553     * @return @c EINA_TRUE if the given string was found, @c EINA_FALSE if not
13554     * or failure
13555     */
13556    EAPI Eina_Bool                    elm_web_text_search(const Evas_Object *obj, const char *string, Eina_Bool case_sensitive, Eina_Bool forward, Eina_Bool wrap);
13557    /**
13558     * Marks matches of the given string in a document.
13559     *
13560     * @param obj The web object where to search text
13561     * @param string String to match
13562     * @param case_sensitive If match should be case sensitive or not
13563     * @param highlight If matches should be highlighted
13564     * @param limit Maximum amount of matches, or zero to unlimited
13565     *
13566     * @return number of matched @a string
13567     */
13568    EAPI unsigned int                 elm_web_text_matches_mark(Evas_Object *obj, const char *string, Eina_Bool case_sensitive, Eina_Bool highlight, unsigned int limit);
13569    /**
13570     * Clears all marked matches in the document
13571     *
13572     * @param obj The web object
13573     *
13574     * @return EINA_TRUE on success, EINA_FALSE otherwise
13575     */
13576    EAPI Eina_Bool                    elm_web_text_matches_unmark_all(Evas_Object *obj);
13577    /**
13578     * Sets whether to highlight the matched marks
13579     *
13580     * If enabled, marks set with elm_web_text_matches_mark() will be
13581     * highlighted.
13582     *
13583     * @param obj The web object
13584     * @param highlight Whether to highlight the marks or not
13585     *
13586     * @return EINA_TRUE on success, EINA_FALSE otherwise
13587     */
13588    EAPI Eina_Bool                    elm_web_text_matches_highlight_set(Evas_Object *obj, Eina_Bool highlight);
13589    /**
13590     * Gets whether highlighting marks is enabled
13591     *
13592     * @param The web object
13593     *
13594     * @return EINA_TRUE is marks are set to be highlighted, EINA_FALSE
13595     * otherwise
13596     */
13597    EAPI Eina_Bool                    elm_web_text_matches_highlight_get(const Evas_Object *obj);
13598    /**
13599     * Gets the overall loading progress of the page
13600     *
13601     * Returns the estimated loading progress of the page, with a value between
13602     * 0.0 and 1.0. This is an estimated progress accounting for all the frames
13603     * included in the page.
13604     *
13605     * @param The web object
13606     *
13607     * @return A value between 0.0 and 1.0 indicating the progress, or -1.0 on
13608     * failure
13609     */
13610    EAPI double                       elm_web_load_progress_get(const Evas_Object *obj);
13611    /**
13612     * Stops loading the current page
13613     *
13614     * Cancels the loading of the current page in the web object. This will
13615     * cause a "load,error" signal to be emitted, with the is_cancellation
13616     * flag set to EINA_TRUE.
13617     *
13618     * @param obj The web object
13619     *
13620     * @return EINA_TRUE if the cancel was successful, EINA_FALSE otherwise
13621     */
13622    EAPI Eina_Bool                    elm_web_stop(Evas_Object *obj);
13623    /**
13624     * Requests a reload of the current document in the object
13625     *
13626     * @param obj The web object
13627     *
13628     * @return EINA_TRUE on success, EINA_FALSE otherwise
13629     */
13630    EAPI Eina_Bool                    elm_web_reload(Evas_Object *obj);
13631    /**
13632     * Requests a reload of the current document, avoiding any existing caches
13633     *
13634     * @param obj The web object
13635     *
13636     * @return EINA_TRUE on success, EINA_FALSE otherwise
13637     */
13638    EAPI Eina_Bool                    elm_web_reload_full(Evas_Object *obj);
13639    /**
13640     * Goes back one step in the browsing history
13641     *
13642     * This is equivalent to calling elm_web_object_navigate(obj, -1);
13643     *
13644     * @param obj The web object
13645     *
13646     * @return EINA_TRUE on success, EINA_FALSE otherwise
13647     *
13648     * @see elm_web_history_enable_set()
13649     * @see elm_web_back_possible()
13650     * @see elm_web_forward()
13651     * @see elm_web_navigate()
13652     */
13653    EAPI Eina_Bool                    elm_web_back(Evas_Object *obj);
13654    /**
13655     * Goes forward one step in the browsing history
13656     *
13657     * This is equivalent to calling elm_web_object_navigate(obj, 1);
13658     *
13659     * @param obj The web object
13660     *
13661     * @return EINA_TRUE on success, EINA_FALSE otherwise
13662     *
13663     * @see elm_web_history_enable_set()
13664     * @see elm_web_forward_possible()
13665     * @see elm_web_back()
13666     * @see elm_web_navigate()
13667     */
13668    EAPI Eina_Bool                    elm_web_forward(Evas_Object *obj);
13669    /**
13670     * Jumps the given number of steps in the browsing history
13671     *
13672     * The @p steps value can be a negative integer to back in history, or a
13673     * positive to move forward.
13674     *
13675     * @param obj The web object
13676     * @param steps The number of steps to jump
13677     *
13678     * @return EINA_TRUE on success, EINA_FALSE on error or if not enough
13679     * history exists to jump the given number of steps
13680     *
13681     * @see elm_web_history_enable_set()
13682     * @see elm_web_navigate_possible()
13683     * @see elm_web_back()
13684     * @see elm_web_forward()
13685     */
13686    EAPI Eina_Bool                    elm_web_navigate(Evas_Object *obj, int steps);
13687    /**
13688     * Queries whether it's possible to go back in history
13689     *
13690     * @param obj The web object
13691     *
13692     * @return EINA_TRUE if it's possible to back in history, EINA_FALSE
13693     * otherwise
13694     */
13695    EAPI Eina_Bool                    elm_web_back_possible(Evas_Object *obj);
13696    /**
13697     * Queries whether it's possible to go forward in history
13698     *
13699     * @param obj The web object
13700     *
13701     * @return EINA_TRUE if it's possible to forward in history, EINA_FALSE
13702     * otherwise
13703     */
13704    EAPI Eina_Bool                    elm_web_forward_possible(Evas_Object *obj);
13705    /**
13706     * Queries whether it's possible to jump the given number of steps
13707     *
13708     * The @p steps value can be a negative integer to back in history, or a
13709     * positive to move forward.
13710     *
13711     * @param obj The web object
13712     * @param steps The number of steps to check for
13713     *
13714     * @return EINA_TRUE if enough history exists to perform the given jump,
13715     * EINA_FALSE otherwise
13716     */
13717    EAPI Eina_Bool                    elm_web_navigate_possible(Evas_Object *obj, int steps);
13718    /**
13719     * Gets whether browsing history is enabled for the given object
13720     *
13721     * @param obj The web object
13722     *
13723     * @return EINA_TRUE if history is enabled, EINA_FALSE otherwise
13724     */
13725    EAPI Eina_Bool                    elm_web_history_enable_get(const Evas_Object *obj);
13726    /**
13727     * Enables or disables the browsing history
13728     *
13729     * @param obj The web object
13730     * @param enable Whether to enable or disable the browsing history
13731     */
13732    EAPI void                         elm_web_history_enable_set(Evas_Object *obj, Eina_Bool enable);
13733    /**
13734     * Sets the zoom level of the web object
13735     *
13736     * Zoom level matches the Webkit API, so 1.0 means normal zoom, with higher
13737     * values meaning zoom in and lower meaning zoom out. This function will
13738     * only affect the zoom level if the mode set with elm_web_zoom_mode_set()
13739     * is ::ELM_WEB_ZOOM_MODE_MANUAL.
13740     *
13741     * @param obj The web object
13742     * @param zoom The zoom level to set
13743     */
13744    EAPI void                         elm_web_zoom_set(Evas_Object *obj, double zoom);
13745    /**
13746     * Gets the current zoom level set on the web object
13747     *
13748     * Note that this is the zoom level set on the web object and not that
13749     * of the underlying Webkit one. In the ::ELM_WEB_ZOOM_MODE_MANUAL mode,
13750     * the two zoom levels should match, but for the other two modes the
13751     * Webkit zoom is calculated internally to match the chosen mode without
13752     * changing the zoom level set for the web object.
13753     *
13754     * @param obj The web object
13755     *
13756     * @return The zoom level set on the object
13757     */
13758    EAPI double                       elm_web_zoom_get(const Evas_Object *obj);
13759    /**
13760     * Sets the zoom mode to use
13761     *
13762     * The modes can be any of those defined in ::Elm_Web_Zoom_Mode, except
13763     * ::ELM_WEB_ZOOM_MODE_LAST. The default is ::ELM_WEB_ZOOM_MODE_MANUAL.
13764     *
13765     * ::ELM_WEB_ZOOM_MODE_MANUAL means the zoom level will be controlled
13766     * with the elm_web_zoom_set() function.
13767     * ::ELM_WEB_ZOOM_MODE_AUTO_FIT will calculate the needed zoom level to
13768     * make sure the entirety of the web object's contents are shown.
13769     * ::ELM_WEB_ZOOM_MODE_AUTO_FILL will calculate the needed zoom level to
13770     * fit the contents in the web object's size, without leaving any space
13771     * unused.
13772     *
13773     * @param obj The web object
13774     * @param mode The mode to set
13775     */
13776    EAPI void                         elm_web_zoom_mode_set(Evas_Object *obj, Elm_Web_Zoom_Mode mode);
13777    /**
13778     * Gets the currently set zoom mode
13779     *
13780     * @param obj The web object
13781     *
13782     * @return The current zoom mode set for the object, or
13783     * ::ELM_WEB_ZOOM_MODE_LAST on error
13784     */
13785    EAPI Elm_Web_Zoom_Mode            elm_web_zoom_mode_get(const Evas_Object *obj);
13786    /**
13787     * Shows the given region in the web object
13788     *
13789     * @param obj The web object
13790     * @param x The x coordinate of the region to show
13791     * @param y The y coordinate of the region to show
13792     * @param w The width of the region to show
13793     * @param h The height of the region to show
13794     */
13795    EAPI void                         elm_web_region_show(Evas_Object *obj, int x, int y, int w, int h);
13796    /**
13797     * Brings in the region to the visible area
13798     *
13799     * Like elm_web_region_show(), but it animates the scrolling of the object
13800     * to show the area
13801     *
13802     * @param obj The web object
13803     * @param x The x coordinate of the region to show
13804     * @param y The y coordinate of the region to show
13805     * @param w The width of the region to show
13806     * @param h The height of the region to show
13807     */
13808    EAPI void                         elm_web_region_bring_in(Evas_Object *obj, int x, int y, int w, int h);
13809    /**
13810     * Sets the default dialogs to use an Inwin instead of a normal window
13811     *
13812     * If set, then the default implementation for the JavaScript dialogs and
13813     * file selector will be opened in an Inwin. Otherwise they will use a
13814     * normal separated window.
13815     *
13816     * @param obj The web object
13817     * @param value EINA_TRUE to use Inwin, EINA_FALSE to use a normal window
13818     */
13819    EAPI void                         elm_web_inwin_mode_set(Evas_Object *obj, Eina_Bool value);
13820    /**
13821     * Gets whether Inwin mode is set for the current object
13822     *
13823     * @param obj The web object
13824     *
13825     * @return EINA_TRUE if Inwin mode is set, EINA_FALSE otherwise
13826     */
13827    EAPI Eina_Bool                    elm_web_inwin_mode_get(const Evas_Object *obj);
13828
13829    EAPI void                         elm_web_window_features_ref(Elm_Web_Window_Features *wf);
13830    EAPI void                         elm_web_window_features_unref(Elm_Web_Window_Features *wf);
13831    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);
13832    EAPI void                         elm_web_window_features_int_property_get(const Elm_Web_Window_Features *wf, int *x, int *y, int *w, int *h);
13833
13834    /**
13835     * @}
13836     */
13837 #endif
13838
13839    /**
13840     * @defgroup Hoversel Hoversel
13841     *
13842     * @image html img/widget/hoversel/preview-00.png
13843     * @image latex img/widget/hoversel/preview-00.eps
13844     *
13845     * A hoversel is a button that pops up a list of items (automatically
13846     * choosing the direction to display) that have a label and, optionally, an
13847     * icon to select from. It is a convenience widget to avoid the need to do
13848     * all the piecing together yourself. It is intended for a small number of
13849     * items in the hoversel menu (no more than 8), though is capable of many
13850     * more.
13851     *
13852     * Signals that you can add callbacks for are:
13853     * "clicked" - the user clicked the hoversel button and popped up the sel
13854     * "selected" - an item in the hoversel list is selected. event_info is the item
13855     * "dismissed" - the hover is dismissed
13856     *
13857     * See @ref tutorial_hoversel for an example.
13858     * @{
13859     */
13860    typedef struct _Elm_Hoversel_Item Elm_Hoversel_Item; /**< Item of Elm_Hoversel. Sub-type of Elm_Widget_Item */
13861    /**
13862     * @brief Add a new Hoversel object
13863     *
13864     * @param parent The parent object
13865     * @return The new object or NULL if it cannot be created
13866     */
13867    EAPI Evas_Object       *elm_hoversel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13868    /**
13869     * @brief This sets the hoversel to expand horizontally.
13870     *
13871     * @param obj The hoversel object
13872     * @param horizontal If true, the hover will expand horizontally to the
13873     * right.
13874     *
13875     * @note The initial button will display horizontally regardless of this
13876     * setting.
13877     */
13878    EAPI void               elm_hoversel_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
13879    /**
13880     * @brief This returns whether the hoversel is set to expand horizontally.
13881     *
13882     * @param obj The hoversel object
13883     * @return If true, the hover will expand horizontally to the right.
13884     *
13885     * @see elm_hoversel_horizontal_set()
13886     */
13887    EAPI Eina_Bool          elm_hoversel_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13888    /**
13889     * @brief Set the Hover parent
13890     *
13891     * @param obj The hoversel object
13892     * @param parent The parent to use
13893     *
13894     * Sets the hover parent object, the area that will be darkened when the
13895     * hoversel is clicked. Should probably be the window that the hoversel is
13896     * in. See @ref Hover objects for more information.
13897     */
13898    EAPI void               elm_hoversel_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
13899    /**
13900     * @brief Get the Hover parent
13901     *
13902     * @param obj The hoversel object
13903     * @return The used parent
13904     *
13905     * Gets the hover parent object.
13906     *
13907     * @see elm_hoversel_hover_parent_set()
13908     */
13909    EAPI Evas_Object       *elm_hoversel_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13910    /**
13911     * @brief Set the hoversel button label
13912     *
13913     * @param obj The hoversel object
13914     * @param label The label text.
13915     *
13916     * This sets the label of the button that is always visible (before it is
13917     * clicked and expanded).
13918     *
13919     * @deprecated elm_object_text_set()
13920     */
13921    EINA_DEPRECATED EAPI void               elm_hoversel_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
13922    /**
13923     * @brief Get the hoversel button label
13924     *
13925     * @param obj The hoversel object
13926     * @return The label text.
13927     *
13928     * @deprecated elm_object_text_get()
13929     */
13930    EINA_DEPRECATED EAPI const char        *elm_hoversel_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13931    /**
13932     * @brief Set the icon of the hoversel button
13933     *
13934     * @param obj The hoversel object
13935     * @param icon The icon object
13936     *
13937     * Sets the icon of the button that is always visible (before it is clicked
13938     * and expanded).  Once the icon object is set, a previously set one will be
13939     * deleted, if you want to keep that old content object, use the
13940     * elm_hoversel_icon_unset() function.
13941     *
13942     * @see elm_object_content_set() for the button widget
13943     */
13944    EAPI void               elm_hoversel_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
13945    /**
13946     * @brief Get the icon of the hoversel button
13947     *
13948     * @param obj The hoversel object
13949     * @return The icon object
13950     *
13951     * Get the icon of the button that is always visible (before it is clicked
13952     * and expanded). Also see elm_object_content_get() for the button widget.
13953     *
13954     * @see elm_hoversel_icon_set()
13955     */
13956    EAPI Evas_Object       *elm_hoversel_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13957    /**
13958     * @brief Get and unparent the icon of the hoversel button
13959     *
13960     * @param obj The hoversel object
13961     * @return The icon object that was being used
13962     *
13963     * Unparent and return the icon of the button that is always visible
13964     * (before it is clicked and expanded).
13965     *
13966     * @see elm_hoversel_icon_set()
13967     * @see elm_object_content_unset() for the button widget
13968     */
13969    EAPI Evas_Object       *elm_hoversel_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
13970    /**
13971     * @brief This triggers the hoversel popup from code, the same as if the user
13972     * had clicked the button.
13973     *
13974     * @param obj The hoversel object
13975     */
13976    EAPI void               elm_hoversel_hover_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
13977    /**
13978     * @brief This dismisses the hoversel popup as if the user had clicked
13979     * outside the hover.
13980     *
13981     * @param obj The hoversel object
13982     */
13983    EAPI void               elm_hoversel_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
13984    /**
13985     * @brief Returns whether the hoversel is expanded.
13986     *
13987     * @param obj The hoversel object
13988     * @return  This will return EINA_TRUE if the hoversel is expanded or
13989     * EINA_FALSE if it is not expanded.
13990     */
13991    EAPI Eina_Bool          elm_hoversel_expanded_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13992    /**
13993     * @brief This will remove all the children items from the hoversel.
13994     *
13995     * @param obj The hoversel object
13996     *
13997     * @warning Should @b not be called while the hoversel is active; use
13998     * elm_hoversel_expanded_get() to check first.
13999     *
14000     * @see elm_hoversel_item_del_cb_set()
14001     * @see elm_hoversel_item_del()
14002     */
14003    EAPI void               elm_hoversel_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
14004    /**
14005     * @brief Get the list of items within the given hoversel.
14006     *
14007     * @param obj The hoversel object
14008     * @return Returns a list of Elm_Hoversel_Item*
14009     *
14010     * @see elm_hoversel_item_add()
14011     */
14012    EAPI const Eina_List   *elm_hoversel_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14013    /**
14014     * @brief Add an item to the hoversel button
14015     *
14016     * @param obj The hoversel object
14017     * @param label The text label to use for the item (NULL if not desired)
14018     * @param icon_file An image file path on disk to use for the icon or standard
14019     * icon name (NULL if not desired)
14020     * @param icon_type The icon type if relevant
14021     * @param func Convenience function to call when this item is selected
14022     * @param data Data to pass to item-related functions
14023     * @return A handle to the item added.
14024     *
14025     * This adds an item to the hoversel to show when it is clicked. Note: if you
14026     * need to use an icon from an edje file then use
14027     * elm_hoversel_item_icon_set() right after the this function, and set
14028     * icon_file to NULL here.
14029     *
14030     * For more information on what @p icon_file and @p icon_type are see the
14031     * @ref Icon "icon documentation".
14032     */
14033    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);
14034    /**
14035     * @brief Delete an item from the hoversel
14036     *
14037     * @param item The item to delete
14038     *
14039     * This deletes the item from the hoversel (should not be called while the
14040     * hoversel is active; use elm_hoversel_expanded_get() to check first).
14041     *
14042     * @see elm_hoversel_item_add()
14043     * @see elm_hoversel_item_del_cb_set()
14044     */
14045    EAPI void               elm_hoversel_item_del(Elm_Hoversel_Item *item) EINA_ARG_NONNULL(1);
14046    /**
14047     * @brief Set the function to be called when an item from the hoversel is
14048     * freed.
14049     *
14050     * @param item The item to set the callback on
14051     * @param func The function called
14052     *
14053     * That function will receive these parameters:
14054     * @li void *item_data
14055     * @li Evas_Object *the_item_object
14056     * @li Elm_Hoversel_Item *the_object_struct
14057     *
14058     * @see elm_hoversel_item_add()
14059     */
14060    EAPI void               elm_hoversel_item_del_cb_set(Elm_Hoversel_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
14061    /**
14062     * @brief This returns the data pointer supplied with elm_hoversel_item_add()
14063     * that will be passed to associated function callbacks.
14064     *
14065     * @param item The item to get the data from
14066     * @return The data pointer set with elm_hoversel_item_add()
14067     *
14068     * @see elm_hoversel_item_add()
14069     */
14070    EAPI void              *elm_hoversel_item_data_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
14071    /**
14072     * @brief This returns the label text of the given hoversel item.
14073     *
14074     * @param item The item to get the label
14075     * @return The label text of the hoversel item
14076     *
14077     * @see elm_hoversel_item_add()
14078     */
14079    EAPI const char        *elm_hoversel_item_label_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
14080    /**
14081     * @brief This sets the icon for the given hoversel item.
14082     *
14083     * @param item The item to set the icon
14084     * @param icon_file An image file path on disk to use for the icon or standard
14085     * icon name
14086     * @param icon_group The edje group to use if @p icon_file is an edje file. Set this
14087     * to NULL if the icon is not an edje file
14088     * @param icon_type The icon type
14089     *
14090     * The icon can be loaded from the standard set, from an image file, or from
14091     * an edje file.
14092     *
14093     * @see elm_hoversel_item_add()
14094     */
14095    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);
14096    /**
14097     * @brief Get the icon object of the hoversel item
14098     *
14099     * @param item The item to get the icon from
14100     * @param icon_file The image file path on disk used for the icon or standard
14101     * icon name
14102     * @param icon_group The edje group used if @p icon_file is an edje file. NULL
14103     * if the icon is not an edje file
14104     * @param icon_type The icon type
14105     *
14106     * @see elm_hoversel_item_icon_set()
14107     * @see elm_hoversel_item_add()
14108     */
14109    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);
14110    /**
14111     * @}
14112     */
14113
14114    /**
14115     * @defgroup Toolbar Toolbar
14116     * @ingroup Elementary
14117     *
14118     * @image html img/widget/toolbar/preview-00.png
14119     * @image latex img/widget/toolbar/preview-00.eps width=\textwidth
14120     *
14121     * @image html img/toolbar.png
14122     * @image latex img/toolbar.eps width=\textwidth
14123     *
14124     * A toolbar is a widget that displays a list of items inside
14125     * a box. It can be scrollable, show a menu with items that don't fit
14126     * to toolbar size or even crop them.
14127     *
14128     * Only one item can be selected at a time.
14129     *
14130     * Items can have multiple states, or show menus when selected by the user.
14131     *
14132     * Smart callbacks one can listen to:
14133     * - "clicked" - when the user clicks on a toolbar item and becomes selected.
14134     * - "language,changed" - when the program language changes
14135     *
14136     * Available styles for it:
14137     * - @c "default"
14138     * - @c "transparent" - no background or shadow, just show the content
14139     *
14140     * List of examples:
14141     * @li @ref toolbar_example_01
14142     * @li @ref toolbar_example_02
14143     * @li @ref toolbar_example_03
14144     */
14145
14146    /**
14147     * @addtogroup Toolbar
14148     * @{
14149     */
14150
14151    /**
14152     * @enum _Elm_Toolbar_Shrink_Mode
14153     * @typedef Elm_Toolbar_Shrink_Mode
14154     *
14155     * Set toolbar's items display behavior, it can be scrollabel,
14156     * show a menu with exceeding items, or simply hide them.
14157     *
14158     * @note Default value is #ELM_TOOLBAR_SHRINK_MENU. It reads value
14159     * from elm config.
14160     *
14161     * Values <b> don't </b> work as bitmask, only one can be choosen.
14162     *
14163     * @see elm_toolbar_mode_shrink_set()
14164     * @see elm_toolbar_mode_shrink_get()
14165     *
14166     * @ingroup Toolbar
14167     */
14168    typedef enum _Elm_Toolbar_Shrink_Mode
14169      {
14170         ELM_TOOLBAR_SHRINK_NONE,   /**< Set toolbar minimun size to fit all the items. */
14171         ELM_TOOLBAR_SHRINK_HIDE,   /**< Hide exceeding items. */
14172         ELM_TOOLBAR_SHRINK_SCROLL, /**< Allow accessing exceeding items through a scroller. */
14173         ELM_TOOLBAR_SHRINK_MENU,   /**< Inserts a button to pop up a menu with exceeding items. */
14174      } Elm_Toolbar_Shrink_Mode;
14175
14176    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(). */
14177
14178    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(). */
14179
14180    /**
14181     * Add a new toolbar widget to the given parent Elementary
14182     * (container) object.
14183     *
14184     * @param parent The parent object.
14185     * @return a new toolbar widget handle or @c NULL, on errors.
14186     *
14187     * This function inserts a new toolbar widget on the canvas.
14188     *
14189     * @ingroup Toolbar
14190     */
14191    EAPI Evas_Object            *elm_toolbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14192
14193    /**
14194     * Set the icon size, in pixels, to be used by toolbar items.
14195     *
14196     * @param obj The toolbar object
14197     * @param icon_size The icon size in pixels
14198     *
14199     * @note Default value is @c 32. It reads value from elm config.
14200     *
14201     * @see elm_toolbar_icon_size_get()
14202     *
14203     * @ingroup Toolbar
14204     */
14205    EAPI void                    elm_toolbar_icon_size_set(Evas_Object *obj, int icon_size) EINA_ARG_NONNULL(1);
14206
14207    /**
14208     * Get the icon size, in pixels, to be used by toolbar items.
14209     *
14210     * @param obj The toolbar object.
14211     * @return The icon size in pixels.
14212     *
14213     * @see elm_toolbar_icon_size_set() for details.
14214     *
14215     * @ingroup Toolbar
14216     */
14217    EAPI int                     elm_toolbar_icon_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14218
14219    /**
14220     * Sets icon lookup order, for toolbar items' icons.
14221     *
14222     * @param obj The toolbar object.
14223     * @param order The icon lookup order.
14224     *
14225     * Icons added before calling this function will not be affected.
14226     * The default lookup order is #ELM_ICON_LOOKUP_THEME_FDO.
14227     *
14228     * @see elm_toolbar_icon_order_lookup_get()
14229     *
14230     * @ingroup Toolbar
14231     */
14232    EAPI void                    elm_toolbar_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
14233
14234    /**
14235     * Gets the icon lookup order.
14236     *
14237     * @param obj The toolbar object.
14238     * @return The icon lookup order.
14239     *
14240     * @see elm_toolbar_icon_order_lookup_set() for details.
14241     *
14242     * @ingroup Toolbar
14243     */
14244    EAPI Elm_Icon_Lookup_Order   elm_toolbar_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14245
14246    /**
14247     * Set whether the toolbar items' should be selected by the user or not.
14248     *
14249     * @param obj The toolbar object.
14250     * @param wrap @c EINA_TRUE to disable selection or @c EINA_FALSE to
14251     * enable it.
14252     *
14253     * This will turn off the ability to select items entirely and they will
14254     * neither appear selected nor emit selected signals. The clicked
14255     * callback function will still be called.
14256     *
14257     * Selection is enabled by default.
14258     *
14259     * @see elm_toolbar_no_select_mode_get().
14260     *
14261     * @ingroup Toolbar
14262     */
14263    EAPI void                    elm_toolbar_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
14264
14265    /**
14266     * Set whether the toolbar items' should be selected by the user or not.
14267     *
14268     * @param obj The toolbar object.
14269     * @return @c EINA_TRUE means items can be selected. @c EINA_FALSE indicates
14270     * they can't. If @p obj is @c NULL, @c EINA_FALSE is returned.
14271     *
14272     * @see elm_toolbar_no_select_mode_set() for details.
14273     *
14274     * @ingroup Toolbar
14275     */
14276    EAPI Eina_Bool               elm_toolbar_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14277
14278    /**
14279     * Append item to the toolbar.
14280     *
14281     * @param obj The toolbar object.
14282     * @param icon A string with icon name or the absolute path of an image file.
14283     * @param label The label of the item.
14284     * @param func The function to call when the item is clicked.
14285     * @param data The data to associate with the item for related callbacks.
14286     * @return The created item or @c NULL upon failure.
14287     *
14288     * A new item will be created and appended to the toolbar, i.e., will
14289     * be set as @b last item.
14290     *
14291     * Items created with this method can be deleted with
14292     * elm_toolbar_item_del().
14293     *
14294     * Associated @p data can be properly freed when item is deleted if a
14295     * callback function is set with elm_toolbar_item_del_cb_set().
14296     *
14297     * If a function is passed as argument, it will be called everytime this item
14298     * is selected, i.e., the user clicks over an unselected item.
14299     * If such function isn't needed, just passing
14300     * @c NULL as @p func is enough. The same should be done for @p data.
14301     *
14302     * Toolbar will load icon image from fdo or current theme.
14303     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14304     * If an absolute path is provided it will load it direct from a file.
14305     *
14306     * @see elm_toolbar_item_icon_set()
14307     * @see elm_toolbar_item_del()
14308     * @see elm_toolbar_item_del_cb_set()
14309     *
14310     * @ingroup Toolbar
14311     */
14312    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);
14313
14314    /**
14315     * Prepend item to the toolbar.
14316     *
14317     * @param obj The toolbar object.
14318     * @param icon A string with icon name or the absolute path of an image file.
14319     * @param label The label of the item.
14320     * @param func The function to call when the item is clicked.
14321     * @param data The data to associate with the item for related callbacks.
14322     * @return The created item or @c NULL upon failure.
14323     *
14324     * A new item will be created and prepended to the toolbar, i.e., will
14325     * be set as @b first item.
14326     *
14327     * Items created with this method can be deleted with
14328     * elm_toolbar_item_del().
14329     *
14330     * Associated @p data can be properly freed when item is deleted if a
14331     * callback function is set with elm_toolbar_item_del_cb_set().
14332     *
14333     * If a function is passed as argument, it will be called everytime this item
14334     * is selected, i.e., the user clicks over an unselected item.
14335     * If such function isn't needed, just passing
14336     * @c NULL as @p func is enough. The same should be done for @p data.
14337     *
14338     * Toolbar will load icon image from fdo or current theme.
14339     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14340     * If an absolute path is provided it will load it direct from a file.
14341     *
14342     * @see elm_toolbar_item_icon_set()
14343     * @see elm_toolbar_item_del()
14344     * @see elm_toolbar_item_del_cb_set()
14345     *
14346     * @ingroup Toolbar
14347     */
14348    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);
14349
14350    /**
14351     * Insert a new item into the toolbar object before item @p before.
14352     *
14353     * @param obj The toolbar object.
14354     * @param before The toolbar item to insert before.
14355     * @param icon A string with icon name or the absolute path of an image file.
14356     * @param label The label of the item.
14357     * @param func The function to call when the item is clicked.
14358     * @param data The data to associate with the item for related callbacks.
14359     * @return The created item or @c NULL upon failure.
14360     *
14361     * A new item will be created and added to the toolbar. Its position in
14362     * this toolbar will be just before item @p before.
14363     *
14364     * Items created with this method can be deleted with
14365     * elm_toolbar_item_del().
14366     *
14367     * Associated @p data can be properly freed when item is deleted if a
14368     * callback function is set with elm_toolbar_item_del_cb_set().
14369     *
14370     * If a function is passed as argument, it will be called everytime this item
14371     * is selected, i.e., the user clicks over an unselected item.
14372     * If such function isn't needed, just passing
14373     * @c NULL as @p func is enough. The same should be done for @p data.
14374     *
14375     * Toolbar will load icon image from fdo or current theme.
14376     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14377     * If an absolute path is provided it will load it direct from a file.
14378     *
14379     * @see elm_toolbar_item_icon_set()
14380     * @see elm_toolbar_item_del()
14381     * @see elm_toolbar_item_del_cb_set()
14382     *
14383     * @ingroup Toolbar
14384     */
14385    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);
14386
14387    /**
14388     * Insert a new item into the toolbar object after item @p after.
14389     *
14390     * @param obj The toolbar object.
14391     * @param after The toolbar item to insert after.
14392     * @param icon A string with icon name or the absolute path of an image file.
14393     * @param label The label of the item.
14394     * @param func The function to call when the item is clicked.
14395     * @param data The data to associate with the item for related callbacks.
14396     * @return The created item or @c NULL upon failure.
14397     *
14398     * A new item will be created and added to the toolbar. Its position in
14399     * this toolbar will be just after item @p after.
14400     *
14401     * Items created with this method can be deleted with
14402     * elm_toolbar_item_del().
14403     *
14404     * Associated @p data can be properly freed when item is deleted if a
14405     * callback function is set with elm_toolbar_item_del_cb_set().
14406     *
14407     * If a function is passed as argument, it will be called everytime this item
14408     * is selected, i.e., the user clicks over an unselected item.
14409     * If such function isn't needed, just passing
14410     * @c NULL as @p func is enough. The same should be done for @p data.
14411     *
14412     * Toolbar will load icon image from fdo or current theme.
14413     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14414     * If an absolute path is provided it will load it direct from a file.
14415     *
14416     * @see elm_toolbar_item_icon_set()
14417     * @see elm_toolbar_item_del()
14418     * @see elm_toolbar_item_del_cb_set()
14419     *
14420     * @ingroup Toolbar
14421     */
14422    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);
14423
14424    /**
14425     * Get the first item in the given toolbar widget's list of
14426     * items.
14427     *
14428     * @param obj The toolbar object
14429     * @return The first item or @c NULL, if it has no items (and on
14430     * errors)
14431     *
14432     * @see elm_toolbar_item_append()
14433     * @see elm_toolbar_last_item_get()
14434     *
14435     * @ingroup Toolbar
14436     */
14437    EAPI Elm_Toolbar_Item       *elm_toolbar_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14438
14439    /**
14440     * Get the last item in the given toolbar widget's list of
14441     * items.
14442     *
14443     * @param obj The toolbar object
14444     * @return The last item or @c NULL, if it has no items (and on
14445     * errors)
14446     *
14447     * @see elm_toolbar_item_prepend()
14448     * @see elm_toolbar_first_item_get()
14449     *
14450     * @ingroup Toolbar
14451     */
14452    EAPI Elm_Toolbar_Item       *elm_toolbar_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14453
14454    /**
14455     * Get the item after @p item in toolbar.
14456     *
14457     * @param item The toolbar item.
14458     * @return The item after @p item, or @c NULL if none or on failure.
14459     *
14460     * @note If it is the last item, @c NULL will be returned.
14461     *
14462     * @see elm_toolbar_item_append()
14463     *
14464     * @ingroup Toolbar
14465     */
14466    EAPI Elm_Toolbar_Item       *elm_toolbar_item_next_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14467
14468    /**
14469     * Get the item before @p item in toolbar.
14470     *
14471     * @param item The toolbar item.
14472     * @return The item before @p item, or @c NULL if none or on failure.
14473     *
14474     * @note If it is the first item, @c NULL will be returned.
14475     *
14476     * @see elm_toolbar_item_prepend()
14477     *
14478     * @ingroup Toolbar
14479     */
14480    EAPI Elm_Toolbar_Item       *elm_toolbar_item_prev_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14481
14482    /**
14483     * Get the toolbar object from an item.
14484     *
14485     * @param item The item.
14486     * @return The toolbar object.
14487     *
14488     * This returns the toolbar object itself that an item belongs to.
14489     *
14490     * @ingroup Toolbar
14491     */
14492    EAPI Evas_Object            *elm_toolbar_item_toolbar_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14493
14494    /**
14495     * Set the priority of a toolbar item.
14496     *
14497     * @param item The toolbar item.
14498     * @param priority The item priority. The default is zero.
14499     *
14500     * This is used only when the toolbar shrink mode is set to
14501     * #ELM_TOOLBAR_SHRINK_MENU or #ELM_TOOLBAR_SHRINK_HIDE.
14502     * When space is less than required, items with low priority
14503     * will be removed from the toolbar and added to a dynamically-created menu,
14504     * while items with higher priority will remain on the toolbar,
14505     * with the same order they were added.
14506     *
14507     * @see elm_toolbar_item_priority_get()
14508     *
14509     * @ingroup Toolbar
14510     */
14511    EAPI void                    elm_toolbar_item_priority_set(Elm_Toolbar_Item *item, int priority) EINA_ARG_NONNULL(1);
14512
14513    /**
14514     * Get the priority of a toolbar item.
14515     *
14516     * @param item The toolbar item.
14517     * @return The @p item priority, or @c 0 on failure.
14518     *
14519     * @see elm_toolbar_item_priority_set() for details.
14520     *
14521     * @ingroup Toolbar
14522     */
14523    EAPI int                     elm_toolbar_item_priority_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14524
14525    /**
14526     * Get the label of item.
14527     *
14528     * @param item The item of toolbar.
14529     * @return The label of item.
14530     *
14531     * The return value is a pointer to the label associated to @p item when
14532     * it was created, with function elm_toolbar_item_append() or similar,
14533     * or later,
14534     * with function elm_toolbar_item_label_set. If no label
14535     * was passed as argument, it will return @c NULL.
14536     *
14537     * @see elm_toolbar_item_label_set() for more details.
14538     * @see elm_toolbar_item_append()
14539     *
14540     * @ingroup Toolbar
14541     */
14542    EAPI const char             *elm_toolbar_item_label_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14543
14544    /**
14545     * Set the label of item.
14546     *
14547     * @param item The item of toolbar.
14548     * @param text The label of item.
14549     *
14550     * The label to be displayed by the item.
14551     * Label will be placed at icons bottom (if set).
14552     *
14553     * If a label was passed as argument on item creation, with function
14554     * elm_toolbar_item_append() or similar, it will be already
14555     * displayed by the item.
14556     *
14557     * @see elm_toolbar_item_label_get()
14558     * @see elm_toolbar_item_append()
14559     *
14560     * @ingroup Toolbar
14561     */
14562    EAPI void                    elm_toolbar_item_label_set(Elm_Toolbar_Item *item, const char *label) EINA_ARG_NONNULL(1);
14563
14564    /**
14565     * Return the data associated with a given toolbar widget item.
14566     *
14567     * @param item The toolbar widget item handle.
14568     * @return The data associated with @p item.
14569     *
14570     * @see elm_toolbar_item_data_set()
14571     *
14572     * @ingroup Toolbar
14573     */
14574    EAPI void                   *elm_toolbar_item_data_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14575
14576    /**
14577     * Set the data associated with a given toolbar widget item.
14578     *
14579     * @param item The toolbar widget item handle.
14580     * @param data The new data pointer to set to @p item.
14581     *
14582     * This sets new item data on @p item.
14583     *
14584     * @warning The old data pointer won't be touched by this function, so
14585     * the user had better to free that old data himself/herself.
14586     *
14587     * @ingroup Toolbar
14588     */
14589    EAPI void                    elm_toolbar_item_data_set(Elm_Toolbar_Item *item, const void *data) EINA_ARG_NONNULL(1);
14590
14591    /**
14592     * Returns a pointer to a toolbar item by its label.
14593     *
14594     * @param obj The toolbar object.
14595     * @param label The label of the item to find.
14596     *
14597     * @return The pointer to the toolbar item matching @p label or @c NULL
14598     * on failure.
14599     *
14600     * @ingroup Toolbar
14601     */
14602    EAPI Elm_Toolbar_Item       *elm_toolbar_item_find_by_label(const Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
14603
14604    /*
14605     * Get whether the @p item is selected or not.
14606     *
14607     * @param item The toolbar item.
14608     * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
14609     * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
14610     *
14611     * @see elm_toolbar_selected_item_set() for details.
14612     * @see elm_toolbar_item_selected_get()
14613     *
14614     * @ingroup Toolbar
14615     */
14616    EAPI Eina_Bool               elm_toolbar_item_selected_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14617
14618    /**
14619     * Set the selected state of an item.
14620     *
14621     * @param item The toolbar item
14622     * @param selected The selected state
14623     *
14624     * This sets the selected state of the given item @p it.
14625     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
14626     *
14627     * If a new item is selected the previosly selected will be unselected.
14628     * Previoulsy selected item can be get with function
14629     * elm_toolbar_selected_item_get().
14630     *
14631     * Selected items will be highlighted.
14632     *
14633     * @see elm_toolbar_item_selected_get()
14634     * @see elm_toolbar_selected_item_get()
14635     *
14636     * @ingroup Toolbar
14637     */
14638    EAPI void                    elm_toolbar_item_selected_set(Elm_Toolbar_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
14639
14640    /**
14641     * Get the selected item.
14642     *
14643     * @param obj The toolbar object.
14644     * @return The selected toolbar item.
14645     *
14646     * The selected item can be unselected with function
14647     * elm_toolbar_item_selected_set().
14648     *
14649     * The selected item always will be highlighted on toolbar.
14650     *
14651     * @see elm_toolbar_selected_items_get()
14652     *
14653     * @ingroup Toolbar
14654     */
14655    EAPI Elm_Toolbar_Item       *elm_toolbar_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14656
14657    /**
14658     * Set the icon associated with @p item.
14659     *
14660     * @param obj The parent of this item.
14661     * @param item The toolbar item.
14662     * @param icon A string with icon name or the absolute path of an image file.
14663     *
14664     * Toolbar will load icon image from fdo or current theme.
14665     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14666     * If an absolute path is provided it will load it direct from a file.
14667     *
14668     * @see elm_toolbar_icon_order_lookup_set()
14669     * @see elm_toolbar_icon_order_lookup_get()
14670     *
14671     * @ingroup Toolbar
14672     */
14673    EAPI void                    elm_toolbar_item_icon_set(Elm_Toolbar_Item *item, const char *icon) EINA_ARG_NONNULL(1);
14674
14675    /**
14676     * Get the string used to set the icon of @p item.
14677     *
14678     * @param item The toolbar item.
14679     * @return The string associated with the icon object.
14680     *
14681     * @see elm_toolbar_item_icon_set() for details.
14682     *
14683     * @ingroup Toolbar
14684     */
14685    EAPI const char             *elm_toolbar_item_icon_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14686
14687    /**
14688     * Get the object of @p item.
14689     *
14690     * @param item The toolbar item.
14691     * @return The object
14692     *
14693     * @ingroup Toolbar
14694     */
14695    EAPI Evas_Object            *elm_toolbar_item_object_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14696
14697    /**
14698     * Get the icon object of @p item.
14699     *
14700     * @param item The toolbar item.
14701     * @return The icon object
14702     *
14703     * @see elm_toolbar_item_icon_set() or elm_toolbar_item_icon_memfile_set() for details.
14704     *
14705     * @ingroup Toolbar
14706     */
14707    EAPI Evas_Object            *elm_toolbar_item_icon_object_get(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14708
14709    /**
14710     * Set the icon associated with @p item to an image in a binary buffer.
14711     *
14712     * @param item The toolbar item.
14713     * @param img The binary data that will be used as an image
14714     * @param size The size of binary data @p img
14715     * @param format Optional format of @p img to pass to the image loader
14716     * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
14717     *
14718     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
14719     *
14720     * @note The icon image set by this function can be changed by
14721     * elm_toolbar_item_icon_set().
14722     * 
14723     * @ingroup Toolbar
14724     */
14725    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);
14726
14727    /**
14728     * Delete them item from the toolbar.
14729     *
14730     * @param item The item of toolbar to be deleted.
14731     *
14732     * @see elm_toolbar_item_append()
14733     * @see elm_toolbar_item_del_cb_set()
14734     *
14735     * @ingroup Toolbar
14736     */
14737    EAPI void                    elm_toolbar_item_del(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14738
14739    /**
14740     * Set the function called when a toolbar item is freed.
14741     *
14742     * @param item The item to set the callback on.
14743     * @param func The function called.
14744     *
14745     * If there is a @p func, then it will be called prior item's memory release.
14746     * That will be called with the following arguments:
14747     * @li item's data;
14748     * @li item's Evas object;
14749     * @li item itself;
14750     *
14751     * This way, a data associated to a toolbar item could be properly freed.
14752     *
14753     * @ingroup Toolbar
14754     */
14755    EAPI void                    elm_toolbar_item_del_cb_set(Elm_Toolbar_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
14756
14757    /**
14758     * Get a value whether toolbar item is disabled or not.
14759     *
14760     * @param item The item.
14761     * @return The disabled state.
14762     *
14763     * @see elm_toolbar_item_disabled_set() for more details.
14764     *
14765     * @ingroup Toolbar
14766     */
14767    EAPI Eina_Bool               elm_toolbar_item_disabled_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14768
14769    /**
14770     * Sets the disabled/enabled state of a toolbar item.
14771     *
14772     * @param item The item.
14773     * @param disabled The disabled state.
14774     *
14775     * A disabled item cannot be selected or unselected. It will also
14776     * change its appearance (generally greyed out). This sets the
14777     * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
14778     * enabled).
14779     *
14780     * @ingroup Toolbar
14781     */
14782    EAPI void                    elm_toolbar_item_disabled_set(Elm_Toolbar_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
14783
14784    /**
14785     * Set or unset item as a separator.
14786     *
14787     * @param item The toolbar item.
14788     * @param setting @c EINA_TRUE to set item @p item as separator or
14789     * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
14790     *
14791     * Items aren't set as separator by default.
14792     *
14793     * If set as separator it will display separator theme, so won't display
14794     * icons or label.
14795     *
14796     * @see elm_toolbar_item_separator_get()
14797     *
14798     * @ingroup Toolbar
14799     */
14800    EAPI void                    elm_toolbar_item_separator_set(Elm_Toolbar_Item *item, Eina_Bool separator) EINA_ARG_NONNULL(1);
14801
14802    /**
14803     * Get a value whether item is a separator or not.
14804     *
14805     * @param item The toolbar item.
14806     * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
14807     * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
14808     *
14809     * @see elm_toolbar_item_separator_set() for details.
14810     *
14811     * @ingroup Toolbar
14812     */
14813    EAPI Eina_Bool               elm_toolbar_item_separator_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14814
14815    /**
14816     * Set the shrink state of toolbar @p obj.
14817     *
14818     * @param obj The toolbar object.
14819     * @param shrink_mode Toolbar's items display behavior.
14820     *
14821     * The toolbar won't scroll if #ELM_TOOLBAR_SHRINK_NONE,
14822     * but will enforce a minimun size so all the items will fit, won't scroll
14823     * and won't show the items that don't fit if #ELM_TOOLBAR_SHRINK_HIDE,
14824     * will scroll if #ELM_TOOLBAR_SHRINK_SCROLL, and will create a button to
14825     * pop up excess elements with #ELM_TOOLBAR_SHRINK_MENU.
14826     *
14827     * @ingroup Toolbar
14828     */
14829    EAPI void                    elm_toolbar_mode_shrink_set(Evas_Object *obj, Elm_Toolbar_Shrink_Mode shrink_mode) EINA_ARG_NONNULL(1);
14830
14831    /**
14832     * Get the shrink mode of toolbar @p obj.
14833     *
14834     * @param obj The toolbar object.
14835     * @return Toolbar's items display behavior.
14836     *
14837     * @see elm_toolbar_mode_shrink_set() for details.
14838     *
14839     * @ingroup Toolbar
14840     */
14841    EAPI Elm_Toolbar_Shrink_Mode elm_toolbar_mode_shrink_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14842
14843    /**
14844     * Enable/disable homogenous mode.
14845     *
14846     * @param obj The toolbar object
14847     * @param homogeneous Assume the items within the toolbar are of the
14848     * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
14849     *
14850     * This will enable the homogeneous mode where items are of the same size.
14851     * @see elm_toolbar_homogeneous_get()
14852     *
14853     * @ingroup Toolbar
14854     */
14855    EAPI void                    elm_toolbar_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
14856
14857    /**
14858     * Get whether the homogenous mode is enabled.
14859     *
14860     * @param obj The toolbar object.
14861     * @return Assume the items within the toolbar are of the same height
14862     * and width (EINA_TRUE = on, EINA_FALSE = off).
14863     *
14864     * @see elm_toolbar_homogeneous_set()
14865     *
14866     * @ingroup Toolbar
14867     */
14868    EAPI Eina_Bool               elm_toolbar_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14869
14870    /**
14871     * Enable/disable homogenous mode.
14872     *
14873     * @param obj The toolbar object
14874     * @param homogeneous Assume the items within the toolbar are of the
14875     * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
14876     *
14877     * This will enable the homogeneous mode where items are of the same size.
14878     * @see elm_toolbar_homogeneous_get()
14879     *
14880     * @deprecated use elm_toolbar_homogeneous_set() instead.
14881     *
14882     * @ingroup Toolbar
14883     */
14884    EINA_DEPRECATED EAPI void    elm_toolbar_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
14885
14886    /**
14887     * Get whether the homogenous mode is enabled.
14888     *
14889     * @param obj The toolbar object.
14890     * @return Assume the items within the toolbar are of the same height
14891     * and width (EINA_TRUE = on, EINA_FALSE = off).
14892     *
14893     * @see elm_toolbar_homogeneous_set()
14894     * @deprecated use elm_toolbar_homogeneous_get() instead.
14895     *
14896     * @ingroup Toolbar
14897     */
14898    EINA_DEPRECATED EAPI Eina_Bool elm_toolbar_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14899
14900    /**
14901     * Set the parent object of the toolbar items' menus.
14902     *
14903     * @param obj The toolbar object.
14904     * @param parent The parent of the menu objects.
14905     *
14906     * Each item can be set as item menu, with elm_toolbar_item_menu_set().
14907     *
14908     * For more details about setting the parent for toolbar menus, see
14909     * elm_menu_parent_set().
14910     *
14911     * @see elm_menu_parent_set() for details.
14912     * @see elm_toolbar_item_menu_set() for details.
14913     *
14914     * @ingroup Toolbar
14915     */
14916    EAPI void                    elm_toolbar_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
14917
14918    /**
14919     * Get the parent object of the toolbar items' menus.
14920     *
14921     * @param obj The toolbar object.
14922     * @return The parent of the menu objects.
14923     *
14924     * @see elm_toolbar_menu_parent_set() for details.
14925     *
14926     * @ingroup Toolbar
14927     */
14928    EAPI Evas_Object            *elm_toolbar_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14929
14930    /**
14931     * Set the alignment of the items.
14932     *
14933     * @param obj The toolbar object.
14934     * @param align The new alignment, a float between <tt> 0.0 </tt>
14935     * and <tt> 1.0 </tt>.
14936     *
14937     * Alignment of toolbar items, from <tt> 0.0 </tt> to indicates to align
14938     * left, to <tt> 1.0 </tt>, to align to right. <tt> 0.5 </tt> centralize
14939     * items.
14940     *
14941     * Centered items by default.
14942     *
14943     * @see elm_toolbar_align_get()
14944     *
14945     * @ingroup Toolbar
14946     */
14947    EAPI void                    elm_toolbar_align_set(Evas_Object *obj, double align) EINA_ARG_NONNULL(1);
14948
14949    /**
14950     * Get the alignment of the items.
14951     *
14952     * @param obj The toolbar object.
14953     * @return toolbar items alignment, a float between <tt> 0.0 </tt> and
14954     * <tt> 1.0 </tt>.
14955     *
14956     * @see elm_toolbar_align_set() for details.
14957     *
14958     * @ingroup Toolbar
14959     */
14960    EAPI double                  elm_toolbar_align_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14961
14962    /**
14963     * Set whether the toolbar item opens a menu.
14964     *
14965     * @param item The toolbar item.
14966     * @param menu If @c EINA_TRUE, @p item will opens a menu when selected.
14967     *
14968     * A toolbar item can be set to be a menu, using this function.
14969     *
14970     * Once it is set to be a menu, it can be manipulated through the
14971     * menu-like function elm_toolbar_menu_parent_set() and the other
14972     * elm_menu functions, using the Evas_Object @c menu returned by
14973     * elm_toolbar_item_menu_get().
14974     *
14975     * So, items to be displayed in this item's menu should be added with
14976     * elm_menu_item_add().
14977     *
14978     * The following code exemplifies the most basic usage:
14979     * @code
14980     * tb = elm_toolbar_add(win)
14981     * item = elm_toolbar_item_append(tb, "refresh", "Menu", NULL, NULL);
14982     * elm_toolbar_item_menu_set(item, EINA_TRUE);
14983     * elm_toolbar_menu_parent_set(tb, win);
14984     * menu = elm_toolbar_item_menu_get(item);
14985     * elm_menu_item_add(menu, NULL, "edit-cut", "Cut", NULL, NULL);
14986     * menu_item = elm_menu_item_add(menu, NULL, "edit-copy", "Copy", NULL,
14987     * NULL);
14988     * @endcode
14989     *
14990     * @see elm_toolbar_item_menu_get()
14991     *
14992     * @ingroup Toolbar
14993     */
14994    EAPI void                    elm_toolbar_item_menu_set(Elm_Toolbar_Item *item, Eina_Bool menu) EINA_ARG_NONNULL(1);
14995
14996    /**
14997     * Get toolbar item's menu.
14998     *
14999     * @param item The toolbar item.
15000     * @return Item's menu object or @c NULL on failure.
15001     *
15002     * If @p item wasn't set as menu item with elm_toolbar_item_menu_set(),
15003     * this function will set it.
15004     *
15005     * @see elm_toolbar_item_menu_set() for details.
15006     *
15007     * @ingroup Toolbar
15008     */
15009    EAPI Evas_Object            *elm_toolbar_item_menu_get(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15010
15011    /**
15012     * Add a new state to @p item.
15013     *
15014     * @param item The item.
15015     * @param icon A string with icon name or the absolute path of an image file.
15016     * @param label The label of the new state.
15017     * @param func The function to call when the item is clicked when this
15018     * state is selected.
15019     * @param data The data to associate with the state.
15020     * @return The toolbar item state, or @c NULL upon failure.
15021     *
15022     * Toolbar will load icon image from fdo or current theme.
15023     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
15024     * If an absolute path is provided it will load it direct from a file.
15025     *
15026     * States created with this function can be removed with
15027     * elm_toolbar_item_state_del().
15028     *
15029     * @see elm_toolbar_item_state_del()
15030     * @see elm_toolbar_item_state_sel()
15031     * @see elm_toolbar_item_state_get()
15032     *
15033     * @ingroup Toolbar
15034     */
15035    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);
15036
15037    /**
15038     * Delete a previoulsy added state to @p item.
15039     *
15040     * @param item The toolbar item.
15041     * @param state The state to be deleted.
15042     * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
15043     *
15044     * @see elm_toolbar_item_state_add()
15045     */
15046    EAPI Eina_Bool               elm_toolbar_item_state_del(Elm_Toolbar_Item *item, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
15047
15048    /**
15049     * Set @p state as the current state of @p it.
15050     *
15051     * @param it The item.
15052     * @param state The state to use.
15053     * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
15054     *
15055     * If @p state is @c NULL, it won't select any state and the default item's
15056     * icon and label will be used. It's the same behaviour than
15057     * elm_toolbar_item_state_unser().
15058     *
15059     * @see elm_toolbar_item_state_unset()
15060     *
15061     * @ingroup Toolbar
15062     */
15063    EAPI Eina_Bool               elm_toolbar_item_state_set(Elm_Toolbar_Item *it, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
15064
15065    /**
15066     * Unset the state of @p it.
15067     *
15068     * @param it The item.
15069     *
15070     * The default icon and label from this item will be displayed.
15071     *
15072     * @see elm_toolbar_item_state_set() for more details.
15073     *
15074     * @ingroup Toolbar
15075     */
15076    EAPI void                    elm_toolbar_item_state_unset(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15077
15078    /**
15079     * Get the current state of @p it.
15080     *
15081     * @param item The item.
15082     * @return The selected state or @c NULL if none is selected or on failure.
15083     *
15084     * @see elm_toolbar_item_state_set() for details.
15085     * @see elm_toolbar_item_state_unset()
15086     * @see elm_toolbar_item_state_add()
15087     *
15088     * @ingroup Toolbar
15089     */
15090    EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_get(const Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15091
15092    /**
15093     * Get the state after selected state in toolbar's @p item.
15094     *
15095     * @param it The toolbar item to change state.
15096     * @return The state after current state, or @c NULL on failure.
15097     *
15098     * If last state is selected, this function will return first state.
15099     *
15100     * @see elm_toolbar_item_state_set()
15101     * @see elm_toolbar_item_state_add()
15102     *
15103     * @ingroup Toolbar
15104     */
15105    EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_next(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15106
15107    /**
15108     * Get the state before selected state in toolbar's @p item.
15109     *
15110     * @param it The toolbar item to change state.
15111     * @return The state before current state, or @c NULL on failure.
15112     *
15113     * If first state is selected, this function will return last state.
15114     *
15115     * @see elm_toolbar_item_state_set()
15116     * @see elm_toolbar_item_state_add()
15117     *
15118     * @ingroup Toolbar
15119     */
15120    EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_prev(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15121
15122    /**
15123     * Set the text to be shown in a given toolbar item's tooltips.
15124     *
15125     * @param item Target item.
15126     * @param text The text to set in the content.
15127     *
15128     * Setup the text as tooltip to object. The item can have only one tooltip,
15129     * so any previous tooltip data - set with this function or
15130     * elm_toolbar_item_tooltip_content_cb_set() - is removed.
15131     *
15132     * @see elm_object_tooltip_text_set() for more details.
15133     *
15134     * @ingroup Toolbar
15135     */
15136    EAPI void             elm_toolbar_item_tooltip_text_set(Elm_Toolbar_Item *item, const char *text) EINA_ARG_NONNULL(1);
15137
15138    /**
15139     * Set the content to be shown in the tooltip item.
15140     *
15141     * Setup the tooltip to item. The item can have only one tooltip,
15142     * so any previous tooltip data is removed. @p func(with @p data) will
15143     * be called every time that need show the tooltip and it should
15144     * return a valid Evas_Object. This object is then managed fully by
15145     * tooltip system and is deleted when the tooltip is gone.
15146     *
15147     * @param item the toolbar item being attached a tooltip.
15148     * @param func the function used to create the tooltip contents.
15149     * @param data what to provide to @a func as callback data/context.
15150     * @param del_cb called when data is not needed anymore, either when
15151     *        another callback replaces @a func, the tooltip is unset with
15152     *        elm_toolbar_item_tooltip_unset() or the owner @a item
15153     *        dies. This callback receives as the first parameter the
15154     *        given @a data, and @c event_info is the item.
15155     *
15156     * @see elm_object_tooltip_content_cb_set() for more details.
15157     *
15158     * @ingroup Toolbar
15159     */
15160    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);
15161
15162    /**
15163     * Unset tooltip from item.
15164     *
15165     * @param item toolbar item to remove previously set tooltip.
15166     *
15167     * Remove tooltip from item. The callback provided as del_cb to
15168     * elm_toolbar_item_tooltip_content_cb_set() will be called to notify
15169     * it is not used anymore.
15170     *
15171     * @see elm_object_tooltip_unset() for more details.
15172     * @see elm_toolbar_item_tooltip_content_cb_set()
15173     *
15174     * @ingroup Toolbar
15175     */
15176    EAPI void             elm_toolbar_item_tooltip_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15177
15178    /**
15179     * Sets a different style for this item tooltip.
15180     *
15181     * @note before you set a style you should define a tooltip with
15182     *       elm_toolbar_item_tooltip_content_cb_set() or
15183     *       elm_toolbar_item_tooltip_text_set()
15184     *
15185     * @param item toolbar item with tooltip already set.
15186     * @param style the theme style to use (default, transparent, ...)
15187     *
15188     * @see elm_object_tooltip_style_set() for more details.
15189     *
15190     * @ingroup Toolbar
15191     */
15192    EAPI void             elm_toolbar_item_tooltip_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
15193
15194    /**
15195     * Get the style for this item tooltip.
15196     *
15197     * @param item toolbar item with tooltip already set.
15198     * @return style the theme style in use, defaults to "default". If the
15199     *         object does not have a tooltip set, then NULL is returned.
15200     *
15201     * @see elm_object_tooltip_style_get() for more details.
15202     * @see elm_toolbar_item_tooltip_style_set()
15203     *
15204     * @ingroup Toolbar
15205     */
15206    EAPI const char      *elm_toolbar_item_tooltip_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15207
15208    /**
15209     * Set the type of mouse pointer/cursor decoration to be shown,
15210     * when the mouse pointer is over the given toolbar widget item
15211     *
15212     * @param item toolbar item to customize cursor on
15213     * @param cursor the cursor type's name
15214     *
15215     * This function works analogously as elm_object_cursor_set(), but
15216     * here the cursor's changing area is restricted to the item's
15217     * area, and not the whole widget's. Note that that item cursors
15218     * have precedence over widget cursors, so that a mouse over an
15219     * item with custom cursor set will always show @b that cursor.
15220     *
15221     * If this function is called twice for an object, a previously set
15222     * cursor will be unset on the second call.
15223     *
15224     * @see elm_object_cursor_set()
15225     * @see elm_toolbar_item_cursor_get()
15226     * @see elm_toolbar_item_cursor_unset()
15227     *
15228     * @ingroup Toolbar
15229     */
15230    EAPI void             elm_toolbar_item_cursor_set(Elm_Toolbar_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
15231
15232    /*
15233     * Get the type of mouse pointer/cursor decoration set to be shown,
15234     * when the mouse pointer is over the given toolbar widget item
15235     *
15236     * @param item toolbar item with custom cursor set
15237     * @return the cursor type's name or @c NULL, if no custom cursors
15238     * were set to @p item (and on errors)
15239     *
15240     * @see elm_object_cursor_get()
15241     * @see elm_toolbar_item_cursor_set()
15242     * @see elm_toolbar_item_cursor_unset()
15243     *
15244     * @ingroup Toolbar
15245     */
15246    EAPI const char      *elm_toolbar_item_cursor_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15247
15248    /**
15249     * Unset any custom mouse pointer/cursor decoration set to be
15250     * shown, when the mouse pointer is over the given toolbar widget
15251     * item, thus making it show the @b default cursor again.
15252     *
15253     * @param item a toolbar item
15254     *
15255     * Use this call to undo any custom settings on this item's cursor
15256     * decoration, bringing it back to defaults (no custom style set).
15257     *
15258     * @see elm_object_cursor_unset()
15259     * @see elm_toolbar_item_cursor_set()
15260     *
15261     * @ingroup Toolbar
15262     */
15263    EAPI void             elm_toolbar_item_cursor_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15264
15265    /**
15266     * Set a different @b style for a given custom cursor set for a
15267     * toolbar item.
15268     *
15269     * @param item toolbar item with custom cursor set
15270     * @param style the <b>theme style</b> to use (e.g. @c "default",
15271     * @c "transparent", etc)
15272     *
15273     * This function only makes sense when one is using custom mouse
15274     * cursor decorations <b>defined in a theme file</b>, which can have,
15275     * given a cursor name/type, <b>alternate styles</b> on it. It
15276     * works analogously as elm_object_cursor_style_set(), but here
15277     * applyed only to toolbar item objects.
15278     *
15279     * @warning Before you set a cursor style you should have definen a
15280     *       custom cursor previously on the item, with
15281     *       elm_toolbar_item_cursor_set()
15282     *
15283     * @see elm_toolbar_item_cursor_engine_only_set()
15284     * @see elm_toolbar_item_cursor_style_get()
15285     *
15286     * @ingroup Toolbar
15287     */
15288    EAPI void             elm_toolbar_item_cursor_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
15289
15290    /**
15291     * Get the current @b style set for a given toolbar item's custom
15292     * cursor
15293     *
15294     * @param item toolbar item with custom cursor set.
15295     * @return style the cursor style in use. If the object does not
15296     *         have a cursor set, then @c NULL is returned.
15297     *
15298     * @see elm_toolbar_item_cursor_style_set() for more details
15299     *
15300     * @ingroup Toolbar
15301     */
15302    EAPI const char      *elm_toolbar_item_cursor_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15303
15304    /**
15305     * Set if the (custom)cursor for a given toolbar item should be
15306     * searched in its theme, also, or should only rely on the
15307     * rendering engine.
15308     *
15309     * @param item item with custom (custom) cursor already set on
15310     * @param engine_only Use @c EINA_TRUE to have cursors looked for
15311     * only on those provided by the rendering engine, @c EINA_FALSE to
15312     * have them searched on the widget's theme, as well.
15313     *
15314     * @note This call is of use only if you've set a custom cursor
15315     * for toolbar items, with elm_toolbar_item_cursor_set().
15316     *
15317     * @note By default, cursors will only be looked for between those
15318     * provided by the rendering engine.
15319     *
15320     * @ingroup Toolbar
15321     */
15322    EAPI void             elm_toolbar_item_cursor_engine_only_set(Elm_Toolbar_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
15323
15324    /**
15325     * Get if the (custom) cursor for a given toolbar item is being
15326     * searched in its theme, also, or is only relying on the rendering
15327     * engine.
15328     *
15329     * @param item a toolbar item
15330     * @return @c EINA_TRUE, if cursors are being looked for only on
15331     * those provided by the rendering engine, @c EINA_FALSE if they
15332     * are being searched on the widget's theme, as well.
15333     *
15334     * @see elm_toolbar_item_cursor_engine_only_set(), for more details
15335     *
15336     * @ingroup Toolbar
15337     */
15338    EAPI Eina_Bool        elm_toolbar_item_cursor_engine_only_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15339
15340    /**
15341     * Change a toolbar's orientation
15342     * @param obj The toolbar object
15343     * @param vertical If @c EINA_TRUE, the toolbar is vertical
15344     * By default, a toolbar will be horizontal. Use this function to create a vertical toolbar.
15345     * @ingroup Toolbar
15346     * @deprecated use elm_toolbar_horizontal_set() instead.
15347     */
15348    EINA_DEPRECATED EAPI void             elm_toolbar_orientation_set(Evas_Object *obj, Eina_Bool vertical) EINA_ARG_NONNULL(1);
15349
15350    /**
15351     * Change a toolbar's orientation
15352     * @param obj The toolbar object
15353     * @param horizontal If @c EINA_TRUE, the toolbar is horizontal
15354     * By default, a toolbar will be horizontal. Use this function to create a vertical toolbar.
15355     * @ingroup Toolbar
15356     */
15357    EAPI void             elm_toolbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
15358
15359    /**
15360     * Get a toolbar's orientation
15361     * @param obj The toolbar object
15362     * @return If @c EINA_TRUE, the toolbar is vertical
15363     * By default, a toolbar will be horizontal. Use this function to determine whether a toolbar is vertical.
15364     * @ingroup Toolbar
15365     * @deprecated use elm_toolbar_horizontal_get() instead.
15366     */
15367    EINA_DEPRECATED EAPI Eina_Bool        elm_toolbar_orientation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15368
15369    /**
15370     * Get a toolbar's orientation
15371     * @param obj The toolbar object
15372     * @return If @c EINA_TRUE, the toolbar is horizontal
15373     * By default, a toolbar will be horizontal. Use this function to determine whether a toolbar is vertical.
15374     * @ingroup Toolbar
15375     */
15376    EAPI Eina_Bool elm_toolbar_horizontal_get(const Evas_Object *obj);
15377    /**
15378     * @}
15379     */
15380
15381    /**
15382     * @defgroup Tooltips Tooltips
15383     *
15384     * The Tooltip is an (internal, for now) smart object used to show a
15385     * content in a frame on mouse hover of objects(or widgets), with
15386     * tips/information about them.
15387     *
15388     * @{
15389     */
15390
15391    EAPI double       elm_tooltip_delay_get(void);
15392    EAPI Eina_Bool    elm_tooltip_delay_set(double delay);
15393    EAPI void         elm_object_tooltip_show(Evas_Object *obj) EINA_ARG_NONNULL(1);
15394    EAPI void         elm_object_tooltip_hide(Evas_Object *obj) EINA_ARG_NONNULL(1);
15395    EAPI void         elm_object_tooltip_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1, 2);
15396    EAPI void         elm_object_tooltip_domain_translatable_text_set(Evas_Object *obj, const char *domain, const char *text) EINA_ARG_NONNULL(1, 3);
15397 #define elm_object_tooltip_translatable_text_set(obj, text) elm_object_tooltip_domain_translatable_text_set((obj), NULL, (text))
15398    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);
15399    EAPI void         elm_object_tooltip_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15400    EAPI void         elm_object_tooltip_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
15401    EAPI const char  *elm_object_tooltip_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15402
15403    /**
15404     * @defgroup Cursors Cursors
15405     *
15406     * The Elementary cursor is an internal smart object used to
15407     * customize the mouse cursor displayed over objects (or
15408     * widgets). In the most common scenario, the cursor decoration
15409     * comes from the graphical @b engine Elementary is running
15410     * on. Those engines may provide different decorations for cursors,
15411     * and Elementary provides functions to choose them (think of X11
15412     * cursors, as an example).
15413     *
15414     * There's also the possibility of, besides using engine provided
15415     * cursors, also use ones coming from Edje theming files. Both
15416     * globally and per widget, Elementary makes it possible for one to
15417     * make the cursors lookup to be held on engines only or on
15418     * Elementary's theme file, too. To set cursor's hot spot,
15419     * two data items should be added to cursor's theme: "hot_x" and
15420     * "hot_y", that are the offset from upper-left corner of the cursor
15421     * (coordinates 0,0).
15422     *
15423     * @{
15424     */
15425
15426    /**
15427     * Set the cursor to be shown when mouse is over the object
15428     *
15429     * Set the cursor that will be displayed when mouse is over the
15430     * object. The object can have only one cursor set to it, so if
15431     * this function is called twice for an object, the previous set
15432     * will be unset.
15433     * If using X cursors, a definition of all the valid cursor names
15434     * is listed on Elementary_Cursors.h. If an invalid name is set
15435     * the default cursor will be used.
15436     *
15437     * @param obj the object being set a cursor.
15438     * @param cursor the cursor name to be used.
15439     *
15440     * @ingroup Cursors
15441     */
15442    EAPI void         elm_object_cursor_set(Evas_Object *obj, const char *cursor) EINA_ARG_NONNULL(1);
15443
15444    /**
15445     * Get the cursor to be shown when mouse is over the object
15446     *
15447     * @param obj an object with cursor already set.
15448     * @return the cursor name.
15449     *
15450     * @ingroup Cursors
15451     */
15452    EAPI const char  *elm_object_cursor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15453
15454    /**
15455     * Unset cursor for object
15456     *
15457     * Unset cursor for object, and set the cursor to default if the mouse
15458     * was over this object.
15459     *
15460     * @param obj Target object
15461     * @see elm_object_cursor_set()
15462     *
15463     * @ingroup Cursors
15464     */
15465    EAPI void         elm_object_cursor_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15466
15467    /**
15468     * Sets a different style for this object cursor.
15469     *
15470     * @note before you set a style you should define a cursor with
15471     *       elm_object_cursor_set()
15472     *
15473     * @param obj an object with cursor already set.
15474     * @param style the theme style to use (default, transparent, ...)
15475     *
15476     * @ingroup Cursors
15477     */
15478    EAPI void         elm_object_cursor_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
15479
15480    /**
15481     * Get the style for this object cursor.
15482     *
15483     * @param obj an object with cursor already set.
15484     * @return style the theme style in use, defaults to "default". If the
15485     *         object does not have a cursor set, then NULL is returned.
15486     *
15487     * @ingroup Cursors
15488     */
15489    EAPI const char  *elm_object_cursor_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15490
15491    /**
15492     * Set if the cursor set should be searched on the theme or should use
15493     * the provided by the engine, only.
15494     *
15495     * @note before you set if should look on theme you should define a cursor
15496     * with elm_object_cursor_set(). By default it will only look for cursors
15497     * provided by the engine.
15498     *
15499     * @param obj an object with cursor already set.
15500     * @param engine_only boolean to define it cursors should be looked only
15501     * between the provided by the engine or searched on widget's theme as well.
15502     *
15503     * @ingroup Cursors
15504     */
15505    EAPI void         elm_object_cursor_engine_only_set(Evas_Object *obj, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
15506
15507    /**
15508     * Get the cursor engine only usage for this object cursor.
15509     *
15510     * @param obj an object with cursor already set.
15511     * @return engine_only boolean to define it cursors should be
15512     * looked only between the provided by the engine or searched on
15513     * widget's theme as well. If the object does not have a cursor
15514     * set, then EINA_FALSE is returned.
15515     *
15516     * @ingroup Cursors
15517     */
15518    EAPI Eina_Bool    elm_object_cursor_engine_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15519
15520    /**
15521     * Get the configured cursor engine only usage
15522     *
15523     * This gets the globally configured exclusive usage of engine cursors.
15524     *
15525     * @return 1 if only engine cursors should be used
15526     * @ingroup Cursors
15527     */
15528    EAPI int          elm_cursor_engine_only_get(void);
15529
15530    /**
15531     * Set the configured cursor engine only usage
15532     *
15533     * This sets the globally configured exclusive usage of engine cursors.
15534     * It won't affect cursors set before changing this value.
15535     *
15536     * @param engine_only If 1 only engine cursors will be enabled, if 0 will
15537     * look for them on theme before.
15538     * @return EINA_TRUE if value is valid and setted (0 or 1)
15539     * @ingroup Cursors
15540     */
15541    EAPI Eina_Bool    elm_cursor_engine_only_set(int engine_only);
15542
15543    /**
15544     * @}
15545     */
15546
15547    /**
15548     * @defgroup Menu Menu
15549     *
15550     * @image html img/widget/menu/preview-00.png
15551     * @image latex img/widget/menu/preview-00.eps
15552     *
15553     * A menu is a list of items displayed above its parent. When the menu is
15554     * showing its parent is darkened. Each item can have a sub-menu. The menu
15555     * object can be used to display a menu on a right click event, in a toolbar,
15556     * anywhere.
15557     *
15558     * Signals that you can add callbacks for are:
15559     * @li "clicked" - the user clicked the empty space in the menu to dismiss.
15560     *             event_info is NULL.
15561     *
15562     * @see @ref tutorial_menu
15563     * @{
15564     */
15565    typedef struct _Elm_Menu_Item Elm_Menu_Item; /**< Item of Elm_Menu. Sub-type of Elm_Widget_Item */
15566    /**
15567     * @brief Add a new menu to the parent
15568     *
15569     * @param parent The parent object.
15570     * @return The new object or NULL if it cannot be created.
15571     */
15572    EAPI Evas_Object       *elm_menu_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
15573    /**
15574     * @brief Set the parent for the given menu widget
15575     *
15576     * @param obj The menu object.
15577     * @param parent The new parent.
15578     */
15579    EAPI void               elm_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
15580    /**
15581     * @brief Get the parent for the given menu widget
15582     *
15583     * @param obj The menu object.
15584     * @return The parent.
15585     *
15586     * @see elm_menu_parent_set()
15587     */
15588    EAPI Evas_Object       *elm_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15589    /**
15590     * @brief Move the menu to a new position
15591     *
15592     * @param obj The menu object.
15593     * @param x The new position.
15594     * @param y The new position.
15595     *
15596     * Sets the top-left position of the menu to (@p x,@p y).
15597     *
15598     * @note @p x and @p y coordinates are relative to parent.
15599     */
15600    EAPI void               elm_menu_move(Evas_Object *obj, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
15601    /**
15602     * @brief Close a opened menu
15603     *
15604     * @param obj the menu object
15605     * @return void
15606     *
15607     * Hides the menu and all it's sub-menus.
15608     */
15609    EAPI void               elm_menu_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
15610    /**
15611     * @brief Returns a list of @p item's items.
15612     *
15613     * @param obj The menu object
15614     * @return An Eina_List* of @p item's items
15615     */
15616    EAPI const Eina_List   *elm_menu_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15617    /**
15618     * @brief Get the Evas_Object of an Elm_Menu_Item
15619     *
15620     * @param item The menu item object.
15621     * @return The edje object containing the swallowed content
15622     *
15623     * @warning Don't manipulate this object!
15624     */
15625    EAPI Evas_Object       *elm_menu_item_object_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
15626    /**
15627     * @brief Add an item at the end of the given menu widget
15628     *
15629     * @param obj The menu object.
15630     * @param parent The parent menu item (optional)
15631     * @param icon A icon display on the item. The icon will be destryed by the menu.
15632     * @param label The label of the item.
15633     * @param func Function called when the user select the item.
15634     * @param data Data sent by the callback.
15635     * @return Returns the new item.
15636     */
15637    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);
15638    /**
15639     * @brief Set the label of a menu item
15640     *
15641     * @param item The menu item object.
15642     * @param label The label to set for @p item
15643     *
15644     * @warning Don't use this funcion on items created with
15645     * elm_menu_item_add_object() or elm_menu_item_separator_add().
15646     */
15647    EAPI void               elm_menu_item_label_set(Elm_Menu_Item *item, const char *label) EINA_ARG_NONNULL(1);
15648    /**
15649     * @brief Get the label of a menu item
15650     *
15651     * @param item The menu item object.
15652     * @return The label of @p item
15653     */
15654    EAPI const char        *elm_menu_item_label_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15655    EAPI void               elm_menu_item_icon_set(Elm_Menu_Item *item, const char *icon) EINA_ARG_NONNULL(1, 2);
15656    EAPI const char        *elm_menu_item_icon_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15657    EAPI const Evas_Object *elm_menu_item_object_icon_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15658
15659    /**
15660     * @brief Set the selected state of @p item.
15661     *
15662     * @param item The menu item object.
15663     * @param selected The selected/unselected state of the item
15664     */
15665    EAPI void               elm_menu_item_selected_set(Elm_Menu_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
15666    /**
15667     * @brief Get the selected state of @p item.
15668     *
15669     * @param item The menu item object.
15670     * @return The selected/unselected state of the item
15671     *
15672     * @see elm_menu_item_selected_set()
15673     */
15674    EAPI Eina_Bool          elm_menu_item_selected_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15675    /**
15676     * @brief Set the disabled state of @p item.
15677     *
15678     * @param item The menu item object.
15679     * @param disabled The enabled/disabled state of the item
15680     */
15681    EAPI void               elm_menu_item_disabled_set(Elm_Menu_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
15682    /**
15683     * @brief Get the disabled state of @p item.
15684     *
15685     * @param item The menu item object.
15686     * @return The enabled/disabled state of the item
15687     *
15688     * @see elm_menu_item_disabled_set()
15689     */
15690    EAPI Eina_Bool          elm_menu_item_disabled_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15691    /**
15692     * @brief Add a separator item to menu @p obj under @p parent.
15693     *
15694     * @param obj The menu object
15695     * @param parent The item to add the separator under
15696     * @return The created item or NULL on failure
15697     *
15698     * This is item is a @ref Separator.
15699     */
15700    EAPI Elm_Menu_Item     *elm_menu_item_separator_add(Evas_Object *obj, Elm_Menu_Item *parent) EINA_ARG_NONNULL(1);
15701    /**
15702     * @brief Returns whether @p item is a separator.
15703     *
15704     * @param item The item to check
15705     * @return If true, @p item is a separator
15706     *
15707     * @see elm_menu_item_separator_add()
15708     */
15709    EAPI Eina_Bool          elm_menu_item_is_separator(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15710    /**
15711     * @brief Deletes an item from the menu.
15712     *
15713     * @param item The item to delete.
15714     *
15715     * @see elm_menu_item_add()
15716     */
15717    EAPI void               elm_menu_item_del(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15718    /**
15719     * @brief Set the function called when a menu item is deleted.
15720     *
15721     * @param item The item to set the callback on
15722     * @param func The function called
15723     *
15724     * @see elm_menu_item_add()
15725     * @see elm_menu_item_del()
15726     */
15727    EAPI void               elm_menu_item_del_cb_set(Elm_Menu_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
15728    /**
15729     * @brief Returns the data associated with menu item @p item.
15730     *
15731     * @param item The item
15732     * @return The data associated with @p item or NULL if none was set.
15733     *
15734     * This is the data set with elm_menu_add() or elm_menu_item_data_set().
15735     */
15736    EAPI void              *elm_menu_item_data_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
15737    /**
15738     * @brief Sets the data to be associated with menu item @p item.
15739     *
15740     * @param item The item
15741     * @param data The data to be associated with @p item
15742     */
15743    EAPI void               elm_menu_item_data_set(Elm_Menu_Item *item, const void *data) EINA_ARG_NONNULL(1);
15744    /**
15745     * @brief Returns a list of @p item's subitems.
15746     *
15747     * @param item The item
15748     * @return An Eina_List* of @p item's subitems
15749     *
15750     * @see elm_menu_add()
15751     */
15752    EAPI const Eina_List   *elm_menu_item_subitems_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
15753    EAPI Elm_Menu_Item *elm_menu_selected_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
15754    EAPI Elm_Menu_Item *elm_menu_last_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
15755    EAPI Elm_Menu_Item *elm_menu_first_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
15756    EAPI Elm_Menu_Item *elm_menu_item_next_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
15757    EAPI Elm_Menu_Item *elm_menu_item_prev_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
15758
15759    /**
15760     * @}
15761     */
15762
15763    /**
15764     * @defgroup List List
15765     * @ingroup Elementary
15766     *
15767     * @image html img/widget/list/preview-00.png
15768     * @image latex img/widget/list/preview-00.eps width=\textwidth
15769     *
15770     * @image html img/list.png
15771     * @image latex img/list.eps width=\textwidth
15772     *
15773     * A list widget is a container whose children are displayed vertically or
15774     * horizontally, in order, and can be selected.
15775     * The list can accept only one or multiple items selection. Also has many
15776     * modes of items displaying.
15777     *
15778     * A list is a very simple type of list widget.  For more robust
15779     * lists, @ref Genlist should probably be used.
15780     *
15781     * Smart callbacks one can listen to:
15782     * - @c "activated" - The user has double-clicked or pressed
15783     *   (enter|return|spacebar) on an item. The @c event_info parameter
15784     *   is the item that was activated.
15785     * - @c "clicked,double" - The user has double-clicked an item.
15786     *   The @c event_info parameter is the item that was double-clicked.
15787     * - "selected" - when the user selected an item
15788     * - "unselected" - when the user unselected an item
15789     * - "longpressed" - an item in the list is long-pressed
15790     * - "edge,top" - the list is scrolled until the top edge
15791     * - "edge,bottom" - the list is scrolled until the bottom edge
15792     * - "edge,left" - the list is scrolled until the left edge
15793     * - "edge,right" - the list is scrolled until the right edge
15794     * - "language,changed" - the program's language changed
15795     *
15796     * Available styles for it:
15797     * - @c "default"
15798     *
15799     * List of examples:
15800     * @li @ref list_example_01
15801     * @li @ref list_example_02
15802     * @li @ref list_example_03
15803     */
15804
15805    /**
15806     * @addtogroup List
15807     * @{
15808     */
15809
15810    /**
15811     * @enum _Elm_List_Mode
15812     * @typedef Elm_List_Mode
15813     *
15814     * Set list's resize behavior, transverse axis scroll and
15815     * items cropping. See each mode's description for more details.
15816     *
15817     * @note Default value is #ELM_LIST_SCROLL.
15818     *
15819     * Values <b> don't </b> work as bitmask, only one can be choosen.
15820     *
15821     * @see elm_list_mode_set()
15822     * @see elm_list_mode_get()
15823     *
15824     * @ingroup List
15825     */
15826    typedef enum _Elm_List_Mode
15827      {
15828         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. */
15829         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). */
15830         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. */
15831         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. */
15832         ELM_LIST_LAST /**< Indicates error if returned by elm_list_mode_get() */
15833      } Elm_List_Mode;
15834
15835    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().  */
15836
15837    /**
15838     * Add a new list widget to the given parent Elementary
15839     * (container) object.
15840     *
15841     * @param parent The parent object.
15842     * @return a new list widget handle or @c NULL, on errors.
15843     *
15844     * This function inserts a new list widget on the canvas.
15845     *
15846     * @ingroup List
15847     */
15848    EAPI Evas_Object     *elm_list_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
15849
15850    /**
15851     * Starts the list.
15852     *
15853     * @param obj The list object
15854     *
15855     * @note Call before running show() on the list object.
15856     * @warning If not called, it won't display the list properly.
15857     *
15858     * @code
15859     * li = elm_list_add(win);
15860     * elm_list_item_append(li, "First", NULL, NULL, NULL, NULL);
15861     * elm_list_item_append(li, "Second", NULL, NULL, NULL, NULL);
15862     * elm_list_go(li);
15863     * evas_object_show(li);
15864     * @endcode
15865     *
15866     * @ingroup List
15867     */
15868    EAPI void             elm_list_go(Evas_Object *obj) EINA_ARG_NONNULL(1);
15869
15870    /**
15871     * Enable or disable multiple items selection on the list object.
15872     *
15873     * @param obj The list object
15874     * @param multi @c EINA_TRUE to enable multi selection or @c EINA_FALSE to
15875     * disable it.
15876     *
15877     * Disabled by default. If disabled, the user can select a single item of
15878     * the list each time. Selected items are highlighted on list.
15879     * If enabled, many items can be selected.
15880     *
15881     * If a selected item is selected again, it will be unselected.
15882     *
15883     * @see elm_list_multi_select_get()
15884     *
15885     * @ingroup List
15886     */
15887    EAPI void             elm_list_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
15888
15889    /**
15890     * Get a value whether multiple items selection is enabled or not.
15891     *
15892     * @see elm_list_multi_select_set() for details.
15893     *
15894     * @param obj The list object.
15895     * @return @c EINA_TRUE means multiple items selection is enabled.
15896     * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
15897     * @c EINA_FALSE is returned.
15898     *
15899     * @ingroup List
15900     */
15901    EAPI Eina_Bool        elm_list_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15902
15903    /**
15904     * Set which mode to use for the list object.
15905     *
15906     * @param obj The list object
15907     * @param mode One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
15908     * #ELM_LIST_LIMIT or #ELM_LIST_EXPAND.
15909     *
15910     * Set list's resize behavior, transverse axis scroll and
15911     * items cropping. See each mode's description for more details.
15912     *
15913     * @note Default value is #ELM_LIST_SCROLL.
15914     *
15915     * Only one can be set, if a previous one was set, it will be changed
15916     * by the new mode set. Bitmask won't work as well.
15917     *
15918     * @see elm_list_mode_get()
15919     *
15920     * @ingroup List
15921     */
15922    EAPI void             elm_list_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
15923
15924    /**
15925     * Get the mode the list is at.
15926     *
15927     * @param obj The list object
15928     * @return One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
15929     * #ELM_LIST_LIMIT, #ELM_LIST_EXPAND or #ELM_LIST_LAST on errors.
15930     *
15931     * @note see elm_list_mode_set() for more information.
15932     *
15933     * @ingroup List
15934     */
15935    EAPI Elm_List_Mode    elm_list_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15936
15937    /**
15938     * Enable or disable horizontal mode on the list object.
15939     *
15940     * @param obj The list object.
15941     * @param horizontal @c EINA_TRUE to enable horizontal or @c EINA_FALSE to
15942     * disable it, i.e., to enable vertical mode.
15943     *
15944     * @note Vertical mode is set by default.
15945     *
15946     * On horizontal mode items are displayed on list from left to right,
15947     * instead of from top to bottom. Also, the list will scroll horizontally.
15948     * Each item will presents left icon on top and right icon, or end, at
15949     * the bottom.
15950     *
15951     * @see elm_list_horizontal_get()
15952     *
15953     * @ingroup List
15954     */
15955    EAPI void             elm_list_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
15956
15957    /**
15958     * Get a value whether horizontal mode is enabled or not.
15959     *
15960     * @param obj The list object.
15961     * @return @c EINA_TRUE means horizontal mode selection is enabled.
15962     * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
15963     * @c EINA_FALSE is returned.
15964     *
15965     * @see elm_list_horizontal_set() for details.
15966     *
15967     * @ingroup List
15968     */
15969    EAPI Eina_Bool        elm_list_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15970
15971    /**
15972     * Enable or disable always select mode on the list object.
15973     *
15974     * @param obj The list object
15975     * @param always_select @c EINA_TRUE to enable always select mode or
15976     * @c EINA_FALSE to disable it.
15977     *
15978     * @note Always select mode is disabled by default.
15979     *
15980     * Default behavior of list items is to only call its callback function
15981     * the first time it's pressed, i.e., when it is selected. If a selected
15982     * item is pressed again, and multi-select is disabled, it won't call
15983     * this function (if multi-select is enabled it will unselect the item).
15984     *
15985     * If always select is enabled, it will call the callback function
15986     * everytime a item is pressed, so it will call when the item is selected,
15987     * and again when a selected item is pressed.
15988     *
15989     * @see elm_list_always_select_mode_get()
15990     * @see elm_list_multi_select_set()
15991     *
15992     * @ingroup List
15993     */
15994    EAPI void             elm_list_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
15995
15996    /**
15997     * Get a value whether always select mode is enabled or not, meaning that
15998     * an item will always call its callback function, even if already selected.
15999     *
16000     * @param obj The list object
16001     * @return @c EINA_TRUE means horizontal mode selection is enabled.
16002     * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
16003     * @c EINA_FALSE is returned.
16004     *
16005     * @see elm_list_always_select_mode_set() for details.
16006     *
16007     * @ingroup List
16008     */
16009    EAPI Eina_Bool        elm_list_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16010
16011    /**
16012     * Set bouncing behaviour when the scrolled content reaches an edge.
16013     *
16014     * Tell the internal scroller object whether it should bounce or not
16015     * when it reaches the respective edges for each axis.
16016     *
16017     * @param obj The list object
16018     * @param h_bounce Whether to bounce or not in the horizontal axis.
16019     * @param v_bounce Whether to bounce or not in the vertical axis.
16020     *
16021     * @see elm_scroller_bounce_set()
16022     *
16023     * @ingroup List
16024     */
16025    EAPI void             elm_list_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
16026
16027    /**
16028     * Get the bouncing behaviour of the internal scroller.
16029     *
16030     * Get whether the internal scroller should bounce when the edge of each
16031     * axis is reached scrolling.
16032     *
16033     * @param obj The list object.
16034     * @param h_bounce Pointer where to store the bounce state of the horizontal
16035     * axis.
16036     * @param v_bounce Pointer where to store the bounce state of the vertical
16037     * axis.
16038     *
16039     * @see elm_scroller_bounce_get()
16040     * @see elm_list_bounce_set()
16041     *
16042     * @ingroup List
16043     */
16044    EAPI void             elm_list_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
16045
16046    /**
16047     * Set the scrollbar policy.
16048     *
16049     * @param obj The list object
16050     * @param policy_h Horizontal scrollbar policy.
16051     * @param policy_v Vertical scrollbar policy.
16052     *
16053     * This sets the scrollbar visibility policy for the given scroller.
16054     * #ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it
16055     * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
16056     * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
16057     * This applies respectively for the horizontal and vertical scrollbars.
16058     *
16059     * The both are disabled by default, i.e., are set to
16060     * #ELM_SCROLLER_POLICY_OFF.
16061     *
16062     * @ingroup List
16063     */
16064    EAPI void             elm_list_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
16065
16066    /**
16067     * Get the scrollbar policy.
16068     *
16069     * @see elm_list_scroller_policy_get() for details.
16070     *
16071     * @param obj The list object.
16072     * @param policy_h Pointer where to store horizontal scrollbar policy.
16073     * @param policy_v Pointer where to store vertical scrollbar policy.
16074     *
16075     * @ingroup List
16076     */
16077    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);
16078
16079    /**
16080     * Append a new item to the list object.
16081     *
16082     * @param obj The list object.
16083     * @param label The label of the list item.
16084     * @param icon The icon object to use for the left side of the item. An
16085     * icon can be any Evas object, but usually it is an icon created
16086     * with elm_icon_add().
16087     * @param end The icon object to use for the right side of the item. An
16088     * icon can be any Evas object.
16089     * @param func The function to call when the item is clicked.
16090     * @param data The data to associate with the item for related callbacks.
16091     *
16092     * @return The created item or @c NULL upon failure.
16093     *
16094     * A new item will be created and appended to the list, i.e., will
16095     * be set as @b last item.
16096     *
16097     * Items created with this method can be deleted with
16098     * elm_list_item_del().
16099     *
16100     * Associated @p data can be properly freed when item is deleted if a
16101     * callback function is set with elm_list_item_del_cb_set().
16102     *
16103     * If a function is passed as argument, it will be called everytime this item
16104     * is selected, i.e., the user clicks over an unselected item.
16105     * If always select is enabled it will call this function every time
16106     * user clicks over an item (already selected or not).
16107     * If such function isn't needed, just passing
16108     * @c NULL as @p func is enough. The same should be done for @p data.
16109     *
16110     * Simple example (with no function callback or data associated):
16111     * @code
16112     * li = elm_list_add(win);
16113     * ic = elm_icon_add(win);
16114     * elm_icon_file_set(ic, "path/to/image", NULL);
16115     * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
16116     * elm_list_item_append(li, "label", ic, NULL, NULL, NULL);
16117     * elm_list_go(li);
16118     * evas_object_show(li);
16119     * @endcode
16120     *
16121     * @see elm_list_always_select_mode_set()
16122     * @see elm_list_item_del()
16123     * @see elm_list_item_del_cb_set()
16124     * @see elm_list_clear()
16125     * @see elm_icon_add()
16126     *
16127     * @ingroup List
16128     */
16129    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);
16130
16131    /**
16132     * Prepend a new item to the list object.
16133     *
16134     * @param obj The list object.
16135     * @param label The label of the list item.
16136     * @param icon The icon object to use for the left side of the item. An
16137     * icon can be any Evas object, but usually it is an icon created
16138     * with elm_icon_add().
16139     * @param end The icon object to use for the right side of the item. An
16140     * icon can be any Evas object.
16141     * @param func The function to call when the item is clicked.
16142     * @param data The data to associate with the item for related callbacks.
16143     *
16144     * @return The created item or @c NULL upon failure.
16145     *
16146     * A new item will be created and prepended to the list, i.e., will
16147     * be set as @b first item.
16148     *
16149     * Items created with this method can be deleted with
16150     * elm_list_item_del().
16151     *
16152     * Associated @p data can be properly freed when item is deleted if a
16153     * callback function is set with elm_list_item_del_cb_set().
16154     *
16155     * If a function is passed as argument, it will be called everytime this item
16156     * is selected, i.e., the user clicks over an unselected item.
16157     * If always select is enabled it will call this function every time
16158     * user clicks over an item (already selected or not).
16159     * If such function isn't needed, just passing
16160     * @c NULL as @p func is enough. The same should be done for @p data.
16161     *
16162     * @see elm_list_item_append() for a simple code example.
16163     * @see elm_list_always_select_mode_set()
16164     * @see elm_list_item_del()
16165     * @see elm_list_item_del_cb_set()
16166     * @see elm_list_clear()
16167     * @see elm_icon_add()
16168     *
16169     * @ingroup List
16170     */
16171    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);
16172
16173    /**
16174     * Insert a new item into the list object before item @p before.
16175     *
16176     * @param obj The list object.
16177     * @param before The list item to insert before.
16178     * @param label The label of the list item.
16179     * @param icon The icon object to use for the left side of the item. An
16180     * icon can be any Evas object, but usually it is an icon created
16181     * with elm_icon_add().
16182     * @param end The icon object to use for the right side of the item. An
16183     * icon can be any Evas object.
16184     * @param func The function to call when the item is clicked.
16185     * @param data The data to associate with the item for related callbacks.
16186     *
16187     * @return The created item or @c NULL upon failure.
16188     *
16189     * A new item will be created and added to the list. Its position in
16190     * this list will be just before item @p before.
16191     *
16192     * Items created with this method can be deleted with
16193     * elm_list_item_del().
16194     *
16195     * Associated @p data can be properly freed when item is deleted if a
16196     * callback function is set with elm_list_item_del_cb_set().
16197     *
16198     * If a function is passed as argument, it will be called everytime this item
16199     * is selected, i.e., the user clicks over an unselected item.
16200     * If always select is enabled it will call this function every time
16201     * user clicks over an item (already selected or not).
16202     * If such function isn't needed, just passing
16203     * @c NULL as @p func is enough. The same should be done for @p data.
16204     *
16205     * @see elm_list_item_append() for a simple code example.
16206     * @see elm_list_always_select_mode_set()
16207     * @see elm_list_item_del()
16208     * @see elm_list_item_del_cb_set()
16209     * @see elm_list_clear()
16210     * @see elm_icon_add()
16211     *
16212     * @ingroup List
16213     */
16214    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);
16215
16216    /**
16217     * Insert a new item into the list object after item @p after.
16218     *
16219     * @param obj The list object.
16220     * @param after The list item to insert after.
16221     * @param label The label of the list item.
16222     * @param icon The icon object to use for the left side of the item. An
16223     * icon can be any Evas object, but usually it is an icon created
16224     * with elm_icon_add().
16225     * @param end The icon object to use for the right side of the item. An
16226     * icon can be any Evas object.
16227     * @param func The function to call when the item is clicked.
16228     * @param data The data to associate with the item for related callbacks.
16229     *
16230     * @return The created item or @c NULL upon failure.
16231     *
16232     * A new item will be created and added to the list. Its position in
16233     * this list will be just after item @p after.
16234     *
16235     * Items created with this method can be deleted with
16236     * elm_list_item_del().
16237     *
16238     * Associated @p data can be properly freed when item is deleted if a
16239     * callback function is set with elm_list_item_del_cb_set().
16240     *
16241     * If a function is passed as argument, it will be called everytime this item
16242     * is selected, i.e., the user clicks over an unselected item.
16243     * If always select is enabled it will call this function every time
16244     * user clicks over an item (already selected or not).
16245     * If such function isn't needed, just passing
16246     * @c NULL as @p func is enough. The same should be done for @p data.
16247     *
16248     * @see elm_list_item_append() for a simple code example.
16249     * @see elm_list_always_select_mode_set()
16250     * @see elm_list_item_del()
16251     * @see elm_list_item_del_cb_set()
16252     * @see elm_list_clear()
16253     * @see elm_icon_add()
16254     *
16255     * @ingroup List
16256     */
16257    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);
16258
16259    /**
16260     * Insert a new item into the sorted list object.
16261     *
16262     * @param obj The list object.
16263     * @param label The label of the list item.
16264     * @param icon The icon object to use for the left side of the item. An
16265     * icon can be any Evas object, but usually it is an icon created
16266     * with elm_icon_add().
16267     * @param end The icon object to use for the right side of the item. An
16268     * icon can be any Evas object.
16269     * @param func The function to call when the item is clicked.
16270     * @param data The data to associate with the item for related callbacks.
16271     * @param cmp_func The comparing function to be used to sort list
16272     * items <b>by #Elm_List_Item item handles</b>. This function will
16273     * receive two items and compare them, returning a non-negative integer
16274     * if the second item should be place after the first, or negative value
16275     * if should be placed before.
16276     *
16277     * @return The created item or @c NULL upon failure.
16278     *
16279     * @note This function inserts values into a list object assuming it was
16280     * sorted and the result will be sorted.
16281     *
16282     * A new item will be created and added to the list. Its position in
16283     * this list will be found comparing the new item with previously inserted
16284     * items using function @p cmp_func.
16285     *
16286     * Items created with this method can be deleted with
16287     * elm_list_item_del().
16288     *
16289     * Associated @p data can be properly freed when item is deleted if a
16290     * callback function is set with elm_list_item_del_cb_set().
16291     *
16292     * If a function is passed as argument, it will be called everytime this item
16293     * is selected, i.e., the user clicks over an unselected item.
16294     * If always select is enabled it will call this function every time
16295     * user clicks over an item (already selected or not).
16296     * If such function isn't needed, just passing
16297     * @c NULL as @p func is enough. The same should be done for @p data.
16298     *
16299     * @see elm_list_item_append() for a simple code example.
16300     * @see elm_list_always_select_mode_set()
16301     * @see elm_list_item_del()
16302     * @see elm_list_item_del_cb_set()
16303     * @see elm_list_clear()
16304     * @see elm_icon_add()
16305     *
16306     * @ingroup List
16307     */
16308    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);
16309
16310    /**
16311     * Remove all list's items.
16312     *
16313     * @param obj The list object
16314     *
16315     * @see elm_list_item_del()
16316     * @see elm_list_item_append()
16317     *
16318     * @ingroup List
16319     */
16320    EAPI void             elm_list_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
16321
16322    /**
16323     * Get a list of all the list items.
16324     *
16325     * @param obj The list object
16326     * @return An @c Eina_List of list items, #Elm_List_Item,
16327     * or @c NULL on failure.
16328     *
16329     * @see elm_list_item_append()
16330     * @see elm_list_item_del()
16331     * @see elm_list_clear()
16332     *
16333     * @ingroup List
16334     */
16335    EAPI const Eina_List *elm_list_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16336
16337    /**
16338     * Get the selected item.
16339     *
16340     * @param obj The list object.
16341     * @return The selected list item.
16342     *
16343     * The selected item can be unselected with function
16344     * elm_list_item_selected_set().
16345     *
16346     * The selected item always will be highlighted on list.
16347     *
16348     * @see elm_list_selected_items_get()
16349     *
16350     * @ingroup List
16351     */
16352    EAPI Elm_List_Item   *elm_list_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16353
16354    /**
16355     * Return a list of the currently selected list items.
16356     *
16357     * @param obj The list object.
16358     * @return An @c Eina_List of list items, #Elm_List_Item,
16359     * or @c NULL on failure.
16360     *
16361     * Multiple items can be selected if multi select is enabled. It can be
16362     * done with elm_list_multi_select_set().
16363     *
16364     * @see elm_list_selected_item_get()
16365     * @see elm_list_multi_select_set()
16366     *
16367     * @ingroup List
16368     */
16369    EAPI const Eina_List *elm_list_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16370
16371    /**
16372     * Set the selected state of an item.
16373     *
16374     * @param item The list item
16375     * @param selected The selected state
16376     *
16377     * This sets the selected state of the given item @p it.
16378     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
16379     *
16380     * If a new item is selected the previosly selected will be unselected,
16381     * unless multiple selection is enabled with elm_list_multi_select_set().
16382     * Previoulsy selected item can be get with function
16383     * elm_list_selected_item_get().
16384     *
16385     * Selected items will be highlighted.
16386     *
16387     * @see elm_list_item_selected_get()
16388     * @see elm_list_selected_item_get()
16389     * @see elm_list_multi_select_set()
16390     *
16391     * @ingroup List
16392     */
16393    EAPI void             elm_list_item_selected_set(Elm_List_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
16394
16395    /*
16396     * Get whether the @p item is selected or not.
16397     *
16398     * @param item The list item.
16399     * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
16400     * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
16401     *
16402     * @see elm_list_selected_item_set() for details.
16403     * @see elm_list_item_selected_get()
16404     *
16405     * @ingroup List
16406     */
16407    EAPI Eina_Bool        elm_list_item_selected_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16408
16409    /**
16410     * Set or unset item as a separator.
16411     *
16412     * @param it The list item.
16413     * @param setting @c EINA_TRUE to set item @p it as separator or
16414     * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
16415     *
16416     * Items aren't set as separator by default.
16417     *
16418     * If set as separator it will display separator theme, so won't display
16419     * icons or label.
16420     *
16421     * @see elm_list_item_separator_get()
16422     *
16423     * @ingroup List
16424     */
16425    EAPI void             elm_list_item_separator_set(Elm_List_Item *it, Eina_Bool setting) EINA_ARG_NONNULL(1);
16426
16427    /**
16428     * Get a value whether item is a separator or not.
16429     *
16430     * @see elm_list_item_separator_set() for details.
16431     *
16432     * @param it The list item.
16433     * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
16434     * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
16435     *
16436     * @ingroup List
16437     */
16438    EAPI Eina_Bool        elm_list_item_separator_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
16439
16440    /**
16441     * Show @p item in the list view.
16442     *
16443     * @param item The list item to be shown.
16444     *
16445     * It won't animate list until item is visible. If such behavior is wanted,
16446     * use elm_list_bring_in() intead.
16447     *
16448     * @ingroup List
16449     */
16450    EAPI void             elm_list_item_show(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16451
16452    /**
16453     * Bring in the given item to list view.
16454     *
16455     * @param item The item.
16456     *
16457     * This causes list to jump to the given item @p item and show it
16458     * (by scrolling), if it is not fully visible.
16459     *
16460     * This may use animation to do so and take a period of time.
16461     *
16462     * If animation isn't wanted, elm_list_item_show() can be used.
16463     *
16464     * @ingroup List
16465     */
16466    EAPI void             elm_list_item_bring_in(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16467
16468    /**
16469     * Delete them item from the list.
16470     *
16471     * @param item The item of list to be deleted.
16472     *
16473     * If deleting all list items is required, elm_list_clear()
16474     * should be used instead of getting items list and deleting each one.
16475     *
16476     * @see elm_list_clear()
16477     * @see elm_list_item_append()
16478     * @see elm_list_item_del_cb_set()
16479     *
16480     * @ingroup List
16481     */
16482    EAPI void             elm_list_item_del(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16483
16484    /**
16485     * Set the function called when a list item is freed.
16486     *
16487     * @param item The item to set the callback on
16488     * @param func The function called
16489     *
16490     * If there is a @p func, then it will be called prior item's memory release.
16491     * That will be called with the following arguments:
16492     * @li item's data;
16493     * @li item's Evas object;
16494     * @li item itself;
16495     *
16496     * This way, a data associated to a list item could be properly freed.
16497     *
16498     * @ingroup List
16499     */
16500    EAPI void             elm_list_item_del_cb_set(Elm_List_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
16501
16502    /**
16503     * Get the data associated to the item.
16504     *
16505     * @param item The list item
16506     * @return The data associated to @p item
16507     *
16508     * The return value is a pointer to data associated to @p item when it was
16509     * created, with function elm_list_item_append() or similar. If no data
16510     * was passed as argument, it will return @c NULL.
16511     *
16512     * @see elm_list_item_append()
16513     *
16514     * @ingroup List
16515     */
16516    EAPI void            *elm_list_item_data_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16517
16518    /**
16519     * Get the left side icon associated to the item.
16520     *
16521     * @param item The list item
16522     * @return The left side icon associated to @p item
16523     *
16524     * The return value is a pointer to the icon associated to @p item when
16525     * it was
16526     * created, with function elm_list_item_append() or similar, or later
16527     * with function elm_list_item_icon_set(). If no icon
16528     * was passed as argument, it will return @c NULL.
16529     *
16530     * @see elm_list_item_append()
16531     * @see elm_list_item_icon_set()
16532     *
16533     * @ingroup List
16534     */
16535    EAPI Evas_Object     *elm_list_item_icon_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16536
16537    /**
16538     * Set the left side icon associated to the item.
16539     *
16540     * @param item The list item
16541     * @param icon The left side icon object to associate with @p item
16542     *
16543     * The icon object to use at left side of the item. An
16544     * icon can be any Evas object, but usually it is an icon created
16545     * with elm_icon_add().
16546     *
16547     * Once the icon object is set, a previously set one will be deleted.
16548     * @warning Setting the same icon for two items will cause the icon to
16549     * dissapear from the first item.
16550     *
16551     * If an icon was passed as argument on item creation, with function
16552     * elm_list_item_append() or similar, it will be already
16553     * associated to the item.
16554     *
16555     * @see elm_list_item_append()
16556     * @see elm_list_item_icon_get()
16557     *
16558     * @ingroup List
16559     */
16560    EAPI void             elm_list_item_icon_set(Elm_List_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
16561
16562    /**
16563     * Get the right side icon associated to the item.
16564     *
16565     * @param item The list item
16566     * @return The right side icon associated to @p item
16567     *
16568     * The return value is a pointer to the icon associated to @p item when
16569     * it was
16570     * created, with function elm_list_item_append() or similar, or later
16571     * with function elm_list_item_icon_set(). If no icon
16572     * was passed as argument, it will return @c NULL.
16573     *
16574     * @see elm_list_item_append()
16575     * @see elm_list_item_icon_set()
16576     *
16577     * @ingroup List
16578     */
16579    EAPI Evas_Object     *elm_list_item_end_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16580
16581    /**
16582     * Set the right side icon associated to the item.
16583     *
16584     * @param item The list item
16585     * @param end The right side icon object to associate with @p item
16586     *
16587     * The icon object to use at right side of the item. An
16588     * icon can be any Evas object, but usually it is an icon created
16589     * with elm_icon_add().
16590     *
16591     * Once the icon object is set, a previously set one will be deleted.
16592     * @warning Setting the same icon for two items will cause the icon to
16593     * dissapear from the first item.
16594     *
16595     * If an icon was passed as argument on item creation, with function
16596     * elm_list_item_append() or similar, it will be already
16597     * associated to the item.
16598     *
16599     * @see elm_list_item_append()
16600     * @see elm_list_item_end_get()
16601     *
16602     * @ingroup List
16603     */
16604    EAPI void             elm_list_item_end_set(Elm_List_Item *item, Evas_Object *end) EINA_ARG_NONNULL(1);
16605    EAPI Evas_Object     *elm_list_item_base_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16606
16607    /**
16608     * Gets the base object of the item.
16609     *
16610     * @param item The list item
16611     * @return The base object associated with @p item
16612     *
16613     * Base object is the @c Evas_Object that represents that item.
16614     *
16615     * @ingroup List
16616     */
16617    EAPI Evas_Object     *elm_list_item_object_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16618
16619    /**
16620     * Get the label of item.
16621     *
16622     * @param item The item of list.
16623     * @return The label of item.
16624     *
16625     * The return value is a pointer to the label associated to @p item when
16626     * it was created, with function elm_list_item_append(), or later
16627     * with function elm_list_item_label_set. If no label
16628     * was passed as argument, it will return @c NULL.
16629     *
16630     * @see elm_list_item_label_set() for more details.
16631     * @see elm_list_item_append()
16632     *
16633     * @ingroup List
16634     */
16635    EAPI const char      *elm_list_item_label_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16636
16637    /**
16638     * Set the label of item.
16639     *
16640     * @param item The item of list.
16641     * @param text The label of item.
16642     *
16643     * The label to be displayed by the item.
16644     * Label will be placed between left and right side icons (if set).
16645     *
16646     * If a label was passed as argument on item creation, with function
16647     * elm_list_item_append() or similar, it will be already
16648     * displayed by the item.
16649     *
16650     * @see elm_list_item_label_get()
16651     * @see elm_list_item_append()
16652     *
16653     * @ingroup List
16654     */
16655    EAPI void             elm_list_item_label_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
16656
16657
16658    /**
16659     * Get the item before @p it in list.
16660     *
16661     * @param it The list item.
16662     * @return The item before @p it, or @c NULL if none or on failure.
16663     *
16664     * @note If it is the first item, @c NULL will be returned.
16665     *
16666     * @see elm_list_item_append()
16667     * @see elm_list_items_get()
16668     *
16669     * @ingroup List
16670     */
16671    EAPI Elm_List_Item   *elm_list_item_prev(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
16672
16673    /**
16674     * Get the item after @p it in list.
16675     *
16676     * @param it The list item.
16677     * @return The item after @p it, or @c NULL if none or on failure.
16678     *
16679     * @note If it is the last item, @c NULL will be returned.
16680     *
16681     * @see elm_list_item_append()
16682     * @see elm_list_items_get()
16683     *
16684     * @ingroup List
16685     */
16686    EAPI Elm_List_Item   *elm_list_item_next(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
16687
16688    /**
16689     * Sets the disabled/enabled state of a list item.
16690     *
16691     * @param it The item.
16692     * @param disabled The disabled state.
16693     *
16694     * A disabled item cannot be selected or unselected. It will also
16695     * change its appearance (generally greyed out). This sets the
16696     * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
16697     * enabled).
16698     *
16699     * @ingroup List
16700     */
16701    EAPI void             elm_list_item_disabled_set(Elm_List_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
16702
16703    /**
16704     * Get a value whether list item is disabled or not.
16705     *
16706     * @param it The item.
16707     * @return The disabled state.
16708     *
16709     * @see elm_list_item_disabled_set() for more details.
16710     *
16711     * @ingroup List
16712     */
16713    EAPI Eina_Bool        elm_list_item_disabled_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
16714
16715    /**
16716     * Set the text to be shown in a given list item's tooltips.
16717     *
16718     * @param item Target item.
16719     * @param text The text to set in the content.
16720     *
16721     * Setup the text as tooltip to object. The item can have only one tooltip,
16722     * so any previous tooltip data - set with this function or
16723     * elm_list_item_tooltip_content_cb_set() - is removed.
16724     *
16725     * @see elm_object_tooltip_text_set() for more details.
16726     *
16727     * @ingroup List
16728     */
16729    EAPI void             elm_list_item_tooltip_text_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
16730
16731
16732    /**
16733     * @brief Disable size restrictions on an object's tooltip
16734     * @param item The tooltip's anchor object
16735     * @param disable If EINA_TRUE, size restrictions are disabled
16736     * @return EINA_FALSE on failure, EINA_TRUE on success
16737     *
16738     * This function allows a tooltip to expand beyond its parant window's canvas.
16739     * It will instead be limited only by the size of the display.
16740     */
16741    EAPI Eina_Bool        elm_list_item_tooltip_size_restrict_disable(Elm_List_Item *item, Eina_Bool disable) EINA_ARG_NONNULL(1);
16742    /**
16743     * @brief Retrieve size restriction state of an object's tooltip
16744     * @param obj The tooltip's anchor object
16745     * @return If EINA_TRUE, size restrictions are disabled
16746     *
16747     * This function returns whether a tooltip is allowed to expand beyond
16748     * its parant window's canvas.
16749     * It will instead be limited only by the size of the display.
16750     */
16751    EAPI Eina_Bool        elm_list_item_tooltip_size_restrict_disabled_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16752
16753    /**
16754     * Set the content to be shown in the tooltip item.
16755     *
16756     * Setup the tooltip to item. The item can have only one tooltip,
16757     * so any previous tooltip data is removed. @p func(with @p data) will
16758     * be called every time that need show the tooltip and it should
16759     * return a valid Evas_Object. This object is then managed fully by
16760     * tooltip system and is deleted when the tooltip is gone.
16761     *
16762     * @param item the list item being attached a tooltip.
16763     * @param func the function used to create the tooltip contents.
16764     * @param data what to provide to @a func as callback data/context.
16765     * @param del_cb called when data is not needed anymore, either when
16766     *        another callback replaces @a func, the tooltip is unset with
16767     *        elm_list_item_tooltip_unset() or the owner @a item
16768     *        dies. This callback receives as the first parameter the
16769     *        given @a data, and @c event_info is the item.
16770     *
16771     * @see elm_object_tooltip_content_cb_set() for more details.
16772     *
16773     * @ingroup List
16774     */
16775    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);
16776
16777    /**
16778     * Unset tooltip from item.
16779     *
16780     * @param item list item to remove previously set tooltip.
16781     *
16782     * Remove tooltip from item. The callback provided as del_cb to
16783     * elm_list_item_tooltip_content_cb_set() will be called to notify
16784     * it is not used anymore.
16785     *
16786     * @see elm_object_tooltip_unset() for more details.
16787     * @see elm_list_item_tooltip_content_cb_set()
16788     *
16789     * @ingroup List
16790     */
16791    EAPI void             elm_list_item_tooltip_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16792
16793    /**
16794     * Sets a different style for this item tooltip.
16795     *
16796     * @note before you set a style you should define a tooltip with
16797     *       elm_list_item_tooltip_content_cb_set() or
16798     *       elm_list_item_tooltip_text_set()
16799     *
16800     * @param item list item with tooltip already set.
16801     * @param style the theme style to use (default, transparent, ...)
16802     *
16803     * @see elm_object_tooltip_style_set() for more details.
16804     *
16805     * @ingroup List
16806     */
16807    EAPI void             elm_list_item_tooltip_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
16808
16809    /**
16810     * Get the style for this item tooltip.
16811     *
16812     * @param item list item with tooltip already set.
16813     * @return style the theme style in use, defaults to "default". If the
16814     *         object does not have a tooltip set, then NULL is returned.
16815     *
16816     * @see elm_object_tooltip_style_get() for more details.
16817     * @see elm_list_item_tooltip_style_set()
16818     *
16819     * @ingroup List
16820     */
16821    EAPI const char      *elm_list_item_tooltip_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16822
16823    /**
16824     * Set the type of mouse pointer/cursor decoration to be shown,
16825     * when the mouse pointer is over the given list widget item
16826     *
16827     * @param item list item to customize cursor on
16828     * @param cursor the cursor type's name
16829     *
16830     * This function works analogously as elm_object_cursor_set(), but
16831     * here the cursor's changing area is restricted to the item's
16832     * area, and not the whole widget's. Note that that item cursors
16833     * have precedence over widget cursors, so that a mouse over an
16834     * item with custom cursor set will always show @b that cursor.
16835     *
16836     * If this function is called twice for an object, a previously set
16837     * cursor will be unset on the second call.
16838     *
16839     * @see elm_object_cursor_set()
16840     * @see elm_list_item_cursor_get()
16841     * @see elm_list_item_cursor_unset()
16842     *
16843     * @ingroup List
16844     */
16845    EAPI void             elm_list_item_cursor_set(Elm_List_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
16846
16847    /*
16848     * Get the type of mouse pointer/cursor decoration set to be shown,
16849     * when the mouse pointer is over the given list widget item
16850     *
16851     * @param item list item with custom cursor set
16852     * @return the cursor type's name or @c NULL, if no custom cursors
16853     * were set to @p item (and on errors)
16854     *
16855     * @see elm_object_cursor_get()
16856     * @see elm_list_item_cursor_set()
16857     * @see elm_list_item_cursor_unset()
16858     *
16859     * @ingroup List
16860     */
16861    EAPI const char      *elm_list_item_cursor_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16862
16863    /**
16864     * Unset any custom mouse pointer/cursor decoration set to be
16865     * shown, when the mouse pointer is over the given list widget
16866     * item, thus making it show the @b default cursor again.
16867     *
16868     * @param item a list item
16869     *
16870     * Use this call to undo any custom settings on this item's cursor
16871     * decoration, bringing it back to defaults (no custom style set).
16872     *
16873     * @see elm_object_cursor_unset()
16874     * @see elm_list_item_cursor_set()
16875     *
16876     * @ingroup List
16877     */
16878    EAPI void             elm_list_item_cursor_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16879
16880    /**
16881     * Set a different @b style for a given custom cursor set for a
16882     * list item.
16883     *
16884     * @param item list item with custom cursor set
16885     * @param style the <b>theme style</b> to use (e.g. @c "default",
16886     * @c "transparent", etc)
16887     *
16888     * This function only makes sense when one is using custom mouse
16889     * cursor decorations <b>defined in a theme file</b>, which can have,
16890     * given a cursor name/type, <b>alternate styles</b> on it. It
16891     * works analogously as elm_object_cursor_style_set(), but here
16892     * applyed only to list item objects.
16893     *
16894     * @warning Before you set a cursor style you should have definen a
16895     *       custom cursor previously on the item, with
16896     *       elm_list_item_cursor_set()
16897     *
16898     * @see elm_list_item_cursor_engine_only_set()
16899     * @see elm_list_item_cursor_style_get()
16900     *
16901     * @ingroup List
16902     */
16903    EAPI void             elm_list_item_cursor_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
16904
16905    /**
16906     * Get the current @b style set for a given list item's custom
16907     * cursor
16908     *
16909     * @param item list item with custom cursor set.
16910     * @return style the cursor style in use. If the object does not
16911     *         have a cursor set, then @c NULL is returned.
16912     *
16913     * @see elm_list_item_cursor_style_set() for more details
16914     *
16915     * @ingroup List
16916     */
16917    EAPI const char      *elm_list_item_cursor_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16918
16919    /**
16920     * Set if the (custom)cursor for a given list item should be
16921     * searched in its theme, also, or should only rely on the
16922     * rendering engine.
16923     *
16924     * @param item item with custom (custom) cursor already set on
16925     * @param engine_only Use @c EINA_TRUE to have cursors looked for
16926     * only on those provided by the rendering engine, @c EINA_FALSE to
16927     * have them searched on the widget's theme, as well.
16928     *
16929     * @note This call is of use only if you've set a custom cursor
16930     * for list items, with elm_list_item_cursor_set().
16931     *
16932     * @note By default, cursors will only be looked for between those
16933     * provided by the rendering engine.
16934     *
16935     * @ingroup List
16936     */
16937    EAPI void             elm_list_item_cursor_engine_only_set(Elm_List_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
16938
16939    /**
16940     * Get if the (custom) cursor for a given list item is being
16941     * searched in its theme, also, or is only relying on the rendering
16942     * engine.
16943     *
16944     * @param item a list item
16945     * @return @c EINA_TRUE, if cursors are being looked for only on
16946     * those provided by the rendering engine, @c EINA_FALSE if they
16947     * are being searched on the widget's theme, as well.
16948     *
16949     * @see elm_list_item_cursor_engine_only_set(), for more details
16950     *
16951     * @ingroup List
16952     */
16953    EAPI Eina_Bool        elm_list_item_cursor_engine_only_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16954
16955    /**
16956     * @}
16957     */
16958
16959    /**
16960     * @defgroup Slider Slider
16961     * @ingroup Elementary
16962     *
16963     * @image html img/widget/slider/preview-00.png
16964     * @image latex img/widget/slider/preview-00.eps width=\textwidth
16965     *
16966     * The slider adds a dragable ā€œsliderā€ widget for selecting the value of
16967     * something within a range.
16968     *
16969     * A slider can be horizontal or vertical. It can contain an Icon and has a
16970     * primary label as well as a units label (that is formatted with floating
16971     * point values and thus accepts a printf-style format string, like
16972     * ā€œ%1.2f unitsā€. There is also an indicator string that may be somewhere
16973     * else (like on the slider itself) that also accepts a format string like
16974     * units. Label, Icon Unit and Indicator strings/objects are optional.
16975     *
16976     * A slider may be inverted which means values invert, with high vales being
16977     * on the left or top and low values on the right or bottom (as opposed to
16978     * normally being low on the left or top and high on the bottom and right).
16979     *
16980     * The slider should have its minimum and maximum values set by the
16981     * application with  elm_slider_min_max_set() and value should also be set by
16982     * the application before use with  elm_slider_value_set(). The span of the
16983     * slider is its length (horizontally or vertically). This will be scaled by
16984     * the object or applications scaling factor. At any point code can query the
16985     * slider for its value with elm_slider_value_get().
16986     *
16987     * Smart callbacks one can listen to:
16988     * - "changed" - Whenever the slider value is changed by the user.
16989     * - "slider,drag,start" - dragging the slider indicator around has started.
16990     * - "slider,drag,stop" - dragging the slider indicator around has stopped.
16991     * - "delay,changed" - A short time after the value is changed by the user.
16992     * This will be called only when the user stops dragging for
16993     * a very short period or when they release their
16994     * finger/mouse, so it avoids possibly expensive reactions to
16995     * the value change.
16996     *
16997     * Available styles for it:
16998     * - @c "default"
16999     *
17000     * Default contents parts of the slider widget that you can use for are:
17001     * @li "elm.swallow.icon" - A icon of the slider
17002     * @li "elm.swallow.end" - A end part content of the slider
17003     * 
17004     * Here is an example on its usage:
17005     * @li @ref slider_example
17006     */
17007
17008 #define ELM_SLIDER_CONTENT_ICON "elm.swallow.icon"
17009 #define ELM_SLIDER_CONTENT_END "elm.swallow.end"
17010
17011    /**
17012     * @addtogroup Slider
17013     * @{
17014     */
17015
17016    /**
17017     * Add a new slider widget to the given parent Elementary
17018     * (container) object.
17019     *
17020     * @param parent The parent object.
17021     * @return a new slider widget handle or @c NULL, on errors.
17022     *
17023     * This function inserts a new slider widget on the canvas.
17024     *
17025     * @ingroup Slider
17026     */
17027    EAPI Evas_Object       *elm_slider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17028
17029    /**
17030     * Set the label of a given slider widget
17031     *
17032     * @param obj The progress bar object
17033     * @param label The text label string, in UTF-8
17034     *
17035     * @ingroup Slider
17036     * @deprecated use elm_object_text_set() instead.
17037     */
17038    EINA_DEPRECATED EAPI void               elm_slider_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
17039
17040    /**
17041     * Get the label of a given slider widget
17042     *
17043     * @param obj The progressbar object
17044     * @return The text label string, in UTF-8
17045     *
17046     * @ingroup Slider
17047     * @deprecated use elm_object_text_get() instead.
17048     */
17049    EAPI const char        *elm_slider_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17050
17051    /**
17052     * Set the icon object of the slider object.
17053     *
17054     * @param obj The slider object.
17055     * @param icon The icon object.
17056     *
17057     * On horizontal mode, icon is placed at left, and on vertical mode,
17058     * placed at top.
17059     *
17060     * @note Once the icon object is set, a previously set one will be deleted.
17061     * If you want to keep that old content object, use the
17062     * elm_slider_icon_unset() function.
17063     *
17064     * @warning If the object being set does not have minimum size hints set,
17065     * it won't get properly displayed.
17066     *
17067     * @ingroup Slider
17068     * @deprecated use elm_object_content_set() instead.
17069     */
17070    EINA_DEPRECATED EAPI void               elm_slider_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
17071
17072    /**
17073     * Unset an icon set on a given slider widget.
17074     *
17075     * @param obj The slider object.
17076     * @return The icon object that was being used, if any was set, or
17077     * @c NULL, otherwise (and on errors).
17078     *
17079     * On horizontal mode, icon is placed at left, and on vertical mode,
17080     * placed at top.
17081     *
17082     * This call will unparent and return the icon object which was set
17083     * for this widget, previously, on success.
17084     *
17085     * @see elm_slider_icon_set() for more details
17086     * @see elm_slider_icon_get()
17087     * @deprecated use elm_object_content_unset() instead.
17088     *
17089     * @ingroup Slider
17090     */
17091    EINA_DEPRECATED EAPI Evas_Object       *elm_slider_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
17092
17093    /**
17094     * Retrieve the icon object set for a given slider widget.
17095     *
17096     * @param obj The slider object.
17097     * @return The icon object's handle, if @p obj had one set, or @c NULL,
17098     * otherwise (and on errors).
17099     *
17100     * On horizontal mode, icon is placed at left, and on vertical mode,
17101     * placed at top.
17102     *
17103     * @see elm_slider_icon_set() for more details
17104     * @see elm_slider_icon_unset()
17105     *
17106     * @ingroup Slider
17107     */
17108    EINA_DEPRECATED EAPI Evas_Object       *elm_slider_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17109
17110    /**
17111     * Set the end object of the slider object.
17112     *
17113     * @param obj The slider object.
17114     * @param end The end object.
17115     *
17116     * On horizontal mode, end is placed at left, and on vertical mode,
17117     * placed at bottom.
17118     *
17119     * @note Once the icon object is set, a previously set one will be deleted.
17120     * If you want to keep that old content object, use the
17121     * elm_slider_end_unset() function.
17122     *
17123     * @warning If the object being set does not have minimum size hints set,
17124     * it won't get properly displayed.
17125     *
17126     * @ingroup Slider
17127     */
17128    EINA_DEPRECATED EAPI void               elm_slider_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1);
17129
17130    /**
17131     * Unset an end object set on a given slider widget.
17132     *
17133     * @param obj The slider object.
17134     * @return The end object that was being used, if any was set, or
17135     * @c NULL, otherwise (and on errors).
17136     *
17137     * On horizontal mode, end is placed at left, and on vertical mode,
17138     * placed at bottom.
17139     *
17140     * This call will unparent and return the icon object which was set
17141     * for this widget, previously, on success.
17142     *
17143     * @see elm_slider_end_set() for more details.
17144     * @see elm_slider_end_get()
17145     *
17146     * @ingroup Slider
17147     */
17148    EINA_DEPRECATED EAPI Evas_Object       *elm_slider_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
17149
17150    /**
17151     * Retrieve the end object set for a given slider widget.
17152     *
17153     * @param obj The slider object.
17154     * @return The end object's handle, if @p obj had one set, or @c NULL,
17155     * otherwise (and on errors).
17156     *
17157     * On horizontal mode, icon is placed at right, and on vertical mode,
17158     * placed at bottom.
17159     *
17160     * @see elm_slider_end_set() for more details.
17161     * @see elm_slider_end_unset()
17162     *
17163     * @ingroup Slider
17164     */
17165    EINA_DEPRECATED EAPI Evas_Object       *elm_slider_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17166
17167    /**
17168     * Set the (exact) length of the bar region of a given slider widget.
17169     *
17170     * @param obj The slider object.
17171     * @param size The length of the slider's bar region.
17172     *
17173     * This sets the minimum width (when in horizontal mode) or height
17174     * (when in vertical mode) of the actual bar area of the slider
17175     * @p obj. This in turn affects the object's minimum size. Use
17176     * this when you're not setting other size hints expanding on the
17177     * given direction (like weight and alignment hints) and you would
17178     * like it to have a specific size.
17179     *
17180     * @note Icon, end, label, indicator and unit text around @p obj
17181     * will require their
17182     * own space, which will make @p obj to require more the @p size,
17183     * actually.
17184     *
17185     * @see elm_slider_span_size_get()
17186     *
17187     * @ingroup Slider
17188     */
17189    EAPI void               elm_slider_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
17190
17191    /**
17192     * Get the length set for the bar region of a given slider widget
17193     *
17194     * @param obj The slider object.
17195     * @return The length of the slider's bar region.
17196     *
17197     * If that size was not set previously, with
17198     * elm_slider_span_size_set(), this call will return @c 0.
17199     *
17200     * @ingroup Slider
17201     */
17202    EAPI Evas_Coord         elm_slider_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17203
17204    /**
17205     * Set the format string for the unit label.
17206     *
17207     * @param obj The slider object.
17208     * @param format The format string for the unit display.
17209     *
17210     * Unit label is displayed all the time, if set, after slider's bar.
17211     * In horizontal mode, at right and in vertical mode, at bottom.
17212     *
17213     * If @c NULL, unit label won't be visible. If not it sets the format
17214     * string for the label text. To the label text is provided a floating point
17215     * value, so the label text can display up to 1 floating point value.
17216     * Note that this is optional.
17217     *
17218     * Use a format string such as "%1.2f meters" for example, and it will
17219     * display values like: "3.14 meters" for a value equal to 3.14159.
17220     *
17221     * Default is unit label disabled.
17222     *
17223     * @see elm_slider_indicator_format_get()
17224     *
17225     * @ingroup Slider
17226     */
17227    EAPI void               elm_slider_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
17228
17229    /**
17230     * Get the unit label format of the slider.
17231     *
17232     * @param obj The slider object.
17233     * @return The unit label format string in UTF-8.
17234     *
17235     * Unit label is displayed all the time, if set, after slider's bar.
17236     * In horizontal mode, at right and in vertical mode, at bottom.
17237     *
17238     * @see elm_slider_unit_format_set() for more
17239     * information on how this works.
17240     *
17241     * @ingroup Slider
17242     */
17243    EAPI const char        *elm_slider_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17244
17245    /**
17246     * Set the format string for the indicator label.
17247     *
17248     * @param obj The slider object.
17249     * @param indicator The format string for the indicator display.
17250     *
17251     * The slider may display its value somewhere else then unit label,
17252     * for example, above the slider knob that is dragged around. This function
17253     * sets the format string used for this.
17254     *
17255     * If @c NULL, indicator label won't be visible. If not it sets the format
17256     * string for the label text. To the label text is provided a floating point
17257     * value, so the label text can display up to 1 floating point value.
17258     * Note that this is optional.
17259     *
17260     * Use a format string such as "%1.2f meters" for example, and it will
17261     * display values like: "3.14 meters" for a value equal to 3.14159.
17262     *
17263     * Default is indicator label disabled.
17264     *
17265     * @see elm_slider_indicator_format_get()
17266     *
17267     * @ingroup Slider
17268     */
17269    EAPI void               elm_slider_indicator_format_set(Evas_Object *obj, const char *indicator) EINA_ARG_NONNULL(1);
17270
17271    /**
17272     * Get the indicator label format of the slider.
17273     *
17274     * @param obj The slider object.
17275     * @return The indicator label format string in UTF-8.
17276     *
17277     * The slider may display its value somewhere else then unit label,
17278     * for example, above the slider knob that is dragged around. This function
17279     * gets the format string used for this.
17280     *
17281     * @see elm_slider_indicator_format_set() for more
17282     * information on how this works.
17283     *
17284     * @ingroup Slider
17285     */
17286    EAPI const char        *elm_slider_indicator_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17287
17288    /**
17289     * Set the format function pointer for the indicator label
17290     *
17291     * @param obj The slider object.
17292     * @param func The indicator format function.
17293     * @param free_func The freeing function for the format string.
17294     *
17295     * Set the callback function to format the indicator string.
17296     *
17297     * @see elm_slider_indicator_format_set() for more info on how this works.
17298     *
17299     * @ingroup Slider
17300     */
17301   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);
17302
17303   /**
17304    * Set the format function pointer for the units label
17305    *
17306    * @param obj The slider object.
17307    * @param func The units format function.
17308    * @param free_func The freeing function for the format string.
17309    *
17310    * Set the callback function to format the indicator string.
17311    *
17312    * @see elm_slider_units_format_set() for more info on how this works.
17313    *
17314    * @ingroup Slider
17315    */
17316   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);
17317
17318   /**
17319    * Set the orientation of a given slider widget.
17320    *
17321    * @param obj The slider object.
17322    * @param horizontal Use @c EINA_TRUE to make @p obj to be
17323    * @b horizontal, @c EINA_FALSE to make it @b vertical.
17324    *
17325    * Use this function to change how your slider is to be
17326    * disposed: vertically or horizontally.
17327    *
17328    * By default it's displayed horizontally.
17329    *
17330    * @see elm_slider_horizontal_get()
17331    *
17332    * @ingroup Slider
17333    */
17334    EAPI void               elm_slider_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
17335
17336    /**
17337     * Retrieve the orientation of a given slider widget
17338     *
17339     * @param obj The slider object.
17340     * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
17341     * @c EINA_FALSE if it's @b vertical (and on errors).
17342     *
17343     * @see elm_slider_horizontal_set() for more details.
17344     *
17345     * @ingroup Slider
17346     */
17347    EAPI Eina_Bool          elm_slider_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17348
17349    /**
17350     * Set the minimum and maximum values for the slider.
17351     *
17352     * @param obj The slider object.
17353     * @param min The minimum value.
17354     * @param max The maximum value.
17355     *
17356     * Define the allowed range of values to be selected by the user.
17357     *
17358     * If actual value is less than @p min, it will be updated to @p min. If it
17359     * is bigger then @p max, will be updated to @p max. Actual value can be
17360     * get with elm_slider_value_get().
17361     *
17362     * By default, min is equal to 0.0, and max is equal to 1.0.
17363     *
17364     * @warning Maximum must be greater than minimum, otherwise behavior
17365     * is undefined.
17366     *
17367     * @see elm_slider_min_max_get()
17368     *
17369     * @ingroup Slider
17370     */
17371    EAPI void               elm_slider_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
17372
17373    /**
17374     * Get the minimum and maximum values of the slider.
17375     *
17376     * @param obj The slider object.
17377     * @param min Pointer where to store the minimum value.
17378     * @param max Pointer where to store the maximum value.
17379     *
17380     * @note If only one value is needed, the other pointer can be passed
17381     * as @c NULL.
17382     *
17383     * @see elm_slider_min_max_set() for details.
17384     *
17385     * @ingroup Slider
17386     */
17387    EAPI void               elm_slider_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
17388
17389    /**
17390     * Set the value the slider displays.
17391     *
17392     * @param obj The slider object.
17393     * @param val The value to be displayed.
17394     *
17395     * Value will be presented on the unit label following format specified with
17396     * elm_slider_unit_format_set() and on indicator with
17397     * elm_slider_indicator_format_set().
17398     *
17399     * @warning The value must to be between min and max values. This values
17400     * are set by elm_slider_min_max_set().
17401     *
17402     * @see elm_slider_value_get()
17403     * @see elm_slider_unit_format_set()
17404     * @see elm_slider_indicator_format_set()
17405     * @see elm_slider_min_max_set()
17406     *
17407     * @ingroup Slider
17408     */
17409    EAPI void               elm_slider_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
17410
17411    /**
17412     * Get the value displayed by the spinner.
17413     *
17414     * @param obj The spinner object.
17415     * @return The value displayed.
17416     *
17417     * @see elm_spinner_value_set() for details.
17418     *
17419     * @ingroup Slider
17420     */
17421    EAPI double             elm_slider_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17422
17423    /**
17424     * Invert a given slider widget's displaying values order
17425     *
17426     * @param obj The slider object.
17427     * @param inverted Use @c EINA_TRUE to make @p obj inverted,
17428     * @c EINA_FALSE to bring it back to default, non-inverted values.
17429     *
17430     * A slider may be @b inverted, in which state it gets its
17431     * values inverted, with high vales being on the left or top and
17432     * low values on the right or bottom, as opposed to normally have
17433     * the low values on the former and high values on the latter,
17434     * respectively, for horizontal and vertical modes.
17435     *
17436     * @see elm_slider_inverted_get()
17437     *
17438     * @ingroup Slider
17439     */
17440    EAPI void               elm_slider_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
17441
17442    /**
17443     * Get whether a given slider widget's displaying values are
17444     * inverted or not.
17445     *
17446     * @param obj The slider object.
17447     * @return @c EINA_TRUE, if @p obj has inverted values,
17448     * @c EINA_FALSE otherwise (and on errors).
17449     *
17450     * @see elm_slider_inverted_set() for more details.
17451     *
17452     * @ingroup Slider
17453     */
17454    EAPI Eina_Bool          elm_slider_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17455
17456    /**
17457     * Set whether to enlarge slider indicator (augmented knob) or not.
17458     *
17459     * @param obj The slider object.
17460     * @param show @c EINA_TRUE will make it enlarge, @c EINA_FALSE will
17461     * let the knob always at default size.
17462     *
17463     * By default, indicator will be bigger while dragged by the user.
17464     *
17465     * @warning It won't display values set with
17466     * elm_slider_indicator_format_set() if you disable indicator.
17467     *
17468     * @ingroup Slider
17469     */
17470    EAPI void               elm_slider_indicator_show_set(Evas_Object *obj, Eina_Bool show) EINA_ARG_NONNULL(1);
17471
17472    /**
17473     * Get whether a given slider widget's enlarging indicator or not.
17474     *
17475     * @param obj The slider object.
17476     * @return @c EINA_TRUE, if @p obj is enlarging indicator, or
17477     * @c EINA_FALSE otherwise (and on errors).
17478     *
17479     * @see elm_slider_indicator_show_set() for details.
17480     *
17481     * @ingroup Slider
17482     */
17483    EAPI Eina_Bool          elm_slider_indicator_show_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17484
17485    /**
17486     * @}
17487     */
17488
17489    /**
17490     * @addtogroup Actionslider Actionslider
17491     *
17492     * @image html img/widget/actionslider/preview-00.png
17493     * @image latex img/widget/actionslider/preview-00.eps
17494     *
17495     * An actionslider is a switcher for 2 or 3 labels with customizable magnet
17496     * properties. The user drags and releases the indicator, to choose a label.
17497     *
17498     * Labels occupy the following positions.
17499     * a. Left
17500     * b. Right
17501     * c. Center
17502     *
17503     * Positions can be enabled or disabled.
17504     *
17505     * Magnets can be set on the above positions.
17506     *
17507     * When the indicator is released, it will move to its nearest "enabled and magnetized" position.
17508     *
17509     * @note By default all positions are set as enabled.
17510     *
17511     * Signals that you can add callbacks for are:
17512     *
17513     * "selected" - when user selects an enabled position (the label is passed
17514     *              as event info)".
17515     * @n
17516     * "pos_changed" - when the indicator reaches any of the positions("left",
17517     *                 "right" or "center").
17518     *
17519     * See an example of actionslider usage @ref actionslider_example_page "here"
17520     * @{
17521     */
17522
17523    typedef enum _Elm_Actionslider_Indicator_Pos
17524      {
17525         ELM_ACTIONSLIDER_INDICATOR_NONE,
17526         ELM_ACTIONSLIDER_INDICATOR_LEFT,
17527         ELM_ACTIONSLIDER_INDICATOR_RIGHT,
17528         ELM_ACTIONSLIDER_INDICATOR_CENTER
17529      } Elm_Actionslider_Indicator_Pos;
17530
17531    typedef enum _Elm_Actionslider_Magnet_Pos
17532      {
17533         ELM_ACTIONSLIDER_MAGNET_NONE = 0,
17534         ELM_ACTIONSLIDER_MAGNET_LEFT = 1 << 0,
17535         ELM_ACTIONSLIDER_MAGNET_CENTER = 1 << 1,
17536         ELM_ACTIONSLIDER_MAGNET_RIGHT= 1 << 2,
17537         ELM_ACTIONSLIDER_MAGNET_ALL = (1 << 3) -1,
17538         ELM_ACTIONSLIDER_MAGNET_BOTH = (1 << 3)
17539      } Elm_Actionslider_Magnet_Pos;
17540
17541    typedef enum _Elm_Actionslider_Label_Pos
17542      {
17543         ELM_ACTIONSLIDER_LABEL_LEFT,
17544         ELM_ACTIONSLIDER_LABEL_RIGHT,
17545         ELM_ACTIONSLIDER_LABEL_CENTER,
17546         ELM_ACTIONSLIDER_LABEL_BUTTON
17547      } Elm_Actionslider_Label_Pos;
17548
17549    /* smart callbacks called:
17550     * "indicator,position" - when a button reaches to the special position like "left", "right" and "center".
17551     */
17552
17553    /**
17554     * Add a new actionslider to the parent.
17555     *
17556     * @param parent The parent object
17557     * @return The new actionslider object or NULL if it cannot be created
17558     */
17559    EAPI Evas_Object          *elm_actionslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17560
17561    /**
17562    * Set actionslider label.
17563    *
17564    * @param[in] obj The actionslider object
17565    * @param[in] pos The position of the label.
17566    * (ELM_ACTIONSLIDER_LABEL_LEFT, ELM_ACTIONSLIDER_LABEL_RIGHT)
17567    * @param label The label which is going to be set.
17568    */
17569    EAPI void               elm_actionslider_label_set(Evas_Object *obj, Elm_Actionslider_Label_Pos pos, const char *label) EINA_ARG_NONNULL(1);
17570    /**
17571     * Get actionslider labels.
17572     *
17573     * @param obj The actionslider object
17574     * @param left_label A char** to place the left_label of @p obj into.
17575     * @param center_label A char** to place the center_label of @p obj into.
17576     * @param right_label A char** to place the right_label of @p obj into.
17577     */
17578    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);
17579    /**
17580     * Get actionslider selected label.
17581     *
17582     * @param obj The actionslider object
17583     * @return The selected label
17584     */
17585    EAPI const char           *elm_actionslider_selected_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17586    /**
17587     * Set actionslider indicator position.
17588     *
17589     * @param obj The actionslider object.
17590     * @param pos The position of the indicator.
17591     */
17592    EAPI void                elm_actionslider_indicator_pos_set(Evas_Object *obj, Elm_Actionslider_Indicator_Pos pos) EINA_ARG_NONNULL(1);
17593    /**
17594     * Get actionslider indicator position.
17595     *
17596     * @param obj The actionslider object.
17597     * @return The position of the indicator.
17598     */
17599    EAPI Elm_Actionslider_Indicator_Pos  elm_actionslider_indicator_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17600    /**
17601     * Set actionslider magnet position. To make multiple positions magnets @c or
17602     * them together(e.g.: ELM_ACTIONSLIDER_MAGNET_LEFT | ELM_ACTIONSLIDER_MAGNET_RIGHT)
17603     *
17604     * @param obj The actionslider object.
17605     * @param pos Bit mask indicating the magnet positions.
17606     */
17607    EAPI void                elm_actionslider_magnet_pos_set(Evas_Object *obj, Elm_Actionslider_Magnet_Pos pos) EINA_ARG_NONNULL(1);
17608    /**
17609     * Get actionslider magnet position.
17610     *
17611     * @param obj The actionslider object.
17612     * @return The positions with magnet property.
17613     */
17614    EAPI Elm_Actionslider_Magnet_Pos  elm_actionslider_magnet_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17615    /**
17616     * Set actionslider enabled position. To set multiple positions as enabled @c or
17617     * them together(e.g.: ELM_ACTIONSLIDER_MAGNET_LEFT | ELM_ACTIONSLIDER_MAGNET_RIGHT).
17618     *
17619     * @note All the positions are enabled by default.
17620     *
17621     * @param obj The actionslider object.
17622     * @param pos Bit mask indicating the enabled positions.
17623     */
17624    EAPI void                  elm_actionslider_enabled_pos_set(Evas_Object *obj, Elm_Actionslider_Magnet_Pos pos) EINA_ARG_NONNULL(1);
17625    /**
17626     * Get actionslider enabled position.
17627     *
17628     * @param obj The actionslider object.
17629     * @return The enabled positions.
17630     */
17631    EAPI Elm_Actionslider_Magnet_Pos  elm_actionslider_enabled_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17632    /**
17633     * Set the label used on the indicator.
17634     *
17635     * @param obj The actionslider object
17636     * @param label The label to be set on the indicator.
17637     * @deprecated use elm_object_text_set() instead.
17638     */
17639    EINA_DEPRECATED EAPI void                  elm_actionslider_indicator_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
17640    /**
17641     * Get the label used on the indicator object.
17642     *
17643     * @param obj The actionslider object
17644     * @return The indicator label
17645     * @deprecated use elm_object_text_get() instead.
17646     */
17647    EINA_DEPRECATED EAPI const char           *elm_actionslider_indicator_label_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
17648
17649    /**
17650    * Hold actionslider object movement.
17651    *
17652    * @param[in] obj The actionslider object
17653    * @param[in] flag Actionslider hold/release
17654    * (EINA_TURE = hold/EIN_FALSE = release)
17655    *
17656    * @ingroup Actionslider
17657    */
17658    EAPI void                             elm_actionslider_hold(Evas_Object *obj, Eina_Bool flag) EINA_ARG_NONNULL(1);
17659
17660
17661    /**
17662     *
17663     */
17664
17665    /**
17666     * @defgroup Genlist Genlist
17667     *
17668     * @image html img/widget/genlist/preview-00.png
17669     * @image latex img/widget/genlist/preview-00.eps
17670     * @image html img/genlist.png
17671     * @image latex img/genlist.eps
17672     *
17673     * This widget aims to have more expansive list than the simple list in
17674     * Elementary that could have more flexible items and allow many more entries
17675     * while still being fast and low on memory usage. At the same time it was
17676     * also made to be able to do tree structures. But the price to pay is more
17677     * complexity when it comes to usage. If all you want is a simple list with
17678     * icons and a single label, use the normal @ref List object.
17679     *
17680     * Genlist has a fairly large API, mostly because it's relatively complex,
17681     * trying to be both expansive, powerful and efficient. First we will begin
17682     * an overview on the theory behind genlist.
17683     *
17684     * @section Genlist_Item_Class Genlist item classes - creating items
17685     *
17686     * In order to have the ability to add and delete items on the fly, genlist
17687     * implements a class (callback) system where the application provides a
17688     * structure with information about that type of item (genlist may contain
17689     * multiple different items with different classes, states and styles).
17690     * Genlist will call the functions in this struct (methods) when an item is
17691     * "realized" (i.e., created dynamically, while the user is scrolling the
17692     * grid). All objects will simply be deleted when no longer needed with
17693     * evas_object_del(). The #Elm_Genlist_Item_Class structure contains the
17694     * following members:
17695     * - @c item_style - This is a constant string and simply defines the name
17696     *   of the item style. It @b must be specified and the default should be @c
17697     *   "default".
17698     *
17699     * - @c func - A struct with pointers to functions that will be called when
17700     *   an item is going to be actually created. All of them receive a @c data
17701     *   parameter that will point to the same data passed to
17702     *   elm_genlist_item_append() and related item creation functions, and a @c
17703     *   obj parameter that points to the genlist object itself.
17704     *
17705     * The function pointers inside @c func are @c label_get, @c icon_get, @c
17706     * state_get and @c del. The 3 first functions also receive a @c part
17707     * parameter described below. A brief description of these functions follows:
17708     *
17709     * - @c label_get - The @c part parameter is the name string of one of the
17710     *   existing text parts in the Edje group implementing the item's theme.
17711     *   This function @b must return a strdup'()ed string, as the caller will
17712     *   free() it when done. See #Elm_Genlist_Item_Label_Get_Cb.
17713     * - @c content_get - The @c part parameter is the name string of one of the
17714     *   existing (content) swallow parts in the Edje group implementing the item's
17715     *   theme. It must return @c NULL, when no content is desired, or a valid
17716     *   object handle, otherwise.  The object will be deleted by the genlist on
17717     *   its deletion or when the item is "unrealized".  See
17718     *   #Elm_Genlist_Item_Icon_Get_Cb.
17719     * - @c func.state_get - The @c part parameter is the name string of one of
17720     *   the state parts in the Edje group implementing the item's theme. Return
17721     *   @c EINA_FALSE for false/off or @c EINA_TRUE for true/on. Genlists will
17722     *   emit a signal to its theming Edje object with @c "elm,state,XXX,active"
17723     *   and @c "elm" as "emission" and "source" arguments, respectively, when
17724     *   the state is true (the default is false), where @c XXX is the name of
17725     *   the (state) part.  See #Elm_Genlist_Item_State_Get_Cb.
17726     * - @c func.del - This is intended for use when genlist items are deleted,
17727     *   so any data attached to the item (e.g. its data parameter on creation)
17728     *   can be deleted. See #Elm_Genlist_Item_Del_Cb.
17729     *
17730     * available item styles:
17731     * - default
17732     * - default_style - The text part is a textblock
17733     *
17734     * @image html img/widget/genlist/preview-04.png
17735     * @image latex img/widget/genlist/preview-04.eps
17736     *
17737     * - double_label
17738     *
17739     * @image html img/widget/genlist/preview-01.png
17740     * @image latex img/widget/genlist/preview-01.eps
17741     *
17742     * - icon_top_text_bottom
17743     *
17744     * @image html img/widget/genlist/preview-02.png
17745     * @image latex img/widget/genlist/preview-02.eps
17746     *
17747     * - group_index
17748     *
17749     * @image html img/widget/genlist/preview-03.png
17750     * @image latex img/widget/genlist/preview-03.eps
17751     *
17752     * @section Genlist_Items Structure of items
17753     *
17754     * An item in a genlist can have 0 or more text labels (they can be regular
17755     * text or textblock Evas objects - that's up to the style to determine), 0
17756     * or more contents (which are simply objects swallowed into the genlist item's
17757     * theming Edje object) and 0 or more <b>boolean states</b>, which have the
17758     * behavior left to the user to define. The Edje part names for each of
17759     * these properties will be looked up, in the theme file for the genlist,
17760     * under the Edje (string) data items named @c "labels", @c "contents" and @c
17761     * "states", respectively. For each of those properties, if more than one
17762     * part is provided, they must have names listed separated by spaces in the
17763     * data fields. For the default genlist item theme, we have @b one label
17764     * part (@c "elm.text"), @b two content parts (@c "elm.swalllow.icon" and @c
17765     * "elm.swallow.end") and @b no state parts.
17766     *
17767     * A genlist item may be at one of several styles. Elementary provides one
17768     * by default - "default", but this can be extended by system or application
17769     * custom themes/overlays/extensions (see @ref Theme "themes" for more
17770     * details).
17771     *
17772     * @section Genlist_Manipulation Editing and Navigating
17773     *
17774     * Items can be added by several calls. All of them return a @ref
17775     * Elm_Genlist_Item handle that is an internal member inside the genlist.
17776     * They all take a data parameter that is meant to be used for a handle to
17777     * the applications internal data (eg the struct with the original item
17778     * data). The parent parameter is the parent genlist item this belongs to if
17779     * it is a tree or an indexed group, and NULL if there is no parent. The
17780     * flags can be a bitmask of #ELM_GENLIST_ITEM_NONE,
17781     * #ELM_GENLIST_ITEM_SUBITEMS and #ELM_GENLIST_ITEM_GROUP. If
17782     * #ELM_GENLIST_ITEM_SUBITEMS is set then this item is displayed as an item
17783     * that is able to expand and have child items.  If ELM_GENLIST_ITEM_GROUP
17784     * is set then this item is group index item that is displayed at the top
17785     * until the next group comes. The func parameter is a convenience callback
17786     * that is called when the item is selected and the data parameter will be
17787     * the func_data parameter, obj be the genlist object and event_info will be
17788     * the genlist item.
17789     *
17790     * elm_genlist_item_append() adds an item to the end of the list, or if
17791     * there is a parent, to the end of all the child items of the parent.
17792     * elm_genlist_item_prepend() is the same but adds to the beginning of
17793     * the list or children list. elm_genlist_item_insert_before() inserts at
17794     * item before another item and elm_genlist_item_insert_after() inserts after
17795     * the indicated item.
17796     *
17797     * The application can clear the list with elm_genlist_clear() which deletes
17798     * all the items in the list and elm_genlist_item_del() will delete a specific
17799     * item. elm_genlist_item_subitems_clear() will clear all items that are
17800     * children of the indicated parent item.
17801     *
17802     * To help inspect list items you can jump to the item at the top of the list
17803     * with elm_genlist_first_item_get() which will return the item pointer, and
17804     * similarly elm_genlist_last_item_get() gets the item at the end of the list.
17805     * elm_genlist_item_next_get() and elm_genlist_item_prev_get() get the next
17806     * and previous items respectively relative to the indicated item. Using
17807     * these calls you can walk the entire item list/tree. Note that as a tree
17808     * the items are flattened in the list, so elm_genlist_item_parent_get() will
17809     * let you know which item is the parent (and thus know how to skip them if
17810     * wanted).
17811     *
17812     * @section Genlist_Muti_Selection Multi-selection
17813     *
17814     * If the application wants multiple items to be able to be selected,
17815     * elm_genlist_multi_select_set() can enable this. If the list is
17816     * single-selection only (the default), then elm_genlist_selected_item_get()
17817     * will return the selected item, if any, or NULL I none is selected. If the
17818     * list is multi-select then elm_genlist_selected_items_get() will return a
17819     * list (that is only valid as long as no items are modified (added, deleted,
17820     * selected or unselected)).
17821     *
17822     * @section Genlist_Usage_Hints Usage hints
17823     *
17824     * There are also convenience functions. elm_genlist_item_genlist_get() will
17825     * return the genlist object the item belongs to. elm_genlist_item_show()
17826     * will make the scroller scroll to show that specific item so its visible.
17827     * elm_genlist_item_data_get() returns the data pointer set by the item
17828     * creation functions.
17829     *
17830     * If an item changes (state of boolean changes, label or contents change),
17831     * then use elm_genlist_item_update() to have genlist update the item with
17832     * the new state. Genlist will re-realize the item thus call the functions
17833     * in the _Elm_Genlist_Item_Class for that item.
17834     *
17835     * To programmatically (un)select an item use elm_genlist_item_selected_set().
17836     * To get its selected state use elm_genlist_item_selected_get(). Similarly
17837     * to expand/contract an item and get its expanded state, use
17838     * elm_genlist_item_expanded_set() and elm_genlist_item_expanded_get(). And
17839     * again to make an item disabled (unable to be selected and appear
17840     * differently) use elm_genlist_item_disabled_set() to set this and
17841     * elm_genlist_item_disabled_get() to get the disabled state.
17842     *
17843     * In general to indicate how the genlist should expand items horizontally to
17844     * fill the list area, use elm_genlist_horizontal_set(). Valid modes are
17845     * ELM_LIST_LIMIT and ELM_LIST_SCROLL. The default is ELM_LIST_SCROLL. This
17846     * mode means that if items are too wide to fit, the scroller will scroll
17847     * horizontally. Otherwise items are expanded to fill the width of the
17848     * viewport of the scroller. If it is ELM_LIST_LIMIT, items will be expanded
17849     * to the viewport width and limited to that size. This can be combined with
17850     * a different style that uses edjes' ellipsis feature (cutting text off like
17851     * this: "tex...").
17852     *
17853     * Items will only call their selection func and callback when first becoming
17854     * selected. Any further clicks will do nothing, unless you enable always
17855     * select with elm_genlist_always_select_mode_set(). This means even if
17856     * selected, every click will make the selected callbacks be called.
17857     * elm_genlist_no_select_mode_set() will turn off the ability to select
17858     * items entirely and they will neither appear selected nor call selected
17859     * callback functions.
17860     *
17861     * Remember that you can create new styles and add your own theme augmentation
17862     * per application with elm_theme_extension_add(). If you absolutely must
17863     * have a specific style that overrides any theme the user or system sets up
17864     * you can use elm_theme_overlay_add() to add such a file.
17865     *
17866     * @section Genlist_Implementation Implementation
17867     *
17868     * Evas tracks every object you create. Every time it processes an event
17869     * (mouse move, down, up etc.) it needs to walk through objects and find out
17870     * what event that affects. Even worse every time it renders display updates,
17871     * in order to just calculate what to re-draw, it needs to walk through many
17872     * many many objects. Thus, the more objects you keep active, the more
17873     * overhead Evas has in just doing its work. It is advisable to keep your
17874     * active objects to the minimum working set you need. Also remember that
17875     * object creation and deletion carries an overhead, so there is a
17876     * middle-ground, which is not easily determined. But don't keep massive lists
17877     * of objects you can't see or use. Genlist does this with list objects. It
17878     * creates and destroys them dynamically as you scroll around. It groups them
17879     * into blocks so it can determine the visibility etc. of a whole block at
17880     * once as opposed to having to walk the whole list. This 2-level list allows
17881     * for very large numbers of items to be in the list (tests have used up to
17882     * 2,000,000 items). Also genlist employs a queue for adding items. As items
17883     * may be different sizes, every item added needs to be calculated as to its
17884     * size and thus this presents a lot of overhead on populating the list, this
17885     * genlist employs a queue. Any item added is queued and spooled off over
17886     * time, actually appearing some time later, so if your list has many members
17887     * you may find it takes a while for them to all appear, with your process
17888     * consuming a lot of CPU while it is busy spooling.
17889     *
17890     * Genlist also implements a tree structure, but it does so with callbacks to
17891     * the application, with the application filling in tree structures when
17892     * requested (allowing for efficient building of a very deep tree that could
17893     * even be used for file-management). See the above smart signal callbacks for
17894     * details.
17895     *
17896     * @section Genlist_Smart_Events Genlist smart events
17897     *
17898     * Signals that you can add callbacks for are:
17899     * - @c "activated" - The user has double-clicked or pressed
17900     *   (enter|return|spacebar) on an item. The @c event_info parameter is the
17901     *   item that was activated.
17902     * - @c "clicked,double" - The user has double-clicked an item.  The @c
17903     *   event_info parameter is the item that was double-clicked.
17904     * - @c "selected" - This is called when a user has made an item selected.
17905     *   The event_info parameter is the genlist item that was selected.
17906     * - @c "unselected" - This is called when a user has made an item
17907     *   unselected. The event_info parameter is the genlist item that was
17908     *   unselected.
17909     * - @c "expanded" - This is called when elm_genlist_item_expanded_set() is
17910     *   called and the item is now meant to be expanded. The event_info
17911     *   parameter is the genlist item that was indicated to expand.  It is the
17912     *   job of this callback to then fill in the child items.
17913     * - @c "contracted" - This is called when elm_genlist_item_expanded_set() is
17914     *   called and the item is now meant to be contracted. The event_info
17915     *   parameter is the genlist item that was indicated to contract. It is the
17916     *   job of this callback to then delete the child items.
17917     * - @c "expand,request" - This is called when a user has indicated they want
17918     *   to expand a tree branch item. The callback should decide if the item can
17919     *   expand (has any children) and then call elm_genlist_item_expanded_set()
17920     *   appropriately to set the state. The event_info parameter is the genlist
17921     *   item that was indicated to expand.
17922     * - @c "contract,request" - This is called when a user has indicated they
17923     *   want to contract a tree branch item. The callback should decide if the
17924     *   item can contract (has any children) and then call
17925     *   elm_genlist_item_expanded_set() appropriately to set the state. The
17926     *   event_info parameter is the genlist item that was indicated to contract.
17927     * - @c "realized" - This is called when the item in the list is created as a
17928     *   real evas object. event_info parameter is the genlist item that was
17929     *   created. The object may be deleted at any time, so it is up to the
17930     *   caller to not use the object pointer from elm_genlist_item_object_get()
17931     *   in a way where it may point to freed objects.
17932     * - @c "unrealized" - This is called just before an item is unrealized.
17933     *   After this call content objects provided will be deleted and the item
17934     *   object itself delete or be put into a floating cache.
17935     * - @c "drag,start,up" - This is called when the item in the list has been
17936     *   dragged (not scrolled) up.
17937     * - @c "drag,start,down" - This is called when the item in the list has been
17938     *   dragged (not scrolled) down.
17939     * - @c "drag,start,left" - This is called when the item in the list has been
17940     *   dragged (not scrolled) left.
17941     * - @c "drag,start,right" - This is called when the item in the list has
17942     *   been dragged (not scrolled) right.
17943     * - @c "drag,stop" - This is called when the item in the list has stopped
17944     *   being dragged.
17945     * - @c "drag" - This is called when the item in the list is being dragged.
17946     * - @c "longpressed" - This is called when the item is pressed for a certain
17947     *   amount of time. By default it's 1 second.
17948     * - @c "scroll,anim,start" - This is called when scrolling animation has
17949     *   started.
17950     * - @c "scroll,anim,stop" - This is called when scrolling animation has
17951     *   stopped.
17952     * - @c "scroll,drag,start" - This is called when dragging the content has
17953     *   started.
17954     * - @c "scroll,drag,stop" - This is called when dragging the content has
17955     *   stopped.
17956     * - @c "edge,top" - This is called when the genlist is scrolled until
17957     *   the top edge.
17958     * - @c "edge,bottom" - This is called when the genlist is scrolled
17959     *   until the bottom edge.
17960     * - @c "edge,left" - This is called when the genlist is scrolled
17961     *   until the left edge.
17962     * - @c "edge,right" - This is called when the genlist is scrolled
17963     *   until the right edge.
17964     * - @c "multi,swipe,left" - This is called when the genlist is multi-touch
17965     *   swiped left.
17966     * - @c "multi,swipe,right" - This is called when the genlist is multi-touch
17967     *   swiped right.
17968     * - @c "multi,swipe,up" - This is called when the genlist is multi-touch
17969     *   swiped up.
17970     * - @c "multi,swipe,down" - This is called when the genlist is multi-touch
17971     *   swiped down.
17972     * - @c "multi,pinch,out" - This is called when the genlist is multi-touch
17973     *   pinched out.  "- @c multi,pinch,in" - This is called when the genlist is
17974     *   multi-touch pinched in.
17975     * - @c "swipe" - This is called when the genlist is swiped.
17976     * - @c "moved" - This is called when a genlist item is moved.
17977     * - @c "language,changed" - This is called when the program's language is
17978     *   changed.
17979     *
17980     * @section Genlist_Examples Examples
17981     *
17982     * Here is a list of examples that use the genlist, trying to show some of
17983     * its capabilities:
17984     * - @ref genlist_example_01
17985     * - @ref genlist_example_02
17986     * - @ref genlist_example_03
17987     * - @ref genlist_example_04
17988     * - @ref genlist_example_05
17989     */
17990
17991    /**
17992     * @addtogroup Genlist
17993     * @{
17994     */
17995
17996    /**
17997     * @enum _Elm_Genlist_Item_Flags
17998     * @typedef Elm_Genlist_Item_Flags
17999     *
18000     * Defines if the item is of any special type (has subitems or it's the
18001     * index of a group), or is just a simple item.
18002     *
18003     * @ingroup Genlist
18004     */
18005    typedef enum _Elm_Genlist_Item_Flags
18006      {
18007         ELM_GENLIST_ITEM_NONE = 0, /**< simple item */
18008         ELM_GENLIST_ITEM_SUBITEMS = (1 << 0), /**< may expand and have child items */
18009         ELM_GENLIST_ITEM_GROUP = (1 << 1) /**< index of a group of items */
18010      } Elm_Genlist_Item_Flags;
18011    typedef enum _Elm_Genlist_Item_Field_Flags
18012      {
18013         ELM_GENLIST_ITEM_FIELD_ALL = 0,
18014         ELM_GENLIST_ITEM_FIELD_LABEL = (1 << 0),
18015         ELM_GENLIST_ITEM_FIELD_ICON = (1 << 1),
18016         ELM_GENLIST_ITEM_FIELD_STATE = (1 << 2)
18017      } Elm_Genlist_Item_Field_Flags;
18018    typedef struct _Elm_Genlist_Item_Class Elm_Genlist_Item_Class;  /**< Genlist item class definition structs */
18019    typedef struct _Elm_Genlist_Item       Elm_Genlist_Item; /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
18020    typedef struct _Elm_Genlist_Item_Class_Func Elm_Genlist_Item_Class_Func;
18021    typedef char        *(*GenlistItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part);
18022    typedef Evas_Object *(*GenlistItemIconGetFunc)  (void *data, Evas_Object *obj, const char *part);
18023    typedef Eina_Bool    (*GenlistItemStateGetFunc) (void *data, Evas_Object *obj, const char *part);
18024    typedef void         (*GenlistItemDelFunc)      (void *data, Evas_Object *obj);
18025    typedef void         (*GenlistItemMovedFunc)    ( Evas_Object *genlist, Elm_Genlist_Item *item, Elm_Genlist_Item *rel_item, Eina_Bool move_after);
18026
18027    /**
18028     * @struct _Elm_Genlist_Item_Class
18029     *
18030     * Genlist item class definition structs.
18031     *
18032     * This struct contains the style and fetching functions that will define the
18033     * contents of each item.
18034     *
18035     * @see @ref Genlist_Item_Class
18036     */
18037    struct _Elm_Genlist_Item_Class
18038      {
18039         const char                *item_style;
18040         struct {
18041           GenlistItemLabelGetFunc  label_get;
18042           GenlistItemIconGetFunc   icon_get;
18043           GenlistItemStateGetFunc  state_get;
18044           GenlistItemDelFunc       del;
18045           GenlistItemMovedFunc     moved;
18046         } func;
18047         const char *edit_item_style;
18048         const char                *mode_item_style;
18049      };
18050    #define Elm_Genlist_Item_Class_Func Elm_Gen_Item_Class_Func
18051    /**
18052     * Add a new genlist widget to the given parent Elementary
18053     * (container) object
18054     *
18055     * @param parent The parent object
18056     * @return a new genlist widget handle or @c NULL, on errors
18057     *
18058     * This function inserts a new genlist widget on the canvas.
18059     *
18060     * @see elm_genlist_item_append()
18061     * @see elm_genlist_item_del()
18062     * @see elm_genlist_clear()
18063     *
18064     * @ingroup Genlist
18065     */
18066    EAPI Evas_Object      *elm_genlist_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18067    /**
18068     * Remove all items from a given genlist widget.
18069     *
18070     * @param obj The genlist object
18071     *
18072     * This removes (and deletes) all items in @p obj, leaving it empty.
18073     *
18074     * @see elm_genlist_item_del(), to remove just one item.
18075     *
18076     * @ingroup Genlist
18077     */
18078    EAPI void elm_genlist_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
18079    /**
18080     * Enable or disable multi-selection in the genlist
18081     *
18082     * @param obj The genlist object
18083     * @param multi Multi-select enable/disable. Default is disabled.
18084     *
18085     * This enables (@c EINA_TRUE) or disables (@c EINA_FALSE) multi-selection in
18086     * the list. This allows more than 1 item to be selected. To retrieve the list
18087     * of selected items, use elm_genlist_selected_items_get().
18088     *
18089     * @see elm_genlist_selected_items_get()
18090     * @see elm_genlist_multi_select_get()
18091     *
18092     * @ingroup Genlist
18093     */
18094    EAPI void              elm_genlist_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
18095    /**
18096     * Gets if multi-selection in genlist is enabled or disabled.
18097     *
18098     * @param obj The genlist object
18099     * @return Multi-select enabled/disabled
18100     * (@c EINA_TRUE = enabled/@c EINA_FALSE = disabled). Default is @c EINA_FALSE.
18101     *
18102     * @see elm_genlist_multi_select_set()
18103     *
18104     * @ingroup Genlist
18105     */
18106    EAPI Eina_Bool         elm_genlist_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18107    /**
18108     * This sets the horizontal stretching mode.
18109     *
18110     * @param obj The genlist object
18111     * @param mode The mode to use (one of #ELM_LIST_SCROLL or #ELM_LIST_LIMIT).
18112     *
18113     * This sets the mode used for sizing items horizontally. Valid modes
18114     * are #ELM_LIST_LIMIT and #ELM_LIST_SCROLL. The default is
18115     * ELM_LIST_SCROLL. This mode means that if items are too wide to fit,
18116     * the scroller will scroll horizontally. Otherwise items are expanded
18117     * to fill the width of the viewport of the scroller. If it is
18118     * ELM_LIST_LIMIT, items will be expanded to the viewport width and
18119     * limited to that size.
18120     *
18121     * @see elm_genlist_horizontal_get()
18122     *
18123     * @ingroup Genlist
18124     */
18125    EAPI void              elm_genlist_horizontal_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
18126    /**
18127     * Gets the horizontal stretching mode.
18128     *
18129     * @param obj The genlist object
18130     * @return The mode to use
18131     * (#ELM_LIST_LIMIT, #ELM_LIST_SCROLL)
18132     *
18133     * @see elm_genlist_horizontal_set()
18134     *
18135     * @ingroup Genlist
18136     */
18137    EAPI Elm_List_Mode     elm_genlist_horizontal_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18138    /**
18139     * Set the always select mode.
18140     *
18141     * @param obj The genlist object
18142     * @param always_select The always select mode (@c EINA_TRUE = on, @c
18143     * EINA_FALSE = off). Default is @c EINA_FALSE.
18144     *
18145     * Items will only call their selection func and callback when first
18146     * becoming selected. Any further clicks will do nothing, unless you
18147     * enable always select with elm_genlist_always_select_mode_set().
18148     * This means that, even if selected, every click will make the selected
18149     * callbacks be called.
18150     *
18151     * @see elm_genlist_always_select_mode_get()
18152     *
18153     * @ingroup Genlist
18154     */
18155    EAPI void              elm_genlist_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
18156    /**
18157     * Get the always select mode.
18158     *
18159     * @param obj The genlist object
18160     * @return The always select mode
18161     * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18162     *
18163     * @see elm_genlist_always_select_mode_set()
18164     *
18165     * @ingroup Genlist
18166     */
18167    EAPI Eina_Bool         elm_genlist_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18168    /**
18169     * Enable/disable the no select mode.
18170     *
18171     * @param obj The genlist object
18172     * @param no_select The no select mode
18173     * (EINA_TRUE = on, EINA_FALSE = off)
18174     *
18175     * This will turn off the ability to select items entirely and they
18176     * will neither appear selected nor call selected callback functions.
18177     *
18178     * @see elm_genlist_no_select_mode_get()
18179     *
18180     * @ingroup Genlist
18181     */
18182    EAPI void              elm_genlist_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
18183    /**
18184     * Gets whether the no select mode is enabled.
18185     *
18186     * @param obj The genlist object
18187     * @return The no select mode
18188     * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18189     *
18190     * @see elm_genlist_no_select_mode_set()
18191     *
18192     * @ingroup Genlist
18193     */
18194    EAPI Eina_Bool         elm_genlist_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18195    /**
18196     * Enable/disable compress mode.
18197     *
18198     * @param obj The genlist object
18199     * @param compress The compress mode
18200     * (@c EINA_TRUE = on, @c EINA_FALSE = off). Default is @c EINA_FALSE.
18201     *
18202     * This will enable the compress mode where items are "compressed"
18203     * horizontally to fit the genlist scrollable viewport width. This is
18204     * special for genlist.  Do not rely on
18205     * elm_genlist_horizontal_set() being set to @c ELM_LIST_COMPRESS to
18206     * work as genlist needs to handle it specially.
18207     *
18208     * @see elm_genlist_compress_mode_get()
18209     *
18210     * @ingroup Genlist
18211     */
18212    EAPI void              elm_genlist_compress_mode_set(Evas_Object *obj, Eina_Bool compress) EINA_ARG_NONNULL(1);
18213    /**
18214     * Get whether the compress mode is enabled.
18215     *
18216     * @param obj The genlist object
18217     * @return The compress mode
18218     * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18219     *
18220     * @see elm_genlist_compress_mode_set()
18221     *
18222     * @ingroup Genlist
18223     */
18224    EAPI Eina_Bool         elm_genlist_compress_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18225    /**
18226     * Enable/disable height-for-width mode.
18227     *
18228     * @param obj The genlist object
18229     * @param setting The height-for-width mode (@c EINA_TRUE = on,
18230     * @c EINA_FALSE = off). Default is @c EINA_FALSE.
18231     *
18232     * With height-for-width mode the item width will be fixed (restricted
18233     * to a minimum of) to the list width when calculating its size in
18234     * order to allow the height to be calculated based on it. This allows,
18235     * for instance, text block to wrap lines if the Edje part is
18236     * configured with "text.min: 0 1".
18237     *
18238     * @note This mode will make list resize slower as it will have to
18239     *       recalculate every item height again whenever the list width
18240     *       changes!
18241     *
18242     * @note When height-for-width mode is enabled, it also enables
18243     *       compress mode (see elm_genlist_compress_mode_set()) and
18244     *       disables homogeneous (see elm_genlist_homogeneous_set()).
18245     *
18246     * @ingroup Genlist
18247     */
18248    EAPI void              elm_genlist_height_for_width_mode_set(Evas_Object *obj, Eina_Bool height_for_width) EINA_ARG_NONNULL(1);
18249    /**
18250     * Get whether the height-for-width mode is enabled.
18251     *
18252     * @param obj The genlist object
18253     * @return The height-for-width mode (@c EINA_TRUE = on, @c EINA_FALSE =
18254     * off)
18255     *
18256     * @ingroup Genlist
18257     */
18258    EAPI Eina_Bool         elm_genlist_height_for_width_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18259    /**
18260     * Enable/disable horizontal and vertical bouncing effect.
18261     *
18262     * @param obj The genlist object
18263     * @param h_bounce Allow bounce horizontally (@c EINA_TRUE = on, @c
18264     * EINA_FALSE = off). Default is @c EINA_FALSE.
18265     * @param v_bounce Allow bounce vertically (@c EINA_TRUE = on, @c
18266     * EINA_FALSE = off). Default is @c EINA_TRUE.
18267     *
18268     * This will enable or disable the scroller bouncing effect for the
18269     * genlist. See elm_scroller_bounce_set() for details.
18270     *
18271     * @see elm_scroller_bounce_set()
18272     * @see elm_genlist_bounce_get()
18273     *
18274     * @ingroup Genlist
18275     */
18276    EAPI void              elm_genlist_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
18277    /**
18278     * Get whether the horizontal and vertical bouncing effect is enabled.
18279     *
18280     * @param obj The genlist object
18281     * @param h_bounce Pointer to a bool to receive if the bounce horizontally
18282     * option is set.
18283     * @param v_bounce Pointer to a bool to receive if the bounce vertically
18284     * option is set.
18285     *
18286     * @see elm_genlist_bounce_set()
18287     *
18288     * @ingroup Genlist
18289     */
18290    EAPI void              elm_genlist_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
18291    /**
18292     * Enable/disable homogenous mode.
18293     *
18294     * @param obj The genlist object
18295     * @param homogeneous Assume the items within the genlist are of the
18296     * same height and width (EINA_TRUE = on, EINA_FALSE = off). Default is @c
18297     * EINA_FALSE.
18298     *
18299     * This will enable the homogeneous mode where items are of the same
18300     * height and width so that genlist may do the lazy-loading at its
18301     * maximum (which increases the performance for scrolling the list). This
18302     * implies 'compressed' mode.
18303     *
18304     * @see elm_genlist_compress_mode_set()
18305     * @see elm_genlist_homogeneous_get()
18306     *
18307     * @ingroup Genlist
18308     */
18309    EAPI void              elm_genlist_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
18310    /**
18311     * Get whether the homogenous mode is enabled.
18312     *
18313     * @param obj The genlist object
18314     * @return Assume the items within the genlist are of the same height
18315     * and width (EINA_TRUE = on, EINA_FALSE = off)
18316     *
18317     * @see elm_genlist_homogeneous_set()
18318     *
18319     * @ingroup Genlist
18320     */
18321    EAPI Eina_Bool         elm_genlist_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18322    /**
18323     * Set the maximum number of items within an item block
18324     *
18325     * @param obj The genlist object
18326     * @param n   Maximum number of items within an item block. Default is 32.
18327     *
18328     * This will configure the block count to tune to the target with
18329     * particular performance matrix.
18330     *
18331     * A block of objects will be used to reduce the number of operations due to
18332     * many objects in the screen. It can determine the visibility, or if the
18333     * object has changed, it theme needs to be updated, etc. doing this kind of
18334     * calculation to the entire block, instead of per object.
18335     *
18336     * The default value for the block count is enough for most lists, so unless
18337     * you know you will have a lot of objects visible in the screen at the same
18338     * time, don't try to change this.
18339     *
18340     * @see elm_genlist_block_count_get()
18341     * @see @ref Genlist_Implementation
18342     *
18343     * @ingroup Genlist
18344     */
18345    EAPI void              elm_genlist_block_count_set(Evas_Object *obj, int n) EINA_ARG_NONNULL(1);
18346    /**
18347     * Get the maximum number of items within an item block
18348     *
18349     * @param obj The genlist object
18350     * @return Maximum number of items within an item block
18351     *
18352     * @see elm_genlist_block_count_set()
18353     *
18354     * @ingroup Genlist
18355     */
18356    EAPI int               elm_genlist_block_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18357    /**
18358     * Set the timeout in seconds for the longpress event.
18359     *
18360     * @param obj The genlist object
18361     * @param timeout timeout in seconds. Default is 1.
18362     *
18363     * This option will change how long it takes to send an event "longpressed"
18364     * after the mouse down signal is sent to the list. If this event occurs, no
18365     * "clicked" event will be sent.
18366     *
18367     * @see elm_genlist_longpress_timeout_set()
18368     *
18369     * @ingroup Genlist
18370     */
18371    EAPI void              elm_genlist_longpress_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
18372    /**
18373     * Get the timeout in seconds for the longpress event.
18374     *
18375     * @param obj The genlist object
18376     * @return timeout in seconds
18377     *
18378     * @see elm_genlist_longpress_timeout_get()
18379     *
18380     * @ingroup Genlist
18381     */
18382    EAPI double            elm_genlist_longpress_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18383    /**
18384     * Append a new item in a given genlist widget.
18385     *
18386     * @param obj The genlist object
18387     * @param itc The item class for the item
18388     * @param data The item data
18389     * @param parent The parent item, or NULL if none
18390     * @param flags Item flags
18391     * @param func Convenience function called when the item is selected
18392     * @param func_data Data passed to @p func above.
18393     * @return A handle to the item added or @c NULL if not possible
18394     *
18395     * This adds the given item to the end of the list or the end of
18396     * the children list if the @p parent is given.
18397     *
18398     * @see elm_genlist_item_prepend()
18399     * @see elm_genlist_item_insert_before()
18400     * @see elm_genlist_item_insert_after()
18401     * @see elm_genlist_item_del()
18402     *
18403     * @ingroup Genlist
18404     */
18405    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);
18406    /**
18407     * Prepend a new item in a given genlist widget.
18408     *
18409     * @param obj The genlist object
18410     * @param itc The item class for the item
18411     * @param data The item data
18412     * @param parent The parent item, or NULL if none
18413     * @param flags Item flags
18414     * @param func Convenience function called when the item is selected
18415     * @param func_data Data passed to @p func above.
18416     * @return A handle to the item added or NULL if not possible
18417     *
18418     * This adds an item to the beginning of the list or beginning of the
18419     * children of the parent if given.
18420     *
18421     * @see elm_genlist_item_append()
18422     * @see elm_genlist_item_insert_before()
18423     * @see elm_genlist_item_insert_after()
18424     * @see elm_genlist_item_del()
18425     *
18426     * @ingroup Genlist
18427     */
18428    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);
18429    /**
18430     * Insert an item before another in a genlist widget
18431     *
18432     * @param obj The genlist object
18433     * @param itc The item class for the item
18434     * @param data The item data
18435     * @param before The item to place this new one before.
18436     * @param flags Item flags
18437     * @param func Convenience function called when the item is selected
18438     * @param func_data Data passed to @p func above.
18439     * @return A handle to the item added or @c NULL if not possible
18440     *
18441     * This inserts an item before another in the list. It will be in the
18442     * same tree level or group as the item it is inserted before.
18443     *
18444     * @see elm_genlist_item_append()
18445     * @see elm_genlist_item_prepend()
18446     * @see elm_genlist_item_insert_after()
18447     * @see elm_genlist_item_del()
18448     *
18449     * @ingroup Genlist
18450     */
18451    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);
18452    /**
18453     * Insert an item after another in a genlist widget
18454     *
18455     * @param obj The genlist object
18456     * @param itc The item class for the item
18457     * @param data The item data
18458     * @param after The item to place this new one after.
18459     * @param flags Item flags
18460     * @param func Convenience function called when the item is selected
18461     * @param func_data Data passed to @p func above.
18462     * @return A handle to the item added or @c NULL if not possible
18463     *
18464     * This inserts an item after another in the list. It will be in the
18465     * same tree level or group as the item it is inserted after.
18466     *
18467     * @see elm_genlist_item_append()
18468     * @see elm_genlist_item_prepend()
18469     * @see elm_genlist_item_insert_before()
18470     * @see elm_genlist_item_del()
18471     *
18472     * @ingroup Genlist
18473     */
18474    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);
18475    /**
18476     * Insert a new item into the sorted genlist object
18477     *
18478     * @param obj The genlist object
18479     * @param itc The item class for the item
18480     * @param data The item data
18481     * @param parent The parent item, or NULL if none
18482     * @param flags Item flags
18483     * @param comp The function called for the sort
18484     * @param func Convenience function called when item selected
18485     * @param func_data Data passed to @p func above.
18486     * @return A handle to the item added or NULL if not possible
18487     *
18488     * @ingroup Genlist
18489     */
18490    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);
18491    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);
18492    /* operations to retrieve existing items */
18493    /**
18494     * Get the selectd item in the genlist.
18495     *
18496     * @param obj The genlist object
18497     * @return The selected item, or NULL if none is selected.
18498     *
18499     * This gets the selected item in the list (if multi-selection is enabled, only
18500     * the item that was first selected in the list is returned - which is not very
18501     * useful, so see elm_genlist_selected_items_get() for when multi-selection is
18502     * used).
18503     *
18504     * If no item is selected, NULL is returned.
18505     *
18506     * @see elm_genlist_selected_items_get()
18507     *
18508     * @ingroup Genlist
18509     */
18510    EAPI Elm_Genlist_Item *elm_genlist_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18511    /**
18512     * Get a list of selected items in the genlist.
18513     *
18514     * @param obj The genlist object
18515     * @return The list of selected items, or NULL if none are selected.
18516     *
18517     * It returns a list of the selected items. This list pointer is only valid so
18518     * long as the selection doesn't change (no items are selected or unselected, or
18519     * unselected implicitly by deletion). The list contains Elm_Genlist_Item
18520     * pointers. The order of the items in this list is the order which they were
18521     * selected, i.e. the first item in this list is the first item that was
18522     * selected, and so on.
18523     *
18524     * @note If not in multi-select mode, consider using function
18525     * elm_genlist_selected_item_get() instead.
18526     *
18527     * @see elm_genlist_multi_select_set()
18528     * @see elm_genlist_selected_item_get()
18529     *
18530     * @ingroup Genlist
18531     */
18532    EAPI const Eina_List  *elm_genlist_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18533    /**
18534     * Get the mode item style of items in the genlist
18535     * @param obj The genlist object
18536     * @return The mode item style string, or NULL if none is specified
18537     * 
18538     * This is a constant string and simply defines the name of the
18539     * style that will be used for mode animations. It can be
18540     * @c NULL if you don't plan to use Genlist mode. See
18541     * elm_genlist_item_mode_set() for more info.
18542     * 
18543     * @ingroup Genlist
18544     */
18545    EAPI const char       *elm_genlist_mode_item_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18546    /**
18547     * Set the mode item style of items in the genlist
18548     * @param obj The genlist object
18549     * @param style The mode item style string, or NULL if none is desired
18550     * 
18551     * This is a constant string and simply defines the name of the
18552     * style that will be used for mode animations. It can be
18553     * @c NULL if you don't plan to use Genlist mode. See
18554     * elm_genlist_item_mode_set() for more info.
18555     * 
18556     * @ingroup Genlist
18557     */
18558    EAPI void              elm_genlist_mode_item_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
18559    /**
18560     * Get a list of realized items in genlist
18561     *
18562     * @param obj The genlist object
18563     * @return The list of realized items, nor NULL if none are realized.
18564     *
18565     * This returns a list of the realized items in the genlist. The list
18566     * contains Elm_Genlist_Item pointers. The list must be freed by the
18567     * caller when done with eina_list_free(). The item pointers in the
18568     * list are only valid so long as those items are not deleted or the
18569     * genlist is not deleted.
18570     *
18571     * @see elm_genlist_realized_items_update()
18572     *
18573     * @ingroup Genlist
18574     */
18575    EAPI Eina_List        *elm_genlist_realized_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18576    /**
18577     * Get the item that is at the x, y canvas coords.
18578     *
18579     * @param obj The gelinst object.
18580     * @param x The input x coordinate
18581     * @param y The input y coordinate
18582     * @param posret The position relative to the item returned here
18583     * @return The item at the coordinates or NULL if none
18584     *
18585     * This returns the item at the given coordinates (which are canvas
18586     * relative, not object-relative). If an item is at that coordinate,
18587     * that item handle is returned, and if @p posret is not NULL, the
18588     * integer pointed to is set to a value of -1, 0 or 1, depending if
18589     * the coordinate is on the upper portion of that item (-1), on the
18590     * middle section (0) or on the lower part (1). If NULL is returned as
18591     * an item (no item found there), then posret may indicate -1 or 1
18592     * based if the coordinate is above or below all items respectively in
18593     * the genlist.
18594     *
18595     * @ingroup Genlist
18596     */
18597    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);
18598    /**
18599     * Get the first item in the genlist
18600     *
18601     * This returns the first item in the list.
18602     *
18603     * @param obj The genlist object
18604     * @return The first item, or NULL if none
18605     *
18606     * @ingroup Genlist
18607     */
18608    EAPI Elm_Genlist_Item *elm_genlist_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18609    /**
18610     * Get the last item in the genlist
18611     *
18612     * This returns the last item in the list.
18613     *
18614     * @return The last item, or NULL if none
18615     *
18616     * @ingroup Genlist
18617     */
18618    EAPI Elm_Genlist_Item *elm_genlist_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18619    /**
18620     * Set the scrollbar policy
18621     *
18622     * @param obj The genlist object
18623     * @param policy_h Horizontal scrollbar policy.
18624     * @param policy_v Vertical scrollbar policy.
18625     *
18626     * This sets the scrollbar visibility policy for the given genlist
18627     * scroller. #ELM_SMART_SCROLLER_POLICY_AUTO means the scrollbar is
18628     * made visible if it is needed, and otherwise kept hidden.
18629     * #ELM_SMART_SCROLLER_POLICY_ON turns it on all the time, and
18630     * #ELM_SMART_SCROLLER_POLICY_OFF always keeps it off. This applies
18631     * respectively for the horizontal and vertical scrollbars. Default is
18632     * #ELM_SMART_SCROLLER_POLICY_AUTO
18633     *
18634     * @see elm_genlist_scroller_policy_get()
18635     *
18636     * @ingroup Genlist
18637     */
18638    EAPI void              elm_genlist_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
18639    /**
18640     * Get the scrollbar policy
18641     *
18642     * @param obj The genlist object
18643     * @param policy_h Pointer to store the horizontal scrollbar policy.
18644     * @param policy_v Pointer to store the vertical scrollbar policy.
18645     *
18646     * @see elm_genlist_scroller_policy_set()
18647     *
18648     * @ingroup Genlist
18649     */
18650    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);
18651    /**
18652     * Get the @b next item in a genlist widget's internal list of items,
18653     * given a handle to one of those items.
18654     *
18655     * @param item The genlist item to fetch next from
18656     * @return The item after @p item, or @c NULL if there's none (and
18657     * on errors)
18658     *
18659     * This returns the item placed after the @p item, on the container
18660     * genlist.
18661     *
18662     * @see elm_genlist_item_prev_get()
18663     *
18664     * @ingroup Genlist
18665     */
18666    EAPI Elm_Genlist_Item  *elm_genlist_item_next_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18667    /**
18668     * Get the @b previous item in a genlist widget's internal list of items,
18669     * given a handle to one of those items.
18670     *
18671     * @param item The genlist item to fetch previous from
18672     * @return The item before @p item, or @c NULL if there's none (and
18673     * on errors)
18674     *
18675     * This returns the item placed before the @p item, on the container
18676     * genlist.
18677     *
18678     * @see elm_genlist_item_next_get()
18679     *
18680     * @ingroup Genlist
18681     */
18682    EAPI Elm_Genlist_Item  *elm_genlist_item_prev_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18683    /**
18684     * Get the genlist object's handle which contains a given genlist
18685     * item
18686     *
18687     * @param item The item to fetch the container from
18688     * @return The genlist (parent) object
18689     *
18690     * This returns the genlist object itself that an item belongs to.
18691     *
18692     * @ingroup Genlist
18693     */
18694    EAPI Evas_Object       *elm_genlist_item_genlist_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18695    /**
18696     * Get the parent item of the given item
18697     *
18698     * @param it The item
18699     * @return The parent of the item or @c NULL if it has no parent.
18700     *
18701     * This returns the item that was specified as parent of the item @p it on
18702     * elm_genlist_item_append() and insertion related functions.
18703     *
18704     * @ingroup Genlist
18705     */
18706    EAPI Elm_Genlist_Item  *elm_genlist_item_parent_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
18707    /**
18708     * Remove all sub-items (children) of the given item
18709     *
18710     * @param it The item
18711     *
18712     * This removes all items that are children (and their descendants) of the
18713     * given item @p it.
18714     *
18715     * @see elm_genlist_clear()
18716     * @see elm_genlist_item_del()
18717     *
18718     * @ingroup Genlist
18719     */
18720    EAPI void               elm_genlist_item_subitems_clear(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18721    /**
18722     * Set whether a given genlist item is selected or not
18723     *
18724     * @param it The item
18725     * @param selected Use @c EINA_TRUE, to make it selected, @c
18726     * EINA_FALSE to make it unselected
18727     *
18728     * This sets the selected state of an item. If multi selection is
18729     * not enabled on the containing genlist and @p selected is @c
18730     * EINA_TRUE, any other previously selected items will get
18731     * unselected in favor of this new one.
18732     *
18733     * @see elm_genlist_item_selected_get()
18734     *
18735     * @ingroup Genlist
18736     */
18737    EAPI void elm_genlist_item_selected_set(Elm_Genlist_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
18738    /**
18739     * Get whether a given genlist item is selected or not
18740     *
18741     * @param it The item
18742     * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
18743     *
18744     * @see elm_genlist_item_selected_set() for more details
18745     *
18746     * @ingroup Genlist
18747     */
18748    EAPI Eina_Bool elm_genlist_item_selected_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18749    /**
18750     * Sets the expanded state of an item.
18751     *
18752     * @param it The item
18753     * @param expanded The expanded state (@c EINA_TRUE expanded, @c EINA_FALSE not expanded).
18754     *
18755     * This function flags the item of type #ELM_GENLIST_ITEM_SUBITEMS as
18756     * expanded or not.
18757     *
18758     * The theme will respond to this change visually, and a signal "expanded" or
18759     * "contracted" will be sent from the genlist with a pointer to the item that
18760     * has been expanded/contracted.
18761     *
18762     * Calling this function won't show or hide any child of this item (if it is
18763     * a parent). You must manually delete and create them on the callbacks fo
18764     * the "expanded" or "contracted" signals.
18765     *
18766     * @see elm_genlist_item_expanded_get()
18767     *
18768     * @ingroup Genlist
18769     */
18770    EAPI void               elm_genlist_item_expanded_set(Elm_Genlist_Item *item, Eina_Bool expanded) EINA_ARG_NONNULL(1);
18771    /**
18772     * Get the expanded state of an item
18773     *
18774     * @param it The item
18775     * @return The expanded state
18776     *
18777     * This gets the expanded state of an item.
18778     *
18779     * @see elm_genlist_item_expanded_set()
18780     *
18781     * @ingroup Genlist
18782     */
18783    EAPI Eina_Bool          elm_genlist_item_expanded_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18784    /**
18785     * Get the depth of expanded item
18786     *
18787     * @param it The genlist item object
18788     * @return The depth of expanded item
18789     *
18790     * @ingroup Genlist
18791     */
18792    EAPI int                elm_genlist_item_expanded_depth_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
18793    /**
18794     * Set whether a given genlist item is disabled or not.
18795     *
18796     * @param it The item
18797     * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
18798     * to enable it back.
18799     *
18800     * A disabled item cannot be selected or unselected. It will also
18801     * change its appearance, to signal the user it's disabled.
18802     *
18803     * @see elm_genlist_item_disabled_get()
18804     *
18805     * @ingroup Genlist
18806     */
18807    EAPI void               elm_genlist_item_disabled_set(Elm_Genlist_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
18808    /**
18809     * Get whether a given genlist item is disabled or not.
18810     *
18811     * @param it The item
18812     * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
18813     * (and on errors).
18814     *
18815     * @see elm_genlist_item_disabled_set() for more details
18816     *
18817     * @ingroup Genlist
18818     */
18819    EAPI Eina_Bool          elm_genlist_item_disabled_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18820    /**
18821     * Sets the display only state of an item.
18822     *
18823     * @param it The item
18824     * @param display_only @c EINA_TRUE if the item is display only, @c
18825     * EINA_FALSE otherwise.
18826     *
18827     * A display only item cannot be selected or unselected. It is for
18828     * display only and not selecting or otherwise clicking, dragging
18829     * etc. by the user, thus finger size rules will not be applied to
18830     * this item.
18831     *
18832     * It's good to set group index items to display only state.
18833     *
18834     * @see elm_genlist_item_display_only_get()
18835     *
18836     * @ingroup Genlist
18837     */
18838    EAPI void               elm_genlist_item_display_only_set(Elm_Genlist_Item *it, Eina_Bool display_only) EINA_ARG_NONNULL(1);
18839    /**
18840     * Get the display only state of an item
18841     *
18842     * @param it The item
18843     * @return @c EINA_TRUE if the item is display only, @c
18844     * EINA_FALSE otherwise.
18845     *
18846     * @see elm_genlist_item_display_only_set()
18847     *
18848     * @ingroup Genlist
18849     */
18850    EAPI Eina_Bool          elm_genlist_item_display_only_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
18851    /**
18852     * Show the portion of a genlist's internal list containing a given
18853     * item, immediately.
18854     *
18855     * @param it The item to display
18856     *
18857     * This causes genlist to jump to the given item @p it and show it (by
18858     * immediately scrolling to that position), if it is not fully visible.
18859     *
18860     * @see elm_genlist_item_bring_in()
18861     * @see elm_genlist_item_top_show()
18862     * @see elm_genlist_item_middle_show()
18863     *
18864     * @ingroup Genlist
18865     */
18866    EAPI void               elm_genlist_item_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18867    /**
18868     * Animatedly bring in, to the visible are of a genlist, a given
18869     * item on it.
18870     *
18871     * @param it The item to display
18872     *
18873     * This causes genlist to jump to the given item @p it and show it (by
18874     * animatedly scrolling), if it is not fully visible. This may use animation
18875     * to do so and take a period of time
18876     *
18877     * @see elm_genlist_item_show()
18878     * @see elm_genlist_item_top_bring_in()
18879     * @see elm_genlist_item_middle_bring_in()
18880     *
18881     * @ingroup Genlist
18882     */
18883    EAPI void               elm_genlist_item_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18884    /**
18885     * Show the portion of a genlist's internal list containing a given
18886     * item, immediately.
18887     *
18888     * @param it The item to display
18889     *
18890     * This causes genlist to jump to the given item @p it and show it (by
18891     * immediately scrolling to that position), if it is not fully visible.
18892     *
18893     * The item will be positioned at the top of the genlist viewport.
18894     *
18895     * @see elm_genlist_item_show()
18896     * @see elm_genlist_item_top_bring_in()
18897     *
18898     * @ingroup Genlist
18899     */
18900    EAPI void               elm_genlist_item_top_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18901    /**
18902     * Animatedly bring in, to the visible are of a genlist, a given
18903     * item on it.
18904     *
18905     * @param it The item
18906     *
18907     * This causes genlist to jump to the given item @p it and show it (by
18908     * animatedly scrolling), if it is not fully visible. This may use animation
18909     * to do so and take a period of time
18910     *
18911     * The item will be positioned at the top of the genlist viewport.
18912     *
18913     * @see elm_genlist_item_bring_in()
18914     * @see elm_genlist_item_top_show()
18915     *
18916     * @ingroup Genlist
18917     */
18918    EAPI void               elm_genlist_item_top_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18919    /**
18920     * Show the portion of a genlist's internal list containing a given
18921     * item, immediately.
18922     *
18923     * @param it The item to display
18924     *
18925     * This causes genlist to jump to the given item @p it and show it (by
18926     * immediately scrolling to that position), if it is not fully visible.
18927     *
18928     * The item will be positioned at the middle of the genlist viewport.
18929     *
18930     * @see elm_genlist_item_show()
18931     * @see elm_genlist_item_middle_bring_in()
18932     *
18933     * @ingroup Genlist
18934     */
18935    EAPI void               elm_genlist_item_middle_show(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
18936    /**
18937     * Animatedly bring in, to the visible are of a genlist, a given
18938     * item on it.
18939     *
18940     * @param it The item
18941     *
18942     * This causes genlist to jump to the given item @p it and show it (by
18943     * animatedly scrolling), if it is not fully visible. This may use animation
18944     * to do so and take a period of time
18945     *
18946     * The item will be positioned at the middle of the genlist viewport.
18947     *
18948     * @see elm_genlist_item_bring_in()
18949     * @see elm_genlist_item_middle_show()
18950     *
18951     * @ingroup Genlist
18952     */
18953    EAPI void               elm_genlist_item_middle_bring_in(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
18954    /**
18955     * Remove a genlist item from the its parent, deleting it.
18956     *
18957     * @param item The item to be removed.
18958     * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
18959     *
18960     * @see elm_genlist_clear(), to remove all items in a genlist at
18961     * once.
18962     *
18963     * @ingroup Genlist
18964     */
18965    EAPI void               elm_genlist_item_del(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18966    /**
18967     * Return the data associated to a given genlist item
18968     *
18969     * @param item The genlist item.
18970     * @return the data associated to this item.
18971     *
18972     * This returns the @c data value passed on the
18973     * elm_genlist_item_append() and related item addition calls.
18974     *
18975     * @see elm_genlist_item_append()
18976     * @see elm_genlist_item_data_set()
18977     *
18978     * @ingroup Genlist
18979     */
18980    EAPI void              *elm_genlist_item_data_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18981    /**
18982     * Set the data associated to a given genlist item
18983     *
18984     * @param item The genlist item
18985     * @param data The new data pointer to set on it
18986     *
18987     * This @b overrides the @c data value passed on the
18988     * elm_genlist_item_append() and related item addition calls. This
18989     * function @b won't call elm_genlist_item_update() automatically,
18990     * so you'd issue it afterwards if you want to hove the item
18991     * updated to reflect the that new data.
18992     *
18993     * @see elm_genlist_item_data_get()
18994     *
18995     * @ingroup Genlist
18996     */
18997    EAPI void               elm_genlist_item_data_set(Elm_Genlist_Item *it, const void *data) EINA_ARG_NONNULL(1);
18998    /**
18999     * Tells genlist to "orphan" icons fetchs by the item class
19000     *
19001     * @param it The item
19002     *
19003     * This instructs genlist to release references to icons in the item,
19004     * meaning that they will no longer be managed by genlist and are
19005     * floating "orphans" that can be re-used elsewhere if the user wants
19006     * to.
19007     *
19008     * @ingroup Genlist
19009     */
19010    EAPI void               elm_genlist_item_contents_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19011    EAPI void               elm_genlist_item_icons_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19012    /**
19013     * Get the real Evas object created to implement the view of a
19014     * given genlist item
19015     *
19016     * @param item The genlist item.
19017     * @return the Evas object implementing this item's view.
19018     *
19019     * This returns the actual Evas object used to implement the
19020     * specified genlist item's view. This may be @c NULL, as it may
19021     * not have been created or may have been deleted, at any time, by
19022     * the genlist. <b>Do not modify this object</b> (move, resize,
19023     * show, hide, etc.), as the genlist is controlling it. This
19024     * function is for querying, emitting custom signals or hooking
19025     * lower level callbacks for events on that object. Do not delete
19026     * this object under any circumstances.
19027     *
19028     * @see elm_genlist_item_data_get()
19029     *
19030     * @ingroup Genlist
19031     */
19032    EAPI const Evas_Object *elm_genlist_item_object_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19033    /**
19034     * Update the contents of an item
19035     *
19036     * @param it The item
19037     *
19038     * This updates an item by calling all the item class functions again
19039     * to get the icons, labels and states. Use this when the original
19040     * item data has changed and the changes are desired to be reflected.
19041     *
19042     * Use elm_genlist_realized_items_update() to update all already realized
19043     * items.
19044     *
19045     * @see elm_genlist_realized_items_update()
19046     *
19047     * @ingroup Genlist
19048     */
19049    EAPI void               elm_genlist_item_update(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19050    EAPI void               elm_genlist_item_fields_update(Elm_Genlist_Item *it, const char *parts, Elm_Genlist_Item_Field_Flags itf) EINA_ARG_NONNULL(1);
19051    /**
19052     * Update the item class of an item
19053     *
19054     * @param it The item
19055     * @param itc The item class for the item
19056     *
19057     * This sets another class fo the item, changing the way that it is
19058     * displayed. After changing the item class, elm_genlist_item_update() is
19059     * called on the item @p it.
19060     *
19061     * @ingroup Genlist
19062     */
19063    EAPI void               elm_genlist_item_item_class_update(Elm_Genlist_Item *it, const Elm_Genlist_Item_Class *itc) EINA_ARG_NONNULL(1, 2);
19064    EAPI const Elm_Genlist_Item_Class *elm_genlist_item_item_class_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19065    /**
19066     * Set the text to be shown in a given genlist item's tooltips.
19067     *
19068     * @param item The genlist item
19069     * @param text The text to set in the content
19070     *
19071     * This call will setup the text to be used as tooltip to that item
19072     * (analogous to elm_object_tooltip_text_set(), but being item
19073     * tooltips with higher precedence than object tooltips). It can
19074     * have only one tooltip at a time, so any previous tooltip data
19075     * will get removed.
19076     *
19077     * In order to set an icon or something else as a tooltip, look at
19078     * elm_genlist_item_tooltip_content_cb_set().
19079     *
19080     * @ingroup Genlist
19081     */
19082    EAPI void               elm_genlist_item_tooltip_text_set(Elm_Genlist_Item *item, const char *text) EINA_ARG_NONNULL(1);
19083    /**
19084     * Set the content to be shown in a given genlist item's tooltips
19085     *
19086     * @param item The genlist item.
19087     * @param func The function returning the tooltip contents.
19088     * @param data What to provide to @a func as callback data/context.
19089     * @param del_cb Called when data is not needed anymore, either when
19090     *        another callback replaces @p func, the tooltip is unset with
19091     *        elm_genlist_item_tooltip_unset() or the owner @p item
19092     *        dies. This callback receives as its first parameter the
19093     *        given @p data, being @c event_info the item handle.
19094     *
19095     * This call will setup the tooltip's contents to @p item
19096     * (analogous to elm_object_tooltip_content_cb_set(), but being
19097     * item tooltips with higher precedence than object tooltips). It
19098     * can have only one tooltip at a time, so any previous tooltip
19099     * content will get removed. @p func (with @p data) will be called
19100     * every time Elementary needs to show the tooltip and it should
19101     * return a valid Evas object, which will be fully managed by the
19102     * tooltip system, getting deleted when the tooltip is gone.
19103     *
19104     * In order to set just a text as a tooltip, look at
19105     * elm_genlist_item_tooltip_text_set().
19106     *
19107     * @ingroup Genlist
19108     */
19109    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);
19110    /**
19111     * Unset a tooltip from a given genlist item
19112     *
19113     * @param item genlist item to remove a previously set tooltip from.
19114     *
19115     * This call removes any tooltip set on @p item. The callback
19116     * provided as @c del_cb to
19117     * elm_genlist_item_tooltip_content_cb_set() will be called to
19118     * notify it is not used anymore (and have resources cleaned, if
19119     * need be).
19120     *
19121     * @see elm_genlist_item_tooltip_content_cb_set()
19122     *
19123     * @ingroup Genlist
19124     */
19125    EAPI void               elm_genlist_item_tooltip_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19126    /**
19127     * Set a different @b style for a given genlist item's tooltip.
19128     *
19129     * @param item genlist item with tooltip set
19130     * @param style the <b>theme style</b> to use on tooltips (e.g. @c
19131     * "default", @c "transparent", etc)
19132     *
19133     * Tooltips can have <b>alternate styles</b> to be displayed on,
19134     * which are defined by the theme set on Elementary. This function
19135     * works analogously as elm_object_tooltip_style_set(), but here
19136     * applied only to genlist item objects. The default style for
19137     * tooltips is @c "default".
19138     *
19139     * @note before you set a style you should define a tooltip with
19140     *       elm_genlist_item_tooltip_content_cb_set() or
19141     *       elm_genlist_item_tooltip_text_set()
19142     *
19143     * @see elm_genlist_item_tooltip_style_get()
19144     *
19145     * @ingroup Genlist
19146     */
19147    EAPI void               elm_genlist_item_tooltip_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
19148    /**
19149     * Get the style set a given genlist item's tooltip.
19150     *
19151     * @param item genlist item with tooltip already set on.
19152     * @return style the theme style in use, which defaults to
19153     *         "default". If the object does not have a tooltip set,
19154     *         then @c NULL is returned.
19155     *
19156     * @see elm_genlist_item_tooltip_style_set() for more details
19157     *
19158     * @ingroup Genlist
19159     */
19160    EAPI const char        *elm_genlist_item_tooltip_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19161    /**
19162     * Set the type of mouse pointer/cursor decoration to be shown,
19163     * when the mouse pointer is over the given genlist widget item
19164     *
19165     * @param item genlist item to customize cursor on
19166     * @param cursor the cursor type's name
19167     *
19168     * This function works analogously as elm_object_cursor_set(), but
19169     * here the cursor's changing area is restricted to the item's
19170     * area, and not the whole widget's. Note that that item cursors
19171     * have precedence over widget cursors, so that a mouse over @p
19172     * item will always show cursor @p type.
19173     *
19174     * If this function is called twice for an object, a previously set
19175     * cursor will be unset on the second call.
19176     *
19177     * @see elm_object_cursor_set()
19178     * @see elm_genlist_item_cursor_get()
19179     * @see elm_genlist_item_cursor_unset()
19180     *
19181     * @ingroup Genlist
19182     */
19183    EAPI void               elm_genlist_item_cursor_set(Elm_Genlist_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
19184    /**
19185     * Get the type of mouse pointer/cursor decoration set to be shown,
19186     * when the mouse pointer is over the given genlist widget item
19187     *
19188     * @param item genlist item with custom cursor set
19189     * @return the cursor type's name or @c NULL, if no custom cursors
19190     * were set to @p item (and on errors)
19191     *
19192     * @see elm_object_cursor_get()
19193     * @see elm_genlist_item_cursor_set() for more details
19194     * @see elm_genlist_item_cursor_unset()
19195     *
19196     * @ingroup Genlist
19197     */
19198    EAPI const char        *elm_genlist_item_cursor_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19199    /**
19200     * Unset any custom mouse pointer/cursor decoration set to be
19201     * shown, when the mouse pointer is over the given genlist widget
19202     * item, thus making it show the @b default cursor again.
19203     *
19204     * @param item a genlist item
19205     *
19206     * Use this call to undo any custom settings on this item's cursor
19207     * decoration, bringing it back to defaults (no custom style set).
19208     *
19209     * @see elm_object_cursor_unset()
19210     * @see elm_genlist_item_cursor_set() for more details
19211     *
19212     * @ingroup Genlist
19213     */
19214    EAPI void               elm_genlist_item_cursor_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19215    /**
19216     * Set a different @b style for a given custom cursor set for a
19217     * genlist item.
19218     *
19219     * @param item genlist item with custom cursor set
19220     * @param style the <b>theme style</b> to use (e.g. @c "default",
19221     * @c "transparent", etc)
19222     *
19223     * This function only makes sense when one is using custom mouse
19224     * cursor decorations <b>defined in a theme file</b> , which can
19225     * have, given a cursor name/type, <b>alternate styles</b> on
19226     * it. It works analogously as elm_object_cursor_style_set(), but
19227     * here applied only to genlist item objects.
19228     *
19229     * @warning Before you set a cursor style you should have defined a
19230     *       custom cursor previously on the item, with
19231     *       elm_genlist_item_cursor_set()
19232     *
19233     * @see elm_genlist_item_cursor_engine_only_set()
19234     * @see elm_genlist_item_cursor_style_get()
19235     *
19236     * @ingroup Genlist
19237     */
19238    EAPI void               elm_genlist_item_cursor_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
19239    /**
19240     * Get the current @b style set for a given genlist item's custom
19241     * cursor
19242     *
19243     * @param item genlist item with custom cursor set.
19244     * @return style the cursor style in use. If the object does not
19245     *         have a cursor set, then @c NULL is returned.
19246     *
19247     * @see elm_genlist_item_cursor_style_set() for more details
19248     *
19249     * @ingroup Genlist
19250     */
19251    EAPI const char        *elm_genlist_item_cursor_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19252    /**
19253     * Set if the (custom) cursor for a given genlist item should be
19254     * searched in its theme, also, or should only rely on the
19255     * rendering engine.
19256     *
19257     * @param item item with custom (custom) cursor already set on
19258     * @param engine_only Use @c EINA_TRUE to have cursors looked for
19259     * only on those provided by the rendering engine, @c EINA_FALSE to
19260     * have them searched on the widget's theme, as well.
19261     *
19262     * @note This call is of use only if you've set a custom cursor
19263     * for genlist items, with elm_genlist_item_cursor_set().
19264     *
19265     * @note By default, cursors will only be looked for between those
19266     * provided by the rendering engine.
19267     *
19268     * @ingroup Genlist
19269     */
19270    EAPI void               elm_genlist_item_cursor_engine_only_set(Elm_Genlist_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
19271    /**
19272     * Get if the (custom) cursor for a given genlist item is being
19273     * searched in its theme, also, or is only relying on the rendering
19274     * engine.
19275     *
19276     * @param item a genlist item
19277     * @return @c EINA_TRUE, if cursors are being looked for only on
19278     * those provided by the rendering engine, @c EINA_FALSE if they
19279     * are being searched on the widget's theme, as well.
19280     *
19281     * @see elm_genlist_item_cursor_engine_only_set(), for more details
19282     *
19283     * @ingroup Genlist
19284     */
19285    EAPI Eina_Bool          elm_genlist_item_cursor_engine_only_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19286    /**
19287     * Update the contents of all realized items.
19288     *
19289     * @param obj The genlist object.
19290     *
19291     * This updates all realized items by calling all the item class functions again
19292     * to get the icons, labels and states. Use this when the original
19293     * item data has changed and the changes are desired to be reflected.
19294     *
19295     * To update just one item, use elm_genlist_item_update().
19296     *
19297     * @see elm_genlist_realized_items_get()
19298     * @see elm_genlist_item_update()
19299     *
19300     * @ingroup Genlist
19301     */
19302    EAPI void               elm_genlist_realized_items_update(Evas_Object *obj) EINA_ARG_NONNULL(1);
19303    /**
19304     * Activate a genlist mode on an item
19305     *
19306     * @param item The genlist item
19307     * @param mode Mode name
19308     * @param mode_set Boolean to define set or unset mode.
19309     *
19310     * A genlist mode is a different way of selecting an item. Once a mode is
19311     * activated on an item, any other selected item is immediately unselected.
19312     * This feature provides an easy way of implementing a new kind of animation
19313     * for selecting an item, without having to entirely rewrite the item style
19314     * theme. However, the elm_genlist_selected_* API can't be used to get what
19315     * item is activate for a mode.
19316     *
19317     * The current item style will still be used, but applying a genlist mode to
19318     * an item will select it using a different kind of animation.
19319     *
19320     * The current active item for a mode can be found by
19321     * elm_genlist_mode_item_get().
19322     *
19323     * The characteristics of genlist mode are:
19324     * - Only one mode can be active at any time, and for only one item.
19325     * - Genlist handles deactivating other items when one item is activated.
19326     * - A mode is defined in the genlist theme (edc), and more modes can easily
19327     *   be added.
19328     * - A mode style and the genlist item style are different things. They
19329     *   can be combined to provide a default style to the item, with some kind
19330     *   of animation for that item when the mode is activated.
19331     *
19332     * When a mode is activated on an item, a new view for that item is created.
19333     * The theme of this mode defines the animation that will be used to transit
19334     * the item from the old view to the new view. This second (new) view will be
19335     * active for that item while the mode is active on the item, and will be
19336     * destroyed after the mode is totally deactivated from that item.
19337     *
19338     * @see elm_genlist_mode_get()
19339     * @see elm_genlist_mode_item_get()
19340     *
19341     * @ingroup Genlist
19342     */
19343    EAPI void               elm_genlist_item_mode_set(Elm_Genlist_Item *it, const char *mode_type, Eina_Bool mode_set) EINA_ARG_NONNULL(1, 2);
19344    /**
19345     * Get the last (or current) genlist mode used.
19346     *
19347     * @param obj The genlist object
19348     *
19349     * This function just returns the name of the last used genlist mode. It will
19350     * be the current mode if it's still active.
19351     *
19352     * @see elm_genlist_item_mode_set()
19353     * @see elm_genlist_mode_item_get()
19354     *
19355     * @ingroup Genlist
19356     */
19357    EAPI const char        *elm_genlist_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19358    /**
19359     * Get active genlist mode item
19360     *
19361     * @param obj The genlist object
19362     * @return The active item for that current mode. Or @c NULL if no item is
19363     * activated with any mode.
19364     *
19365     * This function returns the item that was activated with a mode, by the
19366     * function elm_genlist_item_mode_set().
19367     *
19368     * @see elm_genlist_item_mode_set()
19369     * @see elm_genlist_mode_get()
19370     *
19371     * @ingroup Genlist
19372     */
19373    EAPI const Elm_Genlist_Item *elm_genlist_mode_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19374
19375    /**
19376     * Set reorder mode
19377     *
19378     * @param obj The genlist object
19379     * @param reorder_mode The reorder mode
19380     * (EINA_TRUE = on, EINA_FALSE = off)
19381     *
19382     * @ingroup Genlist
19383     */
19384    EAPI void               elm_genlist_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
19385
19386    /**
19387     * Get the reorder mode
19388     *
19389     * @param obj The genlist object
19390     * @return The reorder mode
19391     * (EINA_TRUE = on, EINA_FALSE = off)
19392     *
19393     * @ingroup Genlist
19394     */
19395    EAPI Eina_Bool          elm_genlist_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19396
19397    EAPI void               elm_genlist_edit_mode_set(Evas_Object *obj, Eina_Bool edit_mode) EINA_ARG_NONNULL(1);
19398    EAPI Eina_Bool          elm_genlist_edit_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19399    EAPI void               elm_genlist_item_rename_mode_set(Elm_Genlist_Item *it, Eina_Bool renamed) EINA_ARG_NONNULL(1);
19400    EAPI Eina_Bool          elm_genlist_item_rename_mode_get(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19401    EAPI void               elm_genlist_item_move_after(Elm_Genlist_Item *it, Elm_Genlist_Item *after ) EINA_ARG_NONNULL(1, 2);
19402    EAPI void               elm_genlist_item_move_before(Elm_Genlist_Item *it, Elm_Genlist_Item *before) EINA_ARG_NONNULL(1, 2);
19403    EAPI void               elm_genlist_effect_set(const Evas_Object *obj, Eina_Bool emode) EINA_ARG_NONNULL(1);
19404    EAPI void               elm_genlist_pinch_zoom_set(Evas_Object *obj, Eina_Bool emode) EINA_ARG_NONNULL(1);
19405    EAPI void               elm_genlist_pinch_zoom_mode_set(Evas_Object *obj, Eina_Bool emode) EINA_ARG_NONNULL(1);
19406    EAPI Eina_Bool          elm_genlist_pinch_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19407
19408    /**
19409     * @}
19410     */
19411
19412    /**
19413     * @defgroup Check Check
19414     *
19415     * @image html img/widget/check/preview-00.png
19416     * @image latex img/widget/check/preview-00.eps
19417     * @image html img/widget/check/preview-01.png
19418     * @image latex img/widget/check/preview-01.eps
19419     * @image html img/widget/check/preview-02.png
19420     * @image latex img/widget/check/preview-02.eps
19421     *
19422     * @brief The check widget allows for toggling a value between true and
19423     * false.
19424     *
19425     * Check objects are a lot like radio objects in layout and functionality
19426     * except they do not work as a group, but independently and only toggle the
19427     * value of a boolean from false to true (0 or 1). elm_check_state_set() sets
19428     * the boolean state (1 for true, 0 for false), and elm_check_state_get()
19429     * returns the current state. For convenience, like the radio objects, you
19430     * can set a pointer to a boolean directly with elm_check_state_pointer_set()
19431     * for it to modify.
19432     *
19433     * Signals that you can add callbacks for are:
19434     * "changed" - This is called whenever the user changes the state of one of
19435     *             the check object(event_info is NULL).
19436     *
19437     * Default contents parts of the check widget that you can use for are:
19438     * @li "elm.swallow.content" - A icon of the check
19439     *
19440     * Default text parts of the check widget that you can use for are:
19441     * @li "elm.text" - Label of the check
19442     *
19443     * @ref tutorial_check should give you a firm grasp of how to use this widget
19444     * .
19445     * @{
19446     */
19447    /**
19448     * @brief Add a new Check object
19449     *
19450     * @param parent The parent object
19451     * @return The new object or NULL if it cannot be created
19452     */
19453    EAPI Evas_Object *elm_check_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19454    /**
19455     * @brief Set the text label of the check object
19456     *
19457     * @param obj The check object
19458     * @param label The text label string in UTF-8
19459     *
19460     * @deprecated use elm_object_text_set() instead.
19461     */
19462    EINA_DEPRECATED EAPI void         elm_check_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
19463    /**
19464     * @brief Get the text label of the check object
19465     *
19466     * @param obj The check object
19467     * @return The text label string in UTF-8
19468     *
19469     * @deprecated use elm_object_text_get() instead.
19470     */
19471    EINA_DEPRECATED EAPI const char  *elm_check_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19472    /**
19473     * @brief Set the icon object of the check object
19474     *
19475     * @param obj The check object
19476     * @param icon The icon object
19477     *
19478     * Once the icon object is set, a previously set one will be deleted.
19479     * If you want to keep that old content object, use the
19480     * elm_object_content_unset() function.
19481     */
19482    EINA_DEPRECATED EAPI void         elm_check_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
19483    /**
19484     * @brief Get the icon object of the check object
19485     *
19486     * @param obj The check object
19487     * @return The icon object
19488     */
19489    EINA_DEPRECATED EAPI Evas_Object *elm_check_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19490    /**
19491     * @brief Unset the icon used for the check object
19492     *
19493     * @param obj The check object
19494     * @return The icon object that was being used
19495     *
19496     * Unparent and return the icon object which was set for this widget.
19497     */
19498    EINA_DEPRECATED EAPI Evas_Object *elm_check_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
19499    /**
19500     * @brief Set the on/off state of the check object
19501     *
19502     * @param obj The check object
19503     * @param state The state to use (1 == on, 0 == off)
19504     *
19505     * This sets the state of the check. If set
19506     * with elm_check_state_pointer_set() the state of that variable is also
19507     * changed. Calling this @b doesn't cause the "changed" signal to be emited.
19508     */
19509    EAPI void         elm_check_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
19510    /**
19511     * @brief Get the state of the check object
19512     *
19513     * @param obj The check object
19514     * @return The boolean state
19515     */
19516    EAPI Eina_Bool    elm_check_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19517    /**
19518     * @brief Set a convenience pointer to a boolean to change
19519     *
19520     * @param obj The check object
19521     * @param statep Pointer to the boolean to modify
19522     *
19523     * This sets a pointer to a boolean, that, in addition to the check objects
19524     * state will also be modified directly. To stop setting the object pointed
19525     * to simply use NULL as the @p statep parameter. If @p statep is not NULL,
19526     * then when this is called, the check objects state will also be modified to
19527     * reflect the value of the boolean @p statep points to, just like calling
19528     * elm_check_state_set().
19529     */
19530    EAPI void         elm_check_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
19531    /**
19532     * @}
19533     */
19534
19535    /**
19536     * @defgroup Radio Radio
19537     *
19538     * @image html img/widget/radio/preview-00.png
19539     * @image latex img/widget/radio/preview-00.eps
19540     *
19541     * @brief Radio is a widget that allows for 1 or more options to be displayed
19542     * and have the user choose only 1 of them.
19543     *
19544     * A radio object contains an indicator, an optional Label and an optional
19545     * icon object. While it's possible to have a group of only one radio they,
19546     * are normally used in groups of 2 or more. To add a radio to a group use
19547     * elm_radio_group_add(). The radio object(s) will select from one of a set
19548     * of integer values, so any value they are configuring needs to be mapped to
19549     * a set of integers. To configure what value that radio object represents,
19550     * use  elm_radio_state_value_set() to set the integer it represents. To set
19551     * the value the whole group(which one is currently selected) is to indicate
19552     * use elm_radio_value_set() on any group member, and to get the groups value
19553     * use elm_radio_value_get(). For convenience the radio objects are also able
19554     * to directly set an integer(int) to the value that is selected. To specify
19555     * the pointer to this integer to modify, use elm_radio_value_pointer_set().
19556     * The radio objects will modify this directly. That implies the pointer must
19557     * point to valid memory for as long as the radio objects exist.
19558     *
19559     * Signals that you can add callbacks for are:
19560     * @li changed - This is called whenever the user changes the state of one of
19561     * the radio objects within the group of radio objects that work together.
19562     *
19563     * Default contents parts of the radio widget that you can use for are:
19564     * @li "elm.swallow.content" - A icon of the radio
19565     *
19566     * @ref tutorial_radio show most of this API in action.
19567     * @{
19568     */
19569    /**
19570     * @brief Add a new radio to the parent
19571     *
19572     * @param parent The parent object
19573     * @return The new object or NULL if it cannot be created
19574     */
19575    EAPI Evas_Object *elm_radio_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19576    /**
19577     * @brief Set the text label of the radio object
19578     *
19579     * @param obj The radio object
19580     * @param label The text label string in UTF-8
19581     *
19582     * @deprecated use elm_object_text_set() instead.
19583     */
19584    EINA_DEPRECATED EAPI void         elm_radio_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
19585    /**
19586     * @brief Get the text label of the radio object
19587     *
19588     * @param obj The radio object
19589     * @return The text label string in UTF-8
19590     *
19591     * @deprecated use elm_object_text_set() instead.
19592     */
19593    EINA_DEPRECATED EAPI const char  *elm_radio_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19594    /**
19595     * @brief Set the icon object of the radio object
19596     *
19597     * @param obj The radio object
19598     * @param icon The icon object
19599     *
19600     * Once the icon object is set, a previously set one will be deleted. If you
19601     * want to keep that old content object, use the elm_radio_icon_unset()
19602     * function.
19603     &
19604     * @deprecated use elm_object_content_set() instead.
19605     */
19606    EINA_DEPRECATED EAPI void         elm_radio_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
19607    /**
19608     * @brief Get the icon object of the radio object
19609     *
19610     * @param obj The radio object
19611     * @return The icon object
19612     *
19613     * @see elm_radio_icon_set()
19614     */
19615    EINA_DEPRECATED EAPI Evas_Object *elm_radio_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19616    /**
19617     * @brief Unset the icon used for the radio object
19618     *
19619     * @param obj The radio object
19620     * @return The icon object that was being used
19621     *
19622     * Unparent and return the icon object which was set for this widget.
19623     *
19624     * @see elm_radio_icon_set()
19625     * @deprecated use elm_object_content_unset() instead.
19626     */
19627    EINA_DEPRECATED EAPI Evas_Object *elm_radio_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
19628    /**
19629     * @brief Add this radio to a group of other radio objects
19630     *
19631     * @param obj The radio object
19632     * @param group Any object whose group the @p obj is to join.
19633     *
19634     * Radio objects work in groups. Each member should have a different integer
19635     * value assigned. In order to have them work as a group, they need to know
19636     * about each other. This adds the given radio object to the group of which
19637     * the group object indicated is a member.
19638     */
19639    EAPI void         elm_radio_group_add(Evas_Object *obj, Evas_Object *group) EINA_ARG_NONNULL(1);
19640    /**
19641     * @brief Set the integer value that this radio object represents
19642     *
19643     * @param obj The radio object
19644     * @param value The value to use if this radio object is selected
19645     *
19646     * This sets the value of the radio.
19647     */
19648    EAPI void         elm_radio_state_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
19649    /**
19650     * @brief Get the integer value that this radio object represents
19651     *
19652     * @param obj The radio object
19653     * @return The value used if this radio object is selected
19654     *
19655     * This gets the value of the radio.
19656     *
19657     * @see elm_radio_value_set()
19658     */
19659    EAPI int          elm_radio_state_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19660    /**
19661     * @brief Set the value of the radio.
19662     *
19663     * @param obj The radio object
19664     * @param value The value to use for the group
19665     *
19666     * This sets the value of the radio group and will also set the value if
19667     * pointed to, to the value supplied, but will not call any callbacks.
19668     */
19669    EAPI void         elm_radio_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
19670    /**
19671     * @brief Get the state of the radio object
19672     *
19673     * @param obj The radio object
19674     * @return The integer state
19675     */
19676    EAPI int          elm_radio_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19677    /**
19678     * @brief Set a convenience pointer to a integer to change
19679     *
19680     * @param obj The radio object
19681     * @param valuep Pointer to the integer to modify
19682     *
19683     * This sets a pointer to a integer, that, in addition to the radio objects
19684     * state will also be modified directly. To stop setting the object pointed
19685     * to simply use NULL as the @p valuep argument. If valuep is not NULL, then
19686     * when this is called, the radio objects state will also be modified to
19687     * reflect the value of the integer valuep points to, just like calling
19688     * elm_radio_value_set().
19689     */
19690    EAPI void         elm_radio_value_pointer_set(Evas_Object *obj, int *valuep) EINA_ARG_NONNULL(1);
19691    /**
19692     * @}
19693     */
19694
19695    /**
19696     * @defgroup Pager Pager
19697     *
19698     * @image html img/widget/pager/preview-00.png
19699     * @image latex img/widget/pager/preview-00.eps
19700     *
19701     * @brief Widget that allows flipping between 1 or more ā€œpagesā€ of objects.
19702     *
19703     * The flipping between ā€œpagesā€ of objects is animated. All content in pager
19704     * is kept in a stack, the last content to be added will be on the top of the
19705     * stack(be visible).
19706     *
19707     * Objects can be pushed or popped from the stack or deleted as normal.
19708     * Pushes and pops will animate (and a pop will delete the object once the
19709     * animation is finished). Any object already in the pager can be promoted to
19710     * the top(from its current stacking position) through the use of
19711     * elm_pager_content_promote(). Objects are pushed to the top with
19712     * elm_pager_content_push() and when the top item is no longer wanted, simply
19713     * pop it with elm_pager_content_pop() and it will also be deleted. If an
19714     * object is no longer needed and is not the top item, just delete it as
19715     * normal. You can query which objects are the top and bottom with
19716     * elm_pager_content_bottom_get() and elm_pager_content_top_get().
19717     *
19718     * Signals that you can add callbacks for are:
19719     * "hide,finished" - when the previous page is hided
19720     *
19721     * This widget has the following styles available:
19722     * @li default
19723     * @li fade
19724     * @li fade_translucide
19725     * @li fade_invisible
19726     * @note This styles affect only the flipping animations, the appearance when
19727     * not animating is unaffected by styles.
19728     *
19729     * @ref tutorial_pager gives a good overview of the usage of the API.
19730     * @{
19731     */
19732    /**
19733     * Add a new pager to the parent
19734     *
19735     * @param parent The parent object
19736     * @return The new object or NULL if it cannot be created
19737     *
19738     * @ingroup Pager
19739     */
19740    EAPI Evas_Object *elm_pager_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19741    /**
19742     * @brief Push an object to the top of the pager stack (and show it).
19743     *
19744     * @param obj The pager object
19745     * @param content The object to push
19746     *
19747     * The object pushed becomes a child of the pager, it will be controlled and
19748     * deleted when the pager is deleted.
19749     *
19750     * @note If the content is already in the stack use
19751     * elm_pager_content_promote().
19752     * @warning Using this function on @p content already in the stack results in
19753     * undefined behavior.
19754     */
19755    EAPI void         elm_pager_content_push(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
19756    /**
19757     * @brief Pop the object that is on top of the stack
19758     *
19759     * @param obj The pager object
19760     *
19761     * This pops the object that is on the top(visible) of the pager, makes it
19762     * disappear, then deletes the object. The object that was underneath it on
19763     * the stack will become visible.
19764     */
19765    EAPI void         elm_pager_content_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
19766    /**
19767     * @brief Moves an object already in the pager stack to the top of the stack.
19768     *
19769     * @param obj The pager object
19770     * @param content The object to promote
19771     *
19772     * This will take the @p content and move it to the top of the stack as
19773     * if it had been pushed there.
19774     *
19775     * @note If the content isn't already in the stack use
19776     * elm_pager_content_push().
19777     * @warning Using this function on @p content not already in the stack
19778     * results in undefined behavior.
19779     */
19780    EAPI void         elm_pager_content_promote(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
19781    /**
19782     * @brief Return the object at the bottom of the pager stack
19783     *
19784     * @param obj The pager object
19785     * @return The bottom object or NULL if none
19786     */
19787    EAPI Evas_Object *elm_pager_content_bottom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19788    /**
19789     * @brief  Return the object at the top of the pager stack
19790     *
19791     * @param obj The pager object
19792     * @return The top object or NULL if none
19793     */
19794    EAPI Evas_Object *elm_pager_content_top_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19795
19796    EAPI void         elm_pager_to_content_pop(Evas_Object *obj, Evas_Object *content); EINA_ARG_NONNULL(1);
19797    EAPI void         elm_pager_animation_disabled_set(Evas_Object *obj, Eina_Bool disable); EINA_ARG_NONNULL(1);
19798
19799    /**
19800     * @}
19801     */
19802
19803    /**
19804     * @defgroup Slideshow Slideshow
19805     *
19806     * @image html img/widget/slideshow/preview-00.png
19807     * @image latex img/widget/slideshow/preview-00.eps
19808     *
19809     * This widget, as the name indicates, is a pre-made image
19810     * slideshow panel, with API functions acting on (child) image
19811     * items presentation. Between those actions, are:
19812     * - advance to next/previous image
19813     * - select the style of image transition animation
19814     * - set the exhibition time for each image
19815     * - start/stop the slideshow
19816     *
19817     * The transition animations are defined in the widget's theme,
19818     * consequently new animations can be added without having to
19819     * update the widget's code.
19820     *
19821     * @section Slideshow_Items Slideshow items
19822     *
19823     * For slideshow items, just like for @ref Genlist "genlist" ones,
19824     * the user defines a @b classes, specifying functions that will be
19825     * called on the item's creation and deletion times.
19826     *
19827     * The #Elm_Slideshow_Item_Class structure contains the following
19828     * members:
19829     *
19830     * - @c func.get - When an item is displayed, this function is
19831     *   called, and it's where one should create the item object, de
19832     *   facto. For example, the object can be a pure Evas image object
19833     *   or an Elementary @ref Photocam "photocam" widget. See
19834     *   #SlideshowItemGetFunc.
19835     * - @c func.del - When an item is no more displayed, this function
19836     *   is called, where the user must delete any data associated to
19837     *   the item. See #SlideshowItemDelFunc.
19838     *
19839     * @section Slideshow_Caching Slideshow caching
19840     *
19841     * The slideshow provides facilities to have items adjacent to the
19842     * one being displayed <b>already "realized"</b> (i.e. loaded) for
19843     * you, so that the system does not have to decode image data
19844     * anymore at the time it has to actually switch images on its
19845     * viewport. The user is able to set the numbers of items to be
19846     * cached @b before and @b after the current item, in the widget's
19847     * item list.
19848     *
19849     * Smart events one can add callbacks for are:
19850     *
19851     * - @c "changed" - when the slideshow switches its view to a new
19852     *   item
19853     *
19854     * List of examples for the slideshow widget:
19855     * @li @ref slideshow_example
19856     */
19857
19858    /**
19859     * @addtogroup Slideshow
19860     * @{
19861     */
19862
19863    typedef struct _Elm_Slideshow_Item_Class Elm_Slideshow_Item_Class; /**< Slideshow item class definition struct */
19864    typedef struct _Elm_Slideshow_Item_Class_Func Elm_Slideshow_Item_Class_Func; /**< Class functions for slideshow item classes. */
19865    typedef struct _Elm_Slideshow_Item       Elm_Slideshow_Item; /**< Slideshow item handle */
19866    typedef Evas_Object *(*SlideshowItemGetFunc) (void *data, Evas_Object *obj); /**< Image fetching class function for slideshow item classes. */
19867    typedef void         (*SlideshowItemDelFunc) (void *data, Evas_Object *obj); /**< Deletion class function for slideshow item classes. */
19868
19869    /**
19870     * @struct _Elm_Slideshow_Item_Class
19871     *
19872     * Slideshow item class definition. See @ref Slideshow_Items for
19873     * field details.
19874     */
19875    struct _Elm_Slideshow_Item_Class
19876      {
19877         struct _Elm_Slideshow_Item_Class_Func
19878           {
19879              SlideshowItemGetFunc get;
19880              SlideshowItemDelFunc del;
19881           } func;
19882      }; /**< #Elm_Slideshow_Item_Class member definitions */
19883
19884    /**
19885     * Add a new slideshow widget to the given parent Elementary
19886     * (container) object
19887     *
19888     * @param parent The parent object
19889     * @return A new slideshow widget handle or @c NULL, on errors
19890     *
19891     * This function inserts a new slideshow widget on the canvas.
19892     *
19893     * @ingroup Slideshow
19894     */
19895    EAPI Evas_Object        *elm_slideshow_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19896
19897    /**
19898     * Add (append) a new item in a given slideshow widget.
19899     *
19900     * @param obj The slideshow object
19901     * @param itc The item class for the item
19902     * @param data The item's data
19903     * @return A handle to the item added or @c NULL, on errors
19904     *
19905     * Add a new item to @p obj's internal list of items, appending it.
19906     * The item's class must contain the function really fetching the
19907     * image object to show for this item, which could be an Evas image
19908     * object or an Elementary photo, for example. The @p data
19909     * parameter is going to be passed to both class functions of the
19910     * item.
19911     *
19912     * @see #Elm_Slideshow_Item_Class
19913     * @see elm_slideshow_item_sorted_insert()
19914     *
19915     * @ingroup Slideshow
19916     */
19917    EAPI Elm_Slideshow_Item *elm_slideshow_item_add(Evas_Object *obj, const Elm_Slideshow_Item_Class *itc, const void *data) EINA_ARG_NONNULL(1);
19918
19919    /**
19920     * Insert a new item into the given slideshow widget, using the @p func
19921     * function to sort items (by item handles).
19922     *
19923     * @param obj The slideshow object
19924     * @param itc The item class for the item
19925     * @param data The item's data
19926     * @param func The comparing function to be used to sort slideshow
19927     * items <b>by #Elm_Slideshow_Item item handles</b>
19928     * @return Returns The slideshow item handle, on success, or
19929     * @c NULL, on errors
19930     *
19931     * Add a new item to @p obj's internal list of items, in a position
19932     * determined by the @p func comparing function. The item's class
19933     * must contain the function really fetching the image object to
19934     * show for this item, which could be an Evas image object or an
19935     * Elementary photo, for example. The @p data parameter is going to
19936     * be passed to both class functions of the item.
19937     *
19938     * @see #Elm_Slideshow_Item_Class
19939     * @see elm_slideshow_item_add()
19940     *
19941     * @ingroup Slideshow
19942     */
19943    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);
19944
19945    /**
19946     * Display a given slideshow widget's item, programmatically.
19947     *
19948     * @param obj The slideshow object
19949     * @param item The item to display on @p obj's viewport
19950     *
19951     * The change between the current item and @p item will use the
19952     * transition @p obj is set to use (@see
19953     * elm_slideshow_transition_set()).
19954     *
19955     * @ingroup Slideshow
19956     */
19957    EAPI void                elm_slideshow_show(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
19958
19959    /**
19960     * Slide to the @b next item, in a given slideshow widget
19961     *
19962     * @param obj The slideshow object
19963     *
19964     * The sliding animation @p obj is set to use will be the
19965     * transition effect used, after this call is issued.
19966     *
19967     * @note If the end of the slideshow's internal list of items is
19968     * reached, it'll wrap around to the list's beginning, again.
19969     *
19970     * @ingroup Slideshow
19971     */
19972    EAPI void                elm_slideshow_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
19973
19974    /**
19975     * Slide to the @b previous item, in a given slideshow widget
19976     *
19977     * @param obj The slideshow object
19978     *
19979     * The sliding animation @p obj is set to use will be the
19980     * transition effect used, after this call is issued.
19981     *
19982     * @note If the beginning of the slideshow's internal list of items
19983     * is reached, it'll wrap around to the list's end, again.
19984     *
19985     * @ingroup Slideshow
19986     */
19987    EAPI void                elm_slideshow_previous(Evas_Object *obj) EINA_ARG_NONNULL(1);
19988
19989    /**
19990     * Returns the list of sliding transition/effect names available, for a
19991     * given slideshow widget.
19992     *
19993     * @param obj The slideshow object
19994     * @return The list of transitions (list of @b stringshared strings
19995     * as data)
19996     *
19997     * The transitions, which come from @p obj's theme, must be an EDC
19998     * data item named @c "transitions" on the theme file, with (prefix)
19999     * names of EDC programs actually implementing them.
20000     *
20001     * The available transitions for slideshows on the default theme are:
20002     * - @c "fade" - the current item fades out, while the new one
20003     *   fades in to the slideshow's viewport.
20004     * - @c "black_fade" - the current item fades to black, and just
20005     *   then, the new item will fade in.
20006     * - @c "horizontal" - the current item slides horizontally, until
20007     *   it gets out of the slideshow's viewport, while the new item
20008     *   comes from the left to take its place.
20009     * - @c "vertical" - the current item slides vertically, until it
20010     *   gets out of the slideshow's viewport, while the new item comes
20011     *   from the bottom to take its place.
20012     * - @c "square" - the new item starts to appear from the middle of
20013     *   the current one, but with a tiny size, growing until its
20014     *   target (full) size and covering the old one.
20015     *
20016     * @warning The stringshared strings get no new references
20017     * exclusive to the user grabbing the list, here, so if you'd like
20018     * to use them out of this call's context, you'd better @c
20019     * eina_stringshare_ref() them.
20020     *
20021     * @see elm_slideshow_transition_set()
20022     *
20023     * @ingroup Slideshow
20024     */
20025    EAPI const Eina_List    *elm_slideshow_transitions_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20026
20027    /**
20028     * Set the current slide transition/effect in use for a given
20029     * slideshow widget
20030     *
20031     * @param obj The slideshow object
20032     * @param transition The new transition's name string
20033     *
20034     * If @p transition is implemented in @p obj's theme (i.e., is
20035     * contained in the list returned by
20036     * elm_slideshow_transitions_get()), this new sliding effect will
20037     * be used on the widget.
20038     *
20039     * @see elm_slideshow_transitions_get() for more details
20040     *
20041     * @ingroup Slideshow
20042     */
20043    EAPI void                elm_slideshow_transition_set(Evas_Object *obj, const char *transition) EINA_ARG_NONNULL(1);
20044
20045    /**
20046     * Get the current slide transition/effect in use for a given
20047     * slideshow widget
20048     *
20049     * @param obj The slideshow object
20050     * @return The current transition's name
20051     *
20052     * @see elm_slideshow_transition_set() for more details
20053     *
20054     * @ingroup Slideshow
20055     */
20056    EAPI const char         *elm_slideshow_transition_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20057
20058    /**
20059     * Set the interval between each image transition on a given
20060     * slideshow widget, <b>and start the slideshow, itself</b>
20061     *
20062     * @param obj The slideshow object
20063     * @param timeout The new displaying timeout for images
20064     *
20065     * After this call, the slideshow widget will start cycling its
20066     * view, sequentially and automatically, with the images of the
20067     * items it has. The time between each new image displayed is going
20068     * to be @p timeout, in @b seconds. If a different timeout was set
20069     * previously and an slideshow was in progress, it will continue
20070     * with the new time between transitions, after this call.
20071     *
20072     * @note A value less than or equal to 0 on @p timeout will disable
20073     * the widget's internal timer, thus halting any slideshow which
20074     * could be happening on @p obj.
20075     *
20076     * @see elm_slideshow_timeout_get()
20077     *
20078     * @ingroup Slideshow
20079     */
20080    EAPI void                elm_slideshow_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
20081
20082    /**
20083     * Get the interval set for image transitions on a given slideshow
20084     * widget.
20085     *
20086     * @param obj The slideshow object
20087     * @return Returns the timeout set on it
20088     *
20089     * @see elm_slideshow_timeout_set() for more details
20090     *
20091     * @ingroup Slideshow
20092     */
20093    EAPI double              elm_slideshow_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20094
20095    /**
20096     * Set if, after a slideshow is started, for a given slideshow
20097     * widget, its items should be displayed cyclically or not.
20098     *
20099     * @param obj The slideshow object
20100     * @param loop Use @c EINA_TRUE to make it cycle through items or
20101     * @c EINA_FALSE for it to stop at the end of @p obj's internal
20102     * list of items
20103     *
20104     * @note elm_slideshow_next() and elm_slideshow_previous() will @b
20105     * ignore what is set by this functions, i.e., they'll @b always
20106     * cycle through items. This affects only the "automatic"
20107     * slideshow, as set by elm_slideshow_timeout_set().
20108     *
20109     * @see elm_slideshow_loop_get()
20110     *
20111     * @ingroup Slideshow
20112     */
20113    EAPI void                elm_slideshow_loop_set(Evas_Object *obj, Eina_Bool loop) EINA_ARG_NONNULL(1);
20114
20115    /**
20116     * Get if, after a slideshow is started, for a given slideshow
20117     * widget, its items are to be displayed cyclically or not.
20118     *
20119     * @param obj The slideshow object
20120     * @return @c EINA_TRUE, if the items in @p obj will be cycled
20121     * through or @c EINA_FALSE, otherwise
20122     *
20123     * @see elm_slideshow_loop_set() for more details
20124     *
20125     * @ingroup Slideshow
20126     */
20127    EAPI Eina_Bool           elm_slideshow_loop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20128
20129    /**
20130     * Remove all items from a given slideshow widget
20131     *
20132     * @param obj The slideshow object
20133     *
20134     * This removes (and deletes) all items in @p obj, leaving it
20135     * empty.
20136     *
20137     * @see elm_slideshow_item_del(), to remove just one item.
20138     *
20139     * @ingroup Slideshow
20140     */
20141    EAPI void                elm_slideshow_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
20142
20143    /**
20144     * Get the internal list of items in a given slideshow widget.
20145     *
20146     * @param obj The slideshow object
20147     * @return The list of items (#Elm_Slideshow_Item as data) or
20148     * @c NULL on errors.
20149     *
20150     * This list is @b not to be modified in any way and must not be
20151     * freed. Use the list members with functions like
20152     * elm_slideshow_item_del(), elm_slideshow_item_data_get().
20153     *
20154     * @warning This list is only valid until @p obj object's internal
20155     * items list is changed. It should be fetched again with another
20156     * call to this function when changes happen.
20157     *
20158     * @ingroup Slideshow
20159     */
20160    EAPI const Eina_List    *elm_slideshow_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20161
20162    /**
20163     * Delete a given item from a slideshow widget.
20164     *
20165     * @param item The slideshow item
20166     *
20167     * @ingroup Slideshow
20168     */
20169    EAPI void                elm_slideshow_item_del(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
20170
20171    /**
20172     * Return the data associated with a given slideshow item
20173     *
20174     * @param item The slideshow item
20175     * @return Returns the data associated to this item
20176     *
20177     * @ingroup Slideshow
20178     */
20179    EAPI void               *elm_slideshow_item_data_get(const Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
20180
20181    /**
20182     * Returns the currently displayed item, in a given slideshow widget
20183     *
20184     * @param obj The slideshow object
20185     * @return A handle to the item being displayed in @p obj or
20186     * @c NULL, if none is (and on errors)
20187     *
20188     * @ingroup Slideshow
20189     */
20190    EAPI Elm_Slideshow_Item *elm_slideshow_item_current_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20191
20192    /**
20193     * Get the real Evas object created to implement the view of a
20194     * given slideshow item
20195     *
20196     * @param item The slideshow item.
20197     * @return the Evas object implementing this item's view.
20198     *
20199     * This returns the actual Evas object used to implement the
20200     * specified slideshow item's view. This may be @c NULL, as it may
20201     * not have been created or may have been deleted, at any time, by
20202     * the slideshow. <b>Do not modify this object</b> (move, resize,
20203     * show, hide, etc.), as the slideshow is controlling it. This
20204     * function is for querying, emitting custom signals or hooking
20205     * lower level callbacks for events on that object. Do not delete
20206     * this object under any circumstances.
20207     *
20208     * @see elm_slideshow_item_data_get()
20209     *
20210     * @ingroup Slideshow
20211     */
20212    EAPI Evas_Object*        elm_slideshow_item_object_get(const Elm_Slideshow_Item* item) EINA_ARG_NONNULL(1);
20213
20214    /**
20215     * Get the the item, in a given slideshow widget, placed at
20216     * position @p nth, in its internal items list
20217     *
20218     * @param obj The slideshow object
20219     * @param nth The number of the item to grab a handle to (0 being
20220     * the first)
20221     * @return The item stored in @p obj at position @p nth or @c NULL,
20222     * if there's no item with that index (and on errors)
20223     *
20224     * @ingroup Slideshow
20225     */
20226    EAPI Elm_Slideshow_Item *elm_slideshow_item_nth_get(const Evas_Object *obj, unsigned int nth) EINA_ARG_NONNULL(1);
20227
20228    /**
20229     * Set the current slide layout in use for a given slideshow widget
20230     *
20231     * @param obj The slideshow object
20232     * @param layout The new layout's name string
20233     *
20234     * If @p layout is implemented in @p obj's theme (i.e., is contained
20235     * in the list returned by elm_slideshow_layouts_get()), this new
20236     * images layout will be used on the widget.
20237     *
20238     * @see elm_slideshow_layouts_get() for more details
20239     *
20240     * @ingroup Slideshow
20241     */
20242    EAPI void                elm_slideshow_layout_set(Evas_Object *obj, const char *layout) EINA_ARG_NONNULL(1);
20243
20244    /**
20245     * Get the current slide layout in use for a given slideshow widget
20246     *
20247     * @param obj The slideshow object
20248     * @return The current layout's name
20249     *
20250     * @see elm_slideshow_layout_set() for more details
20251     *
20252     * @ingroup Slideshow
20253     */
20254    EAPI const char         *elm_slideshow_layout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20255
20256    /**
20257     * Returns the list of @b layout names available, for a given
20258     * slideshow widget.
20259     *
20260     * @param obj The slideshow object
20261     * @return The list of layouts (list of @b stringshared strings
20262     * as data)
20263     *
20264     * Slideshow layouts will change how the widget is to dispose each
20265     * image item in its viewport, with regard to cropping, scaling,
20266     * etc.
20267     *
20268     * The layouts, which come from @p obj's theme, must be an EDC
20269     * data item name @c "layouts" on the theme file, with (prefix)
20270     * names of EDC programs actually implementing them.
20271     *
20272     * The available layouts for slideshows on the default theme are:
20273     * - @c "fullscreen" - item images with original aspect, scaled to
20274     *   touch top and down slideshow borders or, if the image's heigh
20275     *   is not enough, left and right slideshow borders.
20276     * - @c "not_fullscreen" - the same behavior as the @c "fullscreen"
20277     *   one, but always leaving 10% of the slideshow's dimensions of
20278     *   distance between the item image's borders and the slideshow
20279     *   borders, for each axis.
20280     *
20281     * @warning The stringshared strings get no new references
20282     * exclusive to the user grabbing the list, here, so if you'd like
20283     * to use them out of this call's context, you'd better @c
20284     * eina_stringshare_ref() them.
20285     *
20286     * @see elm_slideshow_layout_set()
20287     *
20288     * @ingroup Slideshow
20289     */
20290    EAPI const Eina_List    *elm_slideshow_layouts_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20291
20292    /**
20293     * Set the number of items to cache, on a given slideshow widget,
20294     * <b>before the current item</b>
20295     *
20296     * @param obj The slideshow object
20297     * @param count Number of items to cache before the current one
20298     *
20299     * The default value for this property is @c 2. See
20300     * @ref Slideshow_Caching "slideshow caching" for more details.
20301     *
20302     * @see elm_slideshow_cache_before_get()
20303     *
20304     * @ingroup Slideshow
20305     */
20306    EAPI void                elm_slideshow_cache_before_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
20307
20308    /**
20309     * Retrieve the number of items to cache, on a given slideshow widget,
20310     * <b>before the current item</b>
20311     *
20312     * @param obj The slideshow object
20313     * @return The number of items set to be cached before the current one
20314     *
20315     * @see elm_slideshow_cache_before_set() for more details
20316     *
20317     * @ingroup Slideshow
20318     */
20319    EAPI int                 elm_slideshow_cache_before_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20320
20321    /**
20322     * Set the number of items to cache, on a given slideshow widget,
20323     * <b>after the current item</b>
20324     *
20325     * @param obj The slideshow object
20326     * @param count Number of items to cache after the current one
20327     *
20328     * The default value for this property is @c 2. See
20329     * @ref Slideshow_Caching "slideshow caching" for more details.
20330     *
20331     * @see elm_slideshow_cache_after_get()
20332     *
20333     * @ingroup Slideshow
20334     */
20335    EAPI void                elm_slideshow_cache_after_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
20336
20337    /**
20338     * Retrieve the number of items to cache, on a given slideshow widget,
20339     * <b>after the current item</b>
20340     *
20341     * @param obj The slideshow object
20342     * @return The number of items set to be cached after the current one
20343     *
20344     * @see elm_slideshow_cache_after_set() for more details
20345     *
20346     * @ingroup Slideshow
20347     */
20348    EAPI int                 elm_slideshow_cache_after_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20349
20350    /**
20351     * Get the number of items stored in a given slideshow widget
20352     *
20353     * @param obj The slideshow object
20354     * @return The number of items on @p obj, at the moment of this call
20355     *
20356     * @ingroup Slideshow
20357     */
20358    EAPI unsigned int        elm_slideshow_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20359
20360    /**
20361     * @}
20362     */
20363
20364    /**
20365     * @defgroup Fileselector File Selector
20366     *
20367     * @image html img/widget/fileselector/preview-00.png
20368     * @image latex img/widget/fileselector/preview-00.eps
20369     *
20370     * A file selector is a widget that allows a user to navigate
20371     * through a file system, reporting file selections back via its
20372     * API.
20373     *
20374     * It contains shortcut buttons for home directory (@c ~) and to
20375     * jump one directory upwards (..), as well as cancel/ok buttons to
20376     * confirm/cancel a given selection. After either one of those two
20377     * former actions, the file selector will issue its @c "done" smart
20378     * callback.
20379     *
20380     * There's a text entry on it, too, showing the name of the current
20381     * selection. There's the possibility of making it editable, so it
20382     * is useful on file saving dialogs on applications, where one
20383     * gives a file name to save contents to, in a given directory in
20384     * the system. This custom file name will be reported on the @c
20385     * "done" smart callback (explained in sequence).
20386     *
20387     * Finally, it has a view to display file system items into in two
20388     * possible forms:
20389     * - list
20390     * - grid
20391     *
20392     * If Elementary is built with support of the Ethumb thumbnailing
20393     * library, the second form of view will display preview thumbnails
20394     * of files which it supports.
20395     *
20396     * Smart callbacks one can register to:
20397     *
20398     * - @c "selected" - the user has clicked on a file (when not in
20399     *      folders-only mode) or directory (when in folders-only mode)
20400     * - @c "directory,open" - the list has been populated with new
20401     *      content (@c event_info is a pointer to the directory's
20402     *      path, a @b stringshared string)
20403     * - @c "done" - the user has clicked on the "ok" or "cancel"
20404     *      buttons (@c event_info is a pointer to the selection's
20405     *      path, a @b stringshared string)
20406     *
20407     * Here is an example on its usage:
20408     * @li @ref fileselector_example
20409     */
20410
20411    /**
20412     * @addtogroup Fileselector
20413     * @{
20414     */
20415
20416    /**
20417     * Defines how a file selector widget is to layout its contents
20418     * (file system entries).
20419     */
20420    typedef enum _Elm_Fileselector_Mode
20421      {
20422         ELM_FILESELECTOR_LIST = 0, /**< layout as a list */
20423         ELM_FILESELECTOR_GRID, /**< layout as a grid */
20424         ELM_FILESELECTOR_LAST /**< sentinel (helper) value, not used */
20425      } Elm_Fileselector_Mode;
20426
20427    /**
20428     * Add a new file selector widget to the given parent Elementary
20429     * (container) object
20430     *
20431     * @param parent The parent object
20432     * @return a new file selector widget handle or @c NULL, on errors
20433     *
20434     * This function inserts a new file selector widget on the canvas.
20435     *
20436     * @ingroup Fileselector
20437     */
20438    EAPI Evas_Object          *elm_fileselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20439
20440    /**
20441     * Enable/disable the file name entry box where the user can type
20442     * in a name for a file, in a given file selector widget
20443     *
20444     * @param obj The file selector object
20445     * @param is_save @c EINA_TRUE to make the file selector a "saving
20446     * dialog", @c EINA_FALSE otherwise
20447     *
20448     * Having the entry editable is useful on file saving dialogs on
20449     * applications, where one gives a file name to save contents to,
20450     * in a given directory in the system. This custom file name will
20451     * be reported on the @c "done" smart callback.
20452     *
20453     * @see elm_fileselector_is_save_get()
20454     *
20455     * @ingroup Fileselector
20456     */
20457    EAPI void                  elm_fileselector_is_save_set(Evas_Object *obj, Eina_Bool is_save) EINA_ARG_NONNULL(1);
20458
20459    /**
20460     * Get whether the given file selector is in "saving dialog" mode
20461     *
20462     * @param obj The file selector object
20463     * @return @c EINA_TRUE, if the file selector is in "saving dialog"
20464     * mode, @c EINA_FALSE otherwise (and on errors)
20465     *
20466     * @see elm_fileselector_is_save_set() for more details
20467     *
20468     * @ingroup Fileselector
20469     */
20470    EAPI Eina_Bool             elm_fileselector_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20471
20472    /**
20473     * Enable/disable folder-only view for a given file selector widget
20474     *
20475     * @param obj The file selector object
20476     * @param only @c EINA_TRUE to make @p obj only display
20477     * directories, @c EINA_FALSE to make files to be displayed in it
20478     * too
20479     *
20480     * If enabled, the widget's view will only display folder items,
20481     * naturally.
20482     *
20483     * @see elm_fileselector_folder_only_get()
20484     *
20485     * @ingroup Fileselector
20486     */
20487    EAPI void                  elm_fileselector_folder_only_set(Evas_Object *obj, Eina_Bool only) EINA_ARG_NONNULL(1);
20488
20489    /**
20490     * Get whether folder-only view is set for a given file selector
20491     * widget
20492     *
20493     * @param obj The file selector object
20494     * @return only @c EINA_TRUE if @p obj is only displaying
20495     * directories, @c EINA_FALSE if files are being displayed in it
20496     * too (and on errors)
20497     *
20498     * @see elm_fileselector_folder_only_get()
20499     *
20500     * @ingroup Fileselector
20501     */
20502    EAPI Eina_Bool             elm_fileselector_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20503
20504    /**
20505     * Enable/disable the "ok" and "cancel" buttons on a given file
20506     * selector widget
20507     *
20508     * @param obj The file selector object
20509     * @param only @c EINA_TRUE to show them, @c EINA_FALSE to hide.
20510     *
20511     * @note A file selector without those buttons will never emit the
20512     * @c "done" smart event, and is only usable if one is just hooking
20513     * to the other two events.
20514     *
20515     * @see elm_fileselector_buttons_ok_cancel_get()
20516     *
20517     * @ingroup Fileselector
20518     */
20519    EAPI void                  elm_fileselector_buttons_ok_cancel_set(Evas_Object *obj, Eina_Bool buttons) EINA_ARG_NONNULL(1);
20520
20521    /**
20522     * Get whether the "ok" and "cancel" buttons on a given file
20523     * selector widget are being shown.
20524     *
20525     * @param obj The file selector object
20526     * @return @c EINA_TRUE if they are being shown, @c EINA_FALSE
20527     * otherwise (and on errors)
20528     *
20529     * @see elm_fileselector_buttons_ok_cancel_set() for more details
20530     *
20531     * @ingroup Fileselector
20532     */
20533    EAPI Eina_Bool             elm_fileselector_buttons_ok_cancel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20534
20535    /**
20536     * Enable/disable a tree view in the given file selector widget,
20537     * <b>if it's in @c #ELM_FILESELECTOR_LIST mode</b>
20538     *
20539     * @param obj The file selector object
20540     * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
20541     * disable
20542     *
20543     * In a tree view, arrows are created on the sides of directories,
20544     * allowing them to expand in place.
20545     *
20546     * @note If it's in other mode, the changes made by this function
20547     * will only be visible when one switches back to "list" mode.
20548     *
20549     * @see elm_fileselector_expandable_get()
20550     *
20551     * @ingroup Fileselector
20552     */
20553    EAPI void                  elm_fileselector_expandable_set(Evas_Object *obj, Eina_Bool expand) EINA_ARG_NONNULL(1);
20554
20555    /**
20556     * Get whether tree view is enabled for the given file selector
20557     * widget
20558     *
20559     * @param obj The file selector object
20560     * @return @c EINA_TRUE if @p obj is in tree view, @c EINA_FALSE
20561     * otherwise (and or errors)
20562     *
20563     * @see elm_fileselector_expandable_set() for more details
20564     *
20565     * @ingroup Fileselector
20566     */
20567    EAPI Eina_Bool             elm_fileselector_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20568
20569    /**
20570     * Set, programmatically, the @b directory that a given file
20571     * selector widget will display contents from
20572     *
20573     * @param obj The file selector object
20574     * @param path The path to display in @p obj
20575     *
20576     * This will change the @b directory that @p obj is displaying. It
20577     * will also clear the text entry area on the @p obj object, which
20578     * displays select files' names.
20579     *
20580     * @see elm_fileselector_path_get()
20581     *
20582     * @ingroup Fileselector
20583     */
20584    EAPI void                  elm_fileselector_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
20585
20586    /**
20587     * Get the parent directory's path that a given file selector
20588     * widget is displaying
20589     *
20590     * @param obj The file selector object
20591     * @return The (full) path of the directory the file selector is
20592     * displaying, a @b stringshared string
20593     *
20594     * @see elm_fileselector_path_set()
20595     *
20596     * @ingroup Fileselector
20597     */
20598    EAPI const char           *elm_fileselector_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20599
20600    /**
20601     * Set, programmatically, the currently selected file/directory in
20602     * the given file selector widget
20603     *
20604     * @param obj The file selector object
20605     * @param path The (full) path to a file or directory
20606     * @return @c EINA_TRUE on success, @c EINA_FALSE on failure. The
20607     * latter case occurs if the directory or file pointed to do not
20608     * exist.
20609     *
20610     * @see elm_fileselector_selected_get()
20611     *
20612     * @ingroup Fileselector
20613     */
20614    EAPI Eina_Bool             elm_fileselector_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
20615
20616    /**
20617     * Get the currently selected item's (full) path, in the given file
20618     * selector widget
20619     *
20620     * @param obj The file selector object
20621     * @return The absolute path of the selected item, a @b
20622     * stringshared string
20623     *
20624     * @note Custom editions on @p obj object's text entry, if made,
20625     * will appear on the return string of this function, naturally.
20626     *
20627     * @see elm_fileselector_selected_set() for more details
20628     *
20629     * @ingroup Fileselector
20630     */
20631    EAPI const char           *elm_fileselector_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20632
20633    /**
20634     * Set the mode in which a given file selector widget will display
20635     * (layout) file system entries in its view
20636     *
20637     * @param obj The file selector object
20638     * @param mode The mode of the fileselector, being it one of
20639     * #ELM_FILESELECTOR_LIST (default) or #ELM_FILESELECTOR_GRID. The
20640     * first one, naturally, will display the files in a list. The
20641     * latter will make the widget to display its entries in a grid
20642     * form.
20643     *
20644     * @note By using elm_fileselector_expandable_set(), the user may
20645     * trigger a tree view for that list.
20646     *
20647     * @note If Elementary is built with support of the Ethumb
20648     * thumbnailing library, the second form of view will display
20649     * preview thumbnails of files which it supports. You must have
20650     * elm_need_ethumb() called in your Elementary for thumbnailing to
20651     * work, though.
20652     *
20653     * @see elm_fileselector_expandable_set().
20654     * @see elm_fileselector_mode_get().
20655     *
20656     * @ingroup Fileselector
20657     */
20658    EAPI void                  elm_fileselector_mode_set(Evas_Object *obj, Elm_Fileselector_Mode mode) EINA_ARG_NONNULL(1);
20659
20660    /**
20661     * Get the mode in which a given file selector widget is displaying
20662     * (layouting) file system entries in its view
20663     *
20664     * @param obj The fileselector object
20665     * @return The mode in which the fileselector is at
20666     *
20667     * @see elm_fileselector_mode_set() for more details
20668     *
20669     * @ingroup Fileselector
20670     */
20671    EAPI Elm_Fileselector_Mode elm_fileselector_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20672
20673    /**
20674     * @}
20675     */
20676
20677    /**
20678     * @defgroup Progressbar Progress bar
20679     *
20680     * The progress bar is a widget for visually representing the
20681     * progress status of a given job/task.
20682     *
20683     * A progress bar may be horizontal or vertical. It may display an
20684     * icon besides it, as well as primary and @b units labels. The
20685     * former is meant to label the widget as a whole, while the
20686     * latter, which is formatted with floating point values (and thus
20687     * accepts a <c>printf</c>-style format string, like <c>"%1.2f
20688     * units"</c>), is meant to label the widget's <b>progress
20689     * value</b>. Label, icon and unit strings/objects are @b optional
20690     * for progress bars.
20691     *
20692     * A progress bar may be @b inverted, in which state it gets its
20693     * values inverted, with high values being on the left or top and
20694     * low values on the right or bottom, as opposed to normally have
20695     * the low values on the former and high values on the latter,
20696     * respectively, for horizontal and vertical modes.
20697     *
20698     * The @b span of the progress, as set by
20699     * elm_progressbar_span_size_set(), is its length (horizontally or
20700     * vertically), unless one puts size hints on the widget to expand
20701     * on desired directions, by any container. That length will be
20702     * scaled by the object or applications scaling factor. At any
20703     * point code can query the progress bar for its value with
20704     * elm_progressbar_value_get().
20705     *
20706     * Available widget styles for progress bars:
20707     * - @c "default"
20708     * - @c "wheel" (simple style, no text, no progression, only
20709     *      "pulse" effect is available)
20710     *
20711     * Default contents parts of the progressbar widget that you can use for are:
20712     * @li "elm.swallow.content" - A icon of the progressbar
20713     * 
20714     * Here is an example on its usage:
20715     * @li @ref progressbar_example
20716     */
20717
20718    /**
20719     * Add a new progress bar widget to the given parent Elementary
20720     * (container) object
20721     *
20722     * @param parent The parent object
20723     * @return a new progress bar widget handle or @c NULL, on errors
20724     *
20725     * This function inserts a new progress bar widget on the canvas.
20726     *
20727     * @ingroup Progressbar
20728     */
20729    EAPI Evas_Object *elm_progressbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20730
20731    /**
20732     * Set whether a given progress bar widget is at "pulsing mode" or
20733     * not.
20734     *
20735     * @param obj The progress bar object
20736     * @param pulse @c EINA_TRUE to put @p obj in pulsing mode,
20737     * @c EINA_FALSE to put it back to its default one
20738     *
20739     * By default, progress bars will display values from the low to
20740     * high value boundaries. There are, though, contexts in which the
20741     * state of progression of a given task is @b unknown.  For those,
20742     * one can set a progress bar widget to a "pulsing state", to give
20743     * the user an idea that some computation is being held, but
20744     * without exact progress values. In the default theme it will
20745     * animate its bar with the contents filling in constantly and back
20746     * to non-filled, in a loop. To start and stop this pulsing
20747     * animation, one has to explicitly call elm_progressbar_pulse().
20748     *
20749     * @see elm_progressbar_pulse_get()
20750     * @see elm_progressbar_pulse()
20751     *
20752     * @ingroup Progressbar
20753     */
20754    EAPI void         elm_progressbar_pulse_set(Evas_Object *obj, Eina_Bool pulse) EINA_ARG_NONNULL(1);
20755
20756    /**
20757     * Get whether a given progress bar widget is at "pulsing mode" or
20758     * not.
20759     *
20760     * @param obj The progress bar object
20761     * @return @c EINA_TRUE, if @p obj is in pulsing mode, @c EINA_FALSE
20762     * if it's in the default one (and on errors)
20763     *
20764     * @ingroup Progressbar
20765     */
20766    EAPI Eina_Bool    elm_progressbar_pulse_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20767
20768    /**
20769     * Start/stop a given progress bar "pulsing" animation, if its
20770     * under that mode
20771     *
20772     * @param obj The progress bar object
20773     * @param state @c EINA_TRUE, to @b start the pulsing animation,
20774     * @c EINA_FALSE to @b stop it
20775     *
20776     * @note This call won't do anything if @p obj is not under "pulsing mode".
20777     *
20778     * @see elm_progressbar_pulse_set() for more details.
20779     *
20780     * @ingroup Progressbar
20781     */
20782    EAPI void         elm_progressbar_pulse(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
20783
20784    /**
20785     * Set the progress value (in percentage) on a given progress bar
20786     * widget
20787     *
20788     * @param obj The progress bar object
20789     * @param val The progress value (@b must be between @c 0.0 and @c
20790     * 1.0)
20791     *
20792     * Use this call to set progress bar levels.
20793     *
20794     * @note If you passes a value out of the specified range for @p
20795     * val, it will be interpreted as the @b closest of the @b boundary
20796     * values in the range.
20797     *
20798     * @ingroup Progressbar
20799     */
20800    EAPI void         elm_progressbar_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
20801
20802    /**
20803     * Get the progress value (in percentage) on a given progress bar
20804     * widget
20805     *
20806     * @param obj The progress bar object
20807     * @return The value of the progressbar
20808     *
20809     * @see elm_progressbar_value_set() for more details
20810     *
20811     * @ingroup Progressbar
20812     */
20813    EAPI double       elm_progressbar_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20814
20815    /**
20816     * Set the label of a given progress bar widget
20817     *
20818     * @param obj The progress bar object
20819     * @param label The text label string, in UTF-8
20820     *
20821     * @ingroup Progressbar
20822     * @deprecated use elm_object_text_set() instead.
20823     */
20824    EINA_DEPRECATED EAPI void         elm_progressbar_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
20825
20826    /**
20827     * Get the label of a given progress bar widget
20828     *
20829     * @param obj The progressbar object
20830     * @return The text label string, in UTF-8
20831     *
20832     * @ingroup Progressbar
20833     * @deprecated use elm_object_text_set() instead.
20834     */
20835    EINA_DEPRECATED EAPI const char  *elm_progressbar_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20836
20837    /**
20838     * Set the icon object of a given progress bar widget
20839     *
20840     * @param obj The progress bar object
20841     * @param icon The icon object
20842     *
20843     * Use this call to decorate @p obj with an icon next to it.
20844     *
20845     * @note Once the icon object is set, a previously set one will be
20846     * deleted. If you want to keep that old content object, use the
20847     * elm_progressbar_icon_unset() function.
20848     *
20849     * @see elm_progressbar_icon_get()
20850     * @deprecated use elm_object_content_set() instead.
20851     *
20852     * @ingroup Progressbar
20853     */
20854    EINA_DEPRECATED EAPI void         elm_progressbar_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
20855
20856    /**
20857     * Retrieve the icon object set for a given progress bar widget
20858     *
20859     * @param obj The progress bar object
20860     * @return The icon object's handle, if @p obj had one set, or @c NULL,
20861     * otherwise (and on errors)
20862     *
20863     * @see elm_progressbar_icon_set() for more details
20864     * @deprecated use elm_object_content_set() instead.
20865     *
20866     * @ingroup Progressbar
20867     */
20868    EINA_DEPRECATED EAPI Evas_Object *elm_progressbar_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20869
20870    /**
20871     * Unset an icon set on a given progress bar widget
20872     *
20873     * @param obj The progress bar object
20874     * @return The icon object that was being used, if any was set, or
20875     * @c NULL, otherwise (and on errors)
20876     *
20877     * This call will unparent and return the icon object which was set
20878     * for this widget, previously, on success.
20879     *
20880     * @see elm_progressbar_icon_set() for more details
20881     * @deprecated use elm_object_content_unset() instead.
20882     *
20883     * @ingroup Progressbar
20884     */
20885    EINA_DEPRECATED EAPI Evas_Object *elm_progressbar_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20886
20887    /**
20888     * Set the (exact) length of the bar region of a given progress bar
20889     * widget
20890     *
20891     * @param obj The progress bar object
20892     * @param size The length of the progress bar's bar region
20893     *
20894     * This sets the minimum width (when in horizontal mode) or height
20895     * (when in vertical mode) of the actual bar area of the progress
20896     * bar @p obj. This in turn affects the object's minimum size. Use
20897     * this when you're not setting other size hints expanding on the
20898     * given direction (like weight and alignment hints) and you would
20899     * like it to have a specific size.
20900     *
20901     * @note Icon, label and unit text around @p obj will require their
20902     * own space, which will make @p obj to require more the @p size,
20903     * actually.
20904     *
20905     * @see elm_progressbar_span_size_get()
20906     *
20907     * @ingroup Progressbar
20908     */
20909    EAPI void         elm_progressbar_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
20910
20911    /**
20912     * Get the length set for the bar region of a given progress bar
20913     * widget
20914     *
20915     * @param obj The progress bar object
20916     * @return The length of the progress bar's bar region
20917     *
20918     * If that size was not set previously, with
20919     * elm_progressbar_span_size_set(), this call will return @c 0.
20920     *
20921     * @ingroup Progressbar
20922     */
20923    EAPI Evas_Coord   elm_progressbar_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20924
20925    /**
20926     * Set the format string for a given progress bar widget's units
20927     * label
20928     *
20929     * @param obj The progress bar object
20930     * @param format The format string for @p obj's units label
20931     *
20932     * If @c NULL is passed on @p format, it will make @p obj's units
20933     * area to be hidden completely. If not, it'll set the <b>format
20934     * string</b> for the units label's @b text. The units label is
20935     * provided a floating point value, so the units text is up display
20936     * at most one floating point falue. Note that the units label is
20937     * optional. Use a format string such as "%1.2f meters" for
20938     * example.
20939     *
20940     * @note The default format string for a progress bar is an integer
20941     * percentage, as in @c "%.0f %%".
20942     *
20943     * @see elm_progressbar_unit_format_get()
20944     *
20945     * @ingroup Progressbar
20946     */
20947    EAPI void         elm_progressbar_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
20948
20949    /**
20950     * Retrieve the format string set for a given progress bar widget's
20951     * units label
20952     *
20953     * @param obj The progress bar object
20954     * @return The format set string for @p obj's units label or
20955     * @c NULL, if none was set (and on errors)
20956     *
20957     * @see elm_progressbar_unit_format_set() for more details
20958     *
20959     * @ingroup Progressbar
20960     */
20961    EAPI const char  *elm_progressbar_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20962
20963    /**
20964     * Set the orientation of a given progress bar widget
20965     *
20966     * @param obj The progress bar object
20967     * @param horizontal Use @c EINA_TRUE to make @p obj to be
20968     * @b horizontal, @c EINA_FALSE to make it @b vertical
20969     *
20970     * Use this function to change how your progress bar is to be
20971     * disposed: vertically or horizontally.
20972     *
20973     * @see elm_progressbar_horizontal_get()
20974     *
20975     * @ingroup Progressbar
20976     */
20977    EAPI void         elm_progressbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
20978
20979    /**
20980     * Retrieve the orientation of a given progress bar widget
20981     *
20982     * @param obj The progress bar object
20983     * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
20984     * @c EINA_FALSE if it's @b vertical (and on errors)
20985     *
20986     * @see elm_progressbar_horizontal_set() for more details
20987     *
20988     * @ingroup Progressbar
20989     */
20990    EAPI Eina_Bool    elm_progressbar_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20991
20992    /**
20993     * Invert a given progress bar widget's displaying values order
20994     *
20995     * @param obj The progress bar object
20996     * @param inverted Use @c EINA_TRUE to make @p obj inverted,
20997     * @c EINA_FALSE to bring it back to default, non-inverted values.
20998     *
20999     * A progress bar may be @b inverted, in which state it gets its
21000     * values inverted, with high values being on the left or top and
21001     * low values on the right or bottom, as opposed to normally have
21002     * the low values on the former and high values on the latter,
21003     * respectively, for horizontal and vertical modes.
21004     *
21005     * @see elm_progressbar_inverted_get()
21006     *
21007     * @ingroup Progressbar
21008     */
21009    EAPI void         elm_progressbar_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
21010
21011    /**
21012     * Get whether a given progress bar widget's displaying values are
21013     * inverted or not
21014     *
21015     * @param obj The progress bar object
21016     * @return @c EINA_TRUE, if @p obj has inverted values,
21017     * @c EINA_FALSE otherwise (and on errors)
21018     *
21019     * @see elm_progressbar_inverted_set() for more details
21020     *
21021     * @ingroup Progressbar
21022     */
21023    EAPI Eina_Bool    elm_progressbar_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21024
21025    /**
21026     * @defgroup Separator Separator
21027     *
21028     * @brief Separator is a very thin object used to separate other objects.
21029     *
21030     * A separator can be vertical or horizontal.
21031     *
21032     * @ref tutorial_separator is a good example of how to use a separator.
21033     * @{
21034     */
21035    /**
21036     * @brief Add a separator object to @p parent
21037     *
21038     * @param parent The parent object
21039     *
21040     * @return The separator object, or NULL upon failure
21041     */
21042    EAPI Evas_Object *elm_separator_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21043    /**
21044     * @brief Set the horizontal mode of a separator object
21045     *
21046     * @param obj The separator object
21047     * @param horizontal If true, the separator is horizontal
21048     */
21049    EAPI void         elm_separator_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
21050    /**
21051     * @brief Get the horizontal mode of a separator object
21052     *
21053     * @param obj The separator object
21054     * @return If true, the separator is horizontal
21055     *
21056     * @see elm_separator_horizontal_set()
21057     */
21058    EAPI Eina_Bool    elm_separator_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21059    /**
21060     * @}
21061     */
21062
21063    /**
21064     * @defgroup Spinner Spinner
21065     * @ingroup Elementary
21066     *
21067     * @image html img/widget/spinner/preview-00.png
21068     * @image latex img/widget/spinner/preview-00.eps
21069     *
21070     * A spinner is a widget which allows the user to increase or decrease
21071     * numeric values using arrow buttons, or edit values directly, clicking
21072     * over it and typing the new value.
21073     *
21074     * By default the spinner will not wrap and has a label
21075     * of "%.0f" (just showing the integer value of the double).
21076     *
21077     * A spinner has a label that is formatted with floating
21078     * point values and thus accepts a printf-style format string, like
21079     * ā€œ%1.2f unitsā€.
21080     *
21081     * It also allows specific values to be replaced by pre-defined labels.
21082     *
21083     * Smart callbacks one can register to:
21084     *
21085     * - "changed" - Whenever the spinner value is changed.
21086     * - "delay,changed" - A short time after the value is changed by the user.
21087     *    This will be called only when the user stops dragging for a very short
21088     *    period or when they release their finger/mouse, so it avoids possibly
21089     *    expensive reactions to the value change.
21090     *
21091     * Available styles for it:
21092     * - @c "default";
21093     * - @c "vertical": up/down buttons at the right side and text left aligned.
21094     *
21095     * Here is an example on its usage:
21096     * @ref spinner_example
21097     */
21098
21099    /**
21100     * @addtogroup Spinner
21101     * @{
21102     */
21103
21104    /**
21105     * Add a new spinner widget to the given parent Elementary
21106     * (container) object.
21107     *
21108     * @param parent The parent object.
21109     * @return a new spinner widget handle or @c NULL, on errors.
21110     *
21111     * This function inserts a new spinner widget on the canvas.
21112     *
21113     * @ingroup Spinner
21114     *
21115     */
21116    EAPI Evas_Object *elm_spinner_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21117
21118    /**
21119     * Set the format string of the displayed label.
21120     *
21121     * @param obj The spinner object.
21122     * @param fmt The format string for the label display.
21123     *
21124     * If @c NULL, this sets the format to "%.0f". If not it sets the format
21125     * string for the label text. The label text is provided a floating point
21126     * value, so the label text can display up to 1 floating point value.
21127     * Note that this is optional.
21128     *
21129     * Use a format string such as "%1.2f meters" for example, and it will
21130     * display values like: "3.14 meters" for a value equal to 3.14159.
21131     *
21132     * Default is "%0.f".
21133     *
21134     * @see elm_spinner_label_format_get()
21135     *
21136     * @ingroup Spinner
21137     */
21138    EAPI void         elm_spinner_label_format_set(Evas_Object *obj, const char *fmt) EINA_ARG_NONNULL(1);
21139
21140    /**
21141     * Get the label format of the spinner.
21142     *
21143     * @param obj The spinner object.
21144     * @return The text label format string in UTF-8.
21145     *
21146     * @see elm_spinner_label_format_set() for details.
21147     *
21148     * @ingroup Spinner
21149     */
21150    EAPI const char  *elm_spinner_label_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21151
21152    /**
21153     * Set the minimum and maximum values for the spinner.
21154     *
21155     * @param obj The spinner object.
21156     * @param min The minimum value.
21157     * @param max The maximum value.
21158     *
21159     * Define the allowed range of values to be selected by the user.
21160     *
21161     * If actual value is less than @p min, it will be updated to @p min. If it
21162     * is bigger then @p max, will be updated to @p max. Actual value can be
21163     * get with elm_spinner_value_get().
21164     *
21165     * By default, min is equal to 0, and max is equal to 100.
21166     *
21167     * @warning Maximum must be greater than minimum.
21168     *
21169     * @see elm_spinner_min_max_get()
21170     *
21171     * @ingroup Spinner
21172     */
21173    EAPI void         elm_spinner_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
21174
21175    /**
21176     * Get the minimum and maximum values of the spinner.
21177     *
21178     * @param obj The spinner object.
21179     * @param min Pointer where to store the minimum value.
21180     * @param max Pointer where to store the maximum value.
21181     *
21182     * @note If only one value is needed, the other pointer can be passed
21183     * as @c NULL.
21184     *
21185     * @see elm_spinner_min_max_set() for details.
21186     *
21187     * @ingroup Spinner
21188     */
21189    EAPI void         elm_spinner_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
21190
21191    /**
21192     * Set the step used to increment or decrement the spinner value.
21193     *
21194     * @param obj The spinner object.
21195     * @param step The step value.
21196     *
21197     * This value will be incremented or decremented to the displayed value.
21198     * It will be incremented while the user keep right or top arrow pressed,
21199     * and will be decremented while the user keep left or bottom arrow pressed.
21200     *
21201     * The interval to increment / decrement can be set with
21202     * elm_spinner_interval_set().
21203     *
21204     * By default step value is equal to 1.
21205     *
21206     * @see elm_spinner_step_get()
21207     *
21208     * @ingroup Spinner
21209     */
21210    EAPI void         elm_spinner_step_set(Evas_Object *obj, double step) EINA_ARG_NONNULL(1);
21211
21212    /**
21213     * Get the step used to increment or decrement the spinner value.
21214     *
21215     * @param obj The spinner object.
21216     * @return The step value.
21217     *
21218     * @see elm_spinner_step_get() for more details.
21219     *
21220     * @ingroup Spinner
21221     */
21222    EAPI double       elm_spinner_step_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21223
21224    /**
21225     * Set the value the spinner displays.
21226     *
21227     * @param obj The spinner object.
21228     * @param val The value to be displayed.
21229     *
21230     * Value will be presented on the label following format specified with
21231     * elm_spinner_format_set().
21232     *
21233     * @warning The value must to be between min and max values. This values
21234     * are set by elm_spinner_min_max_set().
21235     *
21236     * @see elm_spinner_value_get().
21237     * @see elm_spinner_format_set().
21238     * @see elm_spinner_min_max_set().
21239     *
21240     * @ingroup Spinner
21241     */
21242    EAPI void         elm_spinner_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
21243
21244    /**
21245     * Get the value displayed by the spinner.
21246     *
21247     * @param obj The spinner object.
21248     * @return The value displayed.
21249     *
21250     * @see elm_spinner_value_set() for details.
21251     *
21252     * @ingroup Spinner
21253     */
21254    EAPI double       elm_spinner_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21255
21256    /**
21257     * Set whether the spinner should wrap when it reaches its
21258     * minimum or maximum value.
21259     *
21260     * @param obj The spinner object.
21261     * @param wrap @c EINA_TRUE to enable wrap or @c EINA_FALSE to
21262     * disable it.
21263     *
21264     * Disabled by default. If disabled, when the user tries to increment the
21265     * value,
21266     * but displayed value plus step value is bigger than maximum value,
21267     * the spinner
21268     * won't allow it. The same happens when the user tries to decrement it,
21269     * but the value less step is less than minimum value.
21270     *
21271     * When wrap is enabled, in such situations it will allow these changes,
21272     * but will get the value that would be less than minimum and subtracts
21273     * from maximum. Or add the value that would be more than maximum to
21274     * the minimum.
21275     *
21276     * E.g.:
21277     * @li min value = 10
21278     * @li max value = 50
21279     * @li step value = 20
21280     * @li displayed value = 20
21281     *
21282     * When the user decrement value (using left or bottom arrow), it will
21283     * displays @c 40, because max - (min - (displayed - step)) is
21284     * @c 50 - (@c 10 - (@c 20 - @c 20)) = @c 40.
21285     *
21286     * @see elm_spinner_wrap_get().
21287     *
21288     * @ingroup Spinner
21289     */
21290    EAPI void         elm_spinner_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
21291
21292    /**
21293     * Get whether the spinner should wrap when it reaches its
21294     * minimum or maximum value.
21295     *
21296     * @param obj The spinner object
21297     * @return @c EINA_TRUE means wrap is enabled. @c EINA_FALSE indicates
21298     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
21299     *
21300     * @see elm_spinner_wrap_set() for details.
21301     *
21302     * @ingroup Spinner
21303     */
21304    EAPI Eina_Bool    elm_spinner_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21305
21306    /**
21307     * Set whether the spinner can be directly edited by the user or not.
21308     *
21309     * @param obj The spinner object.
21310     * @param editable @c EINA_TRUE to allow users to edit it or @c EINA_FALSE to
21311     * don't allow users to edit it directly.
21312     *
21313     * Spinner objects can have edition @b disabled, in which state they will
21314     * be changed only by arrows.
21315     * Useful for contexts
21316     * where you don't want your users to interact with it writting the value.
21317     * Specially
21318     * when using special values, the user can see real value instead
21319     * of special label on edition.
21320     *
21321     * It's enabled by default.
21322     *
21323     * @see elm_spinner_editable_get()
21324     *
21325     * @ingroup Spinner
21326     */
21327    EAPI void         elm_spinner_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
21328
21329    /**
21330     * Get whether the spinner can be directly edited by the user or not.
21331     *
21332     * @param obj The spinner object.
21333     * @return @c EINA_TRUE means edition is enabled. @c EINA_FALSE indicates
21334     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
21335     *
21336     * @see elm_spinner_editable_set() for details.
21337     *
21338     * @ingroup Spinner
21339     */
21340    EAPI Eina_Bool    elm_spinner_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21341
21342    /**
21343     * Set a special string to display in the place of the numerical value.
21344     *
21345     * @param obj The spinner object.
21346     * @param value The value to be replaced.
21347     * @param label The label to be used.
21348     *
21349     * It's useful for cases when a user should select an item that is
21350     * better indicated by a label than a value. For example, weekdays or months.
21351     *
21352     * E.g.:
21353     * @code
21354     * sp = elm_spinner_add(win);
21355     * elm_spinner_min_max_set(sp, 1, 3);
21356     * elm_spinner_special_value_add(sp, 1, "January");
21357     * elm_spinner_special_value_add(sp, 2, "February");
21358     * elm_spinner_special_value_add(sp, 3, "March");
21359     * evas_object_show(sp);
21360     * @endcode
21361     *
21362     * @ingroup Spinner
21363     */
21364    EAPI void         elm_spinner_special_value_add(Evas_Object *obj, double value, const char *label) EINA_ARG_NONNULL(1);
21365
21366    /**
21367     * Set the interval on time updates for an user mouse button hold
21368     * on spinner widgets' arrows.
21369     *
21370     * @param obj The spinner object.
21371     * @param interval The (first) interval value in seconds.
21372     *
21373     * This interval value is @b decreased while the user holds the
21374     * mouse pointer either incrementing or decrementing spinner's value.
21375     *
21376     * This helps the user to get to a given value distant from the
21377     * current one easier/faster, as it will start to change quicker and
21378     * quicker on mouse button holds.
21379     *
21380     * The calculation for the next change interval value, starting from
21381     * the one set with this call, is the previous interval divided by
21382     * @c 1.05, so it decreases a little bit.
21383     *
21384     * The default starting interval value for automatic changes is
21385     * @c 0.85 seconds.
21386     *
21387     * @see elm_spinner_interval_get()
21388     *
21389     * @ingroup Spinner
21390     */
21391    EAPI void         elm_spinner_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
21392
21393    /**
21394     * Get the interval on time updates for an user mouse button hold
21395     * on spinner widgets' arrows.
21396     *
21397     * @param obj The spinner object.
21398     * @return The (first) interval value, in seconds, set on it.
21399     *
21400     * @see elm_spinner_interval_set() for more details.
21401     *
21402     * @ingroup Spinner
21403     */
21404    EAPI double       elm_spinner_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21405
21406    /**
21407     * @}
21408     */
21409
21410    /**
21411     * @defgroup Index Index
21412     *
21413     * @image html img/widget/index/preview-00.png
21414     * @image latex img/widget/index/preview-00.eps
21415     *
21416     * An index widget gives you an index for fast access to whichever
21417     * group of other UI items one might have. It's a list of text
21418     * items (usually letters, for alphabetically ordered access).
21419     *
21420     * Index widgets are by default hidden and just appear when the
21421     * user clicks over it's reserved area in the canvas. In its
21422     * default theme, it's an area one @ref Fingers "finger" wide on
21423     * the right side of the index widget's container.
21424     *
21425     * When items on the index are selected, smart callbacks get
21426     * called, so that its user can make other container objects to
21427     * show a given area or child object depending on the index item
21428     * selected. You'd probably be using an index together with @ref
21429     * List "lists", @ref Genlist "generic lists" or @ref Gengrid
21430     * "general grids".
21431     *
21432     * Smart events one  can add callbacks for are:
21433     * - @c "changed" - When the selected index item changes. @c
21434     *      event_info is the selected item's data pointer.
21435     * - @c "delay,changed" - When the selected index item changes, but
21436     *      after a small idling period. @c event_info is the selected
21437     *      item's data pointer.
21438     * - @c "selected" - When the user releases a mouse button and
21439     *      selects an item. @c event_info is the selected item's data
21440     *      pointer.
21441     * - @c "level,up" - when the user moves a finger from the first
21442     *      level to the second level
21443     * - @c "level,down" - when the user moves a finger from the second
21444     *      level to the first level
21445     *
21446     * The @c "delay,changed" event is so that it'll wait a small time
21447     * before actually reporting those events and, moreover, just the
21448     * last event happening on those time frames will actually be
21449     * reported.
21450     *
21451     * Here are some examples on its usage:
21452     * @li @ref index_example_01
21453     * @li @ref index_example_02
21454     */
21455
21456    /**
21457     * @addtogroup Index
21458     * @{
21459     */
21460
21461    typedef struct _Elm_Index_Item Elm_Index_Item; /**< Opaque handle for items of Elementary index widgets */
21462
21463    /**
21464     * Add a new index widget to the given parent Elementary
21465     * (container) object
21466     *
21467     * @param parent The parent object
21468     * @return a new index widget handle or @c NULL, on errors
21469     *
21470     * This function inserts a new index widget on the canvas.
21471     *
21472     * @ingroup Index
21473     */
21474    EAPI Evas_Object    *elm_index_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21475
21476    /**
21477     * Set whether a given index widget is or not visible,
21478     * programatically.
21479     *
21480     * @param obj The index object
21481     * @param active @c EINA_TRUE to show it, @c EINA_FALSE to hide it
21482     *
21483     * Not to be confused with visible as in @c evas_object_show() --
21484     * visible with regard to the widget's auto hiding feature.
21485     *
21486     * @see elm_index_active_get()
21487     *
21488     * @ingroup Index
21489     */
21490    EAPI void            elm_index_active_set(Evas_Object *obj, Eina_Bool active) EINA_ARG_NONNULL(1);
21491
21492    /**
21493     * Get whether a given index widget is currently visible or not.
21494     *
21495     * @param obj The index object
21496     * @return @c EINA_TRUE, if it's shown, @c EINA_FALSE otherwise
21497     *
21498     * @see elm_index_active_set() for more details
21499     *
21500     * @ingroup Index
21501     */
21502    EAPI Eina_Bool       elm_index_active_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21503
21504    /**
21505     * Set the items level for a given index widget.
21506     *
21507     * @param obj The index object.
21508     * @param level @c 0 or @c 1, the currently implemented levels.
21509     *
21510     * @see elm_index_item_level_get()
21511     *
21512     * @ingroup Index
21513     */
21514    EAPI void            elm_index_item_level_set(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
21515
21516    /**
21517     * Get the items level set for a given index widget.
21518     *
21519     * @param obj The index object.
21520     * @return @c 0 or @c 1, which are the levels @p obj might be at.
21521     *
21522     * @see elm_index_item_level_set() for more information
21523     *
21524     * @ingroup Index
21525     */
21526    EAPI int             elm_index_item_level_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21527
21528    /**
21529     * Returns the last selected item's data, for a given index widget.
21530     *
21531     * @param obj The index object.
21532     * @return The item @b data associated to the last selected item on
21533     * @p obj (or @c NULL, on errors).
21534     *
21535     * @warning The returned value is @b not an #Elm_Index_Item item
21536     * handle, but the data associated to it (see the @c item parameter
21537     * in elm_index_item_append(), as an example).
21538     *
21539     * @ingroup Index
21540     */
21541    EAPI void           *elm_index_item_selected_get(const Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
21542
21543    /**
21544     * Append a new item on a given index widget.
21545     *
21546     * @param obj The index object.
21547     * @param letter Letter under which the item should be indexed
21548     * @param item The item data to set for the index's item
21549     *
21550     * Despite the most common usage of the @p letter argument is for
21551     * single char strings, one could use arbitrary strings as index
21552     * entries.
21553     *
21554     * @c item will be the pointer returned back on @c "changed", @c
21555     * "delay,changed" and @c "selected" smart events.
21556     *
21557     * @ingroup Index
21558     */
21559    EAPI void            elm_index_item_append(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
21560
21561    /**
21562     * Prepend a new item on a given index widget.
21563     *
21564     * @param obj The index object.
21565     * @param letter Letter under which the item should be indexed
21566     * @param item The item data to set for the index's item
21567     *
21568     * Despite the most common usage of the @p letter argument is for
21569     * single char strings, one could use arbitrary strings as index
21570     * entries.
21571     *
21572     * @c item will be the pointer returned back on @c "changed", @c
21573     * "delay,changed" and @c "selected" smart events.
21574     *
21575     * @ingroup Index
21576     */
21577    EAPI void            elm_index_item_prepend(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
21578
21579    /**
21580     * Append a new item, on a given index widget, <b>after the item
21581     * having @p relative as data</b>.
21582     *
21583     * @param obj The index object.
21584     * @param letter Letter under which the item should be indexed
21585     * @param item The item data to set for the index's item
21586     * @param relative The item data of the index item to be the
21587     * predecessor of this new one
21588     *
21589     * Despite the most common usage of the @p letter argument is for
21590     * single char strings, one could use arbitrary strings as index
21591     * entries.
21592     *
21593     * @c item will be the pointer returned back on @c "changed", @c
21594     * "delay,changed" and @c "selected" smart events.
21595     *
21596     * @note If @p relative is @c NULL or if it's not found to be data
21597     * set on any previous item on @p obj, this function will behave as
21598     * elm_index_item_append().
21599     *
21600     * @ingroup Index
21601     */
21602    EAPI void            elm_index_item_append_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
21603
21604    /**
21605     * Prepend a new item, on a given index widget, <b>after the item
21606     * having @p relative as data</b>.
21607     *
21608     * @param obj The index object.
21609     * @param letter Letter under which the item should be indexed
21610     * @param item The item data to set for the index's item
21611     * @param relative The item data of the index item to be the
21612     * successor of this new one
21613     *
21614     * Despite the most common usage of the @p letter argument is for
21615     * single char strings, one could use arbitrary strings as index
21616     * entries.
21617     *
21618     * @c item will be the pointer returned back on @c "changed", @c
21619     * "delay,changed" and @c "selected" smart events.
21620     *
21621     * @note If @p relative is @c NULL or if it's not found to be data
21622     * set on any previous item on @p obj, this function will behave as
21623     * elm_index_item_prepend().
21624     *
21625     * @ingroup Index
21626     */
21627    EAPI void            elm_index_item_prepend_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
21628
21629    /**
21630     * Insert a new item into the given index widget, using @p cmp_func
21631     * function to sort items (by item handles).
21632     *
21633     * @param obj The index object.
21634     * @param letter Letter under which the item should be indexed
21635     * @param item The item data to set for the index's item
21636     * @param cmp_func The comparing function to be used to sort index
21637     * items <b>by #Elm_Index_Item item handles</b>
21638     * @param cmp_data_func A @b fallback function to be called for the
21639     * sorting of index items <b>by item data</b>). It will be used
21640     * when @p cmp_func returns @c 0 (equality), which means an index
21641     * item with provided item data already exists. To decide which
21642     * data item should be pointed to by the index item in question, @p
21643     * cmp_data_func will be used. If @p cmp_data_func returns a
21644     * non-negative value, the previous index item data will be
21645     * replaced by the given @p item pointer. If the previous data need
21646     * to be freed, it should be done by the @p cmp_data_func function,
21647     * because all references to it will be lost. If this function is
21648     * not provided (@c NULL is given), index items will be @b
21649     * duplicated, if @p cmp_func returns @c 0.
21650     *
21651     * Despite the most common usage of the @p letter argument is for
21652     * single char strings, one could use arbitrary strings as index
21653     * entries.
21654     *
21655     * @c item will be the pointer returned back on @c "changed", @c
21656     * "delay,changed" and @c "selected" smart events.
21657     *
21658     * @ingroup Index
21659     */
21660    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);
21661
21662    /**
21663     * Remove an item from a given index widget, <b>to be referenced by
21664     * it's data value</b>.
21665     *
21666     * @param obj The index object
21667     * @param item The item's data pointer for the item to be removed
21668     * from @p obj
21669     *
21670     * If a deletion callback is set, via elm_index_item_del_cb_set(),
21671     * that callback function will be called by this one.
21672     *
21673     * @warning The item to be removed from @p obj will be found via
21674     * its item data pointer, and not by an #Elm_Index_Item handle.
21675     *
21676     * @ingroup Index
21677     */
21678    EAPI void            elm_index_item_del(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
21679
21680    /**
21681     * Find a given index widget's item, <b>using item data</b>.
21682     *
21683     * @param obj The index object
21684     * @param item The item data pointed to by the desired index item
21685     * @return The index item handle, if found, or @c NULL otherwise
21686     *
21687     * @ingroup Index
21688     */
21689    EAPI Elm_Index_Item *elm_index_item_find(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
21690
21691    /**
21692     * Removes @b all items from a given index widget.
21693     *
21694     * @param obj The index object.
21695     *
21696     * If deletion callbacks are set, via elm_index_item_del_cb_set(),
21697     * that callback function will be called for each item in @p obj.
21698     *
21699     * @ingroup Index
21700     */
21701    EAPI void            elm_index_item_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
21702
21703    /**
21704     * Go to a given items level on a index widget
21705     *
21706     * @param obj The index object
21707     * @param level The index level (one of @c 0 or @c 1)
21708     *
21709     * @ingroup Index
21710     */
21711    EAPI void            elm_index_item_go(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
21712
21713    /**
21714     * Return the data associated with a given index widget item
21715     *
21716     * @param it The index widget item handle
21717     * @return The data associated with @p it
21718     *
21719     * @see elm_index_item_data_set()
21720     *
21721     * @ingroup Index
21722     */
21723    EAPI void           *elm_index_item_data_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
21724
21725    /**
21726     * Set the data associated with a given index widget item
21727     *
21728     * @param it The index widget item handle
21729     * @param data The new data pointer to set to @p it
21730     *
21731     * This sets new item data on @p it.
21732     *
21733     * @warning The old data pointer won't be touched by this function, so
21734     * the user had better to free that old data himself/herself.
21735     *
21736     * @ingroup Index
21737     */
21738    EAPI void            elm_index_item_data_set(Elm_Index_Item *it, const void *data) EINA_ARG_NONNULL(1);
21739
21740    /**
21741     * Set the function to be called when a given index widget item is freed.
21742     *
21743     * @param it The item to set the callback on
21744     * @param func The function to call on the item's deletion
21745     *
21746     * When called, @p func will have both @c data and @c event_info
21747     * arguments with the @p it item's data value and, naturally, the
21748     * @c obj argument with a handle to the parent index widget.
21749     *
21750     * @ingroup Index
21751     */
21752    EAPI void            elm_index_item_del_cb_set(Elm_Index_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
21753
21754    /**
21755     * Get the letter (string) set on a given index widget item.
21756     *
21757     * @param it The index item handle
21758     * @return The letter string set on @p it
21759     *
21760     * @ingroup Index
21761     */
21762    EAPI const char     *elm_index_item_letter_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
21763
21764    /**
21765     */
21766    EAPI void            elm_index_button_image_invisible_set(Evas_Object *obj, Eina_Bool invisible) EINA_ARG_NONNULL(1);
21767
21768    /**
21769     * @}
21770     */
21771
21772    /**
21773     * @defgroup Photocam Photocam
21774     *
21775     * @image html img/widget/photocam/preview-00.png
21776     * @image latex img/widget/photocam/preview-00.eps
21777     *
21778     * This is a widget specifically for displaying high-resolution digital
21779     * camera photos giving speedy feedback (fast load), low memory footprint
21780     * and zooming and panning as well as fitting logic. It is entirely focused
21781     * on jpeg images, and takes advantage of properties of the jpeg format (via
21782     * evas loader features in the jpeg loader).
21783     *
21784     * Signals that you can add callbacks for are:
21785     * @li "clicked" - This is called when a user has clicked the photo without
21786     *                 dragging around.
21787     * @li "press" - This is called when a user has pressed down on the photo.
21788     * @li "longpressed" - This is called when a user has pressed down on the
21789     *                     photo for a long time without dragging around.
21790     * @li "clicked,double" - This is called when a user has double-clicked the
21791     *                        photo.
21792     * @li "load" - Photo load begins.
21793     * @li "loaded" - This is called when the image file load is complete for the
21794     *                first view (low resolution blurry version).
21795     * @li "load,detail" - Photo detailed data load begins.
21796     * @li "loaded,detail" - This is called when the image file load is complete
21797     *                      for the detailed image data (full resolution needed).
21798     * @li "zoom,start" - Zoom animation started.
21799     * @li "zoom,stop" - Zoom animation stopped.
21800     * @li "zoom,change" - Zoom changed when using an auto zoom mode.
21801     * @li "scroll" - the content has been scrolled (moved)
21802     * @li "scroll,anim,start" - scrolling animation has started
21803     * @li "scroll,anim,stop" - scrolling animation has stopped
21804     * @li "scroll,drag,start" - dragging the contents around has started
21805     * @li "scroll,drag,stop" - dragging the contents around has stopped
21806     *
21807     * @ref tutorial_photocam shows the API in action.
21808     * @{
21809     */
21810    /**
21811     * @brief Types of zoom available.
21812     */
21813    typedef enum _Elm_Photocam_Zoom_Mode
21814      {
21815         ELM_PHOTOCAM_ZOOM_MODE_MANUAL = 0, /**< Zoom controled normally by elm_photocam_zoom_set */
21816         ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT, /**< Zoom until photo fits in photocam */
21817         ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL, /**< Zoom until photo fills photocam */
21818         ELM_PHOTOCAM_ZOOM_MODE_LAST
21819      } Elm_Photocam_Zoom_Mode;
21820    /**
21821     * @brief Add a new Photocam object
21822     *
21823     * @param parent The parent object
21824     * @return The new object or NULL if it cannot be created
21825     */
21826    EAPI Evas_Object           *elm_photocam_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21827    /**
21828     * @brief Set the photo file to be shown
21829     *
21830     * @param obj The photocam object
21831     * @param file The photo file
21832     * @return The return error (see EVAS_LOAD_ERROR_NONE, EVAS_LOAD_ERROR_GENERIC etc.)
21833     *
21834     * This sets (and shows) the specified file (with a relative or absolute
21835     * path) and will return a load error (same error that
21836     * evas_object_image_load_error_get() will return). The image will change and
21837     * adjust its size at this point and begin a background load process for this
21838     * photo that at some time in the future will be displayed at the full
21839     * quality needed.
21840     */
21841    EAPI Evas_Load_Error        elm_photocam_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
21842    /**
21843     * @brief Returns the path of the current image file
21844     *
21845     * @param obj The photocam object
21846     * @return Returns the path
21847     *
21848     * @see elm_photocam_file_set()
21849     */
21850    EAPI const char            *elm_photocam_file_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21851    /**
21852     * @brief Set the zoom level of the photo
21853     *
21854     * @param obj The photocam object
21855     * @param zoom The zoom level to set
21856     *
21857     * This sets the zoom level. 1 will be 1:1 pixel for pixel. 2 will be 2:1
21858     * (that is 2x2 photo pixels will display as 1 on-screen pixel). 4:1 will be
21859     * 4x4 photo pixels as 1 screen pixel, and so on. The @p zoom parameter must
21860     * be greater than 0. It is usggested to stick to powers of 2. (1, 2, 4, 8,
21861     * 16, 32, etc.).
21862     */
21863    EAPI void                   elm_photocam_zoom_set(Evas_Object *obj, double zoom) EINA_ARG_NONNULL(1);
21864    /**
21865     * @brief Get the zoom level of the photo
21866     *
21867     * @param obj The photocam object
21868     * @return The current zoom level
21869     *
21870     * This returns the current zoom level of the photocam object. Note that if
21871     * you set the fill mode to other than ELM_PHOTOCAM_ZOOM_MODE_MANUAL
21872     * (which is the default), the zoom level may be changed at any time by the
21873     * photocam object itself to account for photo size and photocam viewpoer
21874     * size.
21875     *
21876     * @see elm_photocam_zoom_set()
21877     * @see elm_photocam_zoom_mode_set()
21878     */
21879    EAPI double                 elm_photocam_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21880    /**
21881     * @brief Set the zoom mode
21882     *
21883     * @param obj The photocam object
21884     * @param mode The desired mode
21885     *
21886     * This sets the zoom mode to manual or one of several automatic levels.
21887     * Manual (ELM_PHOTOCAM_ZOOM_MODE_MANUAL) means that zoom is set manually by
21888     * elm_photocam_zoom_set() and will stay at that level until changed by code
21889     * or until zoom mode is changed. This is the default mode. The Automatic
21890     * modes will allow the photocam object to automatically adjust zoom mode
21891     * based on properties. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT) will adjust zoom so
21892     * the photo fits EXACTLY inside the scroll frame with no pixels outside this
21893     * area. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL will be similar but ensure no
21894     * pixels within the frame are left unfilled.
21895     */
21896    EAPI void                   elm_photocam_zoom_mode_set(Evas_Object *obj, Elm_Photocam_Zoom_Mode mode) EINA_ARG_NONNULL(1);
21897    /**
21898     * @brief Get the zoom mode
21899     *
21900     * @param obj The photocam object
21901     * @return The current zoom mode
21902     *
21903     * This gets the current zoom mode of the photocam object.
21904     *
21905     * @see elm_photocam_zoom_mode_set()
21906     */
21907    EAPI Elm_Photocam_Zoom_Mode elm_photocam_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21908    /**
21909     * @brief Get the current image pixel width and height
21910     *
21911     * @param obj The photocam object
21912     * @param w A pointer to the width return
21913     * @param h A pointer to the height return
21914     *
21915     * This gets the current photo pixel width and height (for the original).
21916     * The size will be returned in the integers @p w and @p h that are pointed
21917     * to.
21918     */
21919    EAPI void                   elm_photocam_image_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
21920    /**
21921     * @brief Get the area of the image that is currently shown
21922     *
21923     * @param obj
21924     * @param x A pointer to the X-coordinate of region
21925     * @param y A pointer to the Y-coordinate of region
21926     * @param w A pointer to the width
21927     * @param h A pointer to the height
21928     *
21929     * @see elm_photocam_image_region_show()
21930     * @see elm_photocam_image_region_bring_in()
21931     */
21932    EAPI void                   elm_photocam_region_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
21933    /**
21934     * @brief Set the viewed portion of the image
21935     *
21936     * @param obj The photocam object
21937     * @param x X-coordinate of region in image original pixels
21938     * @param y Y-coordinate of region in image original pixels
21939     * @param w Width of region in image original pixels
21940     * @param h Height of region in image original pixels
21941     *
21942     * This shows the region of the image without using animation.
21943     */
21944    EAPI void                   elm_photocam_image_region_show(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
21945    /**
21946     * @brief Bring in the viewed portion of the image
21947     *
21948     * @param obj The photocam object
21949     * @param x X-coordinate of region in image original pixels
21950     * @param y Y-coordinate of region in image original pixels
21951     * @param w Width of region in image original pixels
21952     * @param h Height of region in image original pixels
21953     *
21954     * This shows the region of the image using animation.
21955     */
21956    EAPI void                   elm_photocam_image_region_bring_in(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
21957    /**
21958     * @brief Set the paused state for photocam
21959     *
21960     * @param obj The photocam object
21961     * @param paused The pause state to set
21962     *
21963     * This sets the paused state to on(EINA_TRUE) or off (EINA_FALSE) for
21964     * photocam. The default is off. This will stop zooming using animation on
21965     * zoom levels changes and change instantly. This will stop any existing
21966     * animations that are running.
21967     */
21968    EAPI void                   elm_photocam_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
21969    /**
21970     * @brief Get the paused state for photocam
21971     *
21972     * @param obj The photocam object
21973     * @return The current paused state
21974     *
21975     * This gets the current paused state for the photocam object.
21976     *
21977     * @see elm_photocam_paused_set()
21978     */
21979    EAPI Eina_Bool              elm_photocam_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21980    /**
21981     * @brief Get the internal low-res image used for photocam
21982     *
21983     * @param obj The photocam object
21984     * @return The internal image object handle, or NULL if none exists
21985     *
21986     * This gets the internal image object inside photocam. Do not modify it. It
21987     * is for inspection only, and hooking callbacks to. Nothing else. It may be
21988     * deleted at any time as well.
21989     */
21990    EAPI Evas_Object           *elm_photocam_internal_image_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21991    /**
21992     * @brief Set the photocam scrolling bouncing.
21993     *
21994     * @param obj The photocam object
21995     * @param h_bounce bouncing for horizontal
21996     * @param v_bounce bouncing for vertical
21997     */
21998    EAPI void                   elm_photocam_bounce_set(Evas_Object *obj,  Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
21999    /**
22000     * @brief Get the photocam scrolling bouncing.
22001     *
22002     * @param obj The photocam object
22003     * @param h_bounce bouncing for horizontal
22004     * @param v_bounce bouncing for vertical
22005     *
22006     * @see elm_photocam_bounce_set()
22007     */
22008    EAPI void                   elm_photocam_bounce_get(const Evas_Object *obj,  Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
22009    /**
22010     * @}
22011     */
22012
22013    /**
22014     * @defgroup Map Map
22015     * @ingroup Elementary
22016     *
22017     * @image html img/widget/map/preview-00.png
22018     * @image latex img/widget/map/preview-00.eps
22019     *
22020     * This is a widget specifically for displaying a map. It uses basically
22021     * OpenStreetMap provider http://www.openstreetmap.org/,
22022     * but custom providers can be added.
22023     *
22024     * It supports some basic but yet nice features:
22025     * @li zoom and scroll
22026     * @li markers with content to be displayed when user clicks over it
22027     * @li group of markers
22028     * @li routes
22029     *
22030     * Smart callbacks one can listen to:
22031     *
22032     * - "clicked" - This is called when a user has clicked the map without
22033     *   dragging around.
22034     * - "press" - This is called when a user has pressed down on the map.
22035     * - "longpressed" - This is called when a user has pressed down on the map
22036     *   for a long time without dragging around.
22037     * - "clicked,double" - This is called when a user has double-clicked
22038     *   the map.
22039     * - "load,detail" - Map detailed data load begins.
22040     * - "loaded,detail" - This is called when all currently visible parts of
22041     *   the map are loaded.
22042     * - "zoom,start" - Zoom animation started.
22043     * - "zoom,stop" - Zoom animation stopped.
22044     * - "zoom,change" - Zoom changed when using an auto zoom mode.
22045     * - "scroll" - the content has been scrolled (moved).
22046     * - "scroll,anim,start" - scrolling animation has started.
22047     * - "scroll,anim,stop" - scrolling animation has stopped.
22048     * - "scroll,drag,start" - dragging the contents around has started.
22049     * - "scroll,drag,stop" - dragging the contents around has stopped.
22050     * - "downloaded" - This is called when all currently required map images
22051     *   are downloaded.
22052     * - "route,load" - This is called when route request begins.
22053     * - "route,loaded" - This is called when route request ends.
22054     * - "name,load" - This is called when name request begins.
22055     * - "name,loaded- This is called when name request ends.
22056     *
22057     * Available style for map widget:
22058     * - @c "default"
22059     *
22060     * Available style for markers:
22061     * - @c "radio"
22062     * - @c "radio2"
22063     * - @c "empty"
22064     *
22065     * Available style for marker bubble:
22066     * - @c "default"
22067     *
22068     * List of examples:
22069     * @li @ref map_example_01
22070     * @li @ref map_example_02
22071     * @li @ref map_example_03
22072     */
22073
22074    /**
22075     * @addtogroup Map
22076     * @{
22077     */
22078
22079    /**
22080     * @enum _Elm_Map_Zoom_Mode
22081     * @typedef Elm_Map_Zoom_Mode
22082     *
22083     * Set map's zoom behavior. It can be set to manual or automatic.
22084     *
22085     * Default value is #ELM_MAP_ZOOM_MODE_MANUAL.
22086     *
22087     * Values <b> don't </b> work as bitmask, only one can be choosen.
22088     *
22089     * @note Valid sizes are 2^zoom, consequently the map may be smaller
22090     * than the scroller view.
22091     *
22092     * @see elm_map_zoom_mode_set()
22093     * @see elm_map_zoom_mode_get()
22094     *
22095     * @ingroup Map
22096     */
22097    typedef enum _Elm_Map_Zoom_Mode
22098      {
22099         ELM_MAP_ZOOM_MODE_MANUAL, /**< Zoom controled manually by elm_map_zoom_set(). It's set by default. */
22100         ELM_MAP_ZOOM_MODE_AUTO_FIT, /**< Zoom until map fits inside the scroll frame with no pixels outside this area. */
22101         ELM_MAP_ZOOM_MODE_AUTO_FILL, /**< Zoom until map fills scroll, ensuring no pixels are left unfilled. */
22102         ELM_MAP_ZOOM_MODE_LAST
22103      } Elm_Map_Zoom_Mode;
22104
22105    /**
22106     * @enum _Elm_Map_Route_Sources
22107     * @typedef Elm_Map_Route_Sources
22108     *
22109     * Set route service to be used. By default used source is
22110     * #ELM_MAP_ROUTE_SOURCE_YOURS.
22111     *
22112     * @see elm_map_route_source_set()
22113     * @see elm_map_route_source_get()
22114     *
22115     * @ingroup Map
22116     */
22117    typedef enum _Elm_Map_Route_Sources
22118      {
22119         ELM_MAP_ROUTE_SOURCE_YOURS, /**< Routing service http://www.yournavigation.org/ . Set by default.*/
22120         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. */
22121         ELM_MAP_ROUTE_SOURCE_ORS, /**< Open Route Service: http://www.openrouteservice.org/ . It's not working with Map yet. */
22122         ELM_MAP_ROUTE_SOURCE_LAST
22123      } Elm_Map_Route_Sources;
22124
22125    typedef enum _Elm_Map_Name_Sources
22126      {
22127         ELM_MAP_NAME_SOURCE_NOMINATIM,
22128         ELM_MAP_NAME_SOURCE_LAST
22129      } Elm_Map_Name_Sources;
22130
22131    /**
22132     * @enum _Elm_Map_Route_Type
22133     * @typedef Elm_Map_Route_Type
22134     *
22135     * Set type of transport used on route.
22136     *
22137     * @see elm_map_route_add()
22138     *
22139     * @ingroup Map
22140     */
22141    typedef enum _Elm_Map_Route_Type
22142      {
22143         ELM_MAP_ROUTE_TYPE_MOTOCAR, /**< Route should consider an automobile will be used. */
22144         ELM_MAP_ROUTE_TYPE_BICYCLE, /**< Route should consider a bicycle will be used by the user. */
22145         ELM_MAP_ROUTE_TYPE_FOOT, /**< Route should consider user will be walking. */
22146         ELM_MAP_ROUTE_TYPE_LAST
22147      } Elm_Map_Route_Type;
22148
22149    /**
22150     * @enum _Elm_Map_Route_Method
22151     * @typedef Elm_Map_Route_Method
22152     *
22153     * Set the routing method, what should be priorized, time or distance.
22154     *
22155     * @see elm_map_route_add()
22156     *
22157     * @ingroup Map
22158     */
22159    typedef enum _Elm_Map_Route_Method
22160      {
22161         ELM_MAP_ROUTE_METHOD_FASTEST, /**< Route should priorize time. */
22162         ELM_MAP_ROUTE_METHOD_SHORTEST, /**< Route should priorize distance. */
22163         ELM_MAP_ROUTE_METHOD_LAST
22164      } Elm_Map_Route_Method;
22165
22166    typedef enum _Elm_Map_Name_Method
22167      {
22168         ELM_MAP_NAME_METHOD_SEARCH,
22169         ELM_MAP_NAME_METHOD_REVERSE,
22170         ELM_MAP_NAME_METHOD_LAST
22171      } Elm_Map_Name_Method;
22172
22173    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(). */
22174    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(). */
22175    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(). */
22176    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(). */
22177    typedef struct _Elm_Map_Name            Elm_Map_Name; /**< A handle for specific coordinates. */
22178    typedef struct _Elm_Map_Track           Elm_Map_Track;
22179
22180    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. */
22181    typedef void         (*ElmMapMarkerDelFunc)      (Evas_Object *obj, Elm_Map_Marker *marker, void *data, Evas_Object *o); /**< Function to delete bubble content for marker classes. */
22182    typedef Evas_Object *(*ElmMapMarkerIconGetFunc)  (Evas_Object *obj, Elm_Map_Marker *marker, void *data); /**< Icon fetching class function for marker classes. */
22183    typedef Evas_Object *(*ElmMapGroupIconGetFunc)   (Evas_Object *obj, void *data); /**< Icon fetching class function for markers group classes. */
22184
22185    typedef char        *(*ElmMapModuleSourceFunc) (void);
22186    typedef int          (*ElmMapModuleZoomMinFunc) (void);
22187    typedef int          (*ElmMapModuleZoomMaxFunc) (void);
22188    typedef char        *(*ElmMapModuleUrlFunc) (Evas_Object *obj, int x, int y, int zoom);
22189    typedef int          (*ElmMapModuleRouteSourceFunc) (void);
22190    typedef char        *(*ElmMapModuleRouteUrlFunc) (Evas_Object *obj, char *type_name, int method, double flon, double flat, double tlon, double tlat);
22191    typedef char        *(*ElmMapModuleNameUrlFunc) (Evas_Object *obj, int method, char *name, double lon, double lat);
22192    typedef Eina_Bool    (*ElmMapModuleGeoIntoCoordFunc) (const Evas_Object *obj, int zoom, double lon, double lat, int size, int *x, int *y);
22193    typedef Eina_Bool    (*ElmMapModuleCoordIntoGeoFunc) (const Evas_Object *obj, int zoom, int x, int y, int size, double *lon, double *lat);
22194
22195    /**
22196     * Add a new map widget to the given parent Elementary (container) object.
22197     *
22198     * @param parent The parent object.
22199     * @return a new map widget handle or @c NULL, on errors.
22200     *
22201     * This function inserts a new map widget on the canvas.
22202     *
22203     * @ingroup Map
22204     */
22205    EAPI Evas_Object          *elm_map_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22206
22207    /**
22208     * Set the zoom level of the map.
22209     *
22210     * @param obj The map object.
22211     * @param zoom The zoom level to set.
22212     *
22213     * This sets the zoom level.
22214     *
22215     * It will respect limits defined by elm_map_source_zoom_min_set() and
22216     * elm_map_source_zoom_max_set().
22217     *
22218     * By default these values are 0 (world map) and 18 (maximum zoom).
22219     *
22220     * This function should be used when zoom mode is set to
22221     * #ELM_MAP_ZOOM_MODE_MANUAL. This is the default mode, and can be set
22222     * with elm_map_zoom_mode_set().
22223     *
22224     * @see elm_map_zoom_mode_set().
22225     * @see elm_map_zoom_get().
22226     *
22227     * @ingroup Map
22228     */
22229    EAPI void                  elm_map_zoom_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
22230
22231    /**
22232     * Get the zoom level of the map.
22233     *
22234     * @param obj The map object.
22235     * @return The current zoom level.
22236     *
22237     * This returns the current zoom level of the map object.
22238     *
22239     * Note that if you set the fill mode to other than #ELM_MAP_ZOOM_MODE_MANUAL
22240     * (which is the default), the zoom level may be changed at any time by the
22241     * map object itself to account for map size and map viewport size.
22242     *
22243     * @see elm_map_zoom_set() for details.
22244     *
22245     * @ingroup Map
22246     */
22247    EAPI int                   elm_map_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22248
22249    /**
22250     * Set the zoom mode used by the map object.
22251     *
22252     * @param obj The map object.
22253     * @param mode The zoom mode of the map, being it one of
22254     * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
22255     * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
22256     *
22257     * This sets the zoom mode to manual or one of the automatic levels.
22258     * Manual (#ELM_MAP_ZOOM_MODE_MANUAL) means that zoom is set manually by
22259     * elm_map_zoom_set() and will stay at that level until changed by code
22260     * or until zoom mode is changed. This is the default mode.
22261     *
22262     * The Automatic modes will allow the map object to automatically
22263     * adjust zoom mode based on properties. #ELM_MAP_ZOOM_MODE_AUTO_FIT will
22264     * adjust zoom so the map fits inside the scroll frame with no pixels
22265     * outside this area. #ELM_MAP_ZOOM_MODE_AUTO_FILL will be similar but
22266     * ensure no pixels within the frame are left unfilled. Do not forget that
22267     * the valid sizes are 2^zoom, consequently the map may be smaller than
22268     * the scroller view.
22269     *
22270     * @see elm_map_zoom_set()
22271     *
22272     * @ingroup Map
22273     */
22274    EAPI void                  elm_map_zoom_mode_set(Evas_Object *obj, Elm_Map_Zoom_Mode mode) EINA_ARG_NONNULL(1);
22275
22276    /**
22277     * Get the zoom mode used by the map object.
22278     *
22279     * @param obj The map object.
22280     * @return The zoom mode of the map, being it one of
22281     * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
22282     * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
22283     *
22284     * This function returns the current zoom mode used by the map object.
22285     *
22286     * @see elm_map_zoom_mode_set() for more details.
22287     *
22288     * @ingroup Map
22289     */
22290    EAPI Elm_Map_Zoom_Mode     elm_map_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22291
22292    /**
22293     * Get the current coordinates of the map.
22294     *
22295     * @param obj The map object.
22296     * @param lon Pointer where to store longitude.
22297     * @param lat Pointer where to store latitude.
22298     *
22299     * This gets the current center coordinates of the map object. It can be
22300     * set by elm_map_geo_region_bring_in() and elm_map_geo_region_show().
22301     *
22302     * @see elm_map_geo_region_bring_in()
22303     * @see elm_map_geo_region_show()
22304     *
22305     * @ingroup Map
22306     */
22307    EAPI void                  elm_map_geo_region_get(const Evas_Object *obj, double *lon, double *lat) EINA_ARG_NONNULL(1);
22308
22309    /**
22310     * Animatedly bring in given coordinates to the center of the map.
22311     *
22312     * @param obj The map object.
22313     * @param lon Longitude to center at.
22314     * @param lat Latitude to center at.
22315     *
22316     * This causes map to jump to the given @p lat and @p lon coordinates
22317     * and show it (by scrolling) in the center of the viewport, if it is not
22318     * already centered. This will use animation to do so and take a period
22319     * of time to complete.
22320     *
22321     * @see elm_map_geo_region_show() for a function to avoid animation.
22322     * @see elm_map_geo_region_get()
22323     *
22324     * @ingroup Map
22325     */
22326    EAPI void                  elm_map_geo_region_bring_in(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
22327
22328    /**
22329     * Show the given coordinates at the center of the map, @b immediately.
22330     *
22331     * @param obj The map object.
22332     * @param lon Longitude to center at.
22333     * @param lat Latitude to center at.
22334     *
22335     * This causes map to @b redraw its viewport's contents to the
22336     * region contining the given @p lat and @p lon, that will be moved to the
22337     * center of the map.
22338     *
22339     * @see elm_map_geo_region_bring_in() for a function to move with animation.
22340     * @see elm_map_geo_region_get()
22341     *
22342     * @ingroup Map
22343     */
22344    EAPI void                  elm_map_geo_region_show(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
22345
22346    /**
22347     * Pause or unpause the map.
22348     *
22349     * @param obj The map object.
22350     * @param paused Use @c EINA_TRUE to pause the map @p obj or @c EINA_FALSE
22351     * to unpause it.
22352     *
22353     * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
22354     * for map.
22355     *
22356     * The default is off.
22357     *
22358     * This will stop zooming using animation, changing zoom levels will
22359     * change instantly. This will stop any existing animations that are running.
22360     *
22361     * @see elm_map_paused_get()
22362     *
22363     * @ingroup Map
22364     */
22365    EAPI void                  elm_map_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
22366
22367    /**
22368     * Get a value whether map is paused or not.
22369     *
22370     * @param obj The map object.
22371     * @return @c EINA_TRUE means map is pause. @c EINA_FALSE indicates
22372     * it is not. If @p obj is @c NULL, @c EINA_FALSE is returned.
22373     *
22374     * This gets the current paused state for the map object.
22375     *
22376     * @see elm_map_paused_set() for details.
22377     *
22378     * @ingroup Map
22379     */
22380    EAPI Eina_Bool             elm_map_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22381
22382    /**
22383     * Set to show markers during zoom level changes or not.
22384     *
22385     * @param obj The map object.
22386     * @param paused Use @c EINA_TRUE to @b not show markers or @c EINA_FALSE
22387     * to show them.
22388     *
22389     * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
22390     * for map.
22391     *
22392     * The default is off.
22393     *
22394     * This will stop zooming using animation, changing zoom levels will
22395     * change instantly. This will stop any existing animations that are running.
22396     *
22397     * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
22398     * for the markers.
22399     *
22400     * The default  is off.
22401     *
22402     * Enabling it will force the map to stop displaying the markers during
22403     * zoom level changes. Set to on if you have a large number of markers.
22404     *
22405     * @see elm_map_paused_markers_get()
22406     *
22407     * @ingroup Map
22408     */
22409    EAPI void                  elm_map_paused_markers_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
22410
22411    /**
22412     * Get a value whether markers will be displayed on zoom level changes or not
22413     *
22414     * @param obj The map object.
22415     * @return @c EINA_TRUE means map @b won't display markers or @c EINA_FALSE
22416     * indicates it will. If @p obj is @c NULL, @c EINA_FALSE is returned.
22417     *
22418     * This gets the current markers paused state for the map object.
22419     *
22420     * @see elm_map_paused_markers_set() for details.
22421     *
22422     * @ingroup Map
22423     */
22424    EAPI Eina_Bool             elm_map_paused_markers_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22425
22426    /**
22427     * Get the information of downloading status.
22428     *
22429     * @param obj The map object.
22430     * @param try_num Pointer where to store number of tiles being downloaded.
22431     * @param finish_num Pointer where to store number of tiles successfully
22432     * downloaded.
22433     *
22434     * This gets the current downloading status for the map object, the number
22435     * of tiles being downloaded and the number of tiles already downloaded.
22436     *
22437     * @ingroup Map
22438     */
22439    EAPI void                  elm_map_utils_downloading_status_get(const Evas_Object *obj, int *try_num, int *finish_num) EINA_ARG_NONNULL(1, 2, 3);
22440
22441    /**
22442     * Convert a pixel coordinate (x,y) into a geographic coordinate
22443     * (longitude, latitude).
22444     *
22445     * @param obj The map object.
22446     * @param x the coordinate.
22447     * @param y the coordinate.
22448     * @param size the size in pixels of the map.
22449     * The map is a square and generally his size is : pow(2.0, zoom)*256.
22450     * @param lon Pointer where to store the longitude that correspond to x.
22451     * @param lat Pointer where to store the latitude that correspond to y.
22452     *
22453     * @note Origin pixel point is the top left corner of the viewport.
22454     * Map zoom and size are taken on account.
22455     *
22456     * @see elm_map_utils_convert_geo_into_coord() if you need the inverse.
22457     *
22458     * @ingroup Map
22459     */
22460    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);
22461
22462    /**
22463     * Convert a geographic coordinate (longitude, latitude) into a pixel
22464     * coordinate (x, y).
22465     *
22466     * @param obj The map object.
22467     * @param lon the longitude.
22468     * @param lat the latitude.
22469     * @param size the size in pixels of the map. The map is a square
22470     * and generally his size is : pow(2.0, zoom)*256.
22471     * @param x Pointer where to store the horizontal pixel coordinate that
22472     * correspond to the longitude.
22473     * @param y Pointer where to store the vertical pixel coordinate that
22474     * correspond to the latitude.
22475     *
22476     * @note Origin pixel point is the top left corner of the viewport.
22477     * Map zoom and size are taken on account.
22478     *
22479     * @see elm_map_utils_convert_coord_into_geo() if you need the inverse.
22480     *
22481     * @ingroup Map
22482     */
22483    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);
22484
22485    /**
22486     * Convert a geographic coordinate (longitude, latitude) into a name
22487     * (address).
22488     *
22489     * @param obj The map object.
22490     * @param lon the longitude.
22491     * @param lat the latitude.
22492     * @return name A #Elm_Map_Name handle for this coordinate.
22493     *
22494     * To get the string for this address, elm_map_name_address_get()
22495     * should be used.
22496     *
22497     * @see elm_map_utils_convert_name_into_coord() if you need the inverse.
22498     *
22499     * @ingroup Map
22500     */
22501    EAPI Elm_Map_Name         *elm_map_utils_convert_coord_into_name(const Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
22502
22503    /**
22504     * Convert a name (address) into a geographic coordinate
22505     * (longitude, latitude).
22506     *
22507     * @param obj The map object.
22508     * @param name The address.
22509     * @return name A #Elm_Map_Name handle for this address.
22510     *
22511     * To get the longitude and latitude, elm_map_name_region_get()
22512     * should be used.
22513     *
22514     * @see elm_map_utils_convert_coord_into_name() if you need the inverse.
22515     *
22516     * @ingroup Map
22517     */
22518    EAPI Elm_Map_Name         *elm_map_utils_convert_name_into_coord(const Evas_Object *obj, char *address) EINA_ARG_NONNULL(1, 2);
22519
22520    /**
22521     * Convert a pixel coordinate into a rotated pixel coordinate.
22522     *
22523     * @param obj The map object.
22524     * @param x horizontal coordinate of the point to rotate.
22525     * @param y vertical coordinate of the point to rotate.
22526     * @param cx rotation's center horizontal position.
22527     * @param cy rotation's center vertical position.
22528     * @param degree amount of degrees from 0.0 to 360.0 to rotate arount Z axis.
22529     * @param xx Pointer where to store rotated x.
22530     * @param yy Pointer where to store rotated y.
22531     *
22532     * @ingroup Map
22533     */
22534    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);
22535
22536    /**
22537     * Add a new marker to the map object.
22538     *
22539     * @param obj The map object.
22540     * @param lon The longitude of the marker.
22541     * @param lat The latitude of the marker.
22542     * @param clas The class, to use when marker @b isn't grouped to others.
22543     * @param clas_group The class group, to use when marker is grouped to others
22544     * @param data The data passed to the callbacks.
22545     *
22546     * @return The created marker or @c NULL upon failure.
22547     *
22548     * A marker will be created and shown in a specific point of the map, defined
22549     * by @p lon and @p lat.
22550     *
22551     * It will be displayed using style defined by @p class when this marker
22552     * is displayed alone (not grouped). A new class can be created with
22553     * elm_map_marker_class_new().
22554     *
22555     * If the marker is grouped to other markers, it will be displayed with
22556     * style defined by @p class_group. Markers with the same group are grouped
22557     * if they are close. A new group class can be created with
22558     * elm_map_marker_group_class_new().
22559     *
22560     * Markers created with this method can be deleted with
22561     * elm_map_marker_remove().
22562     *
22563     * A marker can have associated content to be displayed by a bubble,
22564     * when a user click over it, as well as an icon. These objects will
22565     * be fetch using class' callback functions.
22566     *
22567     * @see elm_map_marker_class_new()
22568     * @see elm_map_marker_group_class_new()
22569     * @see elm_map_marker_remove()
22570     *
22571     * @ingroup Map
22572     */
22573    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);
22574
22575    /**
22576     * Set the maximum numbers of markers' content to be displayed in a group.
22577     *
22578     * @param obj The map object.
22579     * @param max The maximum numbers of items displayed in a bubble.
22580     *
22581     * A bubble will be displayed when the user clicks over the group,
22582     * and will place the content of markers that belong to this group
22583     * inside it.
22584     *
22585     * A group can have a long list of markers, consequently the creation
22586     * of the content of the bubble can be very slow.
22587     *
22588     * In order to avoid this, a maximum number of items is displayed
22589     * in a bubble.
22590     *
22591     * By default this number is 30.
22592     *
22593     * Marker with the same group class are grouped if they are close.
22594     *
22595     * @see elm_map_marker_add()
22596     *
22597     * @ingroup Map
22598     */
22599    EAPI void                  elm_map_max_marker_per_group_set(Evas_Object *obj, int max) EINA_ARG_NONNULL(1);
22600
22601    /**
22602     * Remove a marker from the map.
22603     *
22604     * @param marker The marker to remove.
22605     *
22606     * @see elm_map_marker_add()
22607     *
22608     * @ingroup Map
22609     */
22610    EAPI void                  elm_map_marker_remove(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
22611
22612    /**
22613     * Get the current coordinates of the marker.
22614     *
22615     * @param marker marker.
22616     * @param lat Pointer where to store the marker's latitude.
22617     * @param lon Pointer where to store the marker's longitude.
22618     *
22619     * These values are set when adding markers, with function
22620     * elm_map_marker_add().
22621     *
22622     * @see elm_map_marker_add()
22623     *
22624     * @ingroup Map
22625     */
22626    EAPI void                  elm_map_marker_region_get(const Elm_Map_Marker *marker, double *lon, double *lat) EINA_ARG_NONNULL(1);
22627
22628    /**
22629     * Animatedly bring in given marker to the center of the map.
22630     *
22631     * @param marker The marker to center at.
22632     *
22633     * This causes map to jump to the given @p marker's coordinates
22634     * and show it (by scrolling) in the center of the viewport, if it is not
22635     * already centered. This will use animation to do so and take a period
22636     * of time to complete.
22637     *
22638     * @see elm_map_marker_show() for a function to avoid animation.
22639     * @see elm_map_marker_region_get()
22640     *
22641     * @ingroup Map
22642     */
22643    EAPI void                  elm_map_marker_bring_in(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
22644
22645    /**
22646     * Show the given marker at the center of the map, @b immediately.
22647     *
22648     * @param marker The marker to center at.
22649     *
22650     * This causes map to @b redraw its viewport's contents to the
22651     * region contining the given @p marker's coordinates, that will be
22652     * moved to the center of the map.
22653     *
22654     * @see elm_map_marker_bring_in() for a function to move with animation.
22655     * @see elm_map_markers_list_show() if more than one marker need to be
22656     * displayed.
22657     * @see elm_map_marker_region_get()
22658     *
22659     * @ingroup Map
22660     */
22661    EAPI void                  elm_map_marker_show(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
22662
22663    /**
22664     * Move and zoom the map to display a list of markers.
22665     *
22666     * @param markers A list of #Elm_Map_Marker handles.
22667     *
22668     * The map will be centered on the center point of the markers in the list.
22669     * Then the map will be zoomed in order to fit the markers using the maximum
22670     * zoom which allows display of all the markers.
22671     *
22672     * @warning All the markers should belong to the same map object.
22673     *
22674     * @see elm_map_marker_show() to show a single marker.
22675     * @see elm_map_marker_bring_in()
22676     *
22677     * @ingroup Map
22678     */
22679    EAPI void                  elm_map_markers_list_show(Eina_List *markers) EINA_ARG_NONNULL(1);
22680
22681    /**
22682     * Get the Evas object returned by the ElmMapMarkerGetFunc callback
22683     *
22684     * @param marker The marker wich content should be returned.
22685     * @return Return the evas object if it exists, else @c NULL.
22686     *
22687     * To set callback function #ElmMapMarkerGetFunc for the marker class,
22688     * elm_map_marker_class_get_cb_set() should be used.
22689     *
22690     * This content is what will be inside the bubble that will be displayed
22691     * when an user clicks over the marker.
22692     *
22693     * This returns the actual Evas object used to be placed inside
22694     * the bubble. This may be @c NULL, as it may
22695     * not have been created or may have been deleted, at any time, by
22696     * the map. <b>Do not modify this object</b> (move, resize,
22697     * show, hide, etc.), as the map is controlling it. This
22698     * function is for querying, emitting custom signals or hooking
22699     * lower level callbacks for events on that object. Do not delete
22700     * this object under any circumstances.
22701     *
22702     * @ingroup Map
22703     */
22704    EAPI Evas_Object          *elm_map_marker_object_get(const Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
22705
22706    /**
22707     * Update the marker
22708     *
22709     * @param marker The marker to be updated.
22710     *
22711     * If a content is set to this marker, it will call function to delete it,
22712     * #ElmMapMarkerDelFunc, and then will fetch the content again with
22713     * #ElmMapMarkerGetFunc.
22714     *
22715     * These functions are set for the marker class with
22716     * elm_map_marker_class_get_cb_set() and elm_map_marker_class_del_cb_set().
22717     *
22718     * @ingroup Map
22719     */
22720    EAPI void                  elm_map_marker_update(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
22721
22722    /**
22723     * Close all the bubbles opened by the user.
22724     *
22725     * @param obj The map object.
22726     *
22727     * A bubble is displayed with a content fetched with #ElmMapMarkerGetFunc
22728     * when the user clicks on a marker.
22729     *
22730     * This functions is set for the marker class with
22731     * elm_map_marker_class_get_cb_set().
22732     *
22733     * @ingroup Map
22734     */
22735    EAPI void                  elm_map_bubbles_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
22736
22737    /**
22738     * Create a new group class.
22739     *
22740     * @param obj The map object.
22741     * @return Returns the new group class.
22742     *
22743     * Each marker must be associated to a group class. Markers in the same
22744     * group are grouped if they are close.
22745     *
22746     * The group class defines the style of the marker when a marker is grouped
22747     * to others markers. When it is alone, another class will be used.
22748     *
22749     * A group class will need to be provided when creating a marker with
22750     * elm_map_marker_add().
22751     *
22752     * Some properties and functions can be set by class, as:
22753     * - style, with elm_map_group_class_style_set()
22754     * - data - to be associated to the group class. It can be set using
22755     *   elm_map_group_class_data_set().
22756     * - min zoom to display markers, set with
22757     *   elm_map_group_class_zoom_displayed_set().
22758     * - max zoom to group markers, set using
22759     *   elm_map_group_class_zoom_grouped_set().
22760     * - visibility - set if markers will be visible or not, set with
22761     *   elm_map_group_class_hide_set().
22762     * - #ElmMapGroupIconGetFunc - used to fetch icon for markers group classes.
22763     *   It can be set using elm_map_group_class_icon_cb_set().
22764     *
22765     * @see elm_map_marker_add()
22766     * @see elm_map_group_class_style_set()
22767     * @see elm_map_group_class_data_set()
22768     * @see elm_map_group_class_zoom_displayed_set()
22769     * @see elm_map_group_class_zoom_grouped_set()
22770     * @see elm_map_group_class_hide_set()
22771     * @see elm_map_group_class_icon_cb_set()
22772     *
22773     * @ingroup Map
22774     */
22775    EAPI Elm_Map_Group_Class  *elm_map_group_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
22776
22777    /**
22778     * Set the marker's style of a group class.
22779     *
22780     * @param clas The group class.
22781     * @param style The style to be used by markers.
22782     *
22783     * Each marker must be associated to a group class, and will use the style
22784     * defined by such class when grouped to other markers.
22785     *
22786     * The following styles are provided by default theme:
22787     * @li @c radio - blue circle
22788     * @li @c radio2 - green circle
22789     * @li @c empty
22790     *
22791     * @see elm_map_group_class_new() for more details.
22792     * @see elm_map_marker_add()
22793     *
22794     * @ingroup Map
22795     */
22796    EAPI void                  elm_map_group_class_style_set(Elm_Map_Group_Class *clas, const char *style) EINA_ARG_NONNULL(1);
22797
22798    /**
22799     * Set the icon callback function of a group class.
22800     *
22801     * @param clas The group class.
22802     * @param icon_get The callback function that will return the icon.
22803     *
22804     * Each marker must be associated to a group class, and it can display a
22805     * custom icon. The function @p icon_get must return this icon.
22806     *
22807     * @see elm_map_group_class_new() for more details.
22808     * @see elm_map_marker_add()
22809     *
22810     * @ingroup Map
22811     */
22812    EAPI void                  elm_map_group_class_icon_cb_set(Elm_Map_Group_Class *clas, ElmMapGroupIconGetFunc icon_get) EINA_ARG_NONNULL(1);
22813
22814    /**
22815     * Set the data associated to the group class.
22816     *
22817     * @param clas The group class.
22818     * @param data The new user data.
22819     *
22820     * This data will be passed for callback functions, like icon get callback,
22821     * that can be set with elm_map_group_class_icon_cb_set().
22822     *
22823     * If a data was previously set, the object will lose the pointer for it,
22824     * so if needs to be freed, you must do it yourself.
22825     *
22826     * @see elm_map_group_class_new() for more details.
22827     * @see elm_map_group_class_icon_cb_set()
22828     * @see elm_map_marker_add()
22829     *
22830     * @ingroup Map
22831     */
22832    EAPI void                  elm_map_group_class_data_set(Elm_Map_Group_Class *clas, void *data) EINA_ARG_NONNULL(1);
22833
22834    /**
22835     * Set the minimum zoom from where the markers are displayed.
22836     *
22837     * @param clas The group class.
22838     * @param zoom The minimum zoom.
22839     *
22840     * Markers only will be displayed when the map is displayed at @p zoom
22841     * or bigger.
22842     *
22843     * @see elm_map_group_class_new() for more details.
22844     * @see elm_map_marker_add()
22845     *
22846     * @ingroup Map
22847     */
22848    EAPI void                  elm_map_group_class_zoom_displayed_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
22849
22850    /**
22851     * Set the zoom from where the markers are no more grouped.
22852     *
22853     * @param clas The group class.
22854     * @param zoom The maximum zoom.
22855     *
22856     * Markers only will be grouped when the map is displayed at
22857     * less than @p zoom.
22858     *
22859     * @see elm_map_group_class_new() for more details.
22860     * @see elm_map_marker_add()
22861     *
22862     * @ingroup Map
22863     */
22864    EAPI void                  elm_map_group_class_zoom_grouped_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
22865
22866    /**
22867     * Set if the markers associated to the group class @clas are hidden or not.
22868     *
22869     * @param clas The group class.
22870     * @param hide Use @c EINA_TRUE to hide markers or @c EINA_FALSE
22871     * to show them.
22872     *
22873     * If @p hide is @c EINA_TRUE the markers will be hidden, but default
22874     * is to show them.
22875     *
22876     * @ingroup Map
22877     */
22878    EAPI void                  elm_map_group_class_hide_set(Evas_Object *obj, Elm_Map_Group_Class *clas, Eina_Bool hide) EINA_ARG_NONNULL(1, 2);
22879
22880    /**
22881     * Create a new marker class.
22882     *
22883     * @param obj The map object.
22884     * @return Returns the new group class.
22885     *
22886     * Each marker must be associated to a class.
22887     *
22888     * The marker class defines the style of the marker when a marker is
22889     * displayed alone, i.e., not grouped to to others markers. When grouped
22890     * it will use group class style.
22891     *
22892     * A marker class will need to be provided when creating a marker with
22893     * elm_map_marker_add().
22894     *
22895     * Some properties and functions can be set by class, as:
22896     * - style, with elm_map_marker_class_style_set()
22897     * - #ElmMapMarkerIconGetFunc - used to fetch icon for markers classes.
22898     *   It can be set using elm_map_marker_class_icon_cb_set().
22899     * - #ElmMapMarkerGetFunc - used to fetch bubble content for marker classes.
22900     *   Set using elm_map_marker_class_get_cb_set().
22901     * - #ElmMapMarkerDelFunc - used to delete bubble content for marker classes.
22902     *   Set using elm_map_marker_class_del_cb_set().
22903     *
22904     * @see elm_map_marker_add()
22905     * @see elm_map_marker_class_style_set()
22906     * @see elm_map_marker_class_icon_cb_set()
22907     * @see elm_map_marker_class_get_cb_set()
22908     * @see elm_map_marker_class_del_cb_set()
22909     *
22910     * @ingroup Map
22911     */
22912    EAPI Elm_Map_Marker_Class *elm_map_marker_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
22913
22914    /**
22915     * Set the marker's style of a marker class.
22916     *
22917     * @param clas The marker class.
22918     * @param style The style to be used by markers.
22919     *
22920     * Each marker must be associated to a marker class, and will use the style
22921     * defined by such class when alone, i.e., @b not grouped to other markers.
22922     *
22923     * The following styles are provided by default theme:
22924     * @li @c radio
22925     * @li @c radio2
22926     * @li @c empty
22927     *
22928     * @see elm_map_marker_class_new() for more details.
22929     * @see elm_map_marker_add()
22930     *
22931     * @ingroup Map
22932     */
22933    EAPI void                  elm_map_marker_class_style_set(Elm_Map_Marker_Class *clas, const char *style) EINA_ARG_NONNULL(1);
22934
22935    /**
22936     * Set the icon callback function of a marker class.
22937     *
22938     * @param clas The marker class.
22939     * @param icon_get The callback function that will return the icon.
22940     *
22941     * Each marker must be associated to a marker class, and it can display a
22942     * custom icon. The function @p icon_get must return this icon.
22943     *
22944     * @see elm_map_marker_class_new() for more details.
22945     * @see elm_map_marker_add()
22946     *
22947     * @ingroup Map
22948     */
22949    EAPI void                  elm_map_marker_class_icon_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerIconGetFunc icon_get) EINA_ARG_NONNULL(1);
22950
22951    /**
22952     * Set the bubble content callback function of a marker class.
22953     *
22954     * @param clas The marker class.
22955     * @param get The callback function that will return the content.
22956     *
22957     * Each marker must be associated to a marker class, and it can display a
22958     * a content on a bubble that opens when the user click over the marker.
22959     * The function @p get must return this content object.
22960     *
22961     * If this content will need to be deleted, elm_map_marker_class_del_cb_set()
22962     * can be used.
22963     *
22964     * @see elm_map_marker_class_new() for more details.
22965     * @see elm_map_marker_class_del_cb_set()
22966     * @see elm_map_marker_add()
22967     *
22968     * @ingroup Map
22969     */
22970    EAPI void                  elm_map_marker_class_get_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerGetFunc get) EINA_ARG_NONNULL(1);
22971
22972    /**
22973     * Set the callback function used to delete bubble content of a marker class.
22974     *
22975     * @param clas The marker class.
22976     * @param del The callback function that will delete the content.
22977     *
22978     * Each marker must be associated to a marker class, and it can display a
22979     * a content on a bubble that opens when the user click over the marker.
22980     * The function to return such content can be set with
22981     * elm_map_marker_class_get_cb_set().
22982     *
22983     * If this content must be freed, a callback function need to be
22984     * set for that task with this function.
22985     *
22986     * If this callback is defined it will have to delete (or not) the
22987     * object inside, but if the callback is not defined the object will be
22988     * destroyed with evas_object_del().
22989     *
22990     * @see elm_map_marker_class_new() for more details.
22991     * @see elm_map_marker_class_get_cb_set()
22992     * @see elm_map_marker_add()
22993     *
22994     * @ingroup Map
22995     */
22996    EAPI void                  elm_map_marker_class_del_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerDelFunc del) EINA_ARG_NONNULL(1);
22997
22998    /**
22999     * Get the list of available sources.
23000     *
23001     * @param obj The map object.
23002     * @return The source names list.
23003     *
23004     * It will provide a list with all available sources, that can be set as
23005     * current source with elm_map_source_name_set(), or get with
23006     * elm_map_source_name_get().
23007     *
23008     * Available sources:
23009     * @li "Mapnik"
23010     * @li "Osmarender"
23011     * @li "CycleMap"
23012     * @li "Maplint"
23013     *
23014     * @see elm_map_source_name_set() for more details.
23015     * @see elm_map_source_name_get()
23016     *
23017     * @ingroup Map
23018     */
23019    EAPI const char          **elm_map_source_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23020
23021    /**
23022     * Set the source of the map.
23023     *
23024     * @param obj The map object.
23025     * @param source The source to be used.
23026     *
23027     * Map widget retrieves images that composes the map from a web service.
23028     * This web service can be set with this method.
23029     *
23030     * A different service can return a different maps with different
23031     * information and it can use different zoom values.
23032     *
23033     * The @p source_name need to match one of the names provided by
23034     * elm_map_source_names_get().
23035     *
23036     * The current source can be get using elm_map_source_name_get().
23037     *
23038     * @see elm_map_source_names_get()
23039     * @see elm_map_source_name_get()
23040     *
23041     *
23042     * @ingroup Map
23043     */
23044    EAPI void                  elm_map_source_name_set(Evas_Object *obj, const char *source_name) EINA_ARG_NONNULL(1);
23045
23046    /**
23047     * Get the name of currently used source.
23048     *
23049     * @param obj The map object.
23050     * @return Returns the name of the source in use.
23051     *
23052     * @see elm_map_source_name_set() for more details.
23053     *
23054     * @ingroup Map
23055     */
23056    EAPI const char           *elm_map_source_name_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23057
23058    /**
23059     * Set the source of the route service to be used by the map.
23060     *
23061     * @param obj The map object.
23062     * @param source The route service to be used, being it one of
23063     * #ELM_MAP_ROUTE_SOURCE_YOURS (default), #ELM_MAP_ROUTE_SOURCE_MONAV,
23064     * and #ELM_MAP_ROUTE_SOURCE_ORS.
23065     *
23066     * Each one has its own algorithm, so the route retrieved may
23067     * differ depending on the source route. Now, only the default is working.
23068     *
23069     * #ELM_MAP_ROUTE_SOURCE_YOURS is the routing service provided at
23070     * http://www.yournavigation.org/.
23071     *
23072     * #ELM_MAP_ROUTE_SOURCE_MONAV, offers exact routing without heuristic
23073     * assumptions. Its routing core is based on Contraction Hierarchies.
23074     *
23075     * #ELM_MAP_ROUTE_SOURCE_ORS, is provided at http://www.openrouteservice.org/
23076     *
23077     * @see elm_map_route_source_get().
23078     *
23079     * @ingroup Map
23080     */
23081    EAPI void                  elm_map_route_source_set(Evas_Object *obj, Elm_Map_Route_Sources source) EINA_ARG_NONNULL(1);
23082
23083    /**
23084     * Get the current route source.
23085     *
23086     * @param obj The map object.
23087     * @return The source of the route service used by the map.
23088     *
23089     * @see elm_map_route_source_set() for details.
23090     *
23091     * @ingroup Map
23092     */
23093    EAPI Elm_Map_Route_Sources elm_map_route_source_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23094
23095    /**
23096     * Set the minimum zoom of the source.
23097     *
23098     * @param obj The map object.
23099     * @param zoom New minimum zoom value to be used.
23100     *
23101     * By default, it's 0.
23102     *
23103     * @ingroup Map
23104     */
23105    EAPI void                  elm_map_source_zoom_min_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
23106
23107    /**
23108     * Get the minimum zoom of the source.
23109     *
23110     * @param obj The map object.
23111     * @return Returns the minimum zoom of the source.
23112     *
23113     * @see elm_map_source_zoom_min_set() for details.
23114     *
23115     * @ingroup Map
23116     */
23117    EAPI int                   elm_map_source_zoom_min_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23118
23119    /**
23120     * Set the maximum zoom of the source.
23121     *
23122     * @param obj The map object.
23123     * @param zoom New maximum zoom value to be used.
23124     *
23125     * By default, it's 18.
23126     *
23127     * @ingroup Map
23128     */
23129    EAPI void                  elm_map_source_zoom_max_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
23130
23131    /**
23132     * Get the maximum zoom of the source.
23133     *
23134     * @param obj The map object.
23135     * @return Returns the maximum zoom of the source.
23136     *
23137     * @see elm_map_source_zoom_min_set() for details.
23138     *
23139     * @ingroup Map
23140     */
23141    EAPI int                   elm_map_source_zoom_max_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23142
23143    /**
23144     * Set the user agent used by the map object to access routing services.
23145     *
23146     * @param obj The map object.
23147     * @param user_agent The user agent to be used by the map.
23148     *
23149     * User agent is a client application implementing a network protocol used
23150     * in communications within a clientā€“server distributed computing system
23151     *
23152     * The @p user_agent identification string will transmitted in a header
23153     * field @c User-Agent.
23154     *
23155     * @see elm_map_user_agent_get()
23156     *
23157     * @ingroup Map
23158     */
23159    EAPI void                  elm_map_user_agent_set(Evas_Object *obj, const char *user_agent) EINA_ARG_NONNULL(1, 2);
23160
23161    /**
23162     * Get the user agent used by the map object.
23163     *
23164     * @param obj The map object.
23165     * @return The user agent identification string used by the map.
23166     *
23167     * @see elm_map_user_agent_set() for details.
23168     *
23169     * @ingroup Map
23170     */
23171    EAPI const char           *elm_map_user_agent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23172
23173    /**
23174     * Add a new route to the map object.
23175     *
23176     * @param obj The map object.
23177     * @param type The type of transport to be considered when tracing a route.
23178     * @param method The routing method, what should be priorized.
23179     * @param flon The start longitude.
23180     * @param flat The start latitude.
23181     * @param tlon The destination longitude.
23182     * @param tlat The destination latitude.
23183     *
23184     * @return The created route or @c NULL upon failure.
23185     *
23186     * A route will be traced by point on coordinates (@p flat, @p flon)
23187     * to point on coordinates (@p tlat, @p tlon), using the route service
23188     * set with elm_map_route_source_set().
23189     *
23190     * It will take @p type on consideration to define the route,
23191     * depending if the user will be walking or driving, the route may vary.
23192     * One of #ELM_MAP_ROUTE_TYPE_MOTOCAR, #ELM_MAP_ROUTE_TYPE_BICYCLE, or
23193     * #ELM_MAP_ROUTE_TYPE_FOOT need to be used.
23194     *
23195     * Another parameter is what the route should priorize, the minor distance
23196     * or the less time to be spend on the route. So @p method should be one
23197     * of #ELM_MAP_ROUTE_METHOD_SHORTEST or #ELM_MAP_ROUTE_METHOD_FASTEST.
23198     *
23199     * Routes created with this method can be deleted with
23200     * elm_map_route_remove(), colored with elm_map_route_color_set(),
23201     * and distance can be get with elm_map_route_distance_get().
23202     *
23203     * @see elm_map_route_remove()
23204     * @see elm_map_route_color_set()
23205     * @see elm_map_route_distance_get()
23206     * @see elm_map_route_source_set()
23207     *
23208     * @ingroup Map
23209     */
23210    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);
23211
23212    /**
23213     * Remove a route from the map.
23214     *
23215     * @param route The route to remove.
23216     *
23217     * @see elm_map_route_add()
23218     *
23219     * @ingroup Map
23220     */
23221    EAPI void                  elm_map_route_remove(Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23222
23223    /**
23224     * Set the route color.
23225     *
23226     * @param route The route object.
23227     * @param r Red channel value, from 0 to 255.
23228     * @param g Green channel value, from 0 to 255.
23229     * @param b Blue channel value, from 0 to 255.
23230     * @param a Alpha channel value, from 0 to 255.
23231     *
23232     * It uses an additive color model, so each color channel represents
23233     * how much of each primary colors must to be used. 0 represents
23234     * ausence of this color, so if all of the three are set to 0,
23235     * the color will be black.
23236     *
23237     * These component values should be integers in the range 0 to 255,
23238     * (single 8-bit byte).
23239     *
23240     * This sets the color used for the route. By default, it is set to
23241     * solid red (r = 255, g = 0, b = 0, a = 255).
23242     *
23243     * For alpha channel, 0 represents completely transparent, and 255, opaque.
23244     *
23245     * @see elm_map_route_color_get()
23246     *
23247     * @ingroup Map
23248     */
23249    EAPI void                  elm_map_route_color_set(Elm_Map_Route *route, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
23250
23251    /**
23252     * Get the route color.
23253     *
23254     * @param route The route object.
23255     * @param r Pointer where to store the red channel value.
23256     * @param g Pointer where to store the green channel value.
23257     * @param b Pointer where to store the blue channel value.
23258     * @param a Pointer where to store the alpha channel value.
23259     *
23260     * @see elm_map_route_color_set() for details.
23261     *
23262     * @ingroup Map
23263     */
23264    EAPI void                  elm_map_route_color_get(const Elm_Map_Route *route, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
23265
23266    /**
23267     * Get the route distance in kilometers.
23268     *
23269     * @param route The route object.
23270     * @return The distance of route (unit : km).
23271     *
23272     * @ingroup Map
23273     */
23274    EAPI double                elm_map_route_distance_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23275
23276    /**
23277     * Get the information of route nodes.
23278     *
23279     * @param route The route object.
23280     * @return Returns a string with the nodes of route.
23281     *
23282     * @ingroup Map
23283     */
23284    EAPI const char           *elm_map_route_node_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23285
23286    /**
23287     * Get the information of route waypoint.
23288     *
23289     * @param route the route object.
23290     * @return Returns a string with information about waypoint of route.
23291     *
23292     * @ingroup Map
23293     */
23294    EAPI const char           *elm_map_route_waypoint_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23295
23296    /**
23297     * Get the address of the name.
23298     *
23299     * @param name The name handle.
23300     * @return Returns the address string of @p name.
23301     *
23302     * This gets the coordinates of the @p name, created with one of the
23303     * conversion functions.
23304     *
23305     * @see elm_map_utils_convert_name_into_coord()
23306     * @see elm_map_utils_convert_coord_into_name()
23307     *
23308     * @ingroup Map
23309     */
23310    EAPI const char           *elm_map_name_address_get(const Elm_Map_Name *name) EINA_ARG_NONNULL(1);
23311
23312    /**
23313     * Get the current coordinates of the name.
23314     *
23315     * @param name The name handle.
23316     * @param lat Pointer where to store the latitude.
23317     * @param lon Pointer where to store The longitude.
23318     *
23319     * This gets the coordinates of the @p name, created with one of the
23320     * conversion functions.
23321     *
23322     * @see elm_map_utils_convert_name_into_coord()
23323     * @see elm_map_utils_convert_coord_into_name()
23324     *
23325     * @ingroup Map
23326     */
23327    EAPI void                  elm_map_name_region_get(const Elm_Map_Name *name, double *lon, double *lat) EINA_ARG_NONNULL(1);
23328
23329    /**
23330     * Remove a name from the map.
23331     *
23332     * @param name The name to remove.
23333     *
23334     * Basically the struct handled by @p name will be freed, so convertions
23335     * between address and coordinates will be lost.
23336     *
23337     * @see elm_map_utils_convert_name_into_coord()
23338     * @see elm_map_utils_convert_coord_into_name()
23339     *
23340     * @ingroup Map
23341     */
23342    EAPI void                  elm_map_name_remove(Elm_Map_Name *name) EINA_ARG_NONNULL(1);
23343
23344    /**
23345     * Rotate the map.
23346     *
23347     * @param obj The map object.
23348     * @param degree Angle from 0.0 to 360.0 to rotate arount Z axis.
23349     * @param cx Rotation's center horizontal position.
23350     * @param cy Rotation's center vertical position.
23351     *
23352     * @see elm_map_rotate_get()
23353     *
23354     * @ingroup Map
23355     */
23356    EAPI void                  elm_map_rotate_set(Evas_Object *obj, double degree, Evas_Coord cx, Evas_Coord cy) EINA_ARG_NONNULL(1);
23357
23358    /**
23359     * Get the rotate degree of the map
23360     *
23361     * @param obj The map object
23362     * @param degree Pointer where to store degrees from 0.0 to 360.0
23363     * to rotate arount Z axis.
23364     * @param cx Pointer where to store rotation's center horizontal position.
23365     * @param cy Pointer where to store rotation's center vertical position.
23366     *
23367     * @see elm_map_rotate_set() to set map rotation.
23368     *
23369     * @ingroup Map
23370     */
23371    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);
23372
23373    /**
23374     * Enable or disable mouse wheel to be used to zoom in / out the map.
23375     *
23376     * @param obj The map object.
23377     * @param disabled Use @c EINA_TRUE to disable mouse wheel or @c EINA_FALSE
23378     * to enable it.
23379     *
23380     * Mouse wheel can be used for the user to zoom in or zoom out the map.
23381     *
23382     * It's disabled by default.
23383     *
23384     * @see elm_map_wheel_disabled_get()
23385     *
23386     * @ingroup Map
23387     */
23388    EAPI void                  elm_map_wheel_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
23389
23390    /**
23391     * Get a value whether mouse wheel is enabled or not.
23392     *
23393     * @param obj The map object.
23394     * @return @c EINA_TRUE means map is disabled. @c EINA_FALSE indicates
23395     * it is enabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
23396     *
23397     * Mouse wheel can be used for the user to zoom in or zoom out the map.
23398     *
23399     * @see elm_map_wheel_disabled_set() for details.
23400     *
23401     * @ingroup Map
23402     */
23403    EAPI Eina_Bool             elm_map_wheel_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23404
23405 #ifdef ELM_EMAP
23406    /**
23407     * Add a track on the map
23408     *
23409     * @param obj The map object.
23410     * @param emap The emap route object.
23411     * @return The route object. This is an elm object of type Route.
23412     *
23413     * @see elm_route_add() for details.
23414     *
23415     * @ingroup Map
23416     */
23417    EAPI Evas_Object          *elm_map_track_add(Evas_Object *obj, EMap_Route *emap) EINA_ARG_NONNULL(1);
23418 #endif
23419
23420    /**
23421     * Remove a track from the map
23422     *
23423     * @param obj The map object.
23424     * @param route The track to remove.
23425     *
23426     * @ingroup Map
23427     */
23428    EAPI void                  elm_map_track_remove(Evas_Object *obj, Evas_Object *route) EINA_ARG_NONNULL(1);
23429
23430    /**
23431     * @}
23432     */
23433
23434    /* Route */
23435    EAPI Evas_Object *elm_route_add(Evas_Object *parent);
23436 #ifdef ELM_EMAP
23437    EAPI void elm_route_emap_set(Evas_Object *obj, EMap_Route *emap);
23438 #endif
23439    EAPI double elm_route_lon_min_get(Evas_Object *obj);
23440    EAPI double elm_route_lat_min_get(Evas_Object *obj);
23441    EAPI double elm_route_lon_max_get(Evas_Object *obj);
23442    EAPI double elm_route_lat_max_get(Evas_Object *obj);
23443
23444
23445    /**
23446     * @defgroup Panel Panel
23447     *
23448     * @image html img/widget/panel/preview-00.png
23449     * @image latex img/widget/panel/preview-00.eps
23450     *
23451     * @brief A panel is a type of animated container that contains subobjects.
23452     * It can be expanded or contracted by clicking the button on it's edge.
23453     *
23454     * Orientations are as follows:
23455     * @li ELM_PANEL_ORIENT_TOP
23456     * @li ELM_PANEL_ORIENT_LEFT
23457     * @li ELM_PANEL_ORIENT_RIGHT
23458     *
23459     * To set/get/unset the content of the panel, you can use
23460     * elm_object_content_set/get/unset APIs.
23461     * Once the content object is set, a previously set one will be deleted.
23462     * If you want to keep that old content object, use the
23463     * elm_object_content_unset() function
23464     *
23465     * @ref tutorial_panel shows one way to use this widget.
23466     * @{
23467     */
23468    typedef enum _Elm_Panel_Orient
23469      {
23470         ELM_PANEL_ORIENT_TOP, /**< Panel (dis)appears from the top */
23471         ELM_PANEL_ORIENT_BOTTOM, /**< Not implemented */
23472         ELM_PANEL_ORIENT_LEFT, /**< Panel (dis)appears from the left */
23473         ELM_PANEL_ORIENT_RIGHT, /**< Panel (dis)appears from the right */
23474      } Elm_Panel_Orient;
23475    /**
23476     * @brief Adds a panel object
23477     *
23478     * @param parent The parent object
23479     *
23480     * @return The panel object, or NULL on failure
23481     */
23482    EAPI Evas_Object          *elm_panel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23483    /**
23484     * @brief Sets the orientation of the panel
23485     *
23486     * @param parent The parent object
23487     * @param orient The panel orientation. Can be one of the following:
23488     * @li ELM_PANEL_ORIENT_TOP
23489     * @li ELM_PANEL_ORIENT_LEFT
23490     * @li ELM_PANEL_ORIENT_RIGHT
23491     *
23492     * Sets from where the panel will (dis)appear.
23493     */
23494    EAPI void                  elm_panel_orient_set(Evas_Object *obj, Elm_Panel_Orient orient) EINA_ARG_NONNULL(1);
23495    /**
23496     * @brief Get the orientation of the panel.
23497     *
23498     * @param obj The panel object
23499     * @return The Elm_Panel_Orient, or ELM_PANEL_ORIENT_LEFT on failure.
23500     */
23501    EAPI Elm_Panel_Orient      elm_panel_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23502    /**
23503     * @brief Set the content of the panel.
23504     *
23505     * @param obj The panel object
23506     * @param content The panel content
23507     *
23508     * Once the content object is set, a previously set one will be deleted.
23509     * If you want to keep that old content object, use the
23510     * elm_panel_content_unset() function.
23511     */
23512    EINA_DEPRECATED EAPI void                  elm_panel_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
23513    /**
23514     * @brief Get the content of the panel.
23515     *
23516     * @param obj The panel object
23517     * @return The content that is being used
23518     *
23519     * Return the content object which is set for this widget.
23520     *
23521     * @see elm_panel_content_set()
23522     */
23523    EINA_DEPRECATED EAPI Evas_Object          *elm_panel_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23524    /**
23525     * @brief Unset the content of the panel.
23526     *
23527     * @param obj The panel object
23528     * @return The content that was being used
23529     *
23530     * Unparent and return the content object which was set for this widget.
23531     *
23532     * @see elm_panel_content_set()
23533     */
23534    EINA_DEPRECATED EAPI Evas_Object          *elm_panel_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
23535    /**
23536     * @brief Set the state of the panel.
23537     *
23538     * @param obj The panel object
23539     * @param hidden If true, the panel will run the animation to contract
23540     */
23541    EAPI void                  elm_panel_hidden_set(Evas_Object *obj, Eina_Bool hidden) EINA_ARG_NONNULL(1);
23542    /**
23543     * @brief Get the state of the panel.
23544     *
23545     * @param obj The panel object
23546     * @param hidden If true, the panel is in the "hide" state
23547     */
23548    EAPI Eina_Bool             elm_panel_hidden_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23549    /**
23550     * @brief Toggle the hidden state of the panel from code
23551     *
23552     * @param obj The panel object
23553     */
23554    EAPI void                  elm_panel_toggle(Evas_Object *obj) EINA_ARG_NONNULL(1);
23555    /**
23556     * @}
23557     */
23558
23559    /**
23560     * @defgroup Panes Panes
23561     * @ingroup Elementary
23562     *
23563     * @image html img/widget/panes/preview-00.png
23564     * @image latex img/widget/panes/preview-00.eps width=\textwidth
23565     *
23566     * @image html img/panes.png
23567     * @image latex img/panes.eps width=\textwidth
23568     *
23569     * The panes adds a dragable bar between two contents. When dragged
23570     * this bar will resize contents size.
23571     *
23572     * Panes can be displayed vertically or horizontally, and contents
23573     * size proportion can be customized (homogeneous by default).
23574     *
23575     * Smart callbacks one can listen to:
23576     * - "press" - The panes has been pressed (button wasn't released yet).
23577     * - "unpressed" - The panes was released after being pressed.
23578     * - "clicked" - The panes has been clicked>
23579     * - "clicked,double" - The panes has been double clicked
23580     *
23581     * Available styles for it:
23582     * - @c "default"
23583     *
23584     * Default contents parts of the panes widget that you can use for are:
23585     * @li "elm.swallow.left" - A leftside content of the panes
23586     * @li "elm.swallow.right" - A rightside content of the panes
23587     *
23588     * If panes is displayed vertically, left content will be displayed at
23589     * top.
23590     * 
23591     * Here is an example on its usage:
23592     * @li @ref panes_example
23593     */
23594
23595 #define ELM_PANES_CONTENT_LEFT "elm.swallow.left"
23596 #define ELM_PANES_CONTENT_RIGHT "elm.swallow.right"
23597
23598    /**
23599     * @addtogroup Panes
23600     * @{
23601     */
23602
23603    /**
23604     * Add a new panes widget to the given parent Elementary
23605     * (container) object.
23606     *
23607     * @param parent The parent object.
23608     * @return a new panes widget handle or @c NULL, on errors.
23609     *
23610     * This function inserts a new panes widget on the canvas.
23611     *
23612     * @ingroup Panes
23613     */
23614    EAPI Evas_Object          *elm_panes_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23615
23616    /**
23617     * Set the left content of the panes widget.
23618     *
23619     * @param obj The panes object.
23620     * @param content The new left content object.
23621     *
23622     * Once the content object is set, a previously set one will be deleted.
23623     * If you want to keep that old content object, use the
23624     * elm_panes_content_left_unset() function.
23625     *
23626     * If panes is displayed vertically, left content will be displayed at
23627     * top.
23628     *
23629     * @see elm_panes_content_left_get()
23630     * @see elm_panes_content_right_set() to set content on the other side.
23631     *
23632     * @ingroup Panes
23633     */
23634    EAPI void                  elm_panes_content_left_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
23635
23636    /**
23637     * Set the right content of the panes widget.
23638     *
23639     * @param obj The panes object.
23640     * @param content The new right content object.
23641     *
23642     * Once the content object is set, a previously set one will be deleted.
23643     * If you want to keep that old content object, use the
23644     * elm_panes_content_right_unset() function.
23645     *
23646     * If panes is displayed vertically, left content will be displayed at
23647     * bottom.
23648     *
23649     * @see elm_panes_content_right_get()
23650     * @see elm_panes_content_left_set() to set content on the other side.
23651     *
23652     * @ingroup Panes
23653     */
23654    EAPI void                  elm_panes_content_right_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
23655
23656    /**
23657     * Get the left content of the panes.
23658     *
23659     * @param obj The panes object.
23660     * @return The left content object that is being used.
23661     *
23662     * Return the left content object which is set for this widget.
23663     *
23664     * @see elm_panes_content_left_set() for details.
23665     *
23666     * @ingroup Panes
23667     */
23668    EAPI Evas_Object          *elm_panes_content_left_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23669
23670    /**
23671     * Get the right content of the panes.
23672     *
23673     * @param obj The panes object
23674     * @return The right content object that is being used
23675     *
23676     * Return the right content object which is set for this widget.
23677     *
23678     * @see elm_panes_content_right_set() for details.
23679     *
23680     * @ingroup Panes
23681     */
23682    EAPI Evas_Object          *elm_panes_content_right_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23683
23684    /**
23685     * Unset the left content used for the panes.
23686     *
23687     * @param obj The panes object.
23688     * @return The left content object that was being used.
23689     *
23690     * Unparent and return the left content object which was set for this widget.
23691     *
23692     * @see elm_panes_content_left_set() for details.
23693     * @see elm_panes_content_left_get().
23694     *
23695     * @ingroup Panes
23696     */
23697    EAPI Evas_Object          *elm_panes_content_left_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
23698
23699    /**
23700     * Unset the right content used for the panes.
23701     *
23702     * @param obj The panes object.
23703     * @return The right content object that was being used.
23704     *
23705     * Unparent and return the right content object which was set for this
23706     * widget.
23707     *
23708     * @see elm_panes_content_right_set() for details.
23709     * @see elm_panes_content_right_get().
23710     *
23711     * @ingroup Panes
23712     */
23713    EAPI Evas_Object          *elm_panes_content_right_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
23714
23715    /**
23716     * Get the size proportion of panes widget's left side.
23717     *
23718     * @param obj The panes object.
23719     * @return float value between 0.0 and 1.0 representing size proportion
23720     * of left side.
23721     *
23722     * @see elm_panes_content_left_size_set() for more details.
23723     *
23724     * @ingroup Panes
23725     */
23726    EAPI double                elm_panes_content_left_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23727
23728    /**
23729     * Set the size proportion of panes widget's left side.
23730     *
23731     * @param obj The panes object.
23732     * @param size Value between 0.0 and 1.0 representing size proportion
23733     * of left side.
23734     *
23735     * By default it's homogeneous, i.e., both sides have the same size.
23736     *
23737     * If something different is required, it can be set with this function.
23738     * For example, if the left content should be displayed over
23739     * 75% of the panes size, @p size should be passed as @c 0.75.
23740     * This way, right content will be resized to 25% of panes size.
23741     *
23742     * If displayed vertically, left content is displayed at top, and
23743     * right content at bottom.
23744     *
23745     * @note This proportion will change when user drags the panes bar.
23746     *
23747     * @see elm_panes_content_left_size_get()
23748     *
23749     * @ingroup Panes
23750     */
23751    EAPI void                  elm_panes_content_left_size_set(Evas_Object *obj, double size) EINA_ARG_NONNULL(1);
23752
23753   /**
23754    * Set the orientation of a given panes widget.
23755    *
23756    * @param obj The panes object.
23757    * @param horizontal Use @c EINA_TRUE to make @p obj to be
23758    * @b horizontal, @c EINA_FALSE to make it @b vertical.
23759    *
23760    * Use this function to change how your panes is to be
23761    * disposed: vertically or horizontally.
23762    *
23763    * By default it's displayed horizontally.
23764    *
23765    * @see elm_panes_horizontal_get()
23766    *
23767    * @ingroup Panes
23768    */
23769    EAPI void                  elm_panes_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
23770
23771    /**
23772     * Retrieve the orientation of a given panes widget.
23773     *
23774     * @param obj The panes object.
23775     * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
23776     * @c EINA_FALSE if it's @b vertical (and on errors).
23777     *
23778     * @see elm_panes_horizontal_set() for more details.
23779     *
23780     * @ingroup Panes
23781     */
23782    EAPI Eina_Bool             elm_panes_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23783    EAPI void                  elm_panes_fixed_set(Evas_Object *obj, Eina_Bool fixed) EINA_ARG_NONNULL(1);
23784    EAPI Eina_Bool             elm_panes_fixed_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23785
23786    /**
23787     * @}
23788     */
23789
23790    /**
23791     * @defgroup Flip Flip
23792     *
23793     * @image html img/widget/flip/preview-00.png
23794     * @image latex img/widget/flip/preview-00.eps
23795     *
23796     * This widget holds 2 content objects(Evas_Object): one on the front and one
23797     * on the back. It allows you to flip from front to back and vice-versa using
23798     * various animations.
23799     *
23800     * If either the front or back contents are not set the flip will treat that
23801     * as transparent. So if you wore to set the front content but not the back,
23802     * and then call elm_flip_go() you would see whatever is below the flip.
23803     *
23804     * For a list of supported animations see elm_flip_go().
23805     *
23806     * Signals that you can add callbacks for are:
23807     * "animate,begin" - when a flip animation was started
23808     * "animate,done" - when a flip animation is finished
23809     *
23810     * @ref tutorial_flip show how to use most of the API.
23811     *
23812     * @{
23813     */
23814    typedef enum _Elm_Flip_Mode
23815      {
23816         ELM_FLIP_ROTATE_Y_CENTER_AXIS,
23817         ELM_FLIP_ROTATE_X_CENTER_AXIS,
23818         ELM_FLIP_ROTATE_XZ_CENTER_AXIS,
23819         ELM_FLIP_ROTATE_YZ_CENTER_AXIS,
23820         ELM_FLIP_CUBE_LEFT,
23821         ELM_FLIP_CUBE_RIGHT,
23822         ELM_FLIP_CUBE_UP,
23823         ELM_FLIP_CUBE_DOWN,
23824         ELM_FLIP_PAGE_LEFT,
23825         ELM_FLIP_PAGE_RIGHT,
23826         ELM_FLIP_PAGE_UP,
23827         ELM_FLIP_PAGE_DOWN
23828      } Elm_Flip_Mode;
23829    typedef enum _Elm_Flip_Interaction
23830      {
23831         ELM_FLIP_INTERACTION_NONE,
23832         ELM_FLIP_INTERACTION_ROTATE,
23833         ELM_FLIP_INTERACTION_CUBE,
23834         ELM_FLIP_INTERACTION_PAGE
23835      } Elm_Flip_Interaction;
23836    typedef enum _Elm_Flip_Direction
23837      {
23838         ELM_FLIP_DIRECTION_UP, /**< Allows interaction with the top of the widget */
23839         ELM_FLIP_DIRECTION_DOWN, /**< Allows interaction with the bottom of the widget */
23840         ELM_FLIP_DIRECTION_LEFT, /**< Allows interaction with the left portion of the widget */
23841         ELM_FLIP_DIRECTION_RIGHT /**< Allows interaction with the right portion of the widget */
23842      } Elm_Flip_Direction;
23843    /**
23844     * @brief Add a new flip to the parent
23845     *
23846     * @param parent The parent object
23847     * @return The new object or NULL if it cannot be created
23848     */
23849    EAPI Evas_Object *elm_flip_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23850    /**
23851     * @brief Set the front content of the flip widget.
23852     *
23853     * @param obj The flip object
23854     * @param content The new front content object
23855     *
23856     * Once the content object is set, a previously set one will be deleted.
23857     * If you want to keep that old content object, use the
23858     * elm_flip_content_front_unset() function.
23859     */
23860    EAPI void         elm_flip_content_front_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
23861    /**
23862     * @brief Set the back content of the flip widget.
23863     *
23864     * @param obj The flip object
23865     * @param content The new back content object
23866     *
23867     * Once the content object is set, a previously set one will be deleted.
23868     * If you want to keep that old content object, use the
23869     * elm_flip_content_back_unset() function.
23870     */
23871    EAPI void         elm_flip_content_back_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
23872    /**
23873     * @brief Get the front content used for the flip
23874     *
23875     * @param obj The flip object
23876     * @return The front content object that is being used
23877     *
23878     * Return the front content object which is set for this widget.
23879     */
23880    EAPI Evas_Object *elm_flip_content_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23881    /**
23882     * @brief Get the back content used for the flip
23883     *
23884     * @param obj The flip object
23885     * @return The back content object that is being used
23886     *
23887     * Return the back content object which is set for this widget.
23888     */
23889    EAPI Evas_Object *elm_flip_content_back_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23890    /**
23891     * @brief Unset the front content used for the flip
23892     *
23893     * @param obj The flip object
23894     * @return The front content object that was being used
23895     *
23896     * Unparent and return the front content object which was set for this widget.
23897     */
23898    EAPI Evas_Object *elm_flip_content_front_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
23899    /**
23900     * @brief Unset the back content used for the flip
23901     *
23902     * @param obj The flip object
23903     * @return The back content object that was being used
23904     *
23905     * Unparent and return the back content object which was set for this widget.
23906     */
23907    EAPI Evas_Object *elm_flip_content_back_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
23908    /**
23909     * @brief Get flip front visibility state
23910     *
23911     * @param obj The flip objct
23912     * @return EINA_TRUE if front front is showing, EINA_FALSE if the back is
23913     * showing.
23914     */
23915    EAPI Eina_Bool    elm_flip_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23916    /**
23917     * @brief Set flip perspective
23918     *
23919     * @param obj The flip object
23920     * @param foc The coordinate to set the focus on
23921     * @param x The X coordinate
23922     * @param y The Y coordinate
23923     *
23924     * @warning This function currently does nothing.
23925     */
23926    EAPI void         elm_flip_perspective_set(Evas_Object *obj, Evas_Coord foc, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
23927    /**
23928     * @brief Runs the flip animation
23929     *
23930     * @param obj The flip object
23931     * @param mode The mode type
23932     *
23933     * Flips the front and back contents using the @p mode animation. This
23934     * efectively hides the currently visible content and shows the hidden one.
23935     *
23936     * There a number of possible animations to use for the flipping:
23937     * @li ELM_FLIP_ROTATE_X_CENTER_AXIS - Rotate the currently visible content
23938     * around a horizontal axis in the middle of its height, the other content
23939     * is shown as the other side of the flip.
23940     * @li ELM_FLIP_ROTATE_Y_CENTER_AXIS - Rotate the currently visible content
23941     * around a vertical axis in the middle of its width, the other content is
23942     * shown as the other side of the flip.
23943     * @li ELM_FLIP_ROTATE_XZ_CENTER_AXIS - Rotate the currently visible content
23944     * around a diagonal axis in the middle of its width, the other content is
23945     * shown as the other side of the flip.
23946     * @li ELM_FLIP_ROTATE_YZ_CENTER_AXIS - Rotate the currently visible content
23947     * around a diagonal axis in the middle of its height, the other content is
23948     * shown as the other side of the flip.
23949     * @li ELM_FLIP_CUBE_LEFT - Rotate the currently visible content to the left
23950     * as if the flip was a cube, the other content is show as the right face of
23951     * the cube.
23952     * @li ELM_FLIP_CUBE_RIGHT - Rotate the currently visible content to the
23953     * right as if the flip was a cube, the other content is show as the left
23954     * face of the cube.
23955     * @li ELM_FLIP_CUBE_UP - Rotate the currently visible content up as if the
23956     * flip was a cube, the other content is show as the bottom face of the cube.
23957     * @li ELM_FLIP_CUBE_DOWN - Rotate the currently visible content down as if
23958     * the flip was a cube, the other content is show as the upper face of the
23959     * cube.
23960     * @li ELM_FLIP_PAGE_LEFT - Move the currently visible content to the left as
23961     * if the flip was a book, the other content is shown as the page below that.
23962     * @li ELM_FLIP_PAGE_RIGHT - Move the currently visible content to the right
23963     * as if the flip was a book, the other content is shown as the page below
23964     * that.
23965     * @li ELM_FLIP_PAGE_UP - Move the currently visible content up as if the
23966     * flip was a book, the other content is shown as the page below that.
23967     * @li ELM_FLIP_PAGE_DOWN - Move the currently visible content down as if the
23968     * flip was a book, the other content is shown as the page below that.
23969     *
23970     * @image html elm_flip.png
23971     * @image latex elm_flip.eps width=\textwidth
23972     */
23973    EAPI void         elm_flip_go(Evas_Object *obj, Elm_Flip_Mode mode) EINA_ARG_NONNULL(1);
23974    /**
23975     * @brief Set the interactive flip mode
23976     *
23977     * @param obj The flip object
23978     * @param mode The interactive flip mode to use
23979     *
23980     * This sets if the flip should be interactive (allow user to click and
23981     * drag a side of the flip to reveal the back page and cause it to flip).
23982     * By default a flip is not interactive. You may also need to set which
23983     * sides of the flip are "active" for flipping and how much space they use
23984     * (a minimum of a finger size) with elm_flip_interacton_direction_enabled_set()
23985     * and elm_flip_interacton_direction_hitsize_set()
23986     *
23987     * The four avilable mode of interaction are:
23988     * @li ELM_FLIP_INTERACTION_NONE - No interaction is allowed
23989     * @li ELM_FLIP_INTERACTION_ROTATE - Interaction will cause rotate animation
23990     * @li ELM_FLIP_INTERACTION_CUBE - Interaction will cause cube animation
23991     * @li ELM_FLIP_INTERACTION_PAGE - Interaction will cause page animation
23992     *
23993     * @note ELM_FLIP_INTERACTION_ROTATE won't cause
23994     * ELM_FLIP_ROTATE_XZ_CENTER_AXIS or ELM_FLIP_ROTATE_YZ_CENTER_AXIS to
23995     * happen, those can only be acheived with elm_flip_go();
23996     */
23997    EAPI void         elm_flip_interaction_set(Evas_Object *obj, Elm_Flip_Interaction mode);
23998    /**
23999     * @brief Get the interactive flip mode
24000     *
24001     * @param obj The flip object
24002     * @return The interactive flip mode
24003     *
24004     * Returns the interactive flip mode set by elm_flip_interaction_set()
24005     */
24006    EAPI Elm_Flip_Interaction elm_flip_interaction_get(const Evas_Object *obj);
24007    /**
24008     * @brief Set which directions of the flip respond to interactive flip
24009     *
24010     * @param obj The flip object
24011     * @param dir The direction to change
24012     * @param enabled If that direction is enabled or not
24013     *
24014     * By default all directions are disabled, so you may want to enable the
24015     * desired directions for flipping if you need interactive flipping. You must
24016     * call this function once for each direction that should be enabled.
24017     *
24018     * @see elm_flip_interaction_set()
24019     */
24020    EAPI void         elm_flip_interacton_direction_enabled_set(Evas_Object *obj, Elm_Flip_Direction dir, Eina_Bool enabled);
24021    /**
24022     * @brief Get the enabled state of that flip direction
24023     *
24024     * @param obj The flip object
24025     * @param dir The direction to check
24026     * @return If that direction is enabled or not
24027     *
24028     * Gets the enabled state set by elm_flip_interacton_direction_enabled_set()
24029     *
24030     * @see elm_flip_interaction_set()
24031     */
24032    EAPI Eina_Bool    elm_flip_interacton_direction_enabled_get(Evas_Object *obj, Elm_Flip_Direction dir);
24033    /**
24034     * @brief Set the amount of the flip that is sensitive to interactive flip
24035     *
24036     * @param obj The flip object
24037     * @param dir The direction to modify
24038     * @param hitsize The amount of that dimension (0.0 to 1.0) to use
24039     *
24040     * Set the amount of the flip that is sensitive to interactive flip, with 0
24041     * representing no area in the flip and 1 representing the entire flip. There
24042     * is however a consideration to be made in that the area will never be
24043     * smaller than the finger size set(as set in your Elementary configuration).
24044     *
24045     * @see elm_flip_interaction_set()
24046     */
24047    EAPI void         elm_flip_interacton_direction_hitsize_set(Evas_Object *obj, Elm_Flip_Direction dir, double hitsize);
24048    /**
24049     * @brief Get the amount of the flip that is sensitive to interactive flip
24050     *
24051     * @param obj The flip object
24052     * @param dir The direction to check
24053     * @return The size set for that direction
24054     *
24055     * Returns the amount os sensitive area set by
24056     * elm_flip_interacton_direction_hitsize_set().
24057     */
24058    EAPI double       elm_flip_interacton_direction_hitsize_get(Evas_Object *obj, Elm_Flip_Direction dir);
24059    /**
24060     * @}
24061     */
24062
24063    /* scrolledentry */
24064    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24065    EINA_DEPRECATED EAPI void         elm_scrolled_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
24066    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24067    EINA_DEPRECATED EAPI void         elm_scrolled_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
24068    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24069    EINA_DEPRECATED EAPI void         elm_scrolled_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
24070    EINA_DEPRECATED EAPI const char  *elm_scrolled_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24071    EINA_DEPRECATED EAPI void         elm_scrolled_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
24072    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24073    EINA_DEPRECATED EAPI const char  *elm_scrolled_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24074    EINA_DEPRECATED EAPI void         elm_scrolled_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
24075    EINA_DEPRECATED EAPI void         elm_scrolled_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
24076    EINA_DEPRECATED EAPI void         elm_scrolled_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
24077    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24078    EINA_DEPRECATED EAPI void         elm_scrolled_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
24079    EINA_DEPRECATED EAPI void         elm_scrolled_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
24080    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
24081    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
24082    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
24083    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
24084    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24085    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24086    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24087    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24088    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
24089    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
24090    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24091    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24092    EINA_DEPRECATED EAPI const char  *elm_scrolled_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24093    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
24094    EINA_DEPRECATED EAPI int          elm_scrolled_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24095    EINA_DEPRECATED EAPI void         elm_scrolled_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
24096    EINA_DEPRECATED EAPI void         elm_scrolled_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
24097    EINA_DEPRECATED EAPI void         elm_scrolled_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
24098    EINA_DEPRECATED EAPI void         elm_scrolled_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
24099    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);
24100    EINA_DEPRECATED EAPI void         elm_scrolled_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
24101    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24102    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);
24103    EINA_DEPRECATED EAPI void         elm_scrolled_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
24104    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);
24105    EINA_DEPRECATED EAPI void         elm_scrolled_entry_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1, 2);
24106    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24107    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24108    EINA_DEPRECATED EAPI void         elm_scrolled_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
24109    EINA_DEPRECATED EAPI void         elm_scrolled_entry_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1, 2);
24110    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24111    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24112    EINA_DEPRECATED EAPI void         elm_scrolled_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
24113    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);
24114    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);
24115    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);
24116    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);
24117    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);
24118    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);
24119    EINA_DEPRECATED EAPI void         elm_scrolled_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
24120    EINA_DEPRECATED EAPI void         elm_scrolled_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
24121    EINA_DEPRECATED EAPI void         elm_scrolled_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
24122    EINA_DEPRECATED EAPI void         elm_scrolled_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
24123    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24124    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
24125    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cnp_textonly_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
24126    EINA_DEPRECATED EAPI void         elm_scrolled_entry_line_char_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
24127    EINA_DEPRECATED EAPI void         elm_scrolled_entry_input_panel_enabled_set(Evas_Object *obj, Eina_Bool enabled);
24128    EINA_DEPRECATED EAPI void         elm_scrolled_entry_input_panel_layout_set(Evas_Object *obj, Elm_Input_Panel_Layout layout);
24129    EINA_DEPRECATED EAPI Ecore_IMF_Context *elm_scrolled_entry_imf_context_get(Evas_Object *obj);
24130    EINA_DEPRECATED EAPI void         elm_scrolled_entry_autocapitalization_set(Evas_Object *obj, Eina_Bool autocap);
24131    EINA_DEPRECATED EAPI void         elm_scrolled_entry_autoperiod_set(Evas_Object *obj, Eina_Bool autoperiod);
24132
24133    /**
24134     * @defgroup Conformant Conformant
24135     * @ingroup Elementary
24136     *
24137     * @image html img/widget/conformant/preview-00.png
24138     * @image latex img/widget/conformant/preview-00.eps width=\textwidth
24139     *
24140     * @image html img/conformant.png
24141     * @image latex img/conformant.eps width=\textwidth
24142     *
24143     * The aim is to provide a widget that can be used in elementary apps to
24144     * account for space taken up by the indicator, virtual keypad & softkey
24145     * windows when running the illume2 module of E17.
24146     *
24147     * So conformant content will be sized and positioned considering the
24148     * space required for such stuff, and when they popup, as a keyboard
24149     * shows when an entry is selected, conformant content won't change.
24150     *
24151     * Available styles for it:
24152     * - @c "default"
24153     *
24154     * Default contents parts of the conformant widget that you can use for are:
24155     * @li "elm.swallow.content" - A content of the conformant
24156     *
24157     * See how to use this widget in this example:
24158     * @ref conformant_example
24159     */
24160
24161    /**
24162     * @addtogroup Conformant
24163     * @{
24164     */
24165
24166    /**
24167     * Add a new conformant widget to the given parent Elementary
24168     * (container) object.
24169     *
24170     * @param parent The parent object.
24171     * @return A new conformant widget handle or @c NULL, on errors.
24172     *
24173     * This function inserts a new conformant widget on the canvas.
24174     *
24175     * @ingroup Conformant
24176     */
24177    EAPI Evas_Object *elm_conformant_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24178
24179    /**
24180     * Set the content of the conformant widget.
24181     *
24182     * @param obj The conformant object.
24183     * @param content The content to be displayed by the conformant.
24184     *
24185     * Content will be sized and positioned considering the space required
24186     * to display a virtual keyboard. So it won't fill all the conformant
24187     * size. This way is possible to be sure that content won't resize
24188     * or be re-positioned after the keyboard is displayed.
24189     *
24190     * Once the content object is set, a previously set one will be deleted.
24191     * If you want to keep that old content object, use the
24192     * elm_object_content_unset() function.
24193     *
24194     * @see elm_object_content_unset()
24195     * @see elm_object_content_get()
24196     *
24197     * @ingroup Conformant
24198     */
24199    EAPI void         elm_conformant_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24200
24201    /**
24202     * Get the content of the conformant widget.
24203     *
24204     * @param obj The conformant object.
24205     * @return The content that is being used.
24206     *
24207     * Return the content object which is set for this widget.
24208     * It won't be unparent from conformant. For that, use
24209     * elm_object_content_unset().
24210     *
24211     * @see elm_object_content_set().
24212     * @see elm_object_content_unset()
24213     *
24214     * @ingroup Conformant
24215     */
24216    EAPI Evas_Object *elm_conformant_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24217
24218    /**
24219     * Unset the content of the conformant widget.
24220     *
24221     * @param obj The conformant object.
24222     * @return The content that was being used.
24223     *
24224     * Unparent and return the content object which was set for this widget.
24225     *
24226     * @see elm_object_content_set().
24227     *
24228     * @ingroup Conformant
24229     */
24230    EAPI Evas_Object *elm_conformant_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24231
24232    /**
24233     * Returns the Evas_Object that represents the content area.
24234     *
24235     * @param obj The conformant object.
24236     * @return The content area of the widget.
24237     *
24238     * @ingroup Conformant
24239     */
24240    EAPI Evas_Object *elm_conformant_content_area_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24241
24242    /**
24243     * @}
24244     */
24245
24246    /**
24247     * @defgroup Mapbuf Mapbuf
24248     * @ingroup Elementary
24249     *
24250     * @image html img/widget/mapbuf/preview-00.png
24251     * @image latex img/widget/mapbuf/preview-00.eps width=\textwidth
24252     *
24253     * This holds one content object and uses an Evas Map of transformation
24254     * points to be later used with this content. So the content will be
24255     * moved, resized, etc as a single image. So it will improve performance
24256     * when you have a complex interafce, with a lot of elements, and will
24257     * need to resize or move it frequently (the content object and its
24258     * children).
24259     *
24260     * To set/get/unset the content of the mapbuf, you can use 
24261     * elm_object_content_set/get/unset APIs. 
24262     * Once the content object is set, a previously set one will be deleted.
24263     * If you want to keep that old content object, use the
24264     * elm_object_content_unset() function.
24265     *
24266     * To enable map, elm_mapbuf_enabled_set() should be used.
24267     * 
24268     * See how to use this widget in this example:
24269     * @ref mapbuf_example
24270     */
24271
24272    /**
24273     * @addtogroup Mapbuf
24274     * @{
24275     */
24276
24277    /**
24278     * Add a new mapbuf widget to the given parent Elementary
24279     * (container) object.
24280     *
24281     * @param parent The parent object.
24282     * @return A new mapbuf widget handle or @c NULL, on errors.
24283     *
24284     * This function inserts a new mapbuf widget on the canvas.
24285     *
24286     * @ingroup Mapbuf
24287     */
24288    EAPI Evas_Object *elm_mapbuf_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24289
24290    /**
24291     * Set the content of the mapbuf.
24292     *
24293     * @param obj The mapbuf object.
24294     * @param content The content that will be filled in this mapbuf object.
24295     *
24296     * Once the content object is set, a previously set one will be deleted.
24297     * If you want to keep that old content object, use the
24298     * elm_mapbuf_content_unset() function.
24299     *
24300     * To enable map, elm_mapbuf_enabled_set() should be used.
24301     *
24302     * @ingroup Mapbuf
24303     */
24304    EINA_DEPRECATED EAPI void         elm_mapbuf_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24305
24306    /**
24307     * Get the content of the mapbuf.
24308     *
24309     * @param obj The mapbuf object.
24310     * @return The content that is being used.
24311     *
24312     * Return the content object which is set for this widget.
24313     *
24314     * @see elm_mapbuf_content_set() for details.
24315     *
24316     * @ingroup Mapbuf
24317     */
24318    EINA_DEPRECATED EAPI Evas_Object *elm_mapbuf_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24319
24320    /**
24321     * Unset the content of the mapbuf.
24322     *
24323     * @param obj The mapbuf object.
24324     * @return The content that was being used.
24325     *
24326     * Unparent and return the content object which was set for this widget.
24327     *
24328     * @see elm_mapbuf_content_set() for details.
24329     *
24330     * @ingroup Mapbuf
24331     */
24332    EINA_DEPRECATED EAPI Evas_Object *elm_mapbuf_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24333
24334    /**
24335     * Enable or disable the map.
24336     *
24337     * @param obj The mapbuf object.
24338     * @param enabled @c EINA_TRUE to enable map or @c EINA_FALSE to disable it.
24339     *
24340     * This enables the map that is set or disables it. On enable, the object
24341     * geometry will be saved, and the new geometry will change (position and
24342     * size) to reflect the map geometry set.
24343     *
24344     * Also, when enabled, alpha and smooth states will be used, so if the
24345     * content isn't solid, alpha should be enabled, for example, otherwise
24346     * a black retangle will fill the content.
24347     *
24348     * When disabled, the stored map will be freed and geometry prior to
24349     * enabling the map will be restored.
24350     *
24351     * It's disabled by default.
24352     *
24353     * @see elm_mapbuf_alpha_set()
24354     * @see elm_mapbuf_smooth_set()
24355     *
24356     * @ingroup Mapbuf
24357     */
24358    EAPI void         elm_mapbuf_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
24359
24360    /**
24361     * Get a value whether map is enabled or not.
24362     *
24363     * @param obj The mapbuf object.
24364     * @return @c EINA_TRUE means map is enabled. @c EINA_FALSE indicates
24365     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24366     *
24367     * @see elm_mapbuf_enabled_set() for details.
24368     *
24369     * @ingroup Mapbuf
24370     */
24371    EAPI Eina_Bool    elm_mapbuf_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24372
24373    /**
24374     * Enable or disable smooth map rendering.
24375     *
24376     * @param obj The mapbuf object.
24377     * @param smooth @c EINA_TRUE to enable smooth map rendering or @c EINA_FALSE
24378     * to disable it.
24379     *
24380     * This sets smoothing for map rendering. If the object is a type that has
24381     * its own smoothing settings, then both the smooth settings for this object
24382     * and the map must be turned off.
24383     *
24384     * By default smooth maps are enabled.
24385     *
24386     * @ingroup Mapbuf
24387     */
24388    EAPI void         elm_mapbuf_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
24389
24390    /**
24391     * Get a value whether smooth map rendering is enabled or not.
24392     *
24393     * @param obj The mapbuf object.
24394     * @return @c EINA_TRUE means smooth map rendering is enabled. @c EINA_FALSE
24395     * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24396     *
24397     * @see elm_mapbuf_smooth_set() for details.
24398     *
24399     * @ingroup Mapbuf
24400     */
24401    EAPI Eina_Bool    elm_mapbuf_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24402
24403    /**
24404     * Set or unset alpha flag for map rendering.
24405     *
24406     * @param obj The mapbuf object.
24407     * @param alpha @c EINA_TRUE to enable alpha blending or @c EINA_FALSE
24408     * to disable it.
24409     *
24410     * This sets alpha flag for map rendering. If the object is a type that has
24411     * its own alpha settings, then this will take precedence. Only image objects
24412     * have this currently. It stops alpha blending of the map area, and is
24413     * useful if you know the object and/or all sub-objects is 100% solid.
24414     *
24415     * Alpha is enabled by default.
24416     *
24417     * @ingroup Mapbuf
24418     */
24419    EAPI void         elm_mapbuf_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
24420
24421    /**
24422     * Get a value whether alpha blending is enabled or not.
24423     *
24424     * @param obj The mapbuf object.
24425     * @return @c EINA_TRUE means alpha blending is enabled. @c EINA_FALSE
24426     * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24427     *
24428     * @see elm_mapbuf_alpha_set() for details.
24429     *
24430     * @ingroup Mapbuf
24431     */
24432    EAPI Eina_Bool    elm_mapbuf_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24433
24434    /**
24435     * @}
24436     */
24437
24438    /**
24439     * @defgroup Flipselector Flip Selector
24440     *
24441     * A flip selector is a widget to show a set of @b text items, one
24442     * at a time, with the same sheet switching style as the @ref Clock
24443     * "clock" widget, when one changes the current displaying sheet
24444     * (thus, the "flip" in the name).
24445     *
24446     * User clicks to flip sheets which are @b held for some time will
24447     * make the flip selector to flip continuosly and automatically for
24448     * the user. The interval between flips will keep growing in time,
24449     * so that it helps the user to reach an item which is distant from
24450     * the current selection.
24451     *
24452     * Smart callbacks one can register to:
24453     * - @c "selected" - when the widget's selected text item is changed
24454     * - @c "overflowed" - when the widget's current selection is changed
24455     *   from the first item in its list to the last
24456     * - @c "underflowed" - when the widget's current selection is changed
24457     *   from the last item in its list to the first
24458     *
24459     * Available styles for it:
24460     * - @c "default"
24461     *
24462     * Here is an example on its usage:
24463     * @li @ref flipselector_example
24464     */
24465
24466    /**
24467     * @addtogroup Flipselector
24468     * @{
24469     */
24470
24471    typedef struct _Elm_Flipselector_Item Elm_Flipselector_Item; /**< Item handle for a flip selector widget. */
24472
24473    /**
24474     * Add a new flip selector widget to the given parent Elementary
24475     * (container) widget
24476     *
24477     * @param parent The parent object
24478     * @return a new flip selector widget handle or @c NULL, on errors
24479     *
24480     * This function inserts a new flip selector widget on the canvas.
24481     *
24482     * @ingroup Flipselector
24483     */
24484    EAPI Evas_Object               *elm_flipselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24485
24486    /**
24487     * Programmatically select the next item of a flip selector widget
24488     *
24489     * @param obj The flipselector object
24490     *
24491     * @note The selection will be animated. Also, if it reaches the
24492     * end of its list of member items, it will continue with the first
24493     * one onwards.
24494     *
24495     * @ingroup Flipselector
24496     */
24497    EAPI void                       elm_flipselector_flip_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
24498
24499    /**
24500     * Programmatically select the previous item of a flip selector
24501     * widget
24502     *
24503     * @param obj The flipselector object
24504     *
24505     * @note The selection will be animated.  Also, if it reaches the
24506     * beginning of its list of member items, it will continue with the
24507     * last one backwards.
24508     *
24509     * @ingroup Flipselector
24510     */
24511    EAPI void                       elm_flipselector_flip_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
24512
24513    /**
24514     * Append a (text) item to a flip selector widget
24515     *
24516     * @param obj The flipselector object
24517     * @param label The (text) label of the new item
24518     * @param func Convenience callback function to take place when
24519     * item is selected
24520     * @param data Data passed to @p func, above
24521     * @return A handle to the item added or @c NULL, on errors
24522     *
24523     * The widget's list of labels to show will be appended with the
24524     * given value. If the user wishes so, a callback function pointer
24525     * can be passed, which will get called when this same item is
24526     * selected.
24527     *
24528     * @note The current selection @b won't be modified by appending an
24529     * element to the list.
24530     *
24531     * @note The maximum length of the text label is going to be
24532     * determined <b>by the widget's theme</b>. Strings larger than
24533     * that value are going to be @b truncated.
24534     *
24535     * @ingroup Flipselector
24536     */
24537    EAPI Elm_Flipselector_Item     *elm_flipselector_item_append(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
24538
24539    /**
24540     * Prepend a (text) item to a flip selector widget
24541     *
24542     * @param obj The flipselector object
24543     * @param label The (text) label of the new item
24544     * @param func Convenience callback function to take place when
24545     * item is selected
24546     * @param data Data passed to @p func, above
24547     * @return A handle to the item added or @c NULL, on errors
24548     *
24549     * The widget's list of labels to show will be prepended with the
24550     * given value. If the user wishes so, a callback function pointer
24551     * can be passed, which will get called when this same item is
24552     * selected.
24553     *
24554     * @note The current selection @b won't be modified by prepending
24555     * an element to the list.
24556     *
24557     * @note The maximum length of the text label is going to be
24558     * determined <b>by the widget's theme</b>. Strings larger than
24559     * that value are going to be @b truncated.
24560     *
24561     * @ingroup Flipselector
24562     */
24563    EAPI Elm_Flipselector_Item     *elm_flipselector_item_prepend(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
24564
24565    /**
24566     * Get the internal list of items in a given flip selector widget.
24567     *
24568     * @param obj The flipselector object
24569     * @return The list of items (#Elm_Flipselector_Item as data) or @c
24570     * NULL on errors.
24571     *
24572     * This list is @b not to be modified in any way and must not be
24573     * freed. Use the list members with functions like
24574     * elm_flipselector_item_label_set(),
24575     * elm_flipselector_item_label_get(), elm_flipselector_item_del(),
24576     * elm_flipselector_item_del(),
24577     * elm_flipselector_item_selected_get(),
24578     * elm_flipselector_item_selected_set().
24579     *
24580     * @warning This list is only valid until @p obj object's internal
24581     * items list is changed. It should be fetched again with another
24582     * call to this function when changes happen.
24583     *
24584     * @ingroup Flipselector
24585     */
24586    EAPI const Eina_List           *elm_flipselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24587
24588    /**
24589     * Get the first item in the given flip selector widget's list of
24590     * items.
24591     *
24592     * @param obj The flipselector object
24593     * @return The first item or @c NULL, if it has no items (and on
24594     * errors)
24595     *
24596     * @see elm_flipselector_item_append()
24597     * @see elm_flipselector_last_item_get()
24598     *
24599     * @ingroup Flipselector
24600     */
24601    EAPI Elm_Flipselector_Item     *elm_flipselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24602
24603    /**
24604     * Get the last item in the given flip selector widget's list of
24605     * items.
24606     *
24607     * @param obj The flipselector object
24608     * @return The last item or @c NULL, if it has no items (and on
24609     * errors)
24610     *
24611     * @see elm_flipselector_item_prepend()
24612     * @see elm_flipselector_first_item_get()
24613     *
24614     * @ingroup Flipselector
24615     */
24616    EAPI Elm_Flipselector_Item     *elm_flipselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24617
24618    /**
24619     * Get the currently selected item in a flip selector widget.
24620     *
24621     * @param obj The flipselector object
24622     * @return The selected item or @c NULL, if the widget has no items
24623     * (and on erros)
24624     *
24625     * @ingroup Flipselector
24626     */
24627    EAPI Elm_Flipselector_Item     *elm_flipselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24628
24629    /**
24630     * Set whether a given flip selector widget's item should be the
24631     * currently selected one.
24632     *
24633     * @param item The flip selector item
24634     * @param selected @c EINA_TRUE to select it, @c EINA_FALSE to unselect.
24635     *
24636     * This sets whether @p item is or not the selected (thus, under
24637     * display) one. If @p item is different than one under display,
24638     * the latter will be unselected. If the @p item is set to be
24639     * unselected, on the other hand, the @b first item in the widget's
24640     * internal members list will be the new selected one.
24641     *
24642     * @see elm_flipselector_item_selected_get()
24643     *
24644     * @ingroup Flipselector
24645     */
24646    EAPI void                       elm_flipselector_item_selected_set(Elm_Flipselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
24647
24648    /**
24649     * Get whether a given flip selector widget's item is the currently
24650     * selected one.
24651     *
24652     * @param item The flip selector item
24653     * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
24654     * (or on errors).
24655     *
24656     * @see elm_flipselector_item_selected_set()
24657     *
24658     * @ingroup Flipselector
24659     */
24660    EAPI Eina_Bool                  elm_flipselector_item_selected_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
24661
24662    /**
24663     * Delete a given item from a flip selector widget.
24664     *
24665     * @param item The item to delete
24666     *
24667     * @ingroup Flipselector
24668     */
24669    EAPI void                       elm_flipselector_item_del(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
24670
24671    /**
24672     * Get the label of a given flip selector widget's item.
24673     *
24674     * @param item The item to get label from
24675     * @return The text label of @p item or @c NULL, on errors
24676     *
24677     * @see elm_flipselector_item_label_set()
24678     *
24679     * @ingroup Flipselector
24680     */
24681    EAPI const char                *elm_flipselector_item_label_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
24682
24683    /**
24684     * Set the label of a given flip selector widget's item.
24685     *
24686     * @param item The item to set label on
24687     * @param label The text label string, in UTF-8 encoding
24688     *
24689     * @see elm_flipselector_item_label_get()
24690     *
24691     * @ingroup Flipselector
24692     */
24693    EAPI void                       elm_flipselector_item_label_set(Elm_Flipselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
24694
24695    /**
24696     * Gets the item before @p item in a flip selector widget's
24697     * internal list of items.
24698     *
24699     * @param item The item to fetch previous from
24700     * @return The item before the @p item, in its parent's list. If
24701     *         there is no previous item for @p item or there's an
24702     *         error, @c NULL is returned.
24703     *
24704     * @see elm_flipselector_item_next_get()
24705     *
24706     * @ingroup Flipselector
24707     */
24708    EAPI Elm_Flipselector_Item     *elm_flipselector_item_prev_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
24709
24710    /**
24711     * Gets the item after @p item in a flip selector widget's
24712     * internal list of items.
24713     *
24714     * @param item The item to fetch next from
24715     * @return The item after the @p item, in its parent's list. If
24716     *         there is no next item for @p item or there's an
24717     *         error, @c NULL is returned.
24718     *
24719     * @see elm_flipselector_item_next_get()
24720     *
24721     * @ingroup Flipselector
24722     */
24723    EAPI Elm_Flipselector_Item     *elm_flipselector_item_next_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
24724
24725    /**
24726     * Set the interval on time updates for an user mouse button hold
24727     * on a flip selector widget.
24728     *
24729     * @param obj The flip selector object
24730     * @param interval The (first) interval value in seconds
24731     *
24732     * This interval value is @b decreased while the user holds the
24733     * mouse pointer either flipping up or flipping doww a given flip
24734     * selector.
24735     *
24736     * This helps the user to get to a given item distant from the
24737     * current one easier/faster, as it will start to flip quicker and
24738     * quicker on mouse button holds.
24739     *
24740     * The calculation for the next flip interval value, starting from
24741     * the one set with this call, is the previous interval divided by
24742     * 1.05, so it decreases a little bit.
24743     *
24744     * The default starting interval value for automatic flips is
24745     * @b 0.85 seconds.
24746     *
24747     * @see elm_flipselector_interval_get()
24748     *
24749     * @ingroup Flipselector
24750     */
24751    EAPI void                       elm_flipselector_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
24752
24753    /**
24754     * Get the interval on time updates for an user mouse button hold
24755     * on a flip selector widget.
24756     *
24757     * @param obj The flip selector object
24758     * @return The (first) interval value, in seconds, set on it
24759     *
24760     * @see elm_flipselector_interval_set() for more details
24761     *
24762     * @ingroup Flipselector
24763     */
24764    EAPI double                     elm_flipselector_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24765
24766    /**
24767     * @}
24768     */
24769
24770    /**
24771     * @addtogroup Animator Animator
24772     * @ingroup Elementary
24773     *
24774     * @brief Functions to ease creation of animations.
24775     *
24776     * elm_animator is designed to provide an easy way to create animations.
24777     * Creating an animation with elm_animator is as simple as setting a
24778     * duration, an operating callback and telling it to run the animation.
24779     * However that is not the full extent of elm_animator's ability, animations
24780     * can be paused and resumed, reversed and the animation need not be linear.
24781     *
24782     * To run an animation you must specify at least a duration and operation
24783     * callback, not setting any other properties will create a linear animation
24784     * that runs once and is not reversed.
24785     *
24786     * @ref elm_animator_example_page_01 "This" example should make all of that
24787     * very clear.
24788     *
24789     * @warning elm_animator is @b not a widget.
24790     * @{
24791     */
24792    /**
24793     * @brief Type of curve desired for animation.
24794     *
24795     * The speed in which an animation happens doesn't have to be linear, some
24796     * animations will look better if they're accelerating or decelerating, so
24797     * elm_animator provides four options in this regard:
24798     * @image html elm_animator_curve_style.png
24799     * @image latex elm_animator_curve_style.eps width=\textwidth
24800     * As can be seen in the image the speed of the animation will be:
24801     * @li ELM_ANIMATOR_CURVE_LINEAR constant
24802     * @li ELM_ANIMATOR_CURVE_IN_OUT start slow, speed up and then slow down
24803     * @li ELM_ANIMATOR_CURVE_IN start slow and then speed up
24804     * @li ELM_ANIMATOR_CURVE_OUT start fast and then slow down
24805     */
24806    typedef enum
24807      {
24808         ELM_ANIMATOR_CURVE_LINEAR,
24809         ELM_ANIMATOR_CURVE_IN_OUT,
24810         ELM_ANIMATOR_CURVE_IN,
24811         ELM_ANIMATOR_CURVE_OUT
24812      } Elm_Animator_Curve_Style;
24813    typedef struct _Elm_Animator Elm_Animator;
24814   /**
24815    * Called back per loop of an elementary animators cycle
24816    * @param data user-data given to elm_animator_operation_callback_set()
24817    * @param animator the animator being run
24818    * @param double the position in the animation
24819    */
24820    typedef void (*Elm_Animator_Operation_Cb) (void *data, Elm_Animator *animator, double frame);
24821   /**
24822    * Called back when an elementary animator finishes
24823    * @param data user-data given to elm_animator_completion_callback_set()
24824    */
24825    typedef void (*Elm_Animator_Completion_Cb) (void *data);
24826
24827    /**
24828     * @brief Create a new animator.
24829     *
24830     * @param[in] parent Parent object
24831     *
24832     * The @a parent argument can be set to NULL for no parent. If a parent is set
24833     * there is no need to call elm_animator_del(), when the parent is deleted it
24834     * will delete the animator.
24835     * @deprecated Use @ref Transit instead.
24836
24837     */
24838    EINA_DEPRECATED EAPI Elm_Animator*            elm_animator_add(Evas_Object *parent);
24839    /**
24840     * Deletes the animator freeing any resources it used. If the animator was
24841     * created with a NULL parent this must be called, otherwise it will be
24842     * automatically called when the parent is deleted.
24843     *
24844     * @param[in] animator Animator object
24845     * @deprecated Use @ref Transit instead.
24846     */
24847    EINA_DEPRECATED EAPI void                     elm_animator_del(Elm_Animator *animator) EINA_ARG_NONNULL(1);
24848    /**
24849     * Set the duration of the animation.
24850     *
24851     * @param[in] animator Animator object
24852     * @param[in] duration Duration in second
24853     * @deprecated Use @ref Transit instead.
24854     */
24855    EINA_DEPRECATED EAPI void                     elm_animator_duration_set(Elm_Animator *animator, double duration) EINA_ARG_NONNULL(1);
24856    /**
24857     * @brief Set the callback function for animator operation.
24858     *
24859     * @param[in] animator Animator object
24860     * @param[in] func @ref Elm_Animator_Operation_Cb "Callback" function pointer
24861     * @param[in] data Callback function user argument
24862     *
24863     * The @p func callback will be called with a frame value in range [0, 1] which
24864     * indicates how far along the animation should be. It is the job of @p func to
24865     * actually change the state of any object(or objects) that are being animated.
24866     * @deprecated Use @ref Transit instead.
24867     */
24868    EINA_DEPRECATED EAPI void                     elm_animator_operation_callback_set(Elm_Animator *animator, Elm_Animator_Operation_Cb func, void *data) EINA_ARG_NONNULL(1);
24869    /**
24870     * Set the callback function for the when the animation ends.
24871     *
24872     * @param[in]  animator Animator object
24873     * @param[in]  func   Callback function pointe
24874     * @param[in]  data Callback function user argument
24875     *
24876     * @warning @a func will not be executed if elm_animator_stop() is called.
24877     * @deprecated Use @ref Transit instead.
24878     */
24879    EINA_DEPRECATED EAPI void                     elm_animator_completion_callback_set(Elm_Animator *animator, Elm_Animator_Completion_Cb func, void *data) EINA_ARG_NONNULL(1);
24880    /**
24881     * @brief Stop animator.
24882     *
24883     * @param[in] animator Animator object
24884     *
24885     * If called before elm_animator_animate() it does nothing. If there is an
24886     * animation in progress the animation will be stopped(the operation callback
24887     * will not be executed again) and it can't be restarted using
24888     * elm_animator_resume().
24889     * @deprecated Use @ref Transit instead.
24890     */
24891    EINA_DEPRECATED EAPI void                     elm_animator_stop(Elm_Animator *animator) EINA_ARG_NONNULL(1);
24892    /**
24893     * Set the animator repeat count.
24894     *
24895     * @param[in]  animator Animator object
24896     * @param[in]  repeat_cnt Repeat count
24897     * @deprecated Use @ref Transit instead.
24898     */
24899    EINA_DEPRECATED EAPI void                     elm_animator_repeat_set(Elm_Animator *animator, unsigned int repeat_cnt) EINA_ARG_NONNULL(1);
24900    /**
24901     * @brief Start animation.
24902     *
24903     * @param[in] animator Animator object
24904     *
24905     * This function starts the animation if the nescessary properties(duration
24906     * and operation callback) have been set. Once started the animation will
24907     * run until complete or elm_animator_stop() is called.
24908     * @deprecated Use @ref Transit instead.
24909     */
24910    EINA_DEPRECATED EAPI void                     elm_animator_animate(Elm_Animator *animator) EINA_ARG_NONNULL(1);
24911    /**
24912     * Sets the animation @ref Elm_Animator_Curve_Style "acceleration style".
24913     *
24914     * @param[in] animator Animator object
24915     * @param[in] cs Curve style. Default is ELM_ANIMATOR_CURVE_LINEAR
24916     * @deprecated Use @ref Transit instead.
24917     */
24918    EINA_DEPRECATED EAPI void                     elm_animator_curve_style_set(Elm_Animator *animator, Elm_Animator_Curve_Style cs) EINA_ARG_NONNULL(1);
24919    /**
24920     * Gets the animation @ref Elm_Animator_Curve_Style "acceleration style".
24921     *
24922     * @param[in] animator Animator object
24923     * @param[in] cs Curve style. Default is ELM_ANIMATOR_CURVE_LINEAR
24924     * @deprecated Use @ref Transit instead.
24925     */
24926    EINA_DEPRECATED EAPI Elm_Animator_Curve_Style elm_animator_curve_style_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
24927    /**
24928     * @brief Sets wether the animation should be automatically reversed.
24929     *
24930     * @param[in] animator Animator object
24931     * @param[in] reverse Reverse or not
24932     *
24933     * This controls wether the animation will be run on reverse imediately after
24934     * running forward. When this is set together with repetition the animation
24935     * will run in reverse once for each time it ran forward.@n
24936     * Runnin an animation in reverse is accomplished by calling the operation
24937     * callback with a frame value starting at 1 and diminshing until 0.
24938     * @deprecated Use @ref Transit instead.
24939     */
24940    EINA_DEPRECATED EAPI void                     elm_animator_auto_reverse_set(Elm_Animator *animator, Eina_Bool reverse) EINA_ARG_NONNULL(1);
24941    /**
24942     * Gets wether the animation will automatically reversed
24943     *
24944     * @param[in] animator Animator object
24945     * @deprecated Use @ref Transit instead.
24946     */
24947    EINA_DEPRECATED EAPI Eina_Bool                elm_animator_auto_reverse_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
24948    /**
24949     * Gets the status for the animator operation. The status of the animator @b
24950     * doesn't take in to account elm_animator_pause() or elm_animator_resume(), it
24951     * only informs if the animation was started and has not ended(either normally
24952     * or through elm_animator_stop()).
24953     *
24954     * @param[in] animator Animator object
24955     * @deprecated Use @ref Transit instead.
24956     */
24957    EINA_DEPRECATED EAPI Eina_Bool                elm_animator_operating_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
24958    /**
24959     * Gets how many times the animation will be repeated
24960     *
24961     * @param[in] animator Animator object
24962     * @deprecated Use @ref Transit instead.
24963     */
24964    EINA_DEPRECATED EAPI unsigned int             elm_animator_repeat_get(const Elm_Animator *animator) EINA_ARG_NONNULL(1);
24965    /**
24966     * Pause the animator.
24967     *
24968     * @param[in]  animator Animator object
24969     *
24970     * This causes the animation to be temporarily stopped(the operation callback
24971     * will not be called). If the animation is not yet running this is a no-op.
24972     * Once an animation has been paused with this function it can be resumed
24973     * using elm_animator_resume().
24974     * @deprecated Use @ref Transit instead.
24975     */
24976    EINA_DEPRECATED EAPI void                     elm_animator_pause(Elm_Animator *animator) EINA_ARG_NONNULL(1);
24977    /**
24978     * @brief Resumes the animator.
24979     *
24980     * @param[in]  animator Animator object
24981     *
24982     * Resumes an animation that was paused using elm_animator_pause(), after
24983     * calling this function calls to the operation callback will happen
24984     * normally. If an animation is stopped by means of elm_animator_stop it
24985     * @b can't be restarted with this function.@n
24986     *
24987     * @warning When an animation is resumed it doesn't start from where it was paused, it
24988     * will go to where it would have been if it had not been paused. If an
24989     * animation with a duration of 3 seconds is paused after 1 second for 1 second
24990     * it will resume as if it had ben animating for 2 seconds, the operating
24991     * callback will be called with a frame value of aproximately 2/3.
24992     * @deprecated Use @ref Transit instead.
24993     */
24994    EINA_DEPRECATED EAPI void                     elm_animator_resume(Elm_Animator *animator) EINA_ARG_NONNULL(1);
24995    /**
24996     * @}
24997     */
24998
24999    /**
25000     * @addtogroup Calendar
25001     * @{
25002     */
25003
25004    /**
25005     * @enum _Elm_Calendar_Mark_Repeat
25006     * @typedef Elm_Calendar_Mark_Repeat
25007     *
25008     * Event periodicity, used to define if a mark should be repeated
25009     * @b beyond event's day. It's set when a mark is added.
25010     *
25011     * So, for a mark added to 13th May with periodicity set to WEEKLY,
25012     * there will be marks every week after this date. Marks will be displayed
25013     * at 13th, 20th, 27th, 3rd June ...
25014     *
25015     * Values don't work as bitmask, only one can be choosen.
25016     *
25017     * @see elm_calendar_mark_add()
25018     *
25019     * @ingroup Calendar
25020     */
25021    typedef enum _Elm_Calendar_Mark_Repeat
25022      {
25023         ELM_CALENDAR_UNIQUE, /**< Default value. Marks will be displayed only on event day. */
25024         ELM_CALENDAR_DAILY, /**< Marks will be displayed everyday after event day (inclusive). */
25025         ELM_CALENDAR_WEEKLY, /**< Marks will be displayed every week after event day (inclusive) - i.e. each seven days. */
25026         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*/
25027         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. */
25028      } Elm_Calendar_Mark_Repeat;
25029
25030    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(). */
25031
25032    /**
25033     * Add a new calendar widget to the given parent Elementary
25034     * (container) object.
25035     *
25036     * @param parent The parent object.
25037     * @return a new calendar widget handle or @c NULL, on errors.
25038     *
25039     * This function inserts a new calendar widget on the canvas.
25040     *
25041     * @ref calendar_example_01
25042     *
25043     * @ingroup Calendar
25044     */
25045    EAPI Evas_Object       *elm_calendar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25046
25047    /**
25048     * Get weekdays names displayed by the calendar.
25049     *
25050     * @param obj The calendar object.
25051     * @return Array of seven strings to be used as weekday names.
25052     *
25053     * By default, weekdays abbreviations get from system are displayed:
25054     * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
25055     * The first string is related to Sunday, the second to Monday...
25056     *
25057     * @see elm_calendar_weekdays_name_set()
25058     *
25059     * @ref calendar_example_05
25060     *
25061     * @ingroup Calendar
25062     */
25063    EAPI const char       **elm_calendar_weekdays_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25064
25065    /**
25066     * Set weekdays names to be displayed by the calendar.
25067     *
25068     * @param obj The calendar object.
25069     * @param weekdays Array of seven strings to be used as weekday names.
25070     * @warning It must have 7 elements, or it will access invalid memory.
25071     * @warning The strings must be NULL terminated ('@\0').
25072     *
25073     * By default, weekdays abbreviations get from system are displayed:
25074     * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
25075     *
25076     * The first string should be related to Sunday, the second to Monday...
25077     *
25078     * The usage should be like this:
25079     * @code
25080     *   const char *weekdays[] =
25081     *   {
25082     *      "Sunday", "Monday", "Tuesday", "Wednesday",
25083     *      "Thursday", "Friday", "Saturday"
25084     *   };
25085     *   elm_calendar_weekdays_names_set(calendar, weekdays);
25086     * @endcode
25087     *
25088     * @see elm_calendar_weekdays_name_get()
25089     *
25090     * @ref calendar_example_02
25091     *
25092     * @ingroup Calendar
25093     */
25094    EAPI void               elm_calendar_weekdays_names_set(Evas_Object *obj, const char *weekdays[]) EINA_ARG_NONNULL(1, 2);
25095
25096    /**
25097     * Set the minimum and maximum values for the year
25098     *
25099     * @param obj The calendar object
25100     * @param min The minimum year, greater than 1901;
25101     * @param max The maximum year;
25102     *
25103     * Maximum must be greater than minimum, except if you don't wan't to set
25104     * maximum year.
25105     * Default values are 1902 and -1.
25106     *
25107     * If the maximum year is a negative value, it will be limited depending
25108     * on the platform architecture (year 2037 for 32 bits);
25109     *
25110     * @see elm_calendar_min_max_year_get()
25111     *
25112     * @ref calendar_example_03
25113     *
25114     * @ingroup Calendar
25115     */
25116    EAPI void               elm_calendar_min_max_year_set(Evas_Object *obj, int min, int max) EINA_ARG_NONNULL(1);
25117
25118    /**
25119     * Get the minimum and maximum values for the year
25120     *
25121     * @param obj The calendar object.
25122     * @param min The minimum year.
25123     * @param max The maximum year.
25124     *
25125     * Default values are 1902 and -1.
25126     *
25127     * @see elm_calendar_min_max_year_get() for more details.
25128     *
25129     * @ref calendar_example_05
25130     *
25131     * @ingroup Calendar
25132     */
25133    EAPI void               elm_calendar_min_max_year_get(const Evas_Object *obj, int *min, int *max) EINA_ARG_NONNULL(1);
25134
25135    /**
25136     * Enable or disable day selection
25137     *
25138     * @param obj The calendar object.
25139     * @param enabled @c EINA_TRUE to enable selection or @c EINA_FALSE to
25140     * disable it.
25141     *
25142     * Enabled by default. If disabled, the user still can select months,
25143     * but not days. Selected days are highlighted on calendar.
25144     * It should be used if you won't need such selection for the widget usage.
25145     *
25146     * When a day is selected, or month is changed, smart callbacks for
25147     * signal "changed" will be called.
25148     *
25149     * @see elm_calendar_day_selection_enable_get()
25150     *
25151     * @ref calendar_example_04
25152     *
25153     * @ingroup Calendar
25154     */
25155    EAPI void               elm_calendar_day_selection_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
25156
25157    /**
25158     * Get a value whether day selection is enabled or not.
25159     *
25160     * @see elm_calendar_day_selection_enable_set() for details.
25161     *
25162     * @param obj The calendar object.
25163     * @return EINA_TRUE means day selection is enabled. EINA_FALSE indicates
25164     * it's disabled. If @p obj is NULL, EINA_FALSE is returned.
25165     *
25166     * @ref calendar_example_05
25167     *
25168     * @ingroup Calendar
25169     */
25170    EAPI Eina_Bool          elm_calendar_day_selection_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25171
25172
25173    /**
25174     * Set selected date to be highlighted on calendar.
25175     *
25176     * @param obj The calendar object.
25177     * @param selected_time A @b tm struct to represent the selected date.
25178     *
25179     * Set the selected date, changing the displayed month if needed.
25180     * Selected date changes when the user goes to next/previous month or
25181     * select a day pressing over it on calendar.
25182     *
25183     * @see elm_calendar_selected_time_get()
25184     *
25185     * @ref calendar_example_04
25186     *
25187     * @ingroup Calendar
25188     */
25189    EAPI void               elm_calendar_selected_time_set(Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1);
25190
25191    /**
25192     * Get selected date.
25193     *
25194     * @param obj The calendar object
25195     * @param selected_time A @b tm struct to point to selected date
25196     * @return EINA_FALSE means an error ocurred and returned time shouldn't
25197     * be considered.
25198     *
25199     * Get date selected by the user or set by function
25200     * elm_calendar_selected_time_set().
25201     * Selected date changes when the user goes to next/previous month or
25202     * select a day pressing over it on calendar.
25203     *
25204     * @see elm_calendar_selected_time_get()
25205     *
25206     * @ref calendar_example_05
25207     *
25208     * @ingroup Calendar
25209     */
25210    EAPI Eina_Bool          elm_calendar_selected_time_get(const Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1, 2);
25211
25212    /**
25213     * Set a function to format the string that will be used to display
25214     * month and year;
25215     *
25216     * @param obj The calendar object
25217     * @param format_function Function to set the month-year string given
25218     * the selected date
25219     *
25220     * By default it uses strftime with "%B %Y" format string.
25221     * It should allocate the memory that will be used by the string,
25222     * that will be freed by the widget after usage.
25223     * A pointer to the string and a pointer to the time struct will be provided.
25224     *
25225     * Example:
25226     * @code
25227     * static char *
25228     * _format_month_year(struct tm *selected_time)
25229     * {
25230     *    char buf[32];
25231     *    if (!strftime(buf, sizeof(buf), "%B %Y", selected_time)) return NULL;
25232     *    return strdup(buf);
25233     * }
25234     *
25235     * elm_calendar_format_function_set(calendar, _format_month_year);
25236     * @endcode
25237     *
25238     * @ref calendar_example_02
25239     *
25240     * @ingroup Calendar
25241     */
25242    EAPI void               elm_calendar_format_function_set(Evas_Object *obj, char * (*format_function) (struct tm *stime)) EINA_ARG_NONNULL(1);
25243
25244    /**
25245     * Add a new mark to the calendar
25246     *
25247     * @param obj The calendar object
25248     * @param mark_type A string used to define the type of mark. It will be
25249     * emitted to the theme, that should display a related modification on these
25250     * days representation.
25251     * @param mark_time A time struct to represent the date of inclusion of the
25252     * mark. For marks that repeats it will just be displayed after the inclusion
25253     * date in the calendar.
25254     * @param repeat Repeat the event following this periodicity. Can be a unique
25255     * mark (that don't repeat), daily, weekly, monthly or annually.
25256     * @return The created mark or @p NULL upon failure.
25257     *
25258     * Add a mark that will be drawn in the calendar respecting the insertion
25259     * time and periodicity. It will emit the type as signal to the widget theme.
25260     * Default theme supports "holiday" and "checked", but it can be extended.
25261     *
25262     * It won't immediately update the calendar, drawing the marks.
25263     * For this, call elm_calendar_marks_draw(). However, when user selects
25264     * next or previous month calendar forces marks drawn.
25265     *
25266     * Marks created with this method can be deleted with
25267     * elm_calendar_mark_del().
25268     *
25269     * Example
25270     * @code
25271     * struct tm selected_time;
25272     * time_t current_time;
25273     *
25274     * current_time = time(NULL) + 5 * 84600;
25275     * localtime_r(&current_time, &selected_time);
25276     * elm_calendar_mark_add(cal, "holiday", selected_time,
25277     *     ELM_CALENDAR_ANNUALLY);
25278     *
25279     * current_time = time(NULL) + 1 * 84600;
25280     * localtime_r(&current_time, &selected_time);
25281     * elm_calendar_mark_add(cal, "checked", selected_time, ELM_CALENDAR_UNIQUE);
25282     *
25283     * elm_calendar_marks_draw(cal);
25284     * @endcode
25285     *
25286     * @see elm_calendar_marks_draw()
25287     * @see elm_calendar_mark_del()
25288     *
25289     * @ref calendar_example_06
25290     *
25291     * @ingroup Calendar
25292     */
25293    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);
25294
25295    /**
25296     * Delete mark from the calendar.
25297     *
25298     * @param mark The mark to be deleted.
25299     *
25300     * If deleting all calendar marks is required, elm_calendar_marks_clear()
25301     * should be used instead of getting marks list and deleting each one.
25302     *
25303     * @see elm_calendar_mark_add()
25304     *
25305     * @ref calendar_example_06
25306     *
25307     * @ingroup Calendar
25308     */
25309    EAPI void               elm_calendar_mark_del(Elm_Calendar_Mark *mark) EINA_ARG_NONNULL(1);
25310
25311    /**
25312     * Remove all calendar's marks
25313     *
25314     * @param obj The calendar object.
25315     *
25316     * @see elm_calendar_mark_add()
25317     * @see elm_calendar_mark_del()
25318     *
25319     * @ingroup Calendar
25320     */
25321    EAPI void               elm_calendar_marks_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
25322
25323
25324    /**
25325     * Get a list of all the calendar marks.
25326     *
25327     * @param obj The calendar object.
25328     * @return An @c Eina_List of calendar marks objects, or @c NULL on failure.
25329     *
25330     * @see elm_calendar_mark_add()
25331     * @see elm_calendar_mark_del()
25332     * @see elm_calendar_marks_clear()
25333     *
25334     * @ingroup Calendar
25335     */
25336    EAPI const Eina_List   *elm_calendar_marks_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25337
25338    /**
25339     * Draw calendar marks.
25340     *
25341     * @param obj The calendar object.
25342     *
25343     * Should be used after adding, removing or clearing marks.
25344     * It will go through the entire marks list updating the calendar.
25345     * If lots of marks will be added, add all the marks and then call
25346     * this function.
25347     *
25348     * When the month is changed, i.e. user selects next or previous month,
25349     * marks will be drawed.
25350     *
25351     * @see elm_calendar_mark_add()
25352     * @see elm_calendar_mark_del()
25353     * @see elm_calendar_marks_clear()
25354     *
25355     * @ref calendar_example_06
25356     *
25357     * @ingroup Calendar
25358     */
25359    EAPI void               elm_calendar_marks_draw(Evas_Object *obj) EINA_ARG_NONNULL(1);
25360    EINA_DEPRECATED EAPI void               elm_calendar_text_saturday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25361    EINA_DEPRECATED EAPI void               elm_calendar_text_sunday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25362    EINA_DEPRECATED EAPI void               elm_calendar_text_weekday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25363
25364    /**
25365     * Set a day text color to the same that represents Saturdays.
25366     *
25367     * @param obj The calendar object.
25368     * @param pos The text position. Position is the cell counter, from left
25369     * to right, up to down. It starts on 0 and ends on 41.
25370     *
25371     * @deprecated use elm_calendar_mark_add() instead like:
25372     *
25373     * @code
25374     * struct tm t = { 0, 0, 12, 6, 0, 0, 6, 6, -1 };
25375     * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
25376     * @endcode
25377     *
25378     * @see elm_calendar_mark_add()
25379     *
25380     * @ingroup Calendar
25381     */
25382    EAPI void               elm_calendar_text_saturday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25383
25384    /**
25385     * Set a day text color to the same that represents Sundays.
25386     *
25387     * @param obj The calendar object.
25388     * @param pos The text position. Position is the cell counter, from left
25389     * to right, up to down. It starts on 0 and ends on 41.
25390
25391     * @deprecated use elm_calendar_mark_add() instead like:
25392     *
25393     * @code
25394     * struct tm t = { 0, 0, 12, 7, 0, 0, 0, 0, -1 };
25395     * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
25396     * @endcode
25397     *
25398     * @see elm_calendar_mark_add()
25399     *
25400     * @ingroup Calendar
25401     */
25402    EAPI void               elm_calendar_text_sunday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25403
25404    /**
25405     * Set a day text color to the same that represents Weekdays.
25406     *
25407     * @param obj The calendar object
25408     * @param pos The text position. Position is the cell counter, from left
25409     * to right, up to down. It starts on 0 and ends on 41.
25410     *
25411     * @deprecated use elm_calendar_mark_add() instead like:
25412     *
25413     * @code
25414     * struct tm t = { 0, 0, 12, 1, 0, 0, 0, 0, -1 };
25415     *
25416     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // monday
25417     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25418     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // tuesday
25419     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25420     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // wednesday
25421     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25422     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // thursday
25423     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25424     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // friday
25425     * @endcode
25426     *
25427     * @see elm_calendar_mark_add()
25428     *
25429     * @ingroup Calendar
25430     */
25431    EAPI void               elm_calendar_text_weekday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25432
25433    /**
25434     * Set the interval on time updates for an user mouse button hold
25435     * on calendar widgets' month selection.
25436     *
25437     * @param obj The calendar object
25438     * @param interval The (first) interval value in seconds
25439     *
25440     * This interval value is @b decreased while the user holds the
25441     * mouse pointer either selecting next or previous month.
25442     *
25443     * This helps the user to get to a given month distant from the
25444     * current one easier/faster, as it will start to change quicker and
25445     * quicker on mouse button holds.
25446     *
25447     * The calculation for the next change interval value, starting from
25448     * the one set with this call, is the previous interval divided by
25449     * 1.05, so it decreases a little bit.
25450     *
25451     * The default starting interval value for automatic changes is
25452     * @b 0.85 seconds.
25453     *
25454     * @see elm_calendar_interval_get()
25455     *
25456     * @ingroup Calendar
25457     */
25458    EAPI void               elm_calendar_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
25459
25460    /**
25461     * Get the interval on time updates for an user mouse button hold
25462     * on calendar widgets' month selection.
25463     *
25464     * @param obj The calendar object
25465     * @return The (first) interval value, in seconds, set on it
25466     *
25467     * @see elm_calendar_interval_set() for more details
25468     *
25469     * @ingroup Calendar
25470     */
25471    EAPI double             elm_calendar_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25472
25473    /**
25474     * @}
25475     */
25476
25477    /**
25478     * @defgroup Diskselector Diskselector
25479     * @ingroup Elementary
25480     *
25481     * @image html img/widget/diskselector/preview-00.png
25482     * @image latex img/widget/diskselector/preview-00.eps
25483     *
25484     * A diskselector is a kind of list widget. It scrolls horizontally,
25485     * and can contain label and icon objects. Three items are displayed
25486     * with the selected one in the middle.
25487     *
25488     * It can act like a circular list with round mode and labels can be
25489     * reduced for a defined length for side items.
25490     *
25491     * Smart callbacks one can listen to:
25492     * - "selected" - when item is selected, i.e. scroller stops.
25493     *
25494     * Available styles for it:
25495     * - @c "default"
25496     *
25497     * List of examples:
25498     * @li @ref diskselector_example_01
25499     * @li @ref diskselector_example_02
25500     */
25501
25502    /**
25503     * @addtogroup Diskselector
25504     * @{
25505     */
25506
25507    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(). */
25508
25509    /**
25510     * Add a new diskselector widget to the given parent Elementary
25511     * (container) object.
25512     *
25513     * @param parent The parent object.
25514     * @return a new diskselector widget handle or @c NULL, on errors.
25515     *
25516     * This function inserts a new diskselector widget on the canvas.
25517     *
25518     * @ingroup Diskselector
25519     */
25520    EAPI Evas_Object           *elm_diskselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25521
25522    /**
25523     * Enable or disable round mode.
25524     *
25525     * @param obj The diskselector object.
25526     * @param round @c EINA_TRUE to enable round mode or @c EINA_FALSE to
25527     * disable it.
25528     *
25529     * Disabled by default. If round mode is enabled the items list will
25530     * work like a circle list, so when the user reaches the last item,
25531     * the first one will popup.
25532     *
25533     * @see elm_diskselector_round_get()
25534     *
25535     * @ingroup Diskselector
25536     */
25537    EAPI void                   elm_diskselector_round_set(Evas_Object *obj, Eina_Bool round) EINA_ARG_NONNULL(1);
25538
25539    /**
25540     * Get a value whether round mode is enabled or not.
25541     *
25542     * @see elm_diskselector_round_set() for details.
25543     *
25544     * @param obj The diskselector object.
25545     * @return @c EINA_TRUE means round mode is enabled. @c EINA_FALSE indicates
25546     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
25547     *
25548     * @ingroup Diskselector
25549     */
25550    EAPI Eina_Bool              elm_diskselector_round_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25551
25552    /**
25553     * Get the side labels max length.
25554     *
25555     * @deprecated use elm_diskselector_side_label_length_get() instead:
25556     *
25557     * @param obj The diskselector object.
25558     * @return The max length defined for side labels, or 0 if not a valid
25559     * diskselector.
25560     *
25561     * @ingroup Diskselector
25562     */
25563    EINA_DEPRECATED EAPI int    elm_diskselector_side_label_lenght_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25564
25565    /**
25566     * Set the side labels max length.
25567     *
25568     * @deprecated use elm_diskselector_side_label_length_set() instead:
25569     *
25570     * @param obj The diskselector object.
25571     * @param len The max length defined for side labels.
25572     *
25573     * @ingroup Diskselector
25574     */
25575    EINA_DEPRECATED EAPI void   elm_diskselector_side_label_lenght_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
25576
25577    /**
25578     * Get the side labels max length.
25579     *
25580     * @see elm_diskselector_side_label_length_set() for details.
25581     *
25582     * @param obj The diskselector object.
25583     * @return The max length defined for side labels, or 0 if not a valid
25584     * diskselector.
25585     *
25586     * @ingroup Diskselector
25587     */
25588    EAPI int                    elm_diskselector_side_label_length_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25589
25590    /**
25591     * Set the side labels max length.
25592     *
25593     * @param obj The diskselector object.
25594     * @param len The max length defined for side labels.
25595     *
25596     * Length is the number of characters of items' label that will be
25597     * visible when it's set on side positions. It will just crop
25598     * the string after defined size. E.g.:
25599     *
25600     * An item with label "January" would be displayed on side position as
25601     * "Jan" if max length is set to 3, or "Janu", if this property
25602     * is set to 4.
25603     *
25604     * When it's selected, the entire label will be displayed, except for
25605     * width restrictions. In this case label will be cropped and "..."
25606     * will be concatenated.
25607     *
25608     * Default side label max length is 3.
25609     *
25610     * This property will be applyed over all items, included before or
25611     * later this function call.
25612     *
25613     * @ingroup Diskselector
25614     */
25615    EAPI void                   elm_diskselector_side_label_length_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
25616
25617    /**
25618     * Set the number of items to be displayed.
25619     *
25620     * @param obj The diskselector object.
25621     * @param num The number of items the diskselector will display.
25622     *
25623     * Default value is 3, and also it's the minimun. If @p num is less
25624     * than 3, it will be set to 3.
25625     *
25626     * Also, it can be set on theme, using data item @c display_item_num
25627     * on group "elm/diskselector/item/X", where X is style set.
25628     * E.g.:
25629     *
25630     * group { name: "elm/diskselector/item/X";
25631     * data {
25632     *     item: "display_item_num" "5";
25633     *     }
25634     *
25635     * @ingroup Diskselector
25636     */
25637    EAPI void                   elm_diskselector_display_item_num_set(Evas_Object *obj, int num) EINA_ARG_NONNULL(1);
25638
25639    /**
25640     * Get the number of items in the diskselector object.
25641     *
25642     * @param obj The diskselector object.
25643     *
25644     * @ingroup Diskselector
25645     */
25646    EAPI int                   elm_diskselector_display_item_num_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25647
25648    /**
25649     * Set bouncing behaviour when the scrolled content reaches an edge.
25650     *
25651     * Tell the internal scroller object whether it should bounce or not
25652     * when it reaches the respective edges for each axis.
25653     *
25654     * @param obj The diskselector object.
25655     * @param h_bounce Whether to bounce or not in the horizontal axis.
25656     * @param v_bounce Whether to bounce or not in the vertical axis.
25657     *
25658     * @see elm_scroller_bounce_set()
25659     *
25660     * @ingroup Diskselector
25661     */
25662    EAPI void                   elm_diskselector_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
25663
25664    /**
25665     * Get the bouncing behaviour of the internal scroller.
25666     *
25667     * Get whether the internal scroller should bounce when the edge of each
25668     * axis is reached scrolling.
25669     *
25670     * @param obj The diskselector object.
25671     * @param h_bounce Pointer where to store the bounce state of the horizontal
25672     * axis.
25673     * @param v_bounce Pointer where to store the bounce state of the vertical
25674     * axis.
25675     *
25676     * @see elm_scroller_bounce_get()
25677     * @see elm_diskselector_bounce_set()
25678     *
25679     * @ingroup Diskselector
25680     */
25681    EAPI void                   elm_diskselector_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
25682
25683    /**
25684     * Get the scrollbar policy.
25685     *
25686     * @see elm_diskselector_scroller_policy_get() for details.
25687     *
25688     * @param obj The diskselector object.
25689     * @param policy_h Pointer where to store horizontal scrollbar policy.
25690     * @param policy_v Pointer where to store vertical scrollbar policy.
25691     *
25692     * @ingroup Diskselector
25693     */
25694    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);
25695
25696    /**
25697     * Set the scrollbar policy.
25698     *
25699     * @param obj The diskselector object.
25700     * @param policy_h Horizontal scrollbar policy.
25701     * @param policy_v Vertical scrollbar policy.
25702     *
25703     * This sets the scrollbar visibility policy for the given scroller.
25704     * #ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it
25705     * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
25706     * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
25707     * This applies respectively for the horizontal and vertical scrollbars.
25708     *
25709     * The both are disabled by default, i.e., are set to
25710     * #ELM_SCROLLER_POLICY_OFF.
25711     *
25712     * @ingroup Diskselector
25713     */
25714    EAPI void                   elm_diskselector_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
25715
25716    /**
25717     * Remove all diskselector's items.
25718     *
25719     * @param obj The diskselector object.
25720     *
25721     * @see elm_diskselector_item_del()
25722     * @see elm_diskselector_item_append()
25723     *
25724     * @ingroup Diskselector
25725     */
25726    EAPI void                   elm_diskselector_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
25727
25728    /**
25729     * Get a list of all the diskselector items.
25730     *
25731     * @param obj The diskselector object.
25732     * @return An @c Eina_List of diskselector items, #Elm_Diskselector_Item,
25733     * or @c NULL on failure.
25734     *
25735     * @see elm_diskselector_item_append()
25736     * @see elm_diskselector_item_del()
25737     * @see elm_diskselector_clear()
25738     *
25739     * @ingroup Diskselector
25740     */
25741    EAPI const Eina_List       *elm_diskselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25742
25743    /**
25744     * Appends a new item to the diskselector object.
25745     *
25746     * @param obj The diskselector object.
25747     * @param label The label of the diskselector item.
25748     * @param icon The icon object to use at left side of the item. An
25749     * icon can be any Evas object, but usually it is an icon created
25750     * with elm_icon_add().
25751     * @param func The function to call when the item is selected.
25752     * @param data The data to associate with the item for related callbacks.
25753     *
25754     * @return The created item or @c NULL upon failure.
25755     *
25756     * A new item will be created and appended to the diskselector, i.e., will
25757     * be set as last item. Also, if there is no selected item, it will
25758     * be selected. This will always happens for the first appended item.
25759     *
25760     * If no icon is set, label will be centered on item position, otherwise
25761     * the icon will be placed at left of the label, that will be shifted
25762     * to the right.
25763     *
25764     * Items created with this method can be deleted with
25765     * elm_diskselector_item_del().
25766     *
25767     * Associated @p data can be properly freed when item is deleted if a
25768     * callback function is set with elm_diskselector_item_del_cb_set().
25769     *
25770     * If a function is passed as argument, it will be called everytime this item
25771     * is selected, i.e., the user stops the diskselector with this
25772     * item on center position. If such function isn't needed, just passing
25773     * @c NULL as @p func is enough. The same should be done for @p data.
25774     *
25775     * Simple example (with no function callback or data associated):
25776     * @code
25777     * disk = elm_diskselector_add(win);
25778     * ic = elm_icon_add(win);
25779     * elm_icon_file_set(ic, "path/to/image", NULL);
25780     * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
25781     * elm_diskselector_item_append(disk, "label", ic, NULL, NULL);
25782     * @endcode
25783     *
25784     * @see elm_diskselector_item_del()
25785     * @see elm_diskselector_item_del_cb_set()
25786     * @see elm_diskselector_clear()
25787     * @see elm_icon_add()
25788     *
25789     * @ingroup Diskselector
25790     */
25791    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);
25792
25793
25794    /**
25795     * Delete them item from the diskselector.
25796     *
25797     * @param it The item of diskselector to be deleted.
25798     *
25799     * If deleting all diskselector items is required, elm_diskselector_clear()
25800     * should be used instead of getting items list and deleting each one.
25801     *
25802     * @see elm_diskselector_clear()
25803     * @see elm_diskselector_item_append()
25804     * @see elm_diskselector_item_del_cb_set()
25805     *
25806     * @ingroup Diskselector
25807     */
25808    EAPI void                   elm_diskselector_item_del(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25809
25810    /**
25811     * Set the function called when a diskselector item is freed.
25812     *
25813     * @param it The item to set the callback on
25814     * @param func The function called
25815     *
25816     * If there is a @p func, then it will be called prior item's memory release.
25817     * That will be called with the following arguments:
25818     * @li item's data;
25819     * @li item's Evas object;
25820     * @li item itself;
25821     *
25822     * This way, a data associated to a diskselector item could be properly
25823     * freed.
25824     *
25825     * @ingroup Diskselector
25826     */
25827    EAPI void                   elm_diskselector_item_del_cb_set(Elm_Diskselector_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
25828
25829    /**
25830     * Get the data associated to the item.
25831     *
25832     * @param it The diskselector item
25833     * @return The data associated to @p it
25834     *
25835     * The return value is a pointer to data associated to @p item when it was
25836     * created, with function elm_diskselector_item_append(). If no data
25837     * was passed as argument, it will return @c NULL.
25838     *
25839     * @see elm_diskselector_item_append()
25840     *
25841     * @ingroup Diskselector
25842     */
25843    EAPI void                  *elm_diskselector_item_data_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25844
25845    /**
25846     * Set the icon associated to the item.
25847     *
25848     * @param it The diskselector item
25849     * @param icon The icon object to associate with @p it
25850     *
25851     * The icon object to use at left side of the item. An
25852     * icon can be any Evas object, but usually it is an icon created
25853     * with elm_icon_add().
25854     *
25855     * Once the icon object is set, a previously set one will be deleted.
25856     * @warning Setting the same icon for two items will cause the icon to
25857     * dissapear from the first item.
25858     *
25859     * If an icon was passed as argument on item creation, with function
25860     * elm_diskselector_item_append(), it will be already
25861     * associated to the item.
25862     *
25863     * @see elm_diskselector_item_append()
25864     * @see elm_diskselector_item_icon_get()
25865     *
25866     * @ingroup Diskselector
25867     */
25868    EAPI void                   elm_diskselector_item_icon_set(Elm_Diskselector_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
25869
25870    /**
25871     * Get the icon associated to the item.
25872     *
25873     * @param it The diskselector item
25874     * @return The icon associated to @p it
25875     *
25876     * The return value is a pointer to the icon associated to @p item when it was
25877     * created, with function elm_diskselector_item_append(), or later
25878     * with function elm_diskselector_item_icon_set. If no icon
25879     * was passed as argument, it will return @c NULL.
25880     *
25881     * @see elm_diskselector_item_append()
25882     * @see elm_diskselector_item_icon_set()
25883     *
25884     * @ingroup Diskselector
25885     */
25886    EAPI Evas_Object           *elm_diskselector_item_icon_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25887
25888    /**
25889     * Set the label of item.
25890     *
25891     * @param it The item of diskselector.
25892     * @param label The label of item.
25893     *
25894     * The label to be displayed by the item.
25895     *
25896     * If no icon is set, label will be centered on item position, otherwise
25897     * the icon will be placed at left of the label, that will be shifted
25898     * to the right.
25899     *
25900     * An item with label "January" would be displayed on side position as
25901     * "Jan" if max length is set to 3 with function
25902     * elm_diskselector_side_label_lenght_set(), or "Janu", if this property
25903     * is set to 4.
25904     *
25905     * When this @p item is selected, the entire label will be displayed,
25906     * except for width restrictions.
25907     * In this case label will be cropped and "..." will be concatenated,
25908     * but only for display purposes. It will keep the entire string, so
25909     * if diskselector is resized the remaining characters will be displayed.
25910     *
25911     * If a label was passed as argument on item creation, with function
25912     * elm_diskselector_item_append(), it will be already
25913     * displayed by the item.
25914     *
25915     * @see elm_diskselector_side_label_lenght_set()
25916     * @see elm_diskselector_item_label_get()
25917     * @see elm_diskselector_item_append()
25918     *
25919     * @ingroup Diskselector
25920     */
25921    EAPI void                   elm_diskselector_item_label_set(Elm_Diskselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
25922
25923    /**
25924     * Get the label of item.
25925     *
25926     * @param it The item of diskselector.
25927     * @return The label of item.
25928     *
25929     * The return value is a pointer to the label associated to @p item when it was
25930     * created, with function elm_diskselector_item_append(), or later
25931     * with function elm_diskselector_item_label_set. If no label
25932     * was passed as argument, it will return @c NULL.
25933     *
25934     * @see elm_diskselector_item_label_set() for more details.
25935     * @see elm_diskselector_item_append()
25936     *
25937     * @ingroup Diskselector
25938     */
25939    EAPI const char            *elm_diskselector_item_label_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
25940
25941    /**
25942     * Get the selected item.
25943     *
25944     * @param obj The diskselector object.
25945     * @return The selected diskselector item.
25946     *
25947     * The selected item can be unselected with function
25948     * elm_diskselector_item_selected_set(), and the first item of
25949     * diskselector will be selected.
25950     *
25951     * The selected item always will be centered on diskselector, with
25952     * full label displayed, i.e., max lenght set to side labels won't
25953     * apply on the selected item. More details on
25954     * elm_diskselector_side_label_length_set().
25955     *
25956     * @ingroup Diskselector
25957     */
25958    EAPI Elm_Diskselector_Item *elm_diskselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25959
25960    /**
25961     * Set the selected state of an item.
25962     *
25963     * @param it The diskselector item
25964     * @param selected The selected state
25965     *
25966     * This sets the selected state of the given item @p it.
25967     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
25968     *
25969     * If a new item is selected the previosly selected will be unselected.
25970     * Previoulsy selected item can be get with function
25971     * elm_diskselector_selected_item_get().
25972     *
25973     * If the item @p it is unselected, the first item of diskselector will
25974     * be selected.
25975     *
25976     * Selected items will be visible on center position of diskselector.
25977     * So if it was on another position before selected, or was invisible,
25978     * diskselector will animate items until the selected item reaches center
25979     * position.
25980     *
25981     * @see elm_diskselector_item_selected_get()
25982     * @see elm_diskselector_selected_item_get()
25983     *
25984     * @ingroup Diskselector
25985     */
25986    EAPI void                   elm_diskselector_item_selected_set(Elm_Diskselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
25987
25988    /*
25989     * Get whether the @p item is selected or not.
25990     *
25991     * @param it The diskselector item.
25992     * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
25993     * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
25994     *
25995     * @see elm_diskselector_selected_item_set() for details.
25996     * @see elm_diskselector_item_selected_get()
25997     *
25998     * @ingroup Diskselector
25999     */
26000    EAPI Eina_Bool              elm_diskselector_item_selected_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26001
26002    /**
26003     * Get the first item of the diskselector.
26004     *
26005     * @param obj The diskselector object.
26006     * @return The first item, or @c NULL if none.
26007     *
26008     * The list of items follows append order. So it will return the first
26009     * item appended to the widget that wasn't deleted.
26010     *
26011     * @see elm_diskselector_item_append()
26012     * @see elm_diskselector_items_get()
26013     *
26014     * @ingroup Diskselector
26015     */
26016    EAPI Elm_Diskselector_Item *elm_diskselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26017
26018    /**
26019     * Get the last item of the diskselector.
26020     *
26021     * @param obj The diskselector object.
26022     * @return The last item, or @c NULL if none.
26023     *
26024     * The list of items follows append order. So it will return last first
26025     * item appended to the widget that wasn't deleted.
26026     *
26027     * @see elm_diskselector_item_append()
26028     * @see elm_diskselector_items_get()
26029     *
26030     * @ingroup Diskselector
26031     */
26032    EAPI Elm_Diskselector_Item *elm_diskselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26033
26034    /**
26035     * Get the item before @p item in diskselector.
26036     *
26037     * @param it The diskselector item.
26038     * @return The item before @p item, or @c NULL if none or on failure.
26039     *
26040     * The list of items follows append order. So it will return item appended
26041     * just before @p item and that wasn't deleted.
26042     *
26043     * If it is the first item, @c NULL will be returned.
26044     * First item can be get by elm_diskselector_first_item_get().
26045     *
26046     * @see elm_diskselector_item_append()
26047     * @see elm_diskselector_items_get()
26048     *
26049     * @ingroup Diskselector
26050     */
26051    EAPI Elm_Diskselector_Item *elm_diskselector_item_prev_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26052
26053    /**
26054     * Get the item after @p item in diskselector.
26055     *
26056     * @param it The diskselector item.
26057     * @return The item after @p item, or @c NULL if none or on failure.
26058     *
26059     * The list of items follows append order. So it will return item appended
26060     * just after @p item and that wasn't deleted.
26061     *
26062     * If it is the last item, @c NULL will be returned.
26063     * Last item can be get by elm_diskselector_last_item_get().
26064     *
26065     * @see elm_diskselector_item_append()
26066     * @see elm_diskselector_items_get()
26067     *
26068     * @ingroup Diskselector
26069     */
26070    EAPI Elm_Diskselector_Item *elm_diskselector_item_next_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26071
26072    /**
26073     * Set the text to be shown in the diskselector item.
26074     *
26075     * @param item Target item
26076     * @param text The text to set in the content
26077     *
26078     * Setup the text as tooltip to object. The item can have only one tooltip,
26079     * so any previous tooltip data is removed.
26080     *
26081     * @see elm_object_tooltip_text_set() for more details.
26082     *
26083     * @ingroup Diskselector
26084     */
26085    EAPI void                   elm_diskselector_item_tooltip_text_set(Elm_Diskselector_Item *item, const char *text) EINA_ARG_NONNULL(1);
26086
26087    /**
26088     * Set the content to be shown in the tooltip item.
26089     *
26090     * Setup the tooltip to item. The item can have only one tooltip,
26091     * so any previous tooltip data is removed. @p func(with @p data) will
26092     * be called every time that need show the tooltip and it should
26093     * return a valid Evas_Object. This object is then managed fully by
26094     * tooltip system and is deleted when the tooltip is gone.
26095     *
26096     * @param item the diskselector item being attached a tooltip.
26097     * @param func the function used to create the tooltip contents.
26098     * @param data what to provide to @a func as callback data/context.
26099     * @param del_cb called when data is not needed anymore, either when
26100     *        another callback replaces @p func, the tooltip is unset with
26101     *        elm_diskselector_item_tooltip_unset() or the owner @a item
26102     *        dies. This callback receives as the first parameter the
26103     *        given @a data, and @c event_info is the item.
26104     *
26105     * @see elm_object_tooltip_content_cb_set() for more details.
26106     *
26107     * @ingroup Diskselector
26108     */
26109    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);
26110
26111    /**
26112     * Unset tooltip from item.
26113     *
26114     * @param item diskselector item to remove previously set tooltip.
26115     *
26116     * Remove tooltip from item. The callback provided as del_cb to
26117     * elm_diskselector_item_tooltip_content_cb_set() will be called to notify
26118     * it is not used anymore.
26119     *
26120     * @see elm_object_tooltip_unset() for more details.
26121     * @see elm_diskselector_item_tooltip_content_cb_set()
26122     *
26123     * @ingroup Diskselector
26124     */
26125    EAPI void                   elm_diskselector_item_tooltip_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26126
26127
26128    /**
26129     * Sets a different style for this item tooltip.
26130     *
26131     * @note before you set a style you should define a tooltip with
26132     *       elm_diskselector_item_tooltip_content_cb_set() or
26133     *       elm_diskselector_item_tooltip_text_set()
26134     *
26135     * @param item diskselector item with tooltip already set.
26136     * @param style the theme style to use (default, transparent, ...)
26137     *
26138     * @see elm_object_tooltip_style_set() for more details.
26139     *
26140     * @ingroup Diskselector
26141     */
26142    EAPI void                   elm_diskselector_item_tooltip_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
26143
26144    /**
26145     * Get the style for this item tooltip.
26146     *
26147     * @param item diskselector item with tooltip already set.
26148     * @return style the theme style in use, defaults to "default". If the
26149     *         object does not have a tooltip set, then NULL is returned.
26150     *
26151     * @see elm_object_tooltip_style_get() for more details.
26152     * @see elm_diskselector_item_tooltip_style_set()
26153     *
26154     * @ingroup Diskselector
26155     */
26156    EAPI const char            *elm_diskselector_item_tooltip_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26157
26158    /**
26159     * Set the cursor to be shown when mouse is over the diskselector item
26160     *
26161     * @param item Target item
26162     * @param cursor the cursor name to be used.
26163     *
26164     * @see elm_object_cursor_set() for more details.
26165     *
26166     * @ingroup Diskselector
26167     */
26168    EAPI void                   elm_diskselector_item_cursor_set(Elm_Diskselector_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
26169
26170    /**
26171     * Get the cursor to be shown when mouse is over the diskselector item
26172     *
26173     * @param item diskselector item with cursor already set.
26174     * @return the cursor name.
26175     *
26176     * @see elm_object_cursor_get() for more details.
26177     * @see elm_diskselector_cursor_set()
26178     *
26179     * @ingroup Diskselector
26180     */
26181    EAPI const char            *elm_diskselector_item_cursor_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26182
26183
26184    /**
26185     * Unset the cursor to be shown when mouse is over the diskselector item
26186     *
26187     * @param item Target item
26188     *
26189     * @see elm_object_cursor_unset() for more details.
26190     * @see elm_diskselector_cursor_set()
26191     *
26192     * @ingroup Diskselector
26193     */
26194    EAPI void                   elm_diskselector_item_cursor_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26195
26196    /**
26197     * Sets a different style for this item cursor.
26198     *
26199     * @note before you set a style you should define a cursor with
26200     *       elm_diskselector_item_cursor_set()
26201     *
26202     * @param item diskselector item with cursor already set.
26203     * @param style the theme style to use (default, transparent, ...)
26204     *
26205     * @see elm_object_cursor_style_set() for more details.
26206     *
26207     * @ingroup Diskselector
26208     */
26209    EAPI void                   elm_diskselector_item_cursor_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
26210
26211
26212    /**
26213     * Get the style for this item cursor.
26214     *
26215     * @param item diskselector item with cursor already set.
26216     * @return style the theme style in use, defaults to "default". If the
26217     *         object does not have a cursor set, then @c NULL is returned.
26218     *
26219     * @see elm_object_cursor_style_get() for more details.
26220     * @see elm_diskselector_item_cursor_style_set()
26221     *
26222     * @ingroup Diskselector
26223     */
26224    EAPI const char            *elm_diskselector_item_cursor_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26225
26226
26227    /**
26228     * Set if the cursor set should be searched on the theme or should use
26229     * the provided by the engine, only.
26230     *
26231     * @note before you set if should look on theme you should define a cursor
26232     * with elm_diskselector_item_cursor_set().
26233     * By default it will only look for cursors provided by the engine.
26234     *
26235     * @param item widget item with cursor already set.
26236     * @param engine_only boolean to define if cursors set with
26237     * elm_diskselector_item_cursor_set() should be searched only
26238     * between cursors provided by the engine or searched on widget's
26239     * theme as well.
26240     *
26241     * @see elm_object_cursor_engine_only_set() for more details.
26242     *
26243     * @ingroup Diskselector
26244     */
26245    EAPI void                   elm_diskselector_item_cursor_engine_only_set(Elm_Diskselector_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
26246
26247    /**
26248     * Get the cursor engine only usage for this item cursor.
26249     *
26250     * @param item widget item with cursor already set.
26251     * @return engine_only boolean to define it cursors should be looked only
26252     * between the provided by the engine or searched on widget's theme as well.
26253     * If the item does not have a cursor set, then @c EINA_FALSE is returned.
26254     *
26255     * @see elm_object_cursor_engine_only_get() for more details.
26256     * @see elm_diskselector_item_cursor_engine_only_set()
26257     *
26258     * @ingroup Diskselector
26259     */
26260    EAPI Eina_Bool              elm_diskselector_item_cursor_engine_only_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26261
26262    /**
26263     * @}
26264     */
26265
26266    /**
26267     * @defgroup Colorselector Colorselector
26268     *
26269     * @{
26270     *
26271     * @image html img/widget/colorselector/preview-00.png
26272     * @image latex img/widget/colorselector/preview-00.eps
26273     *
26274     * @brief Widget for user to select a color.
26275     *
26276     * Signals that you can add callbacks for are:
26277     * "changed" - When the color value changes(event_info is NULL).
26278     *
26279     * See @ref tutorial_colorselector.
26280     */
26281    /**
26282     * @brief Add a new colorselector to the parent
26283     *
26284     * @param parent The parent object
26285     * @return The new object or NULL if it cannot be created
26286     *
26287     * @ingroup Colorselector
26288     */
26289    EAPI Evas_Object *elm_colorselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26290    /**
26291     * Set a color for the colorselector
26292     *
26293     * @param obj   Colorselector object
26294     * @param r     r-value of color
26295     * @param g     g-value of color
26296     * @param b     b-value of color
26297     * @param a     a-value of color
26298     *
26299     * @ingroup Colorselector
26300     */
26301    EAPI void         elm_colorselector_color_set(Evas_Object *obj, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
26302    /**
26303     * Get a color from the colorselector
26304     *
26305     * @param obj   Colorselector object
26306     * @param r     integer pointer for r-value of color
26307     * @param g     integer pointer for g-value of color
26308     * @param b     integer pointer for b-value of color
26309     * @param a     integer pointer for a-value of color
26310     *
26311     * @ingroup Colorselector
26312     */
26313    EAPI void         elm_colorselector_color_get(const Evas_Object *obj, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
26314    /**
26315     * @}
26316     */
26317
26318    /**
26319     * @defgroup Ctxpopup Ctxpopup
26320     *
26321     * @image html img/widget/ctxpopup/preview-00.png
26322     * @image latex img/widget/ctxpopup/preview-00.eps
26323     *
26324     * @brief Context popup widet.
26325     *
26326     * A ctxpopup is a widget that, when shown, pops up a list of items.
26327     * It automatically chooses an area inside its parent object's view
26328     * (set via elm_ctxpopup_add() and elm_ctxpopup_hover_parent_set()) to
26329     * optimally fit into it. In the default theme, it will also point an
26330     * arrow to it's top left position at the time one shows it. Ctxpopup
26331     * items have a label and/or an icon. It is intended for a small
26332     * number of items (hence the use of list, not genlist).
26333     *
26334     * @note Ctxpopup is a especialization of @ref Hover.
26335     *
26336     * Signals that you can add callbacks for are:
26337     * "dismissed" - the ctxpopup was dismissed
26338     *
26339     * Default contents parts of the ctxpopup widget that you can use for are:
26340     * @li "elm.swallow.content" - A content of the ctxpopup
26341     *
26342     * @ref tutorial_ctxpopup shows the usage of a good deal of the API.
26343     * @{
26344     */
26345    typedef enum _Elm_Ctxpopup_Direction
26346      {
26347         ELM_CTXPOPUP_DIRECTION_DOWN, /**< ctxpopup show appear below clicked
26348                                           area */
26349         ELM_CTXPOPUP_DIRECTION_RIGHT, /**< ctxpopup show appear to the right of
26350                                            the clicked area */
26351         ELM_CTXPOPUP_DIRECTION_LEFT, /**< ctxpopup show appear to the left of
26352                                           the clicked area */
26353         ELM_CTXPOPUP_DIRECTION_UP, /**< ctxpopup show appear above the clicked
26354                                         area */
26355         ELM_CTXPOPUP_DIRECTION_UNKNOWN, /**< ctxpopup does not determine it's direction yet*/
26356      } Elm_Ctxpopup_Direction;
26357 #define Elm_Ctxpopup_Item Elm_Object_Item
26358
26359    /**
26360     * @brief Add a new Ctxpopup object to the parent.
26361     *
26362     * @param parent Parent object
26363     * @return New object or @c NULL, if it cannot be created
26364     */
26365    EAPI Evas_Object  *elm_ctxpopup_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26366    /**
26367     * @brief Set the Ctxpopup's parent
26368     *
26369     * @param obj The ctxpopup object
26370     * @param area The parent to use
26371     *
26372     * Set the parent object.
26373     *
26374     * @note elm_ctxpopup_add() will automatically call this function
26375     * with its @c parent argument.
26376     *
26377     * @see elm_ctxpopup_add()
26378     * @see elm_hover_parent_set()
26379     */
26380    EAPI void          elm_ctxpopup_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1, 2);
26381    /**
26382     * @brief Get the Ctxpopup's parent
26383     *
26384     * @param obj The ctxpopup object
26385     *
26386     * @see elm_ctxpopup_hover_parent_set() for more information
26387     */
26388    EAPI Evas_Object  *elm_ctxpopup_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26389    /**
26390     * @brief Clear all items in the given ctxpopup object.
26391     *
26392     * @param obj Ctxpopup object
26393     */
26394    EAPI void          elm_ctxpopup_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
26395    /**
26396     * @brief Change the ctxpopup's orientation to horizontal or vertical.
26397     *
26398     * @param obj Ctxpopup object
26399     * @param horizontal @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical
26400     */
26401    EAPI void          elm_ctxpopup_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
26402    /**
26403     * @brief Get the value of current ctxpopup object's orientation.
26404     *
26405     * @param obj Ctxpopup object
26406     * @return @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical mode (or errors)
26407     *
26408     * @see elm_ctxpopup_horizontal_set()
26409     */
26410    EAPI Eina_Bool     elm_ctxpopup_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26411    /**
26412     * @brief Add a new item to a ctxpopup object.
26413     *
26414     * @param obj Ctxpopup object
26415     * @param icon Icon to be set on new item
26416     * @param label The Label of the new item
26417     * @param func Convenience function called when item selected
26418     * @param data Data passed to @p func
26419     * @return A handle to the item added or @c NULL, on errors
26420     *
26421     * @warning Ctxpopup can't hold both an item list and a content at the same
26422     * time. When an item is added, any previous content will be removed.
26423     *
26424     * @see elm_ctxpopup_content_set()
26425     */
26426    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);
26427    /**
26428     * @brief Delete the given item in a ctxpopup object.
26429     *
26430     * @param it Ctxpopup item to be deleted
26431     *
26432     * @see elm_ctxpopup_item_append()
26433     */
26434    EAPI void          elm_ctxpopup_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26435    /**
26436     * @brief Set the ctxpopup item's state as disabled or enabled.
26437     *
26438     * @param it Ctxpopup item to be enabled/disabled
26439     * @param disabled @c EINA_TRUE to disable it, @c EINA_FALSE to enable it
26440     *
26441     * When disabled the item is greyed out to indicate it's state.
26442     */
26443    EAPI void          elm_ctxpopup_item_disabled_set(Elm_Object_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
26444    /**
26445     * @brief Get the ctxpopup item's disabled/enabled state.
26446     *
26447     * @param it Ctxpopup item to be enabled/disabled
26448     * @return disabled @c EINA_TRUE, if disabled, @c EINA_FALSE otherwise
26449     *
26450     * @see elm_ctxpopup_item_disabled_set()
26451     */
26452    EAPI Eina_Bool     elm_ctxpopup_item_disabled_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26453    /**
26454     * @brief Get the icon object for the given ctxpopup item.
26455     *
26456     * @param it Ctxpopup item
26457     * @return icon object or @c NULL, if the item does not have icon or an error
26458     * occurred
26459     *
26460     * @see elm_ctxpopup_item_append()
26461     * @see elm_ctxpopup_item_icon_set()
26462     */
26463    EAPI Evas_Object  *elm_ctxpopup_item_icon_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26464    /**
26465     * @brief Sets the side icon associated with the ctxpopup item
26466     *
26467     * @param it Ctxpopup item
26468     * @param icon Icon object to be set
26469     *
26470     * Once the icon object is set, a previously set one will be deleted.
26471     * @warning Setting the same icon for two items will cause the icon to
26472     * dissapear from the first item.
26473     *
26474     * @see elm_ctxpopup_item_append()
26475     */
26476    EAPI void          elm_ctxpopup_item_icon_set(Elm_Object_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
26477    /**
26478     * @brief Get the label for the given ctxpopup item.
26479     *
26480     * @param it Ctxpopup item
26481     * @return label string or @c NULL, if the item does not have label or an
26482     * error occured
26483     *
26484     * @see elm_ctxpopup_item_append()
26485     * @see elm_ctxpopup_item_label_set()
26486     */
26487    EAPI const char   *elm_ctxpopup_item_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26488    /**
26489     * @brief (Re)set the label on the given ctxpopup item.
26490     *
26491     * @param it Ctxpopup item
26492     * @param label String to set as label
26493     */
26494    EAPI void          elm_ctxpopup_item_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
26495    /**
26496     * @brief Set an elm widget as the content of the ctxpopup.
26497     *
26498     * @param obj Ctxpopup object
26499     * @param content Content to be swallowed
26500     *
26501     * If the content object is already set, a previous one will bedeleted. If
26502     * you want to keep that old content object, use the
26503     * elm_ctxpopup_content_unset() function.
26504     *
26505     * @deprecated use elm_object_content_set()
26506     *
26507     * @warning Ctxpopup can't hold both a item list and a content at the same
26508     * time. When a content is set, any previous items will be removed.
26509     */
26510    EAPI void          elm_ctxpopup_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1, 2);
26511    /**
26512     * @brief Unset the ctxpopup content
26513     *
26514     * @param obj Ctxpopup object
26515     * @return The content that was being used
26516     *
26517     * Unparent and return the content object which was set for this widget.
26518     *
26519     * @deprecated use elm_object_content_unset()
26520     *
26521     * @see elm_ctxpopup_content_set()
26522     */
26523    EAPI Evas_Object  *elm_ctxpopup_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
26524    /**
26525     * @brief Set the direction priority of a ctxpopup.
26526     *
26527     * @param obj Ctxpopup object
26528     * @param first 1st priority of direction
26529     * @param second 2nd priority of direction
26530     * @param third 3th priority of direction
26531     * @param fourth 4th priority of direction
26532     *
26533     * This functions gives a chance to user to set the priority of ctxpopup
26534     * showing direction. This doesn't guarantee the ctxpopup will appear in the
26535     * requested direction.
26536     *
26537     * @see Elm_Ctxpopup_Direction
26538     */
26539    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);
26540    /**
26541     * @brief Get the direction priority of a ctxpopup.
26542     *
26543     * @param obj Ctxpopup object
26544     * @param first 1st priority of direction to be returned
26545     * @param second 2nd priority of direction to be returned
26546     * @param third 3th priority of direction to be returned
26547     * @param fourth 4th priority of direction to be returned
26548     *
26549     * @see elm_ctxpopup_direction_priority_set() for more information.
26550     */
26551    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);
26552
26553    /**
26554     * @brief Get the current direction of a ctxpopup.
26555     *
26556     * @param obj Ctxpopup object
26557     * @return current direction of a ctxpopup
26558     *
26559     * @warning Once the ctxpopup showed up, the direction would be determined
26560     */
26561    EAPI Elm_Ctxpopup_Direction elm_ctxpopup_direction_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26562
26563    /**
26564     * @}
26565     */
26566
26567    /* transit */
26568    /**
26569     *
26570     * @defgroup Transit Transit
26571     * @ingroup Elementary
26572     *
26573     * Transit is designed to apply various animated transition effects to @c
26574     * Evas_Object, such like translation, rotation, etc. For using these
26575     * effects, create an @ref Elm_Transit and add the desired transition effects.
26576     *
26577     * Once the effects are added into transit, they will be automatically
26578     * managed (their callback will be called until the duration is ended, and
26579     * they will be deleted on completion).
26580     *
26581     * Example:
26582     * @code
26583     * Elm_Transit *trans = elm_transit_add();
26584     * elm_transit_object_add(trans, obj);
26585     * elm_transit_effect_translation_add(trans, 0, 0, 280, 280
26586     * elm_transit_duration_set(transit, 1);
26587     * elm_transit_auto_reverse_set(transit, EINA_TRUE);
26588     * elm_transit_tween_mode_set(transit, ELM_TRANSIT_TWEEN_MODE_DECELERATE);
26589     * elm_transit_repeat_times_set(transit, 3);
26590     * @endcode
26591     *
26592     * Some transition effects are used to change the properties of objects. They
26593     * are:
26594     * @li @ref elm_transit_effect_translation_add
26595     * @li @ref elm_transit_effect_color_add
26596     * @li @ref elm_transit_effect_rotation_add
26597     * @li @ref elm_transit_effect_wipe_add
26598     * @li @ref elm_transit_effect_zoom_add
26599     * @li @ref elm_transit_effect_resizing_add
26600     *
26601     * Other transition effects are used to make one object disappear and another
26602     * object appear on its old place. These effects are:
26603     *
26604     * @li @ref elm_transit_effect_flip_add
26605     * @li @ref elm_transit_effect_resizable_flip_add
26606     * @li @ref elm_transit_effect_fade_add
26607     * @li @ref elm_transit_effect_blend_add
26608     *
26609     * It's also possible to make a transition chain with @ref
26610     * elm_transit_chain_transit_add.
26611     *
26612     * @warning We strongly recommend to use elm_transit just when edje can not do
26613     * the trick. Edje has more advantage than Elm_Transit, it has more flexibility and
26614     * animations can be manipulated inside the theme.
26615     *
26616     * List of examples:
26617     * @li @ref transit_example_01_explained
26618     * @li @ref transit_example_02_explained
26619     * @li @ref transit_example_03_c
26620     * @li @ref transit_example_04_c
26621     *
26622     * @{
26623     */
26624
26625    /**
26626     * @enum Elm_Transit_Tween_Mode
26627     *
26628     * The type of acceleration used in the transition.
26629     */
26630    typedef enum
26631      {
26632         ELM_TRANSIT_TWEEN_MODE_LINEAR, /**< Constant speed */
26633         ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL, /**< Starts slow, increase speed
26634                                              over time, then decrease again
26635                                              and stop slowly */
26636         ELM_TRANSIT_TWEEN_MODE_DECELERATE, /**< Starts fast and decrease
26637                                              speed over time */
26638         ELM_TRANSIT_TWEEN_MODE_ACCELERATE /**< Starts slow and increase speed
26639                                             over time */
26640      } Elm_Transit_Tween_Mode;
26641
26642    /**
26643     * @enum Elm_Transit_Effect_Flip_Axis
26644     *
26645     * The axis where flip effect should be applied.
26646     */
26647    typedef enum
26648      {
26649         ELM_TRANSIT_EFFECT_FLIP_AXIS_X, /**< Flip on X axis */
26650         ELM_TRANSIT_EFFECT_FLIP_AXIS_Y /**< Flip on Y axis */
26651      } Elm_Transit_Effect_Flip_Axis;
26652    /**
26653     * @enum Elm_Transit_Effect_Wipe_Dir
26654     *
26655     * The direction where the wipe effect should occur.
26656     */
26657    typedef enum
26658      {
26659         ELM_TRANSIT_EFFECT_WIPE_DIR_LEFT, /**< Wipe to the left */
26660         ELM_TRANSIT_EFFECT_WIPE_DIR_RIGHT, /**< Wipe to the right */
26661         ELM_TRANSIT_EFFECT_WIPE_DIR_UP, /**< Wipe up */
26662         ELM_TRANSIT_EFFECT_WIPE_DIR_DOWN /**< Wipe down */
26663      } Elm_Transit_Effect_Wipe_Dir;
26664    /** @enum Elm_Transit_Effect_Wipe_Type
26665     *
26666     * Whether the wipe effect should show or hide the object.
26667     */
26668    typedef enum
26669      {
26670         ELM_TRANSIT_EFFECT_WIPE_TYPE_HIDE, /**< Hide the object during the
26671                                              animation */
26672         ELM_TRANSIT_EFFECT_WIPE_TYPE_SHOW /**< Show the object during the
26673                                             animation */
26674      } Elm_Transit_Effect_Wipe_Type;
26675
26676    /**
26677     * @typedef Elm_Transit
26678     *
26679     * The Transit created with elm_transit_add(). This type has the information
26680     * about the objects which the transition will be applied, and the
26681     * transition effects that will be used. It also contains info about
26682     * duration, number of repetitions, auto-reverse, etc.
26683     */
26684    typedef struct _Elm_Transit Elm_Transit;
26685    typedef void Elm_Transit_Effect;
26686    /**
26687     * @typedef Elm_Transit_Effect_Transition_Cb
26688     *
26689     * Transition callback called for this effect on each transition iteration.
26690     */
26691    typedef void (*Elm_Transit_Effect_Transition_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit, double progress);
26692    /**
26693     * Elm_Transit_Effect_End_Cb
26694     *
26695     * Transition callback called for this effect when the transition is over.
26696     */
26697    typedef void (*Elm_Transit_Effect_End_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit);
26698
26699    /**
26700     * Elm_Transit_Del_Cb
26701     *
26702     * A callback called when the transit is deleted.
26703     */
26704    typedef void (*Elm_Transit_Del_Cb) (void *data, Elm_Transit *transit);
26705
26706    /**
26707     * Add new transit.
26708     *
26709     * @note Is not necessary to delete the transit object, it will be deleted at
26710     * the end of its operation.
26711     * @note The transit will start playing when the program enter in the main loop, is not
26712     * necessary to give a start to the transit.
26713     *
26714     * @return The transit object.
26715     *
26716     * @ingroup Transit
26717     */
26718    EAPI Elm_Transit                *elm_transit_add(void);
26719
26720    /**
26721     * Stops the animation and delete the @p transit object.
26722     *
26723     * Call this function if you wants to stop the animation before the duration
26724     * time. Make sure the @p transit object is still alive with
26725     * elm_transit_del_cb_set() function.
26726     * All added effects will be deleted, calling its repective data_free_cb
26727     * functions. The function setted by elm_transit_del_cb_set() will be called.
26728     *
26729     * @see elm_transit_del_cb_set()
26730     *
26731     * @param transit The transit object to be deleted.
26732     *
26733     * @ingroup Transit
26734     * @warning Just call this function if you are sure the transit is alive.
26735     */
26736    EAPI void                        elm_transit_del(Elm_Transit *transit) EINA_ARG_NONNULL(1);
26737
26738    /**
26739     * Add a new effect to the transit.
26740     *
26741     * @note The cb function and the data are the key to the effect. If you try to
26742     * add an already added effect, nothing is done.
26743     * @note After the first addition of an effect in @p transit, if its
26744     * effect list become empty again, the @p transit will be killed by
26745     * elm_transit_del(transit) function.
26746     *
26747     * Exemple:
26748     * @code
26749     * Elm_Transit *transit = elm_transit_add();
26750     * elm_transit_effect_add(transit,
26751     *                        elm_transit_effect_blend_op,
26752     *                        elm_transit_effect_blend_context_new(),
26753     *                        elm_transit_effect_blend_context_free);
26754     * @endcode
26755     *
26756     * @param transit The transit object.
26757     * @param transition_cb The operation function. It is called when the
26758     * animation begins, it is the function that actually performs the animation.
26759     * It is called with the @p data, @p transit and the time progression of the
26760     * animation (a double value between 0.0 and 1.0).
26761     * @param effect The context data of the effect.
26762     * @param end_cb The function to free the context data, it will be called
26763     * at the end of the effect, it must finalize the animation and free the
26764     * @p data.
26765     *
26766     * @ingroup Transit
26767     * @warning The transit free the context data at the and of the transition with
26768     * the data_free_cb function, do not use the context data in another transit.
26769     */
26770    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);
26771
26772    /**
26773     * Delete an added effect.
26774     *
26775     * This function will remove the effect from the @p transit, calling the
26776     * data_free_cb to free the @p data.
26777     *
26778     * @see elm_transit_effect_add()
26779     *
26780     * @note If the effect is not found, nothing is done.
26781     * @note If the effect list become empty, this function will call
26782     * elm_transit_del(transit), that is, it will kill the @p transit.
26783     *
26784     * @param transit The transit object.
26785     * @param transition_cb The operation function.
26786     * @param effect The context data of the effect.
26787     *
26788     * @ingroup Transit
26789     */
26790    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);
26791
26792    /**
26793     * Add new object to apply the effects.
26794     *
26795     * @note After the first addition of an object in @p transit, if its
26796     * object list become empty again, the @p transit will be killed by
26797     * elm_transit_del(transit) function.
26798     * @note If the @p obj belongs to another transit, the @p obj will be
26799     * removed from it and it will only belong to the @p transit. If the old
26800     * transit stays without objects, it will die.
26801     * @note When you add an object into the @p transit, its state from
26802     * evas_object_pass_events_get(obj) is saved, and it is applied when the
26803     * transit ends, if you change this state whith evas_object_pass_events_set()
26804     * after add the object, this state will change again when @p transit stops to
26805     * run.
26806     *
26807     * @param transit The transit object.
26808     * @param obj Object to be animated.
26809     *
26810     * @ingroup Transit
26811     * @warning It is not allowed to add a new object after transit begins to go.
26812     */
26813    EAPI void                        elm_transit_object_add(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
26814
26815    /**
26816     * Removes an added object from the transit.
26817     *
26818     * @note If the @p obj is not in the @p transit, nothing is done.
26819     * @note If the list become empty, this function will call
26820     * elm_transit_del(transit), that is, it will kill the @p transit.
26821     *
26822     * @param transit The transit object.
26823     * @param obj Object to be removed from @p transit.
26824     *
26825     * @ingroup Transit
26826     * @warning It is not allowed to remove objects after transit begins to go.
26827     */
26828    EAPI void                        elm_transit_object_remove(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
26829
26830    /**
26831     * Get the objects of the transit.
26832     *
26833     * @param transit The transit object.
26834     * @return a Eina_List with the objects from the transit.
26835     *
26836     * @ingroup Transit
26837     */
26838    EAPI const Eina_List            *elm_transit_objects_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26839
26840    /**
26841     * Enable/disable keeping up the objects states.
26842     * If it is not kept, the objects states will be reset when transition ends.
26843     *
26844     * @note @p transit can not be NULL.
26845     * @note One state includes geometry, color, map data.
26846     *
26847     * @param transit The transit object.
26848     * @param state_keep Keeping or Non Keeping.
26849     *
26850     * @ingroup Transit
26851     */
26852    EAPI void                        elm_transit_objects_final_state_keep_set(Elm_Transit *transit, Eina_Bool state_keep) EINA_ARG_NONNULL(1);
26853
26854    /**
26855     * Get a value whether the objects states will be reset or not.
26856     *
26857     * @note @p transit can not be NULL
26858     *
26859     * @see elm_transit_objects_final_state_keep_set()
26860     *
26861     * @param transit The transit object.
26862     * @return EINA_TRUE means the states of the objects will be reset.
26863     * If @p transit is NULL, EINA_FALSE is returned
26864     *
26865     * @ingroup Transit
26866     */
26867    EAPI Eina_Bool                   elm_transit_objects_final_state_keep_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26868
26869    /**
26870     * Set the event enabled when transit is operating.
26871     *
26872     * If @p enabled is EINA_TRUE, the objects of the transit will receives
26873     * events from mouse and keyboard during the animation.
26874     * @note When you add an object with elm_transit_object_add(), its state from
26875     * evas_object_pass_events_get(obj) is saved, and it is applied when the
26876     * transit ends, if you change this state with evas_object_pass_events_set()
26877     * after adding the object, this state will change again when @p transit stops
26878     * to run.
26879     *
26880     * @param transit The transit object.
26881     * @param enabled Events are received when enabled is @c EINA_TRUE, and
26882     * ignored otherwise.
26883     *
26884     * @ingroup Transit
26885     */
26886    EAPI void                        elm_transit_event_enabled_set(Elm_Transit *transit, Eina_Bool enabled) EINA_ARG_NONNULL(1);
26887
26888    /**
26889     * Get the value of event enabled status.
26890     *
26891     * @see elm_transit_event_enabled_set()
26892     *
26893     * @param transit The Transit object
26894     * @return EINA_TRUE, when event is enabled. If @p transit is NULL
26895     * EINA_FALSE is returned
26896     *
26897     * @ingroup Transit
26898     */
26899    EAPI Eina_Bool                   elm_transit_event_enabled_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26900
26901    /**
26902     * Set the user-callback function when the transit is deleted.
26903     *
26904     * @note Using this function twice will overwrite the first function setted.
26905     * @note the @p transit object will be deleted after call @p cb function.
26906     *
26907     * @param transit The transit object.
26908     * @param cb Callback function pointer. This function will be called before
26909     * the deletion of the transit.
26910     * @param data Callback funtion user data. It is the @p op parameter.
26911     *
26912     * @ingroup Transit
26913     */
26914    EAPI void                        elm_transit_del_cb_set(Elm_Transit *transit, Elm_Transit_Del_Cb cb, void *data) EINA_ARG_NONNULL(1);
26915
26916    /**
26917     * Set reverse effect automatically.
26918     *
26919     * If auto reverse is setted, after running the effects with the progress
26920     * parameter from 0 to 1, it will call the effecs again with the progress
26921     * from 1 to 0. The transit will last for a time iqual to (2 * duration * repeat),
26922     * where the duration was setted with the function elm_transit_add and
26923     * the repeat with the function elm_transit_repeat_times_set().
26924     *
26925     * @param transit The transit object.
26926     * @param reverse EINA_TRUE means the auto_reverse is on.
26927     *
26928     * @ingroup Transit
26929     */
26930    EAPI void                        elm_transit_auto_reverse_set(Elm_Transit *transit, Eina_Bool reverse) EINA_ARG_NONNULL(1);
26931
26932    /**
26933     * Get if the auto reverse is on.
26934     *
26935     * @see elm_transit_auto_reverse_set()
26936     *
26937     * @param transit The transit object.
26938     * @return EINA_TRUE means auto reverse is on. If @p transit is NULL
26939     * EINA_FALSE is returned
26940     *
26941     * @ingroup Transit
26942     */
26943    EAPI Eina_Bool                   elm_transit_auto_reverse_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26944
26945    /**
26946     * Set the transit repeat count. Effect will be repeated by repeat count.
26947     *
26948     * This function sets the number of repetition the transit will run after
26949     * the first one, that is, if @p repeat is 1, the transit will run 2 times.
26950     * If the @p repeat is a negative number, it will repeat infinite times.
26951     *
26952     * @note If this function is called during the transit execution, the transit
26953     * will run @p repeat times, ignoring the times it already performed.
26954     *
26955     * @param transit The transit object
26956     * @param repeat Repeat count
26957     *
26958     * @ingroup Transit
26959     */
26960    EAPI void                        elm_transit_repeat_times_set(Elm_Transit *transit, int repeat) EINA_ARG_NONNULL(1);
26961
26962    /**
26963     * Get the transit repeat count.
26964     *
26965     * @see elm_transit_repeat_times_set()
26966     *
26967     * @param transit The Transit object.
26968     * @return The repeat count. If @p transit is NULL
26969     * 0 is returned
26970     *
26971     * @ingroup Transit
26972     */
26973    EAPI int                         elm_transit_repeat_times_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
26974
26975    /**
26976     * Set the transit animation acceleration type.
26977     *
26978     * This function sets the tween mode of the transit that can be:
26979     * ELM_TRANSIT_TWEEN_MODE_LINEAR - The default mode.
26980     * ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL - Starts in accelerate mode and ends decelerating.
26981     * ELM_TRANSIT_TWEEN_MODE_DECELERATE - The animation will be slowed over time.
26982     * ELM_TRANSIT_TWEEN_MODE_ACCELERATE - The animation will accelerate over time.
26983     *
26984     * @param transit The transit object.
26985     * @param tween_mode The tween type.
26986     *
26987     * @ingroup Transit
26988     */
26989    EAPI void                        elm_transit_tween_mode_set(Elm_Transit *transit, Elm_Transit_Tween_Mode tween_mode) EINA_ARG_NONNULL(1);
26990
26991    /**
26992     * Get the transit animation acceleration type.
26993     *
26994     * @note @p transit can not be NULL
26995     *
26996     * @param transit The transit object.
26997     * @return The tween type. If @p transit is NULL
26998     * ELM_TRANSIT_TWEEN_MODE_LINEAR is returned.
26999     *
27000     * @ingroup Transit
27001     */
27002    EAPI Elm_Transit_Tween_Mode      elm_transit_tween_mode_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27003
27004    /**
27005     * Set the transit animation time
27006     *
27007     * @note @p transit can not be NULL
27008     *
27009     * @param transit The transit object.
27010     * @param duration The animation time.
27011     *
27012     * @ingroup Transit
27013     */
27014    EAPI void                        elm_transit_duration_set(Elm_Transit *transit, double duration) EINA_ARG_NONNULL(1);
27015
27016    /**
27017     * Get the transit animation time
27018     *
27019     * @note @p transit can not be NULL
27020     *
27021     * @param transit The transit object.
27022     *
27023     * @return The transit animation time.
27024     *
27025     * @ingroup Transit
27026     */
27027    EAPI double                      elm_transit_duration_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27028
27029    /**
27030     * Starts the transition.
27031     * Once this API is called, the transit begins to measure the time.
27032     *
27033     * @note @p transit can not be NULL
27034     *
27035     * @param transit The transit object.
27036     *
27037     * @ingroup Transit
27038     */
27039    EAPI void                        elm_transit_go(Elm_Transit *transit) EINA_ARG_NONNULL(1);
27040
27041    /**
27042     * Pause/Resume the transition.
27043     *
27044     * If you call elm_transit_go again, the transit will be started from the
27045     * beginning, and will be unpaused.
27046     *
27047     * @note @p transit can not be NULL
27048     *
27049     * @param transit The transit object.
27050     * @param paused Whether the transition should be paused or not.
27051     *
27052     * @ingroup Transit
27053     */
27054    EAPI void                        elm_transit_paused_set(Elm_Transit *transit, Eina_Bool paused) EINA_ARG_NONNULL(1);
27055
27056    /**
27057     * Get the value of paused status.
27058     *
27059     * @see elm_transit_paused_set()
27060     *
27061     * @note @p transit can not be NULL
27062     *
27063     * @param transit The transit object.
27064     * @return EINA_TRUE means transition is paused. If @p transit is NULL
27065     * EINA_FALSE is returned
27066     *
27067     * @ingroup Transit
27068     */
27069    EAPI Eina_Bool                   elm_transit_paused_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27070
27071    /**
27072     * Get the time progression of the animation (a double value between 0.0 and 1.0).
27073     *
27074     * The value returned is a fraction (current time / total time). It
27075     * represents the progression position relative to the total.
27076     *
27077     * @note @p transit can not be NULL
27078     *
27079     * @param transit The transit object.
27080     *
27081     * @return The time progression value. If @p transit is NULL
27082     * 0 is returned
27083     *
27084     * @ingroup Transit
27085     */
27086    EAPI double                      elm_transit_progress_value_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27087
27088    /**
27089     * Makes the chain relationship between two transits.
27090     *
27091     * @note @p transit can not be NULL. Transit would have multiple chain transits.
27092     * @note @p chain_transit can not be NULL. Chain transits could be chained to the only one transit.
27093     *
27094     * @param transit The transit object.
27095     * @param chain_transit The chain transit object. This transit will be operated
27096     *        after transit is done.
27097     *
27098     * This function adds @p chain_transit transition to a chain after the @p
27099     * transit, and will be started as soon as @p transit ends. See @ref
27100     * transit_example_02_explained for a full example.
27101     *
27102     * @ingroup Transit
27103     */
27104    EAPI void                        elm_transit_chain_transit_add(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1, 2);
27105
27106    /**
27107     * Cut off the chain relationship between two transits.
27108     *
27109     * @note @p transit can not be NULL. Transit would have the chain relationship with @p chain transit.
27110     * @note @p chain_transit can not be NULL. Chain transits should be chained to the @p transit.
27111     *
27112     * @param transit The transit object.
27113     * @param chain_transit The chain transit object.
27114     *
27115     * This function remove the @p chain_transit transition from the @p transit.
27116     *
27117     * @ingroup Transit
27118     */
27119    EAPI void                        elm_transit_chain_transit_del(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1,2);
27120
27121    /**
27122     * Get the current chain transit list.
27123     *
27124     * @note @p transit can not be NULL.
27125     *
27126     * @param transit The transit object.
27127     * @return chain transit list.
27128     *
27129     * @ingroup Transit
27130     */
27131    EAPI Eina_List                  *elm_transit_chain_transits_get(const Elm_Transit *transit);
27132
27133    /**
27134     * Add the Resizing Effect to Elm_Transit.
27135     *
27136     * @note This API is one of the facades. It creates resizing effect context
27137     * and add it's required APIs to elm_transit_effect_add.
27138     *
27139     * @see elm_transit_effect_add()
27140     *
27141     * @param transit Transit object.
27142     * @param from_w Object width size when effect begins.
27143     * @param from_h Object height size when effect begins.
27144     * @param to_w Object width size when effect ends.
27145     * @param to_h Object height size when effect ends.
27146     * @return Resizing effect context data.
27147     *
27148     * @ingroup Transit
27149     */
27150    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);
27151
27152    /**
27153     * Add the Translation Effect to Elm_Transit.
27154     *
27155     * @note This API is one of the facades. It creates translation effect context
27156     * and add it's required APIs to elm_transit_effect_add.
27157     *
27158     * @see elm_transit_effect_add()
27159     *
27160     * @param transit Transit object.
27161     * @param from_dx X Position variation when effect begins.
27162     * @param from_dy Y Position variation when effect begins.
27163     * @param to_dx X Position variation when effect ends.
27164     * @param to_dy Y Position variation when effect ends.
27165     * @return Translation effect context data.
27166     *
27167     * @ingroup Transit
27168     * @warning It is highly recommended just create a transit with this effect when
27169     * the window that the objects of the transit belongs has already been created.
27170     * This is because this effect needs the geometry information about the objects,
27171     * and if the window was not created yet, it can get a wrong information.
27172     */
27173    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);
27174
27175    /**
27176     * Add the Zoom Effect to Elm_Transit.
27177     *
27178     * @note This API is one of the facades. It creates zoom effect context
27179     * and add it's required APIs to elm_transit_effect_add.
27180     *
27181     * @see elm_transit_effect_add()
27182     *
27183     * @param transit Transit object.
27184     * @param from_rate Scale rate when effect begins (1 is current rate).
27185     * @param to_rate Scale rate when effect ends.
27186     * @return Zoom effect context data.
27187     *
27188     * @ingroup Transit
27189     * @warning It is highly recommended just create a transit with this effect when
27190     * the window that the objects of the transit belongs has already been created.
27191     * This is because this effect needs the geometry information about the objects,
27192     * and if the window was not created yet, it can get a wrong information.
27193     */
27194    EAPI Elm_Transit_Effect *elm_transit_effect_zoom_add(Elm_Transit *transit, float from_rate, float to_rate);
27195
27196    /**
27197     * Add the Flip Effect to Elm_Transit.
27198     *
27199     * @note This API is one of the facades. It creates flip effect context
27200     * and add it's required APIs to elm_transit_effect_add.
27201     * @note This effect is applied to each pair of objects in the order they are listed
27202     * in the transit list of objects. The first object in the pair will be the
27203     * "front" object and the second will be the "back" object.
27204     *
27205     * @see elm_transit_effect_add()
27206     *
27207     * @param transit Transit object.
27208     * @param axis Flipping Axis(X or Y).
27209     * @param cw Flipping Direction. EINA_TRUE is clock-wise.
27210     * @return Flip effect context data.
27211     *
27212     * @ingroup Transit
27213     * @warning It is highly recommended just create a transit with this effect when
27214     * the window that the objects of the transit belongs has already been created.
27215     * This is because this effect needs the geometry information about the objects,
27216     * and if the window was not created yet, it can get a wrong information.
27217     */
27218    EAPI Elm_Transit_Effect *elm_transit_effect_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
27219
27220    /**
27221     * Add the Resizable Flip Effect to Elm_Transit.
27222     *
27223     * @note This API is one of the facades. It creates resizable flip effect context
27224     * and add it's required APIs to elm_transit_effect_add.
27225     * @note This effect is applied to each pair of objects in the order they are listed
27226     * in the transit list of objects. The first object in the pair will be the
27227     * "front" object and the second will be the "back" object.
27228     *
27229     * @see elm_transit_effect_add()
27230     *
27231     * @param transit Transit object.
27232     * @param axis Flipping Axis(X or Y).
27233     * @param cw Flipping Direction. EINA_TRUE is clock-wise.
27234     * @return Resizable flip effect context data.
27235     *
27236     * @ingroup Transit
27237     * @warning It is highly recommended just create a transit with this effect when
27238     * the window that the objects of the transit belongs has already been created.
27239     * This is because this effect needs the geometry information about the objects,
27240     * and if the window was not created yet, it can get a wrong information.
27241     */
27242    EAPI Elm_Transit_Effect *elm_transit_effect_resizable_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
27243
27244    /**
27245     * Add the Wipe Effect to Elm_Transit.
27246     *
27247     * @note This API is one of the facades. It creates wipe effect context
27248     * and add it's required APIs to elm_transit_effect_add.
27249     *
27250     * @see elm_transit_effect_add()
27251     *
27252     * @param transit Transit object.
27253     * @param type Wipe type. Hide or show.
27254     * @param dir Wipe Direction.
27255     * @return Wipe effect context data.
27256     *
27257     * @ingroup Transit
27258     * @warning It is highly recommended just create a transit with this effect when
27259     * the window that the objects of the transit belongs has already been created.
27260     * This is because this effect needs the geometry information about the objects,
27261     * and if the window was not created yet, it can get a wrong information.
27262     */
27263    EAPI Elm_Transit_Effect *elm_transit_effect_wipe_add(Elm_Transit *transit, Elm_Transit_Effect_Wipe_Type type, Elm_Transit_Effect_Wipe_Dir dir);
27264
27265    /**
27266     * Add the Color Effect to Elm_Transit.
27267     *
27268     * @note This API is one of the facades. It creates color effect context
27269     * and add it's required APIs to elm_transit_effect_add.
27270     *
27271     * @see elm_transit_effect_add()
27272     *
27273     * @param transit        Transit object.
27274     * @param  from_r        RGB R when effect begins.
27275     * @param  from_g        RGB G when effect begins.
27276     * @param  from_b        RGB B when effect begins.
27277     * @param  from_a        RGB A when effect begins.
27278     * @param  to_r          RGB R when effect ends.
27279     * @param  to_g          RGB G when effect ends.
27280     * @param  to_b          RGB B when effect ends.
27281     * @param  to_a          RGB A when effect ends.
27282     * @return               Color effect context data.
27283     *
27284     * @ingroup Transit
27285     */
27286    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);
27287
27288    /**
27289     * Add the Fade Effect to Elm_Transit.
27290     *
27291     * @note This API is one of the facades. It creates fade effect context
27292     * and add it's required APIs to elm_transit_effect_add.
27293     * @note This effect is applied to each pair of objects in the order they are listed
27294     * in the transit list of objects. The first object in the pair will be the
27295     * "before" object and the second will be the "after" object.
27296     *
27297     * @see elm_transit_effect_add()
27298     *
27299     * @param transit Transit object.
27300     * @return Fade effect context data.
27301     *
27302     * @ingroup Transit
27303     * @warning It is highly recommended just create a transit with this effect when
27304     * the window that the objects of the transit belongs has already been created.
27305     * This is because this effect needs the color information about the objects,
27306     * and if the window was not created yet, it can get a wrong information.
27307     */
27308    EAPI Elm_Transit_Effect *elm_transit_effect_fade_add(Elm_Transit *transit);
27309
27310    /**
27311     * Add the Blend Effect to Elm_Transit.
27312     *
27313     * @note This API is one of the facades. It creates blend effect context
27314     * and add it's required APIs to elm_transit_effect_add.
27315     * @note This effect is applied to each pair of objects in the order they are listed
27316     * in the transit list of objects. The first object in the pair will be the
27317     * "before" object and the second will be the "after" object.
27318     *
27319     * @see elm_transit_effect_add()
27320     *
27321     * @param transit Transit object.
27322     * @return Blend effect context data.
27323     *
27324     * @ingroup Transit
27325     * @warning It is highly recommended just create a transit with this effect when
27326     * the window that the objects of the transit belongs has already been created.
27327     * This is because this effect needs the color information about the objects,
27328     * and if the window was not created yet, it can get a wrong information.
27329     */
27330    EAPI Elm_Transit_Effect *elm_transit_effect_blend_add(Elm_Transit *transit);
27331
27332    /**
27333     * Add the Rotation Effect to Elm_Transit.
27334     *
27335     * @note This API is one of the facades. It creates rotation effect context
27336     * and add it's required APIs to elm_transit_effect_add.
27337     *
27338     * @see elm_transit_effect_add()
27339     *
27340     * @param transit Transit object.
27341     * @param from_degree Degree when effect begins.
27342     * @param to_degree Degree when effect is ends.
27343     * @return Rotation effect context data.
27344     *
27345     * @ingroup Transit
27346     * @warning It is highly recommended just create a transit with this effect when
27347     * the window that the objects of the transit belongs has already been created.
27348     * This is because this effect needs the geometry information about the objects,
27349     * and if the window was not created yet, it can get a wrong information.
27350     */
27351    EAPI Elm_Transit_Effect *elm_transit_effect_rotation_add(Elm_Transit *transit, float from_degree, float to_degree);
27352
27353    /**
27354     * Add the ImageAnimation Effect to Elm_Transit.
27355     *
27356     * @note This API is one of the facades. It creates image animation effect context
27357     * and add it's required APIs to elm_transit_effect_add.
27358     * The @p images parameter is a list images paths. This list and
27359     * its contents will be deleted at the end of the effect by
27360     * elm_transit_effect_image_animation_context_free() function.
27361     *
27362     * Example:
27363     * @code
27364     * char buf[PATH_MAX];
27365     * Eina_List *images = NULL;
27366     * Elm_Transit *transi = elm_transit_add();
27367     *
27368     * snprintf(buf, sizeof(buf), "%s/images/icon_11.png", PACKAGE_DATA_DIR);
27369     * images = eina_list_append(images, eina_stringshare_add(buf));
27370     *
27371     * snprintf(buf, sizeof(buf), "%s/images/logo_small.png", PACKAGE_DATA_DIR);
27372     * images = eina_list_append(images, eina_stringshare_add(buf));
27373     * elm_transit_effect_image_animation_add(transi, images);
27374     *
27375     * @endcode
27376     *
27377     * @see elm_transit_effect_add()
27378     *
27379     * @param transit Transit object.
27380     * @param images Eina_List of images file paths. This list and
27381     * its contents will be deleted at the end of the effect by
27382     * elm_transit_effect_image_animation_context_free() function.
27383     * @return Image Animation effect context data.
27384     *
27385     * @ingroup Transit
27386     */
27387    EAPI Elm_Transit_Effect *elm_transit_effect_image_animation_add(Elm_Transit *transit, Eina_List *images);
27388    /**
27389     * @}
27390     */
27391
27392    /* Store */
27393    typedef struct _Elm_Store                      Elm_Store;
27394    typedef struct _Elm_Store_DBsystem             Elm_Store_DBsystem;
27395    typedef struct _Elm_Store_Filesystem           Elm_Store_Filesystem;
27396    typedef struct _Elm_Store_Item                 Elm_Store_Item;
27397    typedef struct _Elm_Store_Item_DBsystem        Elm_Store_Item_DBsystem;
27398    typedef struct _Elm_Store_Item_Filesystem      Elm_Store_Item_Filesystem;
27399    typedef struct _Elm_Store_Item_Info            Elm_Store_Item_Info;
27400    typedef struct _Elm_Store_Item_Info_Filesystem Elm_Store_Item_Info_Filesystem;
27401    typedef struct _Elm_Store_Item_Mapping         Elm_Store_Item_Mapping;
27402    typedef struct _Elm_Store_Item_Mapping_Empty   Elm_Store_Item_Mapping_Empty;
27403    typedef struct _Elm_Store_Item_Mapping_Icon    Elm_Store_Item_Mapping_Icon;
27404    typedef struct _Elm_Store_Item_Mapping_Photo   Elm_Store_Item_Mapping_Photo;
27405    typedef struct _Elm_Store_Item_Mapping_Custom  Elm_Store_Item_Mapping_Custom;
27406
27407    typedef Eina_Bool (*Elm_Store_Item_List_Cb) (void *data, Elm_Store_Item_Info *info);
27408    typedef void      (*Elm_Store_Item_Fetch_Cb) (void *data, Elm_Store_Item *sti, Elm_Store_Item_Info *info);
27409    typedef void      (*Elm_Store_Item_Unfetch_Cb) (void *data, Elm_Store_Item *sti, Elm_Store_Item_Info *info);
27410    typedef void      (*Elm_Store_Item_Select_Cb) (void *data, Elm_Store_Item *sti);
27411    typedef int       (*Elm_Store_Item_Sort_Cb) (void *data, Elm_Store_Item_Info *info1, Elm_Store_Item_Info *info2);
27412    typedef void      (*Elm_Store_Item_Free_Cb) (void *data, Elm_Store_Item_Info *info);
27413    typedef void     *(*Elm_Store_Item_Mapping_Cb) (void *data, Elm_Store_Item *sti, const char *part);
27414
27415    typedef enum
27416      {
27417         ELM_STORE_ITEM_MAPPING_NONE = 0,
27418         ELM_STORE_ITEM_MAPPING_LABEL, // const char * -> label
27419         ELM_STORE_ITEM_MAPPING_STATE, // Eina_Bool -> state
27420         ELM_STORE_ITEM_MAPPING_ICON, // char * -> icon path
27421         ELM_STORE_ITEM_MAPPING_PHOTO, // char * -> photo path
27422         ELM_STORE_ITEM_MAPPING_CUSTOM, // item->custom(it->data, it, part) -> void * (-> any)
27423         // can add more here as needed by common apps
27424         ELM_STORE_ITEM_MAPPING_LAST
27425      } Elm_Store_Item_Mapping_Type;
27426
27427    struct _Elm_Store_Item_Mapping_Icon
27428      {
27429         // FIXME: allow edje file icons
27430         int                   w, h;
27431         Elm_Icon_Lookup_Order lookup_order;
27432         Eina_Bool             standard_name : 1;
27433         Eina_Bool             no_scale : 1;
27434         Eina_Bool             smooth : 1;
27435         Eina_Bool             scale_up : 1;
27436         Eina_Bool             scale_down : 1;
27437      };
27438
27439    struct _Elm_Store_Item_Mapping_Empty
27440      {
27441         Eina_Bool             dummy;
27442      };
27443
27444    struct _Elm_Store_Item_Mapping_Photo
27445      {
27446         int                   size;
27447      };
27448
27449    struct _Elm_Store_Item_Mapping_Custom
27450      {
27451         Elm_Store_Item_Mapping_Cb func;
27452      };
27453
27454    struct _Elm_Store_Item_Mapping
27455      {
27456         Elm_Store_Item_Mapping_Type     type;
27457         const char                     *part;
27458         int                             offset;
27459         union
27460           {
27461              Elm_Store_Item_Mapping_Empty  empty;
27462              Elm_Store_Item_Mapping_Icon   icon;
27463              Elm_Store_Item_Mapping_Photo  photo;
27464              Elm_Store_Item_Mapping_Custom custom;
27465              // add more types here
27466           } details;
27467      };
27468
27469    struct _Elm_Store_Item_Info
27470      {
27471         int                           index;
27472         int                           item_type;
27473         int                           group_index;
27474         Eina_Bool                     rec_item;
27475         int                           pre_group_index;
27476
27477         Elm_Genlist_Item_Class       *item_class;
27478         const Elm_Store_Item_Mapping *mapping;
27479         void                         *data;
27480         char                         *sort_id;
27481      };
27482
27483    struct _Elm_Store_Item_Info_Filesystem
27484      {
27485         Elm_Store_Item_Info  base;
27486         char                *path;
27487      };
27488
27489 #define ELM_STORE_ITEM_MAPPING_END { ELM_STORE_ITEM_MAPPING_NONE, NULL, 0, { .empty = { EINA_TRUE } } }
27490 #define ELM_STORE_ITEM_MAPPING_OFFSET(st, it) offsetof(st, it)
27491
27492    EAPI Elm_Store              *elm_store_dbsystem_new(void);
27493    EAPI void                    elm_store_item_count_set(Elm_Store *st, int count) EINA_ARG_NONNULL(1);
27494    EAPI void                    elm_store_item_select_func_set(Elm_Store *st, Elm_Store_Item_Select_Cb func, const void *data) EINA_ARG_NONNULL(1);
27495    EAPI void                    elm_store_item_sort_func_set(Elm_Store *st, Elm_Store_Item_Sort_Cb func, const void *data) EINA_ARG_NONNULL(1);
27496    EAPI void                    elm_store_item_free_func_set(Elm_Store *st, Elm_Store_Item_Free_Cb func, const void *data) EINA_ARG_NONNULL(1);
27497    EAPI int                     elm_store_item_data_index_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27498    EAPI void                   *elm_store_dbsystem_db_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27499    EAPI void                    elm_store_dbsystem_db_set(Elm_Store *store, void *pDB) EINA_ARG_NONNULL(1);
27500    EAPI int                     elm_store_item_index_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27501    EAPI Elm_Store_Item         *elm_store_item_add(Elm_Store *st, Elm_Store_Item_Info *info) EINA_ARG_NONNULL(1);
27502    EAPI void                    elm_store_item_update(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27503    EAPI void                    elm_store_visible_items_update(Elm_Store *st) EINA_ARG_NONNULL(1);
27504    EAPI void                    elm_store_item_del(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27505    EAPI void                    elm_store_free(Elm_Store *st);
27506    EAPI Elm_Store              *elm_store_filesystem_new(void);
27507    EAPI void                    elm_store_filesystem_directory_set(Elm_Store *st, const char *dir) EINA_ARG_NONNULL(1);
27508    EAPI const char             *elm_store_filesystem_directory_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27509    EAPI const char             *elm_store_item_filesystem_path_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27510
27511    EAPI void                    elm_store_target_genlist_set(Elm_Store *st, Evas_Object *obj) EINA_ARG_NONNULL(1);
27512
27513    EAPI void                    elm_store_cache_set(Elm_Store *st, int max) EINA_ARG_NONNULL(1);
27514    EAPI int                     elm_store_cache_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27515    EAPI void                    elm_store_list_func_set(Elm_Store *st, Elm_Store_Item_List_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
27516    EAPI void                    elm_store_fetch_func_set(Elm_Store *st, Elm_Store_Item_Fetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
27517    EAPI void                    elm_store_fetch_thread_set(Elm_Store *st, Eina_Bool use_thread) EINA_ARG_NONNULL(1);
27518    EAPI Eina_Bool               elm_store_fetch_thread_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27519
27520    EAPI void                    elm_store_unfetch_func_set(Elm_Store *st, Elm_Store_Item_Unfetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
27521    EAPI void                    elm_store_sorted_set(Elm_Store *st, Eina_Bool sorted) EINA_ARG_NONNULL(1);
27522    EAPI Eina_Bool               elm_store_sorted_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27523    EAPI void                    elm_store_item_data_set(Elm_Store_Item *sti, void *data) EINA_ARG_NONNULL(1);
27524    EAPI void                   *elm_store_item_data_get(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27525    EAPI const Elm_Store        *elm_store_item_store_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27526    EAPI const Elm_Genlist_Item *elm_store_item_genlist_item_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27527
27528    /**
27529     * @defgroup SegmentControl SegmentControl
27530     * @ingroup Elementary
27531     *
27532     * @image html img/widget/segment_control/preview-00.png
27533     * @image latex img/widget/segment_control/preview-00.eps width=\textwidth
27534     *
27535     * @image html img/segment_control.png
27536     * @image latex img/segment_control.eps width=\textwidth
27537     *
27538     * Segment control widget is a horizontal control made of multiple segment
27539     * items, each segment item functioning similar to discrete two state button.
27540     * A segment control groups the items together and provides compact
27541     * single button with multiple equal size segments.
27542     *
27543     * Segment item size is determined by base widget
27544     * size and the number of items added.
27545     * Only one segment item can be at selected state. A segment item can display
27546     * combination of Text and any Evas_Object like Images or other widget.
27547     *
27548     * Smart callbacks one can listen to:
27549     * - "changed" - When the user clicks on a segment item which is not
27550     *   previously selected and get selected. The event_info parameter is the
27551     *   segment item pointer.
27552     *
27553     * Available styles for it:
27554     * - @c "default"
27555     *
27556     * Here is an example on its usage:
27557     * @li @ref segment_control_example
27558     */
27559
27560    /**
27561     * @addtogroup SegmentControl
27562     * @{
27563     */
27564
27565    typedef struct _Elm_Segment_Item Elm_Segment_Item; /**< Item handle for a segment control widget. */
27566
27567    /**
27568     * Add a new segment control widget to the given parent Elementary
27569     * (container) object.
27570     *
27571     * @param parent The parent object.
27572     * @return a new segment control widget handle or @c NULL, on errors.
27573     *
27574     * This function inserts a new segment control widget on the canvas.
27575     *
27576     * @ingroup SegmentControl
27577     */
27578    EAPI Evas_Object      *elm_segment_control_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
27579
27580    /**
27581     * Append a new item to the segment control object.
27582     *
27583     * @param obj The segment control object.
27584     * @param icon The icon object to use for the left side of the item. An
27585     * icon can be any Evas object, but usually it is an icon created
27586     * with elm_icon_add().
27587     * @param label The label of the item.
27588     *        Note that, NULL is different from empty string "".
27589     * @return The created item or @c NULL upon failure.
27590     *
27591     * A new item will be created and appended to the segment control, i.e., will
27592     * be set as @b last item.
27593     *
27594     * If it should be inserted at another position,
27595     * elm_segment_control_item_insert_at() should be used instead.
27596     *
27597     * Items created with this function can be deleted with function
27598     * elm_segment_control_item_del() or elm_segment_control_item_del_at().
27599     *
27600     * @note @p label set to @c NULL is different from empty string "".
27601     * If an item
27602     * only has icon, it will be displayed bigger and centered. If it has
27603     * icon and label, even that an empty string, icon will be smaller and
27604     * positioned at left.
27605     *
27606     * Simple example:
27607     * @code
27608     * sc = elm_segment_control_add(win);
27609     * ic = elm_icon_add(win);
27610     * elm_icon_file_set(ic, "path/to/image", NULL);
27611     * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
27612     * elm_segment_control_item_add(sc, ic, "label");
27613     * evas_object_show(sc);
27614     * @endcode
27615     *
27616     * @see elm_segment_control_item_insert_at()
27617     * @see elm_segment_control_item_del()
27618     *
27619     * @ingroup SegmentControl
27620     */
27621    EAPI Elm_Segment_Item *elm_segment_control_item_add(Evas_Object *obj, Evas_Object *icon, const char *label) EINA_ARG_NONNULL(1);
27622
27623    /**
27624     * Insert a new item to the segment control object at specified position.
27625     *
27626     * @param obj The segment control object.
27627     * @param icon The icon object to use for the left side of the item. An
27628     * icon can be any Evas object, but usually it is an icon created
27629     * with elm_icon_add().
27630     * @param label The label of the item.
27631     * @param index Item position. Value should be between 0 and items count.
27632     * @return The created item or @c NULL upon failure.
27633
27634     * Index values must be between @c 0, when item will be prepended to
27635     * segment control, and items count, that can be get with
27636     * elm_segment_control_item_count_get(), case when item will be appended
27637     * to segment control, just like elm_segment_control_item_add().
27638     *
27639     * Items created with this function can be deleted with function
27640     * elm_segment_control_item_del() or elm_segment_control_item_del_at().
27641     *
27642     * @note @p label set to @c NULL is different from empty string "".
27643     * If an item
27644     * only has icon, it will be displayed bigger and centered. If it has
27645     * icon and label, even that an empty string, icon will be smaller and
27646     * positioned at left.
27647     *
27648     * @see elm_segment_control_item_add()
27649     * @see elm_segment_control_item_count_get()
27650     * @see elm_segment_control_item_del()
27651     *
27652     * @ingroup SegmentControl
27653     */
27654    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);
27655
27656    /**
27657     * Remove a segment control item from its parent, deleting it.
27658     *
27659     * @param it The item to be removed.
27660     *
27661     * Items can be added with elm_segment_control_item_add() or
27662     * elm_segment_control_item_insert_at().
27663     *
27664     * @ingroup SegmentControl
27665     */
27666    EAPI void              elm_segment_control_item_del(Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
27667
27668    /**
27669     * Remove a segment control item at given index from its parent,
27670     * deleting it.
27671     *
27672     * @param obj The segment control object.
27673     * @param index The position of the segment control item to be deleted.
27674     *
27675     * Items can be added with elm_segment_control_item_add() or
27676     * elm_segment_control_item_insert_at().
27677     *
27678     * @ingroup SegmentControl
27679     */
27680    EAPI void              elm_segment_control_item_del_at(Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
27681
27682    /**
27683     * Get the Segment items count from segment control.
27684     *
27685     * @param obj The segment control object.
27686     * @return Segment items count.
27687     *
27688     * It will just return the number of items added to segment control @p obj.
27689     *
27690     * @ingroup SegmentControl
27691     */
27692    EAPI int               elm_segment_control_item_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27693
27694    /**
27695     * Get the item placed at specified index.
27696     *
27697     * @param obj The segment control object.
27698     * @param index The index of the segment item.
27699     * @return The segment control item or @c NULL on failure.
27700     *
27701     * Index is the position of an item in segment control widget. Its
27702     * range is from @c 0 to <tt> count - 1 </tt>.
27703     * Count is the number of items, that can be get with
27704     * elm_segment_control_item_count_get().
27705     *
27706     * @ingroup SegmentControl
27707     */
27708    EAPI Elm_Segment_Item *elm_segment_control_item_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
27709
27710    /**
27711     * Get the label of item.
27712     *
27713     * @param obj The segment control object.
27714     * @param index The index of the segment item.
27715     * @return The label of the item at @p index.
27716     *
27717     * The return value is a pointer to the label associated to the item when
27718     * it was created, with function elm_segment_control_item_add(), or later
27719     * with function elm_segment_control_item_label_set. If no label
27720     * was passed as argument, it will return @c NULL.
27721     *
27722     * @see elm_segment_control_item_label_set() for more details.
27723     * @see elm_segment_control_item_add()
27724     *
27725     * @ingroup SegmentControl
27726     */
27727    EAPI const char       *elm_segment_control_item_label_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
27728
27729    /**
27730     * Set the label of item.
27731     *
27732     * @param it The item of segment control.
27733     * @param text The label of item.
27734     *
27735     * The label to be displayed by the item.
27736     * Label will be at right of the icon (if set).
27737     *
27738     * If a label was passed as argument on item creation, with function
27739     * elm_control_segment_item_add(), it will be already
27740     * displayed by the item.
27741     *
27742     * @see elm_segment_control_item_label_get()
27743     * @see elm_segment_control_item_add()
27744     *
27745     * @ingroup SegmentControl
27746     */
27747    EAPI void              elm_segment_control_item_label_set(Elm_Segment_Item* it, const char* label) EINA_ARG_NONNULL(1);
27748
27749    /**
27750     * Get the icon associated to the item.
27751     *
27752     * @param obj The segment control object.
27753     * @param index The index of the segment item.
27754     * @return The left side icon associated to the item at @p index.
27755     *
27756     * The return value is a pointer to the icon associated to the item when
27757     * it was created, with function elm_segment_control_item_add(), or later
27758     * with function elm_segment_control_item_icon_set(). If no icon
27759     * was passed as argument, it will return @c NULL.
27760     *
27761     * @see elm_segment_control_item_add()
27762     * @see elm_segment_control_item_icon_set()
27763     *
27764     * @ingroup SegmentControl
27765     */
27766    EAPI Evas_Object      *elm_segment_control_item_icon_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
27767
27768    /**
27769     * Set the icon associated to the item.
27770     *
27771     * @param it The segment control item.
27772     * @param icon The icon object to associate with @p it.
27773     *
27774     * The icon object to use at left side of the item. An
27775     * icon can be any Evas object, but usually it is an icon created
27776     * with elm_icon_add().
27777     *
27778     * Once the icon object is set, a previously set one will be deleted.
27779     * @warning Setting the same icon for two items will cause the icon to
27780     * dissapear from the first item.
27781     *
27782     * If an icon was passed as argument on item creation, with function
27783     * elm_segment_control_item_add(), it will be already
27784     * associated to the item.
27785     *
27786     * @see elm_segment_control_item_add()
27787     * @see elm_segment_control_item_icon_get()
27788     *
27789     * @ingroup SegmentControl
27790     */
27791    EAPI void              elm_segment_control_item_icon_set(Elm_Segment_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
27792
27793    /**
27794     * Get the index of an item.
27795     *
27796     * @param it The segment control item.
27797     * @return The position of item in segment control widget.
27798     *
27799     * Index is the position of an item in segment control widget. Its
27800     * range is from @c 0 to <tt> count - 1 </tt>.
27801     * Count is the number of items, that can be get with
27802     * elm_segment_control_item_count_get().
27803     *
27804     * @ingroup SegmentControl
27805     */
27806    EAPI int               elm_segment_control_item_index_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
27807
27808    /**
27809     * Get the base object of the item.
27810     *
27811     * @param it The segment control item.
27812     * @return The base object associated with @p it.
27813     *
27814     * Base object is the @c Evas_Object that represents that item.
27815     *
27816     * @ingroup SegmentControl
27817     */
27818    EAPI Evas_Object      *elm_segment_control_item_object_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
27819
27820    /**
27821     * Get the selected item.
27822     *
27823     * @param obj The segment control object.
27824     * @return The selected item or @c NULL if none of segment items is
27825     * selected.
27826     *
27827     * The selected item can be unselected with function
27828     * elm_segment_control_item_selected_set().
27829     *
27830     * The selected item always will be highlighted on segment control.
27831     *
27832     * @ingroup SegmentControl
27833     */
27834    EAPI Elm_Segment_Item *elm_segment_control_item_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27835
27836    /**
27837     * Set the selected state of an item.
27838     *
27839     * @param it The segment control item
27840     * @param select The selected state
27841     *
27842     * This sets the selected state of the given item @p it.
27843     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
27844     *
27845     * If a new item is selected the previosly selected will be unselected.
27846     * Previoulsy selected item can be get with function
27847     * elm_segment_control_item_selected_get().
27848     *
27849     * The selected item always will be highlighted on segment control.
27850     *
27851     * @see elm_segment_control_item_selected_get()
27852     *
27853     * @ingroup SegmentControl
27854     */
27855    EAPI void              elm_segment_control_item_selected_set(Elm_Segment_Item *it, Eina_Bool select) EINA_ARG_NONNULL(1);
27856
27857    /**
27858     * @}
27859     */
27860
27861    /**
27862     * @defgroup Grid Grid
27863     *
27864     * The grid is a grid layout widget that lays out a series of children as a
27865     * fixed "grid" of widgets using a given percentage of the grid width and
27866     * height each using the child object.
27867     *
27868     * The Grid uses a "Virtual resolution" that is stretched to fill the grid
27869     * widgets size itself. The default is 100 x 100, so that means the
27870     * position and sizes of children will effectively be percentages (0 to 100)
27871     * of the width or height of the grid widget
27872     *
27873     * @{
27874     */
27875
27876    /**
27877     * Add a new grid to the parent
27878     *
27879     * @param parent The parent object
27880     * @return The new object or NULL if it cannot be created
27881     *
27882     * @ingroup Grid
27883     */
27884    EAPI Evas_Object *elm_grid_add(Evas_Object *parent);
27885
27886    /**
27887     * Set the virtual size of the grid
27888     *
27889     * @param obj The grid object
27890     * @param w The virtual width of the grid
27891     * @param h The virtual height of the grid
27892     *
27893     * @ingroup Grid
27894     */
27895    EAPI void         elm_grid_size_set(Evas_Object *obj, int w, int h);
27896
27897    /**
27898     * Get the virtual size of the grid
27899     *
27900     * @param obj The grid object
27901     * @param w Pointer to integer to store the virtual width of the grid
27902     * @param h Pointer to integer to store the virtual height of the grid
27903     *
27904     * @ingroup Grid
27905     */
27906    EAPI void         elm_grid_size_get(Evas_Object *obj, int *w, int *h);
27907
27908    /**
27909     * Pack child at given position and size
27910     *
27911     * @param obj The grid object
27912     * @param subobj The child to pack
27913     * @param x The virtual x coord at which to pack it
27914     * @param y The virtual y coord at which to pack it
27915     * @param w The virtual width at which to pack it
27916     * @param h The virtual height at which to pack it
27917     *
27918     * @ingroup Grid
27919     */
27920    EAPI void         elm_grid_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h);
27921
27922    /**
27923     * Unpack a child from a grid object
27924     *
27925     * @param obj The grid object
27926     * @param subobj The child to unpack
27927     *
27928     * @ingroup Grid
27929     */
27930    EAPI void         elm_grid_unpack(Evas_Object *obj, Evas_Object *subobj);
27931
27932    /**
27933     * Faster way to remove all child objects from a grid object.
27934     *
27935     * @param obj The grid object
27936     * @param clear If true, it will delete just removed children
27937     *
27938     * @ingroup Grid
27939     */
27940    EAPI void         elm_grid_clear(Evas_Object *obj, Eina_Bool clear);
27941
27942    /**
27943     * Set packing of an existing child at to position and size
27944     *
27945     * @param subobj The child to set packing of
27946     * @param x The virtual x coord at which to pack it
27947     * @param y The virtual y coord at which to pack it
27948     * @param w The virtual width at which to pack it
27949     * @param h The virtual height at which to pack it
27950     *
27951     * @ingroup Grid
27952     */
27953    EAPI void         elm_grid_pack_set(Evas_Object *subobj, int x, int y, int w, int h);
27954
27955    /**
27956     * get packing of a child
27957     *
27958     * @param subobj The child to query
27959     * @param x Pointer to integer to store the virtual x coord
27960     * @param y Pointer to integer to store the virtual y coord
27961     * @param w Pointer to integer to store the virtual width
27962     * @param h Pointer to integer to store the virtual height
27963     *
27964     * @ingroup Grid
27965     */
27966    EAPI void         elm_grid_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h);
27967
27968    /**
27969     * @}
27970     */
27971
27972    EAPI Evas_Object *elm_genscroller_add(Evas_Object *parent);
27973    EAPI void         elm_genscroller_world_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h);
27974
27975    EAPI Evas_Object *elm_factory_add(Evas_Object *parent);
27976    EINA_DEPRECATED EAPI void         elm_factory_content_set(Evas_Object *obj, Evas_Object *content);
27977    EINA_DEPRECATED EAPI Evas_Object *elm_factory_content_get(const Evas_Object *obj);
27978    EAPI void         elm_factory_maxmin_mode_set(Evas_Object *obj, Eina_Bool enabled);
27979    EAPI Eina_Bool    elm_factory_maxmin_mode_get(const Evas_Object *obj);
27980    EAPI void         elm_factory_maxmin_reset_set(Evas_Object *obj);
27981
27982
27983    /**
27984     * @defgroup Video Video
27985     *
27986     * @addtogroup Video
27987     * @{
27988     *
27989     * Elementary comes with two object that help design application that need
27990     * to display video. The main one, Elm_Video, display a video by using Emotion.
27991     * It does embedded the video inside an Edje object, so you can do some
27992     * animation depending on the video state change. It does also implement a
27993     * ressource management policy to remove this burden from the application writer.
27994     *
27995     * The second one, Elm_Player is a video player that need to be linked with and Elm_Video.
27996     * It take care of updating its content according to Emotion event and provide a
27997     * way to theme itself. It also does automatically raise the priority of the
27998     * linked Elm_Video so it will use the video decoder if available. It also does
27999     * activate the remember function on the linked Elm_Video object.
28000     *
28001     * Signals that you can add callback for are :
28002     *
28003     * "forward,clicked" - the user clicked the forward button.
28004     * "info,clicked" - the user clicked the info button.
28005     * "next,clicked" - the user clicked the next button.
28006     * "pause,clicked" - the user clicked the pause button.
28007     * "play,clicked" - the user clicked the play button.
28008     * "prev,clicked" - the user clicked the prev button.
28009     * "rewind,clicked" - the user clicked the rewind button.
28010     * "stop,clicked" - the user clicked the stop button.
28011     * 
28012     * To set the video of the player, you can use elm_object_content_set() API.
28013     * 
28014     */
28015
28016    /**
28017     * @brief Add a new Elm_Player object to the given parent Elementary (container) object.
28018     *
28019     * @param parent The parent object
28020     * @return a new player widget handle or @c NULL, on errors.
28021     *
28022     * This function inserts a new player widget on the canvas.
28023     *
28024     * @see elm_object_content_set()
28025     *
28026     * @ingroup Video
28027     */
28028    EAPI Evas_Object *elm_player_add(Evas_Object *parent);
28029
28030    /**
28031     * @brief Link a Elm_Payer with an Elm_Video object.
28032     *
28033     * @param player the Elm_Player object.
28034     * @param video The Elm_Video object.
28035     *
28036     * This mean that action on the player widget will affect the
28037     * video object and the state of the video will be reflected in
28038     * the player itself.
28039     *
28040     * @see elm_player_add()
28041     * @see elm_video_add()
28042     *
28043     * @ingroup Video
28044     */
28045    EAPI void elm_player_video_set(Evas_Object *player, Evas_Object *video);
28046
28047    /**
28048     * @brief Add a new Elm_Video object to the given parent Elementary (container) object.
28049     *
28050     * @param parent The parent object
28051     * @return a new video widget handle or @c NULL, on errors.
28052     *
28053     * This function inserts a new video widget on the canvas.
28054     *
28055     * @seeelm_video_file_set()
28056     * @see elm_video_uri_set()
28057     *
28058     * @ingroup Video
28059     */
28060    EAPI Evas_Object *elm_video_add(Evas_Object *parent);
28061
28062    /**
28063     * @brief Define the file that will be the video source.
28064     *
28065     * @param video The video object to define the file for.
28066     * @param filename The file to target.
28067     *
28068     * This function will explicitly define a filename as a source
28069     * for the video of the Elm_Video object.
28070     *
28071     * @see elm_video_uri_set()
28072     * @see elm_video_add()
28073     * @see elm_player_add()
28074     *
28075     * @ingroup Video
28076     */
28077    EAPI void elm_video_file_set(Evas_Object *video, const char *filename);
28078
28079    /**
28080     * @brief Define the uri that will be the video source.
28081     *
28082     * @param video The video object to define the file for.
28083     * @param uri The uri to target.
28084     *
28085     * This function will define an uri as a source for the video of the
28086     * Elm_Video object. URI could be remote source of video, like http:// or local source
28087     * like for example WebCam who are most of the time v4l2:// (but that depend and
28088     * you should use Emotion API to request and list the available Webcam on your system).
28089     *
28090     * @see elm_video_file_set()
28091     * @see elm_video_add()
28092     * @see elm_player_add()
28093     *
28094     * @ingroup Video
28095     */
28096    EAPI void elm_video_uri_set(Evas_Object *video, const char *uri);
28097
28098    /**
28099     * @brief Get the underlying Emotion object.
28100     *
28101     * @param video The video object to proceed the request on.
28102     * @return the underlying Emotion object.
28103     *
28104     * @ingroup Video
28105     */
28106    EAPI Evas_Object *elm_video_emotion_get(const Evas_Object *video);
28107
28108    /**
28109     * @brief Start to play the video
28110     *
28111     * @param video The video object to proceed the request on.
28112     *
28113     * Start to play the video and cancel all suspend state.
28114     *
28115     * @ingroup Video
28116     */
28117    EAPI void elm_video_play(Evas_Object *video);
28118
28119    /**
28120     * @brief Pause the video
28121     *
28122     * @param video The video object to proceed the request on.
28123     *
28124     * Pause the video and start a timer to trigger suspend mode.
28125     *
28126     * @ingroup Video
28127     */
28128    EAPI void elm_video_pause(Evas_Object *video);
28129
28130    /**
28131     * @brief Stop the video
28132     *
28133     * @param video The video object to proceed the request on.
28134     *
28135     * Stop the video and put the emotion in deep sleep mode.
28136     *
28137     * @ingroup Video
28138     */
28139    EAPI void elm_video_stop(Evas_Object *video);
28140
28141    /**
28142     * @brief Is the video actually playing.
28143     *
28144     * @param video The video object to proceed the request on.
28145     * @return EINA_TRUE if the video is actually playing.
28146     *
28147     * You should consider watching event on the object instead of polling
28148     * the object state.
28149     *
28150     * @ingroup Video
28151     */
28152    EAPI Eina_Bool elm_video_is_playing(const Evas_Object *video);
28153
28154    /**
28155     * @brief Is it possible to seek inside the video.
28156     *
28157     * @param video The video object to proceed the request on.
28158     * @return EINA_TRUE if is possible to seek inside the video.
28159     *
28160     * @ingroup Video
28161     */
28162    EAPI Eina_Bool elm_video_is_seekable(const Evas_Object *video);
28163
28164    /**
28165     * @brief Is the audio muted.
28166     *
28167     * @param video The video object to proceed the request on.
28168     * @return EINA_TRUE if the audio is muted.
28169     *
28170     * @ingroup Video
28171     */
28172    EAPI Eina_Bool elm_video_audio_mute_get(const Evas_Object *video);
28173
28174    /**
28175     * @brief Change the mute state of the Elm_Video object.
28176     *
28177     * @param video The video object to proceed the request on.
28178     * @param mute The new mute state.
28179     *
28180     * @ingroup Video
28181     */
28182    EAPI void elm_video_audio_mute_set(Evas_Object *video, Eina_Bool mute);
28183
28184    /**
28185     * @brief Get the audio level of the current video.
28186     *
28187     * @param video The video object to proceed the request on.
28188     * @return the current audio level.
28189     *
28190     * @ingroup Video
28191     */
28192    EAPI double elm_video_audio_level_get(const Evas_Object *video);
28193
28194    /**
28195     * @brief Set the audio level of anElm_Video object.
28196     *
28197     * @param video The video object to proceed the request on.
28198     * @param volume The new audio volume.
28199     *
28200     * @ingroup Video
28201     */
28202    EAPI void elm_video_audio_level_set(Evas_Object *video, double volume);
28203
28204    EAPI double elm_video_play_position_get(const Evas_Object *video);
28205    EAPI void elm_video_play_position_set(Evas_Object *video, double position);
28206    EAPI double elm_video_play_length_get(const Evas_Object *video);
28207    EAPI void elm_video_remember_position_set(Evas_Object *video, Eina_Bool remember);
28208    EAPI Eina_Bool elm_video_remember_position_get(const Evas_Object *video);
28209    EAPI const char *elm_video_title_get(const Evas_Object *video);
28210    /**
28211     * @}
28212     */
28213
28214    // FIXME: incomplete - carousel. don't use this until this comment is removed
28215    typedef struct _Elm_Carousel_Item Elm_Carousel_Item;
28216    EAPI Evas_Object       *elm_carousel_add(Evas_Object *parent);
28217    EAPI Elm_Carousel_Item *elm_carousel_item_add(Evas_Object *obj, Evas_Object *icon, const char *label, Evas_Smart_Cb func, const void *data);
28218    EAPI void               elm_carousel_item_del(Elm_Carousel_Item *item);
28219    EAPI void               elm_carousel_item_select(Elm_Carousel_Item *item);
28220    /* smart callbacks called:
28221     * "clicked" - when the user clicks on a carousel item and becomes selected
28222     */
28223
28224    /* datefield */
28225
28226    typedef enum _Elm_Datefield_ItemType
28227      {
28228         ELM_DATEFIELD_YEAR = 0,
28229         ELM_DATEFIELD_MONTH,
28230         ELM_DATEFIELD_DATE,
28231         ELM_DATEFIELD_HOUR,
28232         ELM_DATEFIELD_MINUTE,
28233         ELM_DATEFIELD_AMPM
28234      } Elm_Datefield_ItemType;
28235
28236    EAPI Evas_Object *elm_datefield_add(Evas_Object *parent);
28237    EAPI void         elm_datefield_format_set(Evas_Object *obj, const char *fmt);
28238    EAPI char        *elm_datefield_format_get(const Evas_Object *obj);
28239    EAPI void         elm_datefield_item_enabled_set(Evas_Object *obj, Elm_Datefield_ItemType itemtype, Eina_Bool enable);
28240    EAPI Eina_Bool    elm_datefield_item_enabled_get(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
28241    EAPI void         elm_datefield_item_value_set(Evas_Object *obj, Elm_Datefield_ItemType itemtype, int value);
28242    EAPI int          elm_datefield_item_value_get(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
28243    EAPI void         elm_datefield_item_min_set(Evas_Object *obj, Elm_Datefield_ItemType itemtype, int value, Eina_Bool abs_limit);
28244    EAPI int          elm_datefield_item_min_get(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
28245    EAPI Eina_Bool    elm_datefield_item_min_is_absolute(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
28246    EAPI void         elm_datefield_item_max_set(Evas_Object *obj, Elm_Datefield_ItemType itemtype, int value, Eina_Bool abs_limit);
28247    EAPI int          elm_datefield_item_max_get(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
28248    EAPI Eina_Bool    elm_datefield_item_max_is_absolute(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
28249  
28250    /* smart callbacks called:
28251    * "changed" - when datefield value is changed, this signal is sent.
28252    */
28253
28254 ////////////////////// DEPRECATED ///////////////////////////////////
28255
28256    typedef enum _Elm_Datefield_Layout
28257      {
28258         ELM_DATEFIELD_LAYOUT_TIME,
28259         ELM_DATEFIELD_LAYOUT_DATE,
28260         ELM_DATEFIELD_LAYOUT_DATEANDTIME
28261      } Elm_Datefield_Layout;
28262
28263    EINA_DEPRECATED EAPI void         elm_datefield_layout_set(Evas_Object *obj, Elm_Datefield_Layout layout);
28264    EINA_DEPRECATED EAPI Elm_Datefield_Layout elm_datefield_layout_get(const Evas_Object *obj);
28265    EINA_DEPRECATED EAPI void         elm_datefield_date_format_set(Evas_Object *obj, const char *fmt);
28266    EINA_DEPRECATED EAPI const char  *elm_datefield_date_format_get(const Evas_Object *obj);
28267    EINA_DEPRECATED EAPI void         elm_datefield_time_mode_set(Evas_Object *obj, Eina_Bool mode);
28268    EINA_DEPRECATED EAPI Eina_Bool    elm_datefield_time_mode_get(const Evas_Object *obj);
28269    EINA_DEPRECATED EAPI void         elm_datefield_date_set(Evas_Object *obj, int year, int month, int day, int hour, int min);
28270    EINA_DEPRECATED EAPI void         elm_datefield_date_get(const Evas_Object *obj, int *year, int *month, int *day, int *hour, int *min);
28271    EINA_DEPRECATED EAPI Eina_Bool    elm_datefield_date_max_set(Evas_Object *obj, int year, int month, int day);
28272    EINA_DEPRECATED EAPI void         elm_datefield_date_max_get(const Evas_Object *obj, int *year, int *month, int *day);
28273    EINA_DEPRECATED EAPI Eina_Bool    elm_datefield_date_min_set(Evas_Object *obj, int year, int month, int day);
28274    EINA_DEPRECATED EAPI void         elm_datefield_date_min_get(const Evas_Object *obj, int *year, int *month, int *day);
28275    EINA_DEPRECATED EAPI void         elm_datefield_input_panel_state_callback_add(Evas_Object *obj, void (*pEventCallbackFunc) (void *data, Evas_Object *obj, int value), void *data);
28276    EINA_DEPRECATED EAPI void         elm_datefield_input_panel_state_callback_del(Evas_Object *obj, void (*pEventCallbackFunc) (void *data, Evas_Object *obj, int value));
28277 /////////////////////////////////////////////////////////////////////
28278
28279    /* popup */
28280    typedef enum _Elm_Popup_Response
28281      {
28282         ELM_POPUP_RESPONSE_NONE = -1,
28283         ELM_POPUP_RESPONSE_TIMEOUT = -2,
28284         ELM_POPUP_RESPONSE_OK = -3,
28285         ELM_POPUP_RESPONSE_CANCEL = -4,
28286         ELM_POPUP_RESPONSE_CLOSE = -5
28287      } Elm_Popup_Response;
28288
28289    typedef enum _Elm_Popup_Mode
28290      {
28291         ELM_POPUP_TYPE_NONE = 0,
28292         ELM_POPUP_TYPE_ALERT = (1 << 0)
28293      } Elm_Popup_Mode;
28294
28295    typedef enum _Elm_Popup_Orient
28296      {
28297         ELM_POPUP_ORIENT_TOP,
28298         ELM_POPUP_ORIENT_CENTER,
28299         ELM_POPUP_ORIENT_BOTTOM,
28300         ELM_POPUP_ORIENT_LEFT,
28301         ELM_POPUP_ORIENT_RIGHT,
28302         ELM_POPUP_ORIENT_TOP_LEFT,
28303         ELM_POPUP_ORIENT_TOP_RIGHT,
28304         ELM_POPUP_ORIENT_BOTTOM_LEFT,
28305         ELM_POPUP_ORIENT_BOTTOM_RIGHT
28306      } Elm_Popup_Orient;
28307
28308    /* smart callbacks called:
28309     * "response" - when ever popup is closed, this signal is sent with appropriate response id.".
28310     */
28311
28312    EAPI Evas_Object *elm_popup_add(Evas_Object *parent);
28313    EAPI void         elm_popup_desc_set(Evas_Object *obj, const char *text);
28314    EAPI const char  *elm_popup_desc_get(Evas_Object *obj);
28315    EAPI void         elm_popup_title_label_set(Evas_Object *obj, const char *text);
28316    EAPI const char  *elm_popup_title_label_get(Evas_Object *obj);
28317    EAPI void         elm_popup_title_icon_set(Evas_Object *obj, Evas_Object *icon);
28318    EAPI Evas_Object *elm_popup_title_icon_get(Evas_Object *obj);
28319    EAPI void         elm_popup_content_set(Evas_Object *obj, Evas_Object *content);
28320    EAPI Evas_Object *elm_popup_content_get(Evas_Object *obj);
28321    EAPI void         elm_popup_buttons_add(Evas_Object *obj,int no_of_buttons, const char *first_button_text,  ...);
28322    EAPI Evas_Object *elm_popup_with_buttons_add(Evas_Object *parent, const char *title, const char *desc_text,int no_of_buttons, const char *first_button_text, ... );
28323    EAPI void         elm_popup_timeout_set(Evas_Object *obj, double timeout);
28324    EAPI void         elm_popup_mode_set(Evas_Object *obj, Elm_Popup_Mode mode);
28325    EAPI void         elm_popup_response(Evas_Object *obj, int  response_id);
28326    EAPI void         elm_popup_orient_set(Evas_Object *obj, Elm_Popup_Orient orient);
28327    EAPI int          elm_popup_run(Evas_Object *obj);
28328
28329    /* NavigationBar */
28330    #define NAVIBAR_TITLEOBJ_INSTANT_HIDE "elm,state,hide,noanimate,title", "elm"
28331    #define NAVIBAR_TITLEOBJ_INSTANT_SHOW "elm,state,show,noanimate,title", "elm"
28332
28333    typedef enum
28334      {
28335         ELM_NAVIGATIONBAR_FUNCTION_BUTTON1,
28336         ELM_NAVIGATIONBAR_FUNCTION_BUTTON2,
28337         ELM_NAVIGATIONBAR_FUNCTION_BUTTON3,
28338         ELM_NAVIGATIONBAR_BACK_BUTTON
28339      } Elm_Navi_Button_Type;
28340
28341    EAPI Evas_Object *elm_navigationbar_add(Evas_Object *parent);
28342    EAPI void         elm_navigationbar_push(Evas_Object *obj, const char *title, Evas_Object *fn_btn1, Evas_Object *fn_btn2, Evas_Object *fn_btn3, Evas_Object *content);
28343    EAPI void         elm_navigationbar_pop(Evas_Object *obj);
28344    EAPI void         elm_navigationbar_to_content_pop(Evas_Object *obj, Evas_Object *content);
28345    EAPI void         elm_navigationbar_title_label_set(Evas_Object *obj, Evas_Object *content, const char *title);
28346    EAPI const char  *elm_navigationbar_title_label_get(Evas_Object *obj, Evas_Object *content);
28347    EAPI void         elm_navigationbar_title_object_add(Evas_Object *obj, Evas_Object *content, Evas_Object *title_obj);
28348    EAPI Evas_Object *elm_navigationbar_title_object_get(Evas_Object *obj, Evas_Object *content);
28349    EAPI Eina_List   *elm_navigationbar_title_object_list_get(Evas_Object *obj, Evas_Object *content);
28350    EAPI Evas_Object *elm_navigationbar_content_top_get(Evas_Object *obj);
28351    EAPI Evas_Object *elm_navigationbar_content_bottom_get(Evas_Object *obj);
28352    EAPI void         elm_navigationbar_hidden_set(Evas_Object *obj, Eina_Bool hidden);
28353    EAPI void         elm_navigationbar_title_button_set(Evas_Object *obj, Evas_Object *content, Evas_Object *button, Elm_Navi_Button_Type button_type);
28354    EAPI Evas_Object *elm_navigationbar_title_button_get(Evas_Object *obj, Evas_Object *content, Elm_Navi_Button_Type button_type);
28355    EAPI const char  *elm_navigationbar_subtitle_label_get(Evas_Object *obj, Evas_Object *content);
28356    EAPI void         elm_navigationbar_subtitle_label_set(Evas_Object *obj, Evas_Object *content, const char *subtitle);
28357    EAPI void         elm_navigationbar_title_object_list_unset(Evas_Object *obj, Evas_Object *content, Eina_List **list);
28358    EAPI void         elm_navigationbar_animation_disabled_set(Evas_Object *obj, Eina_Bool disable);
28359    EAPI void         elm_navigationbar_title_object_visible_set(Evas_Object *obj, Evas_Object *content, Eina_Bool visible);
28360    Eina_Bool         elm_navigationbar_title_object_visible_get(Evas_Object *obj, Evas_Object *content);
28361    EAPI void         elm_navigationbar_title_icon_set(Evas_Object *obj, Evas_Object *content, Evas_Object *icon);
28362    EAPI Evas_Object *elm_navigationbar_title_icon_get(Evas_Object *obj, Evas_Object *content);
28363
28364    /* NavigationBar */
28365    #define NAVIBAR_EX_TITLEOBJ_INSTANT_HIDE "elm,state,hide,noanimate,title", "elm"
28366    #define NAVIBAR_EX_TITLEOBJ_INSTANT_SHOW "elm,state,show,noanimate,title", "elm"
28367
28368    typedef enum
28369      {
28370         ELM_NAVIGATIONBAR_EX_BACK_BUTTON,
28371         ELM_NAVIGATIONBAR_EX_FUNCTION_BUTTON1,
28372         ELM_NAVIGATIONBAR_EX_FUNCTION_BUTTON2,
28373         ELM_NAVIGATIONBAR_EX_FUNCTION_BUTTON3,
28374         ELM_NAVIGATIONBAR_EX_MAX
28375      } Elm_Navi_ex_Button_Type;
28376    typedef struct _Elm_Navigationbar_ex_Item Elm_Navigationbar_ex_Item;
28377
28378    EAPI Evas_Object *elm_navigationbar_ex_add(Evas_Object *parent);
28379    EAPI Elm_Navigationbar_ex_Item *elm_navigationbar_ex_item_push(Evas_Object *obj, Evas_Object *content, const char *item_style);
28380    EAPI void         elm_navigationbar_ex_item_pop(Evas_Object *obj);
28381    EAPI void         elm_navigationbar_ex_item_promote(Elm_Navigationbar_ex_Item* item);
28382    EAPI void         elm_navigationbar_ex_to_item_pop(Elm_Navigationbar_ex_Item* item);
28383    EAPI void         elm_navigationbar_ex_item_title_label_set(Elm_Navigationbar_ex_Item *item, const char *title);
28384    EAPI const char  *elm_navigationbar_ex_item_title_label_get(Elm_Navigationbar_ex_Item* item);
28385    EAPI Elm_Navigationbar_ex_Item *elm_navigationbar_ex_item_top_get(const Evas_Object *obj);
28386    EAPI Elm_Navigationbar_ex_Item *elm_navigationbar_ex_item_bottom_get(const Evas_Object *obj);
28387    EAPI void         elm_navigationbar_ex_item_title_button_set(Elm_Navigationbar_ex_Item* item, char *btn_label, Evas_Object *icon, int button_type, Evas_Smart_Cb func, const void *data);
28388    EAPI Evas_Object *elm_navigationbar_ex_item_title_button_get(Elm_Navigationbar_ex_Item* item, int button_type);
28389    EAPI void         elm_navigationbar_ex_item_title_object_set(Elm_Navigationbar_ex_Item* item, Evas_Object *title_obj);
28390    EAPI Evas_Object *elm_navigationbar_ex_item_title_object_unset(Elm_Navigationbar_ex_Item* item);
28391    EAPI void         elm_navigationbar_ex_item_title_hidden_set(Elm_Navigationbar_ex_Item* item, Eina_Bool hidden);
28392    EAPI Evas_Object *elm_navigationbar_ex_item_title_object_get(Elm_Navigationbar_ex_Item* item);
28393    EAPI const char  *elm_navigationbar_ex_item_subtitle_label_get(Elm_Navigationbar_ex_Item* item);
28394    EAPI void         elm_navigationbar_ex_item_subtitle_label_set( Elm_Navigationbar_ex_Item* item, const char *subtitle);
28395    EAPI void         elm_navigationbar_ex_item_style_set(Elm_Navigationbar_ex_Item* item, const char* item_style);
28396    EAPI const char  *elm_navigationbar_ex_item_style_get(Elm_Navigationbar_ex_Item* item);
28397    EAPI Evas_Object *elm_navigationbar_ex_item_content_unset(Elm_Navigationbar_ex_Item* item);
28398    EAPI Evas_Object *elm_navigationbar_ex_item_content_get(Elm_Navigationbar_ex_Item* item);
28399    EAPI void         elm_navigationbar_ex_delete_on_pop_set(Evas_Object *obj, Eina_Bool del_on_pop);
28400    EAPI Evas_Object *elm_navigationbar_ex_item_icon_get(Elm_Navigationbar_ex_Item* item);
28401    EAPI void         elm_navigationbar_ex_item_icon_set(Elm_Navigationbar_ex_Item* item, Evas_Object *icon);
28402    EAPI Evas_Object *elm_navigationbar_ex_item_title_button_unset(Elm_Navigationbar_ex_Item* item, int button_type);
28403    EAPI void         elm_navigationbar_ex_animation_disable_set(Evas_Object *obj, Eina_Bool disable);
28404    EAPI void         elm_navigationbar_ex_title_object_visible_set(Elm_Navigationbar_ex_Item* item, Eina_Bool visible);
28405    Eina_Bool         elm_navigationbar_ex_title_object_visible_get(Elm_Navigationbar_ex_Item* item);
28406
28407   /* naviframe */
28408   #define ELM_NAVIFRAME_ITEM_CONTENT "elm.swallow.content"
28409   #define ELM_NAVIFRAME_ITEM_ICON "elm.swallow.icon"
28410   #define ELM_NAVIFRAME_ITEM_OPTIONHEADER "elm.swallow.optionheader"
28411   #define ELM_NAVIFRAME_ITEM_OPTIONHEADER2 "elm.swallow.optionheader2"
28412   #define ELM_NAVIFRAME_ITEM_TITLE_LABEL "elm.text.title"
28413   #define ELM_NAVIFRAME_ITEM_PREV_BTN "elm.swallow.prev_btn"
28414   #define ELM_NAVIFRAME_ITEM_SIGNAL_OPTIONHEADER_CLOSE "elm,state,optionheader,close", ""
28415   #define ELM_NAVIFRAME_ITEM_SIGNAL_OPTIONHEADER_OPEN "elm,state,optionheader,open", ""
28416   #define ELM_NAVIFRAME_ITEM_SIGNAL_OPTIONHEADER_INSTANT_CLOSE "elm,state,optionheader,instant_close", ""
28417   #define ELM_NAVIFRAME_ITEM_SIGNAL_OPTIONHEADER_INSTANT_OPEN "elm,state,optionheader,instant_open", ""
28418
28419   /**
28420     * @defgroup Naviframe Naviframe
28421     *
28422     * @brief Naviframe is a kind of view manager for the applications.
28423     *
28424     * Naviframe provides functions to switch different pages with stack
28425     * mechanism. It means if one page(item) needs to be changed to the new one,
28426     * then naviframe would push the new page to it's internal stack. Of course,
28427     * it can be back to the previous page by popping the top page. Naviframe
28428     * provides some transition effect while the pages are switching (same as
28429     * pager).
28430     *
28431     * Since each item could keep the different styles, users could keep the
28432     * same look & feel for the pages or different styles for the items in it's
28433     * application.
28434     *
28435     * Signals that you can add callback for are:
28436     * @li "transition,finished" - When the transition is finished in changing
28437     *     the item
28438     * @li "title,clicked" - User clicked title area
28439     *
28440     * Default contents parts for the naviframe items that you can use for are:
28441     *
28442     * @li "elm.swallow.content" - A main content of the page
28443     * @li "elm.swallow.prev_btn" - A button to go to the previous page
28444     * @li "elm.swallow.next_btn" - A button to go to the next page
28445     *
28446     * Default text parts of naviframe items that you can be used are:
28447     *
28448     * @li "elm.text.title" - Title label in the title area
28449     *
28450     * @ref tutorial_naviframe gives a good overview of the usage of the API.
28451     * @{
28452     */
28453    /**
28454     * @brief Add a new Naviframe object to the parent.
28455     *
28456     * @param parent Parent object
28457     * @return New object or @c NULL, if it cannot be created
28458     */
28459    EAPI Evas_Object        *elm_naviframe_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
28460    /**
28461     * @brief Push a new item to the top of the naviframe stack (and show it).
28462     *
28463     * @param obj The naviframe object
28464     * @param title_label The label in the title area. The name of the title
28465     *        label part is "elm.text.title"
28466     * @param prev_btn The button to go to the previous item. If it is NULL,
28467     *        then naviframe will create a back button automatically. The name of
28468     *        the prev_btn part is "elm.swallow.prev_btn"
28469     * @param next_btn The button to go to the next item. Or It could be just an
28470     *        extra function button. The name of the next_btn part is
28471     *        "elm.swallow.next_btn"
28472     * @param content The main content object. The name of content part is
28473     *        "elm.swallow.content"
28474     * @param item_style The current item style name. @c NULL would be default.
28475     * @return The created item or @c NULL upon failure.
28476     *
28477     * The item pushed becomes one page of the naviframe, this item will be
28478     * deleted when it is popped.
28479     *
28480     * @see also elm_naviframe_item_style_set()
28481     *
28482     * The following styles are available for this item:
28483     * @li @c "default"
28484     */
28485    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);
28486    /**
28487     * @brief Pop an item that is on top of the stack
28488     *
28489     * @param obj The naviframe object
28490     * @return @c NULL or the content object(if the
28491     *         elm_naviframe_content_preserve_on_pop_get is true).
28492     *
28493     * This pops an item that is on the top(visible) of the naviframe, makes it
28494     * disappear, then deletes the item. The item that was underneath it on the
28495     * stack will become visible.
28496     *
28497     * @see also elm_naviframe_content_preserve_on_pop_get()
28498     *
28499     * @ingroup Naviframe
28500     */
28501    EAPI Evas_Object        *elm_naviframe_item_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
28502    /**
28503     * @brief Pop the items between the top and the above one on the given item.
28504     *
28505     * @param it The naviframe item
28506     *
28507     * @ingroup Naviframe
28508     */
28509    EAPI void                elm_naviframe_item_pop_to(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28510    /**
28511    * Promote an item already in the naviframe stack to the top of the stack
28512    *
28513    * @param it The naviframe item
28514    *
28515    * This will take the indicated item and promote it to the top of the stack
28516    * as if it had been pushed there. The item must already be inside the
28517    * naviframe stack to work.
28518    *
28519    */
28520    EAPI void                elm_naviframe_item_promote(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28521    /**
28522     * @brief Delete the given item instantly.
28523     *
28524     * @param it The naviframe item
28525     *
28526     * This just deletes the given item from the naviframe item list instantly.
28527     * So this would not emit any signals for view transitions but just change
28528     * the current view if the given item is a top one.
28529     *
28530     * @ingroup Naviframe
28531     */
28532    EAPI void                elm_naviframe_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28533    /**
28534     * @brief preserve the content objects when items are popped.
28535     *
28536     * @param obj The naviframe object
28537     * @param preserve Enable the preserve mode if EINA_TRUE, disable otherwise
28538     *
28539     * @see also elm_naviframe_content_preserve_on_pop_get()
28540     *
28541     * @ingroup Naviframe
28542     */
28543    EAPI void                elm_naviframe_content_preserve_on_pop_set(Evas_Object *obj, Eina_Bool preserve) EINA_ARG_NONNULL(1);
28544    /**
28545     * @brief Get a value whether preserve mode is enabled or not.
28546     *
28547     * @param obj The naviframe object
28548     * @return If @c EINA_TRUE, preserve mode is enabled
28549     *
28550     * @see also elm_naviframe_content_preserve_on_pop_set()
28551     *
28552     * @ingroup Naviframe
28553     */
28554    EAPI Eina_Bool           elm_naviframe_content_preserve_on_pop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28555    /**
28556     * @brief Get a top item on the naviframe stack
28557     *
28558     * @param obj The naviframe object
28559     * @return The top item on the naviframe stack or @c NULL, if the stack is
28560     *         empty
28561     *
28562     * @ingroup Naviframe
28563     */
28564    EAPI Elm_Object_Item    *elm_naviframe_top_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28565    /**
28566     * @brief Get a bottom item on the naviframe stack
28567     *
28568     * @param obj The naviframe object
28569     * @return The bottom item on the naviframe stack or @c NULL, if the stack is
28570     *         empty
28571     *
28572     * @ingroup Naviframe
28573     */
28574    EAPI Elm_Object_Item    *elm_naviframe_bottom_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28575    /**
28576     * @brief Set an item style
28577     *
28578     * @param obj The naviframe item
28579     * @param item_style The current item style name. @c NULL would be default
28580     *
28581     * The following styles are available for this item:
28582     * @li @c "default"
28583     *
28584     * @see also elm_naviframe_item_style_get()
28585     *
28586     * @ingroup Naviframe
28587     */
28588    EAPI void                elm_naviframe_item_style_set(Elm_Object_Item *it, const char *item_style) EINA_ARG_NONNULL(1);
28589    /**
28590     * @brief Get an item style
28591     *
28592     * @param obj The naviframe item
28593     * @return The current item style name
28594     *
28595     * @see also elm_naviframe_item_style_set()
28596     *
28597     * @ingroup Naviframe
28598     */
28599    EAPI const char         *elm_naviframe_item_style_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28600    /**
28601     * @brief Show/Hide the title area
28602     *
28603     * @param it The naviframe item
28604     * @param visible If @c EINA_TRUE, title area will be visible, hidden
28605     *        otherwise
28606     *
28607     * When the title area is invisible, then the controls would be hidden so as     * to expand the content area to full-size.
28608     *
28609     * @see also elm_naviframe_item_title_visible_get()
28610     *
28611     * @ingroup Naviframe
28612     */
28613    EAPI void                elm_naviframe_item_title_visible_set(Elm_Object_Item *it, Eina_Bool visible) EINA_ARG_NONNULL(1);
28614    /**
28615     * @brief Get a value whether title area is visible or not.
28616     *
28617     * @param it The naviframe item
28618     * @return If @c EINA_TRUE, title area is visible
28619     *
28620     * @see also elm_naviframe_item_title_visible_set()
28621     *
28622     * @ingroup Naviframe
28623     */
28624    EAPI Eina_Bool           elm_naviframe_item_title_visible_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28625
28626    /**
28627     * @brief Set creating prev button automatically or not
28628     *
28629     * @param obj The naviframe object
28630     * @param auto_pushed If @c EINA_TRUE, the previous button(back button) will
28631     *        be created internally when you pass the @c NULL to the prev_btn
28632     *        parameter in elm_naviframe_item_push
28633     *
28634     * @see also elm_naviframe_item_push()
28635     */
28636    EAPI void                elm_naviframe_prev_btn_auto_pushed_set(Evas_Object *obj, Eina_Bool auto_pushed) EINA_ARG_NONNULL(1);
28637    /**
28638     * @brief Get a value whether prev button(back button) will be auto pushed or
28639     *        not.
28640     *
28641     * @param obj The naviframe object
28642     * @return If @c EINA_TRUE, prev button will be auto pushed.
28643     *
28644     * @see also elm_naviframe_item_push()
28645     *           elm_naviframe_prev_btn_auto_pushed_set()
28646     */
28647    EAPI Eina_Bool           elm_naviframe_prev_btn_auto_pushed_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
28648
28649    /* Control Bar */
28650    #define CONTROLBAR_SYSTEM_ICON_ALBUMS "controlbar_albums"
28651    #define CONTROLBAR_SYSTEM_ICON_ARTISTS "controlbar_artists"
28652    #define CONTROLBAR_SYSTEM_ICON_SONGS "controlbar_songs"
28653    #define CONTROLBAR_SYSTEM_ICON_PLAYLIST "controlbar_playlist"
28654    #define CONTROLBAR_SYSTEM_ICON_MORE "controlbar_more"
28655    #define CONTROLBAR_SYSTEM_ICON_CONTACTS "controlbar_contacts"
28656    #define CONTROLBAR_SYSTEM_ICON_DIALER "controlbar_dialer"
28657    #define CONTROLBAR_SYSTEM_ICON_FAVORITES "controlbar_favorites"
28658    #define CONTROLBAR_SYSTEM_ICON_LOGS "controlbar_logs"
28659
28660    typedef enum _Elm_Controlbar_Mode_Type
28661      {
28662         ELM_CONTROLBAR_MODE_DEFAULT = 0,
28663         ELM_CONTROLBAR_MODE_TRANSLUCENCE,
28664         ELM_CONTROLBAR_MODE_TRANSPARENCY,
28665         ELM_CONTROLBAR_MODE_LARGE,
28666         ELM_CONTROLBAR_MODE_SMALL,
28667         ELM_CONTROLBAR_MODE_LEFT,
28668         ELM_CONTROLBAR_MODE_RIGHT
28669      } Elm_Controlbar_Mode_Type;
28670
28671    typedef struct _Elm_Controlbar_Item Elm_Controlbar_Item;
28672    EAPI Evas_Object *elm_controlbar_add(Evas_Object *parent);
28673    EAPI Elm_Controlbar_Item *elm_controlbar_tab_item_append(Evas_Object *obj, const char *icon_path, const char *label, Evas_Object *view);
28674    EAPI Elm_Controlbar_Item *elm_controlbar_tab_item_prepend(Evas_Object *obj, const char *icon_path, const char *label, Evas_Object *view);
28675    EAPI Elm_Controlbar_Item *elm_controlbar_tab_item_insert_before(Evas_Object *obj, Elm_Controlbar_Item *before, const char *icon_path, const char *label, Evas_Object *view);
28676    EAPI Elm_Controlbar_Item *elm_controlbar_tab_item_insert_after(Evas_Object *obj, Elm_Controlbar_Item *after, const char *icon_path, const char *label, Evas_Object *view);
28677    EAPI Elm_Controlbar_Item *elm_controlbar_tool_item_append(Evas_Object *obj, const char *icon_path, const char *label, void (*func) (void *data, Evas_Object *obj, void *event_info), void *data);
28678    EAPI Elm_Controlbar_Item *elm_controlbar_tool_item_prepend(Evas_Object *obj, const char *icon_path, const char *label, void (*func) (void *data, Evas_Object *obj, void *event_info), void *data);
28679    EAPI Elm_Controlbar_Item *elm_controlbar_tool_item_insert_before(Evas_Object *obj, Elm_Controlbar_Item *before, const char *icon_path, const char *label, void (*func) (void *data, Evas_Object *obj, void *event_info), void *data);
28680    EAPI Elm_Controlbar_Item *elm_controlbar_tool_item_insert_after(Evas_Object *obj, Elm_Controlbar_Item *after, const char *icon_path, const char *label, void (*func) (void *data, Evas_Object *obj, void *event_info), void *data);
28681    EAPI Elm_Controlbar_Item *elm_controlbar_object_item_append(Evas_Object *obj, Evas_Object *obj_item, const int sel);
28682    EAPI Elm_Controlbar_Item *elm_controlbar_object_item_prepend(Evas_Object *obj, Evas_Object *obj_item, const int sel);
28683    EAPI Elm_Controlbar_Item *elm_controlbar_object_item_insert_before(Evas_Object *obj, Elm_Controlbar_Item *before, Evas_Object *obj_item, const int sel);
28684    EAPI Elm_Controlbar_Item *elm_controlbar_object_item_insert_after(Evas_Object *obj, Elm_Controlbar_Item *after, Evas_Object *obj_item, const int sel);
28685    EAPI Evas_Object *elm_controlbar_object_item_object_get(const Elm_Controlbar_Item *it);
28686    EAPI void         elm_controlbar_item_del(Elm_Controlbar_Item *it);
28687    EAPI void         elm_controlbar_item_select(Elm_Controlbar_Item *it);
28688    EAPI void         elm_controlbar_item_visible_set(Elm_Controlbar_Item *it, Eina_Bool bar);
28689    EAPI Eina_Bool    elm_controlbar_item_visible_get(const Elm_Controlbar_Item * it);
28690    EAPI void         elm_controlbar_item_disabled_set(Elm_Controlbar_Item * it, Eina_Bool disabled);
28691    EAPI Eina_Bool    elm_controlbar_item_disabled_get(const Elm_Controlbar_Item * it);
28692    EAPI void         elm_controlbar_item_icon_set(Elm_Controlbar_Item *it, const char *icon_path);
28693    EAPI Evas_Object *elm_controlbar_item_icon_get(const Elm_Controlbar_Item *it);
28694    EAPI void         elm_controlbar_item_label_set(Elm_Controlbar_Item *it, const char *label);
28695    EAPI const char  *elm_controlbar_item_label_get(const Elm_Controlbar_Item *it);
28696    EAPI Elm_Controlbar_Item *elm_controlbar_selected_item_get(const Evas_Object *obj);
28697    EAPI Elm_Controlbar_Item *elm_controlbar_first_item_get(const Evas_Object *obj);
28698    EAPI Elm_Controlbar_Item *elm_controlbar_last_item_get(const Evas_Object *obj);
28699    EAPI const Eina_List   *elm_controlbar_items_get(const Evas_Object *obj);
28700    EAPI Elm_Controlbar_Item *elm_controlbar_item_prev(Elm_Controlbar_Item *it);
28701    EAPI Elm_Controlbar_Item *elm_controlbar_item_next(Elm_Controlbar_Item *it);
28702    EAPI void         elm_controlbar_item_view_set(Elm_Controlbar_Item *it, Evas_Object * view);
28703    EAPI Evas_Object *elm_controlbar_item_view_get(const Elm_Controlbar_Item *it);
28704    EAPI Evas_Object *elm_controlbar_item_view_unset(Elm_Controlbar_Item *it);
28705    EAPI Evas_Object *elm_controlbar_item_button_get(const Elm_Controlbar_Item *it);
28706    EAPI void         elm_controlbar_mode_set(Evas_Object *obj, int mode);
28707    EAPI void         elm_controlbar_alpha_set(Evas_Object *obj, int alpha);
28708    EAPI void         elm_controlbar_item_auto_align_set(Evas_Object *obj, Eina_Bool auto_align);
28709    EAPI void         elm_controlbar_vertical_set(Evas_Object *obj, Eina_Bool vertical);
28710
28711    /* SearchBar */
28712    EAPI Evas_Object *elm_searchbar_add(Evas_Object *parent);
28713    EAPI void         elm_searchbar_text_set(Evas_Object *obj, const char *entry);
28714    EAPI const char  *elm_searchbar_text_get(Evas_Object *obj);
28715    EAPI Evas_Object *elm_searchbar_entry_get(Evas_Object *obj);
28716    EAPI Evas_Object *elm_searchbar_editfield_get(Evas_Object *obj);
28717    EAPI void         elm_searchbar_cancel_button_animation_set(Evas_Object *obj, Eina_Bool cancel_btn_ani_flag);
28718    EAPI void         elm_searchbar_cancel_button_set(Evas_Object *obj, Eina_Bool visible);
28719    EAPI void         elm_searchbar_clear(Evas_Object *obj);
28720    EAPI void         elm_searchbar_boundary_rect_set(Evas_Object *obj, Eina_Bool boundary);
28721
28722    EAPI Evas_Object *elm_page_control_add(Evas_Object *parent);
28723    EAPI void         elm_page_control_page_count_set(Evas_Object *obj, unsigned int page_count);
28724    EAPI void         elm_page_control_page_id_set(Evas_Object *obj, unsigned int page_id);
28725    EAPI unsigned int elm_page_control_page_id_get(Evas_Object *obj);
28726
28727    /* NoContents */
28728    EAPI Evas_Object *elm_nocontents_add(Evas_Object *parent);
28729    EAPI void         elm_nocontents_label_set(Evas_Object *obj, const char *label);
28730    EAPI const char  *elm_nocontents_label_get(const Evas_Object *obj);
28731    EAPI void         elm_nocontents_custom_set(const Evas_Object *obj, Evas_Object *custom);
28732    EAPI Evas_Object *elm_nocontents_custom_get(const Evas_Object *obj);
28733
28734    /* TickerNoti */
28735    typedef enum
28736      {
28737         ELM_TICKERNOTI_ORIENT_TOP = 0,
28738         ELM_TICKERNOTI_ORIENT_BOTTOM,
28739         ELM_TICKERNOTI_ORIENT_LAST
28740      }  Elm_Tickernoti_Orient;
28741
28742    EAPI Evas_Object              *elm_tickernoti_add (Evas_Object *parent);
28743    EAPI void                      elm_tickernoti_orient_set (Evas_Object *obj, Elm_Tickernoti_Orient orient) EINA_ARG_NONNULL(1);
28744    EAPI Elm_Tickernoti_Orient     elm_tickernoti_orient_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
28745    EAPI int                       elm_tickernoti_rotation_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
28746    EAPI void                      elm_tickernoti_rotation_set (Evas_Object *obj, int angle) EINA_ARG_NONNULL(1);
28747    EAPI Evas_Object              *elm_tickernoti_win_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
28748    /* #### Below APIs and data structures are going to be deprecated, announcment will be made soon ####*/
28749    typedef enum
28750     {
28751        ELM_TICKERNOTI_DEFAULT,
28752        ELM_TICKERNOTI_DETAILVIEW
28753     } Elm_Tickernoti_Mode;
28754    EAPI void                      elm_tickernoti_detailview_label_set (Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
28755    EAPI const char               *elm_tickernoti_detailview_label_get (const Evas_Object *obj)EINA_ARG_NONNULL(1);
28756    EAPI void                      elm_tickernoti_detailview_button_set (Evas_Object *obj, Evas_Object *button) EINA_ARG_NONNULL(2);
28757    EAPI Evas_Object              *elm_tickernoti_detailview_button_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
28758    EAPI void                      elm_tickernoti_detailview_icon_set (Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
28759    EAPI Evas_Object              *elm_tickernoti_detailview_icon_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
28760    EAPI Evas_Object              *elm_tickernoti_detailview_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
28761    EAPI void                      elm_tickernoti_mode_set (Evas_Object *obj, Elm_Tickernoti_Mode mode) EINA_ARG_NONNULL(1);
28762    EAPI Elm_Tickernoti_Mode       elm_tickernoti_mode_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
28763    EAPI void                      elm_tickernoti_orientation_set (Evas_Object *obj, Elm_Tickernoti_Orient orient) EINA_ARG_NONNULL(1);
28764    EAPI Elm_Tickernoti_Orient     elm_tickernoti_orientation_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
28765    EAPI void                      elm_tickernoti_label_set (Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
28766    EAPI const char               *elm_tickernoti_label_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
28767    EAPI void                      elm_tickernoti_icon_set (Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
28768    EAPI Evas_Object              *elm_tickernoti_icon_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
28769    EAPI void                      elm_tickernoti_button_set (Evas_Object *obj, Evas_Object *button) EINA_ARG_NONNULL(1);
28770    EAPI Evas_Object              *elm_tickernoti_button_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
28771    /* ############################################################################### */
28772    /*
28773     * Parts which can be used with elm_object_text_part_set() and
28774     * elm_object_text_part_get():
28775     *
28776     * @li NULL/"default" - Operates on tickernoti content-text
28777     *
28778     * Parts which can be used with elm_object_content_part_set() and
28779     * elm_object_content_part_get():
28780     *
28781     * @li "icon" - Operates on tickernoti's icon
28782     * @li "button" - Operates on tickernoti's button
28783     *
28784     * smart callbacks called:
28785     * @li "clicked" - emitted when tickernoti is clicked, except at the
28786     * swallow/button region, if any.
28787     * @li "hide" - emitted when the tickernoti is completely hidden. In case of
28788     * any hide animation, this signal is emitted after the animation.
28789     */
28790
28791    /* colorpalette */
28792    typedef struct _Colorpalette_Color Elm_Colorpalette_Color;
28793
28794    struct _Colorpalette_Color
28795      {
28796         unsigned int r, g, b;
28797      };
28798
28799    EAPI Evas_Object *elm_colorpalette_add(Evas_Object *parent);
28800    EAPI void         elm_colorpalette_color_set(Evas_Object *obj, int color_num, Elm_Colorpalette_Color *color);
28801    EAPI void         elm_colorpalette_row_column_set(Evas_Object *obj, int row, int col);
28802    /* smart callbacks called:
28803     * "clicked" - when image clicked
28804     */
28805
28806    /* editfield */
28807    EAPI Evas_Object *elm_editfield_add(Evas_Object *parent);
28808    EAPI void         elm_editfield_label_set(Evas_Object *obj, const char *label);
28809    EAPI const char  *elm_editfield_label_get(Evas_Object *obj);
28810    EAPI void         elm_editfield_guide_text_set(Evas_Object *obj, const char *text);
28811    EAPI const char  *elm_editfield_guide_text_get(Evas_Object *obj);
28812    EAPI Evas_Object *elm_editfield_entry_get(Evas_Object *obj);
28813 //   EAPI Evas_Object *elm_editfield_clear_button_show(Evas_Object *obj, Eina_Bool show);
28814    EAPI void         elm_editfield_right_icon_set(Evas_Object *obj, Evas_Object *icon);
28815    EAPI Evas_Object *elm_editfield_right_icon_get(Evas_Object *obj);
28816    EAPI void         elm_editfield_left_icon_set(Evas_Object *obj, Evas_Object *icon);
28817    EAPI Evas_Object *elm_editfield_left_icon_get(Evas_Object *obj);
28818    EAPI void         elm_editfield_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line);
28819    EAPI Eina_Bool    elm_editfield_entry_single_line_get(Evas_Object *obj);
28820    EAPI void         elm_editfield_eraser_set(Evas_Object *obj, Eina_Bool visible);
28821    EAPI Eina_Bool    elm_editfield_eraser_get(Evas_Object *obj);
28822    /* smart callbacks called:
28823     * "clicked" - when an editfield is clicked
28824     * "unfocused" - when an editfield is unfocused
28825     */
28826
28827
28828    /* Sliding Drawer */
28829    typedef enum _Elm_SlidingDrawer_Pos
28830      {
28831         ELM_SLIDINGDRAWER_BOTTOM,
28832         ELM_SLIDINGDRAWER_LEFT,
28833         ELM_SLIDINGDRAWER_RIGHT,
28834         ELM_SLIDINGDRAWER_TOP
28835      } Elm_SlidingDrawer_Pos;
28836
28837    typedef struct _Elm_SlidingDrawer_Drag_Value
28838      {
28839         double x, y;
28840      } Elm_SlidingDrawer_Drag_Value;
28841
28842    EINA_DEPRECATED EAPI Evas_Object *elm_slidingdrawer_add(Evas_Object *parent);
28843    EINA_DEPRECATED EAPI void         elm_slidingdrawer_content_set (Evas_Object *obj, Evas_Object *content);
28844    EINA_DEPRECATED EAPI Evas_Object *elm_slidingdrawer_content_unset(Evas_Object *obj);
28845    EINA_DEPRECATED EAPI void         elm_slidingdrawer_pos_set(Evas_Object *obj, Elm_SlidingDrawer_Pos pos);
28846    EINA_DEPRECATED EAPI void         elm_slidingdrawer_max_drag_value_set(Evas_Object *obj, double dw,  double dh);
28847    EINA_DEPRECATED EAPI void         elm_slidingdrawer_drag_value_set(Evas_Object *obj, double dx, double dy);
28848
28849    /* multibuttonentry */
28850    typedef struct _Multibuttonentry_Item Elm_Multibuttonentry_Item;
28851    typedef Eina_Bool (*Elm_Multibuttonentry_Item_Verify_Callback) (Evas_Object *obj, const char *item_label, void *item_data, void *data);
28852    EAPI Evas_Object               *elm_multibuttonentry_add(Evas_Object *parent);
28853    EAPI const char                *elm_multibuttonentry_label_get(Evas_Object *obj);
28854    EAPI void                       elm_multibuttonentry_label_set(Evas_Object *obj, const char *label);
28855    EAPI Evas_Object               *elm_multibuttonentry_entry_get(Evas_Object *obj);
28856    EAPI const char *               elm_multibuttonentry_guide_text_get(Evas_Object *obj);
28857    EAPI void                       elm_multibuttonentry_guide_text_set(Evas_Object *obj, const char *guidetext);
28858    EAPI int                        elm_multibuttonentry_contracted_state_get(Evas_Object *obj);
28859    EAPI void                       elm_multibuttonentry_contracted_state_set(Evas_Object *obj, int contracted);
28860    EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_add_start(Evas_Object *obj, const char *label, void *data);
28861    EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_add_end(Evas_Object *obj, const char *label, void *data);
28862    EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_add_before(Evas_Object *obj, const char *label, Elm_Multibuttonentry_Item *before, void *data);
28863    EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_add_after(Evas_Object *obj, const char *label, Elm_Multibuttonentry_Item *after, void *data);
28864    EAPI const Eina_List           *elm_multibuttonentry_items_get(Evas_Object *obj);
28865    EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_first_get(Evas_Object *obj);
28866    EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_last_get(Evas_Object *obj);
28867    EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_selected_get(Evas_Object *obj);
28868    EAPI void                       elm_multibuttonentry_item_selected_set(Elm_Multibuttonentry_Item *item);
28869    EAPI void                       elm_multibuttonentry_item_unselect_all(Evas_Object *obj);
28870    EAPI void                       elm_multibuttonentry_item_del(Elm_Multibuttonentry_Item *item);
28871    EAPI void                       elm_multibuttonentry_items_del(Evas_Object *obj);
28872    EAPI const char                *elm_multibuttonentry_item_label_get(Elm_Multibuttonentry_Item *item);
28873    EAPI void                       elm_multibuttonentry_item_label_set(Elm_Multibuttonentry_Item *item, const char *str);
28874    EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_prev(Elm_Multibuttonentry_Item *item);
28875    EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_next(Elm_Multibuttonentry_Item *item);
28876    EAPI void                      *elm_multibuttonentry_item_data_get(Elm_Multibuttonentry_Item *item);
28877    EAPI void                       elm_multibuttonentry_item_data_set(Elm_Multibuttonentry_Item *item, void *data);
28878    EAPI void                       elm_multibuttonentry_item_verify_callback_set(Evas_Object *obj, Elm_Multibuttonentry_Item_Verify_Callback func, void *data);
28879    /* smart callback called:
28880     * "selected" - This signal is emitted when the selected item of multibuttonentry is changed.
28881     * "added" - This signal is emitted when a new multibuttonentry item is added.
28882     * "deleted" - This signal is emitted when a multibuttonentry item is deleted.
28883     * "expanded" - This signal is emitted when a multibuttonentry is expanded.
28884     * "contracted" - This signal is emitted when a multibuttonentry is contracted.
28885     * "contracted,state,changed" - This signal is emitted when the contracted state of multibuttonentry is changed.
28886     * "item,selected" - This signal is emitted when the selected item of multibuttonentry is changed.
28887     * "item,added" - This signal is emitted when a new multibuttonentry item is added.
28888     * "item,deleted" - This signal is emitted when a multibuttonentry item is deleted.
28889     * "item,clicked" - This signal is emitted when a multibuttonentry item is clicked.
28890     * "clicked" - This signal is emitted when a multibuttonentry is clicked.
28891     * "unfocused" - This signal is emitted when a multibuttonentry is unfocused.
28892     */
28893    /* available styles:
28894     * default
28895     */
28896
28897    /* stackedicon */
28898    typedef struct _Stackedicon_Item Elm_Stackedicon_Item;
28899    EAPI Evas_Object          *elm_stackedicon_add(Evas_Object *parent);
28900    EAPI Elm_Stackedicon_Item *elm_stackedicon_item_append(Evas_Object *obj, const char *path);
28901    EAPI Elm_Stackedicon_Item *elm_stackedicon_item_prepend(Evas_Object *obj, const char *path);
28902    EAPI void                  elm_stackedicon_item_del(Elm_Stackedicon_Item *it);
28903    EAPI Eina_List            *elm_stackedicon_item_list_get(Evas_Object *obj);
28904    /* smart callback called:
28905     * "expanded" - This signal is emitted when a stackedicon is expanded.
28906     * "clicked" - This signal is emitted when a stackedicon is clicked.
28907     */
28908    /* available styles:
28909     * default
28910     */
28911
28912    /* dialoguegroup */
28913    typedef struct _Dialogue_Item Dialogue_Item;
28914
28915    typedef enum _Elm_Dialoguegourp_Item_Style
28916      {
28917         ELM_DIALOGUEGROUP_ITEM_STYLE_DEFAULT = 0,
28918         ELM_DIALOGUEGROUP_ITEM_STYLE_EDITFIELD = (1 << 0),
28919         ELM_DIALOGUEGROUP_ITEM_STYLE_EDITFIELD_WITH_TITLE = (1 << 1),
28920         ELM_DIALOGUEGROUP_ITEM_STYLE_EDIT_TITLE = (1 << 2),
28921         ELM_DIALOGUEGROUP_ITEM_STYLE_HIDDEN = (1 << 3),
28922         ELM_DIALOGUEGROUP_ITEM_STYLE_DATAVIEW = (1 << 4),
28923         ELM_DIALOGUEGROUP_ITEM_STYLE_NO_BG = (1 << 5),
28924         ELM_DIALOGUEGROUP_ITEM_STYLE_SUB = (1 << 6),
28925         ELM_DIALOGUEGROUP_ITEM_STYLE_EDIT = (1 << 7),
28926         ELM_DIALOGUEGROUP_ITEM_STYLE_EDIT_MERGE = (1 << 8),
28927         ELM_DIALOGUEGROUP_ITEM_STYLE_LAST = (1 << 9)
28928      } Elm_Dialoguegroup_Item_Style;
28929
28930    EINA_DEPRECATED EAPI Evas_Object   *elm_dialoguegroup_add(Evas_Object *parent);
28931    EINA_DEPRECATED EAPI Dialogue_Item *elm_dialoguegroup_append(Evas_Object *obj, Evas_Object *subobj, Elm_Dialoguegroup_Item_Style style);
28932    EINA_DEPRECATED EAPI Dialogue_Item *elm_dialoguegroup_prepend(Evas_Object *obj, Evas_Object *subobj, Elm_Dialoguegroup_Item_Style style);
28933    EINA_DEPRECATED EAPI Dialogue_Item *elm_dialoguegroup_insert_after(Evas_Object *obj, Evas_Object *subobj, Dialogue_Item *after, Elm_Dialoguegroup_Item_Style style);
28934    EINA_DEPRECATED EAPI Dialogue_Item *elm_dialoguegroup_insert_before(Evas_Object *obj, Evas_Object *subobj, Dialogue_Item *before, Elm_Dialoguegroup_Item_Style style);
28935    EINA_DEPRECATED EAPI void           elm_dialoguegroup_remove(Dialogue_Item *item);
28936    EINA_DEPRECATED EAPI void           elm_dialoguegroup_remove_all(Evas_Object *obj);
28937    EINA_DEPRECATED EAPI void           elm_dialoguegroup_title_set(Evas_Object *obj, const char *title);
28938    EINA_DEPRECATED EAPI const char    *elm_dialoguegroup_title_get(Evas_Object *obj);
28939    EINA_DEPRECATED EAPI void           elm_dialoguegroup_press_effect_set(Dialogue_Item *item, Eina_Bool press);
28940    EINA_DEPRECATED EAPI Eina_Bool      elm_dialoguegroup_press_effect_get(Dialogue_Item *item);
28941    EINA_DEPRECATED EAPI Evas_Object   *elm_dialoguegroup_item_content_get(Dialogue_Item *item);
28942    EINA_DEPRECATED EAPI void           elm_dialoguegroup_item_style_set(Dialogue_Item *item, Elm_Dialoguegroup_Item_Style style);
28943    EINA_DEPRECATED EAPI Elm_Dialoguegroup_Item_Style    elm_dialoguegroup_item_style_get(Dialogue_Item *item);
28944    EINA_DEPRECATED EAPI void           elm_dialoguegroup_item_disabled_set(Dialogue_Item *item, Eina_Bool disabled);
28945    EINA_DEPRECATED EAPI Eina_Bool      elm_dialoguegroup_item_disabled_get(Dialogue_Item *item);
28946
28947    /* Dayselector */
28948    typedef enum
28949      {
28950         ELM_DAYSELECTOR_SUN,
28951         ELM_DAYSELECTOR_MON,
28952         ELM_DAYSELECTOR_TUE,
28953         ELM_DAYSELECTOR_WED,
28954         ELM_DAYSELECTOR_THU,
28955         ELM_DAYSELECTOR_FRI,
28956         ELM_DAYSELECTOR_SAT
28957      } Elm_DaySelector_Day;
28958
28959    EAPI Evas_Object *elm_dayselector_add(Evas_Object *parent);
28960    EAPI Eina_Bool    elm_dayselector_check_state_get(Evas_Object *obj, Elm_DaySelector_Day day);
28961    EAPI void         elm_dayselector_check_state_set(Evas_Object *obj, Elm_DaySelector_Day day, Eina_Bool checked);
28962
28963    /* Image Slider */
28964    typedef struct _Imageslider_Item Elm_Imageslider_Item;
28965    typedef void (*Elm_Imageslider_Cb)(void *data, Evas_Object *obj, void *event_info);
28966    EAPI Evas_Object           *elm_imageslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
28967    EAPI Elm_Imageslider_Item  *elm_imageslider_item_append(Evas_Object *obj, const char *photo_file, Elm_Imageslider_Cb func, void *data) EINA_ARG_NONNULL(1);
28968    EAPI Elm_Imageslider_Item  *elm_imageslider_item_append_relative(Evas_Object *obj, const char *photo_file, Elm_Imageslider_Cb func, unsigned int index, void *data) EINA_ARG_NONNULL(1);
28969    EAPI Elm_Imageslider_Item  *elm_imageslider_item_prepend(Evas_Object *obj, const char *photo_file, Elm_Imageslider_Cb func, void *data) EINA_ARG_NONNULL(1);
28970    EAPI void                   elm_imageslider_item_del(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
28971    EAPI Elm_Imageslider_Item  *elm_imageslider_selected_item_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
28972    EAPI Eina_Bool              elm_imageslider_item_selected_get(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
28973    EAPI void                   elm_imageslider_item_selected_set(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
28974    EAPI const char            *elm_imageslider_item_photo_file_get(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
28975    EAPI Elm_Imageslider_Item  *elm_imageslider_item_prev(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
28976    EAPI Elm_Imageslider_Item  *elm_imageslider_item_next(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
28977    EAPI void                   elm_imageslider_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
28978    EAPI void                   elm_imageslider_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
28979    EAPI void                   elm_imageslider_item_photo_file_set(Elm_Imageslider_Item *it, const char *photo_file) EINA_ARG_NONNULL(1,2);
28980    EAPI void                   elm_imageslider_item_update(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
28981 #ifdef __cplusplus
28982 }
28983 #endif
28984
28985 #endif