Please find the Attached patch for Password show last feature's set,get APIs.
[framework/uifw/elementary.git] / src / lib / Elementary.h.in
1 /*
2  *
3  * vim:ts=8:sw=3:sts=3:expandtab:cino=>5n-3f0^-2{2(0W1st0
4  */
5
6 /**
7 @file Elementary.h.in
8 @brief Elementary Widget Library
9 */
10
11 /**
12 @mainpage Elementary
13 @image html  elementary.png
14 @version 0.7.0
15 @date 2008-2011
16
17 @section intro What is Elementary?
18
19 This is a VERY SIMPLE toolkit. It is not meant for writing extensive desktop
20 applications (yet). Small simple ones with simple needs.
21
22 It is meant to make the programmers work almost brainless but give them lots
23 of flexibility.
24
25 @li @ref Start - Go here to quickly get started with writing Apps
26
27 @section organization Organization
28
29 One can divide Elemementary into three main groups:
30 @li @ref infralist - These are modules that deal with Elementary as a whole.
31 @li @ref widgetslist - These are the widgets you'll compose your UI out of.
32 @li @ref containerslist - These are the containers in which the widgets will be
33                           layouted.
34
35 @section license License
36
37 LGPL v2 (see COPYING in the base of Elementary's source). This applies to
38 all files in the source tree.
39
40 @section ack Acknowledgements
41 There is a lot that goes into making a widget set, and they don't happen out of
42 nothing. It's like trying to make everyone everywhere happy, regardless of age,
43 gender, race or nationality - and that is really tough. So thanks to people and
44 organisations behind this, as listed in the @ref authors page.
45 */
46
47
48 /**
49  * @defgroup Start Getting Started
50  *
51  * To write an Elementary app, you can get started with the following:
52  *
53 @code
54 #include <Elementary.h>
55 EAPI int
56 elm_main(int argc, char **argv)
57 {
58    // create window(s) here and do any application init
59    elm_run(); // run main loop
60    elm_shutdown(); // after mainloop finishes running, shutdown
61    return 0; // exit 0 for exit code
62 }
63 ELM_MAIN()
64 @endcode
65  *
66  * To use autotools (which helps in many ways in the long run, like being able
67  * to immediately create releases of your software directly from your tree
68  * and ensure everything needed to build it is there) you will need a
69  * configure.ac, Makefile.am and autogen.sh file.
70  *
71  * configure.ac:
72  *
73 @verbatim
74 AC_INIT(myapp, 0.0.0, myname@mydomain.com)
75 AC_PREREQ(2.52)
76 AC_CONFIG_SRCDIR(configure.ac)
77 AM_CONFIG_HEADER(config.h)
78 AC_PROG_CC
79 AM_INIT_AUTOMAKE(1.6 dist-bzip2)
80 PKG_CHECK_MODULES([ELEMENTARY], elementary)
81 AC_OUTPUT(Makefile)
82 @endverbatim
83  *
84  * Makefile.am:
85  *
86 @verbatim
87 AUTOMAKE_OPTIONS = 1.4 foreign
88 MAINTAINERCLEANFILES = Makefile.in aclocal.m4 config.h.in configure depcomp install-sh missing
89
90 INCLUDES = -I$(top_srcdir)
91
92 bin_PROGRAMS = myapp
93
94 myapp_SOURCES = main.c
95 myapp_LDADD = @ELEMENTARY_LIBS@
96 myapp_CFLAGS = @ELEMENTARY_CFLAGS@
97 @endverbatim
98  *
99  * autogen.sh:
100  *
101 @verbatim
102 #!/bin/sh
103 echo "Running aclocal..." ; aclocal $ACLOCAL_FLAGS || exit 1
104 echo "Running autoheader..." ; autoheader || exit 1
105 echo "Running autoconf..." ; autoconf || exit 1
106 echo "Running automake..." ; automake --add-missing --copy --gnu || exit 1
107 ./configure "$@"
108 @endverbatim
109  *
110  * To generate all the things needed to bootstrap just run:
111  *
112 @verbatim
113 ./autogen.sh
114 @endverbatim
115  *
116  * This will generate Makefile.in's, the confgure script and everything else.
117  * After this it works like all normal autotools projects:
118 @verbatim
119 ./configure
120 make
121 sudo make install
122 @endverbatim
123  *
124  * Note sudo was assumed to get root permissions, as this would install in
125  * /usr/local which is system-owned. Use any way you like to gain root, or
126  * specify a different prefix with configure:
127  *
128 @verbatim
129 ./confiugre --prefix=$HOME/mysoftware
130 @endverbatim
131  *
132  * Also remember that autotools buys you some useful commands like:
133 @verbatim
134 make uninstall
135 @endverbatim
136  *
137  * This uninstalls the software after it was installed with "make install".
138  * It is very useful to clear up what you built if you wish to clean the
139  * system.
140  *
141 @verbatim
142 make distcheck
143 @endverbatim
144  *
145  * This firstly checks if your build tree is "clean" and ready for
146  * distribution. It also builds a tarball (myapp-0.0.0.tar.gz) that is
147  * ready to upload and distribute to the world, that contains the generated
148  * Makefile.in's and configure script. The users do not need to run
149  * autogen.sh - just configure and on. They don't need autotools installed.
150  * This tarball also builds cleanly, has all the sources it needs to build
151  * included (that is sources for your application, not libraries it depends
152  * on like Elementary). It builds cleanly in a buildroot and does not
153  * contain any files that are temporarily generated like binaries and other
154  * build-generated files, so the tarball is clean, and no need to worry
155  * about cleaning up your tree before packaging.
156  *
157 @verbatim
158 make clean
159 @endverbatim
160  *
161  * This cleans up all build files (binaries, objects etc.) from the tree.
162  *
163 @verbatim
164 make distclean
165 @endverbatim
166  *
167  * This cleans out all files from the build and from configure's output too.
168  *
169 @verbatim
170 make maintainer-clean
171 @endverbatim
172  *
173  * This deletes all the files autogen.sh will produce so the tree is clean
174  * to be put into a revision-control system (like CVS, SVN or GIT for example).
175  *
176  * There is a more advanced way of making use of the quicklaunch infrastructure
177  * in Elementary (which will not be covered here due to its more advanced
178  * nature).
179  *
180  * Now let's actually create an interactive "Hello World" gui that you can
181  * click the ok button to exit. It's more code because this now does something
182  * much more significant, but it's still very simple:
183  *
184 @code
185 #include <Elementary.h>
186
187 static void
188 on_done(void *data, Evas_Object *obj, void *event_info)
189 {
190    // quit the mainloop (elm_run function will return)
191    elm_exit();
192 }
193
194 EAPI int
195 elm_main(int argc, char **argv)
196 {
197    Evas_Object *win, *bg, *box, *lab, *btn;
198
199    // new window - do the usual and give it a name, title and delete handler
200    win = elm_win_add(NULL, "hello", ELM_WIN_BASIC);
201    elm_win_title_set(win, "Hello");
202    // when the user clicks "close" on a window there is a request to delete
203    evas_object_smart_callback_add(win, "delete,request", on_done, NULL);
204
205    // add a standard bg
206    bg = elm_bg_add(win);
207    // add object as a resize object for the window (controls window minimum
208    // size as well as gets resized if window is resized)
209    elm_win_resize_object_add(win, bg);
210    evas_object_show(bg);
211
212    // add a box object - default is vertical. a box holds children in a row,
213    // either horizontally or vertically. nothing more.
214    box = elm_box_add(win);
215    // make the box hotizontal
216    elm_box_horizontal_set(box, EINA_TRUE);
217    // add object as a resize object for the window (controls window minimum
218    // size as well as gets resized if window is resized)
219    elm_win_resize_object_add(win, box);
220    evas_object_show(box);
221
222    // add a label widget, set the text and put it in the pad frame
223    lab = elm_label_add(win);
224    // set default text of the label
225    elm_object_text_set(lab, "Hello out there world!");
226    // pack the label at the end of the box
227    elm_box_pack_end(box, lab);
228    evas_object_show(lab);
229
230    // add an ok button
231    btn = elm_button_add(win);
232    // set default text of button to "OK"
233    elm_object_text_set(btn, "OK");
234    // pack the button at the end of the box
235    elm_box_pack_end(box, btn);
236    evas_object_show(btn);
237    // call on_done when button is clicked
238    evas_object_smart_callback_add(btn, "clicked", on_done, NULL);
239
240    // now we are done, show the window
241    evas_object_show(win);
242
243    // run the mainloop and process events and callbacks
244    elm_run();
245    return 0;
246 }
247 ELM_MAIN()
248 @endcode
249    *
250    */
251
252 /**
253 @page authors Authors
254 @author Carsten Haitzler <raster@@rasterman.com>
255 @author Gustavo Sverzut Barbieri <barbieri@@profusion.mobi>
256 @author Cedric Bail <cedric.bail@@free.fr>
257 @author Vincent Torri <vtorri@@univ-evry.fr>
258 @author Daniel Kolesa <quaker66@@gmail.com>
259 @author Jaime Thomas <avi.thomas@@gmail.com>
260 @author Swisscom - http://www.swisscom.ch/
261 @author Christopher Michael <devilhorns@@comcast.net>
262 @author Marco Trevisan (Treviño) <mail@@3v1n0.net>
263 @author Michael Bouchaud <michael.bouchaud@@gmail.com>
264 @author Jonathan Atton (Watchwolf) <jonathan.atton@@gmail.com>
265 @author Brian Wang <brian.wang.0721@@gmail.com>
266 @author Mike Blumenkrantz (zmike) <mike@@zentific.com>
267 @author Samsung Electronics <tbd>
268 @author Samsung SAIT <tbd>
269 @author Brett Nash <nash@@nash.id.au>
270 @author Bruno Dilly <bdilly@@profusion.mobi>
271 @author Rafael Fonseca <rfonseca@@profusion.mobi>
272 @author Chuneon Park <hermet@@hermet.pe.kr>
273 @author Woohyun Jung <wh0705.jung@@samsung.com>
274 @author Jaehwan Kim <jae.hwan.kim@@samsung.com>
275 @author Wonguk Jeong <wonguk.jeong@@samsung.com>
276 @author Leandro A. F. Pereira <leandro@@profusion.mobi>
277 @author Helen Fornazier <helen.fornazier@@profusion.mobi>
278 @author Gustavo Lima Chaves <glima@@profusion.mobi>
279 @author Fabiano Fidêncio <fidencio@@profusion.mobi>
280 @author Tiago Falcão <tiago@@profusion.mobi>
281 @author Otavio Pontes <otavio@@profusion.mobi>
282 @author Viktor Kojouharov <vkojouharov@@gmail.com>
283 @author Daniel Juyung Seo (SeoZ) <juyung.seo@@samsung.com> <seojuyung2@@gmail.com>
284 @author Sangho Park <sangho.g.park@@samsung.com> <gouache95@@gmail.com>
285 @author Rajeev Ranjan (Rajeev) <rajeev.r@@samsung.com> <rajeev.jnnce@@gmail.com>
286 @author Seunggyun Kim <sgyun.kim@@samsung.com> <tmdrbs@@gmail.com>
287 @author Sohyun Kim <anna1014.kim@@samsung.com> <sohyun.anna@@gmail.com>
288 @author Jihoon Kim <jihoon48.kim@@samsung.com>
289 @author Jeonghyun Yun (arosis) <jh0506.yun@@samsung.com>
290 @author Tom Hacohen <tom@@stosb.com>
291 @author Aharon Hillel <a.hillel@@partner.samsung.com>
292 @author Jonathan Atton (Watchwolf) <jonathan.atton@@gmail.com>
293 @author Shinwoo Kim <kimcinoo@@gmail.com>
294 @author Govindaraju SM <govi.sm@@samsung.com> <govism@@gmail.com>
295 @author Prince Kumar Dubey <prince.dubey@@samsung.com> <prince.dubey@@gmail.com>
296 @author Sung W. Park <sungwoo@gmail.com>
297 @author Thierry el Borgi <thierry@substantiel.fr>
298 @author Shilpa Singh <shilpa.singh@samsung.com> <shilpasingh.o@gmail.com>
299 @author Chanwook Jung <joey.jung@samsung.com>
300
301 Please contact <enlightenment-devel@lists.sourceforge.net> to get in
302 contact with the developers and maintainers.
303  */
304
305 #ifndef ELEMENTARY_H
306 #define ELEMENTARY_H
307
308 /**
309  * @file Elementary.h
310  * @brief Elementary's API
311  *
312  * Elementary API.
313  */
314
315 @ELM_UNIX_DEF@ ELM_UNIX
316 @ELM_WIN32_DEF@ ELM_WIN32
317 @ELM_WINCE_DEF@ ELM_WINCE
318 @ELM_EDBUS_DEF@ ELM_EDBUS
319 @ELM_EFREET_DEF@ ELM_EFREET
320 @ELM_ETHUMB_DEF@ ELM_ETHUMB
321 @ELM_EMAP_DEF@ ELM_EMAP
322 @ELM_DEBUG_DEF@ ELM_DEBUG
323 @ELM_ALLOCA_H_DEF@ ELM_ALLOCA_H
324 @ELM_LIBINTL_H_DEF@ ELM_LIBINTL_H
325
326 /* Standard headers for standard system calls etc. */
327 #include <stdio.h>
328 #include <stdlib.h>
329 #include <unistd.h>
330 #include <string.h>
331 #include <sys/types.h>
332 #include <sys/stat.h>
333 #include <sys/time.h>
334 #include <sys/param.h>
335 #include <dlfcn.h>
336 #include <math.h>
337 #include <fnmatch.h>
338 #include <limits.h>
339 #include <ctype.h>
340 #include <time.h>
341 #include <dirent.h>
342 #include <pwd.h>
343 #include <errno.h>
344
345 #ifdef ELM_UNIX
346 # include <locale.h>
347 # ifdef ELM_LIBINTL_H
348 #  include <libintl.h>
349 # endif
350 # include <signal.h>
351 # include <grp.h>
352 # include <glob.h>
353 #endif
354
355 #ifdef ELM_ALLOCA_H
356 # include <alloca.h>
357 #endif
358
359 #if defined (ELM_WIN32) || defined (ELM_WINCE)
360 # include <malloc.h>
361 # ifndef alloca
362 #  define alloca _alloca
363 # endif
364 #endif
365
366
367 /* EFL headers */
368 #include <Eina.h>
369 #include <Eet.h>
370 #include <Evas.h>
371 #include <Evas_GL.h>
372 #include <Ecore.h>
373 #include <Ecore_Evas.h>
374 #include <Ecore_File.h>
375 #include <Ecore_IMF.h>
376 #include <Ecore_Con.h>
377 #include <Edje.h>
378
379 #ifdef ELM_EDBUS
380 # include <E_DBus.h>
381 #endif
382
383 #ifdef ELM_EFREET
384 # include <Efreet.h>
385 # include <Efreet_Mime.h>
386 # include <Efreet_Trash.h>
387 #endif
388
389 #ifdef ELM_ETHUMB
390 # include <Ethumb_Client.h>
391 #endif
392
393 #ifdef ELM_EMAP
394 # include <EMap.h>
395 #endif
396
397 #ifdef EAPI
398 # undef EAPI
399 #endif
400
401 #ifdef _WIN32
402 # ifdef ELEMENTARY_BUILD
403 #  ifdef DLL_EXPORT
404 #   define EAPI __declspec(dllexport)
405 #  else
406 #   define EAPI
407 #  endif /* ! DLL_EXPORT */
408 # else
409 #  define EAPI __declspec(dllimport)
410 # endif /* ! EFL_EVAS_BUILD */
411 #else
412 # ifdef __GNUC__
413 #  if __GNUC__ >= 4
414 #   define EAPI __attribute__ ((visibility("default")))
415 #  else
416 #   define EAPI
417 #  endif
418 # else
419 #  define EAPI
420 # endif
421 #endif /* ! _WIN32 */
422
423
424 /* allow usage from c++ */
425 #ifdef __cplusplus
426 extern "C" {
427 #endif
428
429 #define ELM_VERSION_MAJOR @VMAJ@
430 #define ELM_VERSION_MINOR @VMIN@
431
432    typedef struct _Elm_Version
433      {
434         int major;
435         int minor;
436         int micro;
437         int revision;
438      } Elm_Version;
439
440    EAPI extern Elm_Version *elm_version;
441
442 /* handy macros */
443 #define ELM_RECTS_INTERSECT(x, y, w, h, xx, yy, ww, hh) (((x) < ((xx) + (ww))) && ((y) < ((yy) + (hh))) && (((x) + (w)) > (xx)) && (((y) + (h)) > (yy)))
444 #define ELM_PI 3.14159265358979323846
445
446    /**
447     * @defgroup General General
448     *
449     * @brief General Elementary API. Functions that don't relate to
450     * Elementary objects specifically.
451     *
452     * Here are documented functions which init/shutdown the library,
453     * that apply to generic Elementary objects, that deal with
454     * configuration, et cetera.
455     *
456     * @ref general_functions_example_page "This" example contemplates
457     * some of these functions.
458     */
459
460    /**
461     * @addtogroup General
462     * @{
463     */
464
465   /**
466    * Defines couple of standard Evas_Object layers to be used
467    * with evas_object_layer_set().
468    *
469    * @note whenever extending with new values, try to keep some padding
470    *       to siblings so there is room for further extensions.
471    */
472   typedef enum _Elm_Object_Layer
473     {
474        ELM_OBJECT_LAYER_BACKGROUND = EVAS_LAYER_MIN + 64, /**< where to place backgrounds */
475        ELM_OBJECT_LAYER_DEFAULT = 0, /**< Evas_Object default layer (and thus for Elementary) */
476        ELM_OBJECT_LAYER_FOCUS = EVAS_LAYER_MAX - 128, /**< where focus object visualization is */
477        ELM_OBJECT_LAYER_TOOLTIP = EVAS_LAYER_MAX - 64, /**< where to show tooltips */
478        ELM_OBJECT_LAYER_CURSOR = EVAS_LAYER_MAX - 32, /**< where to show cursors */
479        ELM_OBJECT_LAYER_LAST /**< last layer known by Elementary */
480     } Elm_Object_Layer;
481
482 /**************************************************************************/
483    EAPI extern int ELM_ECORE_EVENT_ETHUMB_CONNECT;
484
485    /**
486     * Emitted when any Elementary's policy value is changed.
487     */
488    EAPI extern int ELM_EVENT_POLICY_CHANGED;
489
490    /**
491     * @typedef Elm_Event_Policy_Changed
492     *
493     * Data on the event when an Elementary policy has changed
494     */
495     typedef struct _Elm_Event_Policy_Changed Elm_Event_Policy_Changed;
496
497    /**
498     * @struct _Elm_Event_Policy_Changed
499     *
500     * Data on the event when an Elementary policy has changed
501     */
502     struct _Elm_Event_Policy_Changed
503      {
504         unsigned int policy; /**< the policy identifier */
505         int          new_value; /**< value the policy had before the change */
506         int          old_value; /**< new value the policy got */
507     };
508
509    /**
510     * Policy identifiers.
511     */
512     typedef enum _Elm_Policy
513     {
514         ELM_POLICY_QUIT, /**< under which circumstances the application
515                           * should quit automatically. @see
516                           * Elm_Policy_Quit.
517                           */
518         ELM_POLICY_LAST
519     } Elm_Policy; /**< Elementary policy identifiers/groups enumeration.  @see elm_policy_set()
520  */
521
522    typedef enum _Elm_Policy_Quit
523      {
524         ELM_POLICY_QUIT_NONE = 0, /**< never quit the application
525                                    * automatically */
526         ELM_POLICY_QUIT_LAST_WINDOW_CLOSED /**< quit when the
527                                             * application's last
528                                             * window is closed */
529      } Elm_Policy_Quit; /**< Possible values for the #ELM_POLICY_QUIT policy */
530
531    typedef enum _Elm_Focus_Direction
532      {
533         ELM_FOCUS_PREVIOUS,
534         ELM_FOCUS_NEXT
535      } Elm_Focus_Direction;
536
537    typedef enum _Elm_Text_Format
538      {
539         ELM_TEXT_FORMAT_PLAIN_UTF8,
540         ELM_TEXT_FORMAT_MARKUP_UTF8
541      } Elm_Text_Format;
542
543    /**
544     * Line wrapping types.
545     */
546    typedef enum _Elm_Wrap_Type
547      {
548         ELM_WRAP_NONE = 0, /**< No wrap - value is zero */
549         ELM_WRAP_CHAR, /**< Char wrap - wrap between characters */
550         ELM_WRAP_WORD, /**< Word wrap - wrap in allowed wrapping points (as defined in the unicode standard) */
551         ELM_WRAP_MIXED, /**< Mixed wrap - Word wrap, and if that fails, char wrap. */
552         ELM_WRAP_LAST
553      } Elm_Wrap_Type;
554
555    /**
556     * @typedef Elm_Object_Item
557     * An Elementary Object item handle.
558     * @ingroup General
559     */
560    typedef struct _Elm_Object_Item Elm_Object_Item;
561
562
563    /**
564     * Called back when a widget's tooltip is activated and needs content.
565     * @param data user-data given to elm_object_tooltip_content_cb_set()
566     * @param obj owner widget.
567     * @param tooltip The tooltip object (affix content to this!)
568     */
569    typedef Evas_Object *(*Elm_Tooltip_Content_Cb) (void *data, Evas_Object *obj, Evas_Object *tooltip);
570
571    /**
572     * Called back when a widget's item tooltip is activated and needs content.
573     * @param data user-data given to elm_object_tooltip_content_cb_set()
574     * @param obj owner widget.
575     * @param tooltip The tooltip object (affix content to this!)
576     * @param item context dependent item. As an example, if tooltip was
577     *        set on Elm_List_Item, then it is of this type.
578     */
579    typedef Evas_Object *(*Elm_Tooltip_Item_Content_Cb) (void *data, Evas_Object *obj, Evas_Object *tooltip, void *item);
580
581    typedef Eina_Bool (*Elm_Event_Cb) (void *data, Evas_Object *obj, Evas_Object *src, Evas_Callback_Type type, void *event_info); /**< Function prototype definition for callbacks on input events happening on Elementary widgets. @a data will receive the user data pointer passed to elm_object_event_callback_add(). @a src will be a pointer to the widget on which the input event took place. @a type will get the type of this event and @a event_info, the struct with details on this event. */
582
583 #ifndef ELM_LIB_QUICKLAUNCH
584 #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 */
585 #else
586 #define ELM_MAIN() int main(int argc, char **argv) {return elm_quicklaunch_fallback(argc, argv);} /**< macro to be used after the elm_main() function */
587 #endif
588
589 /**************************************************************************/
590    /* General calls */
591
592    /**
593     * Initialize Elementary
594     *
595     * @param[in] argc System's argument count value
596     * @param[in] argv System's pointer to array of argument strings
597     * @return The init counter value.
598     *
599     * This function initializes Elementary and increments a counter of
600     * the number of calls to it. It returns the new counter's value.
601     *
602     * @warning This call is exported only for use by the @c ELM_MAIN()
603     * macro. There is no need to use this if you use this macro (which
604     * is highly advisable). An elm_main() should contain the entry
605     * point code for your application, having the same prototype as
606     * elm_init(), and @b not being static (putting the @c EAPI symbol
607     * in front of its type declaration is advisable). The @c
608     * ELM_MAIN() call should be placed just after it.
609     *
610     * Example:
611     * @dontinclude bg_example_01.c
612     * @skip static void
613     * @until ELM_MAIN
614     *
615     * See the full @ref bg_example_01_c "example".
616     *
617     * @see elm_shutdown().
618     * @ingroup General
619     */
620    EAPI int          elm_init(int argc, char **argv);
621
622    /**
623     * Shut down Elementary
624     *
625     * @return The init counter value.
626     *
627     * This should be called at the end of your application, just
628     * before it ceases to do any more processing. This will clean up
629     * any permanent resources your application may have allocated via
630     * Elementary that would otherwise persist.
631     *
632     * @see elm_init() for an example
633     *
634     * @ingroup General
635     */
636    EAPI int          elm_shutdown(void);
637
638    /**
639     * Run Elementary's main loop
640     *
641     * This call should be issued just after all initialization is
642     * completed. This function will not return until elm_exit() is
643     * called. It will keep looping, running the main
644     * (event/processing) loop for Elementary.
645     *
646     * @see elm_init() for an example
647     *
648     * @ingroup General
649     */
650    EAPI void         elm_run(void);
651
652    /**
653     * Exit Elementary's main loop
654     *
655     * If this call is issued, it will flag the main loop to cease
656     * processing and return back to its parent function (usually your
657     * elm_main() function).
658     *
659     * @see elm_init() for an example. There, just after a request to
660     * close the window comes, the main loop will be left.
661     *
662     * @note By using the #ELM_POLICY_QUIT on your Elementary
663     * applications, you'll this function called automatically for you.
664     *
665     * @ingroup General
666     */
667    EAPI void         elm_exit(void);
668
669    /**
670     * Provide information in order to make Elementary determine the @b
671     * run time location of the software in question, so other data files
672     * such as images, sound files, executable utilities, libraries,
673     * modules and locale files can be found.
674     *
675     * @param mainfunc This is your application's main function name,
676     *        whose binary's location is to be found. Providing @c NULL
677     *        will make Elementary not to use it
678     * @param dom This will be used as the application's "domain", in the
679     *        form of a prefix to any environment variables that may
680     *        override prefix detection and the directory name, inside the
681     *        standard share or data directories, where the software's
682     *        data files will be looked for.
683     * @param checkfile This is an (optional) magic file's path to check
684     *        for existence (and it must be located in the data directory,
685     *        under the share directory provided above). Its presence will
686     *        help determine the prefix found was correct. Pass @c NULL if
687     *        the check is not to be done.
688     *
689     * This function allows one to re-locate the application somewhere
690     * else after compilation, if the developer wishes for easier
691     * distribution of pre-compiled binaries.
692     *
693     * The prefix system is designed to locate where the given software is
694     * installed (under a common path prefix) at run time and then report
695     * specific locations of this prefix and common directories inside
696     * this prefix like the binary, library, data and locale directories,
697     * through the @c elm_app_*_get() family of functions.
698     *
699     * Call elm_app_info_set() early on before you change working
700     * directory or anything about @c argv[0], so it gets accurate
701     * information.
702     *
703     * It will then try and trace back which file @p mainfunc comes from,
704     * if provided, to determine the application's prefix directory.
705     *
706     * The @p dom parameter provides a string prefix to prepend before
707     * environment variables, allowing a fallback to @b specific
708     * environment variables to locate the software. You would most
709     * probably provide a lowercase string there, because it will also
710     * serve as directory domain, explained next. For environment
711     * variables purposes, this string is made uppercase. For example if
712     * @c "myapp" is provided as the prefix, then the program would expect
713     * @c "MYAPP_PREFIX" as a master environment variable to specify the
714     * exact install prefix for the software, or more specific environment
715     * variables like @c "MYAPP_BIN_DIR", @c "MYAPP_LIB_DIR", @c
716     * "MYAPP_DATA_DIR" and @c "MYAPP_LOCALE_DIR", which could be set by
717     * the user or scripts before launching. If not provided (@c NULL),
718     * environment variables will not be used to override compiled-in
719     * defaults or auto detections.
720     *
721     * The @p dom string also provides a subdirectory inside the system
722     * shared data directory for data files. For example, if the system
723     * directory is @c /usr/local/share, then this directory name is
724     * appended, creating @c /usr/local/share/myapp, if it @p was @c
725     * "myapp". It is expected the application installs data files in
726     * this directory.
727     *
728     * The @p checkfile is a file name or path of something inside the
729     * share or data directory to be used to test that the prefix
730     * detection worked. For example, your app will install a wallpaper
731     * image as @c /usr/local/share/myapp/images/wallpaper.jpg and so to
732     * check that this worked, provide @c "images/wallpaper.jpg" as the @p
733     * checkfile string.
734     *
735     * @see elm_app_compile_bin_dir_set()
736     * @see elm_app_compile_lib_dir_set()
737     * @see elm_app_compile_data_dir_set()
738     * @see elm_app_compile_locale_set()
739     * @see elm_app_prefix_dir_get()
740     * @see elm_app_bin_dir_get()
741     * @see elm_app_lib_dir_get()
742     * @see elm_app_data_dir_get()
743     * @see elm_app_locale_dir_get()
744     */
745    EAPI void         elm_app_info_set(void *mainfunc, const char *dom, const char *checkfile);
746
747    /**
748     * Provide information on the @b fallback application's binaries
749     * directory, on scenarios where they get overriden by
750     * elm_app_info_set().
751     *
752     * @param dir The path to the default binaries directory (compile time
753     * one)
754     *
755     * @note Elementary will as well use this path to determine actual
756     * names of binaries' directory paths, maybe changing it to be @c
757     * something/local/bin instead of @c something/bin, only, for
758     * example.
759     *
760     * @warning You should call this function @b before
761     * elm_app_info_set().
762     */
763    EAPI void         elm_app_compile_bin_dir_set(const char *dir);
764
765    /**
766     * Provide information on the @b fallback application's libraries
767     * directory, on scenarios where they get overriden by
768     * elm_app_info_set().
769     *
770     * @param dir The path to the default libraries directory (compile
771     * time one)
772     *
773     * @note Elementary will as well use this path to determine actual
774     * names of libraries' directory paths, maybe changing it to be @c
775     * something/lib32 or @c something/lib64 instead of @c something/lib,
776     * only, for example.
777     *
778     * @warning You should call this function @b before
779     * elm_app_info_set().
780     */
781    EAPI void         elm_app_compile_lib_dir_set(const char *dir);
782
783    /**
784     * Provide information on the @b fallback application's data
785     * directory, on scenarios where they get overriden by
786     * elm_app_info_set().
787     *
788     * @param dir The path to the default data directory (compile time
789     * one)
790     *
791     * @note Elementary will as well use this path to determine actual
792     * names of data directory paths, maybe changing it to be @c
793     * something/local/share instead of @c something/share, only, for
794     * example.
795     *
796     * @warning You should call this function @b before
797     * elm_app_info_set().
798     */
799    EAPI void         elm_app_compile_data_dir_set(const char *dir);
800
801    /**
802     * Provide information on the @b fallback application's locale
803     * directory, on scenarios where they get overriden by
804     * elm_app_info_set().
805     *
806     * @param dir The path to the default locale directory (compile time
807     * one)
808     *
809     * @warning You should call this function @b before
810     * elm_app_info_set().
811     */
812    EAPI void         elm_app_compile_locale_set(const char *dir);
813
814    /**
815     * Retrieve the application's run time prefix directory, as set by
816     * elm_app_info_set() and the way (environment) the application was
817     * run from.
818     *
819     * @return The directory prefix the application is actually using
820     */
821    EAPI const char  *elm_app_prefix_dir_get(void);
822
823    /**
824     * Retrieve the application's run time binaries prefix directory, as
825     * set by elm_app_info_set() and the way (environment) the application
826     * was run from.
827     *
828     * @return The binaries directory prefix the application is actually
829     * using
830     */
831    EAPI const char  *elm_app_bin_dir_get(void);
832
833    /**
834     * Retrieve the application's run time libraries prefix directory, as
835     * set by elm_app_info_set() and the way (environment) the application
836     * was run from.
837     *
838     * @return The libraries directory prefix the application is actually
839     * using
840     */
841    EAPI const char  *elm_app_lib_dir_get(void);
842
843    /**
844     * Retrieve the application's run time data prefix directory, as
845     * set by elm_app_info_set() and the way (environment) the application
846     * was run from.
847     *
848     * @return The data directory prefix the application is actually
849     * using
850     */
851    EAPI const char  *elm_app_data_dir_get(void);
852
853    /**
854     * Retrieve the application's run time locale prefix directory, as
855     * set by elm_app_info_set() and the way (environment) the application
856     * was run from.
857     *
858     * @return The locale directory prefix the application is actually
859     * using
860     */
861    EAPI const char  *elm_app_locale_dir_get(void);
862
863    EAPI void         elm_quicklaunch_mode_set(Eina_Bool ql_on);
864    EAPI Eina_Bool    elm_quicklaunch_mode_get(void);
865    EAPI int          elm_quicklaunch_init(int argc, char **argv);
866    EAPI int          elm_quicklaunch_sub_init(int argc, char **argv);
867    EAPI int          elm_quicklaunch_sub_shutdown(void);
868    EAPI int          elm_quicklaunch_shutdown(void);
869    EAPI void         elm_quicklaunch_seed(void);
870    EAPI Eina_Bool    elm_quicklaunch_prepare(int argc, char **argv);
871    EAPI Eina_Bool    elm_quicklaunch_fork(int argc, char **argv, char *cwd, void (postfork_func) (void *data), void *postfork_data);
872    EAPI void         elm_quicklaunch_cleanup(void);
873    EAPI int          elm_quicklaunch_fallback(int argc, char **argv);
874    EAPI char        *elm_quicklaunch_exe_path_get(const char *exe);
875
876    EAPI Eina_Bool    elm_need_efreet(void);
877    EAPI Eina_Bool    elm_need_e_dbus(void);
878
879    /**
880     * This must be called before any other function that handle with
881     * elm_thumb objects or ethumb_client instances.
882     *
883     * @ingroup Thumb
884     */
885    EAPI Eina_Bool    elm_need_ethumb(void);
886
887    /**
888     * Set a new policy's value (for a given policy group/identifier).
889     *
890     * @param policy policy identifier, as in @ref Elm_Policy.
891     * @param value policy value, which depends on the identifier
892     *
893     * @return @c EINA_TRUE on success or @c EINA_FALSE, on error.
894     *
895     * Elementary policies define applications' behavior,
896     * somehow. These behaviors are divided in policy groups (see
897     * #Elm_Policy enumeration). This call will emit the Ecore event
898     * #ELM_EVENT_POLICY_CHANGED, which can be hooked at with
899     * handlers. An #Elm_Event_Policy_Changed struct will be passed,
900     * then.
901     *
902     * @note Currently, we have only one policy identifier/group
903     * (#ELM_POLICY_QUIT), which has two possible values.
904     *
905     * @ingroup General
906     */
907    EAPI Eina_Bool    elm_policy_set(unsigned int policy, int value);
908
909    /**
910     * Gets the policy value set for given policy identifier.
911     *
912     * @param policy policy identifier, as in #Elm_Policy.
913     * @return The currently set policy value, for that
914     * identifier. Will be @c 0 if @p policy passed is invalid.
915     *
916     * @ingroup General
917     */
918    EAPI int          elm_policy_get(unsigned int policy);
919
920    /**
921     * Set a label of an object
922     *
923     * @param obj The Elementary object
924     * @param part The text part name to set (NULL for the default label)
925     * @param label The new text of the label
926     *
927     * @note Elementary objects may have many labels (e.g. Action Slider)
928     *
929     * @ingroup General
930     */
931    EAPI void         elm_object_text_part_set(Evas_Object *obj, const char *part, const char *label);
932
933 #define elm_object_text_set(obj, label) elm_object_text_part_set((obj), NULL, (label))
934
935    /**
936     * Get a label of an object
937     *
938     * @param obj The Elementary object
939     * @param part The text part name to get (NULL for the default label)
940     * @return text of the label or NULL for any error
941     *
942     * @note Elementary objects may have many labels (e.g. Action Slider)
943     *
944     * @ingroup General
945     */
946    EAPI const char  *elm_object_text_part_get(const Evas_Object *obj, const char *part);
947
948 #define elm_object_text_get(obj) elm_object_text_part_get((obj), NULL)
949
950    /**
951     * Set a content of an object
952     *
953     * @param obj The Elementary object
954     * @param part The content part name to set (NULL for the default content)
955     * @param content The new content of the object
956     *
957     * @note Elementary objects may have many contents
958     *
959     * @ingroup General
960     */
961    EAPI void elm_object_content_part_set(Evas_Object *obj, const char *part, Evas_Object *content);
962
963 #define elm_object_content_set(obj, content) elm_object_content_part_set((obj), NULL, (content))
964
965    /**
966     * Get a content of an object
967     *
968     * @param obj The Elementary object
969     * @param item The content part name to get (NULL for the default content)
970     * @return content of the object or NULL for any error
971     *
972     * @note Elementary objects may have many contents
973     *
974     * @ingroup General
975     */
976    EAPI Evas_Object *elm_object_content_part_get(const Evas_Object *obj, const char *part);
977
978 #define elm_object_content_get(obj) elm_object_content_part_get((obj), NULL)
979
980    /**
981     * Unset a content of an object
982     *
983     * @param obj The Elementary object
984     * @param item The content part name to unset (NULL for the default content)
985     *
986     * @note Elementary objects may have many contents
987     *
988     * @ingroup General
989     */
990    EAPI Evas_Object *elm_object_content_part_unset(Evas_Object *obj, const char *part);
991
992 #define elm_object_content_unset(obj) elm_object_content_part_unset((obj), NULL)
993
994    /**
995     * Set a content of an object item
996     *
997     * @param it The Elementary object item
998     * @param part The content part name to unset (NULL for the default content)
999     * @param content The new content of the object item
1000     *
1001     * @note Elementary object items may have many contents
1002     *
1003     * @ingroup General
1004     */
1005    EAPI void elm_object_item_content_part_set(Elm_Object_Item *it, const char *part, Evas_Object *content);
1006
1007 #define elm_object_item_content_set(it, content) elm_object_item_content_part_set((it), NULL, (content))
1008
1009    /**
1010     * Get a content of an object item
1011     *
1012     * @param it The Elementary object item
1013     * @param part The content part name to unset (NULL for the default content)
1014     * @return content of the object item or NULL for any error
1015     *
1016     * @note Elementary object items may have many contents
1017     *
1018     * @ingroup General
1019     */
1020    EAPI Evas_Object *elm_object_item_content_part_get(const Elm_Object_Item *it, const char *item);
1021
1022 #define elm_object_item_content_get(it, content) elm_object_item_content_part_get((it), NULL, (content))
1023
1024    /**
1025     * Unset a content of an object item
1026     *
1027     * @param it The Elementary object item
1028     * @param part The content part name to unset (NULL for the default content)
1029     *
1030     * @note Elementary object items may have many contents
1031     *
1032     * @ingroup General
1033     */
1034    EAPI Evas_Object *elm_object_item_content_part_unset(Elm_Object_Item *it, const char *part);
1035
1036 #define elm_object_item_content_unset(it, content) elm_object_item_content_part_unset((it), (content))
1037
1038    /**
1039     * Set a label of an objec itemt
1040     *
1041     * @param it The Elementary object item
1042     * @param part The text part name to set (NULL for the default label)
1043     * @param label The new text of the label
1044     *
1045     * @note Elementary object items may have many labels
1046     *
1047     * @ingroup General
1048     */
1049    EAPI void elm_object_item_text_part_set(Elm_Object_Item *it, const char *part, const char *label);
1050
1051 #define elm_object_item_text_set(it, label) elm_object_item_text_part_set((it), NULL, (label))
1052
1053    /**
1054     * Get a label of an object
1055     *
1056     * @param it The Elementary object item
1057     * @param part The text part name to get (NULL for the default label)
1058     * @return text of the label or NULL for any error
1059     *
1060     * @note Elementary object items may have many labels
1061     *
1062     * @ingroup General
1063     */
1064    EAPI const char *elm_object_item_text_part_get(const Elm_Object_Item *it, const char *part);
1065
1066    /**
1067     * Set the text to read out when in accessibility mode
1068     *
1069     * @param obj The object which is to be described
1070     * @param txt The text that describes the widget to people with poor or no vision
1071     *
1072     * @ingroup General
1073     */
1074    EAPI void elm_object_access_info_set(Evas_Object *obj, const char *txt);
1075
1076    /**
1077     * Set the text to read out when in accessibility mode
1078     *
1079     * @param it The object item which is to be described
1080     * @param txt The text that describes the widget to people with poor or no vision
1081     *
1082     * @ingroup General
1083     */
1084    EAPI void elm_object_item_access_info_set(Elm_Object_Item *it, const char *txt);
1085
1086
1087 #define elm_object_item_text_get(it) elm_object_item_text_part_get((it), NULL)
1088
1089    /**
1090     * @}
1091     */
1092
1093    /**
1094     * @defgroup Caches Caches
1095     *
1096     * These are functions which let one fine-tune some cache values for
1097     * Elementary applications, thus allowing for performance adjustments.
1098     *
1099     * @{
1100     */
1101
1102    /**
1103     * @brief Flush all caches.
1104     *
1105     * Frees all data that was in cache and is not currently being used to reduce
1106     * memory usage. This frees Edje's, Evas' and Eet's cache. This is equivalent
1107     * to calling all of the following functions:
1108     * @li edje_file_cache_flush()
1109     * @li edje_collection_cache_flush()
1110     * @li eet_clearcache()
1111     * @li evas_image_cache_flush()
1112     * @li evas_font_cache_flush()
1113     * @li evas_render_dump()
1114     * @note Evas caches are flushed for every canvas associated with a window.
1115     *
1116     * @ingroup Caches
1117     */
1118    EAPI void         elm_all_flush(void);
1119
1120    /**
1121     * Get the configured cache flush interval time
1122     *
1123     * This gets the globally configured cache flush interval time, in
1124     * ticks
1125     *
1126     * @return The cache flush interval time
1127     * @ingroup Caches
1128     *
1129     * @see elm_all_flush()
1130     */
1131    EAPI int          elm_cache_flush_interval_get(void);
1132
1133    /**
1134     * Set the configured cache flush interval time
1135     *
1136     * This sets the globally configured cache flush interval time, in ticks
1137     *
1138     * @param size The cache flush interval time
1139     * @ingroup Caches
1140     *
1141     * @see elm_all_flush()
1142     */
1143    EAPI void         elm_cache_flush_interval_set(int size);
1144
1145    /**
1146     * Set the configured cache flush interval time for all applications on the
1147     * display
1148     *
1149     * This sets the globally configured cache flush interval time -- in ticks
1150     * -- for all applications on the display.
1151     *
1152     * @param size The cache flush interval time
1153     * @ingroup Caches
1154     */
1155    EAPI void         elm_cache_flush_interval_all_set(int size);
1156
1157    /**
1158     * Get the configured cache flush enabled state
1159     *
1160     * This gets the globally configured cache flush state - if it is enabled
1161     * or not. When cache flushing is enabled, elementary will regularly
1162     * (see elm_cache_flush_interval_get() ) flush caches and dump data out of
1163     * memory and allow usage to re-seed caches and data in memory where it
1164     * can do so. An idle application will thus minimise its memory usage as
1165     * data will be freed from memory and not be re-loaded as it is idle and
1166     * not rendering or doing anything graphically right now.
1167     *
1168     * @return The cache flush state
1169     * @ingroup Caches
1170     *
1171     * @see elm_all_flush()
1172     */
1173    EAPI Eina_Bool    elm_cache_flush_enabled_get(void);
1174
1175    /**
1176     * Set the configured cache flush enabled state
1177     *
1178     * This sets the globally configured cache flush enabled state
1179     *
1180     * @param size The cache flush enabled state
1181     * @ingroup Caches
1182     *
1183     * @see elm_all_flush()
1184     */
1185    EAPI void         elm_cache_flush_enabled_set(Eina_Bool enabled);
1186
1187    /**
1188     * Set the configured cache flush enabled state for all applications on the
1189     * display
1190     *
1191     * This sets the globally configured cache flush enabled state for all
1192     * applications on the display.
1193     *
1194     * @param size The cache flush enabled state
1195     * @ingroup Caches
1196     */
1197    EAPI void         elm_cache_flush_enabled_all_set(Eina_Bool enabled);
1198
1199    /**
1200     * Get the configured font cache size
1201     *
1202     * This gets the globally configured font cache size, in bytes
1203     *
1204     * @return The font cache size
1205     * @ingroup Caches
1206     */
1207    EAPI int          elm_font_cache_get(void);
1208
1209    /**
1210     * Set the configured font cache size
1211     *
1212     * This sets the globally configured font cache size, in bytes
1213     *
1214     * @param size The font cache size
1215     * @ingroup Caches
1216     */
1217    EAPI void         elm_font_cache_set(int size);
1218
1219    /**
1220     * Set the configured font cache size for all applications on the
1221     * display
1222     *
1223     * This sets the globally configured font cache size -- in bytes
1224     * -- for all applications on the display.
1225     *
1226     * @param size The font cache size
1227     * @ingroup Caches
1228     */
1229    EAPI void         elm_font_cache_all_set(int size);
1230
1231    /**
1232     * Get the configured image cache size
1233     *
1234     * This gets the globally configured image cache size, in bytes
1235     *
1236     * @return The image cache size
1237     * @ingroup Caches
1238     */
1239    EAPI int          elm_image_cache_get(void);
1240
1241    /**
1242     * Set the configured image cache size
1243     *
1244     * This sets the globally configured image cache size, in bytes
1245     *
1246     * @param size The image cache size
1247     * @ingroup Caches
1248     */
1249    EAPI void         elm_image_cache_set(int size);
1250
1251    /**
1252     * Set the configured image cache size for all applications on the
1253     * display
1254     *
1255     * This sets the globally configured image cache size -- in bytes
1256     * -- for all applications on the display.
1257     *
1258     * @param size The image cache size
1259     * @ingroup Caches
1260     */
1261    EAPI void         elm_image_cache_all_set(int size);
1262
1263    /**
1264     * Get the configured edje file cache size.
1265     *
1266     * This gets the globally configured edje file cache size, in number
1267     * of files.
1268     *
1269     * @return The edje file cache size
1270     * @ingroup Caches
1271     */
1272    EAPI int          elm_edje_file_cache_get(void);
1273
1274    /**
1275     * Set the configured edje file cache size
1276     *
1277     * This sets the globally configured edje file cache size, in number
1278     * of files.
1279     *
1280     * @param size The edje file cache size
1281     * @ingroup Caches
1282     */
1283    EAPI void         elm_edje_file_cache_set(int size);
1284
1285    /**
1286     * Set the configured edje file cache size for all applications on the
1287     * display
1288     *
1289     * This sets the globally configured edje file cache size -- in number
1290     * of files -- for all applications on the display.
1291     *
1292     * @param size The edje file cache size
1293     * @ingroup Caches
1294     */
1295    EAPI void         elm_edje_file_cache_all_set(int size);
1296
1297    /**
1298     * Get the configured edje collections (groups) cache size.
1299     *
1300     * This gets the globally configured edje collections cache size, in
1301     * number of collections.
1302     *
1303     * @return The edje collections cache size
1304     * @ingroup Caches
1305     */
1306    EAPI int          elm_edje_collection_cache_get(void);
1307
1308    /**
1309     * Set the configured edje collections (groups) cache size
1310     *
1311     * This sets the globally configured edje collections cache size, in
1312     * number of collections.
1313     *
1314     * @param size The edje collections cache size
1315     * @ingroup Caches
1316     */
1317    EAPI void         elm_edje_collection_cache_set(int size);
1318
1319    /**
1320     * Set the configured edje collections (groups) cache size for all
1321     * applications on the display
1322     *
1323     * This sets the globally configured edje collections cache size -- in
1324     * number of collections -- for all applications on the display.
1325     *
1326     * @param size The edje collections cache size
1327     * @ingroup Caches
1328     */
1329    EAPI void         elm_edje_collection_cache_all_set(int size);
1330
1331    /**
1332     * @}
1333     */
1334
1335    /**
1336     * @defgroup Scaling Widget Scaling
1337     *
1338     * Different widgets can be scaled independently. These functions
1339     * allow you to manipulate this scaling on a per-widget basis. The
1340     * object and all its children get their scaling factors multiplied
1341     * by the scale factor set. This is multiplicative, in that if a
1342     * child also has a scale size set it is in turn multiplied by its
1343     * parent's scale size. @c 1.0 means “don't scale”, @c 2.0 is
1344     * double size, @c 0.5 is half, etc.
1345     *
1346     * @ref general_functions_example_page "This" example contemplates
1347     * some of these functions.
1348     */
1349
1350    /**
1351     * Get the global scaling factor
1352     *
1353     * This gets the globally configured scaling factor that is applied to all
1354     * objects.
1355     *
1356     * @return The scaling factor
1357     * @ingroup Scaling
1358     */
1359    EAPI double       elm_scale_get(void);
1360
1361    /**
1362     * Set the global scaling factor
1363     *
1364     * This sets the globally configured scaling factor that is applied to all
1365     * objects.
1366     *
1367     * @param scale The scaling factor to set
1368     * @ingroup Scaling
1369     */
1370    EAPI void         elm_scale_set(double scale);
1371
1372    /**
1373     * Set the global scaling factor for all applications on the display
1374     *
1375     * This sets the globally configured scaling factor that is applied to all
1376     * objects for all applications.
1377     * @param scale The scaling factor to set
1378     * @ingroup Scaling
1379     */
1380    EAPI void         elm_scale_all_set(double scale);
1381
1382    /**
1383     * Set the scaling factor for a given Elementary object
1384     *
1385     * @param obj The Elementary to operate on
1386     * @param scale Scale factor (from @c 0.0 up, with @c 1.0 meaning
1387     * no scaling)
1388     *
1389     * @ingroup Scaling
1390     */
1391    EAPI void         elm_object_scale_set(Evas_Object *obj, double scale) EINA_ARG_NONNULL(1);
1392
1393    /**
1394     * Get the scaling factor for a given Elementary object
1395     *
1396     * @param obj The object
1397     * @return The scaling factor set by elm_object_scale_set()
1398     *
1399     * @ingroup Scaling
1400     */
1401    EAPI double       elm_object_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1402
1403    /**
1404     * @defgroup Password_last_show Password last input show
1405     *
1406     * Last show feature of password mode enables user to view
1407     * the last input entered for few seconds before masking it.
1408     * These functions allow to set this feature in password mode
1409     * of entry widget and also allow to manipulate the duration 
1410     * for which the input has to be visible.
1411     *
1412     * @{
1413     */
1414
1415    /**
1416     * Get show last setting of password mode.
1417     *
1418     * This gets the show last input setting of password mode which might be 
1419     * enabled or disabled.
1420     *
1421     * @return @c EINA_TRUE, if the last input show setting is enabled, @c EINA_FALSE
1422     *            if it's disabled.
1423     * @ingroup Password_last_show
1424     */
1425    EAPI Eina_Bool elm_password_show_last_get(void);
1426
1427    /**
1428     * Set show last setting in password mode.
1429     *
1430     * This enables or disables show last setting of password mode.
1431     *
1432     * @param password_show_last If EINA_TRUE enable's last input show in password mode.
1433     * @see elm_password_show_last_timeout_set()
1434     * @ingroup Password_last_show
1435     */
1436    EAPI void elm_password_show_last_set(Eina_Bool password_show_last);
1437
1438    /**
1439     * Get's the timeout value in last show password mode.
1440     *
1441     * This gets the time out value for which the last input entered in password
1442     * mode will be visible.
1443     *
1444     * @return The timeout value of last show password mode.
1445     * @ingroup Password_last_show
1446     */
1447    EAPI double elm_password_show_last_timeout_get(void);
1448
1449    /**
1450     * Set's the timeout value in last show password mode.
1451     *
1452     * This sets the time out value for which the last input entered in password
1453     * mode will be visible.
1454     *
1455     * @param password_show_last_timeout The timeout value.
1456     * @see elm_password_show_last_set()
1457     * @ingroup Password_last_show
1458     */
1459    EAPI void elm_password_show_last_timeout_set(double password_show_last_timeout);
1460
1461    /**
1462     * @defgroup UI-Mirroring Selective Widget mirroring
1463     *
1464     * These functions allow you to set ui-mirroring on specific
1465     * widgets or the whole interface. Widgets can be in one of two
1466     * modes, automatic and manual.  Automatic means they'll be changed
1467     * according to the system mirroring mode and manual means only
1468     * explicit changes will matter. You are not supposed to change
1469     * mirroring state of a widget set to automatic, will mostly work,
1470     * but the behavior is not really defined.
1471     *
1472     * @{
1473     */
1474
1475    EAPI Eina_Bool    elm_mirrored_get(void);
1476    EAPI void         elm_mirrored_set(Eina_Bool mirrored);
1477
1478    /**
1479     * Get the system mirrored mode. This determines the default mirrored mode
1480     * of widgets.
1481     *
1482     * @return EINA_TRUE if mirrored is set, EINA_FALSE otherwise
1483     */
1484    EAPI Eina_Bool    elm_object_mirrored_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1485
1486    /**
1487     * Set the system mirrored mode. This determines the default mirrored mode
1488     * of widgets.
1489     *
1490     * @param mirrored EINA_TRUE to set mirrored mode, EINA_FALSE to unset it.
1491     */
1492    EAPI void         elm_object_mirrored_set(Evas_Object *obj, Eina_Bool mirrored) EINA_ARG_NONNULL(1);
1493
1494    /**
1495     * Returns the widget's mirrored mode setting.
1496     *
1497     * @param obj The widget.
1498     * @return mirrored mode setting of the object.
1499     *
1500     **/
1501    EAPI Eina_Bool    elm_object_mirrored_automatic_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1502
1503    /**
1504     * Sets the widget's mirrored mode setting.
1505     * When widget in automatic mode, it follows the system mirrored mode set by
1506     * elm_mirrored_set().
1507     * @param obj The widget.
1508     * @param automatic EINA_TRUE for auto mirrored mode. EINA_FALSE for manual.
1509     */
1510    EAPI void         elm_object_mirrored_automatic_set(Evas_Object *obj, Eina_Bool automatic) EINA_ARG_NONNULL(1);
1511
1512    /**
1513     * @}
1514     */
1515
1516    /**
1517     * Set the style to use by a widget
1518     *
1519     * Sets the style name that will define the appearance of a widget. Styles
1520     * vary from widget to widget and may also be defined by other themes
1521     * by means of extensions and overlays.
1522     *
1523     * @param obj The Elementary widget to style
1524     * @param style The style name to use
1525     *
1526     * @see elm_theme_extension_add()
1527     * @see elm_theme_extension_del()
1528     * @see elm_theme_overlay_add()
1529     * @see elm_theme_overlay_del()
1530     *
1531     * @ingroup Styles
1532     */
1533    EAPI void         elm_object_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
1534    /**
1535     * Get the style used by the widget
1536     *
1537     * This gets the style being used for that widget. Note that the string
1538     * pointer is only valid as longas the object is valid and the style doesn't
1539     * change.
1540     *
1541     * @param obj The Elementary widget to query for its style
1542     * @return The style name used
1543     *
1544     * @see elm_object_style_set()
1545     *
1546     * @ingroup Styles
1547     */
1548    EAPI const char  *elm_object_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1549
1550    /**
1551     * @defgroup Styles Styles
1552     *
1553     * Widgets can have different styles of look. These generic API's
1554     * set styles of widgets, if they support them (and if the theme(s)
1555     * do).
1556     *
1557     * @ref general_functions_example_page "This" example contemplates
1558     * some of these functions.
1559     */
1560
1561    /**
1562     * Set the disabled state of an Elementary object.
1563     *
1564     * @param obj The Elementary object to operate on
1565     * @param disabled The state to put in in: @c EINA_TRUE for
1566     *        disabled, @c EINA_FALSE for enabled
1567     *
1568     * Elementary objects can be @b disabled, in which state they won't
1569     * receive input and, in general, will be themed differently from
1570     * their normal state, usually greyed out. Useful for contexts
1571     * where you don't want your users to interact with some of the
1572     * parts of you interface.
1573     *
1574     * This sets the state for the widget, either disabling it or
1575     * enabling it back.
1576     *
1577     * @ingroup Styles
1578     */
1579    EAPI void         elm_object_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
1580
1581    /**
1582     * Get the disabled state of an Elementary object.
1583     *
1584     * @param obj The Elementary object to operate on
1585     * @return @c EINA_TRUE, if the widget is disabled, @c EINA_FALSE
1586     *            if it's enabled (or on errors)
1587     *
1588     * This gets the state of the widget, which might be enabled or disabled.
1589     *
1590     * @ingroup Styles
1591     */
1592    EAPI Eina_Bool    elm_object_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1593
1594    /**
1595     * @defgroup WidgetNavigation Widget Tree Navigation.
1596     *
1597     * How to check if an Evas Object is an Elementary widget? How to
1598     * get the first elementary widget that is parent of the given
1599     * object?  These are all covered in widget tree navigation.
1600     *
1601     * @ref general_functions_example_page "This" example contemplates
1602     * some of these functions.
1603     */
1604
1605    /**
1606     * Check if the given Evas Object is an Elementary widget.
1607     *
1608     * @param obj the object to query.
1609     * @return @c EINA_TRUE if it is an elementary widget variant,
1610     *         @c EINA_FALSE otherwise
1611     * @ingroup WidgetNavigation
1612     */
1613    EAPI Eina_Bool    elm_object_widget_check(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1614
1615    /**
1616     * Get the first parent of the given object that is an Elementary
1617     * widget.
1618     *
1619     * @param obj the Elementary object to query parent from.
1620     * @return the parent object that is an Elementary widget, or @c
1621     *         NULL, if it was not found.
1622     *
1623     * Use this to query for an object's parent widget.
1624     *
1625     * @note Most of Elementary users wouldn't be mixing non-Elementary
1626     * smart objects in the objects tree of an application, as this is
1627     * an advanced usage of Elementary with Evas. So, except for the
1628     * application's window, which is the root of that tree, all other
1629     * objects would have valid Elementary widget parents.
1630     *
1631     * @ingroup WidgetNavigation
1632     */
1633    EAPI Evas_Object *elm_object_parent_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1634
1635    /**
1636     * Get the top level parent of an Elementary widget.
1637     *
1638     * @param obj The object to query.
1639     * @return The top level Elementary widget, or @c NULL if parent cannot be
1640     * found.
1641     * @ingroup WidgetNavigation
1642     */
1643    EAPI Evas_Object *elm_object_top_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1644
1645    /**
1646     * Get the string that represents this Elementary widget.
1647     *
1648     * @note Elementary is weird and exposes itself as a single
1649     *       Evas_Object_Smart_Class of type "elm_widget", so
1650     *       evas_object_type_get() always return that, making debug and
1651     *       language bindings hard. This function tries to mitigate this
1652     *       problem, but the solution is to change Elementary to use
1653     *       proper inheritance.
1654     *
1655     * @param obj the object to query.
1656     * @return Elementary widget name, or @c NULL if not a valid widget.
1657     * @ingroup WidgetNavigation
1658     */
1659    EAPI const char  *elm_object_widget_type_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1660
1661    /**
1662     * @defgroup Config Elementary Config
1663     *
1664     * Elementary configuration is formed by a set options bounded to a
1665     * given @ref Profile profile, like @ref Theme theme, @ref Fingers
1666     * "finger size", etc. These are functions with which one syncronizes
1667     * changes made to those values to the configuration storing files, de
1668     * facto. You most probably don't want to use the functions in this
1669     * group unlees you're writing an elementary configuration manager.
1670     *
1671     * @{
1672     */
1673
1674    /**
1675     * Save back Elementary's configuration, so that it will persist on
1676     * future sessions.
1677     *
1678     * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
1679     * @ingroup Config
1680     *
1681     * This function will take effect -- thus, do I/O -- immediately. Use
1682     * it when you want to apply all configuration changes at once. The
1683     * current configuration set will get saved onto the current profile
1684     * configuration file.
1685     *
1686     */
1687    EAPI Eina_Bool    elm_config_save(void);
1688
1689    /**
1690     * Reload Elementary's configuration, bounded to current selected
1691     * profile.
1692     *
1693     * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
1694     * @ingroup Config
1695     *
1696     * Useful when you want to force reloading of configuration values for
1697     * a profile. If one removes user custom configuration directories,
1698     * for example, it will force a reload with system values insted.
1699     *
1700     */
1701    EAPI void         elm_config_reload(void);
1702
1703    /**
1704     * @}
1705     */
1706
1707    /**
1708     * @defgroup Profile Elementary Profile
1709     *
1710     * Profiles are pre-set options that affect the whole look-and-feel of
1711     * Elementary-based applications. There are, for example, profiles
1712     * aimed at desktop computer applications and others aimed at mobile,
1713     * touchscreen-based ones. You most probably don't want to use the
1714     * functions in this group unlees you're writing an elementary
1715     * configuration manager.
1716     *
1717     * @{
1718     */
1719
1720    /**
1721     * Get Elementary's profile in use.
1722     *
1723     * This gets the global profile that is applied to all Elementary
1724     * applications.
1725     *
1726     * @return The profile's name
1727     * @ingroup Profile
1728     */
1729    EAPI const char  *elm_profile_current_get(void);
1730
1731    /**
1732     * Get an Elementary's profile directory path in the filesystem. One
1733     * may want to fetch a system profile's dir or an user one (fetched
1734     * inside $HOME).
1735     *
1736     * @param profile The profile's name
1737     * @param is_user Whether to lookup for an user profile (@c EINA_TRUE)
1738     *                or a system one (@c EINA_FALSE)
1739     * @return The profile's directory path.
1740     * @ingroup Profile
1741     *
1742     * @note You must free it with elm_profile_dir_free().
1743     */
1744    EAPI const char  *elm_profile_dir_get(const char *profile, Eina_Bool is_user);
1745
1746    /**
1747     * Free an Elementary's profile directory path, as returned by
1748     * elm_profile_dir_get().
1749     *
1750     * @param p_dir The profile's path
1751     * @ingroup Profile
1752     *
1753     */
1754    EAPI void         elm_profile_dir_free(const char *p_dir);
1755
1756    /**
1757     * Get Elementary's list of available profiles.
1758     *
1759     * @return The profiles list. List node data are the profile name
1760     *         strings.
1761     * @ingroup Profile
1762     *
1763     * @note One must free this list, after usage, with the function
1764     *       elm_profile_list_free().
1765     */
1766    EAPI Eina_List   *elm_profile_list_get(void);
1767
1768    /**
1769     * Free Elementary's list of available profiles.
1770     *
1771     * @param l The profiles list, as returned by elm_profile_list_get().
1772     * @ingroup Profile
1773     *
1774     */
1775    EAPI void         elm_profile_list_free(Eina_List *l);
1776
1777    /**
1778     * Set Elementary's profile.
1779     *
1780     * This sets the global profile that is applied to Elementary
1781     * applications. Just the process the call comes from will be
1782     * affected.
1783     *
1784     * @param profile The profile's name
1785     * @ingroup Profile
1786     *
1787     */
1788    EAPI void         elm_profile_set(const char *profile);
1789
1790    /**
1791     * Set Elementary's profile.
1792     *
1793     * This sets the global profile that is applied to all Elementary
1794     * applications. All running Elementary windows will be affected.
1795     *
1796     * @param profile The profile's name
1797     * @ingroup Profile
1798     *
1799     */
1800    EAPI void         elm_profile_all_set(const char *profile);
1801
1802    /**
1803     * @}
1804     */
1805
1806    /**
1807     * @defgroup Engine Elementary Engine
1808     *
1809     * These are functions setting and querying which rendering engine
1810     * Elementary will use for drawing its windows' pixels.
1811     *
1812     * The following are the available engines:
1813     * @li "software_x11"
1814     * @li "fb"
1815     * @li "directfb"
1816     * @li "software_16_x11"
1817     * @li "software_8_x11"
1818     * @li "xrender_x11"
1819     * @li "opengl_x11"
1820     * @li "software_gdi"
1821     * @li "software_16_wince_gdi"
1822     * @li "sdl"
1823     * @li "software_16_sdl"
1824     * @li "opengl_sdl"
1825     * @li "buffer"
1826     *
1827     * @{
1828     */
1829
1830    /**
1831     * @brief Get Elementary's rendering engine in use.
1832     *
1833     * @return The rendering engine's name
1834     * @note there's no need to free the returned string, here.
1835     *
1836     * This gets the global rendering engine that is applied to all Elementary
1837     * applications.
1838     *
1839     * @see elm_engine_set()
1840     */
1841    EAPI const char  *elm_engine_current_get(void);
1842
1843    /**
1844     * @brief Set Elementary's rendering engine for use.
1845     *
1846     * @param engine The rendering engine's name
1847     *
1848     * This sets global rendering engine that is applied to all Elementary
1849     * applications. Note that it will take effect only to Elementary windows
1850     * created after this is called.
1851     *
1852     * @see elm_win_add()
1853     */
1854    EAPI void         elm_engine_set(const char *engine);
1855
1856    /**
1857     * @}
1858     */
1859
1860    /**
1861     * @defgroup Fonts Elementary Fonts
1862     *
1863     * These are functions dealing with font rendering, selection and the
1864     * like for Elementary applications. One might fetch which system
1865     * fonts are there to use and set custom fonts for individual classes
1866     * of UI items containing text (text classes).
1867     *
1868     * @{
1869     */
1870
1871   typedef struct _Elm_Text_Class
1872     {
1873        const char *name;
1874        const char *desc;
1875     } Elm_Text_Class;
1876
1877   typedef struct _Elm_Font_Overlay
1878     {
1879        const char     *text_class;
1880        const char     *font;
1881        Evas_Font_Size  size;
1882     } Elm_Font_Overlay;
1883
1884   typedef struct _Elm_Font_Properties
1885     {
1886        const char *name;
1887        Eina_List  *styles;
1888     } Elm_Font_Properties;
1889
1890    /**
1891     * Get Elementary's list of supported text classes.
1892     *
1893     * @return The text classes list, with @c Elm_Text_Class blobs as data.
1894     * @ingroup Fonts
1895     *
1896     * Release the list with elm_text_classes_list_free().
1897     */
1898    EAPI const Eina_List     *elm_text_classes_list_get(void);
1899
1900    /**
1901     * Free Elementary's list of supported text classes.
1902     *
1903     * @ingroup Fonts
1904     *
1905     * @see elm_text_classes_list_get().
1906     */
1907    EAPI void                 elm_text_classes_list_free(const Eina_List *list);
1908
1909    /**
1910     * Get Elementary's list of font overlays, set with
1911     * elm_font_overlay_set().
1912     *
1913     * @return The font overlays list, with @c Elm_Font_Overlay blobs as
1914     * data.
1915     *
1916     * @ingroup Fonts
1917     *
1918     * For each text class, one can set a <b>font overlay</b> for it,
1919     * overriding the default font properties for that class coming from
1920     * the theme in use. There is no need to free this list.
1921     *
1922     * @see elm_font_overlay_set() and elm_font_overlay_unset().
1923     */
1924    EAPI const Eina_List     *elm_font_overlay_list_get(void);
1925
1926    /**
1927     * Set a font overlay for a given Elementary text class.
1928     *
1929     * @param text_class Text class name
1930     * @param font Font name and style string
1931     * @param size Font size
1932     *
1933     * @ingroup Fonts
1934     *
1935     * @p font has to be in the format returned by
1936     * elm_font_fontconfig_name_get(). @see elm_font_overlay_list_get()
1937     * and elm_font_overlay_unset().
1938     */
1939    EAPI void                 elm_font_overlay_set(const char *text_class, const char *font, Evas_Font_Size size);
1940
1941    /**
1942     * Unset a font overlay for a given Elementary text class.
1943     *
1944     * @param text_class Text class name
1945     *
1946     * @ingroup Fonts
1947     *
1948     * This will bring back text elements belonging to text class
1949     * @p text_class back to their default font settings.
1950     */
1951    EAPI void                 elm_font_overlay_unset(const char *text_class);
1952
1953    /**
1954     * Apply the changes made with elm_font_overlay_set() and
1955     * elm_font_overlay_unset() on the current Elementary window.
1956     *
1957     * @ingroup Fonts
1958     *
1959     * This applies all font overlays set to all objects in the UI.
1960     */
1961    EAPI void                 elm_font_overlay_apply(void);
1962
1963    /**
1964     * Apply the changes made with elm_font_overlay_set() and
1965     * elm_font_overlay_unset() on all Elementary application windows.
1966     *
1967     * @ingroup Fonts
1968     *
1969     * This applies all font overlays set to all objects in the UI.
1970     */
1971    EAPI void                 elm_font_overlay_all_apply(void);
1972
1973    /**
1974     * Translate a font (family) name string in fontconfig's font names
1975     * syntax into an @c Elm_Font_Properties struct.
1976     *
1977     * @param font The font name and styles string
1978     * @return the font properties struct
1979     *
1980     * @ingroup Fonts
1981     *
1982     * @note The reverse translation can be achived with
1983     * elm_font_fontconfig_name_get(), for one style only (single font
1984     * instance, not family).
1985     */
1986    EAPI Elm_Font_Properties *elm_font_properties_get(const char *font) EINA_ARG_NONNULL(1);
1987
1988    /**
1989     * Free font properties return by elm_font_properties_get().
1990     *
1991     * @param efp the font properties struct
1992     *
1993     * @ingroup Fonts
1994     */
1995    EAPI void                 elm_font_properties_free(Elm_Font_Properties *efp) EINA_ARG_NONNULL(1);
1996
1997    /**
1998     * Translate a font name, bound to a style, into fontconfig's font names
1999     * syntax.
2000     *
2001     * @param name The font (family) name
2002     * @param style The given style (may be @c NULL)
2003     *
2004     * @return the font name and style string
2005     *
2006     * @ingroup Fonts
2007     *
2008     * @note The reverse translation can be achived with
2009     * elm_font_properties_get(), for one style only (single font
2010     * instance, not family).
2011     */
2012    EAPI const char          *elm_font_fontconfig_name_get(const char *name, const char *style) EINA_ARG_NONNULL(1);
2013
2014    /**
2015     * Free the font string return by elm_font_fontconfig_name_get().
2016     *
2017     * @param efp the font properties struct
2018     *
2019     * @ingroup Fonts
2020     */
2021    EAPI void                 elm_font_fontconfig_name_free(const char *name) EINA_ARG_NONNULL(1);
2022
2023    /**
2024     * Create a font hash table of available system fonts.
2025     *
2026     * One must call it with @p list being the return value of
2027     * evas_font_available_list(). The hash will be indexed by font
2028     * (family) names, being its values @c Elm_Font_Properties blobs.
2029     *
2030     * @param list The list of available system fonts, as returned by
2031     * evas_font_available_list().
2032     * @return the font hash.
2033     *
2034     * @ingroup Fonts
2035     *
2036     * @note The user is supposed to get it populated at least with 3
2037     * default font families (Sans, Serif, Monospace), which should be
2038     * present on most systems.
2039     */
2040    EAPI Eina_Hash           *elm_font_available_hash_add(Eina_List *list);
2041
2042    /**
2043     * Free the hash return by elm_font_available_hash_add().
2044     *
2045     * @param hash the hash to be freed.
2046     *
2047     * @ingroup Fonts
2048     */
2049    EAPI void                 elm_font_available_hash_del(Eina_Hash *hash);
2050
2051    /**
2052     * @}
2053     */
2054
2055    /**
2056     * @defgroup Fingers Fingers
2057     *
2058     * Elementary is designed to be finger-friendly for touchscreens,
2059     * and so in addition to scaling for display resolution, it can
2060     * also scale based on finger "resolution" (or size). You can then
2061     * customize the granularity of the areas meant to receive clicks
2062     * on touchscreens.
2063     *
2064     * Different profiles may have pre-set values for finger sizes.
2065     *
2066     * @ref general_functions_example_page "This" example contemplates
2067     * some of these functions.
2068     *
2069     * @{
2070     */
2071
2072    /**
2073     * Get the configured "finger size"
2074     *
2075     * @return The finger size
2076     *
2077     * This gets the globally configured finger size, <b>in pixels</b>
2078     *
2079     * @ingroup Fingers
2080     */
2081    EAPI Evas_Coord       elm_finger_size_get(void);
2082
2083    /**
2084     * Set the configured finger size
2085     *
2086     * This sets the globally configured finger size in pixels
2087     *
2088     * @param size The finger size
2089     * @ingroup Fingers
2090     */
2091    EAPI void             elm_finger_size_set(Evas_Coord size);
2092
2093    /**
2094     * Set the configured finger size for all applications on the display
2095     *
2096     * This sets the globally configured finger size in pixels for all
2097     * applications on the display
2098     *
2099     * @param size The finger size
2100     * @ingroup Fingers
2101     */
2102    EAPI void             elm_finger_size_all_set(Evas_Coord size);
2103
2104    /**
2105     * @}
2106     */
2107
2108    /**
2109     * @defgroup Focus Focus
2110     *
2111     * An Elementary application has, at all times, one (and only one)
2112     * @b focused object. This is what determines where the input
2113     * events go to within the application's window. Also, focused
2114     * objects can be decorated differently, in order to signal to the
2115     * user where the input is, at a given moment.
2116     *
2117     * Elementary applications also have the concept of <b>focus
2118     * chain</b>: one can cycle through all the windows' focusable
2119     * objects by input (tab key) or programmatically. The default
2120     * focus chain for an application is the one define by the order in
2121     * which the widgets where added in code. One will cycle through
2122     * top level widgets, and, for each one containg sub-objects, cycle
2123     * through them all, before returning to the level
2124     * above. Elementary also allows one to set @b custom focus chains
2125     * for their applications.
2126     *
2127     * Besides the focused decoration a widget may exhibit, when it
2128     * gets focus, Elementary has a @b global focus highlight object
2129     * that can be enabled for a window. If one chooses to do so, this
2130     * extra highlight effect will surround the current focused object,
2131     * too.
2132     *
2133     * @note Some Elementary widgets are @b unfocusable, after
2134     * creation, by their very nature: they are not meant to be
2135     * interacted with input events, but are there just for visual
2136     * purposes.
2137     *
2138     * @ref general_functions_example_page "This" example contemplates
2139     * some of these functions.
2140     */
2141
2142    /**
2143     * Get the enable status of the focus highlight
2144     *
2145     * This gets whether the highlight on focused objects is enabled or not
2146     * @ingroup Focus
2147     */
2148    EAPI Eina_Bool        elm_focus_highlight_enabled_get(void);
2149
2150    /**
2151     * Set the enable status of the focus highlight
2152     *
2153     * Set whether to show or not the highlight on focused objects
2154     * @param enable Enable highlight if EINA_TRUE, disable otherwise
2155     * @ingroup Focus
2156     */
2157    EAPI void             elm_focus_highlight_enabled_set(Eina_Bool enable);
2158
2159    /**
2160     * Get the enable status of the highlight animation
2161     *
2162     * Get whether the focus highlight, if enabled, will animate its switch from
2163     * one object to the next
2164     * @ingroup Focus
2165     */
2166    EAPI Eina_Bool        elm_focus_highlight_animate_get(void);
2167
2168    /**
2169     * Set the enable status of the highlight animation
2170     *
2171     * Set whether the focus highlight, if enabled, will animate its switch from
2172     * one object to the next
2173     * @param animate Enable animation if EINA_TRUE, disable otherwise
2174     * @ingroup Focus
2175     */
2176    EAPI void             elm_focus_highlight_animate_set(Eina_Bool animate);
2177
2178    /**
2179     * Get the whether an Elementary object has the focus or not.
2180     *
2181     * @param obj The Elementary object to get the information from
2182     * @return @c EINA_TRUE, if the object is focused, @c EINA_FALSE if
2183     *            not (and on errors).
2184     *
2185     * @see elm_object_focus_set()
2186     *
2187     * @ingroup Focus
2188     */
2189    EAPI Eina_Bool        elm_object_focus_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2190
2191    /**
2192     * Set/unset focus to a given Elementary object.
2193     *
2194     * @param obj The Elementary object to operate on.
2195     * @param enable @c EINA_TRUE Set focus to a given object,
2196     *               @c EINA_FALSE Unset focus to a given object.
2197     *
2198     * @note When you set focus to this object, if it can handle focus, will
2199     * take the focus away from the one who had it previously and will, for
2200     * now on, be the one receiving input events. Unsetting focus will remove
2201     * the focus from @p obj, passing it back to the previous element in the
2202     * focus chain list.
2203     *
2204     * @see elm_object_focus_get(), elm_object_focus_custom_chain_get()
2205     *
2206     * @ingroup Focus
2207     */
2208    EAPI void             elm_object_focus_set(Evas_Object *obj, Eina_Bool focus) EINA_ARG_NONNULL(1);
2209
2210    /**
2211     * Make a given Elementary object the focused one.
2212     *
2213     * @param obj The Elementary object to make focused.
2214     *
2215     * @note This object, if it can handle focus, will take the focus
2216     * away from the one who had it previously and will, for now on, be
2217     * the one receiving input events.
2218     *
2219     * @see elm_object_focus_get()
2220     * @deprecated use elm_object_focus_set() instead.
2221     *
2222     * @ingroup Focus
2223     */
2224    EINA_DEPRECATED EAPI void             elm_object_focus(Evas_Object *obj) EINA_ARG_NONNULL(1);
2225
2226    /**
2227     * Remove the focus from an Elementary object
2228     *
2229     * @param obj The Elementary to take focus from
2230     *
2231     * This removes the focus from @p obj, passing it back to the
2232     * previous element in the focus chain list.
2233     *
2234     * @see elm_object_focus() and elm_object_focus_custom_chain_get()
2235     * @deprecated use elm_object_focus_set() instead.
2236     *
2237     * @ingroup Focus
2238     */
2239    EINA_DEPRECATED EAPI void             elm_object_unfocus(Evas_Object *obj) EINA_ARG_NONNULL(1);
2240
2241    /**
2242     * Set the ability for an Element object to be focused
2243     *
2244     * @param obj The Elementary object to operate on
2245     * @param enable @c EINA_TRUE if the object can be focused, @c
2246     *        EINA_FALSE if not (and on errors)
2247     *
2248     * This sets whether the object @p obj is able to take focus or
2249     * not. Unfocusable objects do nothing when programmatically
2250     * focused, being the nearest focusable parent object the one
2251     * really getting focus. Also, when they receive mouse input, they
2252     * will get the event, but not take away the focus from where it
2253     * was previously.
2254     *
2255     * @ingroup Focus
2256     */
2257    EAPI void             elm_object_focus_allow_set(Evas_Object *obj, Eina_Bool enable) EINA_ARG_NONNULL(1);
2258
2259    /**
2260     * Get whether an Elementary object is focusable or not
2261     *
2262     * @param obj The Elementary object to operate on
2263     * @return @c EINA_TRUE if the object is allowed to be focused, @c
2264     *             EINA_FALSE if not (and on errors)
2265     *
2266     * @note Objects which are meant to be interacted with by input
2267     * events are created able to be focused, by default. All the
2268     * others are not.
2269     *
2270     * @ingroup Focus
2271     */
2272    EAPI Eina_Bool        elm_object_focus_allow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2273
2274    /**
2275     * Set custom focus chain.
2276     *
2277     * This function overwrites any previous custom focus chain within
2278     * the list of objects. The previous list will be deleted and this list
2279     * will be managed by elementary. After it is set, don't modify it.
2280     *
2281     * @note On focus cycle, only will be evaluated children of this container.
2282     *
2283     * @param obj The container object
2284     * @param objs Chain of objects to pass focus
2285     * @ingroup Focus
2286     */
2287    EAPI void             elm_object_focus_custom_chain_set(Evas_Object *obj, Eina_List *objs) EINA_ARG_NONNULL(1);
2288
2289    /**
2290     * Unset a custom focus chain on a given Elementary widget
2291     *
2292     * @param obj The container object to remove focus chain from
2293     *
2294     * Any focus chain previously set on @p obj (for its child objects)
2295     * is removed entirely after this call.
2296     *
2297     * @ingroup Focus
2298     */
2299    EAPI void             elm_object_focus_custom_chain_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2300
2301    /**
2302     * Get custom focus chain
2303     *
2304     * @param obj The container object
2305     * @ingroup Focus
2306     */
2307    EAPI const Eina_List *elm_object_focus_custom_chain_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2308
2309    /**
2310     * Append object to custom focus chain.
2311     *
2312     * @note If relative_child equal to NULL or not in custom chain, the object
2313     * will be added in end.
2314     *
2315     * @note On focus cycle, only will be evaluated children of this container.
2316     *
2317     * @param obj The container object
2318     * @param child The child to be added in custom chain
2319     * @param relative_child The relative object to position the child
2320     * @ingroup Focus
2321     */
2322    EAPI void             elm_object_focus_custom_chain_append(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
2323
2324    /**
2325     * Prepend object to custom focus chain.
2326     *
2327     * @note If relative_child equal to NULL or not in custom chain, the object
2328     * will be added in begin.
2329     *
2330     * @note On focus cycle, only will be evaluated children of this container.
2331     *
2332     * @param obj The container object
2333     * @param child The child to be added in custom chain
2334     * @param relative_child The relative object to position the child
2335     * @ingroup Focus
2336     */
2337    EAPI void             elm_object_focus_custom_chain_prepend(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
2338
2339    /**
2340     * Give focus to next object in object tree.
2341     *
2342     * Give focus to next object in focus chain of one object sub-tree.
2343     * If the last object of chain already have focus, the focus will go to the
2344     * first object of chain.
2345     *
2346     * @param obj The object root of sub-tree
2347     * @param dir Direction to cycle the focus
2348     *
2349     * @ingroup Focus
2350     */
2351    EAPI void             elm_object_focus_cycle(Evas_Object *obj, Elm_Focus_Direction dir) EINA_ARG_NONNULL(1);
2352
2353    /**
2354     * Give focus to near object in one direction.
2355     *
2356     * Give focus to near object in direction of one object.
2357     * If none focusable object in given direction, the focus will not change.
2358     *
2359     * @param obj The reference object
2360     * @param x Horizontal component of direction to focus
2361     * @param y Vertical component of direction to focus
2362     *
2363     * @ingroup Focus
2364     */
2365    EAPI void             elm_object_focus_direction_go(Evas_Object *obj, int x, int y) EINA_ARG_NONNULL(1);
2366
2367    /**
2368     * Make the elementary object and its children to be unfocusable
2369     * (or focusable).
2370     *
2371     * @param obj The Elementary object to operate on
2372     * @param tree_unfocusable @c EINA_TRUE for unfocusable,
2373     *        @c EINA_FALSE for focusable.
2374     *
2375     * This sets whether the object @p obj and its children objects
2376     * are able to take focus or not. If the tree is set as unfocusable,
2377     * newest focused object which is not in this tree will get focus.
2378     * This API can be helpful for an object to be deleted.
2379     * When an object will be deleted soon, it and its children may not
2380     * want to get focus (by focus reverting or by other focus controls).
2381     * Then, just use this API before deleting.
2382     *
2383     * @see elm_object_tree_unfocusable_get()
2384     *
2385     * @ingroup Focus
2386     */
2387    EAPI void             elm_object_tree_unfocusable_set(Evas_Object *obj, Eina_Bool tree_unfocusable); EINA_ARG_NONNULL(1);
2388
2389    /**
2390     * Get whether an Elementary object and its children are unfocusable or not.
2391     *
2392     * @param obj The Elementary object to get the information from
2393     * @return @c EINA_TRUE, if the tree is unfocussable,
2394     *         @c EINA_FALSE if not (and on errors).
2395     *
2396     * @see elm_object_tree_unfocusable_set()
2397     *
2398     * @ingroup Focus
2399     */
2400    EAPI Eina_Bool        elm_object_tree_unfocusable_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
2401
2402    /**
2403     * @defgroup Scrolling Scrolling
2404     *
2405     * These are functions setting how scrollable views in Elementary
2406     * widgets should behave on user interaction.
2407     *
2408     * @{
2409     */
2410
2411    /**
2412     * Get whether scrollers should bounce when they reach their
2413     * viewport's edge during a scroll.
2414     *
2415     * @return the thumb scroll bouncing state
2416     *
2417     * This is the default behavior for touch screens, in general.
2418     * @ingroup Scrolling
2419     */
2420    EAPI Eina_Bool        elm_scroll_bounce_enabled_get(void);
2421
2422    /**
2423     * Set whether scrollers should bounce when they reach their
2424     * viewport's edge during a scroll.
2425     *
2426     * @param enabled the thumb scroll bouncing state
2427     *
2428     * @see elm_thumbscroll_bounce_enabled_get()
2429     * @ingroup Scrolling
2430     */
2431    EAPI void             elm_scroll_bounce_enabled_set(Eina_Bool enabled);
2432
2433    /**
2434     * Set whether scrollers should bounce when they reach their
2435     * viewport's edge during a scroll, for all Elementary application
2436     * windows.
2437     *
2438     * @param enabled the thumb scroll bouncing state
2439     *
2440     * @see elm_thumbscroll_bounce_enabled_get()
2441     * @ingroup Scrolling
2442     */
2443    EAPI void             elm_scroll_bounce_enabled_all_set(Eina_Bool enabled);
2444
2445    /**
2446     * Get the amount of inertia a scroller will impose at bounce
2447     * animations.
2448     *
2449     * @return the thumb scroll bounce friction
2450     *
2451     * @ingroup Scrolling
2452     */
2453    EAPI double           elm_scroll_bounce_friction_get(void);
2454
2455    /**
2456     * Set the amount of inertia a scroller will impose at bounce
2457     * animations.
2458     *
2459     * @param friction the thumb scroll bounce friction
2460     *
2461     * @see elm_thumbscroll_bounce_friction_get()
2462     * @ingroup Scrolling
2463     */
2464    EAPI void             elm_scroll_bounce_friction_set(double friction);
2465
2466    /**
2467     * Set the amount of inertia a scroller will impose at bounce
2468     * animations, for all Elementary application windows.
2469     *
2470     * @param friction the thumb scroll bounce friction
2471     *
2472     * @see elm_thumbscroll_bounce_friction_get()
2473     * @ingroup Scrolling
2474     */
2475    EAPI void             elm_scroll_bounce_friction_all_set(double friction);
2476
2477    /**
2478     * Get the amount of inertia a <b>paged</b> scroller will impose at
2479     * page fitting animations.
2480     *
2481     * @return the page scroll friction
2482     *
2483     * @ingroup Scrolling
2484     */
2485    EAPI double           elm_scroll_page_scroll_friction_get(void);
2486
2487    /**
2488     * Set the amount of inertia a <b>paged</b> scroller will impose at
2489     * page fitting animations.
2490     *
2491     * @param friction the page scroll friction
2492     *
2493     * @see elm_thumbscroll_page_scroll_friction_get()
2494     * @ingroup Scrolling
2495     */
2496    EAPI void             elm_scroll_page_scroll_friction_set(double friction);
2497
2498    /**
2499     * Set the amount of inertia a <b>paged</b> scroller will impose at
2500     * page fitting animations, for all Elementary application windows.
2501     *
2502     * @param friction the page scroll friction
2503     *
2504     * @see elm_thumbscroll_page_scroll_friction_get()
2505     * @ingroup Scrolling
2506     */
2507    EAPI void             elm_scroll_page_scroll_friction_all_set(double friction);
2508
2509    /**
2510     * Get the amount of inertia a scroller will impose at region bring
2511     * animations.
2512     *
2513     * @return the bring in scroll friction
2514     *
2515     * @ingroup Scrolling
2516     */
2517    EAPI double           elm_scroll_bring_in_scroll_friction_get(void);
2518
2519    /**
2520     * Set the amount of inertia a scroller will impose at region bring
2521     * animations.
2522     *
2523     * @param friction the bring in scroll friction
2524     *
2525     * @see elm_thumbscroll_bring_in_scroll_friction_get()
2526     * @ingroup Scrolling
2527     */
2528    EAPI void             elm_scroll_bring_in_scroll_friction_set(double friction);
2529
2530    /**
2531     * Set the amount of inertia a scroller will impose at region bring
2532     * animations, for all Elementary application windows.
2533     *
2534     * @param friction the bring in scroll friction
2535     *
2536     * @see elm_thumbscroll_bring_in_scroll_friction_get()
2537     * @ingroup Scrolling
2538     */
2539    EAPI void             elm_scroll_bring_in_scroll_friction_all_set(double friction);
2540
2541    /**
2542     * Get the amount of inertia scrollers will impose at animations
2543     * triggered by Elementary widgets' zooming API.
2544     *
2545     * @return the zoom friction
2546     *
2547     * @ingroup Scrolling
2548     */
2549    EAPI double           elm_scroll_zoom_friction_get(void);
2550
2551    /**
2552     * Set the amount of inertia scrollers will impose at animations
2553     * triggered by Elementary widgets' zooming API.
2554     *
2555     * @param friction the zoom friction
2556     *
2557     * @see elm_thumbscroll_zoom_friction_get()
2558     * @ingroup Scrolling
2559     */
2560    EAPI void             elm_scroll_zoom_friction_set(double friction);
2561
2562    /**
2563     * Set the amount of inertia scrollers will impose at animations
2564     * triggered by Elementary widgets' zooming API, for all Elementary
2565     * application windows.
2566     *
2567     * @param friction the zoom friction
2568     *
2569     * @see elm_thumbscroll_zoom_friction_get()
2570     * @ingroup Scrolling
2571     */
2572    EAPI void             elm_scroll_zoom_friction_all_set(double friction);
2573
2574    /**
2575     * Get whether scrollers should be draggable from any point in their
2576     * views.
2577     *
2578     * @return the thumb scroll state
2579     *
2580     * @note This is the default behavior for touch screens, in general.
2581     * @note All other functions namespaced with "thumbscroll" will only
2582     *       have effect if this mode is enabled.
2583     *
2584     * @ingroup Scrolling
2585     */
2586    EAPI Eina_Bool        elm_scroll_thumbscroll_enabled_get(void);
2587
2588    /**
2589     * Set whether scrollers should be draggable from any point in their
2590     * views.
2591     *
2592     * @param enabled the thumb scroll state
2593     *
2594     * @see elm_thumbscroll_enabled_get()
2595     * @ingroup Scrolling
2596     */
2597    EAPI void             elm_scroll_thumbscroll_enabled_set(Eina_Bool enabled);
2598
2599    /**
2600     * Set whether scrollers should be draggable from any point in their
2601     * views, for all Elementary application windows.
2602     *
2603     * @param enabled the thumb scroll state
2604     *
2605     * @see elm_thumbscroll_enabled_get()
2606     * @ingroup Scrolling
2607     */
2608    EAPI void             elm_scroll_thumbscroll_enabled_all_set(Eina_Bool enabled);
2609
2610    /**
2611     * Get the number of pixels one should travel while dragging a
2612     * scroller's view to actually trigger scrolling.
2613     *
2614     * @return the thumb scroll threshould
2615     *
2616     * One would use higher values for touch screens, in general, because
2617     * of their inherent imprecision.
2618     * @ingroup Scrolling
2619     */
2620    EAPI unsigned int     elm_scroll_thumbscroll_threshold_get(void);
2621
2622    /**
2623     * Set the number of pixels one should travel while dragging a
2624     * scroller's view to actually trigger scrolling.
2625     *
2626     * @param threshold the thumb scroll threshould
2627     *
2628     * @see elm_thumbscroll_threshould_get()
2629     * @ingroup Scrolling
2630     */
2631    EAPI void             elm_scroll_thumbscroll_threshold_set(unsigned int threshold);
2632
2633    /**
2634     * Set the number of pixels one should travel while dragging a
2635     * scroller's view to actually trigger scrolling, for all Elementary
2636     * application windows.
2637     *
2638     * @param threshold the thumb scroll threshould
2639     *
2640     * @see elm_thumbscroll_threshould_get()
2641     * @ingroup Scrolling
2642     */
2643    EAPI void             elm_scroll_thumbscroll_threshold_all_set(unsigned int threshold);
2644
2645    /**
2646     * Get the minimum speed of mouse cursor movement which will trigger
2647     * list self scrolling animation after a mouse up event
2648     * (pixels/second).
2649     *
2650     * @return the thumb scroll momentum threshould
2651     *
2652     * @ingroup Scrolling
2653     */
2654    EAPI double           elm_scroll_thumbscroll_momentum_threshold_get(void);
2655
2656    /**
2657     * Set the minimum speed of mouse cursor movement which will trigger
2658     * list self scrolling animation after a mouse up event
2659     * (pixels/second).
2660     *
2661     * @param threshold the thumb scroll momentum threshould
2662     *
2663     * @see elm_thumbscroll_momentum_threshould_get()
2664     * @ingroup Scrolling
2665     */
2666    EAPI void             elm_scroll_thumbscroll_momentum_threshold_set(double threshold);
2667
2668    /**
2669     * Set the minimum speed of mouse cursor movement which will trigger
2670     * list self scrolling animation after a mouse up event
2671     * (pixels/second), for all Elementary application windows.
2672     *
2673     * @param threshold the thumb scroll momentum threshould
2674     *
2675     * @see elm_thumbscroll_momentum_threshould_get()
2676     * @ingroup Scrolling
2677     */
2678    EAPI void             elm_scroll_thumbscroll_momentum_threshold_all_set(double threshold);
2679
2680    /**
2681     * Get the amount of inertia a scroller will impose at self scrolling
2682     * animations.
2683     *
2684     * @return the thumb scroll friction
2685     *
2686     * @ingroup Scrolling
2687     */
2688    EAPI double           elm_scroll_thumbscroll_friction_get(void);
2689
2690    /**
2691     * Set the amount of inertia a scroller will impose at self scrolling
2692     * animations.
2693     *
2694     * @param friction the thumb scroll friction
2695     *
2696     * @see elm_thumbscroll_friction_get()
2697     * @ingroup Scrolling
2698     */
2699    EAPI void             elm_scroll_thumbscroll_friction_set(double friction);
2700
2701    /**
2702     * Set the amount of inertia a scroller will impose at self scrolling
2703     * animations, for all Elementary application windows.
2704     *
2705     * @param friction the thumb scroll friction
2706     *
2707     * @see elm_thumbscroll_friction_get()
2708     * @ingroup Scrolling
2709     */
2710    EAPI void             elm_scroll_thumbscroll_friction_all_set(double friction);
2711
2712    /**
2713     * Get the amount of lag between your actual mouse cursor dragging
2714     * movement and a scroller's view movement itself, while pushing it
2715     * into bounce state manually.
2716     *
2717     * @return the thumb scroll border friction
2718     *
2719     * @ingroup Scrolling
2720     */
2721    EAPI double           elm_scroll_thumbscroll_border_friction_get(void);
2722
2723    /**
2724     * Set the amount of lag between your actual mouse cursor dragging
2725     * movement and a scroller's view movement itself, while pushing it
2726     * into bounce state manually.
2727     *
2728     * @param friction the thumb scroll border friction. @c 0.0 for
2729     *        perfect synchrony between two movements, @c 1.0 for maximum
2730     *        lag.
2731     *
2732     * @see elm_thumbscroll_border_friction_get()
2733     * @note parameter value will get bound to 0.0 - 1.0 interval, always
2734     *
2735     * @ingroup Scrolling
2736     */
2737    EAPI void             elm_scroll_thumbscroll_border_friction_set(double friction);
2738
2739    /**
2740     * Set the amount of lag between your actual mouse cursor dragging
2741     * movement and a scroller's view movement itself, while pushing it
2742     * into bounce state manually, for all Elementary application windows.
2743     *
2744     * @param friction the thumb scroll border friction. @c 0.0 for
2745     *        perfect synchrony between two movements, @c 1.0 for maximum
2746     *        lag.
2747     *
2748     * @see elm_thumbscroll_border_friction_get()
2749     * @note parameter value will get bound to 0.0 - 1.0 interval, always
2750     *
2751     * @ingroup Scrolling
2752     */
2753    EAPI void             elm_scroll_thumbscroll_border_friction_all_set(double friction);
2754
2755    /**
2756     * @}
2757     */
2758
2759    /**
2760     * @defgroup Scrollhints Scrollhints
2761     *
2762     * Objects when inside a scroller can scroll, but this may not always be
2763     * desirable in certain situations. This allows an object to hint to itself
2764     * and parents to "not scroll" in one of 2 ways. If any child object of a
2765     * scroller has pushed a scroll freeze or hold then it affects all parent
2766     * scrollers until all children have released them.
2767     *
2768     * 1. To hold on scrolling. This means just flicking and dragging may no
2769     * longer scroll, but pressing/dragging near an edge of the scroller will
2770     * still scroll. This is automatically used by the entry object when
2771     * selecting text.
2772     *
2773     * 2. To totally freeze scrolling. This means it stops. until
2774     * popped/released.
2775     *
2776     * @{
2777     */
2778
2779    /**
2780     * Push the scroll hold by 1
2781     *
2782     * This increments the scroll hold count by one. If it is more than 0 it will
2783     * take effect on the parents of the indicated object.
2784     *
2785     * @param obj The object
2786     * @ingroup Scrollhints
2787     */
2788    EAPI void             elm_object_scroll_hold_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
2789
2790    /**
2791     * Pop the scroll hold by 1
2792     *
2793     * This decrements the scroll hold count by one. If it is more than 0 it will
2794     * take effect on the parents of the indicated object.
2795     *
2796     * @param obj The object
2797     * @ingroup Scrollhints
2798     */
2799    EAPI void             elm_object_scroll_hold_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
2800
2801    /**
2802     * Push the scroll freeze by 1
2803     *
2804     * This increments the scroll freeze count by one. If it is more
2805     * than 0 it will take effect on the parents of the indicated
2806     * object.
2807     *
2808     * @param obj The object
2809     * @ingroup Scrollhints
2810     */
2811    EAPI void             elm_object_scroll_freeze_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
2812
2813    /**
2814     * Pop the scroll freeze by 1
2815     *
2816     * This decrements the scroll freeze count by one. If it is more
2817     * than 0 it will take effect on the parents of the indicated
2818     * object.
2819     *
2820     * @param obj The object
2821     * @ingroup Scrollhints
2822     */
2823    EAPI void             elm_object_scroll_freeze_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
2824
2825    /**
2826     * Lock the scrolling of the given widget (and thus all parents)
2827     *
2828     * This locks the given object from scrolling in the X axis (and implicitly
2829     * also locks all parent scrollers too from doing the same).
2830     *
2831     * @param obj The object
2832     * @param lock The lock state (1 == locked, 0 == unlocked)
2833     * @ingroup Scrollhints
2834     */
2835    EAPI void             elm_object_scroll_lock_x_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
2836
2837    /**
2838     * Lock the scrolling of the given widget (and thus all parents)
2839     *
2840     * This locks the given object from scrolling in the Y axis (and implicitly
2841     * also locks all parent scrollers too from doing the same).
2842     *
2843     * @param obj The object
2844     * @param lock The lock state (1 == locked, 0 == unlocked)
2845     * @ingroup Scrollhints
2846     */
2847    EAPI void             elm_object_scroll_lock_y_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
2848
2849    /**
2850     * Get the scrolling lock of the given widget
2851     *
2852     * This gets the lock for X axis scrolling.
2853     *
2854     * @param obj The object
2855     * @ingroup Scrollhints
2856     */
2857    EAPI Eina_Bool        elm_object_scroll_lock_x_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2858
2859    /**
2860     * Get the scrolling lock of the given widget
2861     *
2862     * This gets the lock for X axis scrolling.
2863     *
2864     * @param obj The object
2865     * @ingroup Scrollhints
2866     */
2867    EAPI Eina_Bool        elm_object_scroll_lock_y_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2868
2869    /**
2870     * @}
2871     */
2872
2873    /**
2874     * Send a signal to the widget edje object.
2875     *
2876     * This function sends a signal to the edje object of the obj. An
2877     * edje program can respond to a signal by specifying matching
2878     * 'signal' and 'source' fields.
2879     *
2880     * @param obj The object
2881     * @param emission The signal's name.
2882     * @param source The signal's source.
2883     * @ingroup General
2884     */
2885    EAPI void             elm_object_signal_emit(Evas_Object *obj, const char *emission, const char *source) EINA_ARG_NONNULL(1);
2886
2887    /**
2888     * Add a callback for a signal emitted by widget edje object.
2889     *
2890     * This function connects a callback function to a signal emitted by the
2891     * edje object of the obj.
2892     * Globs can occur in either the emission or source name.
2893     *
2894     * @param obj The object
2895     * @param emission The signal's name.
2896     * @param source The signal's source.
2897     * @param func The callback function to be executed when the signal is
2898     * emitted.
2899     * @param data A pointer to data to pass in to the callback function.
2900     * @ingroup General
2901     */
2902    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);
2903
2904    /**
2905     * Remove a signal-triggered callback from a widget edje object.
2906     *
2907     * This function removes a callback, previoulsy attached to a
2908     * signal emitted by the edje object of the obj.  The parameters
2909     * emission, source and func must match exactly those passed to a
2910     * previous call to elm_object_signal_callback_add(). The data
2911     * pointer that was passed to this call will be returned.
2912     *
2913     * @param obj The object
2914     * @param emission The signal's name.
2915     * @param source The signal's source.
2916     * @param func The callback function to be executed when the signal is
2917     * emitted.
2918     * @return The data pointer
2919     * @ingroup General
2920     */
2921    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);
2922
2923    /**
2924     * Add a callback for input events (key up, key down, mouse wheel)
2925     * on a given Elementary widget
2926     *
2927     * @param obj The widget to add an event callback on
2928     * @param func The callback function to be executed when the event
2929     * happens
2930     * @param data Data to pass in to @p func
2931     *
2932     * Every widget in an Elementary interface set to receive focus,
2933     * with elm_object_focus_allow_set(), will propagate @b all of its
2934     * key up, key down and mouse wheel input events up to its parent
2935     * object, and so on. All of the focusable ones in this chain which
2936     * had an event callback set, with this call, will be able to treat
2937     * those events. There are two ways of making the propagation of
2938     * these event upwards in the tree of widgets to @b cease:
2939     * - Just return @c EINA_TRUE on @p func. @c EINA_FALSE will mean
2940     *   the event was @b not processed, so the propagation will go on.
2941     * - The @c event_info pointer passed to @p func will contain the
2942     *   event's structure and, if you OR its @c event_flags inner
2943     *   value to @c EVAS_EVENT_FLAG_ON_HOLD, you're telling Elementary
2944     *   one has already handled it, thus killing the event's
2945     *   propagation, too.
2946     *
2947     * @note Your event callback will be issued on those events taking
2948     * place only if no other child widget of @obj has consumed the
2949     * event already.
2950     *
2951     * @note Not to be confused with @c
2952     * evas_object_event_callback_add(), which will add event callbacks
2953     * per type on general Evas objects (no event propagation
2954     * infrastructure taken in account).
2955     *
2956     * @note Not to be confused with @c
2957     * elm_object_signal_callback_add(), which will add callbacks to @b
2958     * signals coming from a widget's theme, not input events.
2959     *
2960     * @note Not to be confused with @c
2961     * edje_object_signal_callback_add(), which does the same as
2962     * elm_object_signal_callback_add(), but directly on an Edje
2963     * object.
2964     *
2965     * @note Not to be confused with @c
2966     * evas_object_smart_callback_add(), which adds callbacks to smart
2967     * objects' <b>smart events</b>, and not input events.
2968     *
2969     * @see elm_object_event_callback_del()
2970     *
2971     * @ingroup General
2972     */
2973    EAPI void             elm_object_event_callback_add(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
2974
2975    /**
2976     * Remove an event callback from a widget.
2977     *
2978     * This function removes a callback, previoulsy attached to event emission
2979     * by the @p obj.
2980     * The parameters func and data must match exactly those passed to
2981     * a previous call to elm_object_event_callback_add(). The data pointer that
2982     * was passed to this call will be returned.
2983     *
2984     * @param obj The object
2985     * @param func The callback function to be executed when the event is
2986     * emitted.
2987     * @param data Data to pass in to the callback function.
2988     * @return The data pointer
2989     * @ingroup General
2990     */
2991    EAPI void            *elm_object_event_callback_del(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
2992
2993    /**
2994     * Adjust size of an element for finger usage.
2995     *
2996     * @param times_w How many fingers should fit horizontally
2997     * @param w Pointer to the width size to adjust
2998     * @param times_h How many fingers should fit vertically
2999     * @param h Pointer to the height size to adjust
3000     *
3001     * This takes width and height sizes (in pixels) as input and a
3002     * size multiple (which is how many fingers you want to place
3003     * within the area, being "finger" the size set by
3004     * elm_finger_size_set()), and adjusts the size to be large enough
3005     * to accommodate the resulting size -- if it doesn't already
3006     * accommodate it. On return the @p w and @p h sizes pointed to by
3007     * these parameters will be modified, on those conditions.
3008     *
3009     * @note This is kind of a low level Elementary call, most useful
3010     * on size evaluation times for widgets. An external user wouldn't
3011     * be calling, most of the time.
3012     *
3013     * @ingroup Fingers
3014     */
3015    EAPI void             elm_coords_finger_size_adjust(int times_w, Evas_Coord *w, int times_h, Evas_Coord *h);
3016
3017    /**
3018     * Get the duration for occuring long press event.
3019     *
3020     * @return Timeout for long press event
3021     * @ingroup Longpress
3022     */
3023    EAPI double           elm_longpress_timeout_get(void);
3024
3025    /**
3026     * Set the duration for occuring long press event.
3027     *
3028     * @param lonpress_timeout Timeout for long press event
3029     * @ingroup Longpress
3030     */
3031    EAPI void             elm_longpress_timeout_set(double longpress_timeout);
3032
3033    /**
3034     * @defgroup Debug Debug
3035     * don't use it unless you are sure
3036     *
3037     * @{
3038     */
3039
3040    /**
3041     * Print Tree object hierarchy in stdout
3042     *
3043     * @param obj The root object
3044     * @ingroup Debug
3045     */
3046    EAPI void             elm_object_tree_dump(const Evas_Object *top);
3047
3048    /**
3049     * Print Elm Objects tree hierarchy in file as dot(graphviz) syntax.
3050     *
3051     * @param obj The root object
3052     * @param file The path of output file
3053     * @ingroup Debug
3054     */
3055    EAPI void             elm_object_tree_dot_dump(const Evas_Object *top, const char *file);
3056
3057    /**
3058     * @}
3059     */
3060
3061    /**
3062     * @defgroup Theme Theme
3063     *
3064     * Elementary uses Edje to theme its widgets, naturally. But for the most
3065     * part this is hidden behind a simpler interface that lets the user set
3066     * extensions and choose the style of widgets in a much easier way.
3067     *
3068     * Instead of thinking in terms of paths to Edje files and their groups
3069     * each time you want to change the appearance of a widget, Elementary
3070     * works so you can add any theme file with extensions or replace the
3071     * main theme at one point in the application, and then just set the style
3072     * of widgets with elm_object_style_set() and related functions. Elementary
3073     * will then look in its list of themes for a matching group and apply it,
3074     * and when the theme changes midway through the application, all widgets
3075     * will be updated accordingly.
3076     *
3077     * There are three concepts you need to know to understand how Elementary
3078     * theming works: default theme, extensions and overlays.
3079     *
3080     * Default theme, obviously enough, is the one that provides the default
3081     * look of all widgets. End users can change the theme used by Elementary
3082     * by setting the @c ELM_THEME environment variable before running an
3083     * application, or globally for all programs using the @c elementary_config
3084     * utility. Applications can change the default theme using elm_theme_set(),
3085     * but this can go against the user wishes, so it's not an adviced practice.
3086     *
3087     * Ideally, applications should find everything they need in the already
3088     * provided theme, but there may be occasions when that's not enough and
3089     * custom styles are required to correctly express the idea. For this
3090     * cases, Elementary has extensions.
3091     *
3092     * Extensions allow the application developer to write styles of its own
3093     * to apply to some widgets. This requires knowledge of how each widget
3094     * is themed, as extensions will always replace the entire group used by
3095     * the widget, so important signals and parts need to be there for the
3096     * object to behave properly (see documentation of Edje for details).
3097     * Once the theme for the extension is done, the application needs to add
3098     * it to the list of themes Elementary will look into, using
3099     * elm_theme_extension_add(), and set the style of the desired widgets as
3100     * he would normally with elm_object_style_set().
3101     *
3102     * Overlays, on the other hand, can replace the look of all widgets by
3103     * overriding the default style. Like extensions, it's up to the application
3104     * developer to write the theme for the widgets it wants, the difference
3105     * being that when looking for the theme, Elementary will check first the
3106     * list of overlays, then the set theme and lastly the list of extensions,
3107     * so with overlays it's possible to replace the default view and every
3108     * widget will be affected. This is very much alike to setting the whole
3109     * theme for the application and will probably clash with the end user
3110     * options, not to mention the risk of ending up with not matching styles
3111     * across the program. Unless there's a very special reason to use them,
3112     * overlays should be avoided for the resons exposed before.
3113     *
3114     * All these theme lists are handled by ::Elm_Theme instances. Elementary
3115     * keeps one default internally and every function that receives one of
3116     * these can be called with NULL to refer to this default (except for
3117     * elm_theme_free()). It's possible to create a new instance of a
3118     * ::Elm_Theme to set other theme for a specific widget (and all of its
3119     * children), but this is as discouraged, if not even more so, than using
3120     * overlays. Don't use this unless you really know what you are doing.
3121     *
3122     * But to be less negative about things, you can look at the following
3123     * examples:
3124     * @li @ref theme_example_01 "Using extensions"
3125     * @li @ref theme_example_02 "Using overlays"
3126     *
3127     * @{
3128     */
3129    /**
3130     * @typedef Elm_Theme
3131     *
3132     * Opaque handler for the list of themes Elementary looks for when
3133     * rendering widgets.
3134     *
3135     * Stay out of this unless you really know what you are doing. For most
3136     * cases, sticking to the default is all a developer needs.
3137     */
3138    typedef struct _Elm_Theme Elm_Theme;
3139
3140    /**
3141     * Create a new specific theme
3142     *
3143     * This creates an empty specific theme that only uses the default theme. A
3144     * specific theme has its own private set of extensions and overlays too
3145     * (which are empty by default). Specific themes do not fall back to themes
3146     * of parent objects. They are not intended for this use. Use styles, overlays
3147     * and extensions when needed, but avoid specific themes unless there is no
3148     * other way (example: you want to have a preview of a new theme you are
3149     * selecting in a "theme selector" window. The preview is inside a scroller
3150     * and should display what the theme you selected will look like, but not
3151     * actually apply it yet. The child of the scroller will have a specific
3152     * theme set to show this preview before the user decides to apply it to all
3153     * applications).
3154     */
3155    EAPI Elm_Theme       *elm_theme_new(void);
3156    /**
3157     * Free a specific theme
3158     *
3159     * @param th The theme to free
3160     *
3161     * This frees a theme created with elm_theme_new().
3162     */
3163    EAPI void             elm_theme_free(Elm_Theme *th);
3164    /**
3165     * Copy the theme fom the source to the destination theme
3166     *
3167     * @param th The source theme to copy from
3168     * @param thdst The destination theme to copy data to
3169     *
3170     * This makes a one-time static copy of all the theme config, extensions
3171     * and overlays from @p th to @p thdst. If @p th references a theme, then
3172     * @p thdst is also set to reference it, with all the theme settings,
3173     * overlays and extensions that @p th had.
3174     */
3175    EAPI void             elm_theme_copy(Elm_Theme *th, Elm_Theme *thdst);
3176    /**
3177     * Tell the source theme to reference the ref theme
3178     *
3179     * @param th The theme that will do the referencing
3180     * @param thref The theme that is the reference source
3181     *
3182     * This clears @p th to be empty and then sets it to refer to @p thref
3183     * so @p th acts as an override to @p thref, but where its overrides
3184     * don't apply, it will fall through to @p thref for configuration.
3185     */
3186    EAPI void             elm_theme_ref_set(Elm_Theme *th, Elm_Theme *thref);
3187    /**
3188     * Return the theme referred to
3189     *
3190     * @param th The theme to get the reference from
3191     * @return The referenced theme handle
3192     *
3193     * This gets the theme set as the reference theme by elm_theme_ref_set().
3194     * If no theme is set as a reference, NULL is returned.
3195     */
3196    EAPI Elm_Theme       *elm_theme_ref_get(Elm_Theme *th);
3197    /**
3198     * Return the default theme
3199     *
3200     * @return The default theme handle
3201     *
3202     * This returns the internal default theme setup handle that all widgets
3203     * use implicitly unless a specific theme is set. This is also often use
3204     * as a shorthand of NULL.
3205     */
3206    EAPI Elm_Theme       *elm_theme_default_get(void);
3207    /**
3208     * Prepends a theme overlay to the list of overlays
3209     *
3210     * @param th The theme to add to, or if NULL, the default theme
3211     * @param item The Edje file path to be used
3212     *
3213     * Use this if your application needs to provide some custom overlay theme
3214     * (An Edje file that replaces some default styles of widgets) where adding
3215     * new styles, or changing system theme configuration is not possible. Do
3216     * NOT use this instead of a proper system theme configuration. Use proper
3217     * configuration files, profiles, environment variables etc. to set a theme
3218     * so that the theme can be altered by simple confiugration by a user. Using
3219     * this call to achieve that effect is abusing the API and will create lots
3220     * of trouble.
3221     *
3222     * @see elm_theme_extension_add()
3223     */
3224    EAPI void             elm_theme_overlay_add(Elm_Theme *th, const char *item);
3225    /**
3226     * Delete a theme overlay from the list of overlays
3227     *
3228     * @param th The theme to delete from, or if NULL, the default theme
3229     * @param item The name of the theme overlay
3230     *
3231     * @see elm_theme_overlay_add()
3232     */
3233    EAPI void             elm_theme_overlay_del(Elm_Theme *th, const char *item);
3234    /**
3235     * Appends a theme extension to the list of extensions.
3236     *
3237     * @param th The theme to add to, or if NULL, the default theme
3238     * @param item The Edje file path to be used
3239     *
3240     * This is intended when an application needs more styles of widgets or new
3241     * widget themes that the default does not provide (or may not provide). The
3242     * application has "extended" usage by coming up with new custom style names
3243     * for widgets for specific uses, but as these are not "standard", they are
3244     * not guaranteed to be provided by a default theme. This means the
3245     * application is required to provide these extra elements itself in specific
3246     * Edje files. This call adds one of those Edje files to the theme search
3247     * path to be search after the default theme. The use of this call is
3248     * encouraged when default styles do not meet the needs of the application.
3249     * Use this call instead of elm_theme_overlay_add() for almost all cases.
3250     *
3251     * @see elm_object_style_set()
3252     */
3253    EAPI void             elm_theme_extension_add(Elm_Theme *th, const char *item);
3254    /**
3255     * Deletes a theme extension from the list of extensions.
3256     *
3257     * @param th The theme to delete from, or if NULL, the default theme
3258     * @param item The name of the theme extension
3259     *
3260     * @see elm_theme_extension_add()
3261     */
3262    EAPI void             elm_theme_extension_del(Elm_Theme *th, const char *item);
3263    /**
3264     * Set the theme search order for the given theme
3265     *
3266     * @param th The theme to set the search order, or if NULL, the default theme
3267     * @param theme Theme search string
3268     *
3269     * This sets the search string for the theme in path-notation from first
3270     * theme to search, to last, delimited by the : character. Example:
3271     *
3272     * "shiny:/path/to/file.edj:default"
3273     *
3274     * See the ELM_THEME environment variable for more information.
3275     *
3276     * @see elm_theme_get()
3277     * @see elm_theme_list_get()
3278     */
3279    EAPI void             elm_theme_set(Elm_Theme *th, const char *theme);
3280    /**
3281     * Return the theme search order
3282     *
3283     * @param th The theme to get the search order, or if NULL, the default theme
3284     * @return The internal search order path
3285     *
3286     * This function returns a colon separated string of theme elements as
3287     * returned by elm_theme_list_get().
3288     *
3289     * @see elm_theme_set()
3290     * @see elm_theme_list_get()
3291     */
3292    EAPI const char      *elm_theme_get(Elm_Theme *th);
3293    /**
3294     * Return a list of theme elements to be used in a theme.
3295     *
3296     * @param th Theme to get the list of theme elements from.
3297     * @return The internal list of theme elements
3298     *
3299     * This returns the internal list of theme elements (will only be valid as
3300     * long as the theme is not modified by elm_theme_set() or theme is not
3301     * freed by elm_theme_free(). This is a list of strings which must not be
3302     * altered as they are also internal. If @p th is NULL, then the default
3303     * theme element list is returned.
3304     *
3305     * A theme element can consist of a full or relative path to a .edj file,
3306     * or a name, without extension, for a theme to be searched in the known
3307     * theme paths for Elemementary.
3308     *
3309     * @see elm_theme_set()
3310     * @see elm_theme_get()
3311     */
3312    EAPI const Eina_List *elm_theme_list_get(const Elm_Theme *th);
3313    /**
3314     * Return the full patrh for a theme element
3315     *
3316     * @param f The theme element name
3317     * @param in_search_path Pointer to a boolean to indicate if item is in the search path or not
3318     * @return The full path to the file found.
3319     *
3320     * This returns a string you should free with free() on success, NULL on
3321     * failure. This will search for the given theme element, and if it is a
3322     * full or relative path element or a simple searchable name. The returned
3323     * path is the full path to the file, if searched, and the file exists, or it
3324     * is simply the full path given in the element or a resolved path if
3325     * relative to home. The @p in_search_path boolean pointed to is set to
3326     * EINA_TRUE if the file was a searchable file andis in the search path,
3327     * and EINA_FALSE otherwise.
3328     */
3329    EAPI char            *elm_theme_list_item_path_get(const char *f, Eina_Bool *in_search_path);
3330    /**
3331     * Flush the current theme.
3332     *
3333     * @param th Theme to flush
3334     *
3335     * This flushes caches that let elementary know where to find theme elements
3336     * in the given theme. If @p th is NULL, then the default theme is flushed.
3337     * Call this function if source theme data has changed in such a way as to
3338     * make any caches Elementary kept invalid.
3339     */
3340    EAPI void             elm_theme_flush(Elm_Theme *th);
3341    /**
3342     * This flushes all themes (default and specific ones).
3343     *
3344     * This will flush all themes in the current application context, by calling
3345     * elm_theme_flush() on each of them.
3346     */
3347    EAPI void             elm_theme_full_flush(void);
3348    /**
3349     * Set the theme for all elementary using applications on the current display
3350     *
3351     * @param theme The name of the theme to use. Format same as the ELM_THEME
3352     * environment variable.
3353     */
3354    EAPI void             elm_theme_all_set(const char *theme);
3355    /**
3356     * Return a list of theme elements in the theme search path
3357     *
3358     * @return A list of strings that are the theme element names.
3359     *
3360     * This lists all available theme files in the standard Elementary search path
3361     * for theme elements, and returns them in alphabetical order as theme
3362     * element names in a list of strings. Free this with
3363     * elm_theme_name_available_list_free() when you are done with the list.
3364     */
3365    EAPI Eina_List       *elm_theme_name_available_list_new(void);
3366    /**
3367     * Free the list returned by elm_theme_name_available_list_new()
3368     *
3369     * This frees the list of themes returned by
3370     * elm_theme_name_available_list_new(). Once freed the list should no longer
3371     * be used. a new list mys be created.
3372     */
3373    EAPI void             elm_theme_name_available_list_free(Eina_List *list);
3374    /**
3375     * Set a specific theme to be used for this object and its children
3376     *
3377     * @param obj The object to set the theme on
3378     * @param th The theme to set
3379     *
3380     * This sets a specific theme that will be used for the given object and any
3381     * child objects it has. If @p th is NULL then the theme to be used is
3382     * cleared and the object will inherit its theme from its parent (which
3383     * ultimately will use the default theme if no specific themes are set).
3384     *
3385     * Use special themes with great care as this will annoy users and make
3386     * configuration difficult. Avoid any custom themes at all if it can be
3387     * helped.
3388     */
3389    EAPI void             elm_object_theme_set(Evas_Object *obj, Elm_Theme *th) EINA_ARG_NONNULL(1);
3390    /**
3391     * Get the specific theme to be used
3392     *
3393     * @param obj The object to get the specific theme from
3394     * @return The specifc theme set.
3395     *
3396     * This will return a specific theme set, or NULL if no specific theme is
3397     * set on that object. It will not return inherited themes from parents, only
3398     * the specific theme set for that specific object. See elm_object_theme_set()
3399     * for more information.
3400     */
3401    EAPI Elm_Theme       *elm_object_theme_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3402    /**
3403     * @}
3404     */
3405
3406    /* win */
3407    /** @defgroup Win Win
3408     *
3409     * @image html img/widget/win/preview-00.png
3410     * @image latex img/widget/win/preview-00.eps
3411     *
3412     * The window class of Elementary.  Contains functions to manipulate
3413     * windows. The Evas engine used to render the window contents is specified
3414     * in the system or user elementary config files (whichever is found last),
3415     * and can be overridden with the ELM_ENGINE environment variable for
3416     * testing.  Engines that may be supported (depending on Evas and Ecore-Evas
3417     * compilation setup and modules actually installed at runtime) are (listed
3418     * in order of best supported and most likely to be complete and work to
3419     * lowest quality).
3420     *
3421     * @li "x11", "x", "software-x11", "software_x11" (Software rendering in X11)
3422     * @li "gl", "opengl", "opengl-x11", "opengl_x11" (OpenGL or OpenGL-ES2
3423     * rendering in X11)
3424     * @li "shot:..." (Virtual screenshot renderer - renders to output file and
3425     * exits)
3426     * @li "fb", "software-fb", "software_fb" (Linux framebuffer direct software
3427     * rendering)
3428     * @li "sdl", "software-sdl", "software_sdl" (SDL software rendering to SDL
3429     * buffer)
3430     * @li "gl-sdl", "gl_sdl", "opengl-sdl", "opengl_sdl" (OpenGL or OpenGL-ES2
3431     * rendering using SDL as the buffer)
3432     * @li "gdi", "software-gdi", "software_gdi" (Windows WIN32 rendering via
3433     * GDI with software)
3434     * @li "dfb", "directfb" (Rendering to a DirectFB window)
3435     * @li "x11-8", "x8", "software-8-x11", "software_8_x11" (Rendering in
3436     * grayscale using dedicated 8bit software engine in X11)
3437     * @li "x11-16", "x16", "software-16-x11", "software_16_x11" (Rendering in
3438     * X11 using 16bit software engine)
3439     * @li "wince-gdi", "software-16-wince-gdi", "software_16_wince_gdi"
3440     * (Windows CE rendering via GDI with 16bit software renderer)
3441     * @li "sdl-16", "software-16-sdl", "software_16_sdl" (Rendering to SDL
3442     * buffer with 16bit software renderer)
3443     *
3444     * All engines use a simple string to select the engine to render, EXCEPT
3445     * the "shot" engine. This actually encodes the output of the virtual
3446     * screenshot and how long to delay in the engine string. The engine string
3447     * is encoded in the following way:
3448     *
3449     *   "shot:[delay=XX][:][repeat=DDD][:][file=XX]"
3450     *
3451     * Where options are separated by a ":" char if more than one option is
3452     * given, with delay, if provided being the first option and file the last
3453     * (order is important). The delay specifies how long to wait after the
3454     * window is shown before doing the virtual "in memory" rendering and then
3455     * save the output to the file specified by the file option (and then exit).
3456     * If no delay is given, the default is 0.5 seconds. If no file is given the
3457     * default output file is "out.png". Repeat option is for continous
3458     * capturing screenshots. Repeat range is from 1 to 999 and filename is
3459     * fixed to "out001.png" Some examples of using the shot engine:
3460     *
3461     *   ELM_ENGINE="shot:delay=1.0:repeat=5:file=elm_test.png" elementary_test
3462     *   ELM_ENGINE="shot:delay=1.0:file=elm_test.png" elementary_test
3463     *   ELM_ENGINE="shot:file=elm_test2.png" elementary_test
3464     *   ELM_ENGINE="shot:delay=2.0" elementary_test
3465     *   ELM_ENGINE="shot:" elementary_test
3466     *
3467     * Signals that you can add callbacks for are:
3468     *
3469     * @li "delete,request": the user requested to close the window. See
3470     * elm_win_autodel_set().
3471     * @li "focus,in": window got focus
3472     * @li "focus,out": window lost focus
3473     * @li "moved": window that holds the canvas was moved
3474     *
3475     * Examples:
3476     * @li @ref win_example_01
3477     *
3478     * @{
3479     */
3480    /**
3481     * Defines the types of window that can be created
3482     *
3483     * These are hints set on the window so that a running Window Manager knows
3484     * how the window should be handled and/or what kind of decorations it
3485     * should have.
3486     *
3487     * Currently, only the X11 backed engines use them.
3488     */
3489    typedef enum _Elm_Win_Type
3490      {
3491         ELM_WIN_BASIC, /**< A normal window. Indicates a normal, top-level
3492                          window. Almost every window will be created with this
3493                          type. */
3494         ELM_WIN_DIALOG_BASIC, /**< Used for simple dialog windows/ */
3495         ELM_WIN_DESKTOP, /**< For special desktop windows, like a background
3496                            window holding desktop icons. */
3497         ELM_WIN_DOCK, /**< The window is used as a dock or panel. Usually would
3498                         be kept on top of any other window by the Window
3499                         Manager. */
3500         ELM_WIN_TOOLBAR, /**< The window is used to hold a floating toolbar, or
3501                            similar. */
3502         ELM_WIN_MENU, /**< Similar to #ELM_WIN_TOOLBAR. */
3503         ELM_WIN_UTILITY, /**< A persistent utility window, like a toolbox or
3504                            pallete. */
3505         ELM_WIN_SPLASH, /**< Splash window for a starting up application. */
3506         ELM_WIN_DROPDOWN_MENU, /**< The window is a dropdown menu, as when an
3507                                  entry in a menubar is clicked. Typically used
3508                                  with elm_win_override_set(). This hint exists
3509                                  for completion only, as the EFL way of
3510                                  implementing a menu would not normally use a
3511                                  separate window for its contents. */
3512         ELM_WIN_POPUP_MENU, /**< Like #ELM_WIN_DROPDOWN_MENU, but for the menu
3513                               triggered by right-clicking an object. */
3514         ELM_WIN_TOOLTIP, /**< The window is a tooltip. A short piece of
3515                            explanatory text that typically appear after the
3516                            mouse cursor hovers over an object for a while.
3517                            Typically used with elm_win_override_set() and also
3518                            not very commonly used in the EFL. */
3519         ELM_WIN_NOTIFICATION, /**< A notification window, like a warning about
3520                                 battery life or a new E-Mail received. */
3521         ELM_WIN_COMBO, /**< A window holding the contents of a combo box. Not
3522                          usually used in the EFL. */
3523         ELM_WIN_DND, /**< Used to indicate the window is a representation of an
3524                        object being dragged across different windows, or even
3525                        applications. Typically used with
3526                        elm_win_override_set(). */
3527         ELM_WIN_INLINED_IMAGE, /**< The window is rendered onto an image
3528                                  buffer. No actual window is created for this
3529                                  type, instead the window and all of its
3530                                  contents will be rendered to an image buffer.
3531                                  This allows to have children window inside a
3532                                  parent one just like any other object would
3533                                  be, and do other things like applying @c
3534                                  Evas_Map effects to it. This is the only type
3535                                  of window that requires the @c parent
3536                                  parameter of elm_win_add() to be a valid @c
3537                                  Evas_Object. */
3538      } Elm_Win_Type;
3539
3540    /**
3541     * The differents layouts that can be requested for the virtual keyboard.
3542     *
3543     * When the application window is being managed by Illume, it may request
3544     * any of the following layouts for the virtual keyboard.
3545     */
3546    typedef enum _Elm_Win_Keyboard_Mode
3547      {
3548         ELM_WIN_KEYBOARD_UNKNOWN, /**< Unknown keyboard state */
3549         ELM_WIN_KEYBOARD_OFF, /**< Request to deactivate the keyboard */
3550         ELM_WIN_KEYBOARD_ON, /**< Enable keyboard with default layout */
3551         ELM_WIN_KEYBOARD_ALPHA, /**< Alpha (a-z) keyboard layout */
3552         ELM_WIN_KEYBOARD_NUMERIC, /**< Numeric keyboard layout */
3553         ELM_WIN_KEYBOARD_PIN, /**< PIN keyboard layout */
3554         ELM_WIN_KEYBOARD_PHONE_NUMBER, /**< Phone keyboard layout */
3555         ELM_WIN_KEYBOARD_HEX, /**< Hexadecimal numeric keyboard layout */
3556         ELM_WIN_KEYBOARD_TERMINAL, /**< Full (QUERTY) keyboard layout */
3557         ELM_WIN_KEYBOARD_PASSWORD, /**< Password keyboard layout */
3558         ELM_WIN_KEYBOARD_IP, /**< IP keyboard layout */
3559         ELM_WIN_KEYBOARD_HOST, /**< Host keyboard layout */
3560         ELM_WIN_KEYBOARD_FILE, /**< File keyboard layout */
3561         ELM_WIN_KEYBOARD_URL, /**< URL keyboard layout */
3562         ELM_WIN_KEYBOARD_KEYPAD, /**< Keypad layout */
3563         ELM_WIN_KEYBOARD_J2ME /**< J2ME keyboard layout */
3564      } Elm_Win_Keyboard_Mode;
3565
3566    /**
3567     * Available commands that can be sent to the Illume manager.
3568     *
3569     * When running under an Illume session, a window may send commands to the
3570     * Illume manager to perform different actions.
3571     */
3572    typedef enum _Elm_Illume_Command
3573      {
3574         ELM_ILLUME_COMMAND_FOCUS_BACK, /**< Reverts focus to the previous
3575                                          window */
3576         ELM_ILLUME_COMMAND_FOCUS_FORWARD, /**< Sends focus to the next window\
3577                                             in the list */
3578         ELM_ILLUME_COMMAND_FOCUS_HOME, /**< Hides all windows to show the Home
3579                                          screen */
3580         ELM_ILLUME_COMMAND_CLOSE /**< Closes the currently active window */
3581      } Elm_Illume_Command;
3582
3583    /**
3584     * Adds a window object. If this is the first window created, pass NULL as
3585     * @p parent.
3586     *
3587     * @param parent Parent object to add the window to, or NULL
3588     * @param name The name of the window
3589     * @param type The window type, one of #Elm_Win_Type.
3590     *
3591     * The @p parent paramter can be @c NULL for every window @p type except
3592     * #ELM_WIN_INLINED_IMAGE, which needs a parent to retrieve the canvas on
3593     * which the image object will be created.
3594     *
3595     * @return The created object, or NULL on failure
3596     */
3597    EAPI Evas_Object *elm_win_add(Evas_Object *parent, const char *name, Elm_Win_Type type);
3598    /**
3599     * Add @p subobj as a resize object of window @p obj.
3600     *
3601     *
3602     * Setting an object as a resize object of the window means that the
3603     * @p subobj child's size and position will be controlled by the window
3604     * directly. That is, the object will be resized to match the window size
3605     * and should never be moved or resized manually by the developer.
3606     *
3607     * In addition, resize objects of the window control what the minimum size
3608     * of it will be, as well as whether it can or not be resized by the user.
3609     *
3610     * For the end user to be able to resize a window by dragging the handles
3611     * or borders provided by the Window Manager, or using any other similar
3612     * mechanism, all of the resize objects in the window should have their
3613     * evas_object_size_hint_weight_set() set to EVAS_HINT_EXPAND.
3614     *
3615     * @param obj The window object
3616     * @param subobj The resize object to add
3617     */
3618    EAPI void         elm_win_resize_object_add(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3619    /**
3620     * Delete @p subobj as a resize object of window @p obj.
3621     *
3622     * This function removes the object @p subobj from the resize objects of
3623     * the window @p obj. It will not delete the object itself, which will be
3624     * left unmanaged and should be deleted by the developer, manually handled
3625     * or set as child of some other container.
3626     *
3627     * @param obj The window object
3628     * @param subobj The resize object to add
3629     */
3630    EAPI void         elm_win_resize_object_del(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
3631    /**
3632     * Set the title of the window
3633     *
3634     * @param obj The window object
3635     * @param title The title to set
3636     */
3637    EAPI void         elm_win_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
3638    /**
3639     * Get the title of the window
3640     *
3641     * The returned string is an internal one and should not be freed or
3642     * modified. It will also be rendered invalid if a new title is set or if
3643     * the window is destroyed.
3644     *
3645     * @param obj The window object
3646     * @return The title
3647     */
3648    EAPI const char  *elm_win_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3649    /**
3650     * Set the window's autodel state.
3651     *
3652     * When closing the window in any way outside of the program control, like
3653     * pressing the X button in the titlebar or using a command from the
3654     * Window Manager, a "delete,request" signal is emitted to indicate that
3655     * this event occurred and the developer can take any action, which may
3656     * include, or not, destroying the window object.
3657     *
3658     * When the @p autodel parameter is set, the window will be automatically
3659     * destroyed when this event occurs, after the signal is emitted.
3660     * If @p autodel is @c EINA_FALSE, then the window will not be destroyed
3661     * and is up to the program to do so when it's required.
3662     *
3663     * @param obj The window object
3664     * @param autodel If true, the window will automatically delete itself when
3665     * closed
3666     */
3667    EAPI void         elm_win_autodel_set(Evas_Object *obj, Eina_Bool autodel) EINA_ARG_NONNULL(1);
3668    /**
3669     * Get the window's autodel state.
3670     *
3671     * @param obj The window object
3672     * @return If the window will automatically delete itself when closed
3673     *
3674     * @see elm_win_autodel_set()
3675     */
3676    EAPI Eina_Bool    elm_win_autodel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3677    /**
3678     * Activate a window object.
3679     *
3680     * This function sends a request to the Window Manager to activate the
3681     * window pointed by @p obj. If honored by the WM, the window will receive
3682     * the keyboard focus.
3683     *
3684     * @note This is just a request that a Window Manager may ignore, so calling
3685     * this function does not ensure in any way that the window will be the
3686     * active one after it.
3687     *
3688     * @param obj The window object
3689     */
3690    EAPI void         elm_win_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
3691    /**
3692     * Lower a window object.
3693     *
3694     * Places the window pointed by @p obj at the bottom of the stack, so that
3695     * no other window is covered by it.
3696     *
3697     * If elm_win_override_set() is not set, the Window Manager may ignore this
3698     * request.
3699     *
3700     * @param obj The window object
3701     */
3702    EAPI void         elm_win_lower(Evas_Object *obj) EINA_ARG_NONNULL(1);
3703    /**
3704     * Raise a window object.
3705     *
3706     * Places the window pointed by @p obj at the top of the stack, so that it's
3707     * not covered by any other window.
3708     *
3709     * If elm_win_override_set() is not set, the Window Manager may ignore this
3710     * request.
3711     *
3712     * @param obj The window object
3713     */
3714    EAPI void         elm_win_raise(Evas_Object *obj) EINA_ARG_NONNULL(1);
3715    /**
3716     * Set the borderless state of a window.
3717     *
3718     * This function requests the Window Manager to not draw any decoration
3719     * around the window.
3720     *
3721     * @param obj The window object
3722     * @param borderless If true, the window is borderless
3723     */
3724    EAPI void         elm_win_borderless_set(Evas_Object *obj, Eina_Bool borderless) EINA_ARG_NONNULL(1);
3725    /**
3726     * Get the borderless state of a window.
3727     *
3728     * @param obj The window object
3729     * @return If true, the window is borderless
3730     */
3731    EAPI Eina_Bool    elm_win_borderless_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3732    /**
3733     * Set the shaped state of a window.
3734     *
3735     * Shaped windows, when supported, will render the parts of the window that
3736     * has no content, transparent.
3737     *
3738     * If @p shaped is EINA_FALSE, then it is strongly adviced to have some
3739     * background object or cover the entire window in any other way, or the
3740     * parts of the canvas that have no data will show framebuffer artifacts.
3741     *
3742     * @param obj The window object
3743     * @param shaped If true, the window is shaped
3744     *
3745     * @see elm_win_alpha_set()
3746     */
3747    EAPI void         elm_win_shaped_set(Evas_Object *obj, Eina_Bool shaped) EINA_ARG_NONNULL(1);
3748    /**
3749     * Get the shaped state of a window.
3750     *
3751     * @param obj The window object
3752     * @return If true, the window is shaped
3753     *
3754     * @see elm_win_shaped_set()
3755     */
3756    EAPI Eina_Bool    elm_win_shaped_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3757    /**
3758     * Set the alpha channel state of a window.
3759     *
3760     * If @p alpha is EINA_TRUE, the alpha channel of the canvas will be enabled
3761     * possibly making parts of the window completely or partially transparent.
3762     * This is also subject to the underlying system supporting it, like for
3763     * example, running under a compositing manager. If no compositing is
3764     * available, enabling this option will instead fallback to using shaped
3765     * windows, with elm_win_shaped_set().
3766     *
3767     * @param obj The window object
3768     * @param alpha If true, the window has an alpha channel
3769     *
3770     * @see elm_win_alpha_set()
3771     */
3772    EAPI void         elm_win_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
3773    /**
3774     * Get the transparency state of a window.
3775     *
3776     * @param obj The window object
3777     * @return If true, the window is transparent
3778     *
3779     * @see elm_win_transparent_set()
3780     */
3781    EAPI Eina_Bool    elm_win_transparent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3782    /**
3783     * Set the transparency state of a window.
3784     *
3785     * Use elm_win_alpha_set() instead.
3786     *
3787     * @param obj The window object
3788     * @param transparent If true, the window is transparent
3789     *
3790     * @see elm_win_alpha_set()
3791     */
3792    EAPI void         elm_win_transparent_set(Evas_Object *obj, Eina_Bool transparent) EINA_ARG_NONNULL(1);
3793    /**
3794     * Get the alpha channel state of a window.
3795     *
3796     * @param obj The window object
3797     * @return If true, the window has an alpha channel
3798     */
3799    EAPI Eina_Bool    elm_win_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3800    /**
3801     * Set the override state of a window.
3802     *
3803     * A window with @p override set to EINA_TRUE will not be managed by the
3804     * Window Manager. This means that no decorations of any kind will be shown
3805     * for it, moving and resizing must be handled by the application, as well
3806     * as the window visibility.
3807     *
3808     * This should not be used for normal windows, and even for not so normal
3809     * ones, it should only be used when there's a good reason and with a lot
3810     * of care. Mishandling override windows may result situations that
3811     * disrupt the normal workflow of the end user.
3812     *
3813     * @param obj The window object
3814     * @param override If true, the window is overridden
3815     */
3816    EAPI void         elm_win_override_set(Evas_Object *obj, Eina_Bool override) EINA_ARG_NONNULL(1);
3817    /**
3818     * Get the override state of a window.
3819     *
3820     * @param obj The window object
3821     * @return If true, the window is overridden
3822     *
3823     * @see elm_win_override_set()
3824     */
3825    EAPI Eina_Bool    elm_win_override_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3826    /**
3827     * Set the fullscreen state of a window.
3828     *
3829     * @param obj The window object
3830     * @param fullscreen If true, the window is fullscreen
3831     */
3832    EAPI void         elm_win_fullscreen_set(Evas_Object *obj, Eina_Bool fullscreen) EINA_ARG_NONNULL(1);
3833    /**
3834     * Get the fullscreen state of a window.
3835     *
3836     * @param obj The window object
3837     * @return If true, the window is fullscreen
3838     */
3839    EAPI Eina_Bool    elm_win_fullscreen_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3840    /**
3841     * Set the maximized state of a window.
3842     *
3843     * @param obj The window object
3844     * @param maximized If true, the window is maximized
3845     */
3846    EAPI void         elm_win_maximized_set(Evas_Object *obj, Eina_Bool maximized) EINA_ARG_NONNULL(1);
3847    /**
3848     * Get the maximized state of a window.
3849     *
3850     * @param obj The window object
3851     * @return If true, the window is maximized
3852     */
3853    EAPI Eina_Bool    elm_win_maximized_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3854    /**
3855     * Set the iconified state of a window.
3856     *
3857     * @param obj The window object
3858     * @param iconified If true, the window is iconified
3859     */
3860    EAPI void         elm_win_iconified_set(Evas_Object *obj, Eina_Bool iconified) EINA_ARG_NONNULL(1);
3861    /**
3862     * Get the iconified state of a window.
3863     *
3864     * @param obj The window object
3865     * @return If true, the window is iconified
3866     */
3867    EAPI Eina_Bool    elm_win_iconified_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3868    /**
3869     * Set the layer of the window.
3870     *
3871     * What this means exactly will depend on the underlying engine used.
3872     *
3873     * In the case of X11 backed engines, the value in @p layer has the
3874     * following meanings:
3875     * @li < 3: The window will be placed below all others.
3876     * @li > 5: The window will be placed above all others.
3877     * @li other: The window will be placed in the default layer.
3878     *
3879     * @param obj The window object
3880     * @param layer The layer of the window
3881     */
3882    EAPI void         elm_win_layer_set(Evas_Object *obj, int layer) EINA_ARG_NONNULL(1);
3883    /**
3884     * Get the layer of the window.
3885     *
3886     * @param obj The window object
3887     * @return The layer of the window
3888     *
3889     * @see elm_win_layer_set()
3890     */
3891    EAPI int          elm_win_layer_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3892    /**
3893     * Set the rotation of the window.
3894     *
3895     * Most engines only work with multiples of 90.
3896     *
3897     * This function is used to set the orientation of the window @p obj to
3898     * match that of the screen. The window itself will be resized to adjust
3899     * to the new geometry of its contents. If you want to keep the window size,
3900     * see elm_win_rotation_with_resize_set().
3901     *
3902     * @param obj The window object
3903     * @param rotation The rotation of the window, in degrees (0-360),
3904     * counter-clockwise.
3905     */
3906    EAPI void         elm_win_rotation_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
3907    /**
3908     * Rotates the window and resizes it.
3909     *
3910     * Like elm_win_rotation_set(), but it also resizes the window's contents so
3911     * that they fit inside the current window geometry.
3912     *
3913     * @param obj The window object
3914     * @param layer The rotation of the window in degrees (0-360),
3915     * counter-clockwise.
3916     */
3917    EAPI void         elm_win_rotation_with_resize_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
3918    /**
3919     * Get the rotation of the window.
3920     *
3921     * @param obj The window object
3922     * @return The rotation of the window in degrees (0-360)
3923     *
3924     * @see elm_win_rotation_set()
3925     * @see elm_win_rotation_with_resize_set()
3926     */
3927    EAPI int          elm_win_rotation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3928    /**
3929     * Set the sticky state of the window.
3930     *
3931     * Hints the Window Manager that the window in @p obj should be left fixed
3932     * at its position even when the virtual desktop it's on moves or changes.
3933     *
3934     * @param obj The window object
3935     * @param sticky If true, the window's sticky state is enabled
3936     */
3937    EAPI void         elm_win_sticky_set(Evas_Object *obj, Eina_Bool sticky) EINA_ARG_NONNULL(1);
3938    /**
3939     * Get the sticky state of the window.
3940     *
3941     * @param obj The window object
3942     * @return If true, the window's sticky state is enabled
3943     *
3944     * @see elm_win_sticky_set()
3945     */
3946    EAPI Eina_Bool    elm_win_sticky_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3947    /**
3948     * Set if this window is an illume conformant window
3949     *
3950     * @param obj The window object
3951     * @param conformant The conformant flag (1 = conformant, 0 = non-conformant)
3952     */
3953    EAPI void         elm_win_conformant_set(Evas_Object *obj, Eina_Bool conformant) EINA_ARG_NONNULL(1);
3954    /**
3955     * Get if this window is an illume conformant window
3956     *
3957     * @param obj The window object
3958     * @return A boolean if this window is illume conformant or not
3959     */
3960    EAPI Eina_Bool    elm_win_conformant_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3961    /**
3962     * Set a window to be an illume quickpanel window
3963     *
3964     * By default window objects are not quickpanel windows.
3965     *
3966     * @param obj The window object
3967     * @param quickpanel The quickpanel flag (1 = quickpanel, 0 = normal window)
3968     */
3969    EAPI void         elm_win_quickpanel_set(Evas_Object *obj, Eina_Bool quickpanel) EINA_ARG_NONNULL(1);
3970    /**
3971     * Get if this window is a quickpanel or not
3972     *
3973     * @param obj The window object
3974     * @return A boolean if this window is a quickpanel or not
3975     */
3976    EAPI Eina_Bool    elm_win_quickpanel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3977    /**
3978     * Set the major priority of a quickpanel window
3979     *
3980     * @param obj The window object
3981     * @param priority The major priority for this quickpanel
3982     */
3983    EAPI void         elm_win_quickpanel_priority_major_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
3984    /**
3985     * Get the major priority of a quickpanel window
3986     *
3987     * @param obj The window object
3988     * @return The major priority of this quickpanel
3989     */
3990    EAPI int          elm_win_quickpanel_priority_major_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3991    /**
3992     * Set the minor priority of a quickpanel window
3993     *
3994     * @param obj The window object
3995     * @param priority The minor priority for this quickpanel
3996     */
3997    EAPI void         elm_win_quickpanel_priority_minor_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
3998    /**
3999     * Get the minor priority of a quickpanel window
4000     *
4001     * @param obj The window object
4002     * @return The minor priority of this quickpanel
4003     */
4004    EAPI int          elm_win_quickpanel_priority_minor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4005    /**
4006     * Set which zone this quickpanel should appear in
4007     *
4008     * @param obj The window object
4009     * @param zone The requested zone for this quickpanel
4010     */
4011    EAPI void         elm_win_quickpanel_zone_set(Evas_Object *obj, int zone) EINA_ARG_NONNULL(1);
4012    /**
4013     * Get which zone this quickpanel should appear in
4014     *
4015     * @param obj The window object
4016     * @return The requested zone for this quickpanel
4017     */
4018    EAPI int          elm_win_quickpanel_zone_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4019    /**
4020     * Set the window to be skipped by keyboard focus
4021     *
4022     * This sets the window to be skipped by normal keyboard input. This means
4023     * a window manager will be asked to not focus this window as well as omit
4024     * it from things like the taskbar, pager, "alt-tab" list etc. etc.
4025     *
4026     * Call this and enable it on a window BEFORE you show it for the first time,
4027     * otherwise it may have no effect.
4028     *
4029     * Use this for windows that have only output information or might only be
4030     * interacted with by the mouse or fingers, and never for typing input.
4031     * Be careful that this may have side-effects like making the window
4032     * non-accessible in some cases unless the window is specially handled. Use
4033     * this with care.
4034     *
4035     * @param obj The window object
4036     * @param skip The skip flag state (EINA_TRUE if it is to be skipped)
4037     */
4038    EAPI void         elm_win_prop_focus_skip_set(Evas_Object *obj, Eina_Bool skip) EINA_ARG_NONNULL(1);
4039    /**
4040     * Send a command to the windowing environment
4041     *
4042     * This is intended to work in touchscreen or small screen device
4043     * environments where there is a more simplistic window management policy in
4044     * place. This uses the window object indicated to select which part of the
4045     * environment to control (the part that this window lives in), and provides
4046     * a command and an optional parameter structure (use NULL for this if not
4047     * needed).
4048     *
4049     * @param obj The window object that lives in the environment to control
4050     * @param command The command to send
4051     * @param params Optional parameters for the command
4052     */
4053    EAPI void         elm_win_illume_command_send(Evas_Object *obj, Elm_Illume_Command command, void *params) EINA_ARG_NONNULL(1);
4054    /**
4055     * Get the inlined image object handle
4056     *
4057     * When you create a window with elm_win_add() of type ELM_WIN_INLINED_IMAGE,
4058     * then the window is in fact an evas image object inlined in the parent
4059     * canvas. You can get this object (be careful to not manipulate it as it
4060     * is under control of elementary), and use it to do things like get pixel
4061     * data, save the image to a file, etc.
4062     *
4063     * @param obj The window object to get the inlined image from
4064     * @return The inlined image object, or NULL if none exists
4065     */
4066    EAPI Evas_Object *elm_win_inlined_image_object_get(Evas_Object *obj);
4067    /**
4068     * Set the enabled status for the focus highlight in a window
4069     *
4070     * This function will enable or disable the focus highlight only for the
4071     * given window, regardless of the global setting for it
4072     *
4073     * @param obj The window where to enable the highlight
4074     * @param enabled The enabled value for the highlight
4075     */
4076    EAPI void         elm_win_focus_highlight_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
4077    /**
4078     * Get the enabled value of the focus highlight for this window
4079     *
4080     * @param obj The window in which to check if the focus highlight is enabled
4081     *
4082     * @return EINA_TRUE if enabled, EINA_FALSE otherwise
4083     */
4084    EAPI Eina_Bool    elm_win_focus_highlight_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4085    /**
4086     * Set the style for the focus highlight on this window
4087     *
4088     * Sets the style to use for theming the highlight of focused objects on
4089     * the given window. If @p style is NULL, the default will be used.
4090     *
4091     * @param obj The window where to set the style
4092     * @param style The style to set
4093     */
4094    EAPI void         elm_win_focus_highlight_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
4095    /**
4096     * Get the style set for the focus highlight object
4097     *
4098     * Gets the style set for this windows highilght object, or NULL if none
4099     * is set.
4100     *
4101     * @param obj The window to retrieve the highlights style from
4102     *
4103     * @return The style set or NULL if none was. Default is used in that case.
4104     */
4105    EAPI const char  *elm_win_focus_highlight_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4106    /*...
4107     * ecore_x_icccm_hints_set -> accepts_focus (add to ecore_evas)
4108     * ecore_x_icccm_hints_set -> window_group (add to ecore_evas)
4109     * ecore_x_icccm_size_pos_hints_set -> request_pos (add to ecore_evas)
4110     * ecore_x_icccm_client_leader_set -> l (add to ecore_evas)
4111     * ecore_x_icccm_window_role_set -> role (add to ecore_evas)
4112     * ecore_x_icccm_transient_for_set -> forwin (add to ecore_evas)
4113     * ecore_x_netwm_window_type_set -> type (add to ecore_evas)
4114     *
4115     * (add to ecore_x) set netwm argb icon! (add to ecore_evas)
4116     * (blank mouse, private mouse obj, defaultmouse)
4117     *
4118     */
4119    /**
4120     * Sets the keyboard mode of the window.
4121     *
4122     * @param obj The window object
4123     * @param mode The mode to set, one of #Elm_Win_Keyboard_Mode
4124     */
4125    EAPI void                  elm_win_keyboard_mode_set(Evas_Object *obj, Elm_Win_Keyboard_Mode mode) EINA_ARG_NONNULL(1);
4126    /**
4127     * Gets the keyboard mode of the window.
4128     *
4129     * @param obj The window object
4130     * @return The mode, one of #Elm_Win_Keyboard_Mode
4131     */
4132    EAPI Elm_Win_Keyboard_Mode elm_win_keyboard_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4133    /**
4134     * Sets whether the window is a keyboard.
4135     *
4136     * @param obj The window object
4137     * @param is_keyboard If true, the window is a virtual keyboard
4138     */
4139    EAPI void                  elm_win_keyboard_win_set(Evas_Object *obj, Eina_Bool is_keyboard) EINA_ARG_NONNULL(1);
4140    /**
4141     * Gets whether the window is a keyboard.
4142     *
4143     * @param obj The window object
4144     * @return If the window is a virtual keyboard
4145     */
4146    EAPI Eina_Bool             elm_win_keyboard_win_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4147
4148    /**
4149     * Get the screen position of a window.
4150     *
4151     * @param obj The window object
4152     * @param x The int to store the x coordinate to
4153     * @param y The int to store the y coordinate to
4154     */
4155    EAPI void                  elm_win_screen_position_get(const Evas_Object *obj, int *x, int *y) EINA_ARG_NONNULL(1);
4156    /**
4157     * @}
4158     */
4159
4160    /**
4161     * @defgroup Inwin Inwin
4162     *
4163     * @image html img/widget/inwin/preview-00.png
4164     * @image latex img/widget/inwin/preview-00.eps
4165     * @image html img/widget/inwin/preview-01.png
4166     * @image latex img/widget/inwin/preview-01.eps
4167     * @image html img/widget/inwin/preview-02.png
4168     * @image latex img/widget/inwin/preview-02.eps
4169     *
4170     * An inwin is a window inside a window that is useful for a quick popup.
4171     * It does not hover.
4172     *
4173     * It works by creating an object that will occupy the entire window, so it
4174     * must be created using an @ref Win "elm_win" as parent only. The inwin
4175     * object can be hidden or restacked below every other object if it's
4176     * needed to show what's behind it without destroying it. If this is done,
4177     * the elm_win_inwin_activate() function can be used to bring it back to
4178     * full visibility again.
4179     *
4180     * There are three styles available in the default theme. These are:
4181     * @li default: The inwin is sized to take over most of the window it's
4182     * placed in.
4183     * @li minimal: The size of the inwin will be the minimum necessary to show
4184     * its contents.
4185     * @li minimal_vertical: Horizontally, the inwin takes as much space as
4186     * possible, but it's sized vertically the most it needs to fit its\
4187     * contents.
4188     *
4189     * Some examples of Inwin can be found in the following:
4190     * @li @ref inwin_example_01
4191     *
4192     * @{
4193     */
4194    /**
4195     * Adds an inwin to the current window
4196     *
4197     * The @p obj used as parent @b MUST be an @ref Win "Elementary Window".
4198     * Never call this function with anything other than the top-most window
4199     * as its parameter, unless you are fond of undefined behavior.
4200     *
4201     * After creating the object, the widget will set itself as resize object
4202     * for the window with elm_win_resize_object_add(), so when shown it will
4203     * appear to cover almost the entire window (how much of it depends on its
4204     * content and the style used). It must not be added into other container
4205     * objects and it needs not be moved or resized manually.
4206     *
4207     * @param parent The parent object
4208     * @return The new object or NULL if it cannot be created
4209     */
4210    EAPI Evas_Object          *elm_win_inwin_add(Evas_Object *obj) EINA_ARG_NONNULL(1);
4211    /**
4212     * Activates an inwin object, ensuring its visibility
4213     *
4214     * This function will make sure that the inwin @p obj is completely visible
4215     * by calling evas_object_show() and evas_object_raise() on it, to bring it
4216     * to the front. It also sets the keyboard focus to it, which will be passed
4217     * onto its content.
4218     *
4219     * The object's theme will also receive the signal "elm,action,show" with
4220     * source "elm".
4221     *
4222     * @param obj The inwin to activate
4223     */
4224    EAPI void                  elm_win_inwin_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
4225    /**
4226     * Set the content of an inwin object.
4227     *
4228     * Once the content object is set, a previously set one will be deleted.
4229     * If you want to keep that old content object, use the
4230     * elm_win_inwin_content_unset() function.
4231     *
4232     * @param obj The inwin object
4233     * @param content The object to set as content
4234     */
4235    EAPI void                  elm_win_inwin_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
4236    /**
4237     * Get the content of an inwin object.
4238     *
4239     * Return the content object which is set for this widget.
4240     *
4241     * The returned object is valid as long as the inwin is still alive and no
4242     * other content is set on it. Deleting the object will notify the inwin
4243     * about it and this one will be left empty.
4244     *
4245     * If you need to remove an inwin's content to be reused somewhere else,
4246     * see elm_win_inwin_content_unset().
4247     *
4248     * @param obj The inwin object
4249     * @return The content that is being used
4250     */
4251    EAPI Evas_Object          *elm_win_inwin_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4252    /**
4253     * Unset the content of an inwin object.
4254     *
4255     * Unparent and return the content object which was set for this widget.
4256     *
4257     * @param obj The inwin object
4258     * @return The content that was being used
4259     */
4260    EAPI Evas_Object          *elm_win_inwin_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4261    /**
4262     * @}
4263     */
4264    /* X specific calls - won't work on non-x engines (return 0) */
4265
4266    /**
4267     * Get the Ecore_X_Window of an Evas_Object
4268     *
4269     * @param obj The object
4270     *
4271     * @return The Ecore_X_Window of @p obj
4272     *
4273     * @ingroup Win
4274     */
4275    EAPI Ecore_X_Window elm_win_xwindow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4276
4277    /* smart callbacks called:
4278     * "delete,request" - the user requested to delete the window
4279     * "focus,in" - window got focus
4280     * "focus,out" - window lost focus
4281     * "moved" - window that holds the canvas was moved
4282     */
4283
4284    /**
4285     * @defgroup Bg Bg
4286     *
4287     * @image html img/widget/bg/preview-00.png
4288     * @image latex img/widget/bg/preview-00.eps
4289     *
4290     * @brief Background object, used for setting a solid color, image or Edje
4291     * group as background to a window or any container object.
4292     *
4293     * The bg object is used for setting a solid background to a window or
4294     * packing into any container object. It works just like an image, but has
4295     * some properties useful to a background, like setting it to tiled,
4296     * centered, scaled or stretched.
4297     *
4298     * Here is some sample code using it:
4299     * @li @ref bg_01_example_page
4300     * @li @ref bg_02_example_page
4301     * @li @ref bg_03_example_page
4302     */
4303
4304    /* bg */
4305    typedef enum _Elm_Bg_Option
4306      {
4307         ELM_BG_OPTION_CENTER,  /**< center the background */
4308         ELM_BG_OPTION_SCALE,   /**< scale the background retaining aspect ratio */
4309         ELM_BG_OPTION_STRETCH, /**< stretch the background to fill */
4310         ELM_BG_OPTION_TILE     /**< tile background at its original size */
4311      } Elm_Bg_Option;
4312
4313    /**
4314     * Add a new background to the parent
4315     *
4316     * @param parent The parent object
4317     * @return The new object or NULL if it cannot be created
4318     *
4319     * @ingroup Bg
4320     */
4321    EAPI Evas_Object  *elm_bg_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4322
4323    /**
4324     * Set the file (image or edje) used for the background
4325     *
4326     * @param obj The bg object
4327     * @param file The file path
4328     * @param group Optional key (group in Edje) within the file
4329     *
4330     * This sets the image file used in the background object. The image (or edje)
4331     * will be stretched (retaining aspect if its an image file) to completely fill
4332     * the bg object. This may mean some parts are not visible.
4333     *
4334     * @note  Once the image of @p obj is set, a previously set one will be deleted,
4335     * even if @p file is NULL.
4336     *
4337     * @ingroup Bg
4338     */
4339    EAPI void          elm_bg_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
4340
4341    /**
4342     * Get the file (image or edje) used for the background
4343     *
4344     * @param obj The bg object
4345     * @param file The file path
4346     * @param group Optional key (group in Edje) within the file
4347     *
4348     * @ingroup Bg
4349     */
4350    EAPI void          elm_bg_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4351
4352    /**
4353     * Set the option used for the background image
4354     *
4355     * @param obj The bg object
4356     * @param option The desired background option (TILE, SCALE)
4357     *
4358     * This sets the option used for manipulating the display of the background
4359     * image. The image can be tiled or scaled.
4360     *
4361     * @ingroup Bg
4362     */
4363    EAPI void          elm_bg_option_set(Evas_Object *obj, Elm_Bg_Option option) EINA_ARG_NONNULL(1);
4364
4365    /**
4366     * Get the option used for the background image
4367     *
4368     * @param obj The bg object
4369     * @return The desired background option (CENTER, SCALE, STRETCH or TILE)
4370     *
4371     * @ingroup Bg
4372     */
4373    EAPI Elm_Bg_Option elm_bg_option_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4374    /**
4375     * Set the option used for the background color
4376     *
4377     * @param obj The bg object
4378     * @param r
4379     * @param g
4380     * @param b
4381     *
4382     * This sets the color used for the background rectangle. Its range goes
4383     * from 0 to 255.
4384     *
4385     * @ingroup Bg
4386     */
4387    EAPI void          elm_bg_color_set(Evas_Object *obj, int r, int g, int b) EINA_ARG_NONNULL(1);
4388    /**
4389     * Get the option used for the background color
4390     *
4391     * @param obj The bg object
4392     * @param r
4393     * @param g
4394     * @param b
4395     *
4396     * @ingroup Bg
4397     */
4398    EAPI void          elm_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b) EINA_ARG_NONNULL(1);
4399
4400    /**
4401     * Set the overlay object used for the background object.
4402     *
4403     * @param obj The bg object
4404     * @param overlay The overlay object
4405     *
4406     * This provides a way for elm_bg to have an 'overlay' that will be on top
4407     * of the bg. Once the over object is set, a previously set one will be
4408     * deleted, even if you set the new one to NULL. If you want to keep that
4409     * old content object, use the elm_bg_overlay_unset() function.
4410     *
4411     * @ingroup Bg
4412     */
4413
4414    EAPI void          elm_bg_overlay_set(Evas_Object *obj, Evas_Object *overlay) EINA_ARG_NONNULL(1);
4415
4416    /**
4417     * Get the overlay object used for the background object.
4418     *
4419     * @param obj The bg object
4420     * @return The content that is being used
4421     *
4422     * Return the content object which is set for this widget
4423     *
4424     * @ingroup Bg
4425     */
4426    EAPI Evas_Object  *elm_bg_overlay_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4427
4428    /**
4429     * Get the overlay object used for the background object.
4430     *
4431     * @param obj The bg object
4432     * @return The content that was being used
4433     *
4434     * Unparent and return the overlay object which was set for this widget
4435     *
4436     * @ingroup Bg
4437     */
4438    EAPI Evas_Object  *elm_bg_overlay_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4439
4440    /**
4441     * Set the size of the pixmap representation of the image.
4442     *
4443     * This option just makes sense if an image is going to be set in the bg.
4444     *
4445     * @param obj The bg object
4446     * @param w The new width of the image pixmap representation.
4447     * @param h The new height of the image pixmap representation.
4448     *
4449     * This function sets a new size for pixmap representation of the given bg
4450     * image. It allows the image to be loaded already in the specified size,
4451     * reducing the memory usage and load time when loading a big image with load
4452     * size set to a smaller size.
4453     *
4454     * NOTE: this is just a hint, the real size of the pixmap may differ
4455     * depending on the type of image being loaded, being bigger than requested.
4456     *
4457     * @ingroup Bg
4458     */
4459    EAPI void          elm_bg_load_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
4460    /* smart callbacks called:
4461     */
4462
4463    /**
4464     * @defgroup Icon Icon
4465     *
4466     * @image html img/widget/icon/preview-00.png
4467     * @image latex img/widget/icon/preview-00.eps
4468     *
4469     * An object that provides standard icon images (delete, edit, arrows, etc.)
4470     * or a custom file (PNG, JPG, EDJE, etc.) used for an icon.
4471     *
4472     * The icon image requested can be in the elementary theme, or in the
4473     * freedesktop.org paths. It's possible to set the order of preference from
4474     * where the image will be used.
4475     *
4476     * This API is very similar to @ref Image, but with ready to use images.
4477     *
4478     * Default images provided by the theme are described below.
4479     *
4480     * The first list contains icons that were first intended to be used in
4481     * toolbars, but can be used in many other places too:
4482     * @li home
4483     * @li close
4484     * @li apps
4485     * @li arrow_up
4486     * @li arrow_down
4487     * @li arrow_left
4488     * @li arrow_right
4489     * @li chat
4490     * @li clock
4491     * @li delete
4492     * @li edit
4493     * @li refresh
4494     * @li folder
4495     * @li file
4496     *
4497     * Now some icons that were designed to be used in menus (but again, you can
4498     * use them anywhere else):
4499     * @li menu/home
4500     * @li menu/close
4501     * @li menu/apps
4502     * @li menu/arrow_up
4503     * @li menu/arrow_down
4504     * @li menu/arrow_left
4505     * @li menu/arrow_right
4506     * @li menu/chat
4507     * @li menu/clock
4508     * @li menu/delete
4509     * @li menu/edit
4510     * @li menu/refresh
4511     * @li menu/folder
4512     * @li menu/file
4513     *
4514     * And here we have some media player specific icons:
4515     * @li media_player/forward
4516     * @li media_player/info
4517     * @li media_player/next
4518     * @li media_player/pause
4519     * @li media_player/play
4520     * @li media_player/prev
4521     * @li media_player/rewind
4522     * @li media_player/stop
4523     *
4524     * Signals that you can add callbacks for are:
4525     *
4526     * "clicked" - This is called when a user has clicked the icon
4527     *
4528     * An example of usage for this API follows:
4529     * @li @ref tutorial_icon
4530     */
4531
4532    /**
4533     * @addtogroup Icon
4534     * @{
4535     */
4536
4537    typedef enum _Elm_Icon_Type
4538      {
4539         ELM_ICON_NONE,
4540         ELM_ICON_FILE,
4541         ELM_ICON_STANDARD
4542      } Elm_Icon_Type;
4543    /**
4544     * @enum _Elm_Icon_Lookup_Order
4545     * @typedef Elm_Icon_Lookup_Order
4546     *
4547     * Lookup order used by elm_icon_standard_set(). Should look for icons in the
4548     * theme, FDO paths, or both?
4549     *
4550     * @ingroup Icon
4551     */
4552    typedef enum _Elm_Icon_Lookup_Order
4553      {
4554         ELM_ICON_LOOKUP_FDO_THEME, /**< icon look up order: freedesktop, theme */
4555         ELM_ICON_LOOKUP_THEME_FDO, /**< icon look up order: theme, freedesktop */
4556         ELM_ICON_LOOKUP_FDO,       /**< icon look up order: freedesktop */
4557         ELM_ICON_LOOKUP_THEME      /**< icon look up order: theme */
4558      } Elm_Icon_Lookup_Order;
4559
4560    /**
4561     * Add a new icon object to the parent.
4562     *
4563     * @param parent The parent object
4564     * @return The new object or NULL if it cannot be created
4565     *
4566     * @see elm_icon_file_set()
4567     *
4568     * @ingroup Icon
4569     */
4570    EAPI Evas_Object          *elm_icon_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4571    /**
4572     * Set the file that will be used as icon.
4573     *
4574     * @param obj The icon object
4575     * @param file The path to file that will be used as icon image
4576     * @param group The group that the icon belongs to in edje file
4577     *
4578     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4579     *
4580     * @note The icon image set by this function can be changed by
4581     * elm_icon_standard_set().
4582     *
4583     * @see elm_icon_file_get()
4584     *
4585     * @ingroup Icon
4586     */
4587    EAPI Eina_Bool             elm_icon_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
4588    /**
4589     * Set a location in memory to be used as an icon
4590     *
4591     * @param obj The icon object
4592     * @param img The binary data that will be used as an image
4593     * @param size The size of binary data @p img
4594     * @param format Optional format of @p img to pass to the image loader
4595     * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
4596     *
4597     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4598     *
4599     * @note The icon image set by this function can be changed by
4600     * elm_icon_standard_set().
4601     *
4602     * @ingroup Icon
4603     */
4604    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);
4605    /**
4606     * Get the file that will be used as icon.
4607     *
4608     * @param obj The icon object
4609     * @param file The path to file that will be used as icon icon image
4610     * @param group The group that the icon belongs to in edje file
4611     *
4612     * @see elm_icon_file_set()
4613     *
4614     * @ingroup Icon
4615     */
4616    EAPI void                  elm_icon_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4617    EAPI void                  elm_icon_thumb_set(const Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
4618    /**
4619     * Set the icon by icon standards names.
4620     *
4621     * @param obj The icon object
4622     * @param name The icon name
4623     *
4624     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4625     *
4626     * For example, freedesktop.org defines standard icon names such as "home",
4627     * "network", etc. There can be different icon sets to match those icon
4628     * keys. The @p name given as parameter is one of these "keys", and will be
4629     * used to look in the freedesktop.org paths and elementary theme. One can
4630     * change the lookup order with elm_icon_order_lookup_set().
4631     *
4632     * If name is not found in any of the expected locations and it is the
4633     * absolute path of an image file, this image will be used.
4634     *
4635     * @note The icon image set by this function can be changed by
4636     * elm_icon_file_set().
4637     *
4638     * @see elm_icon_standard_get()
4639     * @see elm_icon_file_set()
4640     *
4641     * @ingroup Icon
4642     */
4643    EAPI Eina_Bool             elm_icon_standard_set(Evas_Object *obj, const char *name) EINA_ARG_NONNULL(1);
4644    /**
4645     * Get the icon name set by icon standard names.
4646     *
4647     * @param obj The icon object
4648     * @return The icon name
4649     *
4650     * If the icon image was set using elm_icon_file_set() instead of
4651     * elm_icon_standard_set(), then this function will return @c NULL.
4652     *
4653     * @see elm_icon_standard_set()
4654     *
4655     * @ingroup Icon
4656     */
4657    EAPI const char           *elm_icon_standard_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4658    /**
4659     * Set the smooth effect for an icon object.
4660     *
4661     * @param obj The icon object
4662     * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
4663     * otherwise. Default is @c EINA_TRUE.
4664     *
4665     * Set the scaling algorithm to be used when scaling the icon image. Smooth
4666     * scaling provides a better resulting image, but is slower.
4667     *
4668     * The smooth scaling should be disabled when making animations that change
4669     * the icon size, since they will be faster. Animations that don't require
4670     * resizing of the icon can keep the smooth scaling enabled (even if the icon
4671     * is already scaled, since the scaled icon image will be cached).
4672     *
4673     * @see elm_icon_smooth_get()
4674     *
4675     * @ingroup Icon
4676     */
4677    EAPI void                  elm_icon_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
4678    /**
4679     * Get the smooth effect for an icon object.
4680     *
4681     * @param obj The icon object
4682     * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
4683     *
4684     * @see elm_icon_smooth_set()
4685     *
4686     * @ingroup Icon
4687     */
4688    EAPI Eina_Bool             elm_icon_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4689    /**
4690     * Disable scaling of this object.
4691     *
4692     * @param obj The icon object.
4693     * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
4694     * otherwise. Default is @c EINA_FALSE.
4695     *
4696     * This function disables scaling of the icon object through the function
4697     * elm_object_scale_set(). However, this does not affect the object
4698     * size/resize in any way. For that effect, take a look at
4699     * elm_icon_scale_set().
4700     *
4701     * @see elm_icon_no_scale_get()
4702     * @see elm_icon_scale_set()
4703     * @see elm_object_scale_set()
4704     *
4705     * @ingroup Icon
4706     */
4707    EAPI void                  elm_icon_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
4708    /**
4709     * Get whether scaling is disabled on the object.
4710     *
4711     * @param obj The icon object
4712     * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
4713     *
4714     * @see elm_icon_no_scale_set()
4715     *
4716     * @ingroup Icon
4717     */
4718    EAPI Eina_Bool             elm_icon_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4719    /**
4720     * Set if the object is (up/down) resizable.
4721     *
4722     * @param obj The icon object
4723     * @param scale_up A bool to set if the object is resizable up. Default is
4724     * @c EINA_TRUE.
4725     * @param scale_down A bool to set if the object is resizable down. Default
4726     * is @c EINA_TRUE.
4727     *
4728     * This function limits the icon object resize ability. If @p scale_up is set to
4729     * @c EINA_FALSE, the object can't have its height or width resized to a value
4730     * higher than the original icon size. Same is valid for @p scale_down.
4731     *
4732     * @see elm_icon_scale_get()
4733     *
4734     * @ingroup Icon
4735     */
4736    EAPI void                  elm_icon_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
4737    /**
4738     * Get if the object is (up/down) resizable.
4739     *
4740     * @param obj The icon object
4741     * @param scale_up A bool to set if the object is resizable up
4742     * @param scale_down A bool to set if the object is resizable down
4743     *
4744     * @see elm_icon_scale_set()
4745     *
4746     * @ingroup Icon
4747     */
4748    EAPI void                  elm_icon_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
4749    /**
4750     * Get the object's image size
4751     *
4752     * @param obj The icon object
4753     * @param w A pointer to store the width in
4754     * @param h A pointer to store the height in
4755     *
4756     * @ingroup Icon
4757     */
4758    EAPI void                  elm_icon_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
4759    /**
4760     * Set if the icon fill the entire object area.
4761     *
4762     * @param obj The icon object
4763     * @param fill_outside @c EINA_TRUE if the object is filled outside,
4764     * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
4765     *
4766     * When the icon object is resized to a different aspect ratio from the
4767     * original icon image, the icon image will still keep its aspect. This flag
4768     * tells how the image should fill the object's area. They are: keep the
4769     * entire icon inside the limits of height and width of the object (@p
4770     * fill_outside is @c EINA_FALSE) or let the extra width or height go outside
4771     * of the object, and the icon will fill the entire object (@p fill_outside
4772     * is @c EINA_TRUE).
4773     *
4774     * @note Unlike @ref Image, there's no option in icon to set the aspect ratio
4775     * retain property to false. Thus, the icon image will always keep its
4776     * original aspect ratio.
4777     *
4778     * @see elm_icon_fill_outside_get()
4779     * @see elm_image_fill_outside_set()
4780     *
4781     * @ingroup Icon
4782     */
4783    EAPI void                  elm_icon_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
4784    /**
4785     * Get if the object is filled outside.
4786     *
4787     * @param obj The icon object
4788     * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
4789     *
4790     * @see elm_icon_fill_outside_set()
4791     *
4792     * @ingroup Icon
4793     */
4794    EAPI Eina_Bool             elm_icon_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4795    /**
4796     * Set the prescale size for the icon.
4797     *
4798     * @param obj The icon object
4799     * @param size The prescale size. This value is used for both width and
4800     * height.
4801     *
4802     * This function sets a new size for pixmap representation of the given
4803     * icon. It allows the icon to be loaded already in the specified size,
4804     * reducing the memory usage and load time when loading a big icon with load
4805     * size set to a smaller size.
4806     *
4807     * It's equivalent to the elm_bg_load_size_set() function for bg.
4808     *
4809     * @note this is just a hint, the real size of the pixmap may differ
4810     * depending on the type of icon being loaded, being bigger than requested.
4811     *
4812     * @see elm_icon_prescale_get()
4813     * @see elm_bg_load_size_set()
4814     *
4815     * @ingroup Icon
4816     */
4817    EAPI void                  elm_icon_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
4818    /**
4819     * Get the prescale size for the icon.
4820     *
4821     * @param obj The icon object
4822     * @return The prescale size
4823     *
4824     * @see elm_icon_prescale_set()
4825     *
4826     * @ingroup Icon
4827     */
4828    EAPI int                   elm_icon_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4829    /**
4830     * Sets the icon lookup order used by elm_icon_standard_set().
4831     *
4832     * @param obj The icon object
4833     * @param order The icon lookup order (can be one of
4834     * ELM_ICON_LOOKUP_FDO_THEME, ELM_ICON_LOOKUP_THEME_FDO, ELM_ICON_LOOKUP_FDO
4835     * or ELM_ICON_LOOKUP_THEME)
4836     *
4837     * @see elm_icon_order_lookup_get()
4838     * @see Elm_Icon_Lookup_Order
4839     *
4840     * @ingroup Icon
4841     */
4842    EAPI void                  elm_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
4843    /**
4844     * Gets the icon lookup order.
4845     *
4846     * @param obj The icon object
4847     * @return The icon lookup order
4848     *
4849     * @see elm_icon_order_lookup_set()
4850     * @see Elm_Icon_Lookup_Order
4851     *
4852     * @ingroup Icon
4853     */
4854    EAPI Elm_Icon_Lookup_Order elm_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4855    /**
4856     * Get if the icon supports animation or not.
4857     *
4858     * @param obj The icon object
4859     * @return @c EINA_TRUE if the icon supports animation,
4860     *         @c EINA_FALSE otherwise.
4861     *
4862     * Return if this elm icon's image can be animated. Currently Evas only
4863     * supports gif animation. If the return value is EINA_FALSE, other
4864     * elm_icon_animated_XXX APIs won't work.
4865     * @ingroup Icon
4866     */
4867    EAPI Eina_Bool           elm_icon_animated_available_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4868    /**
4869     * Set animation mode of the icon.
4870     *
4871     * @param obj The icon object
4872     * @param anim @c EINA_TRUE if the object do animation job,
4873     * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
4874     *
4875     * Even though elm icon's file can be animated,
4876     * sometimes appication developer want to just first page of image.
4877     * In that time, don't call this function, because default value is EINA_FALSE
4878     * Only when you want icon support anition,
4879     * use this function and set animated to EINA_TURE
4880     * @ingroup Icon
4881     */
4882    EAPI void                elm_icon_animated_set(Evas_Object *obj, Eina_Bool animated) EINA_ARG_NONNULL(1);
4883    /**
4884     * Get animation mode of the icon.
4885     *
4886     * @param obj The icon object
4887     * @return The animation mode of the icon object
4888     * @see elm_icon_animated_set
4889     * @ingroup Icon
4890     */
4891    EAPI Eina_Bool           elm_icon_animated_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4892    /**
4893     * Set animation play mode of the icon.
4894     *
4895     * @param obj The icon object
4896     * @param play @c EINA_TRUE the object play animation images,
4897     * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
4898     *
4899     * If you want to play elm icon's animation, you set play to EINA_TURE.
4900     * For example, you make gif player using this set/get API and click event.
4901     *
4902     * 1. Click event occurs
4903     * 2. Check play flag using elm_icon_animaged_play_get
4904     * 3. If elm icon was playing, set play to EINA_FALSE.
4905     *    Then animation will be stopped and vice versa
4906     * @ingroup Icon
4907     */
4908    EAPI void                elm_icon_animated_play_set(Evas_Object *obj, Eina_Bool play) EINA_ARG_NONNULL(1);
4909    /**
4910     * Get animation play mode of the icon.
4911     *
4912     * @param obj The icon object
4913     * @return The play mode of the icon object
4914     *
4915     * @see elm_icon_animated_lay_get
4916     * @ingroup Icon
4917     */
4918    EAPI Eina_Bool           elm_icon_animated_play_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4919
4920    /**
4921     * @}
4922     */
4923
4924    /**
4925     * @defgroup Image Image
4926     *
4927     * @image html img/widget/image/preview-00.png
4928     * @image latex img/widget/image/preview-00.eps
4929
4930     *
4931     * An object that allows one to load an image file to it. It can be used
4932     * anywhere like any other elementary widget.
4933     *
4934     * This widget provides most of the functionality provided from @ref Bg or @ref
4935     * Icon, but with a slightly different API (use the one that fits better your
4936     * needs).
4937     *
4938     * The features not provided by those two other image widgets are:
4939     * @li allowing to get the basic @c Evas_Object with elm_image_object_get();
4940     * @li change the object orientation with elm_image_orient_set();
4941     * @li and turning the image editable with elm_image_editable_set().
4942     *
4943     * Signals that you can add callbacks for are:
4944     *
4945     * @li @c "clicked" - This is called when a user has clicked the image
4946     *
4947     * An example of usage for this API follows:
4948     * @li @ref tutorial_image
4949     */
4950
4951    /**
4952     * @addtogroup Image
4953     * @{
4954     */
4955
4956    /**
4957     * @enum _Elm_Image_Orient
4958     * @typedef Elm_Image_Orient
4959     *
4960     * Possible orientation options for elm_image_orient_set().
4961     *
4962     * @image html elm_image_orient_set.png
4963     * @image latex elm_image_orient_set.eps width=\textwidth
4964     *
4965     * @ingroup Image
4966     */
4967    typedef enum _Elm_Image_Orient
4968      {
4969         ELM_IMAGE_ORIENT_NONE, /**< no orientation change */
4970         ELM_IMAGE_ROTATE_90_CW, /**< rotate 90 degrees clockwise */
4971         ELM_IMAGE_ROTATE_180_CW, /**< rotate 180 degrees clockwise */
4972         ELM_IMAGE_ROTATE_90_CCW, /**< rotate 90 degrees counter-clockwise (i.e. 270 degrees clockwise) */
4973         ELM_IMAGE_FLIP_HORIZONTAL, /**< flip image horizontally */
4974         ELM_IMAGE_FLIP_VERTICAL, /**< flip image vertically */
4975         ELM_IMAGE_FLIP_TRANSPOSE, /**< flip the image along the y = (side - x) line*/
4976         ELM_IMAGE_FLIP_TRANSVERSE /**< flip the image along the y = x line */
4977      } Elm_Image_Orient;
4978
4979    /**
4980     * Add a new image to the parent.
4981     *
4982     * @param parent The parent object
4983     * @return The new object or NULL if it cannot be created
4984     *
4985     * @see elm_image_file_set()
4986     *
4987     * @ingroup Image
4988     */
4989    EAPI Evas_Object     *elm_image_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4990    /**
4991     * Set the file that will be used as image.
4992     *
4993     * @param obj The image object
4994     * @param file The path to file that will be used as image
4995     * @param group The group that the image belongs in edje file (if it's an
4996     * edje image)
4997     *
4998     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
4999     *
5000     * @see elm_image_file_get()
5001     *
5002     * @ingroup Image
5003     */
5004    EAPI Eina_Bool        elm_image_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
5005    /**
5006     * Get the file that will be used as image.
5007     *
5008     * @param obj The image object
5009     * @param file The path to file
5010     * @param group The group that the image belongs in edje file
5011     *
5012     * @see elm_image_file_set()
5013     *
5014     * @ingroup Image
5015     */
5016    EAPI void             elm_image_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
5017    /**
5018     * Set the smooth effect for an image.
5019     *
5020     * @param obj The image object
5021     * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
5022     * otherwise. Default is @c EINA_TRUE.
5023     *
5024     * Set the scaling algorithm to be used when scaling the image. Smooth
5025     * scaling provides a better resulting image, but is slower.
5026     *
5027     * The smooth scaling should be disabled when making animations that change
5028     * the image size, since it will be faster. Animations that don't require
5029     * resizing of the image can keep the smooth scaling enabled (even if the
5030     * image is already scaled, since the scaled image will be cached).
5031     *
5032     * @see elm_image_smooth_get()
5033     *
5034     * @ingroup Image
5035     */
5036    EAPI void             elm_image_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
5037    /**
5038     * Get the smooth effect for an image.
5039     *
5040     * @param obj The image object
5041     * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
5042     *
5043     * @see elm_image_smooth_get()
5044     *
5045     * @ingroup Image
5046     */
5047    EAPI Eina_Bool        elm_image_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5048    /**
5049     * Gets the current size of the image.
5050     *
5051     * @param obj The image object.
5052     * @param w Pointer to store width, or NULL.
5053     * @param h Pointer to store height, or NULL.
5054     *
5055     * This is the real size of the image, not the size of the object.
5056     *
5057     * On error, neither w or h will be written.
5058     *
5059     * @ingroup Image
5060     */
5061    EAPI void             elm_image_object_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
5062    /**
5063     * Disable scaling of this object.
5064     *
5065     * @param obj The image object.
5066     * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
5067     * otherwise. Default is @c EINA_FALSE.
5068     *
5069     * This function disables scaling of the elm_image widget through the
5070     * function elm_object_scale_set(). However, this does not affect the widget
5071     * size/resize in any way. For that effect, take a look at
5072     * elm_image_scale_set().
5073     *
5074     * @see elm_image_no_scale_get()
5075     * @see elm_image_scale_set()
5076     * @see elm_object_scale_set()
5077     *
5078     * @ingroup Image
5079     */
5080    EAPI void             elm_image_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
5081    /**
5082     * Get whether scaling is disabled on the object.
5083     *
5084     * @param obj The image object
5085     * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
5086     *
5087     * @see elm_image_no_scale_set()
5088     *
5089     * @ingroup Image
5090     */
5091    EAPI Eina_Bool        elm_image_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5092    /**
5093     * Set if the object is (up/down) resizable.
5094     *
5095     * @param obj The image object
5096     * @param scale_up A bool to set if the object is resizable up. Default is
5097     * @c EINA_TRUE.
5098     * @param scale_down A bool to set if the object is resizable down. Default
5099     * is @c EINA_TRUE.
5100     *
5101     * This function limits the image resize ability. If @p scale_up is set to
5102     * @c EINA_FALSE, the object can't have its height or width resized to a value
5103     * higher than the original image size. Same is valid for @p scale_down.
5104     *
5105     * @see elm_image_scale_get()
5106     *
5107     * @ingroup Image
5108     */
5109    EAPI void             elm_image_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
5110    /**
5111     * Get if the object is (up/down) resizable.
5112     *
5113     * @param obj The image object
5114     * @param scale_up A bool to set if the object is resizable up
5115     * @param scale_down A bool to set if the object is resizable down
5116     *
5117     * @see elm_image_scale_set()
5118     *
5119     * @ingroup Image
5120     */
5121    EAPI void             elm_image_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
5122    /**
5123     * Set if the image fill the entire object area when keeping the aspect ratio.
5124     *
5125     * @param obj The image object
5126     * @param fill_outside @c EINA_TRUE if the object is filled outside,
5127     * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5128     *
5129     * When the image should keep its aspect ratio even if resized to another
5130     * aspect ratio, there are two possibilities to resize it: keep the entire
5131     * image inside the limits of height and width of the object (@p fill_outside
5132     * is @c EINA_FALSE) or let the extra width or height go outside of the object,
5133     * and the image will fill the entire object (@p fill_outside is @c EINA_TRUE).
5134     *
5135     * @note This option will have no effect if
5136     * elm_image_aspect_ratio_retained_set() is set to @c EINA_FALSE.
5137     *
5138     * @see elm_image_fill_outside_get()
5139     * @see elm_image_aspect_ratio_retained_set()
5140     *
5141     * @ingroup Image
5142     */
5143    EAPI void             elm_image_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
5144    /**
5145     * Get if the object is filled outside
5146     *
5147     * @param obj The image object
5148     * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
5149     *
5150     * @see elm_image_fill_outside_set()
5151     *
5152     * @ingroup Image
5153     */
5154    EAPI Eina_Bool        elm_image_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5155    /**
5156     * Set the prescale size for the image
5157     *
5158     * @param obj The image object
5159     * @param size The prescale size. This value is used for both width and
5160     * height.
5161     *
5162     * This function sets a new size for pixmap representation of the given
5163     * image. It allows the image to be loaded already in the specified size,
5164     * reducing the memory usage and load time when loading a big image with load
5165     * size set to a smaller size.
5166     *
5167     * It's equivalent to the elm_bg_load_size_set() function for bg.
5168     *
5169     * @note this is just a hint, the real size of the pixmap may differ
5170     * depending on the type of image being loaded, being bigger than requested.
5171     *
5172     * @see elm_image_prescale_get()
5173     * @see elm_bg_load_size_set()
5174     *
5175     * @ingroup Image
5176     */
5177    EAPI void             elm_image_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
5178    /**
5179     * Get the prescale size for the image
5180     *
5181     * @param obj The image object
5182     * @return The prescale size
5183     *
5184     * @see elm_image_prescale_set()
5185     *
5186     * @ingroup Image
5187     */
5188    EAPI int              elm_image_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5189    /**
5190     * Set the image orientation.
5191     *
5192     * @param obj The image object
5193     * @param orient The image orientation
5194     * (one of #ELM_IMAGE_ORIENT_NONE, #ELM_IMAGE_ROTATE_90_CW,
5195     *  #ELM_IMAGE_ROTATE_180_CW, #ELM_IMAGE_ROTATE_90_CCW,
5196     *  #ELM_IMAGE_FLIP_HORIZONTAL, #ELM_IMAGE_FLIP_VERTICAL,
5197     *  #ELM_IMAGE_FLIP_TRANSPOSE, #ELM_IMAGE_FLIP_TRANSVERSE).
5198     *  Default is #ELM_IMAGE_ORIENT_NONE.
5199     *
5200     * This function allows to rotate or flip the given image.
5201     *
5202     * @see elm_image_orient_get()
5203     * @see @ref Elm_Image_Orient
5204     *
5205     * @ingroup Image
5206     */
5207    EAPI void             elm_image_orient_set(Evas_Object *obj, Elm_Image_Orient orient) EINA_ARG_NONNULL(1);
5208    /**
5209     * Get the image orientation.
5210     *
5211     * @param obj The image object
5212     * @return The image orientation
5213     * (one of #ELM_IMAGE_ORIENT_NONE, #ELM_IMAGE_ROTATE_90_CW,
5214     *  #ELM_IMAGE_ROTATE_180_CW, #ELM_IMAGE_ROTATE_90_CCW,
5215     *  #ELM_IMAGE_FLIP_HORIZONTAL, #ELM_IMAGE_FLIP_VERTICAL,
5216     *  #ELM_IMAGE_FLIP_TRANSPOSE, #ELM_IMAGE_FLIP_TRANSVERSE)
5217     *
5218     * @see elm_image_orient_set()
5219     * @see @ref Elm_Image_Orient
5220     *
5221     * @ingroup Image
5222     */
5223    EAPI Elm_Image_Orient elm_image_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5224    /**
5225     * Make the image 'editable'.
5226     *
5227     * @param obj Image object.
5228     * @param set Turn on or off editability. Default is @c EINA_FALSE.
5229     *
5230     * This means the image is a valid drag target for drag and drop, and can be
5231     * cut or pasted too.
5232     *
5233     * @ingroup Image
5234     */
5235    EAPI void             elm_image_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
5236    /**
5237     * Make the image 'editable'.
5238     *
5239     * @param obj Image object.
5240     * @return Editability.
5241     *
5242     * This means the image is a valid drag target for drag and drop, and can be
5243     * cut or pasted too.
5244     *
5245     * @ingroup Image
5246     */
5247    EAPI Eina_Bool        elm_image_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5248    /**
5249     * Get the basic Evas_Image object from this object (widget).
5250     *
5251     * @param obj The image object to get the inlined image from
5252     * @return The inlined image object, or NULL if none exists
5253     *
5254     * This function allows one to get the underlying @c Evas_Object of type
5255     * Image from this elementary widget. It can be useful to do things like get
5256     * the pixel data, save the image to a file, etc.
5257     *
5258     * @note Be careful to not manipulate it, as it is under control of
5259     * elementary.
5260     *
5261     * @ingroup Image
5262     */
5263    EAPI Evas_Object     *elm_image_object_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5264    /**
5265     * Set whether the original aspect ratio of the image should be kept on resize.
5266     *
5267     * @param obj The image object.
5268     * @param retained @c EINA_TRUE if the image should retain the aspect,
5269     * @c EINA_FALSE otherwise.
5270     *
5271     * The original aspect ratio (width / height) of the image is usually
5272     * distorted to match the object's size. Enabling this option will retain
5273     * this original aspect, and the way that the image is fit into the object's
5274     * area depends on the option set by elm_image_fill_outside_set().
5275     *
5276     * @see elm_image_aspect_ratio_retained_get()
5277     * @see elm_image_fill_outside_set()
5278     *
5279     * @ingroup Image
5280     */
5281    EAPI void             elm_image_aspect_ratio_retained_set(Evas_Object *obj, Eina_Bool retained) EINA_ARG_NONNULL(1);
5282    /**
5283     * Get if the object retains the original aspect ratio.
5284     *
5285     * @param obj The image object.
5286     * @return @c EINA_TRUE if the object keeps the original aspect, @c EINA_FALSE
5287     * otherwise.
5288     *
5289     * @ingroup Image
5290     */
5291    EAPI Eina_Bool        elm_image_aspect_ratio_retained_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5292
5293    /* smart callbacks called:
5294     * "clicked" - the user clicked the image
5295     */
5296
5297    /**
5298     * @}
5299     */
5300
5301    /* glview */
5302    typedef void (*Elm_GLView_Func_Cb)(Evas_Object *obj);
5303
5304    typedef enum _Elm_GLView_Mode
5305      {
5306         ELM_GLVIEW_ALPHA   = 1,
5307         ELM_GLVIEW_DEPTH   = 2,
5308         ELM_GLVIEW_STENCIL = 4
5309      } Elm_GLView_Mode;
5310
5311    /**
5312     * Defines a policy for the glview resizing.
5313     *
5314     * @note Default is ELM_GLVIEW_RESIZE_POLICY_RECREATE
5315     */
5316    typedef enum _Elm_GLView_Resize_Policy
5317      {
5318         ELM_GLVIEW_RESIZE_POLICY_RECREATE = 1,      /**< Resize the internal surface along with the image */
5319         ELM_GLVIEW_RESIZE_POLICY_SCALE    = 2       /**< Only reize the internal image and not the surface */
5320      } Elm_GLView_Resize_Policy;
5321
5322    typedef enum _Elm_GLView_Render_Policy
5323      {
5324         ELM_GLVIEW_RENDER_POLICY_ON_DEMAND = 1,     /**< Render only when there is a need for redrawing */
5325         ELM_GLVIEW_RENDER_POLICY_ALWAYS    = 2      /**< Render always even when it is not visible */
5326      } Elm_GLView_Render_Policy;
5327
5328    /**
5329     * @defgroup GLView
5330     *
5331     * A simple GLView widget that allows GL rendering.
5332     *
5333     * Signals that you can add callbacks for are:
5334     *
5335     * @{
5336     */
5337
5338    /**
5339     * Add a new glview to the parent
5340     *
5341     * @param parent The parent object
5342     * @return The new object or NULL if it cannot be created
5343     *
5344     * @ingroup GLView
5345     */
5346    EAPI Evas_Object     *elm_glview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5347
5348    /**
5349     * Sets the size of the glview
5350     *
5351     * @param obj The glview object
5352     * @param width width of the glview object
5353     * @param height height of the glview object
5354     *
5355     * @ingroup GLView
5356     */
5357    EAPI void             elm_glview_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
5358
5359    /**
5360     * Gets the size of the glview.
5361     *
5362     * @param obj The glview object
5363     * @param width width of the glview object
5364     * @param height height of the glview object
5365     *
5366     * Note that this function returns the actual image size of the
5367     * glview.  This means that when the scale policy is set to
5368     * ELM_GLVIEW_RESIZE_POLICY_SCALE, it'll return the non-scaled
5369     * size.
5370     *
5371     * @ingroup GLView
5372     */
5373    EAPI void             elm_glview_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
5374
5375    /**
5376     * Gets the gl api struct for gl rendering
5377     *
5378     * @param obj The glview object
5379     * @return The api object or NULL if it cannot be created
5380     *
5381     * @ingroup GLView
5382     */
5383    EAPI Evas_GL_API     *elm_glview_gl_api_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5384
5385    /**
5386     * Set the mode of the GLView. Supports Three simple modes.
5387     *
5388     * @param obj The glview object
5389     * @param mode The mode Options OR'ed enabling Alpha, Depth, Stencil.
5390     * @return True if set properly.
5391     *
5392     * @ingroup GLView
5393     */
5394    EAPI Eina_Bool        elm_glview_mode_set(Evas_Object *obj, Elm_GLView_Mode mode) EINA_ARG_NONNULL(1);
5395
5396    /**
5397     * Set the resize policy for the glview object.
5398     *
5399     * @param obj The glview object.
5400     * @param policy The scaling policy.
5401     *
5402     * By default, the resize policy is set to
5403     * ELM_GLVIEW_RESIZE_POLICY_RECREATE.  When resize is called it
5404     * destroys the previous surface and recreates the newly specified
5405     * size. If the policy is set to ELM_GLVIEW_RESIZE_POLICY_SCALE,
5406     * however, glview only scales the image object and not the underlying
5407     * GL Surface.
5408     *
5409     * @ingroup GLView
5410     */
5411    EAPI Eina_Bool        elm_glview_resize_policy_set(Evas_Object *obj, Elm_GLView_Resize_Policy policy) EINA_ARG_NONNULL(1);
5412
5413    /**
5414     * Set the render policy for the glview object.
5415     *
5416     * @param obj The glview object.
5417     * @param policy The render policy.
5418     *
5419     * By default, the render policy is set to
5420     * ELM_GLVIEW_RENDER_POLICY_ON_DEMAND.  This policy is set such
5421     * that during the render loop, glview is only redrawn if it needs
5422     * to be redrawn. (i.e. When it is visible) If the policy is set to
5423     * ELM_GLVIEWW_RENDER_POLICY_ALWAYS, it redraws regardless of
5424     * whether it is visible/need redrawing or not.
5425     *
5426     * @ingroup GLView
5427     */
5428    EAPI Eina_Bool        elm_glview_render_policy_set(Evas_Object *obj, Elm_GLView_Render_Policy policy) EINA_ARG_NONNULL(1);
5429
5430    /**
5431     * Set the init function that runs once in the main loop.
5432     *
5433     * @param obj The glview object.
5434     * @param func The init function to be registered.
5435     *
5436     * The registered init function gets called once during the render loop.
5437     *
5438     * @ingroup GLView
5439     */
5440    EAPI void             elm_glview_init_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5441
5442    /**
5443     * Set the render function that runs in the main loop.
5444     *
5445     * @param obj The glview object.
5446     * @param func The delete function to be registered.
5447     *
5448     * The registered del function gets called when GLView object is deleted.
5449     *
5450     * @ingroup GLView
5451     */
5452    EAPI void             elm_glview_del_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5453
5454    /**
5455     * Set the resize function that gets called when resize happens.
5456     *
5457     * @param obj The glview object.
5458     * @param func The resize function to be registered.
5459     *
5460     * @ingroup GLView
5461     */
5462    EAPI void             elm_glview_resize_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5463
5464    /**
5465     * Set the render function that runs in the main loop.
5466     *
5467     * @param obj The glview object.
5468     * @param func The render function to be registered.
5469     *
5470     * @ingroup GLView
5471     */
5472    EAPI void             elm_glview_render_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5473
5474    /**
5475     * Notifies that there has been changes in the GLView.
5476     *
5477     * @param obj The glview object.
5478     *
5479     * @ingroup GLView
5480     */
5481    EAPI void             elm_glview_changed_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
5482
5483    /**
5484     * @}
5485     */
5486
5487    /* box */
5488    /**
5489     * @defgroup Box Box
5490     *
5491     * @image html img/widget/box/preview-00.png
5492     * @image latex img/widget/box/preview-00.eps width=\textwidth
5493     *
5494     * @image html img/box.png
5495     * @image latex img/box.eps width=\textwidth
5496     *
5497     * A box arranges objects in a linear fashion, governed by a layout function
5498     * that defines the details of this arrangement.
5499     *
5500     * By default, the box will use an internal function to set the layout to
5501     * a single row, either vertical or horizontal. This layout is affected
5502     * by a number of parameters, such as the homogeneous flag set by
5503     * elm_box_homogeneous_set(), the values given by elm_box_padding_set() and
5504     * elm_box_align_set() and the hints set to each object in the box.
5505     *
5506     * For this default layout, it's possible to change the orientation with
5507     * elm_box_horizontal_set(). The box will start in the vertical orientation,
5508     * placing its elements ordered from top to bottom. When horizontal is set,
5509     * the order will go from left to right. If the box is set to be
5510     * homogeneous, every object in it will be assigned the same space, that
5511     * of the largest object. Padding can be used to set some spacing between
5512     * the cell given to each object. The alignment of the box, set with
5513     * elm_box_align_set(), determines how the bounding box of all the elements
5514     * will be placed within the space given to the box widget itself.
5515     *
5516     * The size hints of each object also affect how they are placed and sized
5517     * within the box. evas_object_size_hint_min_set() will give the minimum
5518     * size the object can have, and the box will use it as the basis for all
5519     * latter calculations. Elementary widgets set their own minimum size as
5520     * needed, so there's rarely any need to use it manually.
5521     *
5522     * evas_object_size_hint_weight_set(), when not in homogeneous mode, is
5523     * used to tell whether the object will be allocated the minimum size it
5524     * needs or if the space given to it should be expanded. It's important
5525     * to realize that expanding the size given to the object is not the same
5526     * thing as resizing the object. It could very well end being a small
5527     * widget floating in a much larger empty space. If not set, the weight
5528     * for objects will normally be 0.0 for both axis, meaning the widget will
5529     * not be expanded. To take as much space possible, set the weight to
5530     * EVAS_HINT_EXPAND (defined to 1.0) for the desired axis to expand.
5531     *
5532     * Besides how much space each object is allocated, it's possible to control
5533     * how the widget will be placed within that space using
5534     * evas_object_size_hint_align_set(). By default, this value will be 0.5
5535     * for both axis, meaning the object will be centered, but any value from
5536     * 0.0 (left or top, for the @c x and @c y axis, respectively) to 1.0
5537     * (right or bottom) can be used. The special value EVAS_HINT_FILL, which
5538     * is -1.0, means the object will be resized to fill the entire space it
5539     * was allocated.
5540     *
5541     * In addition, customized functions to define the layout can be set, which
5542     * allow the application developer to organize the objects within the box
5543     * in any number of ways.
5544     *
5545     * The special elm_box_layout_transition() function can be used
5546     * to switch from one layout to another, animating the motion of the
5547     * children of the box.
5548     *
5549     * @note Objects should not be added to box objects using _add() calls.
5550     *
5551     * Some examples on how to use boxes follow:
5552     * @li @ref box_example_01
5553     * @li @ref box_example_02
5554     *
5555     * @{
5556     */
5557    /**
5558     * @typedef Elm_Box_Transition
5559     *
5560     * Opaque handler containing the parameters to perform an animated
5561     * transition of the layout the box uses.
5562     *
5563     * @see elm_box_transition_new()
5564     * @see elm_box_layout_set()
5565     * @see elm_box_layout_transition()
5566     */
5567    typedef struct _Elm_Box_Transition Elm_Box_Transition;
5568
5569    /**
5570     * Add a new box to the parent
5571     *
5572     * By default, the box will be in vertical mode and non-homogeneous.
5573     *
5574     * @param parent The parent object
5575     * @return The new object or NULL if it cannot be created
5576     */
5577    EAPI Evas_Object        *elm_box_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5578    /**
5579     * Set the horizontal orientation
5580     *
5581     * By default, box object arranges their contents vertically from top to
5582     * bottom.
5583     * By calling this function with @p horizontal as EINA_TRUE, the box will
5584     * become horizontal, arranging contents from left to right.
5585     *
5586     * @note This flag is ignored if a custom layout function is set.
5587     *
5588     * @param obj The box object
5589     * @param horizontal The horizontal flag (EINA_TRUE = horizontal,
5590     * EINA_FALSE = vertical)
5591     */
5592    EAPI void                elm_box_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
5593    /**
5594     * Get the horizontal orientation
5595     *
5596     * @param obj The box object
5597     * @return EINA_TRUE if the box is set to horizontal mode, EINA_FALSE otherwise
5598     */
5599    EAPI Eina_Bool           elm_box_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5600    /**
5601     * Set the box to arrange its children homogeneously
5602     *
5603     * If enabled, homogeneous layout makes all items the same size, according
5604     * to the size of the largest of its children.
5605     *
5606     * @note This flag is ignored if a custom layout function is set.
5607     *
5608     * @param obj The box object
5609     * @param homogeneous The homogeneous flag
5610     */
5611    EAPI void                elm_box_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
5612    /**
5613     * Get whether the box is using homogeneous mode or not
5614     *
5615     * @param obj The box object
5616     * @return EINA_TRUE if it's homogeneous, EINA_FALSE otherwise
5617     */
5618    EAPI Eina_Bool           elm_box_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5619    EINA_DEPRECATED EAPI void elm_box_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
5620    EINA_DEPRECATED EAPI Eina_Bool elm_box_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5621    /**
5622     * Add an object to the beginning of the pack list
5623     *
5624     * Pack @p subobj into the box @p obj, placing it first in the list of
5625     * children objects. The actual position the object will get on screen
5626     * depends on the layout used. If no custom layout is set, it will be at
5627     * the top or left, depending if the box is vertical or horizontal,
5628     * respectively.
5629     *
5630     * @param obj The box object
5631     * @param subobj The object to add to the box
5632     *
5633     * @see elm_box_pack_end()
5634     * @see elm_box_pack_before()
5635     * @see elm_box_pack_after()
5636     * @see elm_box_unpack()
5637     * @see elm_box_unpack_all()
5638     * @see elm_box_clear()
5639     */
5640    EAPI void                elm_box_pack_start(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5641    /**
5642     * Add an object at the end of the pack list
5643     *
5644     * Pack @p subobj into the box @p obj, placing it last in the list of
5645     * children objects. The actual position the object will get on screen
5646     * depends on the layout used. If no custom layout is set, it will be at
5647     * the bottom or right, depending if the box is vertical or horizontal,
5648     * respectively.
5649     *
5650     * @param obj The box object
5651     * @param subobj The object to add to the box
5652     *
5653     * @see elm_box_pack_start()
5654     * @see elm_box_pack_before()
5655     * @see elm_box_pack_after()
5656     * @see elm_box_unpack()
5657     * @see elm_box_unpack_all()
5658     * @see elm_box_clear()
5659     */
5660    EAPI void                elm_box_pack_end(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5661    /**
5662     * Adds an object to the box before the indicated object
5663     *
5664     * This will add the @p subobj to the box indicated before the object
5665     * indicated with @p before. If @p before is not already in the box, results
5666     * are undefined. Before means either to the left of the indicated object or
5667     * above it depending on orientation.
5668     *
5669     * @param obj The box object
5670     * @param subobj The object to add to the box
5671     * @param before The object before which to add it
5672     *
5673     * @see elm_box_pack_start()
5674     * @see elm_box_pack_end()
5675     * @see elm_box_pack_after()
5676     * @see elm_box_unpack()
5677     * @see elm_box_unpack_all()
5678     * @see elm_box_clear()
5679     */
5680    EAPI void                elm_box_pack_before(Evas_Object *obj, Evas_Object *subobj, Evas_Object *before) EINA_ARG_NONNULL(1);
5681    /**
5682     * Adds an object to the box after the indicated object
5683     *
5684     * This will add the @p subobj to the box indicated after the object
5685     * indicated with @p after. If @p after is not already in the box, results
5686     * are undefined. After means either to the right of the indicated object or
5687     * below it depending on orientation.
5688     *
5689     * @param obj The box object
5690     * @param subobj The object to add to the box
5691     * @param after The object after which to add it
5692     *
5693     * @see elm_box_pack_start()
5694     * @see elm_box_pack_end()
5695     * @see elm_box_pack_before()
5696     * @see elm_box_unpack()
5697     * @see elm_box_unpack_all()
5698     * @see elm_box_clear()
5699     */
5700    EAPI void                elm_box_pack_after(Evas_Object *obj, Evas_Object *subobj, Evas_Object *after) EINA_ARG_NONNULL(1);
5701    /**
5702     * Clear the box of all children
5703     *
5704     * Remove all the elements contained by the box, deleting the respective
5705     * objects.
5706     *
5707     * @param obj The box object
5708     *
5709     * @see elm_box_unpack()
5710     * @see elm_box_unpack_all()
5711     */
5712    EAPI void                elm_box_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
5713    /**
5714     * Unpack a box item
5715     *
5716     * Remove the object given by @p subobj from the box @p obj without
5717     * deleting it.
5718     *
5719     * @param obj The box object
5720     *
5721     * @see elm_box_unpack_all()
5722     * @see elm_box_clear()
5723     */
5724    EAPI void                elm_box_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
5725    /**
5726     * Remove all items from the box, without deleting them
5727     *
5728     * Clear the box from all children, but don't delete the respective objects.
5729     * If no other references of the box children exist, the objects will never
5730     * be deleted, and thus the application will leak the memory. Make sure
5731     * when using this function that you hold a reference to all the objects
5732     * in the box @p obj.
5733     *
5734     * @param obj The box object
5735     *
5736     * @see elm_box_clear()
5737     * @see elm_box_unpack()
5738     */
5739    EAPI void                elm_box_unpack_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
5740    /**
5741     * Retrieve a list of the objects packed into the box
5742     *
5743     * Returns a new @c Eina_List with a pointer to @c Evas_Object in its nodes.
5744     * The order of the list corresponds to the packing order the box uses.
5745     *
5746     * You must free this list with eina_list_free() once you are done with it.
5747     *
5748     * @param obj The box object
5749     */
5750    EAPI const Eina_List    *elm_box_children_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5751    /**
5752     * Set the space (padding) between the box's elements.
5753     *
5754     * Extra space in pixels that will be added between a box child and its
5755     * neighbors after its containing cell has been calculated. This padding
5756     * is set for all elements in the box, besides any possible padding that
5757     * individual elements may have through their size hints.
5758     *
5759     * @param obj The box object
5760     * @param horizontal The horizontal space between elements
5761     * @param vertical The vertical space between elements
5762     */
5763    EAPI void                elm_box_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
5764    /**
5765     * Get the space (padding) between the box's elements.
5766     *
5767     * @param obj The box object
5768     * @param horizontal The horizontal space between elements
5769     * @param vertical The vertical space between elements
5770     *
5771     * @see elm_box_padding_set()
5772     */
5773    EAPI void                elm_box_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
5774    /**
5775     * Set the alignment of the whole bouding box of contents.
5776     *
5777     * Sets how the bounding box containing all the elements of the box, after
5778     * their sizes and position has been calculated, will be aligned within
5779     * the space given for the whole box widget.
5780     *
5781     * @param obj The box object
5782     * @param horizontal The horizontal alignment of elements
5783     * @param vertical The vertical alignment of elements
5784     */
5785    EAPI void                elm_box_align_set(Evas_Object *obj, double horizontal, double vertical) EINA_ARG_NONNULL(1);
5786    /**
5787     * Get the alignment of the whole bouding box of contents.
5788     *
5789     * @param obj The box object
5790     * @param horizontal The horizontal alignment of elements
5791     * @param vertical The vertical alignment of elements
5792     *
5793     * @see elm_box_align_set()
5794     */
5795    EAPI void                elm_box_align_get(const Evas_Object *obj, double *horizontal, double *vertical) EINA_ARG_NONNULL(1);
5796
5797    /**
5798     * Set the layout defining function to be used by the box
5799     *
5800     * Whenever anything changes that requires the box in @p obj to recalculate
5801     * the size and position of its elements, the function @p cb will be called
5802     * to determine what the layout of the children will be.
5803     *
5804     * Once a custom function is set, everything about the children layout
5805     * is defined by it. The flags set by elm_box_horizontal_set() and
5806     * elm_box_homogeneous_set() no longer have any meaning, and the values
5807     * given by elm_box_padding_set() and elm_box_align_set() are up to this
5808     * layout function to decide if they are used and how. These last two
5809     * will be found in the @c priv parameter, of type @c Evas_Object_Box_Data,
5810     * passed to @p cb. The @c Evas_Object the function receives is not the
5811     * Elementary widget, but the internal Evas Box it uses, so none of the
5812     * functions described here can be used on it.
5813     *
5814     * Any of the layout functions in @c Evas can be used here, as well as the
5815     * special elm_box_layout_transition().
5816     *
5817     * The final @p data argument received by @p cb is the same @p data passed
5818     * here, and the @p free_data function will be called to free it
5819     * whenever the box is destroyed or another layout function is set.
5820     *
5821     * Setting @p cb to NULL will revert back to the default layout function.
5822     *
5823     * @param obj The box object
5824     * @param cb The callback function used for layout
5825     * @param data Data that will be passed to layout function
5826     * @param free_data Function called to free @p data
5827     *
5828     * @see elm_box_layout_transition()
5829     */
5830    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);
5831    /**
5832     * Special layout function that animates the transition from one layout to another
5833     *
5834     * Normally, when switching the layout function for a box, this will be
5835     * reflected immediately on screen on the next render, but it's also
5836     * possible to do this through an animated transition.
5837     *
5838     * This is done by creating an ::Elm_Box_Transition and setting the box
5839     * layout to this function.
5840     *
5841     * For example:
5842     * @code
5843     * Elm_Box_Transition *t = elm_box_transition_new(1.0,
5844     *                            evas_object_box_layout_vertical, // start
5845     *                            NULL, // data for initial layout
5846     *                            NULL, // free function for initial data
5847     *                            evas_object_box_layout_horizontal, // end
5848     *                            NULL, // data for final layout
5849     *                            NULL, // free function for final data
5850     *                            anim_end, // will be called when animation ends
5851     *                            NULL); // data for anim_end function\
5852     * elm_box_layout_set(box, elm_box_layout_transition, t,
5853     *                    elm_box_transition_free);
5854     * @endcode
5855     *
5856     * @note This function can only be used with elm_box_layout_set(). Calling
5857     * it directly will not have the expected results.
5858     *
5859     * @see elm_box_transition_new
5860     * @see elm_box_transition_free
5861     * @see elm_box_layout_set
5862     */
5863    EAPI void                elm_box_layout_transition(Evas_Object *obj, Evas_Object_Box_Data *priv, void *data);
5864    /**
5865     * Create a new ::Elm_Box_Transition to animate the switch of layouts
5866     *
5867     * If you want to animate the change from one layout to another, you need
5868     * to set the layout function of the box to elm_box_layout_transition(),
5869     * passing as user data to it an instance of ::Elm_Box_Transition with the
5870     * necessary information to perform this animation. The free function to
5871     * set for the layout is elm_box_transition_free().
5872     *
5873     * The parameters to create an ::Elm_Box_Transition sum up to how long
5874     * will it be, in seconds, a layout function to describe the initial point,
5875     * another for the final position of the children and one function to be
5876     * called when the whole animation ends. This last function is useful to
5877     * set the definitive layout for the box, usually the same as the end
5878     * layout for the animation, but could be used to start another transition.
5879     *
5880     * @param start_layout The layout function that will be used to start the animation
5881     * @param start_layout_data The data to be passed the @p start_layout function
5882     * @param start_layout_free_data Function to free @p start_layout_data
5883     * @param end_layout The layout function that will be used to end the animation
5884     * @param end_layout_free_data The data to be passed the @p end_layout function
5885     * @param end_layout_free_data Function to free @p end_layout_data
5886     * @param transition_end_cb Callback function called when animation ends
5887     * @param transition_end_data Data to be passed to @p transition_end_cb
5888     * @return An instance of ::Elm_Box_Transition
5889     *
5890     * @see elm_box_transition_new
5891     * @see elm_box_layout_transition
5892     */
5893    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);
5894    /**
5895     * Free a Elm_Box_Transition instance created with elm_box_transition_new().
5896     *
5897     * This function is mostly useful as the @c free_data parameter in
5898     * elm_box_layout_set() when elm_box_layout_transition().
5899     *
5900     * @param data The Elm_Box_Transition instance to be freed.
5901     *
5902     * @see elm_box_transition_new
5903     * @see elm_box_layout_transition
5904     */
5905    EAPI void                elm_box_transition_free(void *data);
5906    /**
5907     * @}
5908     */
5909
5910    /* button */
5911    /**
5912     * @defgroup Button Button
5913     *
5914     * @image html img/widget/button/preview-00.png
5915     * @image latex img/widget/button/preview-00.eps
5916     * @image html img/widget/button/preview-01.png
5917     * @image latex img/widget/button/preview-01.eps
5918     * @image html img/widget/button/preview-02.png
5919     * @image latex img/widget/button/preview-02.eps
5920     *
5921     * This is a push-button. Press it and run some function. It can contain
5922     * a simple label and icon object and it also has an autorepeat feature.
5923     *
5924     * This widgets emits the following signals:
5925     * @li "clicked": the user clicked the button (press/release).
5926     * @li "repeated": the user pressed the button without releasing it.
5927     * @li "pressed": button was pressed.
5928     * @li "unpressed": button was released after being pressed.
5929     * In all three cases, the @c event parameter of the callback will be
5930     * @c NULL.
5931     *
5932     * Also, defined in the default theme, the button has the following styles
5933     * available:
5934     * @li default: a normal button.
5935     * @li anchor: Like default, but the button fades away when the mouse is not
5936     * over it, leaving only the text or icon.
5937     * @li hoversel_vertical: Internally used by @ref Hoversel to give a
5938     * continuous look across its options.
5939     * @li hoversel_vertical_entry: Another internal for @ref Hoversel.
5940     *
5941     * Follow through a complete example @ref button_example_01 "here".
5942     * @{
5943     */
5944    /**
5945     * Add a new button to the parent's canvas
5946     *
5947     * @param parent The parent object
5948     * @return The new object or NULL if it cannot be created
5949     */
5950    EAPI Evas_Object *elm_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5951    /**
5952     * Set the label used in the button
5953     *
5954     * The passed @p label can be NULL to clean any existing text in it and
5955     * leave the button as an icon only object.
5956     *
5957     * @param obj The button object
5958     * @param label The text will be written on the button
5959     * @deprecated use elm_object_text_set() instead.
5960     */
5961    EINA_DEPRECATED EAPI void         elm_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
5962    /**
5963     * Get the label set for the button
5964     *
5965     * The string returned is an internal pointer and should not be freed or
5966     * altered. It will also become invalid when the button is destroyed.
5967     * The string returned, if not NULL, is a stringshare, so if you need to
5968     * keep it around even after the button is destroyed, you can use
5969     * eina_stringshare_ref().
5970     *
5971     * @param obj The button object
5972     * @return The text set to the label, or NULL if nothing is set
5973     * @deprecated use elm_object_text_set() instead.
5974     */
5975    EINA_DEPRECATED EAPI const char  *elm_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5976    /**
5977     * Set the icon used for the button
5978     *
5979     * Setting a new icon will delete any other that was previously set, making
5980     * any reference to them invalid. If you need to maintain the previous
5981     * object alive, unset it first with elm_button_icon_unset().
5982     *
5983     * @param obj The button object
5984     * @param icon The icon object for the button
5985     */
5986    EAPI void         elm_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
5987    /**
5988     * Get the icon used for the button
5989     *
5990     * Return the icon object which is set for this widget. If the button is
5991     * destroyed or another icon is set, the returned object will be deleted
5992     * and any reference to it will be invalid.
5993     *
5994     * @param obj The button object
5995     * @return The icon object that is being used
5996     *
5997     * @see elm_button_icon_unset()
5998     */
5999    EAPI Evas_Object *elm_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6000    /**
6001     * Remove the icon set without deleting it and return the object
6002     *
6003     * This function drops the reference the button holds of the icon object
6004     * and returns this last object. It is used in case you want to remove any
6005     * icon, or set another one, without deleting the actual object. The button
6006     * will be left without an icon set.
6007     *
6008     * @param obj The button object
6009     * @return The icon object that was being used
6010     */
6011    EAPI Evas_Object *elm_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6012    /**
6013     * Turn on/off the autorepeat event generated when the button is kept pressed
6014     *
6015     * When off, no autorepeat is performed and buttons emit a normal @c clicked
6016     * signal when they are clicked.
6017     *
6018     * When on, keeping a button pressed will continuously emit a @c repeated
6019     * signal until the button is released. The time it takes until it starts
6020     * emitting the signal is given by
6021     * elm_button_autorepeat_initial_timeout_set(), and the time between each
6022     * new emission by elm_button_autorepeat_gap_timeout_set().
6023     *
6024     * @param obj The button object
6025     * @param on  A bool to turn on/off the event
6026     */
6027    EAPI void         elm_button_autorepeat_set(Evas_Object *obj, Eina_Bool on) EINA_ARG_NONNULL(1);
6028    /**
6029     * Get whether the autorepeat feature is enabled
6030     *
6031     * @param obj The button object
6032     * @return EINA_TRUE if autorepeat is on, EINA_FALSE otherwise
6033     *
6034     * @see elm_button_autorepeat_set()
6035     */
6036    EAPI Eina_Bool    elm_button_autorepeat_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6037    /**
6038     * Set the initial timeout before the autorepeat event is generated
6039     *
6040     * Sets the timeout, in seconds, since the button is pressed until the
6041     * first @c repeated signal is emitted. If @p t is 0.0 or less, there
6042     * won't be any delay and the even will be fired the moment the button is
6043     * pressed.
6044     *
6045     * @param obj The button object
6046     * @param t   Timeout in seconds
6047     *
6048     * @see elm_button_autorepeat_set()
6049     * @see elm_button_autorepeat_gap_timeout_set()
6050     */
6051    EAPI void         elm_button_autorepeat_initial_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
6052    /**
6053     * Get the initial timeout before the autorepeat event is generated
6054     *
6055     * @param obj The button object
6056     * @return Timeout in seconds
6057     *
6058     * @see elm_button_autorepeat_initial_timeout_set()
6059     */
6060    EAPI double       elm_button_autorepeat_initial_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6061    /**
6062     * Set the interval between each generated autorepeat event
6063     *
6064     * After the first @c repeated event is fired, all subsequent ones will
6065     * follow after a delay of @p t seconds for each.
6066     *
6067     * @param obj The button object
6068     * @param t   Interval in seconds
6069     *
6070     * @see elm_button_autorepeat_initial_timeout_set()
6071     */
6072    EAPI void         elm_button_autorepeat_gap_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
6073    /**
6074     * Get the interval between each generated autorepeat event
6075     *
6076     * @param obj The button object
6077     * @return Interval in seconds
6078     */
6079    EAPI double       elm_button_autorepeat_gap_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6080    /**
6081     * @}
6082     */
6083
6084    /**
6085     * @defgroup File_Selector_Button File Selector Button
6086     *
6087     * @image html img/widget/fileselector_button/preview-00.png
6088     * @image latex img/widget/fileselector_button/preview-00.eps
6089     * @image html img/widget/fileselector_button/preview-01.png
6090     * @image latex img/widget/fileselector_button/preview-01.eps
6091     * @image html img/widget/fileselector_button/preview-02.png
6092     * @image latex img/widget/fileselector_button/preview-02.eps
6093     *
6094     * This is a button that, when clicked, creates an Elementary
6095     * window (or inner window) <b> with a @ref Fileselector "file
6096     * selector widget" within</b>. When a file is chosen, the (inner)
6097     * window is closed and the button emits a signal having the
6098     * selected file as it's @c event_info.
6099     *
6100     * This widget encapsulates operations on its internal file
6101     * selector on its own API. There is less control over its file
6102     * selector than that one would have instatiating one directly.
6103     *
6104     * The following styles are available for this button:
6105     * @li @c "default"
6106     * @li @c "anchor"
6107     * @li @c "hoversel_vertical"
6108     * @li @c "hoversel_vertical_entry"
6109     *
6110     * Smart callbacks one can register to:
6111     * - @c "file,chosen" - the user has selected a path, whose string
6112     *   pointer comes as the @c event_info data (a stringshared
6113     *   string)
6114     *
6115     * Here is an example on its usage:
6116     * @li @ref fileselector_button_example
6117     *
6118     * @see @ref File_Selector_Entry for a similar widget.
6119     * @{
6120     */
6121
6122    /**
6123     * Add a new file selector button widget to the given parent
6124     * Elementary (container) object
6125     *
6126     * @param parent The parent object
6127     * @return a new file selector button widget handle or @c NULL, on
6128     * errors
6129     */
6130    EAPI Evas_Object *elm_fileselector_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6131
6132    /**
6133     * Set the label for a given file selector button widget
6134     *
6135     * @param obj The file selector button widget
6136     * @param label The text label to be displayed on @p obj
6137     *
6138     * @deprecated use elm_object_text_set() instead.
6139     */
6140    EINA_DEPRECATED EAPI void         elm_fileselector_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6141
6142    /**
6143     * Get the label set for a given file selector button widget
6144     *
6145     * @param obj The file selector button widget
6146     * @return The button label
6147     *
6148     * @deprecated use elm_object_text_set() instead.
6149     */
6150    EINA_DEPRECATED EAPI const char  *elm_fileselector_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6151
6152    /**
6153     * Set the icon on a given file selector button widget
6154     *
6155     * @param obj The file selector button widget
6156     * @param icon The icon object for the button
6157     *
6158     * Once the icon object is set, a previously set one will be
6159     * deleted. If you want to keep the latter, use the
6160     * elm_fileselector_button_icon_unset() function.
6161     *
6162     * @see elm_fileselector_button_icon_get()
6163     */
6164    EAPI void         elm_fileselector_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6165
6166    /**
6167     * Get the icon set for a given file selector button widget
6168     *
6169     * @param obj The file selector button widget
6170     * @return The icon object currently set on @p obj or @c NULL, if
6171     * none is
6172     *
6173     * @see elm_fileselector_button_icon_set()
6174     */
6175    EAPI Evas_Object *elm_fileselector_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6176
6177    /**
6178     * Unset the icon used in a given file selector button widget
6179     *
6180     * @param obj The file selector button widget
6181     * @return The icon object that was being used on @p obj or @c
6182     * NULL, on errors
6183     *
6184     * Unparent and return the icon object which was set for this
6185     * widget.
6186     *
6187     * @see elm_fileselector_button_icon_set()
6188     */
6189    EAPI Evas_Object *elm_fileselector_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6190
6191    /**
6192     * Set the title for a given file selector button widget's window
6193     *
6194     * @param obj The file selector button widget
6195     * @param title The title string
6196     *
6197     * This will change the window's title, when the file selector pops
6198     * out after a click on the button. Those windows have the default
6199     * (unlocalized) value of @c "Select a file" as titles.
6200     *
6201     * @note It will only take any effect if the file selector
6202     * button widget is @b not under "inwin mode".
6203     *
6204     * @see elm_fileselector_button_window_title_get()
6205     */
6206    EAPI void         elm_fileselector_button_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6207
6208    /**
6209     * Get the title set for a given file selector button widget's
6210     * window
6211     *
6212     * @param obj The file selector button widget
6213     * @return Title of the file selector button's window
6214     *
6215     * @see elm_fileselector_button_window_title_get() for more details
6216     */
6217    EAPI const char  *elm_fileselector_button_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6218
6219    /**
6220     * Set the size of a given file selector button widget's window,
6221     * holding the file selector itself.
6222     *
6223     * @param obj The file selector button widget
6224     * @param width The window's width
6225     * @param height The window's height
6226     *
6227     * @note it will only take any effect if the file selector button
6228     * widget is @b not under "inwin mode". The default size for the
6229     * window (when applicable) is 400x400 pixels.
6230     *
6231     * @see elm_fileselector_button_window_size_get()
6232     */
6233    EAPI void         elm_fileselector_button_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6234
6235    /**
6236     * Get the size of a given file selector button widget's window,
6237     * holding the file selector itself.
6238     *
6239     * @param obj The file selector button widget
6240     * @param width Pointer into which to store the width value
6241     * @param height Pointer into which to store the height value
6242     *
6243     * @note Use @c NULL pointers on the size values you're not
6244     * interested in: they'll be ignored by the function.
6245     *
6246     * @see elm_fileselector_button_window_size_set(), for more details
6247     */
6248    EAPI void         elm_fileselector_button_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6249
6250    /**
6251     * Set the initial file system path for a given file selector
6252     * button widget
6253     *
6254     * @param obj The file selector button widget
6255     * @param path The path string
6256     *
6257     * It must be a <b>directory</b> path, which will have the contents
6258     * displayed initially in the file selector's view, when invoked
6259     * from @p obj. The default initial path is the @c "HOME"
6260     * environment variable's value.
6261     *
6262     * @see elm_fileselector_button_path_get()
6263     */
6264    EAPI void         elm_fileselector_button_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6265
6266    /**
6267     * Get the initial file system path set for a given file selector
6268     * button widget
6269     *
6270     * @param obj The file selector button widget
6271     * @return path The path string
6272     *
6273     * @see elm_fileselector_button_path_set() for more details
6274     */
6275    EAPI const char  *elm_fileselector_button_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6276
6277    /**
6278     * Enable/disable a tree view in the given file selector button
6279     * widget's internal file selector
6280     *
6281     * @param obj The file selector button widget
6282     * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
6283     * disable
6284     *
6285     * This has the same effect as elm_fileselector_expandable_set(),
6286     * but now applied to a file selector button's internal file
6287     * selector.
6288     *
6289     * @note There's no way to put a file selector button's internal
6290     * file selector in "grid mode", as one may do with "pure" file
6291     * selectors.
6292     *
6293     * @see elm_fileselector_expandable_get()
6294     */
6295    EAPI void         elm_fileselector_button_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6296
6297    /**
6298     * Get whether tree view is enabled for the given file selector
6299     * button widget's internal file selector
6300     *
6301     * @param obj The file selector button widget
6302     * @return @c EINA_TRUE if @p obj widget's internal file selector
6303     * is in tree view, @c EINA_FALSE otherwise (and or errors)
6304     *
6305     * @see elm_fileselector_expandable_set() for more details
6306     */
6307    EAPI Eina_Bool    elm_fileselector_button_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6308
6309    /**
6310     * Set whether a given file selector button widget's internal file
6311     * selector is to display folders only or the directory contents,
6312     * as well.
6313     *
6314     * @param obj The file selector button widget
6315     * @param only @c EINA_TRUE to make @p obj widget's internal file
6316     * selector only display directories, @c EINA_FALSE to make files
6317     * to be displayed in it too
6318     *
6319     * This has the same effect as elm_fileselector_folder_only_set(),
6320     * but now applied to a file selector button's internal file
6321     * selector.
6322     *
6323     * @see elm_fileselector_folder_only_get()
6324     */
6325    EAPI void         elm_fileselector_button_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6326
6327    /**
6328     * Get whether a given file selector button widget's internal file
6329     * selector is displaying folders only or the directory contents,
6330     * as well.
6331     *
6332     * @param obj The file selector button widget
6333     * @return @c EINA_TRUE if @p obj widget's internal file
6334     * selector is only displaying directories, @c EINA_FALSE if files
6335     * are being displayed in it too (and on errors)
6336     *
6337     * @see elm_fileselector_button_folder_only_set() for more details
6338     */
6339    EAPI Eina_Bool    elm_fileselector_button_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6340
6341    /**
6342     * Enable/disable the file name entry box where the user can type
6343     * in a name for a file, in a given file selector button widget's
6344     * internal file selector.
6345     *
6346     * @param obj The file selector button widget
6347     * @param is_save @c EINA_TRUE to make @p obj widget's internal
6348     * file selector a "saving dialog", @c EINA_FALSE otherwise
6349     *
6350     * This has the same effect as elm_fileselector_is_save_set(),
6351     * but now applied to a file selector button's internal file
6352     * selector.
6353     *
6354     * @see elm_fileselector_is_save_get()
6355     */
6356    EAPI void         elm_fileselector_button_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6357
6358    /**
6359     * Get whether the given file selector button widget's internal
6360     * file selector is in "saving dialog" mode
6361     *
6362     * @param obj The file selector button widget
6363     * @return @c EINA_TRUE, if @p obj widget's internal file selector
6364     * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
6365     * errors)
6366     *
6367     * @see elm_fileselector_button_is_save_set() for more details
6368     */
6369    EAPI Eina_Bool    elm_fileselector_button_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6370
6371    /**
6372     * Set whether a given file selector button widget's internal file
6373     * selector will raise an Elementary "inner window", instead of a
6374     * dedicated Elementary window. By default, it won't.
6375     *
6376     * @param obj The file selector button widget
6377     * @param value @c EINA_TRUE to make it use an inner window, @c
6378     * EINA_TRUE to make it use a dedicated window
6379     *
6380     * @see elm_win_inwin_add() for more information on inner windows
6381     * @see elm_fileselector_button_inwin_mode_get()
6382     */
6383    EAPI void         elm_fileselector_button_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6384
6385    /**
6386     * Get whether a given file selector button widget's internal file
6387     * selector will raise an Elementary "inner window", instead of a
6388     * dedicated Elementary window.
6389     *
6390     * @param obj The file selector button widget
6391     * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
6392     * if it will use a dedicated window
6393     *
6394     * @see elm_fileselector_button_inwin_mode_set() for more details
6395     */
6396    EAPI Eina_Bool    elm_fileselector_button_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6397
6398    /**
6399     * @}
6400     */
6401
6402     /**
6403     * @defgroup File_Selector_Entry File Selector Entry
6404     *
6405     * @image html img/widget/fileselector_entry/preview-00.png
6406     * @image latex img/widget/fileselector_entry/preview-00.eps
6407     *
6408     * This is an entry made to be filled with or display a <b>file
6409     * system path string</b>. Besides the entry itself, the widget has
6410     * a @ref File_Selector_Button "file selector button" on its side,
6411     * which will raise an internal @ref Fileselector "file selector widget",
6412     * when clicked, for path selection aided by file system
6413     * navigation.
6414     *
6415     * This file selector may appear in an Elementary window or in an
6416     * inner window. When a file is chosen from it, the (inner) window
6417     * is closed and the selected file's path string is exposed both as
6418     * an smart event and as the new text on the entry.
6419     *
6420     * This widget encapsulates operations on its internal file
6421     * selector on its own API. There is less control over its file
6422     * selector than that one would have instatiating one directly.
6423     *
6424     * Smart callbacks one can register to:
6425     * - @c "changed" - The text within the entry was changed
6426     * - @c "activated" - The entry has had editing finished and
6427     *   changes are to be "committed"
6428     * - @c "press" - The entry has been clicked
6429     * - @c "longpressed" - The entry has been clicked (and held) for a
6430     *   couple seconds
6431     * - @c "clicked" - The entry has been clicked
6432     * - @c "clicked,double" - The entry has been double clicked
6433     * - @c "focused" - The entry has received focus
6434     * - @c "unfocused" - The entry has lost focus
6435     * - @c "selection,paste" - A paste action has occurred on the
6436     *   entry
6437     * - @c "selection,copy" - A copy action has occurred on the entry
6438     * - @c "selection,cut" - A cut action has occurred on the entry
6439     * - @c "unpressed" - The file selector entry's button was released
6440     *   after being pressed.
6441     * - @c "file,chosen" - The user has selected a path via the file
6442     *   selector entry's internal file selector, whose string pointer
6443     *   comes as the @c event_info data (a stringshared string)
6444     *
6445     * Here is an example on its usage:
6446     * @li @ref fileselector_entry_example
6447     *
6448     * @see @ref File_Selector_Button for a similar widget.
6449     * @{
6450     */
6451
6452    /**
6453     * Add a new file selector entry widget to the given parent
6454     * Elementary (container) object
6455     *
6456     * @param parent The parent object
6457     * @return a new file selector entry widget handle or @c NULL, on
6458     * errors
6459     */
6460    EAPI Evas_Object *elm_fileselector_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6461
6462    /**
6463     * Set the label for a given file selector entry widget's button
6464     *
6465     * @param obj The file selector entry widget
6466     * @param label The text label to be displayed on @p obj widget's
6467     * button
6468     *
6469     * @deprecated use elm_object_text_set() instead.
6470     */
6471    EINA_DEPRECATED EAPI void         elm_fileselector_entry_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6472
6473    /**
6474     * Get the label set for a given file selector entry widget's button
6475     *
6476     * @param obj The file selector entry widget
6477     * @return The widget button's label
6478     *
6479     * @deprecated use elm_object_text_set() instead.
6480     */
6481    EINA_DEPRECATED EAPI const char  *elm_fileselector_entry_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6482
6483    /**
6484     * Set the icon on a given file selector entry widget's button
6485     *
6486     * @param obj The file selector entry widget
6487     * @param icon The icon object for the entry's button
6488     *
6489     * Once the icon object is set, a previously set one will be
6490     * deleted. If you want to keep the latter, use the
6491     * elm_fileselector_entry_button_icon_unset() function.
6492     *
6493     * @see elm_fileselector_entry_button_icon_get()
6494     */
6495    EAPI void         elm_fileselector_entry_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6496
6497    /**
6498     * Get the icon set for a given file selector entry widget's button
6499     *
6500     * @param obj The file selector entry widget
6501     * @return The icon object currently set on @p obj widget's button
6502     * or @c NULL, if none is
6503     *
6504     * @see elm_fileselector_entry_button_icon_set()
6505     */
6506    EAPI Evas_Object *elm_fileselector_entry_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6507
6508    /**
6509     * Unset the icon used in a given file selector entry widget's
6510     * button
6511     *
6512     * @param obj The file selector entry widget
6513     * @return The icon object that was being used on @p obj widget's
6514     * button or @c NULL, on errors
6515     *
6516     * Unparent and return the icon object which was set for this
6517     * widget's button.
6518     *
6519     * @see elm_fileselector_entry_button_icon_set()
6520     */
6521    EAPI Evas_Object *elm_fileselector_entry_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6522
6523    /**
6524     * Set the title for a given file selector entry widget's window
6525     *
6526     * @param obj The file selector entry widget
6527     * @param title The title string
6528     *
6529     * This will change the window's title, when the file selector pops
6530     * out after a click on the entry's button. Those windows have the
6531     * default (unlocalized) value of @c "Select a file" as titles.
6532     *
6533     * @note It will only take any effect if the file selector
6534     * entry widget is @b not under "inwin mode".
6535     *
6536     * @see elm_fileselector_entry_window_title_get()
6537     */
6538    EAPI void         elm_fileselector_entry_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6539
6540    /**
6541     * Get the title set for a given file selector entry widget's
6542     * window
6543     *
6544     * @param obj The file selector entry widget
6545     * @return Title of the file selector entry's window
6546     *
6547     * @see elm_fileselector_entry_window_title_get() for more details
6548     */
6549    EAPI const char  *elm_fileselector_entry_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6550
6551    /**
6552     * Set the size of a given file selector entry widget's window,
6553     * holding the file selector itself.
6554     *
6555     * @param obj The file selector entry widget
6556     * @param width The window's width
6557     * @param height The window's height
6558     *
6559     * @note it will only take any effect if the file selector entry
6560     * widget is @b not under "inwin mode". The default size for the
6561     * window (when applicable) is 400x400 pixels.
6562     *
6563     * @see elm_fileselector_entry_window_size_get()
6564     */
6565    EAPI void         elm_fileselector_entry_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6566
6567    /**
6568     * Get the size of a given file selector entry widget's window,
6569     * holding the file selector itself.
6570     *
6571     * @param obj The file selector entry widget
6572     * @param width Pointer into which to store the width value
6573     * @param height Pointer into which to store the height value
6574     *
6575     * @note Use @c NULL pointers on the size values you're not
6576     * interested in: they'll be ignored by the function.
6577     *
6578     * @see elm_fileselector_entry_window_size_set(), for more details
6579     */
6580    EAPI void         elm_fileselector_entry_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6581
6582    /**
6583     * Set the initial file system path and the entry's path string for
6584     * a given file selector entry widget
6585     *
6586     * @param obj The file selector entry widget
6587     * @param path The path string
6588     *
6589     * It must be a <b>directory</b> path, which will have the contents
6590     * displayed initially in the file selector's view, when invoked
6591     * from @p obj. The default initial path is the @c "HOME"
6592     * environment variable's value.
6593     *
6594     * @see elm_fileselector_entry_path_get()
6595     */
6596    EAPI void         elm_fileselector_entry_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6597
6598    /**
6599     * Get the entry's path string for a given file selector entry
6600     * widget
6601     *
6602     * @param obj The file selector entry widget
6603     * @return path The path string
6604     *
6605     * @see elm_fileselector_entry_path_set() for more details
6606     */
6607    EAPI const char  *elm_fileselector_entry_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6608
6609    /**
6610     * Enable/disable a tree view in the given file selector entry
6611     * widget's internal file selector
6612     *
6613     * @param obj The file selector entry widget
6614     * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
6615     * disable
6616     *
6617     * This has the same effect as elm_fileselector_expandable_set(),
6618     * but now applied to a file selector entry's internal file
6619     * selector.
6620     *
6621     * @note There's no way to put a file selector entry's internal
6622     * file selector in "grid mode", as one may do with "pure" file
6623     * selectors.
6624     *
6625     * @see elm_fileselector_expandable_get()
6626     */
6627    EAPI void         elm_fileselector_entry_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6628
6629    /**
6630     * Get whether tree view is enabled for the given file selector
6631     * entry widget's internal file selector
6632     *
6633     * @param obj The file selector entry widget
6634     * @return @c EINA_TRUE if @p obj widget's internal file selector
6635     * is in tree view, @c EINA_FALSE otherwise (and or errors)
6636     *
6637     * @see elm_fileselector_expandable_set() for more details
6638     */
6639    EAPI Eina_Bool    elm_fileselector_entry_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6640
6641    /**
6642     * Set whether a given file selector entry widget's internal file
6643     * selector is to display folders only or the directory contents,
6644     * as well.
6645     *
6646     * @param obj The file selector entry widget
6647     * @param only @c EINA_TRUE to make @p obj widget's internal file
6648     * selector only display directories, @c EINA_FALSE to make files
6649     * to be displayed in it too
6650     *
6651     * This has the same effect as elm_fileselector_folder_only_set(),
6652     * but now applied to a file selector entry's internal file
6653     * selector.
6654     *
6655     * @see elm_fileselector_folder_only_get()
6656     */
6657    EAPI void         elm_fileselector_entry_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6658
6659    /**
6660     * Get whether a given file selector entry widget's internal file
6661     * selector is displaying folders only or the directory contents,
6662     * as well.
6663     *
6664     * @param obj The file selector entry widget
6665     * @return @c EINA_TRUE if @p obj widget's internal file
6666     * selector is only displaying directories, @c EINA_FALSE if files
6667     * are being displayed in it too (and on errors)
6668     *
6669     * @see elm_fileselector_entry_folder_only_set() for more details
6670     */
6671    EAPI Eina_Bool    elm_fileselector_entry_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6672
6673    /**
6674     * Enable/disable the file name entry box where the user can type
6675     * in a name for a file, in a given file selector entry widget's
6676     * internal file selector.
6677     *
6678     * @param obj The file selector entry widget
6679     * @param is_save @c EINA_TRUE to make @p obj widget's internal
6680     * file selector a "saving dialog", @c EINA_FALSE otherwise
6681     *
6682     * This has the same effect as elm_fileselector_is_save_set(),
6683     * but now applied to a file selector entry's internal file
6684     * selector.
6685     *
6686     * @see elm_fileselector_is_save_get()
6687     */
6688    EAPI void         elm_fileselector_entry_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6689
6690    /**
6691     * Get whether the given file selector entry widget's internal
6692     * file selector is in "saving dialog" mode
6693     *
6694     * @param obj The file selector entry widget
6695     * @return @c EINA_TRUE, if @p obj widget's internal file selector
6696     * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
6697     * errors)
6698     *
6699     * @see elm_fileselector_entry_is_save_set() for more details
6700     */
6701    EAPI Eina_Bool    elm_fileselector_entry_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6702
6703    /**
6704     * Set whether a given file selector entry widget's internal file
6705     * selector will raise an Elementary "inner window", instead of a
6706     * dedicated Elementary window. By default, it won't.
6707     *
6708     * @param obj The file selector entry widget
6709     * @param value @c EINA_TRUE to make it use an inner window, @c
6710     * EINA_TRUE to make it use a dedicated window
6711     *
6712     * @see elm_win_inwin_add() for more information on inner windows
6713     * @see elm_fileselector_entry_inwin_mode_get()
6714     */
6715    EAPI void         elm_fileselector_entry_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6716
6717    /**
6718     * Get whether a given file selector entry widget's internal file
6719     * selector will raise an Elementary "inner window", instead of a
6720     * dedicated Elementary window.
6721     *
6722     * @param obj The file selector entry widget
6723     * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
6724     * if it will use a dedicated window
6725     *
6726     * @see elm_fileselector_entry_inwin_mode_set() for more details
6727     */
6728    EAPI Eina_Bool    elm_fileselector_entry_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6729
6730    /**
6731     * Set the initial file system path for a given file selector entry
6732     * widget
6733     *
6734     * @param obj The file selector entry widget
6735     * @param path The path string
6736     *
6737     * It must be a <b>directory</b> path, which will have the contents
6738     * displayed initially in the file selector's view, when invoked
6739     * from @p obj. The default initial path is the @c "HOME"
6740     * environment variable's value.
6741     *
6742     * @see elm_fileselector_entry_path_get()
6743     */
6744    EAPI void         elm_fileselector_entry_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6745
6746    /**
6747     * Get the parent directory's path to the latest file selection on
6748     * a given filer selector entry widget
6749     *
6750     * @param obj The file selector object
6751     * @return The (full) path of the directory of the last selection
6752     * on @p obj widget, a @b stringshared string
6753     *
6754     * @see elm_fileselector_entry_path_set()
6755     */
6756    EAPI const char  *elm_fileselector_entry_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6757
6758    /**
6759     * @}
6760     */
6761
6762    /**
6763     * @defgroup Scroller Scroller
6764     *
6765     * A scroller holds a single object and "scrolls it around". This means that
6766     * it allows the user to use a scrollbar (or a finger) to drag the viewable
6767     * region around, allowing to move through a much larger object that is
6768     * contained in the scroller. The scroiller will always have a small minimum
6769     * size by default as it won't be limited by the contents of the scroller.
6770     *
6771     * Signals that you can add callbacks for are:
6772     * @li "edge,left" - the left edge of the content has been reached
6773     * @li "edge,right" - the right edge of the content has been reached
6774     * @li "edge,top" - the top edge of the content has been reached
6775     * @li "edge,bottom" - the bottom edge of the content has been reached
6776     * @li "scroll" - the content has been scrolled (moved)
6777     * @li "scroll,anim,start" - scrolling animation has started
6778     * @li "scroll,anim,stop" - scrolling animation has stopped
6779     * @li "scroll,drag,start" - dragging the contents around has started
6780     * @li "scroll,drag,stop" - dragging the contents around has stopped
6781     * @note The "scroll,anim,*" and "scroll,drag,*" signals are only emitted by
6782     * user intervetion.
6783     *
6784     * @note When Elemementary is in embedded mode the scrollbars will not be
6785     * dragable, they appear merely as indicators of how much has been scrolled.
6786     * @note When Elementary is in desktop mode the thumbscroll(a.k.a.
6787     * fingerscroll) won't work.
6788     *
6789     * In @ref tutorial_scroller you'll find an example of how to use most of
6790     * this API.
6791     * @{
6792     */
6793    /**
6794     * @brief Type that controls when scrollbars should appear.
6795     *
6796     * @see elm_scroller_policy_set()
6797     */
6798    typedef enum _Elm_Scroller_Policy
6799      {
6800         ELM_SCROLLER_POLICY_AUTO = 0, /**< Show scrollbars as needed */
6801         ELM_SCROLLER_POLICY_ON, /**< Always show scrollbars */
6802         ELM_SCROLLER_POLICY_OFF, /**< Never show scrollbars */
6803         ELM_SCROLLER_POLICY_LAST
6804      } Elm_Scroller_Policy;
6805    /**
6806     * @brief Add a new scroller to the parent
6807     *
6808     * @param parent The parent object
6809     * @return The new object or NULL if it cannot be created
6810     */
6811    EAPI Evas_Object *elm_scroller_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6812    /**
6813     * @brief Set the content of the scroller widget (the object to be scrolled around).
6814     *
6815     * @param obj The scroller object
6816     * @param content The new content object
6817     *
6818     * Once the content object is set, a previously set one will be deleted.
6819     * If you want to keep that old content object, use the
6820     * elm_scroller_content_unset() function.
6821     */
6822    EAPI void         elm_scroller_content_set(Evas_Object *obj, Evas_Object *child) EINA_ARG_NONNULL(1);
6823    /**
6824     * @brief Get the content of the scroller widget
6825     *
6826     * @param obj The slider object
6827     * @return The content that is being used
6828     *
6829     * Return the content object which is set for this widget
6830     *
6831     * @see elm_scroller_content_set()
6832     */
6833    EAPI Evas_Object *elm_scroller_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6834    /**
6835     * @brief Unset the content of the scroller widget
6836     *
6837     * @param obj The slider object
6838     * @return The content that was being used
6839     *
6840     * Unparent and return the content object which was set for this widget
6841     *
6842     * @see elm_scroller_content_set()
6843     */
6844    EAPI Evas_Object *elm_scroller_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6845    /**
6846     * @brief Set custom theme elements for the scroller
6847     *
6848     * @param obj The scroller object
6849     * @param widget The widget name to use (default is "scroller")
6850     * @param base The base name to use (default is "base")
6851     */
6852    EAPI void         elm_scroller_custom_widget_base_theme_set(Evas_Object *obj, const char *widget, const char *base) EINA_ARG_NONNULL(1, 2, 3);
6853    /**
6854     * @brief Make the scroller minimum size limited to the minimum size of the content
6855     *
6856     * @param obj The scroller object
6857     * @param w Enable limiting minimum size horizontally
6858     * @param h Enable limiting minimum size vertically
6859     *
6860     * By default the scroller will be as small as its design allows,
6861     * irrespective of its content. This will make the scroller minimum size the
6862     * right size horizontally and/or vertically to perfectly fit its content in
6863     * that direction.
6864     */
6865    EAPI void         elm_scroller_content_min_limit(Evas_Object *obj, Eina_Bool w, Eina_Bool h) EINA_ARG_NONNULL(1);
6866    /**
6867     * @brief Show a specific virtual region within the scroller content object
6868     *
6869     * @param obj The scroller object
6870     * @param x X coordinate of the region
6871     * @param y Y coordinate of the region
6872     * @param w Width of the region
6873     * @param h Height of the region
6874     *
6875     * This will ensure all (or part if it does not fit) of the designated
6876     * region in the virtual content object (0, 0 starting at the top-left of the
6877     * virtual content object) is shown within the scroller.
6878     */
6879    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);
6880    /**
6881     * @brief Set the scrollbar visibility policy
6882     *
6883     * @param obj The scroller object
6884     * @param policy_h Horizontal scrollbar policy
6885     * @param policy_v Vertical scrollbar policy
6886     *
6887     * This sets the scrollbar visibility policy for the given scroller.
6888     * ELM_SCROLLER_POLICY_AUTO means the scrollber is made visible if it is
6889     * needed, and otherwise kept hidden. ELM_SCROLLER_POLICY_ON turns it on all
6890     * the time, and ELM_SCROLLER_POLICY_OFF always keeps it off. This applies
6891     * respectively for the horizontal and vertical scrollbars.
6892     */
6893    EAPI void         elm_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
6894    /**
6895     * @brief Gets scrollbar visibility policy
6896     *
6897     * @param obj The scroller object
6898     * @param policy_h Horizontal scrollbar policy
6899     * @param policy_v Vertical scrollbar policy
6900     *
6901     * @see elm_scroller_policy_set()
6902     */
6903    EAPI void         elm_scroller_policy_get(const Evas_Object *obj, Elm_Scroller_Policy *policy_h, Elm_Scroller_Policy *policy_v) EINA_ARG_NONNULL(1);
6904    /**
6905     * @brief Get the currently visible content region
6906     *
6907     * @param obj The scroller object
6908     * @param x X coordinate of the region
6909     * @param y Y coordinate of the region
6910     * @param w Width of the region
6911     * @param h Height of the region
6912     *
6913     * This gets the current region in the content object that is visible through
6914     * the scroller. The region co-ordinates are returned in the @p x, @p y, @p
6915     * w, @p h values pointed to.
6916     *
6917     * @note All coordinates are relative to the content.
6918     *
6919     * @see elm_scroller_region_show()
6920     */
6921    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);
6922    /**
6923     * @brief Get the size of the content object
6924     *
6925     * @param obj The scroller object
6926     * @param w Width return
6927     * @param h Height return
6928     *
6929     * This gets the size of the content object of the scroller.
6930     */
6931    EAPI void         elm_scroller_child_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
6932    /**
6933     * @brief Set bouncing behavior
6934     *
6935     * @param obj The scroller object
6936     * @param h_bounce Will the scroller bounce horizontally or not
6937     * @param v_bounce Will the scroller bounce vertically or not
6938     *
6939     * When scrolling, the scroller may "bounce" when reaching an edge of the
6940     * content object. This is a visual way to indicate the end has been reached.
6941     * This is enabled by default for both axis. This will set if it is enabled
6942     * for that axis with the boolean parameters for each axis.
6943     */
6944    EAPI void         elm_scroller_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
6945    /**
6946     * @brief Get the bounce mode
6947     *
6948     * @param obj The Scroller object
6949     * @param h_bounce Allow bounce horizontally
6950     * @param v_bounce Allow bounce vertically
6951     *
6952     * @see elm_scroller_bounce_set()
6953     */
6954    EAPI void         elm_scroller_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
6955    /**
6956     * @brief Set scroll page size relative to viewport size.
6957     *
6958     * @param obj The scroller object
6959     * @param h_pagerel The horizontal page relative size
6960     * @param v_pagerel The vertical page relative size
6961     *
6962     * The scroller is capable of limiting scrolling by the user to "pages". That
6963     * is to jump by and only show a "whole page" at a time as if the continuous
6964     * area of the scroller content is split into page sized pieces. This sets
6965     * the size of a page relative to the viewport of the scroller. 1.0 is "1
6966     * viewport" is size (horizontally or vertically). 0.0 turns it off in that
6967     * axis. This is mutually exclusive with page size
6968     * (see elm_scroller_page_size_set()  for more information). Likewise 0.5
6969     * is "half a viewport". Sane usable valus are normally between 0.0 and 1.0
6970     * including 1.0. If you only want 1 axis to be page "limited", use 0.0 for
6971     * the other axis.
6972     */
6973    EAPI void         elm_scroller_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
6974    /**
6975     * @brief Set scroll page size.
6976     *
6977     * @param obj The scroller object
6978     * @param h_pagesize The horizontal page size
6979     * @param v_pagesize The vertical page size
6980     *
6981     * This sets the page size to an absolute fixed value, with 0 turning it off
6982     * for that axis.
6983     *
6984     * @see elm_scroller_page_relative_set()
6985     */
6986    EAPI void         elm_scroller_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
6987    /**
6988     * @brief Get scroll current page number.
6989     *
6990     * @param obj The scroller object
6991     * @param h_pagenumber The horizoptal page number
6992     * @param v_pagenumber The vertical page number
6993     *
6994     * The page number starts from 0. 0 is the first page.
6995     * Current page means the page which meet the top-left of the viewport.
6996     * If there are two or more pages in the viewport, it returns the number of page
6997     * which meet the top-left of the viewport.
6998     *
6999     * @see elm_scroller_last_page_get()
7000     * @see elm_scroller_page_show()
7001     * @see elm_scroller_page_brint_in()
7002     */
7003    EAPI void         elm_scroller_current_page_get(Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
7004    /**
7005     * @brief Get scroll last page number.
7006     *
7007     * @param obj The scroller object
7008     * @param h_pagenumber The horizoptal page number
7009     * @param v_pagenumber The vertical page number
7010     *
7011     * The page number starts from 0. 0 is the first page.
7012     * This returns the last page number among the pages.
7013     *
7014     * @see elm_scroller_current_page_get()
7015     * @see elm_scroller_page_show()
7016     * @see elm_scroller_page_brint_in()
7017     */
7018    EAPI void         elm_scroller_last_page_get(Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
7019    /**
7020     * Show a specific virtual region within the scroller content object by page number.
7021     *
7022     * @param obj The scroller object
7023     * @param h_pagenumber The horizoptal page number
7024     * @param v_pagenumber The vertical page number
7025     *
7026     * 0, 0 of the indicated page is located at the top-left of the viewport.
7027     * This will jump to the page directly without animation.
7028     *
7029     * Example of usage:
7030     *
7031     * @code
7032     * sc = elm_scroller_add(win);
7033     * elm_scroller_content_set(sc, content);
7034     * elm_scroller_page_relative_set(sc, 1, 0);
7035     * elm_scroller_current_page_get(sc, &h_page, &v_page);
7036     * elm_scroller_page_show(sc, h_page + 1, v_page);
7037     * @endcode
7038     *
7039     * @see elm_scroller_page_bring_in()
7040     */
7041    EAPI void         elm_scroller_page_show(Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
7042    /**
7043     * Show a specific virtual region within the scroller content object by page number.
7044     *
7045     * @param obj The scroller object
7046     * @param h_pagenumber The horizoptal page number
7047     * @param v_pagenumber The vertical page number
7048     *
7049     * 0, 0 of the indicated page is located at the top-left of the viewport.
7050     * This will slide to the page with animation.
7051     *
7052     * Example of usage:
7053     *
7054     * @code
7055     * sc = elm_scroller_add(win);
7056     * elm_scroller_content_set(sc, content);
7057     * elm_scroller_page_relative_set(sc, 1, 0);
7058     * elm_scroller_last_page_get(sc, &h_page, &v_page);
7059     * elm_scroller_page_bring_in(sc, h_page, v_page);
7060     * @endcode
7061     *
7062     * @see elm_scroller_page_show()
7063     */
7064    EAPI void         elm_scroller_page_bring_in(Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
7065    /**
7066     * @brief Show a specific virtual region within the scroller content object.
7067     *
7068     * @param obj The scroller object
7069     * @param x X coordinate of the region
7070     * @param y Y coordinate of the region
7071     * @param w Width of the region
7072     * @param h Height of the region
7073     *
7074     * This will ensure all (or part if it does not fit) of the designated
7075     * region in the virtual content object (0, 0 starting at the top-left of the
7076     * virtual content object) is shown within the scroller. Unlike
7077     * elm_scroller_region_show(), this allow the scroller to "smoothly slide"
7078     * to this location (if configuration in general calls for transitions). It
7079     * may not jump immediately to the new location and make take a while and
7080     * show other content along the way.
7081     *
7082     * @see elm_scroller_region_show()
7083     */
7084    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);
7085    /**
7086     * @brief Set event propagation on a scroller
7087     *
7088     * @param obj The scroller object
7089     * @param propagation If propagation is enabled or not
7090     *
7091     * This enables or disabled event propagation from the scroller content to
7092     * the scroller and its parent. By default event propagation is disabled.
7093     */
7094    EAPI void         elm_scroller_propagate_events_set(Evas_Object *obj, Eina_Bool propagation);
7095    /**
7096     * @brief Get event propagation for a scroller
7097     *
7098     * @param obj The scroller object
7099     * @return The propagation state
7100     *
7101     * This gets the event propagation for a scroller.
7102     *
7103     * @see elm_scroller_propagate_events_set()
7104     */
7105    EAPI Eina_Bool    elm_scroller_propagate_events_get(const Evas_Object *obj);
7106    /**
7107     * @}
7108     */
7109
7110    /**
7111     * @defgroup Label Label
7112     *
7113     * @image html img/widget/label/preview-00.png
7114     * @image latex img/widget/label/preview-00.eps
7115     *
7116     * @brief Widget to display text, with simple html-like markup.
7117     *
7118     * The Label widget @b doesn't allow text to overflow its boundaries, if the
7119     * text doesn't fit the geometry of the label it will be ellipsized or be
7120     * cut. Elementary provides several themes for this widget:
7121     * @li default - No animation
7122     * @li marker - Centers the text in the label and make it bold by default
7123     * @li slide_long - The entire text appears from the right of the screen and
7124     * slides until it disappears in the left of the screen(reappering on the
7125     * right again).
7126     * @li slide_short - The text appears in the left of the label and slides to
7127     * the right to show the overflow. When all of the text has been shown the
7128     * position is reset.
7129     * @li slide_bounce - The text appears in the left of the label and slides to
7130     * the right to show the overflow. When all of the text has been shown the
7131     * animation reverses, moving the text to the left.
7132     *
7133     * Custom themes can of course invent new markup tags and style them any way
7134     * they like.
7135     *
7136     * See @ref tutorial_label for a demonstration of how to use a label widget.
7137     * @{
7138     */
7139    /**
7140     * @brief Add a new label to the parent
7141     *
7142     * @param parent The parent object
7143     * @return The new object or NULL if it cannot be created
7144     */
7145    EAPI Evas_Object *elm_label_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7146    /**
7147     * @brief Set the label on the label object
7148     *
7149     * @param obj The label object
7150     * @param label The label will be used on the label object
7151     * @deprecated See elm_object_text_set()
7152     */
7153    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 */
7154    /**
7155     * @brief Get the label used on the label object
7156     *
7157     * @param obj The label object
7158     * @return The string inside the label
7159     * @deprecated See elm_object_text_get()
7160     */
7161    EINA_DEPRECATED EAPI const char *elm_label_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1); /* deprecated, use elm_object_text_get instead */
7162    /**
7163     * @brief Set the wrapping behavior of the label
7164     *
7165     * @param obj The label object
7166     * @param wrap To wrap text or not
7167     *
7168     * By default no wrapping is done. Possible values for @p wrap are:
7169     * @li ELM_WRAP_NONE - No wrapping
7170     * @li ELM_WRAP_CHAR - wrap between characters
7171     * @li ELM_WRAP_WORD - wrap between words
7172     * @li ELM_WRAP_MIXED - Word wrap, and if that fails, char wrap
7173     */
7174    EAPI void         elm_label_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
7175    /**
7176     * @brief Get the wrapping behavior of the label
7177     *
7178     * @param obj The label object
7179     * @return Wrap type
7180     *
7181     * @see elm_label_line_wrap_set()
7182     */
7183    EAPI Elm_Wrap_Type elm_label_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7184    /**
7185     * @brief Set wrap width of the label
7186     *
7187     * @param obj The label object
7188     * @param w The wrap width in pixels at a minimum where words need to wrap
7189     *
7190     * This function sets the maximum width size hint of the label.
7191     *
7192     * @warning This is only relevant if the label is inside a container.
7193     */
7194    EAPI void         elm_label_wrap_width_set(Evas_Object *obj, Evas_Coord w) EINA_ARG_NONNULL(1);
7195    /**
7196     * @brief Get wrap width of the label
7197     *
7198     * @param obj The label object
7199     * @return The wrap width in pixels at a minimum where words need to wrap
7200     *
7201     * @see elm_label_wrap_width_set()
7202     */
7203    EAPI Evas_Coord   elm_label_wrap_width_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7204    /**
7205     * @brief Set wrap height of the label
7206     *
7207     * @param obj The label object
7208     * @param h The wrap height in pixels at a minimum where words need to wrap
7209     *
7210     * This function sets the maximum height size hint of the label.
7211     *
7212     * @warning This is only relevant if the label is inside a container.
7213     */
7214    EAPI void         elm_label_wrap_height_set(Evas_Object *obj, Evas_Coord h) EINA_ARG_NONNULL(1);
7215    /**
7216     * @brief get wrap width of the label
7217     *
7218     * @param obj The label object
7219     * @return The wrap height in pixels at a minimum where words need to wrap
7220     */
7221    EAPI Evas_Coord   elm_label_wrap_height_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7222    /**
7223     * @brief Set the font size on the label object.
7224     *
7225     * @param obj The label object
7226     * @param size font size
7227     *
7228     * @warning NEVER use this. It is for hyper-special cases only. use styles
7229     * instead. e.g. "big", "medium", "small" - or better name them by use:
7230     * "title", "footnote", "quote" etc.
7231     */
7232    EAPI void         elm_label_fontsize_set(Evas_Object *obj, int fontsize) EINA_ARG_NONNULL(1);
7233    /**
7234     * @brief Set the text color on the label object
7235     *
7236     * @param obj The label object
7237     * @param r Red property background color of The label object
7238     * @param g Green property background color of The label object
7239     * @param b Blue property background color of The label object
7240     * @param a Alpha property background color of The label object
7241     *
7242     * @warning NEVER use this. It is for hyper-special cases only. use styles
7243     * instead. e.g. "big", "medium", "small" - or better name them by use:
7244     * "title", "footnote", "quote" etc.
7245     */
7246    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);
7247    /**
7248     * @brief Set the text align on the label object
7249     *
7250     * @param obj The label object
7251     * @param align align mode ("left", "center", "right")
7252     *
7253     * @warning NEVER use this. It is for hyper-special cases only. use styles
7254     * instead. e.g. "big", "medium", "small" - or better name them by use:
7255     * "title", "footnote", "quote" etc.
7256     */
7257    EAPI void         elm_label_text_align_set(Evas_Object *obj, const char *alignmode) EINA_ARG_NONNULL(1);
7258    /**
7259     * @brief Set background color of the label
7260     *
7261     * @param obj The label object
7262     * @param r Red property background color of The label object
7263     * @param g Green property background color of The label object
7264     * @param b Blue property background color of The label object
7265     * @param a Alpha property background alpha of The label object
7266     *
7267     * @warning NEVER use this. It is for hyper-special cases only. use styles
7268     * instead. e.g. "big", "medium", "small" - or better name them by use:
7269     * "title", "footnote", "quote" etc.
7270     */
7271    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);
7272    /**
7273     * @brief Set the ellipsis behavior of the label
7274     *
7275     * @param obj The label object
7276     * @param ellipsis To ellipsis text or not
7277     *
7278     * If set to true and the text doesn't fit in the label an ellipsis("...")
7279     * will be shown at the end of the widget.
7280     *
7281     * @warning This doesn't work with slide(elm_label_slide_set()) or if the
7282     * choosen wrap method was ELM_WRAP_WORD.
7283     */
7284    EAPI void         elm_label_ellipsis_set(Evas_Object *obj, Eina_Bool ellipsis) EINA_ARG_NONNULL(1);
7285    /**
7286     * @brief Set the text slide of the label
7287     *
7288     * @param obj The label object
7289     * @param slide To start slide or stop
7290     *
7291     * If set to true the text of the label will slide throught the length of
7292     * label.
7293     *
7294     * @warning This only work with the themes "slide_short", "slide_long" and
7295     * "slide_bounce".
7296     */
7297    EAPI void         elm_label_slide_set(Evas_Object *obj, Eina_Bool slide) EINA_ARG_NONNULL(1);
7298    /**
7299     * @brief Get the text slide mode of the label
7300     *
7301     * @param obj The label object
7302     * @return slide slide mode value
7303     *
7304     * @see elm_label_slide_set()
7305     */
7306    EAPI Eina_Bool    elm_label_slide_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7307    /**
7308     * @brief Set the slide duration(speed) of the label
7309     *
7310     * @param obj The label object
7311     * @return The duration in seconds in moving text from slide begin position
7312     * to slide end position
7313     */
7314    EAPI void         elm_label_slide_duration_set(Evas_Object *obj, double duration) EINA_ARG_NONNULL(1);
7315    /**
7316     * @brief Get the slide duration(speed) of the label
7317     *
7318     * @param obj The label object
7319     * @return The duration time in moving text from slide begin position to slide end position
7320     *
7321     * @see elm_label_slide_duration_set()
7322     */
7323    EAPI double       elm_label_slide_duration_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7324    /**
7325     * @}
7326     */
7327
7328    /**
7329     * @defgroup Toggle Toggle
7330     *
7331     * @image html img/widget/toggle/preview-00.png
7332     * @image latex img/widget/toggle/preview-00.eps
7333     *
7334     * @brief A toggle is a slider which can be used to toggle between
7335     * two values.  It has two states: on and off.
7336     *
7337     * Signals that you can add callbacks for are:
7338     * @li "changed" - Whenever the toggle value has been changed.  Is not called
7339     *                 until the toggle is released by the cursor (assuming it
7340     *                 has been triggered by the cursor in the first place).
7341     *
7342     * @ref tutorial_toggle show how to use a toggle.
7343     * @{
7344     */
7345    /**
7346     * @brief Add a toggle to @p parent.
7347     *
7348     * @param parent The parent object
7349     *
7350     * @return The toggle object
7351     */
7352    EAPI Evas_Object *elm_toggle_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7353    /**
7354     * @brief Sets the label to be displayed with the toggle.
7355     *
7356     * @param obj The toggle object
7357     * @param label The label to be displayed
7358     *
7359     * @deprecated use elm_object_text_set() instead.
7360     */
7361    EINA_DEPRECATED EAPI void         elm_toggle_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7362    /**
7363     * @brief Gets the label of the toggle
7364     *
7365     * @param obj  toggle object
7366     * @return The label of the toggle
7367     *
7368     * @deprecated use elm_object_text_get() instead.
7369     */
7370    EINA_DEPRECATED EAPI const char  *elm_toggle_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7371    /**
7372     * @brief Set the icon used for the toggle
7373     *
7374     * @param obj The toggle object
7375     * @param icon The icon object for the button
7376     *
7377     * Once the icon object is set, a previously set one will be deleted
7378     * If you want to keep that old content object, use the
7379     * elm_toggle_icon_unset() function.
7380     */
7381    EAPI void         elm_toggle_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
7382    /**
7383     * @brief Get the icon used for the toggle
7384     *
7385     * @param obj The toggle object
7386     * @return The icon object that is being used
7387     *
7388     * Return the icon object which is set for this widget.
7389     *
7390     * @see elm_toggle_icon_set()
7391     */
7392    EAPI Evas_Object *elm_toggle_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7393    /**
7394     * @brief Unset the icon used for the toggle
7395     *
7396     * @param obj The toggle object
7397     * @return The icon object that was being used
7398     *
7399     * Unparent and return the icon object which was set for this widget.
7400     *
7401     * @see elm_toggle_icon_set()
7402     */
7403    EAPI Evas_Object *elm_toggle_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7404    /**
7405     * @brief Sets the labels to be associated with the on and off states of the toggle.
7406     *
7407     * @param obj The toggle object
7408     * @param onlabel The label displayed when the toggle is in the "on" state
7409     * @param offlabel The label displayed when the toggle is in the "off" state
7410     */
7411    EAPI void         elm_toggle_states_labels_set(Evas_Object *obj, const char *onlabel, const char *offlabel) EINA_ARG_NONNULL(1);
7412    /**
7413     * @brief Gets the labels associated with the on and off states of the toggle.
7414     *
7415     * @param obj The toggle object
7416     * @param onlabel A char** to place the onlabel of @p obj into
7417     * @param offlabel A char** to place the offlabel of @p obj into
7418     */
7419    EAPI void         elm_toggle_states_labels_get(const Evas_Object *obj, const char **onlabel, const char **offlabel) EINA_ARG_NONNULL(1);
7420    /**
7421     * @brief Sets the state of the toggle to @p state.
7422     *
7423     * @param obj The toggle object
7424     * @param state The state of @p obj
7425     */
7426    EAPI void         elm_toggle_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
7427    /**
7428     * @brief Gets the state of the toggle to @p state.
7429     *
7430     * @param obj The toggle object
7431     * @return The state of @p obj
7432     */
7433    EAPI Eina_Bool    elm_toggle_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7434    /**
7435     * @brief Sets the state pointer of the toggle to @p statep.
7436     *
7437     * @param obj The toggle object
7438     * @param statep The state pointer of @p obj
7439     */
7440    EAPI void         elm_toggle_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
7441    /**
7442     * @}
7443     */
7444
7445    /**
7446     * @defgroup Frame Frame
7447     *
7448     * @image html img/widget/frame/preview-00.png
7449     * @image latex img/widget/frame/preview-00.eps
7450     *
7451     * @brief Frame is a widget that holds some content and has a title.
7452     *
7453     * The default look is a frame with a title, but Frame supports multple
7454     * styles:
7455     * @li default
7456     * @li pad_small
7457     * @li pad_medium
7458     * @li pad_large
7459     * @li pad_huge
7460     * @li outdent_top
7461     * @li outdent_bottom
7462     *
7463     * Of all this styles only default shows the title. Frame emits no signals.
7464     *
7465     * For a detailed example see the @ref tutorial_frame.
7466     *
7467     * @{
7468     */
7469    /**
7470     * @brief Add a new frame to the parent
7471     *
7472     * @param parent The parent object
7473     * @return The new object or NULL if it cannot be created
7474     */
7475    EAPI Evas_Object *elm_frame_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7476    /**
7477     * @brief Set the frame label
7478     *
7479     * @param obj The frame object
7480     * @param label The label of this frame object
7481     *
7482     * @deprecated use elm_object_text_set() instead.
7483     */
7484    EINA_DEPRECATED EAPI void         elm_frame_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7485    /**
7486     * @brief Get the frame label
7487     *
7488     * @param obj The frame object
7489     *
7490     * @return The label of this frame objet or NULL if unable to get frame
7491     *
7492     * @deprecated use elm_object_text_get() instead.
7493     */
7494    EINA_DEPRECATED EAPI const char  *elm_frame_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7495    /**
7496     * @brief Set the content of the frame widget
7497     *
7498     * Once the content object is set, a previously set one will be deleted.
7499     * If you want to keep that old content object, use the
7500     * elm_frame_content_unset() function.
7501     *
7502     * @param obj The frame object
7503     * @param content The content will be filled in this frame object
7504     */
7505    EAPI void         elm_frame_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
7506    /**
7507     * @brief Get the content of the frame widget
7508     *
7509     * Return the content object which is set for this widget
7510     *
7511     * @param obj The frame object
7512     * @return The content that is being used
7513     */
7514    EAPI Evas_Object *elm_frame_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7515    /**
7516     * @brief Unset the content of the frame widget
7517     *
7518     * Unparent and return the content object which was set for this widget
7519     *
7520     * @param obj The frame object
7521     * @return The content that was being used
7522     */
7523    EAPI Evas_Object *elm_frame_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7524    /**
7525     * @}
7526     */
7527
7528    /**
7529     * @defgroup Table Table
7530     *
7531     * A container widget to arrange other widgets in a table where items can
7532     * also span multiple columns or rows - even overlap (and then be raised or
7533     * lowered accordingly to adjust stacking if they do overlap).
7534     *
7535     * The followin are examples of how to use a table:
7536     * @li @ref tutorial_table_01
7537     * @li @ref tutorial_table_02
7538     *
7539     * @{
7540     */
7541    /**
7542     * @brief Add a new table to the parent
7543     *
7544     * @param parent The parent object
7545     * @return The new object or NULL if it cannot be created
7546     */
7547    EAPI Evas_Object *elm_table_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7548    /**
7549     * @brief Set the homogeneous layout in the table
7550     *
7551     * @param obj The layout object
7552     * @param homogeneous A boolean to set if the layout is homogeneous in the
7553     * table (EINA_TRUE = homogeneous,  EINA_FALSE = no homogeneous)
7554     */
7555    EAPI void         elm_table_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
7556    /**
7557     * @brief Get the current table homogeneous mode.
7558     *
7559     * @param obj The table object
7560     * @return A boolean to indicating if the layout is homogeneous in the table
7561     * (EINA_TRUE = homogeneous,  EINA_FALSE = no homogeneous)
7562     */
7563    EAPI Eina_Bool    elm_table_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7564    /**
7565     * @warning <b>Use elm_table_homogeneous_set() instead</b>
7566     */
7567    EINA_DEPRECATED EAPI void elm_table_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
7568    /**
7569     * @warning <b>Use elm_table_homogeneous_get() instead</b>
7570     */
7571    EINA_DEPRECATED EAPI Eina_Bool elm_table_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7572    /**
7573     * @brief Set padding between cells.
7574     *
7575     * @param obj The layout object.
7576     * @param horizontal set the horizontal padding.
7577     * @param vertical set the vertical padding.
7578     *
7579     * Default value is 0.
7580     */
7581    EAPI void         elm_table_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
7582    /**
7583     * @brief Get padding between cells.
7584     *
7585     * @param obj The layout object.
7586     * @param horizontal set the horizontal padding.
7587     * @param vertical set the vertical padding.
7588     */
7589    EAPI void         elm_table_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
7590    /**
7591     * @brief Add a subobject on the table with the coordinates passed
7592     *
7593     * @param obj The table object
7594     * @param subobj The subobject to be added to the table
7595     * @param x Row number
7596     * @param y Column number
7597     * @param w rowspan
7598     * @param h colspan
7599     *
7600     * @note All positioning inside the table is relative to rows and columns, so
7601     * a value of 0 for x and y, means the top left cell of the table, and a
7602     * value of 1 for w and h means @p subobj only takes that 1 cell.
7603     */
7604    EAPI void         elm_table_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
7605    /**
7606     * @brief Remove child from table.
7607     *
7608     * @param obj The table object
7609     * @param subobj The subobject
7610     */
7611    EAPI void         elm_table_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
7612    /**
7613     * @brief Faster way to remove all child objects from a table object.
7614     *
7615     * @param obj The table object
7616     * @param clear If true, will delete children, else just remove from table.
7617     */
7618    EAPI void         elm_table_clear(Evas_Object *obj, Eina_Bool clear) EINA_ARG_NONNULL(1);
7619    /**
7620     * @brief Set the packing location of an existing child of the table
7621     *
7622     * @param subobj The subobject to be modified in the table
7623     * @param x Row number
7624     * @param y Column number
7625     * @param w rowspan
7626     * @param h colspan
7627     *
7628     * Modifies the position of an object already in the table.
7629     *
7630     * @note All positioning inside the table is relative to rows and columns, so
7631     * a value of 0 for x and y, means the top left cell of the table, and a
7632     * value of 1 for w and h means @p subobj only takes that 1 cell.
7633     */
7634    EAPI void         elm_table_pack_set(Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
7635    /**
7636     * @brief Get the packing location of an existing child of the table
7637     *
7638     * @param subobj The subobject to be modified in the table
7639     * @param x Row number
7640     * @param y Column number
7641     * @param w rowspan
7642     * @param h colspan
7643     *
7644     * @see elm_table_pack_set()
7645     */
7646    EAPI void         elm_table_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
7647    /**
7648     * @}
7649     */
7650
7651    /**
7652     * @defgroup Gengrid Gengrid (Generic grid)
7653     *
7654     * This widget aims to position objects in a grid layout while
7655     * actually creating and rendering only the visible ones, using the
7656     * same idea as the @ref Genlist "genlist": the user defines a @b
7657     * class for each item, specifying functions that will be called at
7658     * object creation, deletion, etc. When those items are selected by
7659     * the user, a callback function is issued. Users may interact with
7660     * a gengrid via the mouse (by clicking on items to select them and
7661     * clicking on the grid's viewport and swiping to pan the whole
7662     * view) or via the keyboard, navigating through item with the
7663     * arrow keys.
7664     *
7665     * @section Gengrid_Layouts Gengrid layouts
7666     *
7667     * Gengrids may layout its items in one of two possible layouts:
7668     * - horizontal or
7669     * - vertical.
7670     *
7671     * When in "horizontal mode", items will be placed in @b columns,
7672     * from top to bottom and, when the space for a column is filled,
7673     * another one is started on the right, thus expanding the grid
7674     * horizontally, making for horizontal scrolling. When in "vertical
7675     * mode" , though, items will be placed in @b rows, from left to
7676     * right and, when the space for a row is filled, another one is
7677     * started below, thus expanding the grid vertically (and making
7678     * for vertical scrolling).
7679     *
7680     * @section Gengrid_Items Gengrid items
7681     *
7682     * An item in a gengrid can have 0 or more text labels (they can be
7683     * regular text or textblock Evas objects - that's up to the style
7684     * to determine), 0 or more icons (which are simply objects
7685     * swallowed into the gengrid item's theming Edje object) and 0 or
7686     * more <b>boolean states</b>, which have the behavior left to the
7687     * user to define. The Edje part names for each of these properties
7688     * will be looked up, in the theme file for the gengrid, under the
7689     * Edje (string) data items named @c "labels", @c "icons" and @c
7690     * "states", respectively. For each of those properties, if more
7691     * than one part is provided, they must have names listed separated
7692     * by spaces in the data fields. For the default gengrid item
7693     * theme, we have @b one label part (@c "elm.text"), @b two icon
7694     * parts (@c "elm.swalllow.icon" and @c "elm.swallow.end") and @b
7695     * no state parts.
7696     *
7697     * A gengrid item may be at one of several styles. Elementary
7698     * provides one by default - "default", but this can be extended by
7699     * system or application custom themes/overlays/extensions (see
7700     * @ref Theme "themes" for more details).
7701     *
7702     * @section Gengrid_Item_Class Gengrid item classes
7703     *
7704     * In order to have the ability to add and delete items on the fly,
7705     * gengrid implements a class (callback) system where the
7706     * application provides a structure with information about that
7707     * type of item (gengrid may contain multiple different items with
7708     * different classes, states and styles). Gengrid will call the
7709     * functions in this struct (methods) when an item is "realized"
7710     * (i.e., created dynamically, while the user is scrolling the
7711     * grid). All objects will simply be deleted when no longer needed
7712     * with evas_object_del(). The #Elm_GenGrid_Item_Class structure
7713     * contains the following members:
7714     * - @c item_style - This is a constant string and simply defines
7715     * the name of the item style. It @b must be specified and the
7716     * default should be @c "default".
7717     * - @c func.label_get - This function is called when an item
7718     * object is actually created. The @c data parameter will point to
7719     * the same data passed to elm_gengrid_item_append() and related
7720     * item creation functions. The @c obj parameter is the gengrid
7721     * object itself, while the @c part one is the name string of one
7722     * of the existing text parts in the Edje group implementing the
7723     * item's theme. This function @b must return a strdup'()ed string,
7724     * as the caller will free() it when done. See
7725     * #Elm_Gengrid_Item_Label_Get_Cb.
7726     * - @c func.icon_get - This function is called when an item object
7727     * is actually created. The @c data parameter will point to the
7728     * same data passed to elm_gengrid_item_append() and related item
7729     * creation functions. The @c obj parameter is the gengrid object
7730     * itself, while the @c part one is the name string of one of the
7731     * existing (icon) swallow parts in the Edje group implementing the
7732     * item's theme. It must return @c NULL, when no icon is desired,
7733     * or a valid object handle, otherwise. The object will be deleted
7734     * by the gengrid on its deletion or when the item is "unrealized".
7735     * See #Elm_Gengrid_Item_Icon_Get_Cb.
7736     * - @c func.state_get - This function is called when an item
7737     * object is actually created. The @c data parameter will point to
7738     * the same data passed to elm_gengrid_item_append() and related
7739     * item creation functions. The @c obj parameter is the gengrid
7740     * object itself, while the @c part one is the name string of one
7741     * of the state parts in the Edje group implementing the item's
7742     * theme. Return @c EINA_FALSE for false/off or @c EINA_TRUE for
7743     * true/on. Gengrids will emit a signal to its theming Edje object
7744     * with @c "elm,state,XXX,active" and @c "elm" as "emission" and
7745     * "source" arguments, respectively, when the state is true (the
7746     * default is false), where @c XXX is the name of the (state) part.
7747     * See #Elm_Gengrid_Item_State_Get_Cb.
7748     * - @c func.del - This is called when elm_gengrid_item_del() is
7749     * called on an item or elm_gengrid_clear() is called on the
7750     * gengrid. This is intended for use when gengrid items are
7751     * deleted, so any data attached to the item (e.g. its data
7752     * parameter on creation) can be deleted. See #Elm_Gengrid_Item_Del_Cb.
7753     *
7754     * @section Gengrid_Usage_Hints Usage hints
7755     *
7756     * If the user wants to have multiple items selected at the same
7757     * time, elm_gengrid_multi_select_set() will permit it. If the
7758     * gengrid is single-selection only (the default), then
7759     * elm_gengrid_select_item_get() will return the selected item or
7760     * @c NULL, if none is selected. If the gengrid is under
7761     * multi-selection, then elm_gengrid_selected_items_get() will
7762     * return a list (that is only valid as long as no items are
7763     * modified (added, deleted, selected or unselected) of child items
7764     * on a gengrid.
7765     *
7766     * If an item changes (internal (boolean) state, label or icon
7767     * changes), then use elm_gengrid_item_update() to have gengrid
7768     * update the item with the new state. A gengrid will re-"realize"
7769     * the item, thus calling the functions in the
7770     * #Elm_Gengrid_Item_Class set for that item.
7771     *
7772     * To programmatically (un)select an item, use
7773     * elm_gengrid_item_selected_set(). To get its selected state use
7774     * elm_gengrid_item_selected_get(). To make an item disabled
7775     * (unable to be selected and appear differently) use
7776     * elm_gengrid_item_disabled_set() to set this and
7777     * elm_gengrid_item_disabled_get() to get the disabled state.
7778     *
7779     * Grid cells will only have their selection smart callbacks called
7780     * when firstly getting selected. Any further clicks will do
7781     * nothing, unless you enable the "always select mode", with
7782     * elm_gengrid_always_select_mode_set(), thus making every click to
7783     * issue selection callbacks. elm_gengrid_no_select_mode_set() will
7784     * turn off the ability to select items entirely in the widget and
7785     * they will neither appear selected nor call the selection smart
7786     * callbacks.
7787     *
7788     * Remember that you can create new styles and add your own theme
7789     * augmentation per application with elm_theme_extension_add(). If
7790     * you absolutely must have a specific style that overrides any
7791     * theme the user or system sets up you can use
7792     * elm_theme_overlay_add() to add such a file.
7793     *
7794     * @section Gengrid_Smart_Events Gengrid smart events
7795     *
7796     * Smart events that you can add callbacks for are:
7797     * - @c "activated" - The user has double-clicked or pressed
7798     *   (enter|return|spacebar) on an item. The @c event_info parameter
7799     *   is the gengrid item that was activated.
7800     * - @c "clicked,double" - The user has double-clicked an item.
7801     *   The @c event_info parameter is the gengrid item that was double-clicked.
7802     * - @c "selected" - The user has made an item selected. The
7803     *   @c event_info parameter is the gengrid item that was selected.
7804     * - @c "unselected" - The user has made an item unselected. The
7805     *   @c event_info parameter is the gengrid item that was unselected.
7806     * - @c "realized" - This is called when the item in the gengrid
7807     *   has its implementing Evas object instantiated, de facto. @c
7808     *   event_info is the gengrid item that was created. The object
7809     *   may be deleted at any time, so it is highly advised to the
7810     *   caller @b not to use the object pointer returned from
7811     *   elm_gengrid_item_object_get(), because it may point to freed
7812     *   objects.
7813     * - @c "unrealized" - This is called when the implementing Evas
7814     *   object for this item is deleted. @c event_info is the gengrid
7815     *   item that was deleted.
7816     * - @c "changed" - Called when an item is added, removed, resized
7817     *   or moved and when the gengrid is resized or gets "horizontal"
7818     *   property changes.
7819     * - @c "scroll,anim,start" - This is called when scrolling animation has
7820     *   started.
7821     * - @c "scroll,anim,stop" - This is called when scrolling animation has
7822     *   stopped.
7823     * - @c "drag,start,up" - Called when the item in the gengrid has
7824     *   been dragged (not scrolled) up.
7825     * - @c "drag,start,down" - Called when the item in the gengrid has
7826     *   been dragged (not scrolled) down.
7827     * - @c "drag,start,left" - Called when the item in the gengrid has
7828     *   been dragged (not scrolled) left.
7829     * - @c "drag,start,right" - Called when the item in the gengrid has
7830     *   been dragged (not scrolled) right.
7831     * - @c "drag,stop" - Called when the item in the gengrid has
7832     *   stopped being dragged.
7833     * - @c "drag" - Called when the item in the gengrid is being
7834     *   dragged.
7835     * - @c "scroll" - called when the content has been scrolled
7836     *   (moved).
7837     * - @c "scroll,drag,start" - called when dragging the content has
7838     *   started.
7839     * - @c "scroll,drag,stop" - called when dragging the content has
7840     *   stopped.
7841     *
7842     * List of gendrid examples:
7843     * @li @ref gengrid_example
7844     */
7845
7846    /**
7847     * @addtogroup Gengrid
7848     * @{
7849     */
7850
7851    typedef struct _Elm_Gengrid_Item_Class Elm_Gengrid_Item_Class; /**< Gengrid item class definition structs */
7852    typedef struct _Elm_Gengrid_Item_Class_Func Elm_Gengrid_Item_Class_Func; /**< Class functions for gengrid item classes. */
7853    typedef struct _Elm_Gengrid_Item Elm_Gengrid_Item; /**< Gengrid item handles */
7854    typedef char        *(*Elm_Gengrid_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for gengrid item classes. */
7855    typedef Evas_Object *(*Elm_Gengrid_Item_Icon_Get_Cb)  (void *data, Evas_Object *obj, const char *part); /**< Icon fetching class function for gengrid item classes. */
7856    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. */
7857    typedef void         (*Elm_Gengrid_Item_Del_Cb)      (void *data, Evas_Object *obj); /**< Deletion class function for gengrid item classes. */
7858
7859    typedef char        *(*GridItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Gengrid_Item_Label_Get_Cb. */
7860    typedef Evas_Object *(*GridItemIconGetFunc)  (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Gengrid_Item_Icon_Get_Cb. */
7861    typedef Eina_Bool    (*GridItemStateGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Gengrid_Item_State_Get_Cb. */
7862    typedef void         (*GridItemDelFunc)      (void *data, Evas_Object *obj) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Gengrid_Item_Del_Cb. */
7863
7864    /**
7865     * @struct _Elm_Gengrid_Item_Class
7866     *
7867     * Gengrid item class definition. See @ref Gengrid_Item_Class for
7868     * field details.
7869     */
7870    struct _Elm_Gengrid_Item_Class
7871      {
7872         const char             *item_style;
7873         struct _Elm_Gengrid_Item_Class_Func
7874           {
7875              Elm_Gengrid_Item_Label_Get_Cb label_get;
7876              Elm_Gengrid_Item_Icon_Get_Cb  icon_get;
7877              Elm_Gengrid_Item_State_Get_Cb state_get;
7878              Elm_Gengrid_Item_Del_Cb       del;
7879           } func;
7880      }; /**< #Elm_Gengrid_Item_Class member definitions */
7881
7882    /**
7883     * Add a new gengrid widget to the given parent Elementary
7884     * (container) object
7885     *
7886     * @param parent The parent object
7887     * @return a new gengrid widget handle or @c NULL, on errors
7888     *
7889     * This function inserts a new gengrid widget on the canvas.
7890     *
7891     * @see elm_gengrid_item_size_set()
7892     * @see elm_gengrid_horizontal_set()
7893     * @see elm_gengrid_item_append()
7894     * @see elm_gengrid_item_del()
7895     * @see elm_gengrid_clear()
7896     *
7897     * @ingroup Gengrid
7898     */
7899    EAPI Evas_Object       *elm_gengrid_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7900
7901    /**
7902     * Set the size for the items of a given gengrid widget
7903     *
7904     * @param obj The gengrid object.
7905     * @param w The items' width.
7906     * @param h The items' height;
7907     *
7908     * A gengrid, after creation, has still no information on the size
7909     * to give to each of its cells. So, you most probably will end up
7910     * with squares one @ref Fingers "finger" wide, the default
7911     * size. Use this function to force a custom size for you items,
7912     * making them as big as you wish.
7913     *
7914     * @see elm_gengrid_item_size_get()
7915     *
7916     * @ingroup Gengrid
7917     */
7918    EAPI void               elm_gengrid_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
7919
7920    /**
7921     * Get the size set for the items of a given gengrid widget
7922     *
7923     * @param obj The gengrid object.
7924     * @param w Pointer to a variable where to store the items' width.
7925     * @param h Pointer to a variable where to store the items' height.
7926     *
7927     * @note Use @c NULL pointers on the size values you're not
7928     * interested in: they'll be ignored by the function.
7929     *
7930     * @see elm_gengrid_item_size_get() for more details
7931     *
7932     * @ingroup Gengrid
7933     */
7934    EAPI void               elm_gengrid_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
7935
7936    /**
7937     * Set the items grid's alignment within a given gengrid widget
7938     *
7939     * @param obj The gengrid object.
7940     * @param align_x Alignment in the horizontal axis (0 <= align_x <= 1).
7941     * @param align_y Alignment in the vertical axis (0 <= align_y <= 1).
7942     *
7943     * This sets the alignment of the whole grid of items of a gengrid
7944     * within its given viewport. By default, those values are both
7945     * 0.5, meaning that the gengrid will have its items grid placed
7946     * exactly in the middle of its viewport.
7947     *
7948     * @note If given alignment values are out of the cited ranges,
7949     * they'll be changed to the nearest boundary values on the valid
7950     * ranges.
7951     *
7952     * @see elm_gengrid_align_get()
7953     *
7954     * @ingroup Gengrid
7955     */
7956    EAPI void               elm_gengrid_align_set(Evas_Object *obj, double align_x, double align_y) EINA_ARG_NONNULL(1);
7957
7958    /**
7959     * Get the items grid's alignment values within a given gengrid
7960     * widget
7961     *
7962     * @param obj The gengrid object.
7963     * @param align_x Pointer to a variable where to store the
7964     * horizontal alignment.
7965     * @param align_y Pointer to a variable where to store the vertical
7966     * alignment.
7967     *
7968     * @note Use @c NULL pointers on the alignment values you're not
7969     * interested in: they'll be ignored by the function.
7970     *
7971     * @see elm_gengrid_align_set() for more details
7972     *
7973     * @ingroup Gengrid
7974     */
7975    EAPI void               elm_gengrid_align_get(const Evas_Object *obj, double *align_x, double *align_y) EINA_ARG_NONNULL(1);
7976
7977    /**
7978     * Set whether a given gengrid widget is or not able have items
7979     * @b reordered
7980     *
7981     * @param obj The gengrid object
7982     * @param reorder_mode Use @c EINA_TRUE to turn reoderding on,
7983     * @c EINA_FALSE to turn it off
7984     *
7985     * If a gengrid is set to allow reordering, a click held for more
7986     * than 0.5 over a given item will highlight it specially,
7987     * signalling the gengrid has entered the reordering state. From
7988     * that time on, the user will be able to, while still holding the
7989     * mouse button down, move the item freely in the gengrid's
7990     * viewport, replacing to said item to the locations it goes to.
7991     * The replacements will be animated and, whenever the user
7992     * releases the mouse button, the item being replaced gets a new
7993     * definitive place in the grid.
7994     *
7995     * @see elm_gengrid_reorder_mode_get()
7996     *
7997     * @ingroup Gengrid
7998     */
7999    EAPI void               elm_gengrid_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
8000
8001    /**
8002     * Get whether a given gengrid widget is or not able have items
8003     * @b reordered
8004     *
8005     * @param obj The gengrid object
8006     * @return @c EINA_TRUE, if reoderding is on, @c EINA_FALSE if it's
8007     * off
8008     *
8009     * @see elm_gengrid_reorder_mode_set() for more details
8010     *
8011     * @ingroup Gengrid
8012     */
8013    EAPI Eina_Bool          elm_gengrid_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8014
8015    /**
8016     * Append a new item in a given gengrid widget.
8017     *
8018     * @param obj The gengrid object.
8019     * @param gic The item class for the item.
8020     * @param data The item data.
8021     * @param func Convenience function called when the item is
8022     * selected.
8023     * @param func_data Data to be passed to @p func.
8024     * @return A handle to the item added or @c NULL, on errors.
8025     *
8026     * This adds an item to the beginning of the gengrid.
8027     *
8028     * @see elm_gengrid_item_prepend()
8029     * @see elm_gengrid_item_insert_before()
8030     * @see elm_gengrid_item_insert_after()
8031     * @see elm_gengrid_item_del()
8032     *
8033     * @ingroup Gengrid
8034     */
8035    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);
8036
8037    /**
8038     * Prepend a new item in a given gengrid widget.
8039     *
8040     * @param obj The gengrid object.
8041     * @param gic The item class for the item.
8042     * @param data The item data.
8043     * @param func Convenience function called when the item is
8044     * selected.
8045     * @param func_data Data to be passed to @p func.
8046     * @return A handle to the item added or @c NULL, on errors.
8047     *
8048     * This adds an item to the end of the gengrid.
8049     *
8050     * @see elm_gengrid_item_append()
8051     * @see elm_gengrid_item_insert_before()
8052     * @see elm_gengrid_item_insert_after()
8053     * @see elm_gengrid_item_del()
8054     *
8055     * @ingroup Gengrid
8056     */
8057    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);
8058
8059    /**
8060     * Insert an item before another in a gengrid widget
8061     *
8062     * @param obj The gengrid object.
8063     * @param gic The item class for the item.
8064     * @param data The item data.
8065     * @param relative The item to place this new one before.
8066     * @param func Convenience function called when the item is
8067     * selected.
8068     * @param func_data Data to be passed to @p func.
8069     * @return A handle to the item added or @c NULL, on errors.
8070     *
8071     * This inserts an item before another in the gengrid.
8072     *
8073     * @see elm_gengrid_item_append()
8074     * @see elm_gengrid_item_prepend()
8075     * @see elm_gengrid_item_insert_after()
8076     * @see elm_gengrid_item_del()
8077     *
8078     * @ingroup Gengrid
8079     */
8080    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);
8081
8082    /**
8083     * Insert an item after another in a gengrid widget
8084     *
8085     * @param obj The gengrid object.
8086     * @param gic The item class for the item.
8087     * @param data The item data.
8088     * @param relative The item to place this new one after.
8089     * @param func Convenience function called when the item is
8090     * selected.
8091     * @param func_data Data to be passed to @p func.
8092     * @return A handle to the item added or @c NULL, on errors.
8093     *
8094     * This inserts an item after another in the gengrid.
8095     *
8096     * @see elm_gengrid_item_append()
8097     * @see elm_gengrid_item_prepend()
8098     * @see elm_gengrid_item_insert_after()
8099     * @see elm_gengrid_item_del()
8100     *
8101     * @ingroup Gengrid
8102     */
8103    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);
8104
8105    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);
8106
8107    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);
8108
8109    /**
8110     * Set whether items on a given gengrid widget are to get their
8111     * selection callbacks issued for @b every subsequent selection
8112     * click on them or just for the first click.
8113     *
8114     * @param obj The gengrid object
8115     * @param always_select @c EINA_TRUE to make items "always
8116     * selected", @c EINA_FALSE, otherwise
8117     *
8118     * By default, grid items will only call their selection callback
8119     * function when firstly getting selected, any subsequent further
8120     * clicks will do nothing. With this call, you make those
8121     * subsequent clicks also to issue the selection callbacks.
8122     *
8123     * @note <b>Double clicks</b> will @b always be reported on items.
8124     *
8125     * @see elm_gengrid_always_select_mode_get()
8126     *
8127     * @ingroup Gengrid
8128     */
8129    EAPI void               elm_gengrid_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
8130
8131    /**
8132     * Get whether items on a given gengrid widget have their selection
8133     * callbacks issued for @b every subsequent selection click on them
8134     * or just for the first click.
8135     *
8136     * @param obj The gengrid object.
8137     * @return @c EINA_TRUE if the gengrid items are "always selected",
8138     * @c EINA_FALSE, otherwise
8139     *
8140     * @see elm_gengrid_always_select_mode_set() for more details
8141     *
8142     * @ingroup Gengrid
8143     */
8144    EAPI Eina_Bool          elm_gengrid_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8145
8146    /**
8147     * Set whether items on a given gengrid widget can be selected or not.
8148     *
8149     * @param obj The gengrid object
8150     * @param no_select @c EINA_TRUE to make items selectable,
8151     * @c EINA_FALSE otherwise
8152     *
8153     * This will make items in @p obj selectable or not. In the latter
8154     * case, any user interacion on the gendrid items will neither make
8155     * them appear selected nor them call their selection callback
8156     * functions.
8157     *
8158     * @see elm_gengrid_no_select_mode_get()
8159     *
8160     * @ingroup Gengrid
8161     */
8162    EAPI void               elm_gengrid_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
8163
8164    /**
8165     * Get whether items on a given gengrid widget can be selected or
8166     * not.
8167     *
8168     * @param obj The gengrid object
8169     * @return @c EINA_TRUE, if items are selectable, @c EINA_FALSE
8170     * otherwise
8171     *
8172     * @see elm_gengrid_no_select_mode_set() for more details
8173     *
8174     * @ingroup Gengrid
8175     */
8176    EAPI Eina_Bool          elm_gengrid_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8177
8178    /**
8179     * Enable or disable multi-selection in a given gengrid widget
8180     *
8181     * @param obj The gengrid object.
8182     * @param multi @c EINA_TRUE, to enable multi-selection,
8183     * @c EINA_FALSE to disable it.
8184     *
8185     * Multi-selection is the ability for one to have @b more than one
8186     * item selected, on a given gengrid, simultaneously. When it is
8187     * enabled, a sequence of clicks on different items will make them
8188     * all selected, progressively. A click on an already selected item
8189     * will unselect it. If interecting via the keyboard,
8190     * multi-selection is enabled while holding the "Shift" key.
8191     *
8192     * @note By default, multi-selection is @b disabled on gengrids
8193     *
8194     * @see elm_gengrid_multi_select_get()
8195     *
8196     * @ingroup Gengrid
8197     */
8198    EAPI void               elm_gengrid_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
8199
8200    /**
8201     * Get whether multi-selection is enabled or disabled for a given
8202     * gengrid widget
8203     *
8204     * @param obj The gengrid object.
8205     * @return @c EINA_TRUE, if multi-selection is enabled, @c
8206     * EINA_FALSE otherwise
8207     *
8208     * @see elm_gengrid_multi_select_set() for more details
8209     *
8210     * @ingroup Gengrid
8211     */
8212    EAPI Eina_Bool          elm_gengrid_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8213
8214    /**
8215     * Enable or disable bouncing effect for a given gengrid widget
8216     *
8217     * @param obj The gengrid object
8218     * @param h_bounce @c EINA_TRUE, to enable @b horizontal bouncing,
8219     * @c EINA_FALSE to disable it
8220     * @param v_bounce @c EINA_TRUE, to enable @b vertical bouncing,
8221     * @c EINA_FALSE to disable it
8222     *
8223     * The bouncing effect occurs whenever one reaches the gengrid's
8224     * edge's while panning it -- it will scroll past its limits a
8225     * little bit and return to the edge again, in a animated for,
8226     * automatically.
8227     *
8228     * @note By default, gengrids have bouncing enabled on both axis
8229     *
8230     * @see elm_gengrid_bounce_get()
8231     *
8232     * @ingroup Gengrid
8233     */
8234    EAPI void               elm_gengrid_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
8235
8236    /**
8237     * Get whether bouncing effects are enabled or disabled, for a
8238     * given gengrid widget, on each axis
8239     *
8240     * @param obj The gengrid object
8241     * @param h_bounce Pointer to a variable where to store the
8242     * horizontal bouncing flag.
8243     * @param v_bounce Pointer to a variable where to store the
8244     * vertical bouncing flag.
8245     *
8246     * @see elm_gengrid_bounce_set() for more details
8247     *
8248     * @ingroup Gengrid
8249     */
8250    EAPI void               elm_gengrid_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
8251
8252    /**
8253     * Set a given gengrid widget's scrolling page size, relative to
8254     * its viewport size.
8255     *
8256     * @param obj The gengrid object
8257     * @param h_pagerel The horizontal page (relative) size
8258     * @param v_pagerel The vertical page (relative) size
8259     *
8260     * The gengrid's scroller is capable of binding scrolling by the
8261     * user to "pages". It means that, while scrolling and, specially
8262     * after releasing the mouse button, the grid will @b snap to the
8263     * nearest displaying page's area. When page sizes are set, the
8264     * grid's continuous content area is split into (equal) page sized
8265     * pieces.
8266     *
8267     * This function sets the size of a page <b>relatively to the
8268     * viewport dimensions</b> of the gengrid, for each axis. A value
8269     * @c 1.0 means "the exact viewport's size", in that axis, while @c
8270     * 0.0 turns paging off in that axis. Likewise, @c 0.5 means "half
8271     * a viewport". Sane usable values are, than, between @c 0.0 and @c
8272     * 1.0. Values beyond those will make it behave behave
8273     * inconsistently. If you only want one axis to snap to pages, use
8274     * the value @c 0.0 for the other one.
8275     *
8276     * There is a function setting page size values in @b absolute
8277     * values, too -- elm_gengrid_page_size_set(). Naturally, its use
8278     * is mutually exclusive to this one.
8279     *
8280     * @see elm_gengrid_page_relative_get()
8281     *
8282     * @ingroup Gengrid
8283     */
8284    EAPI void               elm_gengrid_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
8285
8286    /**
8287     * Get a given gengrid widget's scrolling page size, relative to
8288     * its viewport size.
8289     *
8290     * @param obj The gengrid object
8291     * @param h_pagerel Pointer to a variable where to store the
8292     * horizontal page (relative) size
8293     * @param v_pagerel Pointer to a variable where to store the
8294     * vertical page (relative) size
8295     *
8296     * @see elm_gengrid_page_relative_set() for more details
8297     *
8298     * @ingroup Gengrid
8299     */
8300    EAPI void               elm_gengrid_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel) EINA_ARG_NONNULL(1);
8301
8302    /**
8303     * Set a given gengrid widget's scrolling page size
8304     *
8305     * @param obj The gengrid object
8306     * @param h_pagerel The horizontal page size, in pixels
8307     * @param v_pagerel The vertical page size, in pixels
8308     *
8309     * The gengrid's scroller is capable of binding scrolling by the
8310     * user to "pages". It means that, while scrolling and, specially
8311     * after releasing the mouse button, the grid will @b snap to the
8312     * nearest displaying page's area. When page sizes are set, the
8313     * grid's continuous content area is split into (equal) page sized
8314     * pieces.
8315     *
8316     * This function sets the size of a page of the gengrid, in pixels,
8317     * for each axis. Sane usable values are, between @c 0 and the
8318     * dimensions of @p obj, for each axis. Values beyond those will
8319     * make it behave behave inconsistently. If you only want one axis
8320     * to snap to pages, use the value @c 0 for the other one.
8321     *
8322     * There is a function setting page size values in @b relative
8323     * values, too -- elm_gengrid_page_relative_set(). Naturally, its
8324     * use is mutually exclusive to this one.
8325     *
8326     * @ingroup Gengrid
8327     */
8328    EAPI void               elm_gengrid_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
8329
8330    /**
8331     * Set for what direction a given gengrid widget will expand while
8332     * placing its items.
8333     *
8334     * @param obj The gengrid object.
8335     * @param setting @c EINA_TRUE to make the gengrid expand
8336     * horizontally, @c EINA_FALSE to expand vertically.
8337     *
8338     * When in "horizontal mode" (@c EINA_TRUE), items will be placed
8339     * in @b columns, from top to bottom and, when the space for a
8340     * column is filled, another one is started on the right, thus
8341     * expanding the grid horizontally. When in "vertical mode"
8342     * (@c EINA_FALSE), though, items will be placed in @b rows, from left
8343     * to right and, when the space for a row is filled, another one is
8344     * started below, thus expanding the grid vertically.
8345     *
8346     * @see elm_gengrid_horizontal_get()
8347     *
8348     * @ingroup Gengrid
8349     */
8350    EAPI void               elm_gengrid_horizontal_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
8351
8352    /**
8353     * Get for what direction a given gengrid widget will expand while
8354     * placing its items.
8355     *
8356     * @param obj The gengrid object.
8357     * @return @c EINA_TRUE, if @p obj is set to expand horizontally,
8358     * @c EINA_FALSE if it's set to expand vertically.
8359     *
8360     * @see elm_gengrid_horizontal_set() for more detais
8361     *
8362     * @ingroup Gengrid
8363     */
8364    EAPI Eina_Bool          elm_gengrid_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8365
8366    /**
8367     * Get the first item in a given gengrid widget
8368     *
8369     * @param obj The gengrid object
8370     * @return The first item's handle or @c NULL, if there are no
8371     * items in @p obj (and on errors)
8372     *
8373     * This returns the first item in the @p obj's internal list of
8374     * items.
8375     *
8376     * @see elm_gengrid_last_item_get()
8377     *
8378     * @ingroup Gengrid
8379     */
8380    EAPI Elm_Gengrid_Item  *elm_gengrid_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8381
8382    /**
8383     * Get the last item in a given gengrid widget
8384     *
8385     * @param obj The gengrid object
8386     * @return The last item's handle or @c NULL, if there are no
8387     * items in @p obj (and on errors)
8388     *
8389     * This returns the last item in the @p obj's internal list of
8390     * items.
8391     *
8392     * @see elm_gengrid_first_item_get()
8393     *
8394     * @ingroup Gengrid
8395     */
8396    EAPI Elm_Gengrid_Item  *elm_gengrid_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8397
8398    /**
8399     * Get the @b next item in a gengrid widget's internal list of items,
8400     * given a handle to one of those items.
8401     *
8402     * @param item The gengrid item to fetch next from
8403     * @return The item after @p item, or @c NULL if there's none (and
8404     * on errors)
8405     *
8406     * This returns the item placed after the @p item, on the container
8407     * gengrid.
8408     *
8409     * @see elm_gengrid_item_prev_get()
8410     *
8411     * @ingroup Gengrid
8412     */
8413    EAPI Elm_Gengrid_Item  *elm_gengrid_item_next_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8414
8415    /**
8416     * Get the @b previous item in a gengrid widget's internal list of items,
8417     * given a handle to one of those items.
8418     *
8419     * @param item The gengrid item to fetch previous from
8420     * @return The item before @p item, or @c NULL if there's none (and
8421     * on errors)
8422     *
8423     * This returns the item placed before the @p item, on the container
8424     * gengrid.
8425     *
8426     * @see elm_gengrid_item_next_get()
8427     *
8428     * @ingroup Gengrid
8429     */
8430    EAPI Elm_Gengrid_Item  *elm_gengrid_item_prev_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8431
8432    /**
8433     * Get the gengrid object's handle which contains a given gengrid
8434     * item
8435     *
8436     * @param item The item to fetch the container from
8437     * @return The gengrid (parent) object
8438     *
8439     * This returns the gengrid object itself that an item belongs to.
8440     *
8441     * @ingroup Gengrid
8442     */
8443    EAPI Evas_Object       *elm_gengrid_item_gengrid_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8444
8445    /**
8446     * Remove a gengrid item from the its parent, deleting it.
8447     *
8448     * @param item The item to be removed.
8449     * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
8450     *
8451     * @see elm_gengrid_clear(), to remove all items in a gengrid at
8452     * once.
8453     *
8454     * @ingroup Gengrid
8455     */
8456    EAPI void               elm_gengrid_item_del(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8457
8458    /**
8459     * Update the contents of a given gengrid item
8460     *
8461     * @param item The gengrid item
8462     *
8463     * This updates an item by calling all the item class functions
8464     * again to get the icons, labels and states. Use this when the
8465     * original item data has changed and you want thta changes to be
8466     * reflected.
8467     *
8468     * @ingroup Gengrid
8469     */
8470    EAPI void               elm_gengrid_item_update(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8471    EAPI const Elm_Gengrid_Item_Class *elm_gengrid_item_item_class_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8472    EAPI void               elm_gengrid_item_item_class_set(Elm_Gengrid_Item *item, const Elm_Gengrid_Item_Class *gic) EINA_ARG_NONNULL(1, 2);
8473
8474    /**
8475     * Return the data associated to a given gengrid item
8476     *
8477     * @param item The gengrid item.
8478     * @return the data associated to this item.
8479     *
8480     * This returns the @c data value passed on the
8481     * elm_gengrid_item_append() and related item addition calls.
8482     *
8483     * @see elm_gengrid_item_append()
8484     * @see elm_gengrid_item_data_set()
8485     *
8486     * @ingroup Gengrid
8487     */
8488    EAPI void              *elm_gengrid_item_data_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8489
8490    /**
8491     * Set the data associated to a given gengrid item
8492     *
8493     * @param item The gengrid item
8494     * @param data The new data pointer to set on it
8495     *
8496     * This @b overrides the @c data value passed on the
8497     * elm_gengrid_item_append() and related item addition calls. This
8498     * function @b won't call elm_gengrid_item_update() automatically,
8499     * so you'd issue it afterwards if you want to hove the item
8500     * updated to reflect the that new data.
8501     *
8502     * @see elm_gengrid_item_data_get()
8503     *
8504     * @ingroup Gengrid
8505     */
8506    EAPI void               elm_gengrid_item_data_set(Elm_Gengrid_Item *item, const void *data) EINA_ARG_NONNULL(1);
8507
8508    /**
8509     * Get a given gengrid item's position, relative to the whole
8510     * gengrid's grid area.
8511     *
8512     * @param item The Gengrid item.
8513     * @param x Pointer to variable where to store the item's <b>row
8514     * number</b>.
8515     * @param y Pointer to variable where to store the item's <b>column
8516     * number</b>.
8517     *
8518     * This returns the "logical" position of the item whithin the
8519     * gengrid. For example, @c (0, 1) would stand for first row,
8520     * second column.
8521     *
8522     * @ingroup Gengrid
8523     */
8524    EAPI void               elm_gengrid_item_pos_get(const Elm_Gengrid_Item *item, unsigned int *x, unsigned int *y) EINA_ARG_NONNULL(1);
8525
8526    /**
8527     * Set whether a given gengrid item is selected or not
8528     *
8529     * @param item The gengrid item
8530     * @param selected Use @c EINA_TRUE, to make it selected, @c
8531     * EINA_FALSE to make it unselected
8532     *
8533     * This sets the selected state of an item. If multi selection is
8534     * not enabled on the containing gengrid and @p selected is @c
8535     * EINA_TRUE, any other previously selected items will get
8536     * unselected in favor of this new one.
8537     *
8538     * @see elm_gengrid_item_selected_get()
8539     *
8540     * @ingroup Gengrid
8541     */
8542    EAPI void               elm_gengrid_item_selected_set(Elm_Gengrid_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
8543
8544    /**
8545     * Get whether a given gengrid item is selected or not
8546     *
8547     * @param item The gengrid item
8548     * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
8549     *
8550     * @see elm_gengrid_item_selected_set() for more details
8551     *
8552     * @ingroup Gengrid
8553     */
8554    EAPI Eina_Bool          elm_gengrid_item_selected_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8555
8556    /**
8557     * Get the real Evas object created to implement the view of a
8558     * given gengrid item
8559     *
8560     * @param item The gengrid item.
8561     * @return the Evas object implementing this item's view.
8562     *
8563     * This returns the actual Evas object used to implement the
8564     * specified gengrid item's view. This may be @c NULL, as it may
8565     * not have been created or may have been deleted, at any time, by
8566     * the gengrid. <b>Do not modify this object</b> (move, resize,
8567     * show, hide, etc.), as the gengrid is controlling it. This
8568     * function is for querying, emitting custom signals or hooking
8569     * lower level callbacks for events on that object. Do not delete
8570     * this object under any circumstances.
8571     *
8572     * @see elm_gengrid_item_data_get()
8573     *
8574     * @ingroup Gengrid
8575     */
8576    EAPI const Evas_Object *elm_gengrid_item_object_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8577
8578    /**
8579     * Show the portion of a gengrid's internal grid containing a given
8580     * item, @b immediately.
8581     *
8582     * @param item The item to display
8583     *
8584     * This causes gengrid to @b redraw its viewport's contents to the
8585     * region contining the given @p item item, if it is not fully
8586     * visible.
8587     *
8588     * @see elm_gengrid_item_bring_in()
8589     *
8590     * @ingroup Gengrid
8591     */
8592    EAPI void               elm_gengrid_item_show(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8593
8594    /**
8595     * Animatedly bring in, to the visible are of a gengrid, a given
8596     * item on it.
8597     *
8598     * @param item The gengrid item to display
8599     *
8600     * This causes gengrig to jump to the given @p item item and show
8601     * it (by scrolling), if it is not fully visible. This will use
8602     * animation to do so and take a period of time to complete.
8603     *
8604     * @see elm_gengrid_item_show()
8605     *
8606     * @ingroup Gengrid
8607     */
8608    EAPI void               elm_gengrid_item_bring_in(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8609
8610    /**
8611     * Set whether a given gengrid item is disabled or not.
8612     *
8613     * @param item The gengrid item
8614     * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
8615     * to enable it back.
8616     *
8617     * A disabled item cannot be selected or unselected. It will also
8618     * change its appearance, to signal the user it's disabled.
8619     *
8620     * @see elm_gengrid_item_disabled_get()
8621     *
8622     * @ingroup Gengrid
8623     */
8624    EAPI void               elm_gengrid_item_disabled_set(Elm_Gengrid_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
8625
8626    /**
8627     * Get whether a given gengrid item is disabled or not.
8628     *
8629     * @param item The gengrid item
8630     * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
8631     * (and on errors).
8632     *
8633     * @see elm_gengrid_item_disabled_set() for more details
8634     *
8635     * @ingroup Gengrid
8636     */
8637    EAPI Eina_Bool          elm_gengrid_item_disabled_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8638
8639    /**
8640     * Set the text to be shown in a given gengrid item's tooltips.
8641     *
8642     * @param item The gengrid item
8643     * @param text The text to set in the content
8644     *
8645     * This call will setup the text to be used as tooltip to that item
8646     * (analogous to elm_object_tooltip_text_set(), but being item
8647     * tooltips with higher precedence than object tooltips). It can
8648     * have only one tooltip at a time, so any previous tooltip data
8649     * will get removed.
8650     *
8651     * @ingroup Gengrid
8652     */
8653    EAPI void               elm_gengrid_item_tooltip_text_set(Elm_Gengrid_Item *item, const char *text) EINA_ARG_NONNULL(1);
8654
8655    /**
8656     * Set the content to be shown in a given gengrid item's tooltips
8657     *
8658     * @param item The gengrid item.
8659     * @param func The function returning the tooltip contents.
8660     * @param data What to provide to @a func as callback data/context.
8661     * @param del_cb Called when data is not needed anymore, either when
8662     *        another callback replaces @p func, the tooltip is unset with
8663     *        elm_gengrid_item_tooltip_unset() or the owner @p item
8664     *        dies. This callback receives as its first parameter the
8665     *        given @p data, being @c event_info the item handle.
8666     *
8667     * This call will setup the tooltip's contents to @p item
8668     * (analogous to elm_object_tooltip_content_cb_set(), but being
8669     * item tooltips with higher precedence than object tooltips). It
8670     * can have only one tooltip at a time, so any previous tooltip
8671     * content will get removed. @p func (with @p data) will be called
8672     * every time Elementary needs to show the tooltip and it should
8673     * return a valid Evas object, which will be fully managed by the
8674     * tooltip system, getting deleted when the tooltip is gone.
8675     *
8676     * @ingroup Gengrid
8677     */
8678    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);
8679
8680    /**
8681     * Unset a tooltip from a given gengrid item
8682     *
8683     * @param item gengrid item to remove a previously set tooltip from.
8684     *
8685     * This call removes any tooltip set on @p item. The callback
8686     * provided as @c del_cb to
8687     * elm_gengrid_item_tooltip_content_cb_set() will be called to
8688     * notify it is not used anymore (and have resources cleaned, if
8689     * need be).
8690     *
8691     * @see elm_gengrid_item_tooltip_content_cb_set()
8692     *
8693     * @ingroup Gengrid
8694     */
8695    EAPI void               elm_gengrid_item_tooltip_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8696
8697    /**
8698     * Set a different @b style for a given gengrid item's tooltip.
8699     *
8700     * @param item gengrid item with tooltip set
8701     * @param style the <b>theme style</b> to use on tooltips (e.g. @c
8702     * "default", @c "transparent", etc)
8703     *
8704     * Tooltips can have <b>alternate styles</b> to be displayed on,
8705     * which are defined by the theme set on Elementary. This function
8706     * works analogously as elm_object_tooltip_style_set(), but here
8707     * applied only to gengrid item objects. The default style for
8708     * tooltips is @c "default".
8709     *
8710     * @note before you set a style you should define a tooltip with
8711     *       elm_gengrid_item_tooltip_content_cb_set() or
8712     *       elm_gengrid_item_tooltip_text_set()
8713     *
8714     * @see elm_gengrid_item_tooltip_style_get()
8715     *
8716     * @ingroup Gengrid
8717     */
8718    EAPI void               elm_gengrid_item_tooltip_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
8719
8720    /**
8721     * Get the style set a given gengrid item's tooltip.
8722     *
8723     * @param item gengrid item with tooltip already set on.
8724     * @return style the theme style in use, which defaults to
8725     *         "default". If the object does not have a tooltip set,
8726     *         then @c NULL is returned.
8727     *
8728     * @see elm_gengrid_item_tooltip_style_set() for more details
8729     *
8730     * @ingroup Gengrid
8731     */
8732    EAPI const char        *elm_gengrid_item_tooltip_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8733    /**
8734     * @brief Disable size restrictions on an object's tooltip
8735     * @param item The tooltip's anchor object
8736     * @param disable If EINA_TRUE, size restrictions are disabled
8737     * @return EINA_FALSE on failure, EINA_TRUE on success
8738     *
8739     * This function allows a tooltip to expand beyond its parant window's canvas.
8740     * It will instead be limited only by the size of the display.
8741     */
8742    EAPI Eina_Bool          elm_gengrid_item_tooltip_size_restrict_disable(Elm_Gengrid_Item *item, Eina_Bool disable);
8743    /**
8744     * @brief Retrieve size restriction state of an object's tooltip
8745     * @param item The tooltip's anchor object
8746     * @return If EINA_TRUE, size restrictions are disabled
8747     *
8748     * This function returns whether a tooltip is allowed to expand beyond
8749     * its parant window's canvas.
8750     * It will instead be limited only by the size of the display.
8751     */
8752    EAPI Eina_Bool          elm_gengrid_item_tooltip_size_restrict_disabled_get(const Elm_Gengrid_Item *item);
8753    /**
8754     * Set the type of mouse pointer/cursor decoration to be shown,
8755     * when the mouse pointer is over the given gengrid widget item
8756     *
8757     * @param item gengrid item to customize cursor on
8758     * @param cursor the cursor type's name
8759     *
8760     * This function works analogously as elm_object_cursor_set(), but
8761     * here the cursor's changing area is restricted to the item's
8762     * area, and not the whole widget's. Note that that item cursors
8763     * have precedence over widget cursors, so that a mouse over @p
8764     * item will always show cursor @p type.
8765     *
8766     * If this function is called twice for an object, a previously set
8767     * cursor will be unset on the second call.
8768     *
8769     * @see elm_object_cursor_set()
8770     * @see elm_gengrid_item_cursor_get()
8771     * @see elm_gengrid_item_cursor_unset()
8772     *
8773     * @ingroup Gengrid
8774     */
8775    EAPI void               elm_gengrid_item_cursor_set(Elm_Gengrid_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
8776
8777    /**
8778     * Get the type of mouse pointer/cursor decoration set to be shown,
8779     * when the mouse pointer is over the given gengrid widget item
8780     *
8781     * @param item gengrid item with custom cursor set
8782     * @return the cursor type's name or @c NULL, if no custom cursors
8783     * were set to @p item (and on errors)
8784     *
8785     * @see elm_object_cursor_get()
8786     * @see elm_gengrid_item_cursor_set() for more details
8787     * @see elm_gengrid_item_cursor_unset()
8788     *
8789     * @ingroup Gengrid
8790     */
8791    EAPI const char        *elm_gengrid_item_cursor_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8792
8793    /**
8794     * Unset any custom mouse pointer/cursor decoration set to be
8795     * shown, when the mouse pointer is over the given gengrid widget
8796     * item, thus making it show the @b default cursor again.
8797     *
8798     * @param item a gengrid item
8799     *
8800     * Use this call to undo any custom settings on this item's cursor
8801     * decoration, bringing it back to defaults (no custom style set).
8802     *
8803     * @see elm_object_cursor_unset()
8804     * @see elm_gengrid_item_cursor_set() for more details
8805     *
8806     * @ingroup Gengrid
8807     */
8808    EAPI void               elm_gengrid_item_cursor_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8809
8810    /**
8811     * Set a different @b style for a given custom cursor set for a
8812     * gengrid item.
8813     *
8814     * @param item gengrid item with custom cursor set
8815     * @param style the <b>theme style</b> to use (e.g. @c "default",
8816     * @c "transparent", etc)
8817     *
8818     * This function only makes sense when one is using custom mouse
8819     * cursor decorations <b>defined in a theme file</b> , which can
8820     * have, given a cursor name/type, <b>alternate styles</b> on
8821     * it. It works analogously as elm_object_cursor_style_set(), but
8822     * here applied only to gengrid item objects.
8823     *
8824     * @warning Before you set a cursor style you should have defined a
8825     *       custom cursor previously on the item, with
8826     *       elm_gengrid_item_cursor_set()
8827     *
8828     * @see elm_gengrid_item_cursor_engine_only_set()
8829     * @see elm_gengrid_item_cursor_style_get()
8830     *
8831     * @ingroup Gengrid
8832     */
8833    EAPI void               elm_gengrid_item_cursor_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
8834
8835    /**
8836     * Get the current @b style set for a given gengrid item's custom
8837     * cursor
8838     *
8839     * @param item gengrid item with custom cursor set.
8840     * @return style the cursor style in use. If the object does not
8841     *         have a cursor set, then @c NULL is returned.
8842     *
8843     * @see elm_gengrid_item_cursor_style_set() for more details
8844     *
8845     * @ingroup Gengrid
8846     */
8847    EAPI const char        *elm_gengrid_item_cursor_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8848
8849    /**
8850     * Set if the (custom) cursor for a given gengrid item should be
8851     * searched in its theme, also, or should only rely on the
8852     * rendering engine.
8853     *
8854     * @param item item with custom (custom) cursor already set on
8855     * @param engine_only Use @c EINA_TRUE to have cursors looked for
8856     * only on those provided by the rendering engine, @c EINA_FALSE to
8857     * have them searched on the widget's theme, as well.
8858     *
8859     * @note This call is of use only if you've set a custom cursor
8860     * for gengrid items, with elm_gengrid_item_cursor_set().
8861     *
8862     * @note By default, cursors will only be looked for between those
8863     * provided by the rendering engine.
8864     *
8865     * @ingroup Gengrid
8866     */
8867    EAPI void               elm_gengrid_item_cursor_engine_only_set(Elm_Gengrid_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
8868
8869    /**
8870     * Get if the (custom) cursor for a given gengrid item is being
8871     * searched in its theme, also, or is only relying on the rendering
8872     * engine.
8873     *
8874     * @param item a gengrid item
8875     * @return @c EINA_TRUE, if cursors are being looked for only on
8876     * those provided by the rendering engine, @c EINA_FALSE if they
8877     * are being searched on the widget's theme, as well.
8878     *
8879     * @see elm_gengrid_item_cursor_engine_only_set(), for more details
8880     *
8881     * @ingroup Gengrid
8882     */
8883    EAPI Eina_Bool          elm_gengrid_item_cursor_engine_only_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8884
8885    /**
8886     * Remove all items from a given gengrid widget
8887     *
8888     * @param obj The gengrid object.
8889     *
8890     * This removes (and deletes) all items in @p obj, leaving it
8891     * empty.
8892     *
8893     * @see elm_gengrid_item_del(), to remove just one item.
8894     *
8895     * @ingroup Gengrid
8896     */
8897    EAPI void               elm_gengrid_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
8898
8899    /**
8900     * Get the selected item in a given gengrid widget
8901     *
8902     * @param obj The gengrid object.
8903     * @return The selected item's handleor @c NULL, if none is
8904     * selected at the moment (and on errors)
8905     *
8906     * This returns the selected item in @p obj. If multi selection is
8907     * enabled on @p obj (@see elm_gengrid_multi_select_set()), only
8908     * the first item in the list is selected, which might not be very
8909     * useful. For that case, see elm_gengrid_selected_items_get().
8910     *
8911     * @ingroup Gengrid
8912     */
8913    EAPI Elm_Gengrid_Item  *elm_gengrid_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8914
8915    /**
8916     * Get <b>a list</b> of selected items in a given gengrid
8917     *
8918     * @param obj The gengrid object.
8919     * @return The list of selected items or @c NULL, if none is
8920     * selected at the moment (and on errors)
8921     *
8922     * This returns a list of the selected items, in the order that
8923     * they appear in the grid. This list is only valid as long as no
8924     * more items are selected or unselected (or unselected implictly
8925     * by deletion). The list contains #Elm_Gengrid_Item pointers as
8926     * data, naturally.
8927     *
8928     * @see elm_gengrid_selected_item_get()
8929     *
8930     * @ingroup Gengrid
8931     */
8932    EAPI const Eina_List   *elm_gengrid_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8933
8934    /**
8935     * @}
8936     */
8937
8938    /**
8939     * @defgroup Clock Clock
8940     *
8941     * @image html img/widget/clock/preview-00.png
8942     * @image latex img/widget/clock/preview-00.eps
8943     *
8944     * This is a @b digital clock widget. In its default theme, it has a
8945     * vintage "flipping numbers clock" appearance, which will animate
8946     * sheets of individual algarisms individually as time goes by.
8947     *
8948     * A newly created clock will fetch system's time (already
8949     * considering local time adjustments) to start with, and will tick
8950     * accondingly. It may or may not show seconds.
8951     *
8952     * Clocks have an @b edition mode. When in it, the sheets will
8953     * display extra arrow indications on the top and bottom and the
8954     * user may click on them to raise or lower the time values. After
8955     * it's told to exit edition mode, it will keep ticking with that
8956     * new time set (it keeps the difference from local time).
8957     *
8958     * Also, when under edition mode, user clicks on the cited arrows
8959     * which are @b held for some time will make the clock to flip the
8960     * sheet, thus editing the time, continuosly and automatically for
8961     * the user. The interval between sheet flips will keep growing in
8962     * time, so that it helps the user to reach a time which is distant
8963     * from the one set.
8964     *
8965     * The time display is, by default, in military mode (24h), but an
8966     * am/pm indicator may be optionally shown, too, when it will
8967     * switch to 12h.
8968     *
8969     * Smart callbacks one can register to:
8970     * - "changed" - the clock's user changed the time
8971     *
8972     * Here is an example on its usage:
8973     * @li @ref clock_example
8974     */
8975
8976    /**
8977     * @addtogroup Clock
8978     * @{
8979     */
8980
8981    /**
8982     * Identifiers for which clock digits should be editable, when a
8983     * clock widget is in edition mode. Values may be ORed together to
8984     * make a mask, naturally.
8985     *
8986     * @see elm_clock_edit_set()
8987     * @see elm_clock_digit_edit_set()
8988     */
8989    typedef enum _Elm_Clock_Digedit
8990      {
8991         ELM_CLOCK_NONE         = 0, /**< Default value. Means that all digits are editable, when in edition mode. */
8992         ELM_CLOCK_HOUR_DECIMAL = 1 << 0, /**< Decimal algarism of hours value should be editable */
8993         ELM_CLOCK_HOUR_UNIT    = 1 << 1, /**< Unit algarism of hours value should be editable */
8994         ELM_CLOCK_MIN_DECIMAL  = 1 << 2, /**< Decimal algarism of minutes value should be editable */
8995         ELM_CLOCK_MIN_UNIT     = 1 << 3, /**< Unit algarism of minutes value should be editable */
8996         ELM_CLOCK_SEC_DECIMAL  = 1 << 4, /**< Decimal algarism of seconds value should be editable */
8997         ELM_CLOCK_SEC_UNIT     = 1 << 5, /**< Unit algarism of seconds value should be editable */
8998         ELM_CLOCK_ALL          = (1 << 6) - 1 /**< All digits should be editable */
8999      } Elm_Clock_Digedit;
9000
9001    /**
9002     * Add a new clock widget to the given parent Elementary
9003     * (container) object
9004     *
9005     * @param parent The parent object
9006     * @return a new clock widget handle or @c NULL, on errors
9007     *
9008     * This function inserts a new clock widget on the canvas.
9009     *
9010     * @ingroup Clock
9011     */
9012    EAPI Evas_Object      *elm_clock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9013
9014    /**
9015     * Set a clock widget's time, programmatically
9016     *
9017     * @param obj The clock widget object
9018     * @param hrs The hours to set
9019     * @param min The minutes to set
9020     * @param sec The secondes to set
9021     *
9022     * This function updates the time that is showed by the clock
9023     * widget.
9024     *
9025     *  Values @b must be set within the following ranges:
9026     * - 0 - 23, for hours
9027     * - 0 - 59, for minutes
9028     * - 0 - 59, for seconds,
9029     *
9030     * even if the clock is not in "military" mode.
9031     *
9032     * @warning The behavior for values set out of those ranges is @b
9033     * indefined.
9034     *
9035     * @ingroup Clock
9036     */
9037    EAPI void              elm_clock_time_set(Evas_Object *obj, int hrs, int min, int sec) EINA_ARG_NONNULL(1);
9038
9039    /**
9040     * Get a clock widget's time values
9041     *
9042     * @param obj The clock object
9043     * @param[out] hrs Pointer to the variable to get the hours value
9044     * @param[out] min Pointer to the variable to get the minutes value
9045     * @param[out] sec Pointer to the variable to get the seconds value
9046     *
9047     * This function gets the time set for @p obj, returning
9048     * it on the variables passed as the arguments to function
9049     *
9050     * @note Use @c NULL pointers on the time values you're not
9051     * interested in: they'll be ignored by the function.
9052     *
9053     * @ingroup Clock
9054     */
9055    EAPI void              elm_clock_time_get(const Evas_Object *obj, int *hrs, int *min, int *sec) EINA_ARG_NONNULL(1);
9056
9057    /**
9058     * Set whether a given clock widget is under <b>edition mode</b> or
9059     * under (default) displaying-only mode.
9060     *
9061     * @param obj The clock object
9062     * @param edit @c EINA_TRUE to put it in edition, @c EINA_FALSE to
9063     * put it back to "displaying only" mode
9064     *
9065     * This function makes a clock's time to be editable or not <b>by
9066     * user interaction</b>. When in edition mode, clocks @b stop
9067     * ticking, until one brings them back to canonical mode. The
9068     * elm_clock_digit_edit_set() function will influence which digits
9069     * of the clock will be editable. By default, all of them will be
9070     * (#ELM_CLOCK_NONE).
9071     *
9072     * @note am/pm sheets, if being shown, will @b always be editable
9073     * under edition mode.
9074     *
9075     * @see elm_clock_edit_get()
9076     *
9077     * @ingroup Clock
9078     */
9079    EAPI void              elm_clock_edit_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
9080
9081    /**
9082     * Retrieve whether a given clock widget is under <b>edition
9083     * mode</b> or under (default) displaying-only mode.
9084     *
9085     * @param obj The clock object
9086     * @param edit @c EINA_TRUE, if it's in edition mode, @c EINA_FALSE
9087     * otherwise
9088     *
9089     * This function retrieves whether the clock's time can be edited
9090     * or not by user interaction.
9091     *
9092     * @see elm_clock_edit_set() for more details
9093     *
9094     * @ingroup Clock
9095     */
9096    EAPI Eina_Bool         elm_clock_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9097
9098    /**
9099     * Set what digits of the given clock widget should be editable
9100     * when in edition mode.
9101     *
9102     * @param obj The clock object
9103     * @param digedit Bit mask indicating the digits to be editable
9104     * (values in #Elm_Clock_Digedit).
9105     *
9106     * If the @p digedit param is #ELM_CLOCK_NONE, editing will be
9107     * disabled on @p obj (same effect as elm_clock_edit_set(), with @c
9108     * EINA_FALSE).
9109     *
9110     * @see elm_clock_digit_edit_get()
9111     *
9112     * @ingroup Clock
9113     */
9114    EAPI void              elm_clock_digit_edit_set(Evas_Object *obj, Elm_Clock_Digedit digedit) EINA_ARG_NONNULL(1);
9115
9116    /**
9117     * Retrieve what digits of the given clock widget should be
9118     * editable when in edition mode.
9119     *
9120     * @param obj The clock object
9121     * @return Bit mask indicating the digits to be editable
9122     * (values in #Elm_Clock_Digedit).
9123     *
9124     * @see elm_clock_digit_edit_set() for more details
9125     *
9126     * @ingroup Clock
9127     */
9128    EAPI Elm_Clock_Digedit elm_clock_digit_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9129
9130    /**
9131     * Set if the given clock widget must show hours in military or
9132     * am/pm mode
9133     *
9134     * @param obj The clock object
9135     * @param am_pm @c EINA_TRUE to put it in am/pm mode, @c EINA_FALSE
9136     * to military mode
9137     *
9138     * This function sets if the clock must show hours in military or
9139     * am/pm mode. In some countries like Brazil the military mode
9140     * (00-24h-format) is used, in opposition to the USA, where the
9141     * am/pm mode is more commonly used.
9142     *
9143     * @see elm_clock_show_am_pm_get()
9144     *
9145     * @ingroup Clock
9146     */
9147    EAPI void              elm_clock_show_am_pm_set(Evas_Object *obj, Eina_Bool am_pm) EINA_ARG_NONNULL(1);
9148
9149    /**
9150     * Get if the given clock widget shows hours in military or am/pm
9151     * mode
9152     *
9153     * @param obj The clock object
9154     * @return @c EINA_TRUE, if in am/pm mode, @c EINA_FALSE if in
9155     * military
9156     *
9157     * This function gets if the clock shows hours in military or am/pm
9158     * mode.
9159     *
9160     * @see elm_clock_show_am_pm_set() for more details
9161     *
9162     * @ingroup Clock
9163     */
9164    EAPI Eina_Bool         elm_clock_show_am_pm_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9165
9166    /**
9167     * Set if the given clock widget must show time with seconds or not
9168     *
9169     * @param obj The clock object
9170     * @param seconds @c EINA_TRUE to show seconds, @c EINA_FALSE otherwise
9171     *
9172     * This function sets if the given clock must show or not elapsed
9173     * seconds. By default, they are @b not shown.
9174     *
9175     * @see elm_clock_show_seconds_get()
9176     *
9177     * @ingroup Clock
9178     */
9179    EAPI void              elm_clock_show_seconds_set(Evas_Object *obj, Eina_Bool seconds) EINA_ARG_NONNULL(1);
9180
9181    /**
9182     * Get whether the given clock widget is showing time with seconds
9183     * or not
9184     *
9185     * @param obj The clock object
9186     * @return @c EINA_TRUE if it's showing seconds, @c EINA_FALSE otherwise
9187     *
9188     * This function gets whether @p obj is showing or not the elapsed
9189     * seconds.
9190     *
9191     * @see elm_clock_show_seconds_set()
9192     *
9193     * @ingroup Clock
9194     */
9195    EAPI Eina_Bool         elm_clock_show_seconds_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9196
9197    /**
9198     * Set the interval on time updates for an user mouse button hold
9199     * on clock widgets' time edition.
9200     *
9201     * @param obj The clock object
9202     * @param interval The (first) interval value in seconds
9203     *
9204     * This interval value is @b decreased while the user holds the
9205     * mouse pointer either incrementing or decrementing a given the
9206     * clock digit's value.
9207     *
9208     * This helps the user to get to a given time distant from the
9209     * current one easier/faster, as it will start to flip quicker and
9210     * quicker on mouse button holds.
9211     *
9212     * The calculation for the next flip interval value, starting from
9213     * the one set with this call, is the previous interval divided by
9214     * 1.05, so it decreases a little bit.
9215     *
9216     * The default starting interval value for automatic flips is
9217     * @b 0.85 seconds.
9218     *
9219     * @see elm_clock_interval_get()
9220     *
9221     * @ingroup Clock
9222     */
9223    EAPI void              elm_clock_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
9224
9225    /**
9226     * Get the interval on time updates for an user mouse button hold
9227     * on clock widgets' time edition.
9228     *
9229     * @param obj The clock object
9230     * @return The (first) interval value, in seconds, set on it
9231     *
9232     * @see elm_clock_interval_set() for more details
9233     *
9234     * @ingroup Clock
9235     */
9236    EAPI double            elm_clock_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9237
9238    /**
9239     * @}
9240     */
9241
9242    /**
9243     * @defgroup Layout Layout
9244     *
9245     * @image html img/widget/layout/preview-00.png
9246     * @image latex img/widget/layout/preview-00.eps width=\textwidth
9247     *
9248     * @image html img/layout-predefined.png
9249     * @image latex img/layout-predefined.eps width=\textwidth
9250     *
9251     * This is a container widget that takes a standard Edje design file and
9252     * wraps it very thinly in a widget.
9253     *
9254     * An Edje design (theme) file has a very wide range of possibilities to
9255     * describe the behavior of elements added to the Layout. Check out the Edje
9256     * documentation and the EDC reference to get more information about what can
9257     * be done with Edje.
9258     *
9259     * Just like @ref List, @ref Box, and other container widgets, any
9260     * object added to the Layout will become its child, meaning that it will be
9261     * deleted if the Layout is deleted, move if the Layout is moved, and so on.
9262     *
9263     * The Layout widget can contain as many Contents, Boxes or Tables as
9264     * described in its theme file. For instance, objects can be added to
9265     * different Tables by specifying the respective Table part names. The same
9266     * is valid for Content and Box.
9267     *
9268     * The objects added as child of the Layout will behave as described in the
9269     * part description where they were added. There are 3 possible types of
9270     * parts where a child can be added:
9271     *
9272     * @section secContent Content (SWALLOW part)
9273     *
9274     * Only one object can be added to the @c SWALLOW part (but you still can
9275     * have many @c SWALLOW parts and one object on each of them). Use the @c
9276     * elm_layout_content_* set of functions to set, retrieve and unset objects
9277     * as content of the @c SWALLOW. After being set to this part, the object
9278     * size, position, visibility, clipping and other description properties
9279     * will be totally controled by the description of the given part (inside
9280     * the Edje theme file).
9281     *
9282     * One can use @c evas_object_size_hint_* functions on the child to have some
9283     * kind of control over its behavior, but the resulting behavior will still
9284     * depend heavily on the @c SWALLOW part description.
9285     *
9286     * The Edje theme also can change the part description, based on signals or
9287     * scripts running inside the theme. This change can also be animated. All of
9288     * this will affect the child object set as content accordingly. The object
9289     * size will be changed if the part size is changed, it will animate move if
9290     * the part is moving, and so on.
9291     *
9292     * The following picture demonstrates a Layout widget with a child object
9293     * added to its @c SWALLOW:
9294     *
9295     * @image html layout_swallow.png
9296     * @image latex layout_swallow.eps width=\textwidth
9297     *
9298     * @section secBox Box (BOX part)
9299     *
9300     * An Edje @c BOX part is very similar to the Elementary @ref Box widget. It
9301     * allows one to add objects to the box and have them distributed along its
9302     * area, accordingly to the specified @a layout property (now by @a layout we
9303     * mean the chosen layouting design of the Box, not the Layout widget
9304     * itself).
9305     *
9306     * A similar effect for having a box with its position, size and other things
9307     * controled by the Layout theme would be to create an Elementary @ref Box
9308     * widget and add it as a Content in the @c SWALLOW part.
9309     *
9310     * The main difference of using the Layout Box is that its behavior, the box
9311     * properties like layouting format, padding, align, etc. will be all
9312     * controled by the theme. This means, for example, that a signal could be
9313     * sent to the Layout theme (with elm_object_signal_emit()) and the theme
9314     * handled the signal by changing the box padding, or align, or both. Using
9315     * the Elementary @ref Box widget is not necessarily harder or easier, it
9316     * just depends on the circunstances and requirements.
9317     *
9318     * The Layout Box can be used through the @c elm_layout_box_* set of
9319     * functions.
9320     *
9321     * The following picture demonstrates a Layout widget with many child objects
9322     * added to its @c BOX part:
9323     *
9324     * @image html layout_box.png
9325     * @image latex layout_box.eps width=\textwidth
9326     *
9327     * @section secTable Table (TABLE part)
9328     *
9329     * Just like the @ref secBox, the Layout Table is very similar to the
9330     * Elementary @ref Table widget. It allows one to add objects to the Table
9331     * specifying the row and column where the object should be added, and any
9332     * column or row span if necessary.
9333     *
9334     * Again, we could have this design by adding a @ref Table widget to the @c
9335     * SWALLOW part using elm_layout_content_set(). The same difference happens
9336     * here when choosing to use the Layout Table (a @c TABLE part) instead of
9337     * the @ref Table plus @c SWALLOW part. It's just a matter of convenience.
9338     *
9339     * The Layout Table can be used through the @c elm_layout_table_* set of
9340     * functions.
9341     *
9342     * The following picture demonstrates a Layout widget with many child objects
9343     * added to its @c TABLE part:
9344     *
9345     * @image html layout_table.png
9346     * @image latex layout_table.eps width=\textwidth
9347     *
9348     * @section secPredef Predefined Layouts
9349     *
9350     * Another interesting thing about the Layout widget is that it offers some
9351     * predefined themes that come with the default Elementary theme. These
9352     * themes can be set by the call elm_layout_theme_set(), and provide some
9353     * basic functionality depending on the theme used.
9354     *
9355     * Most of them already send some signals, some already provide a toolbar or
9356     * back and next buttons.
9357     *
9358     * These are available predefined theme layouts. All of them have class = @c
9359     * layout, group = @c application, and style = one of the following options:
9360     *
9361     * @li @c toolbar-content - application with toolbar and main content area
9362     * @li @c toolbar-content-back - application with toolbar and main content
9363     * area with a back button and title area
9364     * @li @c toolbar-content-back-next - application with toolbar and main
9365     * content area with a back and next buttons and title area
9366     * @li @c content-back - application with a main content area with a back
9367     * button and title area
9368     * @li @c content-back-next - application with a main content area with a
9369     * back and next buttons and title area
9370     * @li @c toolbar-vbox - application with toolbar and main content area as a
9371     * vertical box
9372     * @li @c toolbar-table - application with toolbar and main content area as a
9373     * table
9374     *
9375     * @section secExamples Examples
9376     *
9377     * Some examples of the Layout widget can be found here:
9378     * @li @ref layout_example_01
9379     * @li @ref layout_example_02
9380     * @li @ref layout_example_03
9381     * @li @ref layout_example_edc
9382     *
9383     */
9384
9385    /**
9386     * Add a new layout to the parent
9387     *
9388     * @param parent The parent object
9389     * @return The new object or NULL if it cannot be created
9390     *
9391     * @see elm_layout_file_set()
9392     * @see elm_layout_theme_set()
9393     *
9394     * @ingroup Layout
9395     */
9396    EAPI Evas_Object       *elm_layout_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9397    /**
9398     * Set the file that will be used as layout
9399     *
9400     * @param obj The layout object
9401     * @param file The path to file (edj) that will be used as layout
9402     * @param group The group that the layout belongs in edje file
9403     *
9404     * @return (1 = success, 0 = error)
9405     *
9406     * @ingroup Layout
9407     */
9408    EAPI Eina_Bool          elm_layout_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
9409    /**
9410     * Set the edje group from the elementary theme that will be used as layout
9411     *
9412     * @param obj The layout object
9413     * @param clas the clas of the group
9414     * @param group the group
9415     * @param style the style to used
9416     *
9417     * @return (1 = success, 0 = error)
9418     *
9419     * @ingroup Layout
9420     */
9421    EAPI Eina_Bool          elm_layout_theme_set(Evas_Object *obj, const char *clas, const char *group, const char *style) EINA_ARG_NONNULL(1);
9422    /**
9423     * Set the layout content.
9424     *
9425     * @param obj The layout object
9426     * @param swallow The swallow part name in the edje file
9427     * @param content The child that will be added in this layout object
9428     *
9429     * Once the content object is set, a previously set one will be deleted.
9430     * If you want to keep that old content object, use the
9431     * elm_layout_content_unset() function.
9432     *
9433     * @note In an Edje theme, the part used as a content container is called @c
9434     * SWALLOW. This is why the parameter name is called @p swallow, but it is
9435     * expected to be a part name just like the second parameter of
9436     * elm_layout_box_append().
9437     *
9438     * @see elm_layout_box_append()
9439     * @see elm_layout_content_get()
9440     * @see elm_layout_content_unset()
9441     * @see @ref secBox
9442     *
9443     * @ingroup Layout
9444     */
9445    EAPI void               elm_layout_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
9446    /**
9447     * Get the child object in the given content part.
9448     *
9449     * @param obj The layout object
9450     * @param swallow The SWALLOW part to get its content
9451     *
9452     * @return The swallowed object or NULL if none or an error occurred
9453     *
9454     * @see elm_layout_content_set()
9455     *
9456     * @ingroup Layout
9457     */
9458    EAPI Evas_Object       *elm_layout_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
9459    /**
9460     * Unset the layout content.
9461     *
9462     * @param obj The layout object
9463     * @param swallow The swallow part name in the edje file
9464     * @return The content that was being used
9465     *
9466     * Unparent and return the content object which was set for this part.
9467     *
9468     * @see elm_layout_content_set()
9469     *
9470     * @ingroup Layout
9471     */
9472     EAPI Evas_Object       *elm_layout_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
9473    /**
9474     * Set the text of the given part
9475     *
9476     * @param obj The layout object
9477     * @param part The TEXT part where to set the text
9478     * @param text The text to set
9479     *
9480     * @ingroup Layout
9481     * @deprecated use elm_object_text_* instead.
9482     */
9483    EINA_DEPRECATED EAPI void               elm_layout_text_set(Evas_Object *obj, const char *part, const char *text) EINA_ARG_NONNULL(1);
9484    /**
9485     * Get the text set in the given part
9486     *
9487     * @param obj The layout object
9488     * @param part The TEXT part to retrieve the text off
9489     *
9490     * @return The text set in @p part
9491     *
9492     * @ingroup Layout
9493     * @deprecated use elm_object_text_* instead.
9494     */
9495    EINA_DEPRECATED EAPI const char        *elm_layout_text_get(const Evas_Object *obj, const char *part) EINA_ARG_NONNULL(1);
9496    /**
9497     * Append child to layout box part.
9498     *
9499     * @param obj the layout object
9500     * @param part the box part to which the object will be appended.
9501     * @param child the child object to append to box.
9502     *
9503     * Once the object is appended, it will become child of the layout. Its
9504     * lifetime will be bound to the layout, whenever the layout dies the child
9505     * will be deleted automatically. One should use elm_layout_box_remove() to
9506     * make this layout forget about the object.
9507     *
9508     * @see elm_layout_box_prepend()
9509     * @see elm_layout_box_insert_before()
9510     * @see elm_layout_box_insert_at()
9511     * @see elm_layout_box_remove()
9512     *
9513     * @ingroup Layout
9514     */
9515    EAPI void               elm_layout_box_append(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
9516    /**
9517     * Prepend child to layout box part.
9518     *
9519     * @param obj the layout object
9520     * @param part the box part to prepend.
9521     * @param child the child object to prepend to box.
9522     *
9523     * Once the object is prepended, it will become child of the layout. Its
9524     * lifetime will be bound to the layout, whenever the layout dies the child
9525     * will be deleted automatically. One should use elm_layout_box_remove() to
9526     * make this layout forget about the object.
9527     *
9528     * @see elm_layout_box_append()
9529     * @see elm_layout_box_insert_before()
9530     * @see elm_layout_box_insert_at()
9531     * @see elm_layout_box_remove()
9532     *
9533     * @ingroup Layout
9534     */
9535    EAPI void               elm_layout_box_prepend(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
9536    /**
9537     * Insert child to layout box part before a reference object.
9538     *
9539     * @param obj the layout object
9540     * @param part the box part to insert.
9541     * @param child the child object to insert into box.
9542     * @param reference another reference object to insert before in box.
9543     *
9544     * Once the object is inserted, it will become child of the layout. Its
9545     * lifetime will be bound to the layout, whenever the layout dies the child
9546     * will be deleted automatically. One should use elm_layout_box_remove() to
9547     * make this layout forget about the object.
9548     *
9549     * @see elm_layout_box_append()
9550     * @see elm_layout_box_prepend()
9551     * @see elm_layout_box_insert_before()
9552     * @see elm_layout_box_remove()
9553     *
9554     * @ingroup Layout
9555     */
9556    EAPI void               elm_layout_box_insert_before(Evas_Object *obj, const char *part, Evas_Object *child, const Evas_Object *reference) EINA_ARG_NONNULL(1);
9557    /**
9558     * Insert child to layout box part at a given position.
9559     *
9560     * @param obj the layout object
9561     * @param part the box part to insert.
9562     * @param child the child object to insert into box.
9563     * @param pos the numeric position >=0 to insert the child.
9564     *
9565     * Once the object is inserted, it will become child of the layout. Its
9566     * lifetime will be bound to the layout, whenever the layout dies the child
9567     * will be deleted automatically. One should use elm_layout_box_remove() to
9568     * make this layout forget about the object.
9569     *
9570     * @see elm_layout_box_append()
9571     * @see elm_layout_box_prepend()
9572     * @see elm_layout_box_insert_before()
9573     * @see elm_layout_box_remove()
9574     *
9575     * @ingroup Layout
9576     */
9577    EAPI void               elm_layout_box_insert_at(Evas_Object *obj, const char *part, Evas_Object *child, unsigned int pos) EINA_ARG_NONNULL(1);
9578    /**
9579     * Remove a child of the given part box.
9580     *
9581     * @param obj The layout object
9582     * @param part The box part name to remove child.
9583     * @param child The object to remove from box.
9584     * @return The object that was being used, or NULL if not found.
9585     *
9586     * The object will be removed from the box part and its lifetime will
9587     * not be handled by the layout anymore. This is equivalent to
9588     * elm_layout_content_unset() for box.
9589     *
9590     * @see elm_layout_box_append()
9591     * @see elm_layout_box_remove_all()
9592     *
9593     * @ingroup Layout
9594     */
9595    EAPI Evas_Object       *elm_layout_box_remove(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1, 2, 3);
9596    /**
9597     * Remove all child of the given part box.
9598     *
9599     * @param obj The layout object
9600     * @param part The box part name to remove child.
9601     * @param clear If EINA_TRUE, then all objects will be deleted as
9602     *        well, otherwise they will just be removed and will be
9603     *        dangling on the canvas.
9604     *
9605     * The objects will be removed from the box part and their lifetime will
9606     * not be handled by the layout anymore. This is equivalent to
9607     * elm_layout_box_remove() for all box children.
9608     *
9609     * @see elm_layout_box_append()
9610     * @see elm_layout_box_remove()
9611     *
9612     * @ingroup Layout
9613     */
9614    EAPI void               elm_layout_box_remove_all(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
9615    /**
9616     * Insert child to layout table part.
9617     *
9618     * @param obj the layout object
9619     * @param part the box part to pack child.
9620     * @param child_obj the child object to pack into table.
9621     * @param col the column to which the child should be added. (>= 0)
9622     * @param row the row to which the child should be added. (>= 0)
9623     * @param colspan how many columns should be used to store this object. (>=
9624     *        1)
9625     * @param rowspan how many rows should be used to store this object. (>= 1)
9626     *
9627     * Once the object is inserted, it will become child of the table. Its
9628     * lifetime will be bound to the layout, and whenever the layout dies the
9629     * child will be deleted automatically. One should use
9630     * elm_layout_table_remove() to make this layout forget about the object.
9631     *
9632     * If @p colspan or @p rowspan are bigger than 1, that object will occupy
9633     * more space than a single cell. For instance, the following code:
9634     * @code
9635     * elm_layout_table_pack(layout, "table_part", child, 0, 1, 3, 1);
9636     * @endcode
9637     *
9638     * Would result in an object being added like the following picture:
9639     *
9640     * @image html layout_colspan.png
9641     * @image latex layout_colspan.eps width=\textwidth
9642     *
9643     * @see elm_layout_table_unpack()
9644     * @see elm_layout_table_clear()
9645     *
9646     * @ingroup Layout
9647     */
9648    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);
9649    /**
9650     * Unpack (remove) a child of the given part table.
9651     *
9652     * @param obj The layout object
9653     * @param part The table part name to remove child.
9654     * @param child_obj The object to remove from table.
9655     * @return The object that was being used, or NULL if not found.
9656     *
9657     * The object will be unpacked from the table part and its lifetime
9658     * will not be handled by the layout anymore. This is equivalent to
9659     * elm_layout_content_unset() for table.
9660     *
9661     * @see elm_layout_table_pack()
9662     * @see elm_layout_table_clear()
9663     *
9664     * @ingroup Layout
9665     */
9666    EAPI Evas_Object       *elm_layout_table_unpack(Evas_Object *obj, const char *part, Evas_Object *child_obj) EINA_ARG_NONNULL(1, 2, 3);
9667    /**
9668     * Remove all child of the given part table.
9669     *
9670     * @param obj The layout object
9671     * @param part The table part name to remove child.
9672     * @param clear If EINA_TRUE, then all objects will be deleted as
9673     *        well, otherwise they will just be removed and will be
9674     *        dangling on the canvas.
9675     *
9676     * The objects will be removed from the table part and their lifetime will
9677     * not be handled by the layout anymore. This is equivalent to
9678     * elm_layout_table_unpack() for all table children.
9679     *
9680     * @see elm_layout_table_pack()
9681     * @see elm_layout_table_unpack()
9682     *
9683     * @ingroup Layout
9684     */
9685    EAPI void               elm_layout_table_clear(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
9686    /**
9687     * Get the edje layout
9688     *
9689     * @param obj The layout object
9690     *
9691     * @return A Evas_Object with the edje layout settings loaded
9692     * with function elm_layout_file_set
9693     *
9694     * This returns the edje object. It is not expected to be used to then
9695     * swallow objects via edje_object_part_swallow() for example. Use
9696     * elm_layout_content_set() instead so child object handling and sizing is
9697     * done properly.
9698     *
9699     * @note This function should only be used if you really need to call some
9700     * low level Edje function on this edje object. All the common stuff (setting
9701     * text, emitting signals, hooking callbacks to signals, etc.) can be done
9702     * with proper elementary functions.
9703     *
9704     * @see elm_object_signal_callback_add()
9705     * @see elm_object_signal_emit()
9706     * @see elm_object_text_part_set()
9707     * @see elm_layout_content_set()
9708     * @see elm_layout_box_append()
9709     * @see elm_layout_table_pack()
9710     * @see elm_layout_data_get()
9711     *
9712     * @ingroup Layout
9713     */
9714    EAPI Evas_Object       *elm_layout_edje_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9715    /**
9716     * Get the edje data from the given layout
9717     *
9718     * @param obj The layout object
9719     * @param key The data key
9720     *
9721     * @return The edje data string
9722     *
9723     * This function fetches data specified inside the edje theme of this layout.
9724     * This function return NULL if data is not found.
9725     *
9726     * In EDC this comes from a data block within the group block that @p
9727     * obj was loaded from. E.g.
9728     *
9729     * @code
9730     * collections {
9731     *   group {
9732     *     name: "a_group";
9733     *     data {
9734     *       item: "key1" "value1";
9735     *       item: "key2" "value2";
9736     *     }
9737     *   }
9738     * }
9739     * @endcode
9740     *
9741     * @ingroup Layout
9742     */
9743    EAPI const char        *elm_layout_data_get(const Evas_Object *obj, const char *key) EINA_ARG_NONNULL(1, 2);
9744    /**
9745     * Eval sizing
9746     *
9747     * @param obj The layout object
9748     *
9749     * Manually forces a sizing re-evaluation. This is useful when the minimum
9750     * size required by the edje theme of this layout has changed. The change on
9751     * the minimum size required by the edje theme is not immediately reported to
9752     * the elementary layout, so one needs to call this function in order to tell
9753     * the widget (layout) that it needs to reevaluate its own size.
9754     *
9755     * The minimum size of the theme is calculated based on minimum size of
9756     * parts, the size of elements inside containers like box and table, etc. All
9757     * of this can change due to state changes, and that's when this function
9758     * should be called.
9759     *
9760     * Also note that a standard signal of "size,eval" "elm" emitted from the
9761     * edje object will cause this to happen too.
9762     *
9763     * @ingroup Layout
9764     */
9765    EAPI void               elm_layout_sizing_eval(Evas_Object *obj) EINA_ARG_NONNULL(1);
9766
9767    /**
9768     * Sets a specific cursor for an edje part.
9769     *
9770     * @param obj The layout object.
9771     * @param part_name a part from loaded edje group.
9772     * @param cursor cursor name to use, see Elementary_Cursor.h
9773     *
9774     * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
9775     *         part not exists or it has "mouse_events: 0".
9776     *
9777     * @ingroup Layout
9778     */
9779    EAPI Eina_Bool          elm_layout_part_cursor_set(Evas_Object *obj, const char *part_name, const char *cursor) EINA_ARG_NONNULL(1, 2);
9780
9781    /**
9782     * Get the cursor to be shown when mouse is over an edje part
9783     *
9784     * @param obj The layout object.
9785     * @param part_name a part from loaded edje group.
9786     * @return the cursor name.
9787     *
9788     * @ingroup Layout
9789     */
9790    EAPI const char        *elm_layout_part_cursor_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
9791
9792    /**
9793     * Unsets a cursor previously set with elm_layout_part_cursor_set().
9794     *
9795     * @param obj The layout object.
9796     * @param part_name a part from loaded edje group, that had a cursor set
9797     *        with elm_layout_part_cursor_set().
9798     *
9799     * @ingroup Layout
9800     */
9801    EAPI void               elm_layout_part_cursor_unset(Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
9802
9803    /**
9804     * Sets a specific cursor style for an edje part.
9805     *
9806     * @param obj The layout object.
9807     * @param part_name a part from loaded edje group.
9808     * @param style the theme style to use (default, transparent, ...)
9809     *
9810     * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
9811     *         part not exists or it did not had a cursor set.
9812     *
9813     * @ingroup Layout
9814     */
9815    EAPI Eina_Bool          elm_layout_part_cursor_style_set(Evas_Object *obj, const char *part_name, const char *style) EINA_ARG_NONNULL(1, 2);
9816
9817    /**
9818     * Gets a specific cursor style for an edje part.
9819     *
9820     * @param obj The layout object.
9821     * @param part_name a part from loaded edje group.
9822     *
9823     * @return the theme style in use, defaults to "default". If the
9824     *         object does not have a cursor set, then NULL is returned.
9825     *
9826     * @ingroup Layout
9827     */
9828    EAPI const char        *elm_layout_part_cursor_style_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
9829
9830    /**
9831     * Sets if the cursor set should be searched on the theme or should use
9832     * the provided by the engine, only.
9833     *
9834     * @note before you set if should look on theme you should define a
9835     * cursor with elm_layout_part_cursor_set(). By default it will only
9836     * look for cursors provided by the engine.
9837     *
9838     * @param obj The layout object.
9839     * @param part_name a part from loaded edje group.
9840     * @param engine_only if cursors should be just provided by the engine
9841     *        or should also search on widget's theme as well
9842     *
9843     * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
9844     *         part not exists or it did not had a cursor set.
9845     *
9846     * @ingroup Layout
9847     */
9848    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);
9849
9850    /**
9851     * Gets a specific cursor engine_only for an edje part.
9852     *
9853     * @param obj The layout object.
9854     * @param part_name a part from loaded edje group.
9855     *
9856     * @return whenever the cursor is just provided by engine or also from theme.
9857     *
9858     * @ingroup Layout
9859     */
9860    EAPI Eina_Bool          elm_layout_part_cursor_engine_only_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
9861
9862 /**
9863  * @def elm_layout_icon_set
9864  * Convienience macro to set the icon object in a layout that follows the
9865  * Elementary naming convention for its parts.
9866  *
9867  * @ingroup Layout
9868  */
9869 #define elm_layout_icon_set(_ly, _obj) \
9870   do { \
9871     const char *sig; \
9872     elm_layout_content_set((_ly), "elm.swallow.icon", (_obj)); \
9873     if ((_obj)) sig = "elm,state,icon,visible"; \
9874     else sig = "elm,state,icon,hidden"; \
9875     elm_object_signal_emit((_ly), sig, "elm"); \
9876   } while (0)
9877
9878 /**
9879  * @def elm_layout_icon_get
9880  * Convienience macro to get the icon object from a layout that follows the
9881  * Elementary naming convention for its parts.
9882  *
9883  * @ingroup Layout
9884  */
9885 #define elm_layout_icon_get(_ly) \
9886   elm_layout_content_get((_ly), "elm.swallow.icon")
9887
9888 /**
9889  * @def elm_layout_end_set
9890  * Convienience macro to set the end object in a layout that follows the
9891  * Elementary naming convention for its parts.
9892  *
9893  * @ingroup Layout
9894  */
9895 #define elm_layout_end_set(_ly, _obj) \
9896   do { \
9897     const char *sig; \
9898     elm_layout_content_set((_ly), "elm.swallow.end", (_obj)); \
9899     if ((_obj)) sig = "elm,state,end,visible"; \
9900     else sig = "elm,state,end,hidden"; \
9901     elm_object_signal_emit((_ly), sig, "elm"); \
9902   } while (0)
9903
9904 /**
9905  * @def elm_layout_end_get
9906  * Convienience macro to get the end object in a layout that follows the
9907  * Elementary naming convention for its parts.
9908  *
9909  * @ingroup Layout
9910  */
9911 #define elm_layout_end_get(_ly) \
9912   elm_layout_content_get((_ly), "elm.swallow.end")
9913
9914 /**
9915  * @def elm_layout_label_set
9916  * Convienience macro to set the label in a layout that follows the
9917  * Elementary naming convention for its parts.
9918  *
9919  * @ingroup Layout
9920  * @deprecated use elm_object_text_* instead.
9921  */
9922 #define elm_layout_label_set(_ly, _txt) \
9923   elm_layout_text_set((_ly), "elm.text", (_txt))
9924
9925 /**
9926  * @def elm_layout_label_get
9927  * Convienience macro to get the label in a layout that follows the
9928  * Elementary naming convention for its parts.
9929  *
9930  * @ingroup Layout
9931  * @deprecated use elm_object_text_* instead.
9932  */
9933 #define elm_layout_label_get(_ly) \
9934   elm_layout_text_get((_ly), "elm.text")
9935
9936    /* smart callbacks called:
9937     * "theme,changed" - when elm theme is changed.
9938     */
9939
9940    /**
9941     * @defgroup Notify Notify
9942     *
9943     * @image html img/widget/notify/preview-00.png
9944     * @image latex img/widget/notify/preview-00.eps
9945     *
9946     * Display a container in a particular region of the parent(top, bottom,
9947     * etc.  A timeout can be set to automatically hide the notify. This is so
9948     * that, after an evas_object_show() on a notify object, if a timeout was set
9949     * on it, it will @b automatically get hidden after that time.
9950     *
9951     * Signals that you can add callbacks for are:
9952     * @li "timeout" - when timeout happens on notify and it's hidden
9953     * @li "block,clicked" - when a click outside of the notify happens
9954     *
9955     * @ref tutorial_notify show usage of the API.
9956     *
9957     * @{
9958     */
9959    /**
9960     * @brief Possible orient values for notify.
9961     *
9962     * This values should be used in conjunction to elm_notify_orient_set() to
9963     * set the position in which the notify should appear(relative to its parent)
9964     * and in conjunction with elm_notify_orient_get() to know where the notify
9965     * is appearing.
9966     */
9967    typedef enum _Elm_Notify_Orient
9968      {
9969         ELM_NOTIFY_ORIENT_TOP, /**< Notify should appear in the top of parent, default */
9970         ELM_NOTIFY_ORIENT_CENTER, /**< Notify should appear in the center of parent */
9971         ELM_NOTIFY_ORIENT_BOTTOM, /**< Notify should appear in the bottom of parent */
9972         ELM_NOTIFY_ORIENT_LEFT, /**< Notify should appear in the left of parent */
9973         ELM_NOTIFY_ORIENT_RIGHT, /**< Notify should appear in the right of parent */
9974         ELM_NOTIFY_ORIENT_TOP_LEFT, /**< Notify should appear in the top left of parent */
9975         ELM_NOTIFY_ORIENT_TOP_RIGHT, /**< Notify should appear in the top right of parent */
9976         ELM_NOTIFY_ORIENT_BOTTOM_LEFT, /**< Notify should appear in the bottom left of parent */
9977         ELM_NOTIFY_ORIENT_BOTTOM_RIGHT, /**< Notify should appear in the bottom right of parent */
9978         ELM_NOTIFY_ORIENT_LAST /**< Sentinel value, @b don't use */
9979      } Elm_Notify_Orient;
9980    /**
9981     * @brief Add a new notify to the parent
9982     *
9983     * @param parent The parent object
9984     * @return The new object or NULL if it cannot be created
9985     */
9986    EAPI Evas_Object      *elm_notify_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9987    /**
9988     * @brief Set the content of the notify widget
9989     *
9990     * @param obj The notify object
9991     * @param content The content will be filled in this notify object
9992     *
9993     * Once the content object is set, a previously set one will be deleted. If
9994     * you want to keep that old content object, use the
9995     * elm_notify_content_unset() function.
9996     */
9997    EAPI void              elm_notify_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
9998    /**
9999     * @brief Unset the content of the notify widget
10000     *
10001     * @param obj The notify object
10002     * @return The content that was being used
10003     *
10004     * Unparent and return the content object which was set for this widget
10005     *
10006     * @see elm_notify_content_set()
10007     */
10008    EAPI Evas_Object      *elm_notify_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
10009    /**
10010     * @brief Return the content of the notify widget
10011     *
10012     * @param obj The notify object
10013     * @return The content that is being used
10014     *
10015     * @see elm_notify_content_set()
10016     */
10017    EAPI Evas_Object      *elm_notify_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10018    /**
10019     * @brief Set the notify parent
10020     *
10021     * @param obj The notify object
10022     * @param content The new parent
10023     *
10024     * Once the parent object is set, a previously set one will be disconnected
10025     * and replaced.
10026     */
10027    EAPI void              elm_notify_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10028    /**
10029     * @brief Get the notify parent
10030     *
10031     * @param obj The notify object
10032     * @return The parent
10033     *
10034     * @see elm_notify_parent_set()
10035     */
10036    EAPI Evas_Object      *elm_notify_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10037    /**
10038     * @brief Set the orientation
10039     *
10040     * @param obj The notify object
10041     * @param orient The new orientation
10042     *
10043     * Sets the position in which the notify will appear in its parent.
10044     *
10045     * @see @ref Elm_Notify_Orient for possible values.
10046     */
10047    EAPI void              elm_notify_orient_set(Evas_Object *obj, Elm_Notify_Orient orient) EINA_ARG_NONNULL(1);
10048    /**
10049     * @brief Return the orientation
10050     * @param obj The notify object
10051     * @return The orientation of the notification
10052     *
10053     * @see elm_notify_orient_set()
10054     * @see Elm_Notify_Orient
10055     */
10056    EAPI Elm_Notify_Orient elm_notify_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10057    /**
10058     * @brief Set the time interval after which the notify window is going to be
10059     * hidden.
10060     *
10061     * @param obj The notify object
10062     * @param time The timeout in seconds
10063     *
10064     * This function sets a timeout and starts the timer controlling when the
10065     * notify is hidden. Since calling evas_object_show() on a notify restarts
10066     * the timer controlling when the notify is hidden, setting this before the
10067     * notify is shown will in effect mean starting the timer when the notify is
10068     * shown.
10069     *
10070     * @note Set a value <= 0.0 to disable a running timer.
10071     *
10072     * @note If the value > 0.0 and the notify is previously visible, the
10073     * timer will be started with this value, canceling any running timer.
10074     */
10075    EAPI void              elm_notify_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
10076    /**
10077     * @brief Return the timeout value (in seconds)
10078     * @param obj the notify object
10079     *
10080     * @see elm_notify_timeout_set()
10081     */
10082    EAPI double            elm_notify_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10083    /**
10084     * @brief Sets whether events should be passed to by a click outside
10085     * its area.
10086     *
10087     * @param obj The notify object
10088     * @param repeats EINA_TRUE Events are repeats, else no
10089     *
10090     * When true if the user clicks outside the window the events will be caught
10091     * by the others widgets, else the events are blocked.
10092     *
10093     * @note The default value is EINA_TRUE.
10094     */
10095    EAPI void              elm_notify_repeat_events_set(Evas_Object *obj, Eina_Bool repeat) EINA_ARG_NONNULL(1);
10096    /**
10097     * @brief Return true if events are repeat below the notify object
10098     * @param obj the notify object
10099     *
10100     * @see elm_notify_repeat_events_set()
10101     */
10102    EAPI Eina_Bool         elm_notify_repeat_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10103    /**
10104     * @}
10105     */
10106
10107    /**
10108     * @defgroup Hover Hover
10109     *
10110     * @image html img/widget/hover/preview-00.png
10111     * @image latex img/widget/hover/preview-00.eps
10112     *
10113     * A Hover object will hover over its @p parent object at the @p target
10114     * location. Anything in the background will be given a darker coloring to
10115     * indicate that the hover object is on top (at the default theme). When the
10116     * hover is clicked it is dismissed(hidden), if the contents of the hover are
10117     * clicked that @b doesn't cause the hover to be dismissed.
10118     *
10119     * @note The hover object will take up the entire space of @p target
10120     * object.
10121     *
10122     * Elementary has the following styles for the hover widget:
10123     * @li default
10124     * @li popout
10125     * @li menu
10126     * @li hoversel_vertical
10127     *
10128     * The following are the available position for content:
10129     * @li left
10130     * @li top-left
10131     * @li top
10132     * @li top-right
10133     * @li right
10134     * @li bottom-right
10135     * @li bottom
10136     * @li bottom-left
10137     * @li middle
10138     * @li smart
10139     *
10140     * Signals that you can add callbacks for are:
10141     * @li "clicked" - the user clicked the empty space in the hover to dismiss
10142     * @li "smart,changed" - a content object placed under the "smart"
10143     *                   policy was replaced to a new slot direction.
10144     *
10145     * See @ref tutorial_hover for more information.
10146     *
10147     * @{
10148     */
10149    typedef enum _Elm_Hover_Axis
10150      {
10151         ELM_HOVER_AXIS_NONE, /**< ELM_HOVER_AXIS_NONE -- no prefered orientation */
10152         ELM_HOVER_AXIS_HORIZONTAL, /**< ELM_HOVER_AXIS_HORIZONTAL -- horizontal */
10153         ELM_HOVER_AXIS_VERTICAL, /**< ELM_HOVER_AXIS_VERTICAL -- vertical */
10154         ELM_HOVER_AXIS_BOTH /**< ELM_HOVER_AXIS_BOTH -- both */
10155      } Elm_Hover_Axis;
10156    /**
10157     * @brief Adds a hover object to @p parent
10158     *
10159     * @param parent The parent object
10160     * @return The hover object or NULL if one could not be created
10161     */
10162    EAPI Evas_Object *elm_hover_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10163    /**
10164     * @brief Sets the target object for the hover.
10165     *
10166     * @param obj The hover object
10167     * @param target The object to center the hover onto. The hover
10168     *
10169     * This function will cause the hover to be centered on the target object.
10170     */
10171    EAPI void         elm_hover_target_set(Evas_Object *obj, Evas_Object *target) EINA_ARG_NONNULL(1);
10172    /**
10173     * @brief Gets the target object for the hover.
10174     *
10175     * @param obj The hover object
10176     * @param parent The object to locate the hover over.
10177     *
10178     * @see elm_hover_target_set()
10179     */
10180    EAPI Evas_Object *elm_hover_target_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10181    /**
10182     * @brief Sets the parent object for the hover.
10183     *
10184     * @param obj The hover object
10185     * @param parent The object to locate the hover over.
10186     *
10187     * This function will cause the hover to take up the entire space that the
10188     * parent object fills.
10189     */
10190    EAPI void         elm_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10191    /**
10192     * @brief Gets the parent object for the hover.
10193     *
10194     * @param obj The hover object
10195     * @return The parent object to locate the hover over.
10196     *
10197     * @see elm_hover_parent_set()
10198     */
10199    EAPI Evas_Object *elm_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10200    /**
10201     * @brief Sets the content of the hover object and the direction in which it
10202     * will pop out.
10203     *
10204     * @param obj The hover object
10205     * @param swallow The direction that the object will be displayed
10206     * at. Accepted values are "left", "top-left", "top", "top-right",
10207     * "right", "bottom-right", "bottom", "bottom-left", "middle" and
10208     * "smart".
10209     * @param content The content to place at @p swallow
10210     *
10211     * Once the content object is set for a given direction, a previously
10212     * set one (on the same direction) will be deleted. If you want to
10213     * keep that old content object, use the elm_hover_content_unset()
10214     * function.
10215     *
10216     * All directions may have contents at the same time, except for
10217     * "smart". This is a special placement hint and its use case
10218     * independs of the calculations coming from
10219     * elm_hover_best_content_location_get(). Its use is for cases when
10220     * one desires only one hover content, but with a dinamic special
10221     * placement within the hover area. The content's geometry, whenever
10222     * it changes, will be used to decide on a best location not
10223     * extrapolating the hover's parent object view to show it in (still
10224     * being the hover's target determinant of its medium part -- move and
10225     * resize it to simulate finger sizes, for example). If one of the
10226     * directions other than "smart" are used, a previously content set
10227     * using it will be deleted, and vice-versa.
10228     */
10229    EAPI void         elm_hover_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
10230    /**
10231     * @brief Get the content of the hover object, in a given direction.
10232     *
10233     * Return the content object which was set for this widget in the
10234     * @p swallow direction.
10235     *
10236     * @param obj The hover object
10237     * @param swallow The direction that the object was display at.
10238     * @return The content that was being used
10239     *
10240     * @see elm_hover_content_set()
10241     */
10242    EAPI Evas_Object *elm_hover_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10243    /**
10244     * @brief Unset the content of the hover object, in a given direction.
10245     *
10246     * Unparent and return the content object set at @p swallow direction.
10247     *
10248     * @param obj The hover object
10249     * @param swallow The direction that the object was display at.
10250     * @return The content that was being used.
10251     *
10252     * @see elm_hover_content_set()
10253     */
10254    EAPI Evas_Object *elm_hover_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10255    /**
10256     * @brief Returns the best swallow location for content in the hover.
10257     *
10258     * @param obj The hover object
10259     * @param pref_axis The preferred orientation axis for the hover object to use
10260     * @return The edje location to place content into the hover or @c
10261     *         NULL, on errors.
10262     *
10263     * Best is defined here as the location at which there is the most available
10264     * space.
10265     *
10266     * @p pref_axis may be one of
10267     * - @c ELM_HOVER_AXIS_NONE -- no prefered orientation
10268     * - @c ELM_HOVER_AXIS_HORIZONTAL -- horizontal
10269     * - @c ELM_HOVER_AXIS_VERTICAL -- vertical
10270     * - @c ELM_HOVER_AXIS_BOTH -- both
10271     *
10272     * If ELM_HOVER_AXIS_HORIZONTAL is choosen the returned position will
10273     * nescessarily be along the horizontal axis("left" or "right"). If
10274     * ELM_HOVER_AXIS_VERTICAL is choosen the returned position will nescessarily
10275     * be along the vertical axis("top" or "bottom"). Chossing
10276     * ELM_HOVER_AXIS_BOTH or ELM_HOVER_AXIS_NONE has the same effect and the
10277     * returned position may be in either axis.
10278     *
10279     * @see elm_hover_content_set()
10280     */
10281    EAPI const char  *elm_hover_best_content_location_get(const Evas_Object *obj, Elm_Hover_Axis pref_axis) EINA_ARG_NONNULL(1);
10282    /**
10283     * @}
10284     */
10285
10286    /* entry */
10287    /**
10288     * @defgroup Entry Entry
10289     *
10290     * @image html img/widget/entry/preview-00.png
10291     * @image latex img/widget/entry/preview-00.eps width=\textwidth
10292     * @image html img/widget/entry/preview-01.png
10293     * @image latex img/widget/entry/preview-01.eps width=\textwidth
10294     * @image html img/widget/entry/preview-02.png
10295     * @image latex img/widget/entry/preview-02.eps width=\textwidth
10296     * @image html img/widget/entry/preview-03.png
10297     * @image latex img/widget/entry/preview-03.eps width=\textwidth
10298     *
10299     * An entry is a convenience widget which shows a box that the user can
10300     * enter text into. Entries by default don't scroll, so they grow to
10301     * accomodate the entire text, resizing the parent window as needed. This
10302     * can be changed with the elm_entry_scrollable_set() function.
10303     *
10304     * They can also be single line or multi line (the default) and when set
10305     * to multi line mode they support text wrapping in any of the modes
10306     * indicated by #Elm_Wrap_Type.
10307     *
10308     * Other features include password mode, filtering of inserted text with
10309     * elm_entry_text_filter_append() and related functions, inline "items" and
10310     * formatted markup text.
10311     *
10312     * @section entry-markup Formatted text
10313     *
10314     * The markup tags supported by the Entry are defined by the theme, but
10315     * even when writing new themes or extensions it's a good idea to stick to
10316     * a sane default, to maintain coherency and avoid application breakages.
10317     * Currently defined by the default theme are the following tags:
10318     * @li \<br\>: Inserts a line break.
10319     * @li \<ps\>: Inserts a paragraph separator. This is preferred over line
10320     * breaks.
10321     * @li \<tab\>: Inserts a tab.
10322     * @li \<em\>...\</em\>: Emphasis. Sets the @em oblique style for the
10323     * enclosed text.
10324     * @li \<b\>...\</b\>: Sets the @b bold style for the enclosed text.
10325     * @li \<link\>...\</link\>: Underlines the enclosed text.
10326     * @li \<hilight\>...\</hilight\>: Hilights the enclosed text.
10327     *
10328     * @section entry-special Special markups
10329     *
10330     * Besides those used to format text, entries support two special markup
10331     * tags used to insert clickable portions of text or items inlined within
10332     * the text.
10333     *
10334     * @subsection entry-anchors Anchors
10335     *
10336     * Anchors are similar to HTML anchors. Text can be surrounded by \<a\> and
10337     * \</a\> tags and an event will be generated when this text is clicked,
10338     * like this:
10339     *
10340     * @code
10341     * This text is outside <a href=anc-01>but this one is an anchor</a>
10342     * @endcode
10343     *
10344     * The @c href attribute in the opening tag gives the name that will be
10345     * used to identify the anchor and it can be any valid utf8 string.
10346     *
10347     * When an anchor is clicked, an @c "anchor,clicked" signal is emitted with
10348     * an #Elm_Entry_Anchor_Info in the @c event_info parameter for the
10349     * callback function. The same applies for "anchor,in" (mouse in), "anchor,out"
10350     * (mouse out), "anchor,down" (mouse down), and "anchor,up" (mouse up) events on
10351     * an anchor.
10352     *
10353     * @subsection entry-items Items
10354     *
10355     * Inlined in the text, any other @c Evas_Object can be inserted by using
10356     * \<item\> tags this way:
10357     *
10358     * @code
10359     * <item size=16x16 vsize=full href=emoticon/haha></item>
10360     * @endcode
10361     *
10362     * Just like with anchors, the @c href identifies each item, but these need,
10363     * in addition, to indicate their size, which is done using any one of
10364     * @c size, @c absize or @c relsize attributes. These attributes take their
10365     * value in the WxH format, where W is the width and H the height of the
10366     * item.
10367     *
10368     * @li absize: Absolute pixel size for the item. Whatever value is set will
10369     * be the item's size regardless of any scale value the object may have
10370     * been set to. The final line height will be adjusted to fit larger items.
10371     * @li size: Similar to @c absize, but it's adjusted to the scale value set
10372     * for the object.
10373     * @li relsize: Size is adjusted for the item to fit within the current
10374     * line height.
10375     *
10376     * Besides their size, items are specificed a @c vsize value that affects
10377     * how their final size and position are calculated. The possible values
10378     * are:
10379     * @li ascent: Item will be placed within the line's baseline and its
10380     * ascent. That is, the height between the line where all characters are
10381     * positioned and the highest point in the line. For @c size and @c absize
10382     * items, the descent value will be added to the total line height to make
10383     * them fit. @c relsize items will be adjusted to fit within this space.
10384     * @li full: Items will be placed between the descent and ascent, or the
10385     * lowest point in the line and its highest.
10386     *
10387     * The next image shows different configurations of items and how they
10388     * are the previously mentioned options affect their sizes. In all cases,
10389     * the green line indicates the ascent, blue for the baseline and red for
10390     * the descent.
10391     *
10392     * @image html entry_item.png
10393     * @image latex entry_item.eps width=\textwidth
10394     *
10395     * And another one to show how size differs from absize. In the first one,
10396     * the scale value is set to 1.0, while the second one is using one of 2.0.
10397     *
10398     * @image html entry_item_scale.png
10399     * @image latex entry_item_scale.eps width=\textwidth
10400     *
10401     * After the size for an item is calculated, the entry will request an
10402     * object to place in its space. For this, the functions set with
10403     * elm_entry_item_provider_append() and related functions will be called
10404     * in order until one of them returns a @c non-NULL value. If no providers
10405     * are available, or all of them return @c NULL, then the entry falls back
10406     * to one of the internal defaults, provided the name matches with one of
10407     * them.
10408     *
10409     * All of the following are currently supported:
10410     *
10411     * - emoticon/angry
10412     * - emoticon/angry-shout
10413     * - emoticon/crazy-laugh
10414     * - emoticon/evil-laugh
10415     * - emoticon/evil
10416     * - emoticon/goggle-smile
10417     * - emoticon/grumpy
10418     * - emoticon/grumpy-smile
10419     * - emoticon/guilty
10420     * - emoticon/guilty-smile
10421     * - emoticon/haha
10422     * - emoticon/half-smile
10423     * - emoticon/happy-panting
10424     * - emoticon/happy
10425     * - emoticon/indifferent
10426     * - emoticon/kiss
10427     * - emoticon/knowing-grin
10428     * - emoticon/laugh
10429     * - emoticon/little-bit-sorry
10430     * - emoticon/love-lots
10431     * - emoticon/love
10432     * - emoticon/minimal-smile
10433     * - emoticon/not-happy
10434     * - emoticon/not-impressed
10435     * - emoticon/omg
10436     * - emoticon/opensmile
10437     * - emoticon/smile
10438     * - emoticon/sorry
10439     * - emoticon/squint-laugh
10440     * - emoticon/surprised
10441     * - emoticon/suspicious
10442     * - emoticon/tongue-dangling
10443     * - emoticon/tongue-poke
10444     * - emoticon/uh
10445     * - emoticon/unhappy
10446     * - emoticon/very-sorry
10447     * - emoticon/what
10448     * - emoticon/wink
10449     * - emoticon/worried
10450     * - emoticon/wtf
10451     *
10452     * Alternatively, an item may reference an image by its path, using
10453     * the URI form @c file:///path/to/an/image.png and the entry will then
10454     * use that image for the item.
10455     *
10456     * @section entry-files Loading and saving files
10457     *
10458     * Entries have convinience functions to load text from a file and save
10459     * changes back to it after a short delay. The automatic saving is enabled
10460     * by default, but can be disabled with elm_entry_autosave_set() and files
10461     * can be loaded directly as plain text or have any markup in them
10462     * recognized. See elm_entry_file_set() for more details.
10463     *
10464     * @section entry-signals Emitted signals
10465     *
10466     * This widget emits the following signals:
10467     *
10468     * @li "changed": The text within the entry was changed.
10469     * @li "changed,user": The text within the entry was changed because of user interaction.
10470     * @li "activated": The enter key was pressed on a single line entry.
10471     * @li "press": A mouse button has been pressed on the entry.
10472     * @li "longpressed": A mouse button has been pressed and held for a couple
10473     * seconds.
10474     * @li "clicked": The entry has been clicked (mouse press and release).
10475     * @li "clicked,double": The entry has been double clicked.
10476     * @li "clicked,triple": The entry has been triple clicked.
10477     * @li "focused": The entry has received focus.
10478     * @li "unfocused": The entry has lost focus.
10479     * @li "selection,paste": A paste of the clipboard contents was requested.
10480     * @li "selection,copy": A copy of the selected text into the clipboard was
10481     * requested.
10482     * @li "selection,cut": A cut of the selected text into the clipboard was
10483     * requested.
10484     * @li "selection,start": A selection has begun and no previous selection
10485     * existed.
10486     * @li "selection,changed": The current selection has changed.
10487     * @li "selection,cleared": The current selection has been cleared.
10488     * @li "cursor,changed": The cursor has changed position.
10489     * @li "anchor,clicked": An anchor has been clicked. The event_info
10490     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10491     * @li "anchor,in": Mouse cursor has moved into an anchor. The event_info
10492     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10493     * @li "anchor,out": Mouse cursor has moved out of an anchor. The event_info
10494     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10495     * @li "anchor,up": Mouse button has been unpressed on an anchor. The event_info
10496     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10497     * @li "anchor,down": Mouse button has been pressed on an anchor. The event_info
10498     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
10499     * @li "preedit,changed": The preedit string has changed.
10500     *
10501     * @section entry-examples
10502     *
10503     * An overview of the Entry API can be seen in @ref entry_example_01
10504     *
10505     * @{
10506     */
10507    /**
10508     * @typedef Elm_Entry_Anchor_Info
10509     *
10510     * The info sent in the callback for the "anchor,clicked" signals emitted
10511     * by entries.
10512     */
10513    typedef struct _Elm_Entry_Anchor_Info Elm_Entry_Anchor_Info;
10514    /**
10515     * @struct _Elm_Entry_Anchor_Info
10516     *
10517     * The info sent in the callback for the "anchor,clicked" signals emitted
10518     * by entries.
10519     */
10520    struct _Elm_Entry_Anchor_Info
10521      {
10522         const char *name; /**< The name of the anchor, as stated in its href */
10523         int         button; /**< The mouse button used to click on it */
10524         Evas_Coord  x, /**< Anchor geometry, relative to canvas */
10525                     y, /**< Anchor geometry, relative to canvas */
10526                     w, /**< Anchor geometry, relative to canvas */
10527                     h; /**< Anchor geometry, relative to canvas */
10528      };
10529    /**
10530     * @typedef Elm_Entry_Filter_Cb
10531     * This callback type is used by entry filters to modify text.
10532     * @param data The data specified as the last param when adding the filter
10533     * @param entry The entry object
10534     * @param text A pointer to the location of the text being filtered. This data can be modified,
10535     * but any additional allocations must be managed by the user.
10536     * @see elm_entry_text_filter_append
10537     * @see elm_entry_text_filter_prepend
10538     */
10539    typedef void (*Elm_Entry_Filter_Cb)(void *data, Evas_Object *entry, char **text);
10540
10541    /**
10542     * This adds an entry to @p parent object.
10543     *
10544     * By default, entries are:
10545     * @li not scrolled
10546     * @li multi-line
10547     * @li word wrapped
10548     * @li autosave is enabled
10549     *
10550     * @param parent The parent object
10551     * @return The new object or NULL if it cannot be created
10552     */
10553    EAPI Evas_Object *elm_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10554    /**
10555     * Sets the entry to single line mode.
10556     *
10557     * In single line mode, entries don't ever wrap when the text reaches the
10558     * edge, and instead they keep growing horizontally. Pressing the @c Enter
10559     * key will generate an @c "activate" event instead of adding a new line.
10560     *
10561     * When @p single_line is @c EINA_FALSE, line wrapping takes effect again
10562     * and pressing enter will break the text into a different line
10563     * without generating any events.
10564     *
10565     * @param obj The entry object
10566     * @param single_line If true, the text in the entry
10567     * will be on a single line.
10568     */
10569    EAPI void         elm_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
10570    /**
10571     * Gets whether the entry is set to be single line.
10572     *
10573     * @param obj The entry object
10574     * @return single_line If true, the text in the entry is set to display
10575     * on a single line.
10576     *
10577     * @see elm_entry_single_line_set()
10578     */
10579    EAPI Eina_Bool    elm_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10580    /**
10581     * Sets the entry to password mode.
10582     *
10583     * In password mode, entries are implicitly single line and the display of
10584     * any text in them is replaced with asterisks (*).
10585     *
10586     * @param obj The entry object
10587     * @param password If true, password mode is enabled.
10588     */
10589    EAPI void         elm_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
10590    /**
10591     * Gets whether the entry is set to password mode.
10592     *
10593     * @param obj The entry object
10594     * @return If true, the entry is set to display all characters
10595     * as asterisks (*).
10596     *
10597     * @see elm_entry_password_set()
10598     */
10599    EAPI Eina_Bool    elm_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10600    /**
10601     * This sets the text displayed within the entry to @p entry.
10602     *
10603     * @param obj The entry object
10604     * @param entry The text to be displayed
10605     *
10606     * @deprecated Use elm_object_text_set() instead.
10607     */
10608    EAPI void         elm_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
10609    /**
10610     * This returns the text currently shown in object @p entry.
10611     * See also elm_entry_entry_set().
10612     *
10613     * @param obj The entry object
10614     * @return The currently displayed text or NULL on failure
10615     *
10616     * @deprecated Use elm_object_text_get() instead.
10617     */
10618    EAPI const char  *elm_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10619    /**
10620     * Appends @p entry to the text of the entry.
10621     *
10622     * Adds the text in @p entry to the end of any text already present in the
10623     * widget.
10624     *
10625     * The appended text is subject to any filters set for the widget.
10626     *
10627     * @param obj The entry object
10628     * @param entry The text to be displayed
10629     *
10630     * @see elm_entry_text_filter_append()
10631     */
10632    EAPI void         elm_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
10633    /**
10634     * Gets whether the entry is empty.
10635     *
10636     * Empty means no text at all. If there are any markup tags, like an item
10637     * tag for which no provider finds anything, and no text is displayed, this
10638     * function still returns EINA_FALSE.
10639     *
10640     * @param obj The entry object
10641     * @return EINA_TRUE if the entry is empty, EINA_FALSE otherwise.
10642     */
10643    EAPI Eina_Bool    elm_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10644    /**
10645     * Gets any selected text within the entry.
10646     *
10647     * If there's any selected text in the entry, this function returns it as
10648     * a string in markup format. NULL is returned if no selection exists or
10649     * if an error occurred.
10650     *
10651     * The returned value points to an internal string and should not be freed
10652     * or modified in any way. If the @p entry object is deleted or its
10653     * contents are changed, the returned pointer should be considered invalid.
10654     *
10655     * @param obj The entry object
10656     * @return The selected text within the entry or NULL on failure
10657     */
10658    EAPI const char  *elm_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10659    /**
10660     * Inserts the given text into the entry at the current cursor position.
10661     *
10662     * This inserts text at the cursor position as if it was typed
10663     * by the user (note that this also allows markup which a user
10664     * can't just "type" as it would be converted to escaped text, so this
10665     * call can be used to insert things like emoticon items or bold push/pop
10666     * tags, other font and color change tags etc.)
10667     *
10668     * If any selection exists, it will be replaced by the inserted text.
10669     *
10670     * The inserted text is subject to any filters set for the widget.
10671     *
10672     * @param obj The entry object
10673     * @param entry The text to insert
10674     *
10675     * @see elm_entry_text_filter_append()
10676     */
10677    EAPI void         elm_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
10678    /**
10679     * Set the line wrap type to use on multi-line entries.
10680     *
10681     * Sets the wrap type used by the entry to any of the specified in
10682     * #Elm_Wrap_Type. This tells how the text will be implicitly cut into a new
10683     * line (without inserting a line break or paragraph separator) when it
10684     * reaches the far edge of the widget.
10685     *
10686     * Note that this only makes sense for multi-line entries. A widget set
10687     * to be single line will never wrap.
10688     *
10689     * @param obj The entry object
10690     * @param wrap The wrap mode to use. See #Elm_Wrap_Type for details on them
10691     */
10692    EAPI void         elm_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
10693    /**
10694     * Gets the wrap mode the entry was set to use.
10695     *
10696     * @param obj The entry object
10697     * @return Wrap type
10698     *
10699     * @see also elm_entry_line_wrap_set()
10700     */
10701    EAPI Elm_Wrap_Type elm_entry_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10702    /**
10703     * Sets if the entry is to be editable or not.
10704     *
10705     * By default, entries are editable and when focused, any text input by the
10706     * user will be inserted at the current cursor position. But calling this
10707     * function with @p editable as EINA_FALSE will prevent the user from
10708     * inputting text into the entry.
10709     *
10710     * The only way to change the text of a non-editable entry is to use
10711     * elm_object_text_set(), elm_entry_entry_insert() and other related
10712     * functions.
10713     *
10714     * @param obj The entry object
10715     * @param editable If EINA_TRUE, user input will be inserted in the entry,
10716     * if not, the entry is read-only and no user input is allowed.
10717     */
10718    EAPI void         elm_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
10719    /**
10720     * Gets whether the entry is editable or not.
10721     *
10722     * @param obj The entry object
10723     * @return If true, the entry is editable by the user.
10724     * If false, it is not editable by the user
10725     *
10726     * @see elm_entry_editable_set()
10727     */
10728    EAPI Eina_Bool    elm_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10729    /**
10730     * This drops any existing text selection within the entry.
10731     *
10732     * @param obj The entry object
10733     */
10734    EAPI void         elm_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
10735    /**
10736     * This selects all text within the entry.
10737     *
10738     * @param obj The entry object
10739     */
10740    EAPI void         elm_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
10741    /**
10742     * This moves the cursor one place to the right within the entry.
10743     *
10744     * @param obj The entry object
10745     * @return EINA_TRUE upon success, EINA_FALSE upon failure
10746     */
10747    EAPI Eina_Bool    elm_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
10748    /**
10749     * This moves the cursor one place to the left within the entry.
10750     *
10751     * @param obj The entry object
10752     * @return EINA_TRUE upon success, EINA_FALSE upon failure
10753     */
10754    EAPI Eina_Bool    elm_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
10755    /**
10756     * This moves the cursor one line up within the entry.
10757     *
10758     * @param obj The entry object
10759     * @return EINA_TRUE upon success, EINA_FALSE upon failure
10760     */
10761    EAPI Eina_Bool    elm_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
10762    /**
10763     * This moves the cursor one line down within the entry.
10764     *
10765     * @param obj The entry object
10766     * @return EINA_TRUE upon success, EINA_FALSE upon failure
10767     */
10768    EAPI Eina_Bool    elm_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
10769    /**
10770     * This moves the cursor to the beginning of the entry.
10771     *
10772     * @param obj The entry object
10773     */
10774    EAPI void         elm_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
10775    /**
10776     * This moves the cursor to the end of the entry.
10777     *
10778     * @param obj The entry object
10779     */
10780    EAPI void         elm_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
10781    /**
10782     * This moves the cursor to the beginning of the current line.
10783     *
10784     * @param obj The entry object
10785     */
10786    EAPI void         elm_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
10787    /**
10788     * This moves the cursor to the end of the current line.
10789     *
10790     * @param obj The entry object
10791     */
10792    EAPI void         elm_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
10793    /**
10794     * This begins a selection within the entry as though
10795     * the user were holding down the mouse button to make a selection.
10796     *
10797     * @param obj The entry object
10798     */
10799    EAPI void         elm_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
10800    /**
10801     * This ends a selection within the entry as though
10802     * the user had just released the mouse button while making a selection.
10803     *
10804     * @param obj The entry object
10805     */
10806    EAPI void         elm_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
10807    /**
10808     * Gets whether a format node exists at the current cursor position.
10809     *
10810     * A format node is anything that defines how the text is rendered. It can
10811     * be a visible format node, such as a line break or a paragraph separator,
10812     * or an invisible one, such as bold begin or end tag.
10813     * This function returns whether any format node exists at the current
10814     * cursor position.
10815     *
10816     * @param obj The entry object
10817     * @return EINA_TRUE if the current cursor position contains a format node,
10818     * EINA_FALSE otherwise.
10819     *
10820     * @see elm_entry_cursor_is_visible_format_get()
10821     */
10822    EAPI Eina_Bool    elm_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10823    /**
10824     * Gets if the current cursor position holds a visible format node.
10825     *
10826     * @param obj The entry object
10827     * @return EINA_TRUE if the current cursor is a visible format, EINA_FALSE
10828     * if it's an invisible one or no format exists.
10829     *
10830     * @see elm_entry_cursor_is_format_get()
10831     */
10832    EAPI Eina_Bool    elm_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10833    /**
10834     * Gets the character pointed by the cursor at its current position.
10835     *
10836     * This function returns a string with the utf8 character stored at the
10837     * current cursor position.
10838     * Only the text is returned, any format that may exist will not be part
10839     * of the return value.
10840     *
10841     * @param obj The entry object
10842     * @return The text pointed by the cursors.
10843     */
10844    EAPI const char  *elm_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10845    /**
10846     * This function returns the geometry of the cursor.
10847     *
10848     * It's useful if you want to draw something on the cursor (or where it is),
10849     * or for example in the case of scrolled entry where you want to show the
10850     * cursor.
10851     *
10852     * @param obj The entry object
10853     * @param x returned geometry
10854     * @param y returned geometry
10855     * @param w returned geometry
10856     * @param h returned geometry
10857     * @return EINA_TRUE upon success, EINA_FALSE upon failure
10858     */
10859    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);
10860    /**
10861     * Sets the cursor position in the entry to the given value
10862     *
10863     * The value in @p pos is the index of the character position within the
10864     * contents of the string as returned by elm_entry_cursor_pos_get().
10865     *
10866     * @param obj The entry object
10867     * @param pos The position of the cursor
10868     */
10869    EAPI void         elm_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
10870    /**
10871     * Retrieves the current position of the cursor in the entry
10872     *
10873     * @param obj The entry object
10874     * @return The cursor position
10875     */
10876    EAPI int          elm_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10877    /**
10878     * This executes a "cut" action on the selected text in the entry.
10879     *
10880     * @param obj The entry object
10881     */
10882    EAPI void         elm_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
10883    /**
10884     * This executes a "copy" action on the selected text in the entry.
10885     *
10886     * @param obj The entry object
10887     */
10888    EAPI void         elm_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
10889    /**
10890     * This executes a "paste" action in the entry.
10891     *
10892     * @param obj The entry object
10893     */
10894    EAPI void         elm_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
10895    /**
10896     * This clears and frees the items in a entry's contextual (longpress)
10897     * menu.
10898     *
10899     * @param obj The entry object
10900     *
10901     * @see elm_entry_context_menu_item_add()
10902     */
10903    EAPI void         elm_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
10904    /**
10905     * This adds an item to the entry's contextual menu.
10906     *
10907     * A longpress on an entry will make the contextual menu show up, if this
10908     * hasn't been disabled with elm_entry_context_menu_disabled_set().
10909     * By default, this menu provides a few options like enabling selection mode,
10910     * which is useful on embedded devices that need to be explicit about it,
10911     * and when a selection exists it also shows the copy and cut actions.
10912     *
10913     * With this function, developers can add other options to this menu to
10914     * perform any action they deem necessary.
10915     *
10916     * @param obj The entry object
10917     * @param label The item's text label
10918     * @param icon_file The item's icon file
10919     * @param icon_type The item's icon type
10920     * @param func The callback to execute when the item is clicked
10921     * @param data The data to associate with the item for related functions
10922     */
10923    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);
10924    /**
10925     * This disables the entry's contextual (longpress) menu.
10926     *
10927     * @param obj The entry object
10928     * @param disabled If true, the menu is disabled
10929     */
10930    EAPI void         elm_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
10931    /**
10932     * This returns whether the entry's contextual (longpress) menu is
10933     * disabled.
10934     *
10935     * @param obj The entry object
10936     * @return If true, the menu is disabled
10937     */
10938    EAPI Eina_Bool    elm_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10939    /**
10940     * This appends a custom item provider to the list for that entry
10941     *
10942     * This appends the given callback. The list is walked from beginning to end
10943     * with each function called given the item href string in the text. If the
10944     * function returns an object handle other than NULL (it should create an
10945     * object to do this), then this object is used to replace that item. If
10946     * not the next provider is called until one provides an item object, or the
10947     * default provider in entry does.
10948     *
10949     * @param obj The entry object
10950     * @param func The function called to provide the item object
10951     * @param data The data passed to @p func
10952     *
10953     * @see @ref entry-items
10954     */
10955    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);
10956    /**
10957     * This prepends a custom item provider to the list for that entry
10958     *
10959     * This prepends the given callback. See elm_entry_item_provider_append() for
10960     * more information
10961     *
10962     * @param obj The entry object
10963     * @param func The function called to provide the item object
10964     * @param data The data passed to @p func
10965     */
10966    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);
10967    /**
10968     * This removes a custom item provider to the list for that entry
10969     *
10970     * This removes the given callback. See elm_entry_item_provider_append() for
10971     * more information
10972     *
10973     * @param obj The entry object
10974     * @param func The function called to provide the item object
10975     * @param data The data passed to @p func
10976     */
10977    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);
10978    /**
10979     * Append a filter function for text inserted in the entry
10980     *
10981     * Append the given callback to the list. This functions will be called
10982     * whenever any text is inserted into the entry, with the text to be inserted
10983     * as a parameter. The callback function is free to alter the text in any way
10984     * it wants, but it must remember to free the given pointer and update it.
10985     * If the new text is to be discarded, the function can free it and set its
10986     * text parameter to NULL. This will also prevent any following filters from
10987     * being called.
10988     *
10989     * @param obj The entry object
10990     * @param func The function to use as text filter
10991     * @param data User data to pass to @p func
10992     */
10993    EAPI void         elm_entry_text_filter_append(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
10994    /**
10995     * Prepend a filter function for text insdrted in the entry
10996     *
10997     * Prepend the given callback to the list. See elm_entry_text_filter_append()
10998     * for more information
10999     *
11000     * @param obj The entry object
11001     * @param func The function to use as text filter
11002     * @param data User data to pass to @p func
11003     */
11004    EAPI void         elm_entry_text_filter_prepend(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11005    /**
11006     * Remove a filter from the list
11007     *
11008     * Removes the given callback from the filter list. See
11009     * elm_entry_text_filter_append() for more information.
11010     *
11011     * @param obj The entry object
11012     * @param func The filter function to remove
11013     * @param data The user data passed when adding the function
11014     */
11015    EAPI void         elm_entry_text_filter_remove(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11016    /**
11017     * This converts a markup (HTML-like) string into UTF-8.
11018     *
11019     * The returned string is a malloc'ed buffer and it should be freed when
11020     * not needed anymore.
11021     *
11022     * @param s The string (in markup) to be converted
11023     * @return The converted string (in UTF-8). It should be freed.
11024     */
11025    EAPI char        *elm_entry_markup_to_utf8(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
11026    /**
11027     * This converts a UTF-8 string into markup (HTML-like).
11028     *
11029     * The returned string is a malloc'ed buffer and it should be freed when
11030     * not needed anymore.
11031     *
11032     * @param s The string (in UTF-8) to be converted
11033     * @return The converted string (in markup). It should be freed.
11034     */
11035    EAPI char        *elm_entry_utf8_to_markup(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
11036    /**
11037     * This sets the file (and implicitly loads it) for the text to display and
11038     * then edit. All changes are written back to the file after a short delay if
11039     * the entry object is set to autosave (which is the default).
11040     *
11041     * If the entry had any other file set previously, any changes made to it
11042     * will be saved if the autosave feature is enabled, otherwise, the file
11043     * will be silently discarded and any non-saved changes will be lost.
11044     *
11045     * @param obj The entry object
11046     * @param file The path to the file to load and save
11047     * @param format The file format
11048     */
11049    EAPI void         elm_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
11050    /**
11051     * Gets the file being edited by the entry.
11052     *
11053     * This function can be used to retrieve any file set on the entry for
11054     * edition, along with the format used to load and save it.
11055     *
11056     * @param obj The entry object
11057     * @param file The path to the file to load and save
11058     * @param format The file format
11059     */
11060    EAPI void         elm_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
11061    /**
11062     * This function writes any changes made to the file set with
11063     * elm_entry_file_set()
11064     *
11065     * @param obj The entry object
11066     */
11067    EAPI void         elm_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
11068    /**
11069     * This sets the entry object to 'autosave' the loaded text file or not.
11070     *
11071     * @param obj The entry object
11072     * @param autosave Autosave the loaded file or not
11073     *
11074     * @see elm_entry_file_set()
11075     */
11076    EAPI void         elm_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
11077    /**
11078     * This gets the entry object's 'autosave' status.
11079     *
11080     * @param obj The entry object
11081     * @return Autosave the loaded file or not
11082     *
11083     * @see elm_entry_file_set()
11084     */
11085    EAPI Eina_Bool    elm_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11086    /**
11087     * Control pasting of text and images for the widget.
11088     *
11089     * Normally the entry allows both text and images to be pasted.  By setting
11090     * textonly to be true, this prevents images from being pasted.
11091     *
11092     * Note this only changes the behaviour of text.
11093     *
11094     * @param obj The entry object
11095     * @param textonly paste mode - EINA_TRUE is text only, EINA_FALSE is
11096     * text+image+other.
11097     */
11098    EAPI void         elm_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
11099    /**
11100     * Getting elm_entry text paste/drop mode.
11101     *
11102     * In textonly mode, only text may be pasted or dropped into the widget.
11103     *
11104     * @param obj The entry object
11105     * @return If the widget only accepts text from pastes.
11106     */
11107    EAPI Eina_Bool    elm_entry_cnp_textonly_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11108    /**
11109     * Enable or disable scrolling in entry
11110     *
11111     * Normally the entry is not scrollable unless you enable it with this call.
11112     *
11113     * @param obj The entry object
11114     * @param scroll EINA_TRUE if it is to be scrollable, EINA_FALSE otherwise
11115     */
11116    EAPI void         elm_entry_scrollable_set(Evas_Object *obj, Eina_Bool scroll);
11117    /**
11118     * Get the scrollable state of the entry
11119     *
11120     * Normally the entry is not scrollable. This gets the scrollable state
11121     * of the entry. See elm_entry_scrollable_set() for more information.
11122     *
11123     * @param obj The entry object
11124     * @return The scrollable state
11125     */
11126    EAPI Eina_Bool    elm_entry_scrollable_get(const Evas_Object *obj);
11127    /**
11128     * This sets a widget to be displayed to the left of a scrolled entry.
11129     *
11130     * @param obj The scrolled entry object
11131     * @param icon The widget to display on the left side of the scrolled
11132     * entry.
11133     *
11134     * @note A previously set widget will be destroyed.
11135     * @note If the object being set does not have minimum size hints set,
11136     * it won't get properly displayed.
11137     *
11138     * @see elm_entry_end_set()
11139     */
11140    EAPI void         elm_entry_icon_set(Evas_Object *obj, Evas_Object *icon);
11141    /**
11142     * Gets the leftmost widget of the scrolled entry. This object is
11143     * owned by the scrolled entry and should not be modified.
11144     *
11145     * @param obj The scrolled entry object
11146     * @return the left widget inside the scroller
11147     */
11148    EAPI Evas_Object *elm_entry_icon_get(const Evas_Object *obj);
11149    /**
11150     * Unset the leftmost widget of the scrolled entry, unparenting and
11151     * returning it.
11152     *
11153     * @param obj The scrolled entry object
11154     * @return the previously set icon sub-object of this entry, on
11155     * success.
11156     *
11157     * @see elm_entry_icon_set()
11158     */
11159    EAPI Evas_Object *elm_entry_icon_unset(Evas_Object *obj);
11160    /**
11161     * Sets the visibility of the left-side widget of the scrolled entry,
11162     * set by elm_entry_icon_set().
11163     *
11164     * @param obj The scrolled entry object
11165     * @param setting EINA_TRUE if the object should be displayed,
11166     * EINA_FALSE if not.
11167     */
11168    EAPI void         elm_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting);
11169    /**
11170     * This sets a widget to be displayed to the end of a scrolled entry.
11171     *
11172     * @param obj The scrolled entry object
11173     * @param end The widget to display on the right side of the scrolled
11174     * entry.
11175     *
11176     * @note A previously set widget will be destroyed.
11177     * @note If the object being set does not have minimum size hints set,
11178     * it won't get properly displayed.
11179     *
11180     * @see elm_entry_icon_set
11181     */
11182    EAPI void         elm_entry_end_set(Evas_Object *obj, Evas_Object *end);
11183    /**
11184     * Gets the endmost widget of the scrolled entry. This object is owned
11185     * by the scrolled entry and should not be modified.
11186     *
11187     * @param obj The scrolled entry object
11188     * @return the right widget inside the scroller
11189     */
11190    EAPI Evas_Object *elm_entry_end_get(const Evas_Object *obj);
11191    /**
11192     * Unset the endmost widget of the scrolled entry, unparenting and
11193     * returning it.
11194     *
11195     * @param obj The scrolled entry object
11196     * @return the previously set icon sub-object of this entry, on
11197     * success.
11198     *
11199     * @see elm_entry_icon_set()
11200     */
11201    EAPI Evas_Object *elm_entry_end_unset(Evas_Object *obj);
11202    /**
11203     * Sets the visibility of the end widget of the scrolled entry, set by
11204     * elm_entry_end_set().
11205     *
11206     * @param obj The scrolled entry object
11207     * @param setting EINA_TRUE if the object should be displayed,
11208     * EINA_FALSE if not.
11209     */
11210    EAPI void         elm_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting);
11211    /**
11212     * This sets the scrolled entry's scrollbar policy (ie. enabling/disabling
11213     * them).
11214     *
11215     * Setting an entry to single-line mode with elm_entry_single_line_set()
11216     * will automatically disable the display of scrollbars when the entry
11217     * moves inside its scroller.
11218     *
11219     * @param obj The scrolled entry object
11220     * @param h The horizontal scrollbar policy to apply
11221     * @param v The vertical scrollbar policy to apply
11222     */
11223    EAPI void         elm_entry_scrollbar_policy_set(Evas_Object *obj, Elm_Scroller_Policy h, Elm_Scroller_Policy v);
11224    /**
11225     * This enables/disables bouncing within the entry.
11226     *
11227     * This function sets whether the entry will bounce when scrolling reaches
11228     * the end of the contained entry.
11229     *
11230     * @param obj The scrolled entry object
11231     * @param h The horizontal bounce state
11232     * @param v The vertical bounce state
11233     */
11234    EAPI void         elm_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
11235    /**
11236     * Get the bounce mode
11237     *
11238     * @param obj The Entry object
11239     * @param h_bounce Allow bounce horizontally
11240     * @param v_bounce Allow bounce vertically
11241     */
11242    EAPI void         elm_entry_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
11243
11244    /* pre-made filters for entries */
11245    /**
11246     * @typedef Elm_Entry_Filter_Limit_Size
11247     *
11248     * Data for the elm_entry_filter_limit_size() entry filter.
11249     */
11250    typedef struct _Elm_Entry_Filter_Limit_Size Elm_Entry_Filter_Limit_Size;
11251    /**
11252     * @struct _Elm_Entry_Filter_Limit_Size
11253     *
11254     * Data for the elm_entry_filter_limit_size() entry filter.
11255     */
11256    struct _Elm_Entry_Filter_Limit_Size
11257      {
11258         int max_char_count; /**< The maximum number of characters allowed. */
11259         int max_byte_count; /**< The maximum number of bytes allowed*/
11260      };
11261    /**
11262     * Filter inserted text based on user defined character and byte limits
11263     *
11264     * Add this filter to an entry to limit the characters that it will accept
11265     * based the the contents of the provided #Elm_Entry_Filter_Limit_Size.
11266     * The funtion works on the UTF-8 representation of the string, converting
11267     * it from the set markup, thus not accounting for any format in it.
11268     *
11269     * The user must create an #Elm_Entry_Filter_Limit_Size structure and pass
11270     * it as data when setting the filter. In it, it's possible to set limits
11271     * by character count or bytes (any of them is disabled if 0), and both can
11272     * be set at the same time. In that case, it first checks for characters,
11273     * then bytes.
11274     *
11275     * The function will cut the inserted text in order to allow only the first
11276     * number of characters that are still allowed. The cut is made in
11277     * characters, even when limiting by bytes, in order to always contain
11278     * valid ones and avoid half unicode characters making it in.
11279     *
11280     * This filter, like any others, does not apply when setting the entry text
11281     * directly with elm_object_text_set() (or the deprecated
11282     * elm_entry_entry_set()).
11283     */
11284    EAPI void         elm_entry_filter_limit_size(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 2, 3);
11285    /**
11286     * @typedef Elm_Entry_Filter_Accept_Set
11287     *
11288     * Data for the elm_entry_filter_accept_set() entry filter.
11289     */
11290    typedef struct _Elm_Entry_Filter_Accept_Set Elm_Entry_Filter_Accept_Set;
11291    /**
11292     * @struct _Elm_Entry_Filter_Accept_Set
11293     *
11294     * Data for the elm_entry_filter_accept_set() entry filter.
11295     */
11296    struct _Elm_Entry_Filter_Accept_Set
11297      {
11298         const char *accepted; /**< Set of characters accepted in the entry. */
11299         const char *rejected; /**< Set of characters rejected from the entry. */
11300      };
11301    /**
11302     * Filter inserted text based on accepted or rejected sets of characters
11303     *
11304     * Add this filter to an entry to restrict the set of accepted characters
11305     * based on the sets in the provided #Elm_Entry_Filter_Accept_Set.
11306     * This structure contains both accepted and rejected sets, but they are
11307     * mutually exclusive.
11308     *
11309     * The @c accepted set takes preference, so if it is set, the filter will
11310     * only work based on the accepted characters, ignoring anything in the
11311     * @c rejected value. If @c accepted is @c NULL, then @c rejected is used.
11312     *
11313     * In both cases, the function filters by matching utf8 characters to the
11314     * raw markup text, so it can be used to remove formatting tags.
11315     *
11316     * This filter, like any others, does not apply when setting the entry text
11317     * directly with elm_object_text_set() (or the deprecated
11318     * elm_entry_entry_set()).
11319     */
11320    EAPI void         elm_entry_filter_accept_set(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 3);
11321    /**
11322     * @}
11323     */
11324
11325    /* composite widgets - these basically put together basic widgets above
11326     * in convenient packages that do more than basic stuff */
11327
11328    /* anchorview */
11329    /**
11330     * @defgroup Anchorview Anchorview
11331     *
11332     * @image html img/widget/anchorview/preview-00.png
11333     * @image latex img/widget/anchorview/preview-00.eps
11334     *
11335     * Anchorview is for displaying text that contains markup with anchors
11336     * like <c>\<a href=1234\>something\</\></c> in it.
11337     *
11338     * Besides being styled differently, the anchorview widget provides the
11339     * necessary functionality so that clicking on these anchors brings up a
11340     * popup with user defined content such as "call", "add to contacts" or
11341     * "open web page". This popup is provided using the @ref Hover widget.
11342     *
11343     * This widget is very similar to @ref Anchorblock, so refer to that
11344     * widget for an example. The only difference Anchorview has is that the
11345     * widget is already provided with scrolling functionality, so if the
11346     * text set to it is too large to fit in the given space, it will scroll,
11347     * whereas the @ref Anchorblock widget will keep growing to ensure all the
11348     * text can be displayed.
11349     *
11350     * This widget emits the following signals:
11351     * @li "anchor,clicked": will be called when an anchor is clicked. The
11352     * @p event_info parameter on the callback will be a pointer of type
11353     * ::Elm_Entry_Anchorview_Info.
11354     *
11355     * See @ref Anchorblock for an example on how to use both of them.
11356     *
11357     * @see Anchorblock
11358     * @see Entry
11359     * @see Hover
11360     *
11361     * @{
11362     */
11363    /**
11364     * @typedef Elm_Entry_Anchorview_Info
11365     *
11366     * The info sent in the callback for "anchor,clicked" signals emitted by
11367     * the Anchorview widget.
11368     */
11369    typedef struct _Elm_Entry_Anchorview_Info Elm_Entry_Anchorview_Info;
11370    /**
11371     * @struct _Elm_Entry_Anchorview_Info
11372     *
11373     * The info sent in the callback for "anchor,clicked" signals emitted by
11374     * the Anchorview widget.
11375     */
11376    struct _Elm_Entry_Anchorview_Info
11377      {
11378         const char     *name; /**< Name of the anchor, as indicated in its href
11379                                    attribute */
11380         int             button; /**< The mouse button used to click on it */
11381         Evas_Object    *hover; /**< The hover object to use for the popup */
11382         struct {
11383              Evas_Coord    x, y, w, h;
11384         } anchor, /**< Geometry selection of text used as anchor */
11385           hover_parent; /**< Geometry of the object used as parent by the
11386                              hover */
11387         Eina_Bool       hover_left : 1; /**< Hint indicating if there's space
11388                                              for content on the left side of
11389                                              the hover. Before calling the
11390                                              callback, the widget will make the
11391                                              necessary calculations to check
11392                                              which sides are fit to be set with
11393                                              content, based on the position the
11394                                              hover is activated and its distance
11395                                              to the edges of its parent object
11396                                              */
11397         Eina_Bool       hover_right : 1; /**< Hint indicating content fits on
11398                                               the right side of the hover.
11399                                               See @ref hover_left */
11400         Eina_Bool       hover_top : 1; /**< Hint indicating content fits on top
11401                                             of the hover. See @ref hover_left */
11402         Eina_Bool       hover_bottom : 1; /**< Hint indicating content fits
11403                                                below the hover. See @ref
11404                                                hover_left */
11405      };
11406    /**
11407     * Add a new Anchorview object
11408     *
11409     * @param parent The parent object
11410     * @return The new object or NULL if it cannot be created
11411     */
11412    EAPI Evas_Object *elm_anchorview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11413    /**
11414     * Set the text to show in the anchorview
11415     *
11416     * Sets the text of the anchorview to @p text. This text can include markup
11417     * format tags, including <c>\<a href=anchorname\></c> to begin a segment of
11418     * text that will be specially styled and react to click events, ended with
11419     * either of \</a\> or \</\>. When clicked, the anchor will emit an
11420     * "anchor,clicked" signal that you can attach a callback to with
11421     * evas_object_smart_callback_add(). The name of the anchor given in the
11422     * event info struct will be the one set in the href attribute, in this
11423     * case, anchorname.
11424     *
11425     * Other markup can be used to style the text in different ways, but it's
11426     * up to the style defined in the theme which tags do what.
11427     * @deprecated use elm_object_text_set() instead.
11428     */
11429    EINA_DEPRECATED EAPI void         elm_anchorview_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
11430    /**
11431     * Get the markup text set for the anchorview
11432     *
11433     * Retrieves the text set on the anchorview, with markup tags included.
11434     *
11435     * @param obj The anchorview object
11436     * @return The markup text set or @c NULL if nothing was set or an error
11437     * occurred
11438     * @deprecated use elm_object_text_set() instead.
11439     */
11440    EINA_DEPRECATED EAPI const char  *elm_anchorview_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11441    /**
11442     * Set the parent of the hover popup
11443     *
11444     * Sets the parent object to use by the hover created by the anchorview
11445     * when an anchor is clicked. See @ref Hover for more details on this.
11446     * If no parent is set, the same anchorview object will be used.
11447     *
11448     * @param obj The anchorview object
11449     * @param parent The object to use as parent for the hover
11450     */
11451    EAPI void         elm_anchorview_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
11452    /**
11453     * Get the parent of the hover popup
11454     *
11455     * Get the object used as parent for the hover created by the anchorview
11456     * widget. See @ref Hover for more details on this.
11457     *
11458     * @param obj The anchorview object
11459     * @return The object used as parent for the hover, NULL if none is set.
11460     */
11461    EAPI Evas_Object *elm_anchorview_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11462    /**
11463     * Set the style that the hover should use
11464     *
11465     * When creating the popup hover, anchorview will request that it's
11466     * themed according to @p style.
11467     *
11468     * @param obj The anchorview object
11469     * @param style The style to use for the underlying hover
11470     *
11471     * @see elm_object_style_set()
11472     */
11473    EAPI void         elm_anchorview_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
11474    /**
11475     * Get the style that the hover should use
11476     *
11477     * Get the style the hover created by anchorview will use.
11478     *
11479     * @param obj The anchorview object
11480     * @return The style to use by the hover. NULL means the default is used.
11481     *
11482     * @see elm_object_style_set()
11483     */
11484    EAPI const char  *elm_anchorview_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11485    /**
11486     * Ends the hover popup in the anchorview
11487     *
11488     * When an anchor is clicked, the anchorview widget will create a hover
11489     * object to use as a popup with user provided content. This function
11490     * terminates this popup, returning the anchorview to its normal state.
11491     *
11492     * @param obj The anchorview object
11493     */
11494    EAPI void         elm_anchorview_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
11495    /**
11496     * Set bouncing behaviour when the scrolled content reaches an edge
11497     *
11498     * Tell the internal scroller object whether it should bounce or not
11499     * when it reaches the respective edges for each axis.
11500     *
11501     * @param obj The anchorview object
11502     * @param h_bounce Whether to bounce or not in the horizontal axis
11503     * @param v_bounce Whether to bounce or not in the vertical axis
11504     *
11505     * @see elm_scroller_bounce_set()
11506     */
11507    EAPI void         elm_anchorview_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
11508    /**
11509     * Get the set bouncing behaviour of the internal scroller
11510     *
11511     * Get whether the internal scroller should bounce when the edge of each
11512     * axis is reached scrolling.
11513     *
11514     * @param obj The anchorview object
11515     * @param h_bounce Pointer where to store the bounce state of the horizontal
11516     *                 axis
11517     * @param v_bounce Pointer where to store the bounce state of the vertical
11518     *                 axis
11519     *
11520     * @see elm_scroller_bounce_get()
11521     */
11522    EAPI void         elm_anchorview_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
11523    /**
11524     * Appends a custom item provider to the given anchorview
11525     *
11526     * Appends the given function to the list of items providers. This list is
11527     * called, one function at a time, with the given @p data pointer, the
11528     * anchorview object and, in the @p item parameter, the item name as
11529     * referenced in its href string. Following functions in the list will be
11530     * called in order until one of them returns something different to NULL,
11531     * which should be an Evas_Object which will be used in place of the item
11532     * element.
11533     *
11534     * Items in the markup text take the form \<item relsize=16x16 vsize=full
11535     * href=item/name\>\</item\>
11536     *
11537     * @param obj The anchorview object
11538     * @param func The function to add to the list of providers
11539     * @param data User data that will be passed to the callback function
11540     *
11541     * @see elm_entry_item_provider_append()
11542     */
11543    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);
11544    /**
11545     * Prepend a custom item provider to the given anchorview
11546     *
11547     * Like elm_anchorview_item_provider_append(), but it adds the function
11548     * @p func to the beginning of the list, instead of the end.
11549     *
11550     * @param obj The anchorview object
11551     * @param func The function to add to the list of providers
11552     * @param data User data that will be passed to the callback function
11553     */
11554    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);
11555    /**
11556     * Remove a custom item provider from the list of the given anchorview
11557     *
11558     * Removes the function and data pairing that matches @p func and @p data.
11559     * That is, unless the same function and same user data are given, the
11560     * function will not be removed from the list. This allows us to add the
11561     * same callback several times, with different @p data pointers and be
11562     * able to remove them later without conflicts.
11563     *
11564     * @param obj The anchorview object
11565     * @param func The function to remove from the list
11566     * @param data The data matching the function to remove from the list
11567     */
11568    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);
11569    /**
11570     * @}
11571     */
11572
11573    /* anchorblock */
11574    /**
11575     * @defgroup Anchorblock Anchorblock
11576     *
11577     * @image html img/widget/anchorblock/preview-00.png
11578     * @image latex img/widget/anchorblock/preview-00.eps
11579     *
11580     * Anchorblock is for displaying text that contains markup with anchors
11581     * like <c>\<a href=1234\>something\</\></c> in it.
11582     *
11583     * Besides being styled differently, the anchorblock widget provides the
11584     * necessary functionality so that clicking on these anchors brings up a
11585     * popup with user defined content such as "call", "add to contacts" or
11586     * "open web page". This popup is provided using the @ref Hover widget.
11587     *
11588     * This widget emits the following signals:
11589     * @li "anchor,clicked": will be called when an anchor is clicked. The
11590     * @p event_info parameter on the callback will be a pointer of type
11591     * ::Elm_Entry_Anchorblock_Info.
11592     *
11593     * @see Anchorview
11594     * @see Entry
11595     * @see Hover
11596     *
11597     * Since examples are usually better than plain words, we might as well
11598     * try @ref tutorial_anchorblock_example "one".
11599     */
11600    /**
11601     * @addtogroup Anchorblock
11602     * @{
11603     */
11604    /**
11605     * @typedef Elm_Entry_Anchorblock_Info
11606     *
11607     * The info sent in the callback for "anchor,clicked" signals emitted by
11608     * the Anchorblock widget.
11609     */
11610    typedef struct _Elm_Entry_Anchorblock_Info Elm_Entry_Anchorblock_Info;
11611    /**
11612     * @struct _Elm_Entry_Anchorblock_Info
11613     *
11614     * The info sent in the callback for "anchor,clicked" signals emitted by
11615     * the Anchorblock widget.
11616     */
11617    struct _Elm_Entry_Anchorblock_Info
11618      {
11619         const char     *name; /**< Name of the anchor, as indicated in its href
11620                                    attribute */
11621         int             button; /**< The mouse button used to click on it */
11622         Evas_Object    *hover; /**< The hover object to use for the popup */
11623         struct {
11624              Evas_Coord    x, y, w, h;
11625         } anchor, /**< Geometry selection of text used as anchor */
11626           hover_parent; /**< Geometry of the object used as parent by the
11627                              hover */
11628         Eina_Bool       hover_left : 1; /**< Hint indicating if there's space
11629                                              for content on the left side of
11630                                              the hover. Before calling the
11631                                              callback, the widget will make the
11632                                              necessary calculations to check
11633                                              which sides are fit to be set with
11634                                              content, based on the position the
11635                                              hover is activated and its distance
11636                                              to the edges of its parent object
11637                                              */
11638         Eina_Bool       hover_right : 1; /**< Hint indicating content fits on
11639                                               the right side of the hover.
11640                                               See @ref hover_left */
11641         Eina_Bool       hover_top : 1; /**< Hint indicating content fits on top
11642                                             of the hover. See @ref hover_left */
11643         Eina_Bool       hover_bottom : 1; /**< Hint indicating content fits
11644                                                below the hover. See @ref
11645                                                hover_left */
11646      };
11647    /**
11648     * Add a new Anchorblock object
11649     *
11650     * @param parent The parent object
11651     * @return The new object or NULL if it cannot be created
11652     */
11653    EAPI Evas_Object *elm_anchorblock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11654    /**
11655     * Set the text to show in the anchorblock
11656     *
11657     * Sets the text of the anchorblock to @p text. This text can include markup
11658     * format tags, including <c>\<a href=anchorname\></a></c> to begin a segment
11659     * of text that will be specially styled and react to click events, ended
11660     * with either of \</a\> or \</\>. When clicked, the anchor will emit an
11661     * "anchor,clicked" signal that you can attach a callback to with
11662     * evas_object_smart_callback_add(). The name of the anchor given in the
11663     * event info struct will be the one set in the href attribute, in this
11664     * case, anchorname.
11665     *
11666     * Other markup can be used to style the text in different ways, but it's
11667     * up to the style defined in the theme which tags do what.
11668     * @deprecated use elm_object_text_set() instead.
11669     */
11670    EINA_DEPRECATED EAPI void         elm_anchorblock_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
11671    /**
11672     * Get the markup text set for the anchorblock
11673     *
11674     * Retrieves the text set on the anchorblock, with markup tags included.
11675     *
11676     * @param obj The anchorblock object
11677     * @return The markup text set or @c NULL if nothing was set or an error
11678     * occurred
11679     * @deprecated use elm_object_text_set() instead.
11680     */
11681    EINA_DEPRECATED EAPI const char  *elm_anchorblock_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11682    /**
11683     * Set the parent of the hover popup
11684     *
11685     * Sets the parent object to use by the hover created by the anchorblock
11686     * when an anchor is clicked. See @ref Hover for more details on this.
11687     *
11688     * @param obj The anchorblock object
11689     * @param parent The object to use as parent for the hover
11690     */
11691    EAPI void         elm_anchorblock_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
11692    /**
11693     * Get the parent of the hover popup
11694     *
11695     * Get the object used as parent for the hover created by the anchorblock
11696     * widget. See @ref Hover for more details on this.
11697     * If no parent is set, the same anchorblock object will be used.
11698     *
11699     * @param obj The anchorblock object
11700     * @return The object used as parent for the hover, NULL if none is set.
11701     */
11702    EAPI Evas_Object *elm_anchorblock_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11703    /**
11704     * Set the style that the hover should use
11705     *
11706     * When creating the popup hover, anchorblock will request that it's
11707     * themed according to @p style.
11708     *
11709     * @param obj The anchorblock object
11710     * @param style The style to use for the underlying hover
11711     *
11712     * @see elm_object_style_set()
11713     */
11714    EAPI void         elm_anchorblock_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
11715    /**
11716     * Get the style that the hover should use
11717     *
11718     * Get the style the hover created by anchorblock will use.
11719     *
11720     * @param obj The anchorblock object
11721     * @return The style to use by the hover. NULL means the default is used.
11722     *
11723     * @see elm_object_style_set()
11724     */
11725    EAPI const char  *elm_anchorblock_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11726    /**
11727     * Ends the hover popup in the anchorblock
11728     *
11729     * When an anchor is clicked, the anchorblock widget will create a hover
11730     * object to use as a popup with user provided content. This function
11731     * terminates this popup, returning the anchorblock to its normal state.
11732     *
11733     * @param obj The anchorblock object
11734     */
11735    EAPI void         elm_anchorblock_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
11736    /**
11737     * Appends a custom item provider to the given anchorblock
11738     *
11739     * Appends the given function to the list of items providers. This list is
11740     * called, one function at a time, with the given @p data pointer, the
11741     * anchorblock object and, in the @p item parameter, the item name as
11742     * referenced in its href string. Following functions in the list will be
11743     * called in order until one of them returns something different to NULL,
11744     * which should be an Evas_Object which will be used in place of the item
11745     * element.
11746     *
11747     * Items in the markup text take the form \<item relsize=16x16 vsize=full
11748     * href=item/name\>\</item\>
11749     *
11750     * @param obj The anchorblock object
11751     * @param func The function to add to the list of providers
11752     * @param data User data that will be passed to the callback function
11753     *
11754     * @see elm_entry_item_provider_append()
11755     */
11756    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);
11757    /**
11758     * Prepend a custom item provider to the given anchorblock
11759     *
11760     * Like elm_anchorblock_item_provider_append(), but it adds the function
11761     * @p func to the beginning of the list, instead of the end.
11762     *
11763     * @param obj The anchorblock object
11764     * @param func The function to add to the list of providers
11765     * @param data User data that will be passed to the callback function
11766     */
11767    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);
11768    /**
11769     * Remove a custom item provider from the list of the given anchorblock
11770     *
11771     * Removes the function and data pairing that matches @p func and @p data.
11772     * That is, unless the same function and same user data are given, the
11773     * function will not be removed from the list. This allows us to add the
11774     * same callback several times, with different @p data pointers and be
11775     * able to remove them later without conflicts.
11776     *
11777     * @param obj The anchorblock object
11778     * @param func The function to remove from the list
11779     * @param data The data matching the function to remove from the list
11780     */
11781    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);
11782    /**
11783     * @}
11784     */
11785
11786    /**
11787     * @defgroup Bubble Bubble
11788     *
11789     * @image html img/widget/bubble/preview-00.png
11790     * @image latex img/widget/bubble/preview-00.eps
11791     * @image html img/widget/bubble/preview-01.png
11792     * @image latex img/widget/bubble/preview-01.eps
11793     * @image html img/widget/bubble/preview-02.png
11794     * @image latex img/widget/bubble/preview-02.eps
11795     *
11796     * @brief The Bubble is a widget to show text similarly to how speech is
11797     * represented in comics.
11798     *
11799     * The bubble widget contains 5 important visual elements:
11800     * @li The frame is a rectangle with rounded rectangles and an "arrow".
11801     * @li The @p icon is an image to which the frame's arrow points to.
11802     * @li The @p label is a text which appears to the right of the icon if the
11803     * corner is "top_left" or "bottom_left" and is right aligned to the frame
11804     * otherwise.
11805     * @li The @p info is a text which appears to the right of the label. Info's
11806     * font is of a ligther color than label.
11807     * @li The @p content is an evas object that is shown inside the frame.
11808     *
11809     * The position of the arrow, icon, label and info depends on which corner is
11810     * selected. The four available corners are:
11811     * @li "top_left" - Default
11812     * @li "top_right"
11813     * @li "bottom_left"
11814     * @li "bottom_right"
11815     *
11816     * Signals that you can add callbacks for are:
11817     * @li "clicked" - This is called when a user has clicked the bubble.
11818     *
11819     * For an example of using a buble see @ref bubble_01_example_page "this".
11820     *
11821     * @{
11822     */
11823    /**
11824     * Add a new bubble to the parent
11825     *
11826     * @param parent The parent object
11827     * @return The new object or NULL if it cannot be created
11828     *
11829     * This function adds a text bubble to the given parent evas object.
11830     */
11831    EAPI Evas_Object *elm_bubble_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11832    /**
11833     * Set the label of the bubble
11834     *
11835     * @param obj The bubble object
11836     * @param label The string to set in the label
11837     *
11838     * This function sets the title of the bubble. Where this appears depends on
11839     * the selected corner.
11840     * @deprecated use elm_object_text_set() instead.
11841     */
11842    EINA_DEPRECATED EAPI void         elm_bubble_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
11843    /**
11844     * Get the label of the bubble
11845     *
11846     * @param obj The bubble object
11847     * @return The string of set in the label
11848     *
11849     * This function gets the title of the bubble.
11850     * @deprecated use elm_object_text_get() instead.
11851     */
11852    EINA_DEPRECATED EAPI const char  *elm_bubble_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11853    /**
11854     * Set the info of the bubble
11855     *
11856     * @param obj The bubble object
11857     * @param info The given info about the bubble
11858     *
11859     * This function sets the info of the bubble. Where this appears depends on
11860     * the selected corner.
11861     * @deprecated use elm_object_text_part_set() instead. (with "info" as the parameter).
11862     */
11863    EINA_DEPRECATED EAPI void         elm_bubble_info_set(Evas_Object *obj, const char *info) EINA_ARG_NONNULL(1);
11864    /**
11865     * Get the info of the bubble
11866     *
11867     * @param obj The bubble object
11868     *
11869     * @return The "info" string of the bubble
11870     *
11871     * This function gets the info text.
11872     * @deprecated use elm_object_text_part_get() instead. (with "info" as the parameter).
11873     */
11874    EINA_DEPRECATED EAPI const char  *elm_bubble_info_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11875    /**
11876     * Set the content to be shown in the bubble
11877     *
11878     * Once the content object is set, a previously set one will be deleted.
11879     * If you want to keep the old content object, use the
11880     * elm_bubble_content_unset() function.
11881     *
11882     * @param obj The bubble object
11883     * @param content The given content of the bubble
11884     *
11885     * This function sets the content shown on the middle of the bubble.
11886     */
11887    EAPI void         elm_bubble_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
11888    /**
11889     * Get the content shown in the bubble
11890     *
11891     * Return the content object which is set for this widget.
11892     *
11893     * @param obj The bubble object
11894     * @return The content that is being used
11895     */
11896    EAPI Evas_Object *elm_bubble_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11897    /**
11898     * Unset the content shown in the bubble
11899     *
11900     * Unparent and return the content object which was set for this widget.
11901     *
11902     * @param obj The bubble object
11903     * @return The content that was being used
11904     */
11905    EAPI Evas_Object *elm_bubble_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
11906    /**
11907     * Set the icon of the bubble
11908     *
11909     * Once the icon object is set, a previously set one will be deleted.
11910     * If you want to keep the old content object, use the
11911     * elm_icon_content_unset() function.
11912     *
11913     * @param obj The bubble object
11914     * @param icon The given icon for the bubble
11915     */
11916    EAPI void         elm_bubble_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
11917    /**
11918     * Get the icon of the bubble
11919     *
11920     * @param obj The bubble object
11921     * @return The icon for the bubble
11922     *
11923     * This function gets the icon shown on the top left of bubble.
11924     */
11925    EAPI Evas_Object *elm_bubble_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11926    /**
11927     * Unset the icon of the bubble
11928     *
11929     * Unparent and return the icon object which was set for this widget.
11930     *
11931     * @param obj The bubble object
11932     * @return The icon that was being used
11933     */
11934    EAPI Evas_Object *elm_bubble_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
11935    /**
11936     * Set the corner of the bubble
11937     *
11938     * @param obj The bubble object.
11939     * @param corner The given corner for the bubble.
11940     *
11941     * This function sets the corner of the bubble. The corner will be used to
11942     * determine where the arrow in the frame points to and where label, icon and
11943     * info arre shown.
11944     *
11945     * Possible values for corner are:
11946     * @li "top_left" - Default
11947     * @li "top_right"
11948     * @li "bottom_left"
11949     * @li "bottom_right"
11950     */
11951    EAPI void         elm_bubble_corner_set(Evas_Object *obj, const char *corner) EINA_ARG_NONNULL(1, 2);
11952    /**
11953     * Get the corner of the bubble
11954     *
11955     * @param obj The bubble object.
11956     * @return The given corner for the bubble.
11957     *
11958     * This function gets the selected corner of the bubble.
11959     */
11960    EAPI const char  *elm_bubble_corner_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11961    /**
11962     * @}
11963     */
11964
11965    /**
11966     * @defgroup Photo Photo
11967     *
11968     * For displaying the photo of a person (contact). Simple yet
11969     * with a very specific purpose.
11970     *
11971     * Signals that you can add callbacks for are:
11972     *
11973     * "clicked" - This is called when a user has clicked the photo
11974     * "drag,start" - Someone started dragging the image out of the object
11975     * "drag,end" - Dragged item was dropped (somewhere)
11976     *
11977     * @{
11978     */
11979
11980    /**
11981     * Add a new photo to the parent
11982     *
11983     * @param parent The parent object
11984     * @return The new object or NULL if it cannot be created
11985     *
11986     * @ingroup Photo
11987     */
11988    EAPI Evas_Object *elm_photo_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11989
11990    /**
11991     * Set the file that will be used as photo
11992     *
11993     * @param obj The photo object
11994     * @param file The path to file that will be used as photo
11995     *
11996     * @return (1 = success, 0 = error)
11997     *
11998     * @ingroup Photo
11999     */
12000    EAPI Eina_Bool    elm_photo_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
12001
12002    /**
12003     * Set the size that will be used on the photo
12004     *
12005     * @param obj The photo object
12006     * @param size The size that the photo will be
12007     *
12008     * @ingroup Photo
12009     */
12010    EAPI void         elm_photo_size_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
12011
12012    /**
12013     * Set if the photo should be completely visible or not.
12014     *
12015     * @param obj The photo object
12016     * @param fill if true the photo will be completely visible
12017     *
12018     * @ingroup Photo
12019     */
12020    EAPI void         elm_photo_fill_inside_set(Evas_Object *obj, Eina_Bool fill) EINA_ARG_NONNULL(1);
12021
12022    /**
12023     * Set editability of the photo.
12024     *
12025     * An editable photo can be dragged to or from, and can be cut or
12026     * pasted too.  Note that pasting an image or dropping an item on
12027     * the image will delete the existing content.
12028     *
12029     * @param obj The photo object.
12030     * @param set To set of clear editablity.
12031     */
12032    EAPI void         elm_photo_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
12033
12034    /**
12035     * @}
12036     */
12037
12038    /* gesture layer */
12039    /**
12040     * @defgroup Elm_Gesture_Layer Gesture Layer
12041     * Gesture Layer Usage:
12042     *
12043     * Use Gesture Layer to detect gestures.
12044     * The advantage is that you don't have to implement
12045     * gesture detection, just set callbacks of gesture state.
12046     * By using gesture layer we make standard interface.
12047     *
12048     * In order to use Gesture Layer you start with @ref elm_gesture_layer_add
12049     * with a parent object parameter.
12050     * Next 'activate' gesture layer with a @ref elm_gesture_layer_attach
12051     * call. Usually with same object as target (2nd parameter).
12052     *
12053     * Now you need to tell gesture layer what gestures you follow.
12054     * This is done with @ref elm_gesture_layer_cb_set call.
12055     * By setting the callback you actually saying to gesture layer:
12056     * I would like to know when the gesture @ref Elm_Gesture_Types
12057     * switches to state @ref Elm_Gesture_State.
12058     *
12059     * Next, you need to implement the actual action that follows the input
12060     * in your callback.
12061     *
12062     * Note that if you like to stop being reported about a gesture, just set
12063     * all callbacks referring this gesture to NULL.
12064     * (again with @ref elm_gesture_layer_cb_set)
12065     *
12066     * The information reported by gesture layer to your callback is depending
12067     * on @ref Elm_Gesture_Types:
12068     * @ref Elm_Gesture_Taps_Info is the info reported for tap gestures:
12069     * @ref ELM_GESTURE_N_TAPS, @ref ELM_GESTURE_N_LONG_TAPS,
12070     * @ref ELM_GESTURE_N_DOUBLE_TAPS, @ref ELM_GESTURE_N_TRIPLE_TAPS.
12071     *
12072     * @ref Elm_Gesture_Momentum_Info is info reported for momentum gestures:
12073     * @ref ELM_GESTURE_MOMENTUM.
12074     *
12075     * @ref Elm_Gesture_Line_Info is the info reported for line gestures:
12076     * (this also contains @ref Elm_Gesture_Momentum_Info internal structure)
12077     * @ref ELM_GESTURE_N_LINES, @ref ELM_GESTURE_N_FLICKS.
12078     * Note that we consider a flick as a line-gesture that should be completed
12079     * in flick-time-limit as defined in @ref Config.
12080     *
12081     * @ref Elm_Gesture_Zoom_Info is the info reported for @ref ELM_GESTURE_ZOOM gesture.
12082     *
12083     * @ref Elm_Gesture_Rotate_Info is the info reported for @ref ELM_GESTURE_ROTATE gesture.
12084     * */
12085
12086    /**
12087     * @enum _Elm_Gesture_Types
12088     * Enum of supported gesture types.
12089     * @ingroup Elm_Gesture_Layer
12090     */
12091    enum _Elm_Gesture_Types
12092      {
12093         ELM_GESTURE_FIRST = 0,
12094
12095         ELM_GESTURE_N_TAPS, /**< N fingers single taps */
12096         ELM_GESTURE_N_LONG_TAPS, /**< N fingers single long-taps */
12097         ELM_GESTURE_N_DOUBLE_TAPS, /**< N fingers double-single taps */
12098         ELM_GESTURE_N_TRIPLE_TAPS, /**< N fingers triple-single taps */
12099
12100         ELM_GESTURE_MOMENTUM, /**< Reports momentum in the dircetion of move */
12101
12102         ELM_GESTURE_N_LINES, /**< N fingers line gesture */
12103         ELM_GESTURE_N_FLICKS, /**< N fingers flick gesture */
12104
12105         ELM_GESTURE_ZOOM, /**< Zoom */
12106         ELM_GESTURE_ROTATE, /**< Rotate */
12107
12108         ELM_GESTURE_LAST
12109      };
12110
12111    /**
12112     * @typedef Elm_Gesture_Types
12113     * gesture types enum
12114     * @ingroup Elm_Gesture_Layer
12115     */
12116    typedef enum _Elm_Gesture_Types Elm_Gesture_Types;
12117
12118    /**
12119     * @enum _Elm_Gesture_State
12120     * Enum of gesture states.
12121     * @ingroup Elm_Gesture_Layer
12122     */
12123    enum _Elm_Gesture_State
12124      {
12125         ELM_GESTURE_STATE_UNDEFINED = -1, /**< Gesture not STARTed */
12126         ELM_GESTURE_STATE_START,          /**< Gesture STARTed     */
12127         ELM_GESTURE_STATE_MOVE,           /**< Gesture is ongoing  */
12128         ELM_GESTURE_STATE_END,            /**< Gesture completed   */
12129         ELM_GESTURE_STATE_ABORT    /**< Onging gesture was ABORTed */
12130      };
12131
12132    /**
12133     * @typedef Elm_Gesture_State
12134     * gesture states enum
12135     * @ingroup Elm_Gesture_Layer
12136     */
12137    typedef enum _Elm_Gesture_State Elm_Gesture_State;
12138
12139    /**
12140     * @struct _Elm_Gesture_Taps_Info
12141     * Struct holds taps info for user
12142     * @ingroup Elm_Gesture_Layer
12143     */
12144    struct _Elm_Gesture_Taps_Info
12145      {
12146         Evas_Coord x, y;         /**< Holds center point between fingers */
12147         unsigned int n;          /**< Number of fingers tapped           */
12148         unsigned int timestamp;  /**< event timestamp       */
12149      };
12150
12151    /**
12152     * @typedef Elm_Gesture_Taps_Info
12153     * holds taps info for user
12154     * @ingroup Elm_Gesture_Layer
12155     */
12156    typedef struct _Elm_Gesture_Taps_Info Elm_Gesture_Taps_Info;
12157
12158    /**
12159     * @struct _Elm_Gesture_Momentum_Info
12160     * Struct holds momentum info for user
12161     * x1 and y1 are not necessarily in sync
12162     * x1 holds x value of x direction starting point
12163     * and same holds for y1.
12164     * This is noticeable when doing V-shape movement
12165     * @ingroup Elm_Gesture_Layer
12166     */
12167    struct _Elm_Gesture_Momentum_Info
12168      {  /* Report line ends, timestamps, and momentum computed        */
12169         Evas_Coord x1; /**< Final-swipe direction starting point on X */
12170         Evas_Coord y1; /**< Final-swipe direction starting point on Y */
12171         Evas_Coord x2; /**< Final-swipe direction ending point on X   */
12172         Evas_Coord y2; /**< Final-swipe direction ending point on Y   */
12173
12174         unsigned int tx; /**< Timestamp of start of final x-swipe */
12175         unsigned int ty; /**< Timestamp of start of final y-swipe */
12176
12177         Evas_Coord mx; /**< Momentum on X */
12178         Evas_Coord my; /**< Momentum on Y */
12179      };
12180
12181    /**
12182     * @typedef Elm_Gesture_Momentum_Info
12183     * holds momentum info for user
12184     * @ingroup Elm_Gesture_Layer
12185     */
12186     typedef struct _Elm_Gesture_Momentum_Info Elm_Gesture_Momentum_Info;
12187
12188    /**
12189     * @struct _Elm_Gesture_Line_Info
12190     * Struct holds line info for user
12191     * @ingroup Elm_Gesture_Layer
12192     */
12193    struct _Elm_Gesture_Line_Info
12194      {  /* Report line ends, timestamps, and momentum computed      */
12195         Elm_Gesture_Momentum_Info momentum; /**< Line momentum info */
12196         unsigned int n;            /**< Number of fingers (lines)   */
12197         /* FIXME should be radians, bot degrees */
12198         double angle;              /**< Angle (direction) of lines  */
12199      };
12200
12201    /**
12202     * @typedef Elm_Gesture_Line_Info
12203     * Holds line info for user
12204     * @ingroup Elm_Gesture_Layer
12205     */
12206     typedef struct  _Elm_Gesture_Line_Info Elm_Gesture_Line_Info;
12207
12208    /**
12209     * @struct _Elm_Gesture_Zoom_Info
12210     * Struct holds zoom info for user
12211     * @ingroup Elm_Gesture_Layer
12212     */
12213    struct _Elm_Gesture_Zoom_Info
12214      {
12215         Evas_Coord x, y;       /**< Holds zoom center point reported to user  */
12216         Evas_Coord radius; /**< Holds radius between fingers reported to user */
12217         double zoom;            /**< Zoom value: 1.0 means no zoom             */
12218         double momentum;        /**< Zoom momentum: zoom growth per second (NOT YET SUPPORTED) */
12219      };
12220
12221    /**
12222     * @typedef Elm_Gesture_Zoom_Info
12223     * Holds zoom info for user
12224     * @ingroup Elm_Gesture_Layer
12225     */
12226    typedef struct _Elm_Gesture_Zoom_Info Elm_Gesture_Zoom_Info;
12227
12228    /**
12229     * @struct _Elm_Gesture_Rotate_Info
12230     * Struct holds rotation info for user
12231     * @ingroup Elm_Gesture_Layer
12232     */
12233    struct _Elm_Gesture_Rotate_Info
12234      {
12235         Evas_Coord x, y;   /**< Holds zoom center point reported to user      */
12236         Evas_Coord radius; /**< Holds radius between fingers reported to user */
12237         double base_angle; /**< Holds start-angle */
12238         double angle;      /**< Rotation value: 0.0 means no rotation         */
12239         double momentum;   /**< Rotation momentum: rotation done per second (NOT YET SUPPORTED) */
12240      };
12241
12242    /**
12243     * @typedef Elm_Gesture_Rotate_Info
12244     * Holds rotation info for user
12245     * @ingroup Elm_Gesture_Layer
12246     */
12247    typedef struct _Elm_Gesture_Rotate_Info Elm_Gesture_Rotate_Info;
12248
12249    /**
12250     * @typedef Elm_Gesture_Event_Cb
12251     * User callback used to stream gesture info from gesture layer
12252     * @param data user data
12253     * @param event_info gesture report info
12254     * Returns a flag field to be applied on the causing event.
12255     * You should probably return EVAS_EVENT_FLAG_ON_HOLD if your widget acted
12256     * upon the event, in an irreversible way.
12257     *
12258     * @ingroup Elm_Gesture_Layer
12259     */
12260    typedef Evas_Event_Flags (*Elm_Gesture_Event_Cb) (void *data, void *event_info);
12261
12262    /**
12263     * Use function to set callbacks to be notified about
12264     * change of state of gesture.
12265     * When a user registers a callback with this function
12266     * this means this gesture has to be tested.
12267     *
12268     * When ALL callbacks for a gesture are set to NULL
12269     * it means user isn't interested in gesture-state
12270     * and it will not be tested.
12271     *
12272     * @param obj Pointer to gesture-layer.
12273     * @param idx The gesture you would like to track its state.
12274     * @param cb callback function pointer.
12275     * @param cb_type what event this callback tracks: START, MOVE, END, ABORT.
12276     * @param data user info to be sent to callback (usually, Smart Data)
12277     *
12278     * @ingroup Elm_Gesture_Layer
12279     */
12280    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);
12281
12282    /**
12283     * Call this function to get repeat-events settings.
12284     *
12285     * @param obj Pointer to gesture-layer.
12286     *
12287     * @return repeat events settings.
12288     * @see elm_gesture_layer_hold_events_set()
12289     * @ingroup Elm_Gesture_Layer
12290     */
12291    EAPI Eina_Bool elm_gesture_layer_hold_events_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
12292
12293    /**
12294     * This function called in order to make gesture-layer repeat events.
12295     * Set this of you like to get the raw events only if gestures were not detected.
12296     * Clear this if you like gesture layer to fwd events as testing gestures.
12297     *
12298     * @param obj Pointer to gesture-layer.
12299     * @param r Repeat: TRUE/FALSE
12300     *
12301     * @ingroup Elm_Gesture_Layer
12302     */
12303    EAPI void elm_gesture_layer_hold_events_set(Evas_Object *obj, Eina_Bool r) EINA_ARG_NONNULL(1);
12304
12305    /**
12306     * This function sets step-value for zoom action.
12307     * Set step to any positive value.
12308     * Cancel step setting by setting to 0.0
12309     *
12310     * @param obj Pointer to gesture-layer.
12311     * @param s new zoom step value.
12312     *
12313     * @ingroup Elm_Gesture_Layer
12314     */
12315    EAPI void elm_gesture_layer_zoom_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
12316
12317    /**
12318     * This function sets step-value for rotate action.
12319     * Set step to any positive value.
12320     * Cancel step setting by setting to 0.0
12321     *
12322     * @param obj Pointer to gesture-layer.
12323     * @param s new roatate step value.
12324     *
12325     * @ingroup Elm_Gesture_Layer
12326     */
12327    EAPI void elm_gesture_layer_rotate_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
12328
12329    /**
12330     * This function called to attach gesture-layer to an Evas_Object.
12331     * @param obj Pointer to gesture-layer.
12332     * @param t Pointer to underlying object (AKA Target)
12333     *
12334     * @return TRUE, FALSE on success, failure.
12335     *
12336     * @ingroup Elm_Gesture_Layer
12337     */
12338    EAPI Eina_Bool elm_gesture_layer_attach(Evas_Object *obj, Evas_Object *t) EINA_ARG_NONNULL(1, 2);
12339
12340    /**
12341     * Call this function to construct a new gesture-layer object.
12342     * This does not activate the gesture layer. You have to
12343     * call elm_gesture_layer_attach in order to 'activate' gesture-layer.
12344     *
12345     * @param parent the parent object.
12346     *
12347     * @return Pointer to new gesture-layer object.
12348     *
12349     * @ingroup Elm_Gesture_Layer
12350     */
12351    EAPI Evas_Object *elm_gesture_layer_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12352
12353    /**
12354     * @defgroup Thumb Thumb
12355     *
12356     * @image html img/widget/thumb/preview-00.png
12357     * @image latex img/widget/thumb/preview-00.eps
12358     *
12359     * A thumb object is used for displaying the thumbnail of an image or video.
12360     * You must have compiled Elementary with Ethumb_Client support and the DBus
12361     * service must be present and auto-activated in order to have thumbnails to
12362     * be generated.
12363     *
12364     * Once the thumbnail object becomes visible, it will check if there is a
12365     * previously generated thumbnail image for the file set on it. If not, it
12366     * will start generating this thumbnail.
12367     *
12368     * Different config settings will cause different thumbnails to be generated
12369     * even on the same file.
12370     *
12371     * Generated thumbnails are stored under @c $HOME/.thumbnails/. Check the
12372     * Ethumb documentation to change this path, and to see other configuration
12373     * options.
12374     *
12375     * Signals that you can add callbacks for are:
12376     *
12377     * - "clicked" - This is called when a user has clicked the thumb without dragging
12378     *             around.
12379     * - "clicked,double" - This is called when a user has double-clicked the thumb.
12380     * - "press" - This is called when a user has pressed down the thumb.
12381     * - "generate,start" - The thumbnail generation started.
12382     * - "generate,stop" - The generation process stopped.
12383     * - "generate,error" - The generation failed.
12384     * - "load,error" - The thumbnail image loading failed.
12385     *
12386     * available styles:
12387     * - default
12388     * - noframe
12389     *
12390     * An example of use of thumbnail:
12391     *
12392     * - @ref thumb_example_01
12393     */
12394
12395    /**
12396     * @addtogroup Thumb
12397     * @{
12398     */
12399
12400    /**
12401     * @enum _Elm_Thumb_Animation_Setting
12402     * @typedef Elm_Thumb_Animation_Setting
12403     *
12404     * Used to set if a video thumbnail is animating or not.
12405     *
12406     * @ingroup Thumb
12407     */
12408    typedef enum _Elm_Thumb_Animation_Setting
12409      {
12410         ELM_THUMB_ANIMATION_START = 0, /**< Play animation once */
12411         ELM_THUMB_ANIMATION_LOOP,      /**< Keep playing animation until stop is requested */
12412         ELM_THUMB_ANIMATION_STOP,      /**< Stop playing the animation */
12413         ELM_THUMB_ANIMATION_LAST
12414      } Elm_Thumb_Animation_Setting;
12415
12416    /**
12417     * Add a new thumb object to the parent.
12418     *
12419     * @param parent The parent object.
12420     * @return The new object or NULL if it cannot be created.
12421     *
12422     * @see elm_thumb_file_set()
12423     * @see elm_thumb_ethumb_client_get()
12424     *
12425     * @ingroup Thumb
12426     */
12427    EAPI Evas_Object                 *elm_thumb_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12428    /**
12429     * Reload thumbnail if it was generated before.
12430     *
12431     * @param obj The thumb object to reload
12432     *
12433     * This is useful if the ethumb client configuration changed, like its
12434     * size, aspect or any other property one set in the handle returned
12435     * by elm_thumb_ethumb_client_get().
12436     *
12437     * If the options didn't change, the thumbnail won't be generated again, but
12438     * the old one will still be used.
12439     *
12440     * @see elm_thumb_file_set()
12441     *
12442     * @ingroup Thumb
12443     */
12444    EAPI void                         elm_thumb_reload(Evas_Object *obj) EINA_ARG_NONNULL(1);
12445    /**
12446     * Set the file that will be used as thumbnail.
12447     *
12448     * @param obj The thumb object.
12449     * @param file The path to file that will be used as thumb.
12450     * @param key The key used in case of an EET file.
12451     *
12452     * The file can be an image or a video (in that case, acceptable extensions are:
12453     * avi, mp4, ogv, mov, mpg and wmv). To start the video animation, use the
12454     * function elm_thumb_animate().
12455     *
12456     * @see elm_thumb_file_get()
12457     * @see elm_thumb_reload()
12458     * @see elm_thumb_animate()
12459     *
12460     * @ingroup Thumb
12461     */
12462    EAPI void                         elm_thumb_file_set(Evas_Object *obj, const char *file, const char *key) EINA_ARG_NONNULL(1);
12463    /**
12464     * Get the image or video path and key used to generate the thumbnail.
12465     *
12466     * @param obj The thumb object.
12467     * @param file Pointer to filename.
12468     * @param key Pointer to key.
12469     *
12470     * @see elm_thumb_file_set()
12471     * @see elm_thumb_path_get()
12472     *
12473     * @ingroup Thumb
12474     */
12475    EAPI void                         elm_thumb_file_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
12476    /**
12477     * Get the path and key to the image or video generated by ethumb.
12478     *
12479     * One just need to make sure that the thumbnail was generated before getting
12480     * its path; otherwise, the path will be NULL. One way to do that is by asking
12481     * for the path when/after the "generate,stop" smart callback is called.
12482     *
12483     * @param obj The thumb object.
12484     * @param file Pointer to thumb path.
12485     * @param key Pointer to thumb key.
12486     *
12487     * @see elm_thumb_file_get()
12488     *
12489     * @ingroup Thumb
12490     */
12491    EAPI void                         elm_thumb_path_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
12492    /**
12493     * Set the animation state for the thumb object. If its content is an animated
12494     * video, you may start/stop the animation or tell it to play continuously and
12495     * looping.
12496     *
12497     * @param obj The thumb object.
12498     * @param setting The animation setting.
12499     *
12500     * @see elm_thumb_file_set()
12501     *
12502     * @ingroup Thumb
12503     */
12504    EAPI void                         elm_thumb_animate_set(Evas_Object *obj, Elm_Thumb_Animation_Setting s) EINA_ARG_NONNULL(1);
12505    /**
12506     * Get the animation state for the thumb object.
12507     *
12508     * @param obj The thumb object.
12509     * @return getting The animation setting or @c ELM_THUMB_ANIMATION_LAST,
12510     * on errors.
12511     *
12512     * @see elm_thumb_animate_set()
12513     *
12514     * @ingroup Thumb
12515     */
12516    EAPI Elm_Thumb_Animation_Setting  elm_thumb_animate_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12517    /**
12518     * Get the ethumb_client handle so custom configuration can be made.
12519     *
12520     * @return Ethumb_Client instance or NULL.
12521     *
12522     * This must be called before the objects are created to be sure no object is
12523     * visible and no generation started.
12524     *
12525     * Example of usage:
12526     *
12527     * @code
12528     * #include <Elementary.h>
12529     * #ifndef ELM_LIB_QUICKLAUNCH
12530     * EAPI int
12531     * elm_main(int argc, char **argv)
12532     * {
12533     *    Ethumb_Client *client;
12534     *
12535     *    elm_need_ethumb();
12536     *
12537     *    // ... your code
12538     *
12539     *    client = elm_thumb_ethumb_client_get();
12540     *    if (!client)
12541     *      {
12542     *         ERR("could not get ethumb_client");
12543     *         return 1;
12544     *      }
12545     *    ethumb_client_size_set(client, 100, 100);
12546     *    ethumb_client_crop_align_set(client, 0.5, 0.5);
12547     *    // ... your code
12548     *
12549     *    // Create elm_thumb objects here
12550     *
12551     *    elm_run();
12552     *    elm_shutdown();
12553     *    return 0;
12554     * }
12555     * #endif
12556     * ELM_MAIN()
12557     * @endcode
12558     *
12559     * @note There's only one client handle for Ethumb, so once a configuration
12560     * change is done to it, any other request for thumbnails (for any thumbnail
12561     * object) will use that configuration. Thus, this configuration is global.
12562     *
12563     * @ingroup Thumb
12564     */
12565    EAPI void                        *elm_thumb_ethumb_client_get(void);
12566    /**
12567     * Get the ethumb_client connection state.
12568     *
12569     * @return EINA_TRUE if the client is connected to the server or EINA_FALSE
12570     * otherwise.
12571     */
12572    EAPI Eina_Bool                    elm_thumb_ethumb_client_connected(void);
12573    /**
12574     * Make the thumbnail 'editable'.
12575     *
12576     * @param obj Thumb object.
12577     * @param set Turn on or off editability. Default is @c EINA_FALSE.
12578     *
12579     * This means the thumbnail is a valid drag target for drag and drop, and can be
12580     * cut or pasted too.
12581     *
12582     * @see elm_thumb_editable_get()
12583     *
12584     * @ingroup Thumb
12585     */
12586    EAPI Eina_Bool                    elm_thumb_editable_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
12587    /**
12588     * Make the thumbnail 'editable'.
12589     *
12590     * @param obj Thumb object.
12591     * @return Editability.
12592     *
12593     * This means the thumbnail is a valid drag target for drag and drop, and can be
12594     * cut or pasted too.
12595     *
12596     * @see elm_thumb_editable_set()
12597     *
12598     * @ingroup Thumb
12599     */
12600    EAPI Eina_Bool                    elm_thumb_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12601
12602    /**
12603     * @}
12604     */
12605
12606    /**
12607     * @defgroup Hoversel Hoversel
12608     *
12609     * @image html img/widget/hoversel/preview-00.png
12610     * @image latex img/widget/hoversel/preview-00.eps
12611     *
12612     * A hoversel is a button that pops up a list of items (automatically
12613     * choosing the direction to display) that have a label and, optionally, an
12614     * icon to select from. It is a convenience widget to avoid the need to do
12615     * all the piecing together yourself. It is intended for a small number of
12616     * items in the hoversel menu (no more than 8), though is capable of many
12617     * more.
12618     *
12619     * Signals that you can add callbacks for are:
12620     * "clicked" - the user clicked the hoversel button and popped up the sel
12621     * "selected" - an item in the hoversel list is selected. event_info is the item
12622     * "dismissed" - the hover is dismissed
12623     *
12624     * See @ref tutorial_hoversel for an example.
12625     * @{
12626     */
12627    typedef struct _Elm_Hoversel_Item Elm_Hoversel_Item; /**< Item of Elm_Hoversel. Sub-type of Elm_Widget_Item */
12628    /**
12629     * @brief Add a new Hoversel object
12630     *
12631     * @param parent The parent object
12632     * @return The new object or NULL if it cannot be created
12633     */
12634    EAPI Evas_Object       *elm_hoversel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12635    /**
12636     * @brief This sets the hoversel to expand horizontally.
12637     *
12638     * @param obj The hoversel object
12639     * @param horizontal If true, the hover will expand horizontally to the
12640     * right.
12641     *
12642     * @note The initial button will display horizontally regardless of this
12643     * setting.
12644     */
12645    EAPI void               elm_hoversel_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
12646    /**
12647     * @brief This returns whether the hoversel is set to expand horizontally.
12648     *
12649     * @param obj The hoversel object
12650     * @return If true, the hover will expand horizontally to the right.
12651     *
12652     * @see elm_hoversel_horizontal_set()
12653     */
12654    EAPI Eina_Bool          elm_hoversel_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12655    /**
12656     * @brief Set the Hover parent
12657     *
12658     * @param obj The hoversel object
12659     * @param parent The parent to use
12660     *
12661     * Sets the hover parent object, the area that will be darkened when the
12662     * hoversel is clicked. Should probably be the window that the hoversel is
12663     * in. See @ref Hover objects for more information.
12664     */
12665    EAPI void               elm_hoversel_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
12666    /**
12667     * @brief Get the Hover parent
12668     *
12669     * @param obj The hoversel object
12670     * @return The used parent
12671     *
12672     * Gets the hover parent object.
12673     *
12674     * @see elm_hoversel_hover_parent_set()
12675     */
12676    EAPI Evas_Object       *elm_hoversel_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12677    /**
12678     * @brief Set the hoversel button label
12679     *
12680     * @param obj The hoversel object
12681     * @param label The label text.
12682     *
12683     * This sets the label of the button that is always visible (before it is
12684     * clicked and expanded).
12685     *
12686     * @deprecated elm_object_text_set()
12687     */
12688    EINA_DEPRECATED EAPI void               elm_hoversel_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
12689    /**
12690     * @brief Get the hoversel button label
12691     *
12692     * @param obj The hoversel object
12693     * @return The label text.
12694     *
12695     * @deprecated elm_object_text_get()
12696     */
12697    EINA_DEPRECATED EAPI const char        *elm_hoversel_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12698    /**
12699     * @brief Set the icon of the hoversel button
12700     *
12701     * @param obj The hoversel object
12702     * @param icon The icon object
12703     *
12704     * Sets the icon of the button that is always visible (before it is clicked
12705     * and expanded).  Once the icon object is set, a previously set one will be
12706     * deleted, if you want to keep that old content object, use the
12707     * elm_hoversel_icon_unset() function.
12708     *
12709     * @see elm_button_icon_set()
12710     */
12711    EAPI void               elm_hoversel_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
12712    /**
12713     * @brief Get the icon of the hoversel button
12714     *
12715     * @param obj The hoversel object
12716     * @return The icon object
12717     *
12718     * Get the icon of the button that is always visible (before it is clicked
12719     * and expanded). Also see elm_button_icon_get().
12720     *
12721     * @see elm_hoversel_icon_set()
12722     */
12723    EAPI Evas_Object       *elm_hoversel_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12724    /**
12725     * @brief Get and unparent the icon of the hoversel button
12726     *
12727     * @param obj The hoversel object
12728     * @return The icon object that was being used
12729     *
12730     * Unparent and return the icon of the button that is always visible
12731     * (before it is clicked and expanded).
12732     *
12733     * @see elm_hoversel_icon_set()
12734     * @see elm_button_icon_unset()
12735     */
12736    EAPI Evas_Object       *elm_hoversel_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12737    /**
12738     * @brief This triggers the hoversel popup from code, the same as if the user
12739     * had clicked the button.
12740     *
12741     * @param obj The hoversel object
12742     */
12743    EAPI void               elm_hoversel_hover_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
12744    /**
12745     * @brief This dismisses the hoversel popup as if the user had clicked
12746     * outside the hover.
12747     *
12748     * @param obj The hoversel object
12749     */
12750    EAPI void               elm_hoversel_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
12751    /**
12752     * @brief Returns whether the hoversel is expanded.
12753     *
12754     * @param obj The hoversel object
12755     * @return  This will return EINA_TRUE if the hoversel is expanded or
12756     * EINA_FALSE if it is not expanded.
12757     */
12758    EAPI Eina_Bool          elm_hoversel_expanded_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12759    /**
12760     * @brief This will remove all the children items from the hoversel.
12761     *
12762     * @param obj The hoversel object
12763     *
12764     * @warning Should @b not be called while the hoversel is active; use
12765     * elm_hoversel_expanded_get() to check first.
12766     *
12767     * @see elm_hoversel_item_del_cb_set()
12768     * @see elm_hoversel_item_del()
12769     */
12770    EAPI void               elm_hoversel_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
12771    /**
12772     * @brief Get the list of items within the given hoversel.
12773     *
12774     * @param obj The hoversel object
12775     * @return Returns a list of Elm_Hoversel_Item*
12776     *
12777     * @see elm_hoversel_item_add()
12778     */
12779    EAPI const Eina_List   *elm_hoversel_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12780    /**
12781     * @brief Add an item to the hoversel button
12782     *
12783     * @param obj The hoversel object
12784     * @param label The text label to use for the item (NULL if not desired)
12785     * @param icon_file An image file path on disk to use for the icon or standard
12786     * icon name (NULL if not desired)
12787     * @param icon_type The icon type if relevant
12788     * @param func Convenience function to call when this item is selected
12789     * @param data Data to pass to item-related functions
12790     * @return A handle to the item added.
12791     *
12792     * This adds an item to the hoversel to show when it is clicked. Note: if you
12793     * need to use an icon from an edje file then use
12794     * elm_hoversel_item_icon_set() right after the this function, and set
12795     * icon_file to NULL here.
12796     *
12797     * For more information on what @p icon_file and @p icon_type are see the
12798     * @ref Icon "icon documentation".
12799     */
12800    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);
12801    /**
12802     * @brief Delete an item from the hoversel
12803     *
12804     * @param item The item to delete
12805     *
12806     * This deletes the item from the hoversel (should not be called while the
12807     * hoversel is active; use elm_hoversel_expanded_get() to check first).
12808     *
12809     * @see elm_hoversel_item_add()
12810     * @see elm_hoversel_item_del_cb_set()
12811     */
12812    EAPI void               elm_hoversel_item_del(Elm_Hoversel_Item *item) EINA_ARG_NONNULL(1);
12813    /**
12814     * @brief Set the function to be called when an item from the hoversel is
12815     * freed.
12816     *
12817     * @param item The item to set the callback on
12818     * @param func The function called
12819     *
12820     * That function will receive these parameters:
12821     * @li void *item_data
12822     * @li Evas_Object *the_item_object
12823     * @li Elm_Hoversel_Item *the_object_struct
12824     *
12825     * @see elm_hoversel_item_add()
12826     */
12827    EAPI void               elm_hoversel_item_del_cb_set(Elm_Hoversel_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
12828    /**
12829     * @brief This returns the data pointer supplied with elm_hoversel_item_add()
12830     * that will be passed to associated function callbacks.
12831     *
12832     * @param item The item to get the data from
12833     * @return The data pointer set with elm_hoversel_item_add()
12834     *
12835     * @see elm_hoversel_item_add()
12836     */
12837    EAPI void              *elm_hoversel_item_data_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
12838    /**
12839     * @brief This returns the label text of the given hoversel item.
12840     *
12841     * @param item The item to get the label
12842     * @return The label text of the hoversel item
12843     *
12844     * @see elm_hoversel_item_add()
12845     */
12846    EAPI const char        *elm_hoversel_item_label_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
12847    /**
12848     * @brief This sets the icon for the given hoversel item.
12849     *
12850     * @param item The item to set the icon
12851     * @param icon_file An image file path on disk to use for the icon or standard
12852     * icon name
12853     * @param icon_group The edje group to use if @p icon_file is an edje file. Set this
12854     * to NULL if the icon is not an edje file
12855     * @param icon_type The icon type
12856     *
12857     * The icon can be loaded from the standard set, from an image file, or from
12858     * an edje file.
12859     *
12860     * @see elm_hoversel_item_add()
12861     */
12862    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);
12863    /**
12864     * @brief Get the icon object of the hoversel item
12865     *
12866     * @param item The item to get the icon from
12867     * @param icon_file The image file path on disk used for the icon or standard
12868     * icon name
12869     * @param icon_group The edje group used if @p icon_file is an edje file. NULL
12870     * if the icon is not an edje file
12871     * @param icon_type The icon type
12872     *
12873     * @see elm_hoversel_item_icon_set()
12874     * @see elm_hoversel_item_add()
12875     */
12876    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);
12877    /**
12878     * @}
12879     */
12880
12881    /**
12882     * @defgroup Toolbar Toolbar
12883     * @ingroup Elementary
12884     *
12885     * @image html img/widget/toolbar/preview-00.png
12886     * @image latex img/widget/toolbar/preview-00.eps width=\textwidth
12887     *
12888     * @image html img/toolbar.png
12889     * @image latex img/toolbar.eps width=\textwidth
12890     *
12891     * A toolbar is a widget that displays a list of items inside
12892     * a box. It can be scrollable, show a menu with items that don't fit
12893     * to toolbar size or even crop them.
12894     *
12895     * Only one item can be selected at a time.
12896     *
12897     * Items can have multiple states, or show menus when selected by the user.
12898     *
12899     * Smart callbacks one can listen to:
12900     * - "clicked" - when the user clicks on a toolbar item and becomes selected.
12901     *
12902     * Available styles for it:
12903     * - @c "default"
12904     * - @c "transparent" - no background or shadow, just show the content
12905     *
12906     * List of examples:
12907     * @li @ref toolbar_example_01
12908     * @li @ref toolbar_example_02
12909     * @li @ref toolbar_example_03
12910     */
12911
12912    /**
12913     * @addtogroup Toolbar
12914     * @{
12915     */
12916
12917    /**
12918     * @enum _Elm_Toolbar_Shrink_Mode
12919     * @typedef Elm_Toolbar_Shrink_Mode
12920     *
12921     * Set toolbar's items display behavior, it can be scrollabel,
12922     * show a menu with exceeding items, or simply hide them.
12923     *
12924     * @note Default value is #ELM_TOOLBAR_SHRINK_MENU. It reads value
12925     * from elm config.
12926     *
12927     * Values <b> don't </b> work as bitmask, only one can be choosen.
12928     *
12929     * @see elm_toolbar_mode_shrink_set()
12930     * @see elm_toolbar_mode_shrink_get()
12931     *
12932     * @ingroup Toolbar
12933     */
12934    typedef enum _Elm_Toolbar_Shrink_Mode
12935      {
12936         ELM_TOOLBAR_SHRINK_NONE,   /**< Set toolbar minimun size to fit all the items. */
12937         ELM_TOOLBAR_SHRINK_HIDE,   /**< Hide exceeding items. */
12938         ELM_TOOLBAR_SHRINK_SCROLL, /**< Allow accessing exceeding items through a scroller. */
12939         ELM_TOOLBAR_SHRINK_MENU    /**< Inserts a button to pop up a menu with exceeding items. */
12940      } Elm_Toolbar_Shrink_Mode;
12941
12942    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(). */
12943
12944    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(). */
12945
12946    /**
12947     * Add a new toolbar widget to the given parent Elementary
12948     * (container) object.
12949     *
12950     * @param parent The parent object.
12951     * @return a new toolbar widget handle or @c NULL, on errors.
12952     *
12953     * This function inserts a new toolbar widget on the canvas.
12954     *
12955     * @ingroup Toolbar
12956     */
12957    EAPI Evas_Object            *elm_toolbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12958
12959    /**
12960     * Set the icon size, in pixels, to be used by toolbar items.
12961     *
12962     * @param obj The toolbar object
12963     * @param icon_size The icon size in pixels
12964     *
12965     * @note Default value is @c 32. It reads value from elm config.
12966     *
12967     * @see elm_toolbar_icon_size_get()
12968     *
12969     * @ingroup Toolbar
12970     */
12971    EAPI void                    elm_toolbar_icon_size_set(Evas_Object *obj, int icon_size) EINA_ARG_NONNULL(1);
12972
12973    /**
12974     * Get the icon size, in pixels, to be used by toolbar items.
12975     *
12976     * @param obj The toolbar object.
12977     * @return The icon size in pixels.
12978     *
12979     * @see elm_toolbar_icon_size_set() for details.
12980     *
12981     * @ingroup Toolbar
12982     */
12983    EAPI int                     elm_toolbar_icon_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12984
12985    /**
12986     * Sets icon lookup order, for toolbar items' icons.
12987     *
12988     * @param obj The toolbar object.
12989     * @param order The icon lookup order.
12990     *
12991     * Icons added before calling this function will not be affected.
12992     * The default lookup order is #ELM_ICON_LOOKUP_THEME_FDO.
12993     *
12994     * @see elm_toolbar_icon_order_lookup_get()
12995     *
12996     * @ingroup Toolbar
12997     */
12998    EAPI void                    elm_toolbar_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
12999
13000    /**
13001     * Gets the icon lookup order.
13002     *
13003     * @param obj The toolbar object.
13004     * @return The icon lookup order.
13005     *
13006     * @see elm_toolbar_icon_order_lookup_set() for details.
13007     *
13008     * @ingroup Toolbar
13009     */
13010    EAPI Elm_Icon_Lookup_Order   elm_toolbar_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13011
13012    /**
13013     * Set whether the toolbar items' should be selected by the user or not.
13014     *
13015     * @param obj The toolbar object.
13016     * @param wrap @c EINA_TRUE to disable selection or @c EINA_FALSE to
13017     * enable it.
13018     *
13019     * This will turn off the ability to select items entirely and they will
13020     * neither appear selected nor emit selected signals. The clicked
13021     * callback function will still be called.
13022     *
13023     * Selection is enabled by default.
13024     *
13025     * @see elm_toolbar_no_select_mode_get().
13026     *
13027     * @ingroup Toolbar
13028     */
13029    EAPI void                    elm_toolbar_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
13030
13031    /**
13032     * Set whether the toolbar items' should be selected by the user or not.
13033     *
13034     * @param obj The toolbar object.
13035     * @return @c EINA_TRUE means items can be selected. @c EINA_FALSE indicates
13036     * they can't. If @p obj is @c NULL, @c EINA_FALSE is returned.
13037     *
13038     * @see elm_toolbar_no_select_mode_set() for details.
13039     *
13040     * @ingroup Toolbar
13041     */
13042    EAPI Eina_Bool               elm_toolbar_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13043
13044    /**
13045     * Append item to the toolbar.
13046     *
13047     * @param obj The toolbar object.
13048     * @param icon A string with icon name or the absolute path of an image file.
13049     * @param label The label of the item.
13050     * @param func The function to call when the item is clicked.
13051     * @param data The data to associate with the item for related callbacks.
13052     * @return The created item or @c NULL upon failure.
13053     *
13054     * A new item will be created and appended to the toolbar, i.e., will
13055     * be set as @b last item.
13056     *
13057     * Items created with this method can be deleted with
13058     * elm_toolbar_item_del().
13059     *
13060     * Associated @p data can be properly freed when item is deleted if a
13061     * callback function is set with elm_toolbar_item_del_cb_set().
13062     *
13063     * If a function is passed as argument, it will be called everytime this item
13064     * is selected, i.e., the user clicks over an unselected item.
13065     * If such function isn't needed, just passing
13066     * @c NULL as @p func is enough. The same should be done for @p data.
13067     *
13068     * Toolbar will load icon image from fdo or current theme.
13069     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
13070     * If an absolute path is provided it will load it direct from a file.
13071     *
13072     * @see elm_toolbar_item_icon_set()
13073     * @see elm_toolbar_item_del()
13074     * @see elm_toolbar_item_del_cb_set()
13075     *
13076     * @ingroup Toolbar
13077     */
13078    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);
13079
13080    /**
13081     * Prepend item to the toolbar.
13082     *
13083     * @param obj The toolbar object.
13084     * @param icon A string with icon name or the absolute path of an image file.
13085     * @param label The label of the item.
13086     * @param func The function to call when the item is clicked.
13087     * @param data The data to associate with the item for related callbacks.
13088     * @return The created item or @c NULL upon failure.
13089     *
13090     * A new item will be created and prepended to the toolbar, i.e., will
13091     * be set as @b first item.
13092     *
13093     * Items created with this method can be deleted with
13094     * elm_toolbar_item_del().
13095     *
13096     * Associated @p data can be properly freed when item is deleted if a
13097     * callback function is set with elm_toolbar_item_del_cb_set().
13098     *
13099     * If a function is passed as argument, it will be called everytime this item
13100     * is selected, i.e., the user clicks over an unselected item.
13101     * If such function isn't needed, just passing
13102     * @c NULL as @p func is enough. The same should be done for @p data.
13103     *
13104     * Toolbar will load icon image from fdo or current theme.
13105     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
13106     * If an absolute path is provided it will load it direct from a file.
13107     *
13108     * @see elm_toolbar_item_icon_set()
13109     * @see elm_toolbar_item_del()
13110     * @see elm_toolbar_item_del_cb_set()
13111     *
13112     * @ingroup Toolbar
13113     */
13114    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);
13115
13116    /**
13117     * Insert a new item into the toolbar object before item @p before.
13118     *
13119     * @param obj The toolbar object.
13120     * @param before The toolbar item to insert before.
13121     * @param icon A string with icon name or the absolute path of an image file.
13122     * @param label The label of the item.
13123     * @param func The function to call when the item is clicked.
13124     * @param data The data to associate with the item for related callbacks.
13125     * @return The created item or @c NULL upon failure.
13126     *
13127     * A new item will be created and added to the toolbar. Its position in
13128     * this toolbar will be just before item @p before.
13129     *
13130     * Items created with this method can be deleted with
13131     * elm_toolbar_item_del().
13132     *
13133     * Associated @p data can be properly freed when item is deleted if a
13134     * callback function is set with elm_toolbar_item_del_cb_set().
13135     *
13136     * If a function is passed as argument, it will be called everytime this item
13137     * is selected, i.e., the user clicks over an unselected item.
13138     * If such function isn't needed, just passing
13139     * @c NULL as @p func is enough. The same should be done for @p data.
13140     *
13141     * Toolbar will load icon image from fdo or current theme.
13142     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
13143     * If an absolute path is provided it will load it direct from a file.
13144     *
13145     * @see elm_toolbar_item_icon_set()
13146     * @see elm_toolbar_item_del()
13147     * @see elm_toolbar_item_del_cb_set()
13148     *
13149     * @ingroup Toolbar
13150     */
13151    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);
13152
13153    /**
13154     * Insert a new item into the toolbar object after item @p after.
13155     *
13156     * @param obj The toolbar object.
13157     * @param before The toolbar item to insert before.
13158     * @param icon A string with icon name or the absolute path of an image file.
13159     * @param label The label of the item.
13160     * @param func The function to call when the item is clicked.
13161     * @param data The data to associate with the item for related callbacks.
13162     * @return The created item or @c NULL upon failure.
13163     *
13164     * A new item will be created and added to the toolbar. Its position in
13165     * this toolbar will be just after item @p after.
13166     *
13167     * Items created with this method can be deleted with
13168     * elm_toolbar_item_del().
13169     *
13170     * Associated @p data can be properly freed when item is deleted if a
13171     * callback function is set with elm_toolbar_item_del_cb_set().
13172     *
13173     * If a function is passed as argument, it will be called everytime this item
13174     * is selected, i.e., the user clicks over an unselected item.
13175     * If such function isn't needed, just passing
13176     * @c NULL as @p func is enough. The same should be done for @p data.
13177     *
13178     * Toolbar will load icon image from fdo or current theme.
13179     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
13180     * If an absolute path is provided it will load it direct from a file.
13181     *
13182     * @see elm_toolbar_item_icon_set()
13183     * @see elm_toolbar_item_del()
13184     * @see elm_toolbar_item_del_cb_set()
13185     *
13186     * @ingroup Toolbar
13187     */
13188    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);
13189
13190    /**
13191     * Get the first item in the given toolbar widget's list of
13192     * items.
13193     *
13194     * @param obj The toolbar object
13195     * @return The first item or @c NULL, if it has no items (and on
13196     * errors)
13197     *
13198     * @see elm_toolbar_item_append()
13199     * @see elm_toolbar_last_item_get()
13200     *
13201     * @ingroup Toolbar
13202     */
13203    EAPI Elm_Toolbar_Item       *elm_toolbar_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13204
13205    /**
13206     * Get the last item in the given toolbar widget's list of
13207     * items.
13208     *
13209     * @param obj The toolbar object
13210     * @return The last item or @c NULL, if it has no items (and on
13211     * errors)
13212     *
13213     * @see elm_toolbar_item_prepend()
13214     * @see elm_toolbar_first_item_get()
13215     *
13216     * @ingroup Toolbar
13217     */
13218    EAPI Elm_Toolbar_Item       *elm_toolbar_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13219
13220    /**
13221     * Get the item after @p item in toolbar.
13222     *
13223     * @param item The toolbar item.
13224     * @return The item after @p item, or @c NULL if none or on failure.
13225     *
13226     * @note If it is the last item, @c NULL will be returned.
13227     *
13228     * @see elm_toolbar_item_append()
13229     *
13230     * @ingroup Toolbar
13231     */
13232    EAPI Elm_Toolbar_Item       *elm_toolbar_item_next_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13233
13234    /**
13235     * Get the item before @p item in toolbar.
13236     *
13237     * @param item The toolbar item.
13238     * @return The item before @p item, or @c NULL if none or on failure.
13239     *
13240     * @note If it is the first item, @c NULL will be returned.
13241     *
13242     * @see elm_toolbar_item_prepend()
13243     *
13244     * @ingroup Toolbar
13245     */
13246    EAPI Elm_Toolbar_Item       *elm_toolbar_item_prev_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13247
13248    /**
13249     * Get the toolbar object from an item.
13250     *
13251     * @param item The item.
13252     * @return The toolbar object.
13253     *
13254     * This returns the toolbar object itself that an item belongs to.
13255     *
13256     * @ingroup Toolbar
13257     */
13258    EAPI Evas_Object            *elm_toolbar_item_toolbar_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13259
13260    /**
13261     * Set the priority of a toolbar item.
13262     *
13263     * @param item The toolbar item.
13264     * @param priority The item priority. The default is zero.
13265     *
13266     * This is used only when the toolbar shrink mode is set to
13267     * #ELM_TOOLBAR_SHRINK_MENU or #ELM_TOOLBAR_SHRINK_HIDE.
13268     * When space is less than required, items with low priority
13269     * will be removed from the toolbar and added to a dynamically-created menu,
13270     * while items with higher priority will remain on the toolbar,
13271     * with the same order they were added.
13272     *
13273     * @see elm_toolbar_item_priority_get()
13274     *
13275     * @ingroup Toolbar
13276     */
13277    EAPI void                    elm_toolbar_item_priority_set(Elm_Toolbar_Item *item, int priority) EINA_ARG_NONNULL(1);
13278
13279    /**
13280     * Get the priority of a toolbar item.
13281     *
13282     * @param item The toolbar item.
13283     * @return The @p item priority, or @c 0 on failure.
13284     *
13285     * @see elm_toolbar_item_priority_set() for details.
13286     *
13287     * @ingroup Toolbar
13288     */
13289    EAPI int                     elm_toolbar_item_priority_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13290
13291    /**
13292     * Get the label of item.
13293     *
13294     * @param item The item of toolbar.
13295     * @return The label of item.
13296     *
13297     * The return value is a pointer to the label associated to @p item when
13298     * it was created, with function elm_toolbar_item_append() or similar,
13299     * or later,
13300     * with function elm_toolbar_item_label_set. If no label
13301     * was passed as argument, it will return @c NULL.
13302     *
13303     * @see elm_toolbar_item_label_set() for more details.
13304     * @see elm_toolbar_item_append()
13305     *
13306     * @ingroup Toolbar
13307     */
13308    EAPI const char             *elm_toolbar_item_label_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13309
13310    /**
13311     * Set the label of item.
13312     *
13313     * @param item The item of toolbar.
13314     * @param text The label of item.
13315     *
13316     * The label to be displayed by the item.
13317     * Label will be placed at icons bottom (if set).
13318     *
13319     * If a label was passed as argument on item creation, with function
13320     * elm_toolbar_item_append() or similar, it will be already
13321     * displayed by the item.
13322     *
13323     * @see elm_toolbar_item_label_get()
13324     * @see elm_toolbar_item_append()
13325     *
13326     * @ingroup Toolbar
13327     */
13328    EAPI void                    elm_toolbar_item_label_set(Elm_Toolbar_Item *item, const char *label) EINA_ARG_NONNULL(1);
13329
13330    /**
13331     * Return the data associated with a given toolbar widget item.
13332     *
13333     * @param item The toolbar widget item handle.
13334     * @return The data associated with @p item.
13335     *
13336     * @see elm_toolbar_item_data_set()
13337     *
13338     * @ingroup Toolbar
13339     */
13340    EAPI void                   *elm_toolbar_item_data_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13341
13342    /**
13343     * Set the data associated with a given toolbar widget item.
13344     *
13345     * @param item The toolbar widget item handle.
13346     * @param data The new data pointer to set to @p item.
13347     *
13348     * This sets new item data on @p item.
13349     *
13350     * @warning The old data pointer won't be touched by this function, so
13351     * the user had better to free that old data himself/herself.
13352     *
13353     * @ingroup Toolbar
13354     */
13355    EAPI void                    elm_toolbar_item_data_set(Elm_Toolbar_Item *item, const void *data) EINA_ARG_NONNULL(1);
13356
13357    /**
13358     * Returns a pointer to a toolbar item by its label.
13359     *
13360     * @param obj The toolbar object.
13361     * @param label The label of the item to find.
13362     *
13363     * @return The pointer to the toolbar item matching @p label or @c NULL
13364     * on failure.
13365     *
13366     * @ingroup Toolbar
13367     */
13368    EAPI Elm_Toolbar_Item       *elm_toolbar_item_find_by_label(const Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
13369
13370    /*
13371     * Get whether the @p item is selected or not.
13372     *
13373     * @param item The toolbar item.
13374     * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
13375     * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
13376     *
13377     * @see elm_toolbar_selected_item_set() for details.
13378     * @see elm_toolbar_item_selected_get()
13379     *
13380     * @ingroup Toolbar
13381     */
13382    EAPI Eina_Bool               elm_toolbar_item_selected_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13383
13384    /**
13385     * Set the selected state of an item.
13386     *
13387     * @param item The toolbar item
13388     * @param selected The selected state
13389     *
13390     * This sets the selected state of the given item @p it.
13391     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
13392     *
13393     * If a new item is selected the previosly selected will be unselected.
13394     * Previoulsy selected item can be get with function
13395     * elm_toolbar_selected_item_get().
13396     *
13397     * Selected items will be highlighted.
13398     *
13399     * @see elm_toolbar_item_selected_get()
13400     * @see elm_toolbar_selected_item_get()
13401     *
13402     * @ingroup Toolbar
13403     */
13404    EAPI void                    elm_toolbar_item_selected_set(Elm_Toolbar_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
13405
13406    /**
13407     * Get the selected item.
13408     *
13409     * @param obj The toolbar object.
13410     * @return The selected toolbar item.
13411     *
13412     * The selected item can be unselected with function
13413     * elm_toolbar_item_selected_set().
13414     *
13415     * The selected item always will be highlighted on toolbar.
13416     *
13417     * @see elm_toolbar_selected_items_get()
13418     *
13419     * @ingroup Toolbar
13420     */
13421    EAPI Elm_Toolbar_Item       *elm_toolbar_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13422
13423    /**
13424     * Set the icon associated with @p item.
13425     *
13426     * @param obj The parent of this item.
13427     * @param item The toolbar item.
13428     * @param icon A string with icon name or the absolute path of an image file.
13429     *
13430     * Toolbar will load icon image from fdo or current theme.
13431     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
13432     * If an absolute path is provided it will load it direct from a file.
13433     *
13434     * @see elm_toolbar_icon_order_lookup_set()
13435     * @see elm_toolbar_icon_order_lookup_get()
13436     *
13437     * @ingroup Toolbar
13438     */
13439    EAPI void                    elm_toolbar_item_icon_set(Elm_Toolbar_Item *item, const char *icon) EINA_ARG_NONNULL(1);
13440
13441    /**
13442     * Get the string used to set the icon of @p item.
13443     *
13444     * @param item The toolbar item.
13445     * @return The string associated with the icon object.
13446     *
13447     * @see elm_toolbar_item_icon_set() for details.
13448     *
13449     * @ingroup Toolbar
13450     */
13451    EAPI const char             *elm_toolbar_item_icon_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13452
13453    /**
13454     * Delete them item from the toolbar.
13455     *
13456     * @param item The item of toolbar to be deleted.
13457     *
13458     * @see elm_toolbar_item_append()
13459     * @see elm_toolbar_item_del_cb_set()
13460     *
13461     * @ingroup Toolbar
13462     */
13463    EAPI void                    elm_toolbar_item_del(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13464
13465    /**
13466     * Set the function called when a toolbar item is freed.
13467     *
13468     * @param item The item to set the callback on.
13469     * @param func The function called.
13470     *
13471     * If there is a @p func, then it will be called prior item's memory release.
13472     * That will be called with the following arguments:
13473     * @li item's data;
13474     * @li item's Evas object;
13475     * @li item itself;
13476     *
13477     * This way, a data associated to a toolbar item could be properly freed.
13478     *
13479     * @ingroup Toolbar
13480     */
13481    EAPI void                    elm_toolbar_item_del_cb_set(Elm_Toolbar_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
13482
13483    /**
13484     * Get a value whether toolbar item is disabled or not.
13485     *
13486     * @param item The item.
13487     * @return The disabled state.
13488     *
13489     * @see elm_toolbar_item_disabled_set() for more details.
13490     *
13491     * @ingroup Toolbar
13492     */
13493    EAPI Eina_Bool               elm_toolbar_item_disabled_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13494
13495    /**
13496     * Sets the disabled/enabled state of a toolbar item.
13497     *
13498     * @param item The item.
13499     * @param disabled The disabled state.
13500     *
13501     * A disabled item cannot be selected or unselected. It will also
13502     * change its appearance (generally greyed out). This sets the
13503     * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
13504     * enabled).
13505     *
13506     * @ingroup Toolbar
13507     */
13508    EAPI void                    elm_toolbar_item_disabled_set(Elm_Toolbar_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
13509
13510    /**
13511     * Set or unset item as a separator.
13512     *
13513     * @param item The toolbar item.
13514     * @param setting @c EINA_TRUE to set item @p item as separator or
13515     * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
13516     *
13517     * Items aren't set as separator by default.
13518     *
13519     * If set as separator it will display separator theme, so won't display
13520     * icons or label.
13521     *
13522     * @see elm_toolbar_item_separator_get()
13523     *
13524     * @ingroup Toolbar
13525     */
13526    EAPI void                    elm_toolbar_item_separator_set(Elm_Toolbar_Item *item, Eina_Bool separator) EINA_ARG_NONNULL(1);
13527
13528    /**
13529     * Get a value whether item is a separator or not.
13530     *
13531     * @param item The toolbar item.
13532     * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
13533     * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
13534     *
13535     * @see elm_toolbar_item_separator_set() for details.
13536     *
13537     * @ingroup Toolbar
13538     */
13539    EAPI Eina_Bool               elm_toolbar_item_separator_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13540
13541    /**
13542     * Set the shrink state of toolbar @p obj.
13543     *
13544     * @param obj The toolbar object.
13545     * @param shrink_mode Toolbar's items display behavior.
13546     *
13547     * The toolbar won't scroll if #ELM_TOOLBAR_SHRINK_NONE,
13548     * but will enforce a minimun size so all the items will fit, won't scroll
13549     * and won't show the items that don't fit if #ELM_TOOLBAR_SHRINK_HIDE,
13550     * will scroll if #ELM_TOOLBAR_SHRINK_SCROLL, and will create a button to
13551     * pop up excess elements with #ELM_TOOLBAR_SHRINK_MENU.
13552     *
13553     * @ingroup Toolbar
13554     */
13555    EAPI void                    elm_toolbar_mode_shrink_set(Evas_Object *obj, Elm_Toolbar_Shrink_Mode shrink_mode) EINA_ARG_NONNULL(1);
13556
13557    /**
13558     * Get the shrink mode of toolbar @p obj.
13559     *
13560     * @param obj The toolbar object.
13561     * @return Toolbar's items display behavior.
13562     *
13563     * @see elm_toolbar_mode_shrink_set() for details.
13564     *
13565     * @ingroup Toolbar
13566     */
13567    EAPI Elm_Toolbar_Shrink_Mode elm_toolbar_mode_shrink_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13568
13569    /**
13570     * Enable/disable homogenous mode.
13571     *
13572     * @param obj The toolbar object
13573     * @param homogeneous Assume the items within the toolbar are of the
13574     * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
13575     *
13576     * This will enable the homogeneous mode where items are of the same size.
13577     * @see elm_toolbar_homogeneous_get()
13578     *
13579     * @ingroup Toolbar
13580     */
13581    EAPI void                    elm_toolbar_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
13582
13583    /**
13584     * Get whether the homogenous mode is enabled.
13585     *
13586     * @param obj The toolbar object.
13587     * @return Assume the items within the toolbar are of the same height
13588     * and width (EINA_TRUE = on, EINA_FALSE = off).
13589     *
13590     * @see elm_toolbar_homogeneous_set()
13591     *
13592     * @ingroup Toolbar
13593     */
13594    EAPI Eina_Bool               elm_toolbar_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13595
13596    /**
13597     * Enable/disable homogenous mode.
13598     *
13599     * @param obj The toolbar object
13600     * @param homogeneous Assume the items within the toolbar are of the
13601     * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
13602     *
13603     * This will enable the homogeneous mode where items are of the same size.
13604     * @see elm_toolbar_homogeneous_get()
13605     *
13606     * @deprecated use elm_toolbar_homogeneous_set() instead.
13607     *
13608     * @ingroup Toolbar
13609     */
13610    EINA_DEPRECATED EAPI void    elm_toolbar_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
13611
13612    /**
13613     * Get whether the homogenous mode is enabled.
13614     *
13615     * @param obj The toolbar object.
13616     * @return Assume the items within the toolbar are of the same height
13617     * and width (EINA_TRUE = on, EINA_FALSE = off).
13618     *
13619     * @see elm_toolbar_homogeneous_set()
13620     * @deprecated use elm_toolbar_homogeneous_get() instead.
13621     *
13622     * @ingroup Toolbar
13623     */
13624    EINA_DEPRECATED EAPI Eina_Bool elm_toolbar_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13625
13626    /**
13627     * Set the parent object of the toolbar items' menus.
13628     *
13629     * @param obj The toolbar object.
13630     * @param parent The parent of the menu objects.
13631     *
13632     * Each item can be set as item menu, with elm_toolbar_item_menu_set().
13633     *
13634     * For more details about setting the parent for toolbar menus, see
13635     * elm_menu_parent_set().
13636     *
13637     * @see elm_menu_parent_set() for details.
13638     * @see elm_toolbar_item_menu_set() for details.
13639     *
13640     * @ingroup Toolbar
13641     */
13642    EAPI void                    elm_toolbar_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
13643
13644    /**
13645     * Get the parent object of the toolbar items' menus.
13646     *
13647     * @param obj The toolbar object.
13648     * @return The parent of the menu objects.
13649     *
13650     * @see elm_toolbar_menu_parent_set() for details.
13651     *
13652     * @ingroup Toolbar
13653     */
13654    EAPI Evas_Object            *elm_toolbar_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13655
13656    /**
13657     * Set the alignment of the items.
13658     *
13659     * @param obj The toolbar object.
13660     * @param align The new alignment, a float between <tt> 0.0 </tt>
13661     * and <tt> 1.0 </tt>.
13662     *
13663     * Alignment of toolbar items, from <tt> 0.0 </tt> to indicates to align
13664     * left, to <tt> 1.0 </tt>, to align to right. <tt> 0.5 </tt> centralize
13665     * items.
13666     *
13667     * Centered items by default.
13668     *
13669     * @see elm_toolbar_align_get()
13670     *
13671     * @ingroup Toolbar
13672     */
13673    EAPI void                    elm_toolbar_align_set(Evas_Object *obj, double align) EINA_ARG_NONNULL(1);
13674
13675    /**
13676     * Get the alignment of the items.
13677     *
13678     * @param obj The toolbar object.
13679     * @return toolbar items alignment, a float between <tt> 0.0 </tt> and
13680     * <tt> 1.0 </tt>.
13681     *
13682     * @see elm_toolbar_align_set() for details.
13683     *
13684     * @ingroup Toolbar
13685     */
13686    EAPI double                  elm_toolbar_align_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13687
13688    /**
13689     * Set whether the toolbar item opens a menu.
13690     *
13691     * @param item The toolbar item.
13692     * @param menu If @c EINA_TRUE, @p item will opens a menu when selected.
13693     *
13694     * A toolbar item can be set to be a menu, using this function.
13695     *
13696     * Once it is set to be a menu, it can be manipulated through the
13697     * menu-like function elm_toolbar_menu_parent_set() and the other
13698     * elm_menu functions, using the Evas_Object @c menu returned by
13699     * elm_toolbar_item_menu_get().
13700     *
13701     * So, items to be displayed in this item's menu should be added with
13702     * elm_menu_item_add().
13703     *
13704     * The following code exemplifies the most basic usage:
13705     * @code
13706     * tb = elm_toolbar_add(win)
13707     * item = elm_toolbar_item_append(tb, "refresh", "Menu", NULL, NULL);
13708     * elm_toolbar_item_menu_set(item, EINA_TRUE);
13709     * elm_toolbar_menu_parent_set(tb, win);
13710     * menu = elm_toolbar_item_menu_get(item);
13711     * elm_menu_item_add(menu, NULL, "edit-cut", "Cut", NULL, NULL);
13712     * menu_item = elm_menu_item_add(menu, NULL, "edit-copy", "Copy", NULL,
13713     * NULL);
13714     * @endcode
13715     *
13716     * @see elm_toolbar_item_menu_get()
13717     *
13718     * @ingroup Toolbar
13719     */
13720    EAPI void                    elm_toolbar_item_menu_set(Elm_Toolbar_Item *item, Eina_Bool menu) EINA_ARG_NONNULL(1);
13721
13722    /**
13723     * Get toolbar item's menu.
13724     *
13725     * @param item The toolbar item.
13726     * @return Item's menu object or @c NULL on failure.
13727     *
13728     * If @p item wasn't set as menu item with elm_toolbar_item_menu_set(),
13729     * this function will set it.
13730     *
13731     * @see elm_toolbar_item_menu_set() for details.
13732     *
13733     * @ingroup Toolbar
13734     */
13735    EAPI Evas_Object            *elm_toolbar_item_menu_get(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13736
13737    /**
13738     * Add a new state to @p item.
13739     *
13740     * @param item The item.
13741     * @param icon A string with icon name or the absolute path of an image file.
13742     * @param label The label of the new state.
13743     * @param func The function to call when the item is clicked when this
13744     * state is selected.
13745     * @param data The data to associate with the state.
13746     * @return The toolbar item state, or @c NULL upon failure.
13747     *
13748     * Toolbar will load icon image from fdo or current theme.
13749     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
13750     * If an absolute path is provided it will load it direct from a file.
13751     *
13752     * States created with this function can be removed with
13753     * elm_toolbar_item_state_del().
13754     *
13755     * @see elm_toolbar_item_state_del()
13756     * @see elm_toolbar_item_state_sel()
13757     * @see elm_toolbar_item_state_get()
13758     *
13759     * @ingroup Toolbar
13760     */
13761    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);
13762
13763    /**
13764     * Delete a previoulsy added state to @p item.
13765     *
13766     * @param item The toolbar item.
13767     * @param state The state to be deleted.
13768     * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
13769     *
13770     * @see elm_toolbar_item_state_add()
13771     */
13772    EAPI Eina_Bool               elm_toolbar_item_state_del(Elm_Toolbar_Item *item, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
13773
13774    /**
13775     * Set @p state as the current state of @p it.
13776     *
13777     * @param it The item.
13778     * @param state The state to use.
13779     * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
13780     *
13781     * If @p state is @c NULL, it won't select any state and the default item's
13782     * icon and label will be used. It's the same behaviour than
13783     * elm_toolbar_item_state_unser().
13784     *
13785     * @see elm_toolbar_item_state_unset()
13786     *
13787     * @ingroup Toolbar
13788     */
13789    EAPI Eina_Bool               elm_toolbar_item_state_set(Elm_Toolbar_Item *it, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
13790
13791    /**
13792     * Unset the state of @p it.
13793     *
13794     * @param it The item.
13795     *
13796     * The default icon and label from this item will be displayed.
13797     *
13798     * @see elm_toolbar_item_state_set() for more details.
13799     *
13800     * @ingroup Toolbar
13801     */
13802    EAPI void                    elm_toolbar_item_state_unset(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
13803
13804    /**
13805     * Get the current state of @p it.
13806     *
13807     * @param item The item.
13808     * @return The selected state or @c NULL if none is selected or on failure.
13809     *
13810     * @see elm_toolbar_item_state_set() for details.
13811     * @see elm_toolbar_item_state_unset()
13812     * @see elm_toolbar_item_state_add()
13813     *
13814     * @ingroup Toolbar
13815     */
13816    EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_get(const Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
13817
13818    /**
13819     * Get the state after selected state in toolbar's @p item.
13820     *
13821     * @param it The toolbar item to change state.
13822     * @return The state after current state, or @c NULL on failure.
13823     *
13824     * If last state is selected, this function will return first state.
13825     *
13826     * @see elm_toolbar_item_state_set()
13827     * @see elm_toolbar_item_state_add()
13828     *
13829     * @ingroup Toolbar
13830     */
13831    EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_next(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
13832
13833    /**
13834     * Get the state before selected state in toolbar's @p item.
13835     *
13836     * @param it The toolbar item to change state.
13837     * @return The state before current state, or @c NULL on failure.
13838     *
13839     * If first state is selected, this function will return last state.
13840     *
13841     * @see elm_toolbar_item_state_set()
13842     * @see elm_toolbar_item_state_add()
13843     *
13844     * @ingroup Toolbar
13845     */
13846    EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_prev(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
13847
13848    /**
13849     * Set the text to be shown in a given toolbar item's tooltips.
13850     *
13851     * @param item Target item.
13852     * @param text The text to set in the content.
13853     *
13854     * Setup the text as tooltip to object. The item can have only one tooltip,
13855     * so any previous tooltip data - set with this function or
13856     * elm_toolbar_item_tooltip_content_cb_set() - is removed.
13857     *
13858     * @see elm_object_tooltip_text_set() for more details.
13859     *
13860     * @ingroup Toolbar
13861     */
13862    EAPI void             elm_toolbar_item_tooltip_text_set(Elm_Toolbar_Item *item, const char *text) EINA_ARG_NONNULL(1);
13863
13864    /**
13865     * Set the content to be shown in the tooltip item.
13866     *
13867     * Setup the tooltip to item. The item can have only one tooltip,
13868     * so any previous tooltip data is removed. @p func(with @p data) will
13869     * be called every time that need show the tooltip and it should
13870     * return a valid Evas_Object. This object is then managed fully by
13871     * tooltip system and is deleted when the tooltip is gone.
13872     *
13873     * @param item the toolbar item being attached a tooltip.
13874     * @param func the function used to create the tooltip contents.
13875     * @param data what to provide to @a func as callback data/context.
13876     * @param del_cb called when data is not needed anymore, either when
13877     *        another callback replaces @a func, the tooltip is unset with
13878     *        elm_toolbar_item_tooltip_unset() or the owner @a item
13879     *        dies. This callback receives as the first parameter the
13880     *        given @a data, and @c event_info is the item.
13881     *
13882     * @see elm_object_tooltip_content_cb_set() for more details.
13883     *
13884     * @ingroup Toolbar
13885     */
13886    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);
13887
13888    /**
13889     * Unset tooltip from item.
13890     *
13891     * @param item toolbar item to remove previously set tooltip.
13892     *
13893     * Remove tooltip from item. The callback provided as del_cb to
13894     * elm_toolbar_item_tooltip_content_cb_set() will be called to notify
13895     * it is not used anymore.
13896     *
13897     * @see elm_object_tooltip_unset() for more details.
13898     * @see elm_toolbar_item_tooltip_content_cb_set()
13899     *
13900     * @ingroup Toolbar
13901     */
13902    EAPI void             elm_toolbar_item_tooltip_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13903
13904    /**
13905     * Sets a different style for this item tooltip.
13906     *
13907     * @note before you set a style you should define a tooltip with
13908     *       elm_toolbar_item_tooltip_content_cb_set() or
13909     *       elm_toolbar_item_tooltip_text_set()
13910     *
13911     * @param item toolbar item with tooltip already set.
13912     * @param style the theme style to use (default, transparent, ...)
13913     *
13914     * @see elm_object_tooltip_style_set() for more details.
13915     *
13916     * @ingroup Toolbar
13917     */
13918    EAPI void             elm_toolbar_item_tooltip_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
13919
13920    /**
13921     * Get the style for this item tooltip.
13922     *
13923     * @param item toolbar item with tooltip already set.
13924     * @return style the theme style in use, defaults to "default". If the
13925     *         object does not have a tooltip set, then NULL is returned.
13926     *
13927     * @see elm_object_tooltip_style_get() for more details.
13928     * @see elm_toolbar_item_tooltip_style_set()
13929     *
13930     * @ingroup Toolbar
13931     */
13932    EAPI const char      *elm_toolbar_item_tooltip_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13933
13934    /**
13935     * Set the type of mouse pointer/cursor decoration to be shown,
13936     * when the mouse pointer is over the given toolbar widget item
13937     *
13938     * @param item toolbar item to customize cursor on
13939     * @param cursor the cursor type's name
13940     *
13941     * This function works analogously as elm_object_cursor_set(), but
13942     * here the cursor's changing area is restricted to the item's
13943     * area, and not the whole widget's. Note that that item cursors
13944     * have precedence over widget cursors, so that a mouse over an
13945     * item with custom cursor set will always show @b that cursor.
13946     *
13947     * If this function is called twice for an object, a previously set
13948     * cursor will be unset on the second call.
13949     *
13950     * @see elm_object_cursor_set()
13951     * @see elm_toolbar_item_cursor_get()
13952     * @see elm_toolbar_item_cursor_unset()
13953     *
13954     * @ingroup Toolbar
13955     */
13956    EAPI void             elm_toolbar_item_cursor_set(Elm_Toolbar_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
13957
13958    /*
13959     * Get the type of mouse pointer/cursor decoration set to be shown,
13960     * when the mouse pointer is over the given toolbar widget item
13961     *
13962     * @param item toolbar item with custom cursor set
13963     * @return the cursor type's name or @c NULL, if no custom cursors
13964     * were set to @p item (and on errors)
13965     *
13966     * @see elm_object_cursor_get()
13967     * @see elm_toolbar_item_cursor_set()
13968     * @see elm_toolbar_item_cursor_unset()
13969     *
13970     * @ingroup Toolbar
13971     */
13972    EAPI const char      *elm_toolbar_item_cursor_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13973
13974    /**
13975     * Unset any custom mouse pointer/cursor decoration set to be
13976     * shown, when the mouse pointer is over the given toolbar widget
13977     * item, thus making it show the @b default cursor again.
13978     *
13979     * @param item a toolbar item
13980     *
13981     * Use this call to undo any custom settings on this item's cursor
13982     * decoration, bringing it back to defaults (no custom style set).
13983     *
13984     * @see elm_object_cursor_unset()
13985     * @see elm_toolbar_item_cursor_set()
13986     *
13987     * @ingroup Toolbar
13988     */
13989    EAPI void             elm_toolbar_item_cursor_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
13990
13991    /**
13992     * Set a different @b style for a given custom cursor set for a
13993     * toolbar item.
13994     *
13995     * @param item toolbar item with custom cursor set
13996     * @param style the <b>theme style</b> to use (e.g. @c "default",
13997     * @c "transparent", etc)
13998     *
13999     * This function only makes sense when one is using custom mouse
14000     * cursor decorations <b>defined in a theme file</b>, which can have,
14001     * given a cursor name/type, <b>alternate styles</b> on it. It
14002     * works analogously as elm_object_cursor_style_set(), but here
14003     * applyed only to toolbar item objects.
14004     *
14005     * @warning Before you set a cursor style you should have definen a
14006     *       custom cursor previously on the item, with
14007     *       elm_toolbar_item_cursor_set()
14008     *
14009     * @see elm_toolbar_item_cursor_engine_only_set()
14010     * @see elm_toolbar_item_cursor_style_get()
14011     *
14012     * @ingroup Toolbar
14013     */
14014    EAPI void             elm_toolbar_item_cursor_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
14015
14016    /**
14017     * Get the current @b style set for a given toolbar item's custom
14018     * cursor
14019     *
14020     * @param item toolbar item with custom cursor set.
14021     * @return style the cursor style in use. If the object does not
14022     *         have a cursor set, then @c NULL is returned.
14023     *
14024     * @see elm_toolbar_item_cursor_style_set() for more details
14025     *
14026     * @ingroup Toolbar
14027     */
14028    EAPI const char      *elm_toolbar_item_cursor_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14029
14030    /**
14031     * Set if the (custom)cursor for a given toolbar item should be
14032     * searched in its theme, also, or should only rely on the
14033     * rendering engine.
14034     *
14035     * @param item item with custom (custom) cursor already set on
14036     * @param engine_only Use @c EINA_TRUE to have cursors looked for
14037     * only on those provided by the rendering engine, @c EINA_FALSE to
14038     * have them searched on the widget's theme, as well.
14039     *
14040     * @note This call is of use only if you've set a custom cursor
14041     * for toolbar items, with elm_toolbar_item_cursor_set().
14042     *
14043     * @note By default, cursors will only be looked for between those
14044     * provided by the rendering engine.
14045     *
14046     * @ingroup Toolbar
14047     */
14048    EAPI void             elm_toolbar_item_cursor_engine_only_set(Elm_Toolbar_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
14049
14050    /**
14051     * Get if the (custom) cursor for a given toolbar item is being
14052     * searched in its theme, also, or is only relying on the rendering
14053     * engine.
14054     *
14055     * @param item a toolbar item
14056     * @return @c EINA_TRUE, if cursors are being looked for only on
14057     * those provided by the rendering engine, @c EINA_FALSE if they
14058     * are being searched on the widget's theme, as well.
14059     *
14060     * @see elm_toolbar_item_cursor_engine_only_set(), for more details
14061     *
14062     * @ingroup Toolbar
14063     */
14064    EAPI Eina_Bool        elm_toolbar_item_cursor_engine_only_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14065
14066    /**
14067     * Change a toolbar's orientation
14068     * @param obj The toolbar object
14069     * @param vertical If @c EINA_TRUE, the toolbar is vertical
14070     * By default, a toolbar will be horizontal. Use this function to create a vertical toolbar.
14071     * @ingroup Toolbar
14072     */
14073    EAPI void             elm_toolbar_orientation_set(Evas_Object *obj, Eina_Bool vertical) EINA_ARG_NONNULL(1);
14074
14075    /**
14076     * Get a toolbar's orientation
14077     * @param obj The toolbar object
14078     * @return If @c EINA_TRUE, the toolbar is vertical
14079     * By default, a toolbar will be horizontal. Use this function to determine whether a toolbar is vertical.
14080     * @ingroup Toolbar
14081     */
14082    EAPI Eina_Bool        elm_toolbar_orientation_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
14083
14084    /**
14085     * @}
14086     */
14087
14088    /**
14089     * @defgroup Tooltips Tooltips
14090     *
14091     * The Tooltip is an (internal, for now) smart object used to show a
14092     * content in a frame on mouse hover of objects(or widgets), with
14093     * tips/information about them.
14094     *
14095     * @{
14096     */
14097
14098    EAPI double       elm_tooltip_delay_get(void);
14099    EAPI Eina_Bool    elm_tooltip_delay_set(double delay);
14100    EAPI void         elm_object_tooltip_show(Evas_Object *obj) EINA_ARG_NONNULL(1);
14101    EAPI void         elm_object_tooltip_hide(Evas_Object *obj) EINA_ARG_NONNULL(1);
14102    EAPI void         elm_object_tooltip_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1, 2);
14103    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);
14104    EAPI void         elm_object_tooltip_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
14105    EAPI void         elm_object_tooltip_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
14106    EAPI const char  *elm_object_tooltip_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14107    EAPI Eina_Bool    elm_tooltip_size_restrict_disable(Evas_Object *obj, Eina_Bool disable); EINA_ARG_NONNULL(1);
14108    EAPI Eina_Bool    elm_tooltip_size_restrict_disabled_get(const Evas_Object *obj); EINA_ARG_NONNULL(1);
14109
14110    /**
14111     * @}
14112     */
14113
14114    /**
14115     * @defgroup Cursors Cursors
14116     *
14117     * The Elementary cursor is an internal smart object used to
14118     * customize the mouse cursor displayed over objects (or
14119     * widgets). In the most common scenario, the cursor decoration
14120     * comes from the graphical @b engine Elementary is running
14121     * on. Those engines may provide different decorations for cursors,
14122     * and Elementary provides functions to choose them (think of X11
14123     * cursors, as an example).
14124     *
14125     * There's also the possibility of, besides using engine provided
14126     * cursors, also use ones coming from Edje theming files. Both
14127     * globally and per widget, Elementary makes it possible for one to
14128     * make the cursors lookup to be held on engines only or on
14129     * Elementary's theme file, too.
14130     *
14131     * @{
14132     */
14133
14134    /**
14135     * Set the cursor to be shown when mouse is over the object
14136     *
14137     * Set the cursor that will be displayed when mouse is over the
14138     * object. The object can have only one cursor set to it, so if
14139     * this function is called twice for an object, the previous set
14140     * will be unset.
14141     * If using X cursors, a definition of all the valid cursor names
14142     * is listed on Elementary_Cursors.h. If an invalid name is set
14143     * the default cursor will be used.
14144     *
14145     * @param obj the object being set a cursor.
14146     * @param cursor the cursor name to be used.
14147     *
14148     * @ingroup Cursors
14149     */
14150    EAPI void         elm_object_cursor_set(Evas_Object *obj, const char *cursor) EINA_ARG_NONNULL(1);
14151
14152    /**
14153     * Get the cursor to be shown when mouse is over the object
14154     *
14155     * @param obj an object with cursor already set.
14156     * @return the cursor name.
14157     *
14158     * @ingroup Cursors
14159     */
14160    EAPI const char  *elm_object_cursor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14161
14162    /**
14163     * Unset cursor for object
14164     *
14165     * Unset cursor for object, and set the cursor to default if the mouse
14166     * was over this object.
14167     *
14168     * @param obj Target object
14169     * @see elm_object_cursor_set()
14170     *
14171     * @ingroup Cursors
14172     */
14173    EAPI void         elm_object_cursor_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
14174
14175    /**
14176     * Sets a different style for this object cursor.
14177     *
14178     * @note before you set a style you should define a cursor with
14179     *       elm_object_cursor_set()
14180     *
14181     * @param obj an object with cursor already set.
14182     * @param style the theme style to use (default, transparent, ...)
14183     *
14184     * @ingroup Cursors
14185     */
14186    EAPI void         elm_object_cursor_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
14187
14188    /**
14189     * Get the style for this object cursor.
14190     *
14191     * @param obj an object with cursor already set.
14192     * @return style the theme style in use, defaults to "default". If the
14193     *         object does not have a cursor set, then NULL is returned.
14194     *
14195     * @ingroup Cursors
14196     */
14197    EAPI const char  *elm_object_cursor_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14198
14199    /**
14200     * Set if the cursor set should be searched on the theme or should use
14201     * the provided by the engine, only.
14202     *
14203     * @note before you set if should look on theme you should define a cursor
14204     * with elm_object_cursor_set(). By default it will only look for cursors
14205     * provided by the engine.
14206     *
14207     * @param obj an object with cursor already set.
14208     * @param engine_only boolean to define it cursors should be looked only
14209     * between the provided by the engine or searched on widget's theme as well.
14210     *
14211     * @ingroup Cursors
14212     */
14213    EAPI void         elm_object_cursor_engine_only_set(Evas_Object *obj, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
14214
14215    /**
14216     * Get the cursor engine only usage for this object cursor.
14217     *
14218     * @param obj an object with cursor already set.
14219     * @return engine_only boolean to define it cursors should be
14220     * looked only between the provided by the engine or searched on
14221     * widget's theme as well. If the object does not have a cursor
14222     * set, then EINA_FALSE is returned.
14223     *
14224     * @ingroup Cursors
14225     */
14226    EAPI Eina_Bool    elm_object_cursor_engine_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14227
14228    /**
14229     * Get the configured cursor engine only usage
14230     *
14231     * This gets the globally configured exclusive usage of engine cursors.
14232     *
14233     * @return 1 if only engine cursors should be used
14234     * @ingroup Cursors
14235     */
14236    EAPI int          elm_cursor_engine_only_get(void);
14237
14238    /**
14239     * Set the configured cursor engine only usage
14240     *
14241     * This sets the globally configured exclusive usage of engine cursors.
14242     * It won't affect cursors set before changing this value.
14243     *
14244     * @param engine_only If 1 only engine cursors will be enabled, if 0 will
14245     * look for them on theme before.
14246     * @return EINA_TRUE if value is valid and setted (0 or 1)
14247     * @ingroup Cursors
14248     */
14249    EAPI Eina_Bool    elm_cursor_engine_only_set(int engine_only);
14250
14251    /**
14252     * @}
14253     */
14254
14255    /**
14256     * @defgroup Menu Menu
14257     *
14258     * @image html img/widget/menu/preview-00.png
14259     * @image latex img/widget/menu/preview-00.eps
14260     *
14261     * A menu is a list of items displayed above its parent. When the menu is
14262     * showing its parent is darkened. Each item can have a sub-menu. The menu
14263     * object can be used to display a menu on a right click event, in a toolbar,
14264     * anywhere.
14265     *
14266     * Signals that you can add callbacks for are:
14267     * @li "clicked" - the user clicked the empty space in the menu to dismiss.
14268     *             event_info is NULL.
14269     *
14270     * @see @ref tutorial_menu
14271     * @{
14272     */
14273    typedef struct _Elm_Menu_Item Elm_Menu_Item; /**< Item of Elm_Menu. Sub-type of Elm_Widget_Item */
14274    /**
14275     * @brief Add a new menu to the parent
14276     *
14277     * @param parent The parent object.
14278     * @return The new object or NULL if it cannot be created.
14279     */
14280    EAPI Evas_Object       *elm_menu_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14281    /**
14282     * @brief Set the parent for the given menu widget
14283     *
14284     * @param obj The menu object.
14285     * @param parent The new parent.
14286     */
14287    EAPI void               elm_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
14288    /**
14289     * @brief Get the parent for the given menu widget
14290     *
14291     * @param obj The menu object.
14292     * @return The parent.
14293     *
14294     * @see elm_menu_parent_set()
14295     */
14296    EAPI Evas_Object       *elm_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14297    /**
14298     * @brief Move the menu to a new position
14299     *
14300     * @param obj The menu object.
14301     * @param x The new position.
14302     * @param y The new position.
14303     *
14304     * Sets the top-left position of the menu to (@p x,@p y).
14305     *
14306     * @note @p x and @p y coordinates are relative to parent.
14307     */
14308    EAPI void               elm_menu_move(Evas_Object *obj, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
14309    /**
14310     * @brief Close a opened menu
14311     *
14312     * @param obj the menu object
14313     * @return void
14314     *
14315     * Hides the menu and all it's sub-menus.
14316     */
14317    EAPI void               elm_menu_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
14318    /**
14319     * @brief Returns a list of @p item's items.
14320     *
14321     * @param obj The menu object
14322     * @return An Eina_List* of @p item's items
14323     */
14324    EAPI const Eina_List   *elm_menu_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14325    /**
14326     * @brief Get the Evas_Object of an Elm_Menu_Item
14327     *
14328     * @param item The menu item object.
14329     * @return The edje object containing the swallowed content
14330     *
14331     * @warning Don't manipulate this object!
14332     */
14333    EAPI Evas_Object       *elm_menu_item_object_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
14334    /**
14335     * @brief Add an item at the end of the given menu widget
14336     *
14337     * @param obj The menu object.
14338     * @param parent The parent menu item (optional)
14339     * @param icon A icon display on the item. The icon will be destryed by the menu.
14340     * @param label The label of the item.
14341     * @param func Function called when the user select the item.
14342     * @param data Data sent by the callback.
14343     * @return Returns the new item.
14344     */
14345    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);
14346    /**
14347     * @brief Add an object swallowed in an item at the end of the given menu
14348     * widget
14349     *
14350     * @param obj The menu object.
14351     * @param parent The parent menu item (optional)
14352     * @param subobj The object to swallow
14353     * @param func Function called when the user select the item.
14354     * @param data Data sent by the callback.
14355     * @return Returns the new item.
14356     *
14357     * Add an evas object as an item to the menu.
14358     */
14359    EAPI Elm_Menu_Item     *elm_menu_item_add_object(Evas_Object *obj, Elm_Menu_Item *parent, Evas_Object *subobj, Evas_Smart_Cb func, const void *data) EINA_ARG_NONNULL(1);
14360    /**
14361     * @brief Set the label of a menu item
14362     *
14363     * @param item The menu item object.
14364     * @param label The label to set for @p item
14365     *
14366     * @warning Don't use this funcion on items created with
14367     * elm_menu_item_add_object() or elm_menu_item_separator_add().
14368     */
14369    EAPI void               elm_menu_item_label_set(Elm_Menu_Item *item, const char *label) EINA_ARG_NONNULL(1);
14370    /**
14371     * @brief Get the label of a menu item
14372     *
14373     * @param item The menu item object.
14374     * @return The label of @p item
14375     */
14376    EAPI const char        *elm_menu_item_label_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14377    /**
14378     * @brief Set the icon of a menu item to the standard icon with name @p icon
14379     *
14380     * @param item The menu item object.
14381     * @param icon The icon object to set for the content of @p item
14382     *
14383     * Once this icon is set, any previously set icon will be deleted.
14384     */
14385    EAPI void               elm_menu_item_object_icon_name_set(Elm_Menu_Item *item, const char *icon) EINA_ARG_NONNULL(1, 2);
14386    /**
14387     * @brief Get the string representation from the icon of a menu item
14388     *
14389     * @param item The menu item object.
14390     * @return The string representation of @p item's icon or NULL
14391     *
14392     * @see elm_menu_item_object_icon_name_set()
14393     */
14394    EAPI const char        *elm_menu_item_object_icon_name_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14395    /**
14396     * @brief Set the content object of a menu item
14397     *
14398     * @param item The menu item object
14399     * @param The content object or NULL
14400     * @return EINA_TRUE on success, else EINA_FALSE
14401     *
14402     * Use this function to change the object swallowed by a menu item, deleting
14403     * any previously swallowed object.
14404     */
14405    EAPI Eina_Bool          elm_menu_item_object_content_set(Elm_Menu_Item *item, Evas_Object *obj) EINA_ARG_NONNULL(1);
14406    /**
14407     * @brief Get the content object of a menu item
14408     *
14409     * @param item The menu item object
14410     * @return The content object or NULL
14411     * @note If @p item was added with elm_menu_item_add_object, this
14412     * function will return the object passed, else it will return the
14413     * icon object.
14414     *
14415     * @see elm_menu_item_object_content_set()
14416     */
14417    EAPI Evas_Object *elm_menu_item_object_content_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14418    /**
14419     * @brief Set the selected state of @p item.
14420     *
14421     * @param item The menu item object.
14422     * @param selected The selected/unselected state of the item
14423     */
14424    EAPI void               elm_menu_item_selected_set(Elm_Menu_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
14425    /**
14426     * @brief Get the selected state of @p item.
14427     *
14428     * @param item The menu item object.
14429     * @return The selected/unselected state of the item
14430     *
14431     * @see elm_menu_item_selected_set()
14432     */
14433    EAPI Eina_Bool          elm_menu_item_selected_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14434    /**
14435     * @brief Set the disabled state of @p item.
14436     *
14437     * @param item The menu item object.
14438     * @param disabled The enabled/disabled state of the item
14439     */
14440    EAPI void               elm_menu_item_disabled_set(Elm_Menu_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
14441    /**
14442     * @brief Get the disabled state of @p item.
14443     *
14444     * @param item The menu item object.
14445     * @return The enabled/disabled state of the item
14446     *
14447     * @see elm_menu_item_disabled_set()
14448     */
14449    EAPI Eina_Bool          elm_menu_item_disabled_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14450    /**
14451     * @brief Add a separator item to menu @p obj under @p parent.
14452     *
14453     * @param obj The menu object
14454     * @param parent The item to add the separator under
14455     * @return The created item or NULL on failure
14456     *
14457     * This is item is a @ref Separator.
14458     */
14459    EAPI Elm_Menu_Item     *elm_menu_item_separator_add(Evas_Object *obj, Elm_Menu_Item *parent) EINA_ARG_NONNULL(1);
14460    /**
14461     * @brief Returns whether @p item is a separator.
14462     *
14463     * @param item The item to check
14464     * @return If true, @p item is a separator
14465     *
14466     * @see elm_menu_item_separator_add()
14467     */
14468    EAPI Eina_Bool          elm_menu_item_is_separator(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14469    /**
14470     * @brief Deletes an item from the menu.
14471     *
14472     * @param item The item to delete.
14473     *
14474     * @see elm_menu_item_add()
14475     */
14476    EAPI void               elm_menu_item_del(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14477    /**
14478     * @brief Set the function called when a menu item is deleted.
14479     *
14480     * @param item The item to set the callback on
14481     * @param func The function called
14482     *
14483     * @see elm_menu_item_add()
14484     * @see elm_menu_item_del()
14485     */
14486    EAPI void               elm_menu_item_del_cb_set(Elm_Menu_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
14487    /**
14488     * @brief Returns the data associated with menu item @p item.
14489     *
14490     * @param item The item
14491     * @return The data associated with @p item or NULL if none was set.
14492     *
14493     * This is the data set with elm_menu_add() or elm_menu_item_data_set().
14494     */
14495    EAPI void              *elm_menu_item_data_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
14496    /**
14497     * @brief Sets the data to be associated with menu item @p item.
14498     *
14499     * @param item The item
14500     * @param data The data to be associated with @p item
14501     */
14502    EAPI void               elm_menu_item_data_set(Elm_Menu_Item *item, const void *data) EINA_ARG_NONNULL(1);
14503    /**
14504     * @brief Returns a list of @p item's subitems.
14505     *
14506     * @param item The item
14507     * @return An Eina_List* of @p item's subitems
14508     *
14509     * @see elm_menu_add()
14510     */
14511    EAPI const Eina_List   *elm_menu_item_subitems_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
14512    /**
14513     * @brief Get the position of a menu item
14514     *
14515     * @param item The menu item
14516     * @return The item's index
14517     *
14518     * This function returns the index position of a menu item in a menu.
14519     * For a sub-menu, this number is relative to the first item in the sub-menu.
14520     *
14521     * @note Index values begin with 0
14522     */
14523    EAPI unsigned int       elm_menu_item_index_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
14524    /**
14525     * @brief @brief Return a menu item's owner menu
14526     *
14527     * @param item The menu item
14528     * @return The menu object owning @p item, or NULL on failure
14529     *
14530     * Use this function to get the menu object owning an item.
14531     */
14532    EAPI Evas_Object       *elm_menu_item_menu_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
14533    /**
14534     * @brief Get the selected item in the menu
14535     *
14536     * @param obj The menu object
14537     * @return The selected item, or NULL if none
14538     *
14539     * @see elm_menu_item_selected_get()
14540     * @see elm_menu_item_selected_set()
14541     */
14542    EAPI Elm_Menu_Item *elm_menu_selected_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
14543    /**
14544     * @brief Get the last item in the menu
14545     *
14546     * @param obj The menu object
14547     * @return The last item, or NULL if none
14548     */
14549    EAPI Elm_Menu_Item *elm_menu_last_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
14550    /**
14551     * @brief Get the first item in the menu
14552     *
14553     * @param obj The menu object
14554     * @return The first item, or NULL if none
14555     */
14556    EAPI Elm_Menu_Item *elm_menu_first_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
14557    /**
14558     * @brief Get the next item in the menu.
14559     *
14560     * @param item The menu item object.
14561     * @return The item after it, or NULL if none
14562     */
14563    EAPI Elm_Menu_Item *elm_menu_item_next_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
14564    /**
14565     * @brief Get the previous item in the menu.
14566     *
14567     * @param item The menu item object.
14568     * @return The item before it, or NULL if none
14569     */
14570    EAPI Elm_Menu_Item *elm_menu_item_prev_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
14571    /**
14572     * @}
14573     */
14574
14575    /**
14576     * @defgroup List List
14577     * @ingroup Elementary
14578     *
14579     * @image html img/widget/list/preview-00.png
14580     * @image latex img/widget/list/preview-00.eps width=\textwidth
14581     *
14582     * @image html img/list.png
14583     * @image latex img/list.eps width=\textwidth
14584     *
14585     * A list widget is a container whose children are displayed vertically or
14586     * horizontally, in order, and can be selected.
14587     * The list can accept only one or multiple items selection. Also has many
14588     * modes of items displaying.
14589     *
14590     * A list is a very simple type of list widget.  For more robust
14591     * lists, @ref Genlist should probably be used.
14592     *
14593     * Smart callbacks one can listen to:
14594     * - @c "activated" - The user has double-clicked or pressed
14595     *   (enter|return|spacebar) on an item. The @c event_info parameter
14596     *   is the item that was activated.
14597     * - @c "clicked,double" - The user has double-clicked an item.
14598     *   The @c event_info parameter is the item that was double-clicked.
14599     * - "selected" - when the user selected an item
14600     * - "unselected" - when the user unselected an item
14601     * - "longpressed" - an item in the list is long-pressed
14602     * - "scroll,edge,top" - the list is scrolled until the top edge
14603     * - "scroll,edge,bottom" - the list is scrolled until the bottom edge
14604     * - "scroll,edge,left" - the list is scrolled until the left edge
14605     * - "scroll,edge,right" - the list is scrolled until the right edge
14606     *
14607     * Available styles for it:
14608     * - @c "default"
14609     *
14610     * List of examples:
14611     * @li @ref list_example_01
14612     * @li @ref list_example_02
14613     * @li @ref list_example_03
14614     */
14615
14616    /**
14617     * @addtogroup List
14618     * @{
14619     */
14620
14621    /**
14622     * @enum _Elm_List_Mode
14623     * @typedef Elm_List_Mode
14624     *
14625     * Set list's resize behavior, transverse axis scroll and
14626     * items cropping. See each mode's description for more details.
14627     *
14628     * @note Default value is #ELM_LIST_SCROLL.
14629     *
14630     * Values <b> don't </b> work as bitmask, only one can be choosen.
14631     *
14632     * @see elm_list_mode_set()
14633     * @see elm_list_mode_get()
14634     *
14635     * @ingroup List
14636     */
14637    typedef enum _Elm_List_Mode
14638      {
14639         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. */
14640         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). */
14641         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. */
14642         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. */
14643         ELM_LIST_LAST /**< Indicates error if returned by elm_list_mode_get() */
14644      } Elm_List_Mode;
14645
14646    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().  */
14647
14648    /**
14649     * Add a new list widget to the given parent Elementary
14650     * (container) object.
14651     *
14652     * @param parent The parent object.
14653     * @return a new list widget handle or @c NULL, on errors.
14654     *
14655     * This function inserts a new list widget on the canvas.
14656     *
14657     * @ingroup List
14658     */
14659    EAPI Evas_Object     *elm_list_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14660
14661    /**
14662     * Starts the list.
14663     *
14664     * @param obj The list object
14665     *
14666     * @note Call before running show() on the list object.
14667     * @warning If not called, it won't display the list properly.
14668     *
14669     * @code
14670     * li = elm_list_add(win);
14671     * elm_list_item_append(li, "First", NULL, NULL, NULL, NULL);
14672     * elm_list_item_append(li, "Second", NULL, NULL, NULL, NULL);
14673     * elm_list_go(li);
14674     * evas_object_show(li);
14675     * @endcode
14676     *
14677     * @ingroup List
14678     */
14679    EAPI void             elm_list_go(Evas_Object *obj) EINA_ARG_NONNULL(1);
14680
14681    /**
14682     * Enable or disable multiple items selection on the list object.
14683     *
14684     * @param obj The list object
14685     * @param multi @c EINA_TRUE to enable multi selection or @c EINA_FALSE to
14686     * disable it.
14687     *
14688     * Disabled by default. If disabled, the user can select a single item of
14689     * the list each time. Selected items are highlighted on list.
14690     * If enabled, many items can be selected.
14691     *
14692     * If a selected item is selected again, it will be unselected.
14693     *
14694     * @see elm_list_multi_select_get()
14695     *
14696     * @ingroup List
14697     */
14698    EAPI void             elm_list_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
14699
14700    /**
14701     * Get a value whether multiple items selection is enabled or not.
14702     *
14703     * @see elm_list_multi_select_set() for details.
14704     *
14705     * @param obj The list object.
14706     * @return @c EINA_TRUE means multiple items selection is enabled.
14707     * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
14708     * @c EINA_FALSE is returned.
14709     *
14710     * @ingroup List
14711     */
14712    EAPI Eina_Bool        elm_list_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14713
14714    /**
14715     * Set which mode to use for the list object.
14716     *
14717     * @param obj The list object
14718     * @param mode One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
14719     * #ELM_LIST_LIMIT or #ELM_LIST_EXPAND.
14720     *
14721     * Set list's resize behavior, transverse axis scroll and
14722     * items cropping. See each mode's description for more details.
14723     *
14724     * @note Default value is #ELM_LIST_SCROLL.
14725     *
14726     * Only one can be set, if a previous one was set, it will be changed
14727     * by the new mode set. Bitmask won't work as well.
14728     *
14729     * @see elm_list_mode_get()
14730     *
14731     * @ingroup List
14732     */
14733    EAPI void             elm_list_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
14734
14735    /**
14736     * Get the mode the list is at.
14737     *
14738     * @param obj The list object
14739     * @return One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
14740     * #ELM_LIST_LIMIT, #ELM_LIST_EXPAND or #ELM_LIST_LAST on errors.
14741     *
14742     * @note see elm_list_mode_set() for more information.
14743     *
14744     * @ingroup List
14745     */
14746    EAPI Elm_List_Mode    elm_list_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14747
14748    /**
14749     * Enable or disable horizontal mode on the list object.
14750     *
14751     * @param obj The list object.
14752     * @param horizontal @c EINA_TRUE to enable horizontal or @c EINA_FALSE to
14753     * disable it, i.e., to enable vertical mode.
14754     *
14755     * @note Vertical mode is set by default.
14756     *
14757     * On horizontal mode items are displayed on list from left to right,
14758     * instead of from top to bottom. Also, the list will scroll horizontally.
14759     * Each item will presents left icon on top and right icon, or end, at
14760     * the bottom.
14761     *
14762     * @see elm_list_horizontal_get()
14763     *
14764     * @ingroup List
14765     */
14766    EAPI void             elm_list_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
14767
14768    /**
14769     * Get a value whether horizontal mode is enabled or not.
14770     *
14771     * @param obj The list object.
14772     * @return @c EINA_TRUE means horizontal mode selection is enabled.
14773     * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
14774     * @c EINA_FALSE is returned.
14775     *
14776     * @see elm_list_horizontal_set() for details.
14777     *
14778     * @ingroup List
14779     */
14780    EAPI Eina_Bool        elm_list_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14781
14782    /**
14783     * Enable or disable always select mode on the list object.
14784     *
14785     * @param obj The list object
14786     * @param always_select @c EINA_TRUE to enable always select mode or
14787     * @c EINA_FALSE to disable it.
14788     *
14789     * @note Always select mode is disabled by default.
14790     *
14791     * Default behavior of list items is to only call its callback function
14792     * the first time it's pressed, i.e., when it is selected. If a selected
14793     * item is pressed again, and multi-select is disabled, it won't call
14794     * this function (if multi-select is enabled it will unselect the item).
14795     *
14796     * If always select is enabled, it will call the callback function
14797     * everytime a item is pressed, so it will call when the item is selected,
14798     * and again when a selected item is pressed.
14799     *
14800     * @see elm_list_always_select_mode_get()
14801     * @see elm_list_multi_select_set()
14802     *
14803     * @ingroup List
14804     */
14805    EAPI void             elm_list_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
14806
14807    /**
14808     * Get a value whether always select mode is enabled or not, meaning that
14809     * an item will always call its callback function, even if already selected.
14810     *
14811     * @param obj The list object
14812     * @return @c EINA_TRUE means horizontal mode selection is enabled.
14813     * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
14814     * @c EINA_FALSE is returned.
14815     *
14816     * @see elm_list_always_select_mode_set() for details.
14817     *
14818     * @ingroup List
14819     */
14820    EAPI Eina_Bool        elm_list_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14821
14822    /**
14823     * Set bouncing behaviour when the scrolled content reaches an edge.
14824     *
14825     * Tell the internal scroller object whether it should bounce or not
14826     * when it reaches the respective edges for each axis.
14827     *
14828     * @param obj The list object
14829     * @param h_bounce Whether to bounce or not in the horizontal axis.
14830     * @param v_bounce Whether to bounce or not in the vertical axis.
14831     *
14832     * @see elm_scroller_bounce_set()
14833     *
14834     * @ingroup List
14835     */
14836    EAPI void             elm_list_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
14837
14838    /**
14839     * Get the bouncing behaviour of the internal scroller.
14840     *
14841     * Get whether the internal scroller should bounce when the edge of each
14842     * axis is reached scrolling.
14843     *
14844     * @param obj The list object.
14845     * @param h_bounce Pointer where to store the bounce state of the horizontal
14846     * axis.
14847     * @param v_bounce Pointer where to store the bounce state of the vertical
14848     * axis.
14849     *
14850     * @see elm_scroller_bounce_get()
14851     * @see elm_list_bounce_set()
14852     *
14853     * @ingroup List
14854     */
14855    EAPI void             elm_list_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
14856
14857    /**
14858     * Set the scrollbar policy.
14859     *
14860     * @param obj The list object
14861     * @param policy_h Horizontal scrollbar policy.
14862     * @param policy_v Vertical scrollbar policy.
14863     *
14864     * This sets the scrollbar visibility policy for the given scroller.
14865     * #ELM_SCROLLER_POLICY_AUTO means the scrollber is made visible if it
14866     * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
14867     * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
14868     * This applies respectively for the horizontal and vertical scrollbars.
14869     *
14870     * The both are disabled by default, i.e., are set to
14871     * #ELM_SCROLLER_POLICY_OFF.
14872     *
14873     * @ingroup List
14874     */
14875    EAPI void             elm_list_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
14876
14877    /**
14878     * Get the scrollbar policy.
14879     *
14880     * @see elm_list_scroller_policy_get() for details.
14881     *
14882     * @param obj The list object.
14883     * @param policy_h Pointer where to store horizontal scrollbar policy.
14884     * @param policy_v Pointer where to store vertical scrollbar policy.
14885     *
14886     * @ingroup List
14887     */
14888    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);
14889
14890    /**
14891     * Append a new item to the list object.
14892     *
14893     * @param obj The list object.
14894     * @param label The label of the list item.
14895     * @param icon The icon object to use for the left side of the item. An
14896     * icon can be any Evas object, but usually it is an icon created
14897     * with elm_icon_add().
14898     * @param end The icon object to use for the right side of the item. An
14899     * icon can be any Evas object.
14900     * @param func The function to call when the item is clicked.
14901     * @param data The data to associate with the item for related callbacks.
14902     *
14903     * @return The created item or @c NULL upon failure.
14904     *
14905     * A new item will be created and appended to the list, i.e., will
14906     * be set as @b last item.
14907     *
14908     * Items created with this method can be deleted with
14909     * elm_list_item_del().
14910     *
14911     * Associated @p data can be properly freed when item is deleted if a
14912     * callback function is set with elm_list_item_del_cb_set().
14913     *
14914     * If a function is passed as argument, it will be called everytime this item
14915     * is selected, i.e., the user clicks over an unselected item.
14916     * If always select is enabled it will call this function every time
14917     * user clicks over an item (already selected or not).
14918     * If such function isn't needed, just passing
14919     * @c NULL as @p func is enough. The same should be done for @p data.
14920     *
14921     * Simple example (with no function callback or data associated):
14922     * @code
14923     * li = elm_list_add(win);
14924     * ic = elm_icon_add(win);
14925     * elm_icon_file_set(ic, "path/to/image", NULL);
14926     * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
14927     * elm_list_item_append(li, "label", ic, NULL, NULL, NULL);
14928     * elm_list_go(li);
14929     * evas_object_show(li);
14930     * @endcode
14931     *
14932     * @see elm_list_always_select_mode_set()
14933     * @see elm_list_item_del()
14934     * @see elm_list_item_del_cb_set()
14935     * @see elm_list_clear()
14936     * @see elm_icon_add()
14937     *
14938     * @ingroup List
14939     */
14940    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);
14941
14942    /**
14943     * Prepend a new item to the list object.
14944     *
14945     * @param obj The list object.
14946     * @param label The label of the list item.
14947     * @param icon The icon object to use for the left side of the item. An
14948     * icon can be any Evas object, but usually it is an icon created
14949     * with elm_icon_add().
14950     * @param end The icon object to use for the right side of the item. An
14951     * icon can be any Evas object.
14952     * @param func The function to call when the item is clicked.
14953     * @param data The data to associate with the item for related callbacks.
14954     *
14955     * @return The created item or @c NULL upon failure.
14956     *
14957     * A new item will be created and prepended to the list, i.e., will
14958     * be set as @b first item.
14959     *
14960     * Items created with this method can be deleted with
14961     * elm_list_item_del().
14962     *
14963     * Associated @p data can be properly freed when item is deleted if a
14964     * callback function is set with elm_list_item_del_cb_set().
14965     *
14966     * If a function is passed as argument, it will be called everytime this item
14967     * is selected, i.e., the user clicks over an unselected item.
14968     * If always select is enabled it will call this function every time
14969     * user clicks over an item (already selected or not).
14970     * If such function isn't needed, just passing
14971     * @c NULL as @p func is enough. The same should be done for @p data.
14972     *
14973     * @see elm_list_item_append() for a simple code example.
14974     * @see elm_list_always_select_mode_set()
14975     * @see elm_list_item_del()
14976     * @see elm_list_item_del_cb_set()
14977     * @see elm_list_clear()
14978     * @see elm_icon_add()
14979     *
14980     * @ingroup List
14981     */
14982    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);
14983
14984    /**
14985     * Insert a new item into the list object before item @p before.
14986     *
14987     * @param obj The list object.
14988     * @param before The list item to insert before.
14989     * @param label The label of the list item.
14990     * @param icon The icon object to use for the left side of the item. An
14991     * icon can be any Evas object, but usually it is an icon created
14992     * with elm_icon_add().
14993     * @param end The icon object to use for the right side of the item. An
14994     * icon can be any Evas object.
14995     * @param func The function to call when the item is clicked.
14996     * @param data The data to associate with the item for related callbacks.
14997     *
14998     * @return The created item or @c NULL upon failure.
14999     *
15000     * A new item will be created and added to the list. Its position in
15001     * this list will be just before item @p before.
15002     *
15003     * Items created with this method can be deleted with
15004     * elm_list_item_del().
15005     *
15006     * Associated @p data can be properly freed when item is deleted if a
15007     * callback function is set with elm_list_item_del_cb_set().
15008     *
15009     * If a function is passed as argument, it will be called everytime this item
15010     * is selected, i.e., the user clicks over an unselected item.
15011     * If always select is enabled it will call this function every time
15012     * user clicks over an item (already selected or not).
15013     * If such function isn't needed, just passing
15014     * @c NULL as @p func is enough. The same should be done for @p data.
15015     *
15016     * @see elm_list_item_append() for a simple code example.
15017     * @see elm_list_always_select_mode_set()
15018     * @see elm_list_item_del()
15019     * @see elm_list_item_del_cb_set()
15020     * @see elm_list_clear()
15021     * @see elm_icon_add()
15022     *
15023     * @ingroup List
15024     */
15025    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);
15026
15027    /**
15028     * Insert a new item into the list object after item @p after.
15029     *
15030     * @param obj The list object.
15031     * @param after The list item to insert after.
15032     * @param label The label of the list item.
15033     * @param icon The icon object to use for the left side of the item. An
15034     * icon can be any Evas object, but usually it is an icon created
15035     * with elm_icon_add().
15036     * @param end The icon object to use for the right side of the item. An
15037     * icon can be any Evas object.
15038     * @param func The function to call when the item is clicked.
15039     * @param data The data to associate with the item for related callbacks.
15040     *
15041     * @return The created item or @c NULL upon failure.
15042     *
15043     * A new item will be created and added to the list. Its position in
15044     * this list will be just after item @p after.
15045     *
15046     * Items created with this method can be deleted with
15047     * elm_list_item_del().
15048     *
15049     * Associated @p data can be properly freed when item is deleted if a
15050     * callback function is set with elm_list_item_del_cb_set().
15051     *
15052     * If a function is passed as argument, it will be called everytime this item
15053     * is selected, i.e., the user clicks over an unselected item.
15054     * If always select is enabled it will call this function every time
15055     * user clicks over an item (already selected or not).
15056     * If such function isn't needed, just passing
15057     * @c NULL as @p func is enough. The same should be done for @p data.
15058     *
15059     * @see elm_list_item_append() for a simple code example.
15060     * @see elm_list_always_select_mode_set()
15061     * @see elm_list_item_del()
15062     * @see elm_list_item_del_cb_set()
15063     * @see elm_list_clear()
15064     * @see elm_icon_add()
15065     *
15066     * @ingroup List
15067     */
15068    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);
15069
15070    /**
15071     * Insert a new item into the sorted list object.
15072     *
15073     * @param obj The list object.
15074     * @param label The label of the list item.
15075     * @param icon The icon object to use for the left side of the item. An
15076     * icon can be any Evas object, but usually it is an icon created
15077     * with elm_icon_add().
15078     * @param end The icon object to use for the right side of the item. An
15079     * icon can be any Evas object.
15080     * @param func The function to call when the item is clicked.
15081     * @param data The data to associate with the item for related callbacks.
15082     * @param cmp_func The comparing function to be used to sort list
15083     * items <b>by #Elm_List_Item item handles</b>. This function will
15084     * receive two items and compare them, returning a non-negative integer
15085     * if the second item should be place after the first, or negative value
15086     * if should be placed before.
15087     *
15088     * @return The created item or @c NULL upon failure.
15089     *
15090     * @note This function inserts values into a list object assuming it was
15091     * sorted and the result will be sorted.
15092     *
15093     * A new item will be created and added to the list. Its position in
15094     * this list will be found comparing the new item with previously inserted
15095     * items using function @p cmp_func.
15096     *
15097     * Items created with this method can be deleted with
15098     * elm_list_item_del().
15099     *
15100     * Associated @p data can be properly freed when item is deleted if a
15101     * callback function is set with elm_list_item_del_cb_set().
15102     *
15103     * If a function is passed as argument, it will be called everytime this item
15104     * is selected, i.e., the user clicks over an unselected item.
15105     * If always select is enabled it will call this function every time
15106     * user clicks over an item (already selected or not).
15107     * If such function isn't needed, just passing
15108     * @c NULL as @p func is enough. The same should be done for @p data.
15109     *
15110     * @see elm_list_item_append() for a simple code example.
15111     * @see elm_list_always_select_mode_set()
15112     * @see elm_list_item_del()
15113     * @see elm_list_item_del_cb_set()
15114     * @see elm_list_clear()
15115     * @see elm_icon_add()
15116     *
15117     * @ingroup List
15118     */
15119    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);
15120
15121    /**
15122     * Remove all list's items.
15123     *
15124     * @param obj The list object
15125     *
15126     * @see elm_list_item_del()
15127     * @see elm_list_item_append()
15128     *
15129     * @ingroup List
15130     */
15131    EAPI void             elm_list_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
15132
15133    /**
15134     * Get a list of all the list items.
15135     *
15136     * @param obj The list object
15137     * @return An @c Eina_List of list items, #Elm_List_Item,
15138     * or @c NULL on failure.
15139     *
15140     * @see elm_list_item_append()
15141     * @see elm_list_item_del()
15142     * @see elm_list_clear()
15143     *
15144     * @ingroup List
15145     */
15146    EAPI const Eina_List *elm_list_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15147
15148    /**
15149     * Get the selected item.
15150     *
15151     * @param obj The list object.
15152     * @return The selected list item.
15153     *
15154     * The selected item can be unselected with function
15155     * elm_list_item_selected_set().
15156     *
15157     * The selected item always will be highlighted on list.
15158     *
15159     * @see elm_list_selected_items_get()
15160     *
15161     * @ingroup List
15162     */
15163    EAPI Elm_List_Item   *elm_list_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15164
15165    /**
15166     * Return a list of the currently selected list items.
15167     *
15168     * @param obj The list object.
15169     * @return An @c Eina_List of list items, #Elm_List_Item,
15170     * or @c NULL on failure.
15171     *
15172     * Multiple items can be selected if multi select is enabled. It can be
15173     * done with elm_list_multi_select_set().
15174     *
15175     * @see elm_list_selected_item_get()
15176     * @see elm_list_multi_select_set()
15177     *
15178     * @ingroup List
15179     */
15180    EAPI const Eina_List *elm_list_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15181
15182    /**
15183     * Set the selected state of an item.
15184     *
15185     * @param item The list item
15186     * @param selected The selected state
15187     *
15188     * This sets the selected state of the given item @p it.
15189     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
15190     *
15191     * If a new item is selected the previosly selected will be unselected,
15192     * unless multiple selection is enabled with elm_list_multi_select_set().
15193     * Previoulsy selected item can be get with function
15194     * elm_list_selected_item_get().
15195     *
15196     * Selected items will be highlighted.
15197     *
15198     * @see elm_list_item_selected_get()
15199     * @see elm_list_selected_item_get()
15200     * @see elm_list_multi_select_set()
15201     *
15202     * @ingroup List
15203     */
15204    EAPI void             elm_list_item_selected_set(Elm_List_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
15205
15206    /*
15207     * Get whether the @p item is selected or not.
15208     *
15209     * @param item The list item.
15210     * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
15211     * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
15212     *
15213     * @see elm_list_selected_item_set() for details.
15214     * @see elm_list_item_selected_get()
15215     *
15216     * @ingroup List
15217     */
15218    EAPI Eina_Bool        elm_list_item_selected_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15219
15220    /**
15221     * Set or unset item as a separator.
15222     *
15223     * @param it The list item.
15224     * @param setting @c EINA_TRUE to set item @p it as separator or
15225     * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
15226     *
15227     * Items aren't set as separator by default.
15228     *
15229     * If set as separator it will display separator theme, so won't display
15230     * icons or label.
15231     *
15232     * @see elm_list_item_separator_get()
15233     *
15234     * @ingroup List
15235     */
15236    EAPI void             elm_list_item_separator_set(Elm_List_Item *it, Eina_Bool setting) EINA_ARG_NONNULL(1);
15237
15238    /**
15239     * Get a value whether item is a separator or not.
15240     *
15241     * @see elm_list_item_separator_set() for details.
15242     *
15243     * @param it The list item.
15244     * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
15245     * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
15246     *
15247     * @ingroup List
15248     */
15249    EAPI Eina_Bool        elm_list_item_separator_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
15250
15251    /**
15252     * Show @p item in the list view.
15253     *
15254     * @param item The list item to be shown.
15255     *
15256     * It won't animate list until item is visible. If such behavior is wanted,
15257     * use elm_list_bring_in() intead.
15258     *
15259     * @ingroup List
15260     */
15261    EAPI void             elm_list_item_show(Elm_List_Item *item) EINA_ARG_NONNULL(1);
15262
15263    /**
15264     * Bring in the given item to list view.
15265     *
15266     * @param item The item.
15267     *
15268     * This causes list to jump to the given item @p item and show it
15269     * (by scrolling), if it is not fully visible.
15270     *
15271     * This may use animation to do so and take a period of time.
15272     *
15273     * If animation isn't wanted, elm_list_item_show() can be used.
15274     *
15275     * @ingroup List
15276     */
15277    EAPI void             elm_list_item_bring_in(Elm_List_Item *item) EINA_ARG_NONNULL(1);
15278
15279    /**
15280     * Delete them item from the list.
15281     *
15282     * @param item The item of list to be deleted.
15283     *
15284     * If deleting all list items is required, elm_list_clear()
15285     * should be used instead of getting items list and deleting each one.
15286     *
15287     * @see elm_list_clear()
15288     * @see elm_list_item_append()
15289     * @see elm_list_item_del_cb_set()
15290     *
15291     * @ingroup List
15292     */
15293    EAPI void             elm_list_item_del(Elm_List_Item *item) EINA_ARG_NONNULL(1);
15294
15295    /**
15296     * Set the function called when a list item is freed.
15297     *
15298     * @param item The item to set the callback on
15299     * @param func The function called
15300     *
15301     * If there is a @p func, then it will be called prior item's memory release.
15302     * That will be called with the following arguments:
15303     * @li item's data;
15304     * @li item's Evas object;
15305     * @li item itself;
15306     *
15307     * This way, a data associated to a list item could be properly freed.
15308     *
15309     * @ingroup List
15310     */
15311    EAPI void             elm_list_item_del_cb_set(Elm_List_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
15312
15313    /**
15314     * Get the data associated to the item.
15315     *
15316     * @param item The list item
15317     * @return The data associated to @p item
15318     *
15319     * The return value is a pointer to data associated to @p item when it was
15320     * created, with function elm_list_item_append() or similar. If no data
15321     * was passed as argument, it will return @c NULL.
15322     *
15323     * @see elm_list_item_append()
15324     *
15325     * @ingroup List
15326     */
15327    EAPI void            *elm_list_item_data_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15328
15329    /**
15330     * Get the left side icon associated to the item.
15331     *
15332     * @param item The list item
15333     * @return The left side icon associated to @p item
15334     *
15335     * The return value is a pointer to the icon associated to @p item when
15336     * it was
15337     * created, with function elm_list_item_append() or similar, or later
15338     * with function elm_list_item_icon_set(). If no icon
15339     * was passed as argument, it will return @c NULL.
15340     *
15341     * @see elm_list_item_append()
15342     * @see elm_list_item_icon_set()
15343     *
15344     * @ingroup List
15345     */
15346    EAPI Evas_Object     *elm_list_item_icon_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15347
15348    /**
15349     * Set the left side icon associated to the item.
15350     *
15351     * @param item The list item
15352     * @param icon The left side icon object to associate with @p item
15353     *
15354     * The icon object to use at left side of the item. An
15355     * icon can be any Evas object, but usually it is an icon created
15356     * with elm_icon_add().
15357     *
15358     * Once the icon object is set, a previously set one will be deleted.
15359     * @warning Setting the same icon for two items will cause the icon to
15360     * dissapear from the first item.
15361     *
15362     * If an icon was passed as argument on item creation, with function
15363     * elm_list_item_append() or similar, it will be already
15364     * associated to the item.
15365     *
15366     * @see elm_list_item_append()
15367     * @see elm_list_item_icon_get()
15368     *
15369     * @ingroup List
15370     */
15371    EAPI void             elm_list_item_icon_set(Elm_List_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
15372
15373    /**
15374     * Get the right side icon associated to the item.
15375     *
15376     * @param item The list item
15377     * @return The right side icon associated to @p item
15378     *
15379     * The return value is a pointer to the icon associated to @p item when
15380     * it was
15381     * created, with function elm_list_item_append() or similar, or later
15382     * with function elm_list_item_icon_set(). If no icon
15383     * was passed as argument, it will return @c NULL.
15384     *
15385     * @see elm_list_item_append()
15386     * @see elm_list_item_icon_set()
15387     *
15388     * @ingroup List
15389     */
15390    EAPI Evas_Object     *elm_list_item_end_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15391
15392    /**
15393     * Set the right side icon associated to the item.
15394     *
15395     * @param item The list item
15396     * @param end The right side icon object to associate with @p item
15397     *
15398     * The icon object to use at right side of the item. An
15399     * icon can be any Evas object, but usually it is an icon created
15400     * with elm_icon_add().
15401     *
15402     * Once the icon object is set, a previously set one will be deleted.
15403     * @warning Setting the same icon for two items will cause the icon to
15404     * dissapear from the first item.
15405     *
15406     * If an icon was passed as argument on item creation, with function
15407     * elm_list_item_append() or similar, it will be already
15408     * associated to the item.
15409     *
15410     * @see elm_list_item_append()
15411     * @see elm_list_item_end_get()
15412     *
15413     * @ingroup List
15414     */
15415    EAPI void             elm_list_item_end_set(Elm_List_Item *item, Evas_Object *end) EINA_ARG_NONNULL(1);
15416
15417    /**
15418     * Gets the base object of the item.
15419     *
15420     * @param item The list item
15421     * @return The base object associated with @p item
15422     *
15423     * Base object is the @c Evas_Object that represents that item.
15424     *
15425     * @ingroup List
15426     */
15427    EAPI Evas_Object     *elm_list_item_object_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15428    EINA_DEPRECATED EAPI Evas_Object     *elm_list_item_base_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15429
15430    /**
15431     * Get the label of item.
15432     *
15433     * @param item The item of list.
15434     * @return The label of item.
15435     *
15436     * The return value is a pointer to the label associated to @p item when
15437     * it was created, with function elm_list_item_append(), or later
15438     * with function elm_list_item_label_set. If no label
15439     * was passed as argument, it will return @c NULL.
15440     *
15441     * @see elm_list_item_label_set() for more details.
15442     * @see elm_list_item_append()
15443     *
15444     * @ingroup List
15445     */
15446    EAPI const char      *elm_list_item_label_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15447
15448    /**
15449     * Set the label of item.
15450     *
15451     * @param item The item of list.
15452     * @param text The label of item.
15453     *
15454     * The label to be displayed by the item.
15455     * Label will be placed between left and right side icons (if set).
15456     *
15457     * If a label was passed as argument on item creation, with function
15458     * elm_list_item_append() or similar, it will be already
15459     * displayed by the item.
15460     *
15461     * @see elm_list_item_label_get()
15462     * @see elm_list_item_append()
15463     *
15464     * @ingroup List
15465     */
15466    EAPI void             elm_list_item_label_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
15467
15468
15469    /**
15470     * Get the item before @p it in list.
15471     *
15472     * @param it The list item.
15473     * @return The item before @p it, or @c NULL if none or on failure.
15474     *
15475     * @note If it is the first item, @c NULL will be returned.
15476     *
15477     * @see elm_list_item_append()
15478     * @see elm_list_items_get()
15479     *
15480     * @ingroup List
15481     */
15482    EAPI Elm_List_Item   *elm_list_item_prev(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
15483
15484    /**
15485     * Get the item after @p it in list.
15486     *
15487     * @param it The list item.
15488     * @return The item after @p it, or @c NULL if none or on failure.
15489     *
15490     * @note If it is the last item, @c NULL will be returned.
15491     *
15492     * @see elm_list_item_append()
15493     * @see elm_list_items_get()
15494     *
15495     * @ingroup List
15496     */
15497    EAPI Elm_List_Item   *elm_list_item_next(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
15498
15499    /**
15500     * Sets the disabled/enabled state of a list item.
15501     *
15502     * @param it The item.
15503     * @param disabled The disabled state.
15504     *
15505     * A disabled item cannot be selected or unselected. It will also
15506     * change its appearance (generally greyed out). This sets the
15507     * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
15508     * enabled).
15509     *
15510     * @ingroup List
15511     */
15512    EAPI void             elm_list_item_disabled_set(Elm_List_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
15513
15514    /**
15515     * Get a value whether list item is disabled or not.
15516     *
15517     * @param it The item.
15518     * @return The disabled state.
15519     *
15520     * @see elm_list_item_disabled_set() for more details.
15521     *
15522     * @ingroup List
15523     */
15524    EAPI Eina_Bool        elm_list_item_disabled_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
15525
15526    /**
15527     * Set the text to be shown in a given list item's tooltips.
15528     *
15529     * @param item Target item.
15530     * @param text The text to set in the content.
15531     *
15532     * Setup the text as tooltip to object. The item can have only one tooltip,
15533     * so any previous tooltip data - set with this function or
15534     * elm_list_item_tooltip_content_cb_set() - is removed.
15535     *
15536     * @see elm_object_tooltip_text_set() for more details.
15537     *
15538     * @ingroup List
15539     */
15540    EAPI void             elm_list_item_tooltip_text_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
15541
15542
15543    /**
15544     * @brief Disable size restrictions on an object's tooltip
15545     * @param item The tooltip's anchor object
15546     * @param disable If EINA_TRUE, size restrictions are disabled
15547     * @return EINA_FALSE on failure, EINA_TRUE on success
15548     *
15549     * This function allows a tooltip to expand beyond its parant window's canvas.
15550     * It will instead be limited only by the size of the display.
15551     */
15552    EAPI Eina_Bool        elm_list_item_tooltip_size_restrict_disable(Elm_List_Item *item, Eina_Bool disable) EINA_ARG_NONNULL(1);
15553    /**
15554     * @brief Retrieve size restriction state of an object's tooltip
15555     * @param obj The tooltip's anchor object
15556     * @return If EINA_TRUE, size restrictions are disabled
15557     *
15558     * This function returns whether a tooltip is allowed to expand beyond
15559     * its parant window's canvas.
15560     * It will instead be limited only by the size of the display.
15561     */
15562    EAPI Eina_Bool        elm_list_item_tooltip_size_restrict_disabled_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15563
15564    /**
15565     * Set the content to be shown in the tooltip item.
15566     *
15567     * Setup the tooltip to item. The item can have only one tooltip,
15568     * so any previous tooltip data is removed. @p func(with @p data) will
15569     * be called every time that need show the tooltip and it should
15570     * return a valid Evas_Object. This object is then managed fully by
15571     * tooltip system and is deleted when the tooltip is gone.
15572     *
15573     * @param item the list item being attached a tooltip.
15574     * @param func the function used to create the tooltip contents.
15575     * @param data what to provide to @a func as callback data/context.
15576     * @param del_cb called when data is not needed anymore, either when
15577     *        another callback replaces @a func, the tooltip is unset with
15578     *        elm_list_item_tooltip_unset() or the owner @a item
15579     *        dies. This callback receives as the first parameter the
15580     *        given @a data, and @c event_info is the item.
15581     *
15582     * @see elm_object_tooltip_content_cb_set() for more details.
15583     *
15584     * @ingroup List
15585     */
15586    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);
15587
15588    /**
15589     * Unset tooltip from item.
15590     *
15591     * @param item list item to remove previously set tooltip.
15592     *
15593     * Remove tooltip from item. The callback provided as del_cb to
15594     * elm_list_item_tooltip_content_cb_set() will be called to notify
15595     * it is not used anymore.
15596     *
15597     * @see elm_object_tooltip_unset() for more details.
15598     * @see elm_list_item_tooltip_content_cb_set()
15599     *
15600     * @ingroup List
15601     */
15602    EAPI void             elm_list_item_tooltip_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
15603
15604    /**
15605     * Sets a different style for this item tooltip.
15606     *
15607     * @note before you set a style you should define a tooltip with
15608     *       elm_list_item_tooltip_content_cb_set() or
15609     *       elm_list_item_tooltip_text_set()
15610     *
15611     * @param item list item with tooltip already set.
15612     * @param style the theme style to use (default, transparent, ...)
15613     *
15614     * @see elm_object_tooltip_style_set() for more details.
15615     *
15616     * @ingroup List
15617     */
15618    EAPI void             elm_list_item_tooltip_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
15619
15620    /**
15621     * Get the style for this item tooltip.
15622     *
15623     * @param item list item with tooltip already set.
15624     * @return style the theme style in use, defaults to "default". If the
15625     *         object does not have a tooltip set, then NULL is returned.
15626     *
15627     * @see elm_object_tooltip_style_get() for more details.
15628     * @see elm_list_item_tooltip_style_set()
15629     *
15630     * @ingroup List
15631     */
15632    EAPI const char      *elm_list_item_tooltip_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15633
15634    /**
15635     * Set the type of mouse pointer/cursor decoration to be shown,
15636     * when the mouse pointer is over the given list widget item
15637     *
15638     * @param item list item to customize cursor on
15639     * @param cursor the cursor type's name
15640     *
15641     * This function works analogously as elm_object_cursor_set(), but
15642     * here the cursor's changing area is restricted to the item's
15643     * area, and not the whole widget's. Note that that item cursors
15644     * have precedence over widget cursors, so that a mouse over an
15645     * item with custom cursor set will always show @b that cursor.
15646     *
15647     * If this function is called twice for an object, a previously set
15648     * cursor will be unset on the second call.
15649     *
15650     * @see elm_object_cursor_set()
15651     * @see elm_list_item_cursor_get()
15652     * @see elm_list_item_cursor_unset()
15653     *
15654     * @ingroup List
15655     */
15656    EAPI void             elm_list_item_cursor_set(Elm_List_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
15657
15658    /*
15659     * Get the type of mouse pointer/cursor decoration set to be shown,
15660     * when the mouse pointer is over the given list widget item
15661     *
15662     * @param item list item with custom cursor set
15663     * @return the cursor type's name or @c NULL, if no custom cursors
15664     * were set to @p item (and on errors)
15665     *
15666     * @see elm_object_cursor_get()
15667     * @see elm_list_item_cursor_set()
15668     * @see elm_list_item_cursor_unset()
15669     *
15670     * @ingroup List
15671     */
15672    EAPI const char      *elm_list_item_cursor_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15673
15674    /**
15675     * Unset any custom mouse pointer/cursor decoration set to be
15676     * shown, when the mouse pointer is over the given list widget
15677     * item, thus making it show the @b default cursor again.
15678     *
15679     * @param item a list item
15680     *
15681     * Use this call to undo any custom settings on this item's cursor
15682     * decoration, bringing it back to defaults (no custom style set).
15683     *
15684     * @see elm_object_cursor_unset()
15685     * @see elm_list_item_cursor_set()
15686     *
15687     * @ingroup List
15688     */
15689    EAPI void             elm_list_item_cursor_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
15690
15691    /**
15692     * Set a different @b style for a given custom cursor set for a
15693     * list item.
15694     *
15695     * @param item list item with custom cursor set
15696     * @param style the <b>theme style</b> to use (e.g. @c "default",
15697     * @c "transparent", etc)
15698     *
15699     * This function only makes sense when one is using custom mouse
15700     * cursor decorations <b>defined in a theme file</b>, which can have,
15701     * given a cursor name/type, <b>alternate styles</b> on it. It
15702     * works analogously as elm_object_cursor_style_set(), but here
15703     * applyed only to list item objects.
15704     *
15705     * @warning Before you set a cursor style you should have definen a
15706     *       custom cursor previously on the item, with
15707     *       elm_list_item_cursor_set()
15708     *
15709     * @see elm_list_item_cursor_engine_only_set()
15710     * @see elm_list_item_cursor_style_get()
15711     *
15712     * @ingroup List
15713     */
15714    EAPI void             elm_list_item_cursor_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
15715
15716    /**
15717     * Get the current @b style set for a given list item's custom
15718     * cursor
15719     *
15720     * @param item list item with custom cursor set.
15721     * @return style the cursor style in use. If the object does not
15722     *         have a cursor set, then @c NULL is returned.
15723     *
15724     * @see elm_list_item_cursor_style_set() for more details
15725     *
15726     * @ingroup List
15727     */
15728    EAPI const char      *elm_list_item_cursor_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15729
15730    /**
15731     * Set if the (custom)cursor for a given list item should be
15732     * searched in its theme, also, or should only rely on the
15733     * rendering engine.
15734     *
15735     * @param item item with custom (custom) cursor already set on
15736     * @param engine_only Use @c EINA_TRUE to have cursors looked for
15737     * only on those provided by the rendering engine, @c EINA_FALSE to
15738     * have them searched on the widget's theme, as well.
15739     *
15740     * @note This call is of use only if you've set a custom cursor
15741     * for list items, with elm_list_item_cursor_set().
15742     *
15743     * @note By default, cursors will only be looked for between those
15744     * provided by the rendering engine.
15745     *
15746     * @ingroup List
15747     */
15748    EAPI void             elm_list_item_cursor_engine_only_set(Elm_List_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
15749
15750    /**
15751     * Get if the (custom) cursor for a given list item is being
15752     * searched in its theme, also, or is only relying on the rendering
15753     * engine.
15754     *
15755     * @param item a list item
15756     * @return @c EINA_TRUE, if cursors are being looked for only on
15757     * those provided by the rendering engine, @c EINA_FALSE if they
15758     * are being searched on the widget's theme, as well.
15759     *
15760     * @see elm_list_item_cursor_engine_only_set(), for more details
15761     *
15762     * @ingroup List
15763     */
15764    EAPI Eina_Bool        elm_list_item_cursor_engine_only_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
15765
15766    /**
15767     * @}
15768     */
15769
15770    /**
15771     * @defgroup Slider Slider
15772     * @ingroup Elementary
15773     *
15774     * @image html img/widget/slider/preview-00.png
15775     * @image latex img/widget/slider/preview-00.eps width=\textwidth
15776     *
15777     * The slider adds a dragable “slider” widget for selecting the value of
15778     * something within a range.
15779     *
15780     * A slider can be horizontal or vertical. It can contain an Icon and has a
15781     * primary label as well as a units label (that is formatted with floating
15782     * point values and thus accepts a printf-style format string, like
15783     * “%1.2f units”. There is also an indicator string that may be somewhere
15784     * else (like on the slider itself) that also accepts a format string like
15785     * units. Label, Icon Unit and Indicator strings/objects are optional.
15786     *
15787     * A slider may be inverted which means values invert, with high vales being
15788     * on the left or top and low values on the right or bottom (as opposed to
15789     * normally being low on the left or top and high on the bottom and right).
15790     *
15791     * The slider should have its minimum and maximum values set by the
15792     * application with  elm_slider_min_max_set() and value should also be set by
15793     * the application before use with  elm_slider_value_set(). The span of the
15794     * slider is its length (horizontally or vertically). This will be scaled by
15795     * the object or applications scaling factor. At any point code can query the
15796     * slider for its value with elm_slider_value_get().
15797     *
15798     * Smart callbacks one can listen to:
15799     * - "changed" - Whenever the slider value is changed by the user.
15800     * - "slider,drag,start" - dragging the slider indicator around has started.
15801     * - "slider,drag,stop" - dragging the slider indicator around has stopped.
15802     * - "delay,changed" - A short time after the value is changed by the user.
15803     * This will be called only when the user stops dragging for
15804     * a very short period or when they release their
15805     * finger/mouse, so it avoids possibly expensive reactions to
15806     * the value change.
15807     *
15808     * Available styles for it:
15809     * - @c "default"
15810     *
15811     * Here is an example on its usage:
15812     * @li @ref slider_example
15813     */
15814
15815    /**
15816     * @addtogroup Slider
15817     * @{
15818     */
15819
15820    /**
15821     * Add a new slider widget to the given parent Elementary
15822     * (container) object.
15823     *
15824     * @param parent The parent object.
15825     * @return a new slider widget handle or @c NULL, on errors.
15826     *
15827     * This function inserts a new slider widget on the canvas.
15828     *
15829     * @ingroup Slider
15830     */
15831    EAPI Evas_Object       *elm_slider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
15832
15833    /**
15834     * Set the label of a given slider widget
15835     *
15836     * @param obj The progress bar object
15837     * @param label The text label string, in UTF-8
15838     *
15839     * @ingroup Slider
15840     * @deprecated use elm_object_text_set() instead.
15841     */
15842    EINA_DEPRECATED EAPI void               elm_slider_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
15843
15844    /**
15845     * Get the label of a given slider widget
15846     *
15847     * @param obj The progressbar object
15848     * @return The text label string, in UTF-8
15849     *
15850     * @ingroup Slider
15851     * @deprecated use elm_object_text_get() instead.
15852     */
15853    EINA_DEPRECATED EAPI const char        *elm_slider_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15854
15855    /**
15856     * Set the icon object of the slider object.
15857     *
15858     * @param obj The slider object.
15859     * @param icon The icon object.
15860     *
15861     * On horizontal mode, icon is placed at left, and on vertical mode,
15862     * placed at top.
15863     *
15864     * @note Once the icon object is set, a previously set one will be deleted.
15865     * If you want to keep that old content object, use the
15866     * elm_slider_icon_unset() function.
15867     *
15868     * @warning If the object being set does not have minimum size hints set,
15869     * it won't get properly displayed.
15870     *
15871     * @ingroup Slider
15872     */
15873    EAPI void               elm_slider_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
15874
15875    /**
15876     * Unset an icon set on a given slider widget.
15877     *
15878     * @param obj The slider object.
15879     * @return The icon object that was being used, if any was set, or
15880     * @c NULL, otherwise (and on errors).
15881     *
15882     * On horizontal mode, icon is placed at left, and on vertical mode,
15883     * placed at top.
15884     *
15885     * This call will unparent and return the icon object which was set
15886     * for this widget, previously, on success.
15887     *
15888     * @see elm_slider_icon_set() for more details
15889     * @see elm_slider_icon_get()
15890     *
15891     * @ingroup Slider
15892     */
15893    EAPI Evas_Object       *elm_slider_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15894
15895    /**
15896     * Retrieve the icon object set for a given slider widget.
15897     *
15898     * @param obj The slider object.
15899     * @return The icon object's handle, if @p obj had one set, or @c NULL,
15900     * otherwise (and on errors).
15901     *
15902     * On horizontal mode, icon is placed at left, and on vertical mode,
15903     * placed at top.
15904     *
15905     * @see elm_slider_icon_set() for more details
15906     * @see elm_slider_icon_unset()
15907     *
15908     * @ingroup Slider
15909     */
15910    EAPI Evas_Object       *elm_slider_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15911
15912    /**
15913     * Set the end object of the slider object.
15914     *
15915     * @param obj The slider object.
15916     * @param end The end object.
15917     *
15918     * On horizontal mode, end is placed at left, and on vertical mode,
15919     * placed at bottom.
15920     *
15921     * @note Once the icon object is set, a previously set one will be deleted.
15922     * If you want to keep that old content object, use the
15923     * elm_slider_end_unset() function.
15924     *
15925     * @warning If the object being set does not have minimum size hints set,
15926     * it won't get properly displayed.
15927     *
15928     * @ingroup Slider
15929     */
15930    EAPI void               elm_slider_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1);
15931
15932    /**
15933     * Unset an end object set on a given slider widget.
15934     *
15935     * @param obj The slider object.
15936     * @return The end object that was being used, if any was set, or
15937     * @c NULL, otherwise (and on errors).
15938     *
15939     * On horizontal mode, end is placed at left, and on vertical mode,
15940     * placed at bottom.
15941     *
15942     * This call will unparent and return the icon object which was set
15943     * for this widget, previously, on success.
15944     *
15945     * @see elm_slider_end_set() for more details.
15946     * @see elm_slider_end_get()
15947     *
15948     * @ingroup Slider
15949     */
15950    EAPI Evas_Object       *elm_slider_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15951
15952    /**
15953     * Retrieve the end object set for a given slider widget.
15954     *
15955     * @param obj The slider object.
15956     * @return The end object's handle, if @p obj had one set, or @c NULL,
15957     * otherwise (and on errors).
15958     *
15959     * On horizontal mode, icon is placed at right, and on vertical mode,
15960     * placed at bottom.
15961     *
15962     * @see elm_slider_end_set() for more details.
15963     * @see elm_slider_end_unset()
15964     *
15965     * @ingroup Slider
15966     */
15967    EAPI Evas_Object       *elm_slider_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15968
15969    /**
15970     * Set the (exact) length of the bar region of a given slider widget.
15971     *
15972     * @param obj The slider object.
15973     * @param size The length of the slider's bar region.
15974     *
15975     * This sets the minimum width (when in horizontal mode) or height
15976     * (when in vertical mode) of the actual bar area of the slider
15977     * @p obj. This in turn affects the object's minimum size. Use
15978     * this when you're not setting other size hints expanding on the
15979     * given direction (like weight and alignment hints) and you would
15980     * like it to have a specific size.
15981     *
15982     * @note Icon, end, label, indicator and unit text around @p obj
15983     * will require their
15984     * own space, which will make @p obj to require more the @p size,
15985     * actually.
15986     *
15987     * @see elm_slider_span_size_get()
15988     *
15989     * @ingroup Slider
15990     */
15991    EAPI void               elm_slider_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
15992
15993    /**
15994     * Get the length set for the bar region of a given slider widget
15995     *
15996     * @param obj The slider object.
15997     * @return The length of the slider's bar region.
15998     *
15999     * If that size was not set previously, with
16000     * elm_slider_span_size_set(), this call will return @c 0.
16001     *
16002     * @ingroup Slider
16003     */
16004    EAPI Evas_Coord         elm_slider_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16005
16006    /**
16007     * Set the format string for the unit label.
16008     *
16009     * @param obj The slider object.
16010     * @param format The format string for the unit display.
16011     *
16012     * Unit label is displayed all the time, if set, after slider's bar.
16013     * In horizontal mode, at right and in vertical mode, at bottom.
16014     *
16015     * If @c NULL, unit label won't be visible. If not it sets the format
16016     * string for the label text. To the label text is provided a floating point
16017     * value, so the label text can display up to 1 floating point value.
16018     * Note that this is optional.
16019     *
16020     * Use a format string such as "%1.2f meters" for example, and it will
16021     * display values like: "3.14 meters" for a value equal to 3.14159.
16022     *
16023     * Default is unit label disabled.
16024     *
16025     * @see elm_slider_indicator_format_get()
16026     *
16027     * @ingroup Slider
16028     */
16029    EAPI void               elm_slider_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
16030
16031    /**
16032     * Get the unit label format of the slider.
16033     *
16034     * @param obj The slider object.
16035     * @return The unit label format string in UTF-8.
16036     *
16037     * Unit label is displayed all the time, if set, after slider's bar.
16038     * In horizontal mode, at right and in vertical mode, at bottom.
16039     *
16040     * @see elm_slider_unit_format_set() for more
16041     * information on how this works.
16042     *
16043     * @ingroup Slider
16044     */
16045    EAPI const char        *elm_slider_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16046
16047    /**
16048     * Set the format string for the indicator label.
16049     *
16050     * @param obj The slider object.
16051     * @param indicator The format string for the indicator display.
16052     *
16053     * The slider may display its value somewhere else then unit label,
16054     * for example, above the slider knob that is dragged around. This function
16055     * sets the format string used for this.
16056     *
16057     * If @c NULL, indicator label won't be visible. If not it sets the format
16058     * string for the label text. To the label text is provided a floating point
16059     * value, so the label text can display up to 1 floating point value.
16060     * Note that this is optional.
16061     *
16062     * Use a format string such as "%1.2f meters" for example, and it will
16063     * display values like: "3.14 meters" for a value equal to 3.14159.
16064     *
16065     * Default is indicator label disabled.
16066     *
16067     * @see elm_slider_indicator_format_get()
16068     *
16069     * @ingroup Slider
16070     */
16071    EAPI void               elm_slider_indicator_format_set(Evas_Object *obj, const char *indicator) EINA_ARG_NONNULL(1);
16072
16073    /**
16074     * Get the indicator label format of the slider.
16075     *
16076     * @param obj The slider object.
16077     * @return The indicator label format string in UTF-8.
16078     *
16079     * The slider may display its value somewhere else then unit label,
16080     * for example, above the slider knob that is dragged around. This function
16081     * gets the format string used for this.
16082     *
16083     * @see elm_slider_indicator_format_set() for more
16084     * information on how this works.
16085     *
16086     * @ingroup Slider
16087     */
16088    EAPI const char        *elm_slider_indicator_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16089
16090    /**
16091     * Set the format function pointer for the indicator label
16092     *
16093     * @param obj The slider object.
16094     * @param func The indicator format function.
16095     * @param free_func The freeing function for the format string.
16096     *
16097     * Set the callback function to format the indicator string.
16098     *
16099     * @see elm_slider_indicator_format_set() for more info on how this works.
16100     *
16101     * @ingroup Slider
16102     */
16103   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);
16104
16105   /**
16106    * Set the format function pointer for the units label
16107    *
16108    * @param obj The slider object.
16109    * @param func The units format function.
16110    * @param free_func The freeing function for the format string.
16111    *
16112    * Set the callback function to format the indicator string.
16113    *
16114    * @see elm_slider_units_format_set() for more info on how this works.
16115    *
16116    * @ingroup Slider
16117    */
16118   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);
16119
16120   /**
16121    * Set the orientation of a given slider widget.
16122    *
16123    * @param obj The slider object.
16124    * @param horizontal Use @c EINA_TRUE to make @p obj to be
16125    * @b horizontal, @c EINA_FALSE to make it @b vertical.
16126    *
16127    * Use this function to change how your slider is to be
16128    * disposed: vertically or horizontally.
16129    *
16130    * By default it's displayed horizontally.
16131    *
16132    * @see elm_slider_horizontal_get()
16133    *
16134    * @ingroup Slider
16135    */
16136    EAPI void               elm_slider_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
16137
16138    /**
16139     * Retrieve the orientation of a given slider widget
16140     *
16141     * @param obj The slider object.
16142     * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
16143     * @c EINA_FALSE if it's @b vertical (and on errors).
16144     *
16145     * @see elm_slider_horizontal_set() for more details.
16146     *
16147     * @ingroup Slider
16148     */
16149    EAPI Eina_Bool          elm_slider_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16150
16151    /**
16152     * Set the minimum and maximum values for the slider.
16153     *
16154     * @param obj The slider object.
16155     * @param min The minimum value.
16156     * @param max The maximum value.
16157     *
16158     * Define the allowed range of values to be selected by the user.
16159     *
16160     * If actual value is less than @p min, it will be updated to @p min. If it
16161     * is bigger then @p max, will be updated to @p max. Actual value can be
16162     * get with elm_slider_value_get().
16163     *
16164     * By default, min is equal to 0.0, and max is equal to 1.0.
16165     *
16166     * @warning Maximum must be greater than minimum, otherwise behavior
16167     * is undefined.
16168     *
16169     * @see elm_slider_min_max_get()
16170     *
16171     * @ingroup Slider
16172     */
16173    EAPI void               elm_slider_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
16174
16175    /**
16176     * Get the minimum and maximum values of the slider.
16177     *
16178     * @param obj The slider object.
16179     * @param min Pointer where to store the minimum value.
16180     * @param max Pointer where to store the maximum value.
16181     *
16182     * @note If only one value is needed, the other pointer can be passed
16183     * as @c NULL.
16184     *
16185     * @see elm_slider_min_max_set() for details.
16186     *
16187     * @ingroup Slider
16188     */
16189    EAPI void               elm_slider_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
16190
16191    /**
16192     * Set the value the slider displays.
16193     *
16194     * @param obj The slider object.
16195     * @param val The value to be displayed.
16196     *
16197     * Value will be presented on the unit label following format specified with
16198     * elm_slider_unit_format_set() and on indicator with
16199     * elm_slider_indicator_format_set().
16200     *
16201     * @warning The value must to be between min and max values. This values
16202     * are set by elm_slider_min_max_set().
16203     *
16204     * @see elm_slider_value_get()
16205     * @see elm_slider_unit_format_set()
16206     * @see elm_slider_indicator_format_set()
16207     * @see elm_slider_min_max_set()
16208     *
16209     * @ingroup Slider
16210     */
16211    EAPI void               elm_slider_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
16212
16213    /**
16214     * Get the value displayed by the spinner.
16215     *
16216     * @param obj The spinner object.
16217     * @return The value displayed.
16218     *
16219     * @see elm_spinner_value_set() for details.
16220     *
16221     * @ingroup Slider
16222     */
16223    EAPI double             elm_slider_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16224
16225    /**
16226     * Invert a given slider widget's displaying values order
16227     *
16228     * @param obj The slider object.
16229     * @param inverted Use @c EINA_TRUE to make @p obj inverted,
16230     * @c EINA_FALSE to bring it back to default, non-inverted values.
16231     *
16232     * A slider may be @b inverted, in which state it gets its
16233     * values inverted, with high vales being on the left or top and
16234     * low values on the right or bottom, as opposed to normally have
16235     * the low values on the former and high values on the latter,
16236     * respectively, for horizontal and vertical modes.
16237     *
16238     * @see elm_slider_inverted_get()
16239     *
16240     * @ingroup Slider
16241     */
16242    EAPI void               elm_slider_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
16243
16244    /**
16245     * Get whether a given slider widget's displaying values are
16246     * inverted or not.
16247     *
16248     * @param obj The slider object.
16249     * @return @c EINA_TRUE, if @p obj has inverted values,
16250     * @c EINA_FALSE otherwise (and on errors).
16251     *
16252     * @see elm_slider_inverted_set() for more details.
16253     *
16254     * @ingroup Slider
16255     */
16256    EAPI Eina_Bool          elm_slider_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16257
16258    /**
16259     * Set whether to enlarge slider indicator (augmented knob) or not.
16260     *
16261     * @param obj The slider object.
16262     * @param show @c EINA_TRUE will make it enlarge, @c EINA_FALSE will
16263     * let the knob always at default size.
16264     *
16265     * By default, indicator will be bigger while dragged by the user.
16266     *
16267     * @warning It won't display values set with
16268     * elm_slider_indicator_format_set() if you disable indicator.
16269     *
16270     * @ingroup Slider
16271     */
16272    EAPI void               elm_slider_indicator_show_set(Evas_Object *obj, Eina_Bool show) EINA_ARG_NONNULL(1);
16273
16274    /**
16275     * Get whether a given slider widget's enlarging indicator or not.
16276     *
16277     * @param obj The slider object.
16278     * @return @c EINA_TRUE, if @p obj is enlarging indicator, or
16279     * @c EINA_FALSE otherwise (and on errors).
16280     *
16281     * @see elm_slider_indicator_show_set() for details.
16282     *
16283     * @ingroup Slider
16284     */
16285    EAPI Eina_Bool          elm_slider_indicator_show_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16286
16287    /**
16288     * @}
16289     */
16290
16291    /**
16292     * @addtogroup Actionslider Actionslider
16293     *
16294     * @image html img/widget/actionslider/preview-00.png
16295     * @image latex img/widget/actionslider/preview-00.eps
16296     *
16297     * A actionslider is a switcher for 2 or 3 labels with customizable magnet
16298     * properties. The indicator is the element the user drags to choose a label.
16299     * When the position is set with magnet, when released the indicator will be
16300     * moved to it if it's nearest the magnetized position.
16301     *
16302     * @note By default all positions are set as enabled.
16303     *
16304     * Signals that you can add callbacks for are:
16305     *
16306     * "selected" - when user selects an enabled position (the label is passed
16307     *              as event info)".
16308     * @n
16309     * "pos_changed" - when the indicator reaches any of the positions("left",
16310     *                 "right" or "center").
16311     *
16312     * See an example of actionslider usage @ref actionslider_example_page "here"
16313     * @{
16314     */
16315    typedef enum _Elm_Actionslider_Pos
16316      {
16317         ELM_ACTIONSLIDER_NONE = 0,
16318         ELM_ACTIONSLIDER_LEFT = 1 << 0,
16319         ELM_ACTIONSLIDER_CENTER = 1 << 1,
16320         ELM_ACTIONSLIDER_RIGHT = 1 << 2,
16321         ELM_ACTIONSLIDER_ALL = (1 << 3) -1
16322      } Elm_Actionslider_Pos;
16323
16324    /**
16325     * Add a new actionslider to the parent.
16326     *
16327     * @param parent The parent object
16328     * @return The new actionslider object or NULL if it cannot be created
16329     */
16330    EAPI Evas_Object          *elm_actionslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16331    /**
16332     * Set actionslider labels.
16333     *
16334     * @param obj The actionslider object
16335     * @param left_label The label to be set on the left.
16336     * @param center_label The label to be set on the center.
16337     * @param right_label The label to be set on the right.
16338     * @deprecated use elm_object_text_set() instead.
16339     */
16340    EINA_DEPRECATED EAPI void                  elm_actionslider_labels_set(Evas_Object *obj, const char *left_label, const char *center_label, const char *right_label) EINA_ARG_NONNULL(1);
16341    /**
16342     * Get actionslider labels.
16343     *
16344     * @param obj The actionslider object
16345     * @param left_label A char** to place the left_label of @p obj into.
16346     * @param center_label A char** to place the center_label of @p obj into.
16347     * @param right_label A char** to place the right_label of @p obj into.
16348     * @deprecated use elm_object_text_set() instead.
16349     */
16350    EINA_DEPRECATED EAPI void                  elm_actionslider_labels_get(const Evas_Object *obj, const char **left_label, const char **center_label, const char **right_label) EINA_ARG_NONNULL(1);
16351    /**
16352     * Get actionslider selected label.
16353     *
16354     * @param obj The actionslider object
16355     * @return The selected label
16356     */
16357    EAPI const char           *elm_actionslider_selected_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16358    /**
16359     * Set actionslider indicator position.
16360     *
16361     * @param obj The actionslider object.
16362     * @param pos The position of the indicator.
16363     */
16364    EAPI void                  elm_actionslider_indicator_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
16365    /**
16366     * Get actionslider indicator position.
16367     *
16368     * @param obj The actionslider object.
16369     * @return The position of the indicator.
16370     */
16371    EAPI Elm_Actionslider_Pos  elm_actionslider_indicator_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16372    /**
16373     * Set actionslider magnet position. To make multiple positions magnets @c or
16374     * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT)
16375     *
16376     * @param obj The actionslider object.
16377     * @param pos Bit mask indicating the magnet positions.
16378     */
16379    EAPI void                  elm_actionslider_magnet_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
16380    /**
16381     * Get actionslider magnet position.
16382     *
16383     * @param obj The actionslider object.
16384     * @return The positions with magnet property.
16385     */
16386    EAPI Elm_Actionslider_Pos  elm_actionslider_magnet_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16387    /**
16388     * Set actionslider enabled position. To set multiple positions as enabled @c or
16389     * them together(e.g.: ELM_ACTIONSLIDER_LEFT | ELM_ACTIONSLIDER_RIGHT).
16390     *
16391     * @note All the positions are enabled by default.
16392     *
16393     * @param obj The actionslider object.
16394     * @param pos Bit mask indicating the enabled positions.
16395     */
16396    EAPI void                  elm_actionslider_enabled_pos_set(Evas_Object *obj, Elm_Actionslider_Pos pos) EINA_ARG_NONNULL(1);
16397    /**
16398     * Get actionslider enabled position.
16399     *
16400     * @param obj The actionslider object.
16401     * @return The enabled positions.
16402     */
16403    EAPI Elm_Actionslider_Pos  elm_actionslider_enabled_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16404    /**
16405     * Set the label used on the indicator.
16406     *
16407     * @param obj The actionslider object
16408     * @param label The label to be set on the indicator.
16409     * @deprecated use elm_object_text_set() instead.
16410     */
16411    EINA_DEPRECATED EAPI void                  elm_actionslider_indicator_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
16412    /**
16413     * Get the label used on the indicator object.
16414     *
16415     * @param obj The actionslider object
16416     * @return The indicator label
16417     * @deprecated use elm_object_text_get() instead.
16418     */
16419    EINA_DEPRECATED EAPI const char           *elm_actionslider_indicator_label_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
16420    /**
16421     * @}
16422     */
16423
16424    /**
16425     * @defgroup Genlist Genlist
16426     *
16427     * @image html img/widget/genlist/preview-00.png
16428     * @image latex img/widget/genlist/preview-00.eps
16429     * @image html img/genlist.png
16430     * @image latex img/genlist.eps
16431     *
16432     * This widget aims to have more expansive list than the simple list in
16433     * Elementary that could have more flexible items and allow many more entries
16434     * while still being fast and low on memory usage. At the same time it was
16435     * also made to be able to do tree structures. But the price to pay is more
16436     * complexity when it comes to usage. If all you want is a simple list with
16437     * icons and a single label, use the normal @ref List object.
16438     *
16439     * Genlist has a fairly large API, mostly because it's relatively complex,
16440     * trying to be both expansive, powerful and efficient. First we will begin
16441     * an overview on the theory behind genlist.
16442     *
16443     * @section Genlist_Item_Class Genlist item classes - creating items
16444     *
16445     * In order to have the ability to add and delete items on the fly, genlist
16446     * implements a class (callback) system where the application provides a
16447     * structure with information about that type of item (genlist may contain
16448     * multiple different items with different classes, states and styles).
16449     * Genlist will call the functions in this struct (methods) when an item is
16450     * "realized" (i.e., created dynamically, while the user is scrolling the
16451     * grid). All objects will simply be deleted when no longer needed with
16452     * evas_object_del(). The #Elm_Genlist_Item_Class structure contains the
16453     * following members:
16454     * - @c item_style - This is a constant string and simply defines the name
16455     *   of the item style. It @b must be specified and the default should be @c
16456     *   "default".
16457     * - @c mode_item_style - This is a constant string and simply defines the
16458     *   name of the style that will be used for mode animations. It can be left
16459     *   as @c NULL if you don't plan to use Genlist mode. See
16460     *   elm_genlist_item_mode_set() for more info.
16461     *
16462     * - @c func - A struct with pointers to functions that will be called when
16463     *   an item is going to be actually created. All of them receive a @c data
16464     *   parameter that will point to the same data passed to
16465     *   elm_genlist_item_append() and related item creation functions, and a @c
16466     *   obj parameter that points to the genlist object itself.
16467     *
16468     * The function pointers inside @c func are @c label_get, @c icon_get, @c
16469     * state_get and @c del. The 3 first functions also receive a @c part
16470     * parameter described below. A brief description of these functions follows:
16471     *
16472     * - @c label_get - The @c part parameter is the name string of one of the
16473     *   existing text parts in the Edje group implementing the item's theme.
16474     *   This function @b must return a strdup'()ed string, as the caller will
16475     *   free() it when done. See #Elm_Genlist_Item_Label_Get_Cb.
16476     * - @c icon_get - The @c part parameter is the name string of one of the
16477     *   existing (icon) swallow parts in the Edje group implementing the item's
16478     *   theme. It must return @c NULL, when no icon is desired, or a valid
16479     *   object handle, otherwise.  The object will be deleted by the genlist on
16480     *   its deletion or when the item is "unrealized".  See
16481     *   #Elm_Genlist_Item_Icon_Get_Cb.
16482     * - @c func.state_get - The @c part parameter is the name string of one of
16483     *   the state parts in the Edje group implementing the item's theme. Return
16484     *   @c EINA_FALSE for false/off or @c EINA_TRUE for true/on. Genlists will
16485     *   emit a signal to its theming Edje object with @c "elm,state,XXX,active"
16486     *   and @c "elm" as "emission" and "source" arguments, respectively, when
16487     *   the state is true (the default is false), where @c XXX is the name of
16488     *   the (state) part.  See #Elm_Genlist_Item_State_Get_Cb.
16489     * - @c func.del - This is intended for use when genlist items are deleted,
16490     *   so any data attached to the item (e.g. its data parameter on creation)
16491     *   can be deleted. See #Elm_Genlist_Item_Del_Cb.
16492     *
16493     * available item styles:
16494     * - default
16495     * - default_style - The text part is a textblock
16496     *
16497     * @image html img/widget/genlist/preview-04.png
16498     * @image latex img/widget/genlist/preview-04.eps
16499     *
16500     * - double_label
16501     *
16502     * @image html img/widget/genlist/preview-01.png
16503     * @image latex img/widget/genlist/preview-01.eps
16504     *
16505     * - icon_top_text_bottom
16506     *
16507     * @image html img/widget/genlist/preview-02.png
16508     * @image latex img/widget/genlist/preview-02.eps
16509     *
16510     * - group_index
16511     *
16512     * @image html img/widget/genlist/preview-03.png
16513     * @image latex img/widget/genlist/preview-03.eps
16514     *
16515     * @section Genlist_Items Structure of items
16516     *
16517     * An item in a genlist can have 0 or more text labels (they can be regular
16518     * text or textblock Evas objects - that's up to the style to determine), 0
16519     * or more icons (which are simply objects swallowed into the genlist item's
16520     * theming Edje object) and 0 or more <b>boolean states</b>, which have the
16521     * behavior left to the user to define. The Edje part names for each of
16522     * these properties will be looked up, in the theme file for the genlist,
16523     * under the Edje (string) data items named @c "labels", @c "icons" and @c
16524     * "states", respectively. For each of those properties, if more than one
16525     * part is provided, they must have names listed separated by spaces in the
16526     * data fields. For the default genlist item theme, we have @b one label
16527     * part (@c "elm.text"), @b two icon parts (@c "elm.swalllow.icon" and @c
16528     * "elm.swallow.end") and @b no state parts.
16529     *
16530     * A genlist item may be at one of several styles. Elementary provides one
16531     * by default - "default", but this can be extended by system or application
16532     * custom themes/overlays/extensions (see @ref Theme "themes" for more
16533     * details).
16534     *
16535     * @section Genlist_Manipulation Editing and Navigating
16536     *
16537     * Items can be added by several calls. All of them return a @ref
16538     * Elm_Genlist_Item handle that is an internal member inside the genlist.
16539     * They all take a data parameter that is meant to be used for a handle to
16540     * the applications internal data (eg the struct with the original item
16541     * data). The parent parameter is the parent genlist item this belongs to if
16542     * it is a tree or an indexed group, and NULL if there is no parent. The
16543     * flags can be a bitmask of #ELM_GENLIST_ITEM_NONE,
16544     * #ELM_GENLIST_ITEM_SUBITEMS and #ELM_GENLIST_ITEM_GROUP. If
16545     * #ELM_GENLIST_ITEM_SUBITEMS is set then this item is displayed as an item
16546     * that is able to expand and have child items.  If ELM_GENLIST_ITEM_GROUP
16547     * is set then this item is group index item that is displayed at the top
16548     * until the next group comes. The func parameter is a convenience callback
16549     * that is called when the item is selected and the data parameter will be
16550     * the func_data parameter, obj be the genlist object and event_info will be
16551     * the genlist item.
16552     *
16553     * elm_genlist_item_append() adds an item to the end of the list, or if
16554     * there is a parent, to the end of all the child items of the parent.
16555     * elm_genlist_item_prepend() is the same but adds to the beginning of
16556     * the list or children list. elm_genlist_item_insert_before() inserts at
16557     * item before another item and elm_genlist_item_insert_after() inserts after
16558     * the indicated item.
16559     *
16560     * The application can clear the list with elm_genlist_clear() which deletes
16561     * all the items in the list and elm_genlist_item_del() will delete a specific
16562     * item. elm_genlist_item_subitems_clear() will clear all items that are
16563     * children of the indicated parent item.
16564     *
16565     * To help inspect list items you can jump to the item at the top of the list
16566     * with elm_genlist_first_item_get() which will return the item pointer, and
16567     * similarly elm_genlist_last_item_get() gets the item at the end of the list.
16568     * elm_genlist_item_next_get() and elm_genlist_item_prev_get() get the next
16569     * and previous items respectively relative to the indicated item. Using
16570     * these calls you can walk the entire item list/tree. Note that as a tree
16571     * the items are flattened in the list, so elm_genlist_item_parent_get() will
16572     * let you know which item is the parent (and thus know how to skip them if
16573     * wanted).
16574     *
16575     * @section Genlist_Muti_Selection Multi-selection
16576     *
16577     * If the application wants multiple items to be able to be selected,
16578     * elm_genlist_multi_select_set() can enable this. If the list is
16579     * single-selection only (the default), then elm_genlist_selected_item_get()
16580     * will return the selected item, if any, or NULL I none is selected. If the
16581     * list is multi-select then elm_genlist_selected_items_get() will return a
16582     * list (that is only valid as long as no items are modified (added, deleted,
16583     * selected or unselected)).
16584     *
16585     * @section Genlist_Usage_Hints Usage hints
16586     *
16587     * There are also convenience functions. elm_genlist_item_genlist_get() will
16588     * return the genlist object the item belongs to. elm_genlist_item_show()
16589     * will make the scroller scroll to show that specific item so its visible.
16590     * elm_genlist_item_data_get() returns the data pointer set by the item
16591     * creation functions.
16592     *
16593     * If an item changes (state of boolean changes, label or icons change),
16594     * then use elm_genlist_item_update() to have genlist update the item with
16595     * the new state. Genlist will re-realize the item thus call the functions
16596     * in the _Elm_Genlist_Item_Class for that item.
16597     *
16598     * To programmatically (un)select an item use elm_genlist_item_selected_set().
16599     * To get its selected state use elm_genlist_item_selected_get(). Similarly
16600     * to expand/contract an item and get its expanded state, use
16601     * elm_genlist_item_expanded_set() and elm_genlist_item_expanded_get(). And
16602     * again to make an item disabled (unable to be selected and appear
16603     * differently) use elm_genlist_item_disabled_set() to set this and
16604     * elm_genlist_item_disabled_get() to get the disabled state.
16605     *
16606     * In general to indicate how the genlist should expand items horizontally to
16607     * fill the list area, use elm_genlist_horizontal_set(). Valid modes are
16608     * ELM_LIST_LIMIT and ELM_LIST_SCROLL . The default is ELM_LIST_SCROLL. This
16609     * mode means that if items are too wide to fit, the scroller will scroll
16610     * horizontally. Otherwise items are expanded to fill the width of the
16611     * viewport of the scroller. If it is ELM_LIST_LIMIT, items will be expanded
16612     * to the viewport width and limited to that size. This can be combined with
16613     * a different style that uses edjes' ellipsis feature (cutting text off like
16614     * this: "tex...").
16615     *
16616     * Items will only call their selection func and callback when first becoming
16617     * selected. Any further clicks will do nothing, unless you enable always
16618     * select with elm_genlist_always_select_mode_set(). This means even if
16619     * selected, every click will make the selected callbacks be called.
16620     * elm_genlist_no_select_mode_set() will turn off the ability to select
16621     * items entirely and they will neither appear selected nor call selected
16622     * callback functions.
16623     *
16624     * Remember that you can create new styles and add your own theme augmentation
16625     * per application with elm_theme_extension_add(). If you absolutely must
16626     * have a specific style that overrides any theme the user or system sets up
16627     * you can use elm_theme_overlay_add() to add such a file.
16628     *
16629     * @section Genlist_Implementation Implementation
16630     *
16631     * Evas tracks every object you create. Every time it processes an event
16632     * (mouse move, down, up etc.) it needs to walk through objects and find out
16633     * what event that affects. Even worse every time it renders display updates,
16634     * in order to just calculate what to re-draw, it needs to walk through many
16635     * many many objects. Thus, the more objects you keep active, the more
16636     * overhead Evas has in just doing its work. It is advisable to keep your
16637     * active objects to the minimum working set you need. Also remember that
16638     * object creation and deletion carries an overhead, so there is a
16639     * middle-ground, which is not easily determined. But don't keep massive lists
16640     * of objects you can't see or use. Genlist does this with list objects. It
16641     * creates and destroys them dynamically as you scroll around. It groups them
16642     * into blocks so it can determine the visibility etc. of a whole block at
16643     * once as opposed to having to walk the whole list. This 2-level list allows
16644     * for very large numbers of items to be in the list (tests have used up to
16645     * 2,000,000 items). Also genlist employs a queue for adding items. As items
16646     * may be different sizes, every item added needs to be calculated as to its
16647     * size and thus this presents a lot of overhead on populating the list, this
16648     * genlist employs a queue. Any item added is queued and spooled off over
16649     * time, actually appearing some time later, so if your list has many members
16650     * you may find it takes a while for them to all appear, with your process
16651     * consuming a lot of CPU while it is busy spooling.
16652     *
16653     * Genlist also implements a tree structure, but it does so with callbacks to
16654     * the application, with the application filling in tree structures when
16655     * requested (allowing for efficient building of a very deep tree that could
16656     * even be used for file-management). See the above smart signal callbacks for
16657     * details.
16658     *
16659     * @section Genlist_Smart_Events Genlist smart events
16660     *
16661     * Signals that you can add callbacks for are:
16662     * - @c "activated" - The user has double-clicked or pressed
16663     *   (enter|return|spacebar) on an item. The @c event_info parameter is the
16664     *   item that was activated.
16665     * - @c "clicked,double" - The user has double-clicked an item.  The @c
16666     *   event_info parameter is the item that was double-clicked.
16667     * - @c "selected" - This is called when a user has made an item selected.
16668     *   The event_info parameter is the genlist item that was selected.
16669     * - @c "unselected" - This is called when a user has made an item
16670     *   unselected. The event_info parameter is the genlist item that was
16671     *   unselected.
16672     * - @c "expanded" - This is called when elm_genlist_item_expanded_set() is
16673     *   called and the item is now meant to be expanded. The event_info
16674     *   parameter is the genlist item that was indicated to expand.  It is the
16675     *   job of this callback to then fill in the child items.
16676     * - @c "contracted" - This is called when elm_genlist_item_expanded_set() is
16677     *   called and the item is now meant to be contracted. The event_info
16678     *   parameter is the genlist item that was indicated to contract. It is the
16679     *   job of this callback to then delete the child items.
16680     * - @c "expand,request" - This is called when a user has indicated they want
16681     *   to expand a tree branch item. The callback should decide if the item can
16682     *   expand (has any children) and then call elm_genlist_item_expanded_set()
16683     *   appropriately to set the state. The event_info parameter is the genlist
16684     *   item that was indicated to expand.
16685     * - @c "contract,request" - This is called when a user has indicated they
16686     *   want to contract a tree branch item. The callback should decide if the
16687     *   item can contract (has any children) and then call
16688     *   elm_genlist_item_expanded_set() appropriately to set the state. The
16689     *   event_info parameter is the genlist item that was indicated to contract.
16690     * - @c "realized" - This is called when the item in the list is created as a
16691     *   real evas object. event_info parameter is the genlist item that was
16692     *   created. The object may be deleted at any time, so it is up to the
16693     *   caller to not use the object pointer from elm_genlist_item_object_get()
16694     *   in a way where it may point to freed objects.
16695     * - @c "unrealized" - This is called just before an item is unrealized.
16696     *   After this call icon objects provided will be deleted and the item
16697     *   object itself delete or be put into a floating cache.
16698     * - @c "drag,start,up" - This is called when the item in the list has been
16699     *   dragged (not scrolled) up.
16700     * - @c "drag,start,down" - This is called when the item in the list has been
16701     *   dragged (not scrolled) down.
16702     * - @c "drag,start,left" - This is called when the item in the list has been
16703     *   dragged (not scrolled) left.
16704     * - @c "drag,start,right" - This is called when the item in the list has
16705     *   been dragged (not scrolled) right.
16706     * - @c "drag,stop" - This is called when the item in the list has stopped
16707     *   being dragged.
16708     * - @c "drag" - This is called when the item in the list is being dragged.
16709     * - @c "longpressed" - This is called when the item is pressed for a certain
16710     *   amount of time. By default it's 1 second.
16711     * - @c "scroll,anim,start" - This is called when scrolling animation has
16712     *   started.
16713     * - @c "scroll,anim,stop" - This is called when scrolling animation has
16714     *   stopped.
16715     * - @c "scroll,drag,start" - This is called when dragging the content has
16716     *   started.
16717     * - @c "scroll,drag,stop" - This is called when dragging the content has
16718     *   stopped.
16719     * - @c "scroll,edge,top" - This is called when the genlist is scrolled until
16720     *   the top edge.
16721     * - @c "scroll,edge,bottom" - This is called when the genlist is scrolled
16722     *   until the bottom edge.
16723     * - @c "scroll,edge,left" - This is called when the genlist is scrolled
16724     *   until the left edge.
16725     * - @c "scroll,edge,right" - This is called when the genlist is scrolled
16726     *   until the right edge.
16727     * - @c "multi,swipe,left" - This is called when the genlist is multi-touch
16728     *   swiped left.
16729     * - @c "multi,swipe,right" - This is called when the genlist is multi-touch
16730     *   swiped right.
16731     * - @c "multi,swipe,up" - This is called when the genlist is multi-touch
16732     *   swiped up.
16733     * - @c "multi,swipe,down" - This is called when the genlist is multi-touch
16734     *   swiped down.
16735     * - @c "multi,pinch,out" - This is called when the genlist is multi-touch
16736     *   pinched out.  "- @c multi,pinch,in" - This is called when the genlist is
16737     *   multi-touch pinched in.
16738     * - @c "swipe" - This is called when the genlist is swiped.
16739     *
16740     * @section Genlist_Examples Examples
16741     *
16742     * Here is a list of examples that use the genlist, trying to show some of
16743     * its capabilities:
16744     * - @ref genlist_example_01
16745     * - @ref genlist_example_02
16746     * - @ref genlist_example_03
16747     * - @ref genlist_example_04
16748     * - @ref genlist_example_05
16749     */
16750
16751    /**
16752     * @addtogroup Genlist
16753     * @{
16754     */
16755
16756    /**
16757     * @enum _Elm_Genlist_Item_Flags
16758     * @typedef Elm_Genlist_Item_Flags
16759     *
16760     * Defines if the item is of any special type (has subitems or it's the
16761     * index of a group), or is just a simple item.
16762     *
16763     * @ingroup Genlist
16764     */
16765    typedef enum _Elm_Genlist_Item_Flags
16766      {
16767         ELM_GENLIST_ITEM_NONE = 0, /**< simple item */
16768         ELM_GENLIST_ITEM_SUBITEMS = (1 << 0), /**< may expand and have child items */
16769         ELM_GENLIST_ITEM_GROUP = (1 << 1) /**< index of a group of items */
16770      } Elm_Genlist_Item_Flags;
16771    typedef struct _Elm_Genlist_Item_Class Elm_Genlist_Item_Class;  /**< Genlist item class definition structs */
16772    typedef struct _Elm_Genlist_Item       Elm_Genlist_Item; /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
16773    typedef struct _Elm_Genlist_Item_Class_Func Elm_Genlist_Item_Class_Func; /**< Class functions for genlist item class */
16774    typedef char        *(*Elm_Genlist_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< Label fetching class function for genlist item classes. */
16775    typedef Evas_Object *(*Elm_Genlist_Item_Icon_Get_Cb)  (void *data, Evas_Object *obj, const char *part); /**< Icon fetching class function for genlist item classes. */
16776    typedef Eina_Bool    (*Elm_Genlist_Item_State_Get_Cb) (void *data, Evas_Object *obj, const char *part); /**< State fetching class function for genlist item classes. */
16777    typedef void         (*Elm_Genlist_Item_Del_Cb)      (void *data, Evas_Object *obj); /**< Deletion class function for genlist item classes. */
16778    typedef void         (*GenlistItemMovedFunc)    (Evas_Object *obj, Elm_Genlist_Item *item, Elm_Genlist_Item *rel_item, Eina_Bool move_after); /** TODO: remove this by SeoZ **/
16779
16780    typedef char        *(*GenlistItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Genlist_Item_Label_Get_Cb instead. */
16781    typedef Evas_Object *(*GenlistItemIconGetFunc)  (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Genlist_Item_Icon_Get_Cb instead. */
16782    typedef Eina_Bool    (*GenlistItemStateGetFunc) (void *data, Evas_Object *obj, const char *part) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Genlist_Item_State_Get_Cb instead. */
16783    typedef void         (*GenlistItemDelFunc)      (void *data, Evas_Object *obj) EINA_DEPRECATED; /** DEPRECATED. Use Elm_Genlist_Item_Del_Cb instead. */
16784
16785    /**
16786     * @struct _Elm_Genlist_Item_Class
16787     *
16788     * Genlist item class definition structs.
16789     *
16790     * This struct contains the style and fetching functions that will define the
16791     * contents of each item.
16792     *
16793     * @see @ref Genlist_Item_Class
16794     */
16795    struct _Elm_Genlist_Item_Class
16796      {
16797         const char                *item_style; /**< style of this class. */
16798         struct
16799           {
16800              Elm_Genlist_Item_Label_Get_Cb  label_get; /**< Label fetching class function for genlist item classes.*/
16801              Elm_Genlist_Item_Icon_Get_Cb   icon_get; /**< Icon fetching class function for genlist item classes. */
16802              Elm_Genlist_Item_State_Get_Cb  state_get; /**< State fetching class function for genlist item classes. */
16803              Elm_Genlist_Item_Del_Cb        del; /**< Deletion class function for genlist item classes. */
16804              GenlistItemMovedFunc     moved; // TODO: do not use this. change this to smart callback.
16805           } func;
16806         const char                *mode_item_style;
16807      };
16808
16809    /**
16810     * Add a new genlist widget to the given parent Elementary
16811     * (container) object
16812     *
16813     * @param parent The parent object
16814     * @return a new genlist widget handle or @c NULL, on errors
16815     *
16816     * This function inserts a new genlist widget on the canvas.
16817     *
16818     * @see elm_genlist_item_append()
16819     * @see elm_genlist_item_del()
16820     * @see elm_genlist_clear()
16821     *
16822     * @ingroup Genlist
16823     */
16824    EAPI Evas_Object      *elm_genlist_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16825    /**
16826     * Remove all items from a given genlist widget.
16827     *
16828     * @param obj The genlist object
16829     *
16830     * This removes (and deletes) all items in @p obj, leaving it empty.
16831     *
16832     * @see elm_genlist_item_del(), to remove just one item.
16833     *
16834     * @ingroup Genlist
16835     */
16836    EAPI void              elm_genlist_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
16837    /**
16838     * Enable or disable multi-selection in the genlist
16839     *
16840     * @param obj The genlist object
16841     * @param multi Multi-select enable/disable. Default is disabled.
16842     *
16843     * This enables (@c EINA_TRUE) or disables (@c EINA_FALSE) multi-selection in
16844     * the list. This allows more than 1 item to be selected. To retrieve the list
16845     * of selected items, use elm_genlist_selected_items_get().
16846     *
16847     * @see elm_genlist_selected_items_get()
16848     * @see elm_genlist_multi_select_get()
16849     *
16850     * @ingroup Genlist
16851     */
16852    EAPI void              elm_genlist_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
16853    /**
16854     * Gets if multi-selection in genlist is enabled or disabled.
16855     *
16856     * @param obj The genlist object
16857     * @return Multi-select enabled/disabled
16858     * (@c EINA_TRUE = enabled/@c EINA_FALSE = disabled). Default is @c EINA_FALSE.
16859     *
16860     * @see elm_genlist_multi_select_set()
16861     *
16862     * @ingroup Genlist
16863     */
16864    EAPI Eina_Bool         elm_genlist_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16865    /**
16866     * This sets the horizontal stretching mode.
16867     *
16868     * @param obj The genlist object
16869     * @param mode The mode to use (one of #ELM_LIST_SCROLL or #ELM_LIST_LIMIT).
16870     *
16871     * This sets the mode used for sizing items horizontally. Valid modes
16872     * are #ELM_LIST_LIMIT and #ELM_LIST_SCROLL. The default is
16873     * ELM_LIST_SCROLL. This mode means that if items are too wide to fit,
16874     * the scroller will scroll horizontally. Otherwise items are expanded
16875     * to fill the width of the viewport of the scroller. If it is
16876     * ELM_LIST_LIMIT, items will be expanded to the viewport width and
16877     * limited to that size.
16878     *
16879     * @see elm_genlist_horizontal_get()
16880     *
16881     * @ingroup Genlist
16882     */
16883    EAPI void              elm_genlist_horizontal_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
16884    EINA_DEPRECATED EAPI void              elm_genlist_horizontal_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
16885    /**
16886     * Gets the horizontal stretching mode.
16887     *
16888     * @param obj The genlist object
16889     * @return The mode to use
16890     * (#ELM_LIST_LIMIT, #ELM_LIST_SCROLL)
16891     *
16892     * @see elm_genlist_horizontal_set()
16893     *
16894     * @ingroup Genlist
16895     */
16896    EAPI Elm_List_Mode     elm_genlist_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16897    EINA_DEPRECATED EAPI Elm_List_Mode     elm_genlist_horizontal_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16898    /**
16899     * Set the always select mode.
16900     *
16901     * @param obj The genlist object
16902     * @param always_select The always select mode (@c EINA_TRUE = on, @c
16903     * EINA_FALSE = off). Default is @c EINA_FALSE.
16904     *
16905     * Items will only call their selection func and callback when first
16906     * becoming selected. Any further clicks will do nothing, unless you
16907     * enable always select with elm_genlist_always_select_mode_set().
16908     * This means that, even if selected, every click will make the selected
16909     * callbacks be called.
16910     *
16911     * @see elm_genlist_always_select_mode_get()
16912     *
16913     * @ingroup Genlist
16914     */
16915    EAPI void              elm_genlist_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
16916    /**
16917     * Get the always select mode.
16918     *
16919     * @param obj The genlist object
16920     * @return The always select mode
16921     * (@c EINA_TRUE = on, @c EINA_FALSE = off)
16922     *
16923     * @see elm_genlist_always_select_mode_set()
16924     *
16925     * @ingroup Genlist
16926     */
16927    EAPI Eina_Bool         elm_genlist_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16928    /**
16929     * Enable/disable the no select mode.
16930     *
16931     * @param obj The genlist object
16932     * @param no_select The no select mode
16933     * (EINA_TRUE = on, EINA_FALSE = off)
16934     *
16935     * This will turn off the ability to select items entirely and they
16936     * will neither appear selected nor call selected callback functions.
16937     *
16938     * @see elm_genlist_no_select_mode_get()
16939     *
16940     * @ingroup Genlist
16941     */
16942    EAPI void              elm_genlist_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
16943    /**
16944     * Gets whether the no select mode is enabled.
16945     *
16946     * @param obj The genlist object
16947     * @return The no select mode
16948     * (@c EINA_TRUE = on, @c EINA_FALSE = off)
16949     *
16950     * @see elm_genlist_no_select_mode_set()
16951     *
16952     * @ingroup Genlist
16953     */
16954    EAPI Eina_Bool         elm_genlist_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16955    /**
16956     * Enable/disable compress mode.
16957     *
16958     * @param obj The genlist object
16959     * @param compress The compress mode
16960     * (@c EINA_TRUE = on, @c EINA_FALSE = off). Default is @c EINA_FALSE.
16961     *
16962     * This will enable the compress mode where items are "compressed"
16963     * horizontally to fit the genlist scrollable viewport width. This is
16964     * special for genlist.  Do not rely on
16965     * elm_genlist_horizontal_set() being set to @c ELM_LIST_COMPRESS to
16966     * work as genlist needs to handle it specially.
16967     *
16968     * @see elm_genlist_compress_mode_get()
16969     *
16970     * @ingroup Genlist
16971     */
16972    EAPI void              elm_genlist_compress_mode_set(Evas_Object *obj, Eina_Bool compress) EINA_ARG_NONNULL(1);
16973    /**
16974     * Get whether the compress mode is enabled.
16975     *
16976     * @param obj The genlist object
16977     * @return The compress mode
16978     * (@c EINA_TRUE = on, @c EINA_FALSE = off)
16979     *
16980     * @see elm_genlist_compress_mode_set()
16981     *
16982     * @ingroup Genlist
16983     */
16984    EAPI Eina_Bool         elm_genlist_compress_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16985    /**
16986     * Enable/disable height-for-width mode.
16987     *
16988     * @param obj The genlist object
16989     * @param setting The height-for-width mode (@c EINA_TRUE = on,
16990     * @c EINA_FALSE = off). Default is @c EINA_FALSE.
16991     *
16992     * With height-for-width mode the item width will be fixed (restricted
16993     * to a minimum of) to the list width when calculating its size in
16994     * order to allow the height to be calculated based on it. This allows,
16995     * for instance, text block to wrap lines if the Edje part is
16996     * configured with "text.min: 0 1".
16997     *
16998     * @note This mode will make list resize slower as it will have to
16999     *       recalculate every item height again whenever the list width
17000     *       changes!
17001     *
17002     * @note When height-for-width mode is enabled, it also enables
17003     *       compress mode (see elm_genlist_compress_mode_set()) and
17004     *       disables homogeneous (see elm_genlist_homogeneous_set()).
17005     *
17006     * @ingroup Genlist
17007     */
17008    EAPI void              elm_genlist_height_for_width_mode_set(Evas_Object *obj, Eina_Bool height_for_width) EINA_ARG_NONNULL(1);
17009    /**
17010     * Get whether the height-for-width mode is enabled.
17011     *
17012     * @param obj The genlist object
17013     * @return The height-for-width mode (@c EINA_TRUE = on, @c EINA_FALSE =
17014     * off)
17015     *
17016     * @ingroup Genlist
17017     */
17018    EAPI Eina_Bool         elm_genlist_height_for_width_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17019    /**
17020     * Enable/disable horizontal and vertical bouncing effect.
17021     *
17022     * @param obj The genlist object
17023     * @param h_bounce Allow bounce horizontally (@c EINA_TRUE = on, @c
17024     * EINA_FALSE = off). Default is @c EINA_FALSE.
17025     * @param v_bounce Allow bounce vertically (@c EINA_TRUE = on, @c
17026     * EINA_FALSE = off). Default is @c EINA_TRUE.
17027     *
17028     * This will enable or disable the scroller bouncing effect for the
17029     * genlist. See elm_scroller_bounce_set() for details.
17030     *
17031     * @see elm_scroller_bounce_set()
17032     * @see elm_genlist_bounce_get()
17033     *
17034     * @ingroup Genlist
17035     */
17036    EAPI void              elm_genlist_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
17037    /**
17038     * Get whether the horizontal and vertical bouncing effect is enabled.
17039     *
17040     * @param obj The genlist object
17041     * @param h_bounce Pointer to a bool to receive if the bounce horizontally
17042     * option is set.
17043     * @param v_bounce Pointer to a bool to receive if the bounce vertically
17044     * option is set.
17045     *
17046     * @see elm_genlist_bounce_set()
17047     *
17048     * @ingroup Genlist
17049     */
17050    EAPI void              elm_genlist_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
17051    /**
17052     * Enable/disable homogenous mode.
17053     *
17054     * @param obj The genlist object
17055     * @param homogeneous Assume the items within the genlist are of the
17056     * same height and width (EINA_TRUE = on, EINA_FALSE = off). Default is @c
17057     * EINA_FALSE.
17058     *
17059     * This will enable the homogeneous mode where items are of the same
17060     * height and width so that genlist may do the lazy-loading at its
17061     * maximum (which increases the performance for scrolling the list). This
17062     * implies 'compressed' mode.
17063     *
17064     * @see elm_genlist_compress_mode_set()
17065     * @see elm_genlist_homogeneous_get()
17066     *
17067     * @ingroup Genlist
17068     */
17069    EAPI void              elm_genlist_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
17070    /**
17071     * Get whether the homogenous mode is enabled.
17072     *
17073     * @param obj The genlist object
17074     * @return Assume the items within the genlist are of the same height
17075     * and width (EINA_TRUE = on, EINA_FALSE = off)
17076     *
17077     * @see elm_genlist_homogeneous_set()
17078     *
17079     * @ingroup Genlist
17080     */
17081    EAPI Eina_Bool         elm_genlist_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17082    /**
17083     * Set the maximum number of items within an item block
17084     *
17085     * @param obj The genlist object
17086     * @param n   Maximum number of items within an item block. Default is 32.
17087     *
17088     * This will configure the block count to tune to the target with
17089     * particular performance matrix.
17090     *
17091     * A block of objects will be used to reduce the number of operations due to
17092     * many objects in the screen. It can determine the visibility, or if the
17093     * object has changed, it theme needs to be updated, etc. doing this kind of
17094     * calculation to the entire block, instead of per object.
17095     *
17096     * The default value for the block count is enough for most lists, so unless
17097     * you know you will have a lot of objects visible in the screen at the same
17098     * time, don't try to change this.
17099     *
17100     * @see elm_genlist_block_count_get()
17101     * @see @ref Genlist_Implementation
17102     *
17103     * @ingroup Genlist
17104     */
17105    EAPI void              elm_genlist_block_count_set(Evas_Object *obj, int n) EINA_ARG_NONNULL(1);
17106    /**
17107     * Get the maximum number of items within an item block
17108     *
17109     * @param obj The genlist object
17110     * @return Maximum number of items within an item block
17111     *
17112     * @see elm_genlist_block_count_set()
17113     *
17114     * @ingroup Genlist
17115     */
17116    EAPI int               elm_genlist_block_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17117    /**
17118     * Set the timeout in seconds for the longpress event.
17119     *
17120     * @param obj The genlist object
17121     * @param timeout timeout in seconds. Default is 1.
17122     *
17123     * This option will change how long it takes to send an event "longpressed"
17124     * after the mouse down signal is sent to the list. If this event occurs, no
17125     * "clicked" event will be sent.
17126     *
17127     * @see elm_genlist_longpress_timeout_set()
17128     *
17129     * @ingroup Genlist
17130     */
17131    EAPI void              elm_genlist_longpress_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
17132    /**
17133     * Get the timeout in seconds for the longpress event.
17134     *
17135     * @param obj The genlist object
17136     * @return timeout in seconds
17137     *
17138     * @see elm_genlist_longpress_timeout_get()
17139     *
17140     * @ingroup Genlist
17141     */
17142    EAPI double            elm_genlist_longpress_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17143    /**
17144     * Append a new item in a given genlist widget.
17145     *
17146     * @param obj The genlist object
17147     * @param itc The item class for the item
17148     * @param data The item data
17149     * @param parent The parent item, or NULL if none
17150     * @param flags Item flags
17151     * @param func Convenience function called when the item is selected
17152     * @param func_data Data passed to @p func above.
17153     * @return A handle to the item added or @c NULL if not possible
17154     *
17155     * This adds the given item to the end of the list or the end of
17156     * the children list if the @p parent is given.
17157     *
17158     * @see elm_genlist_item_prepend()
17159     * @see elm_genlist_item_insert_before()
17160     * @see elm_genlist_item_insert_after()
17161     * @see elm_genlist_item_del()
17162     *
17163     * @ingroup Genlist
17164     */
17165    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);
17166    /**
17167     * Prepend a new item in a given genlist widget.
17168     *
17169     * @param obj The genlist object
17170     * @param itc The item class for the item
17171     * @param data The item data
17172     * @param parent The parent item, or NULL if none
17173     * @param flags Item flags
17174     * @param func Convenience function called when the item is selected
17175     * @param func_data Data passed to @p func above.
17176     * @return A handle to the item added or NULL if not possible
17177     *
17178     * This adds an item to the beginning of the list or beginning of the
17179     * children of the parent if given.
17180     *
17181     * @see elm_genlist_item_append()
17182     * @see elm_genlist_item_insert_before()
17183     * @see elm_genlist_item_insert_after()
17184     * @see elm_genlist_item_del()
17185     *
17186     * @ingroup Genlist
17187     */
17188    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);
17189    /**
17190     * Insert an item before another in a genlist widget
17191     *
17192     * @param obj The genlist object
17193     * @param itc The item class for the item
17194     * @param data The item data
17195     * @param before The item to place this new one before.
17196     * @param flags Item flags
17197     * @param func Convenience function called when the item is selected
17198     * @param func_data Data passed to @p func above.
17199     * @return A handle to the item added or @c NULL if not possible
17200     *
17201     * This inserts an item before another in the list. It will be in the
17202     * same tree level or group as the item it is inserted before.
17203     *
17204     * @see elm_genlist_item_append()
17205     * @see elm_genlist_item_prepend()
17206     * @see elm_genlist_item_insert_after()
17207     * @see elm_genlist_item_del()
17208     *
17209     * @ingroup Genlist
17210     */
17211    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);
17212    /**
17213     * Insert an item after another in a genlist widget
17214     *
17215     * @param obj The genlist object
17216     * @param itc The item class for the item
17217     * @param data The item data
17218     * @param after The item to place this new one after.
17219     * @param flags Item flags
17220     * @param func Convenience function called when the item is selected
17221     * @param func_data Data passed to @p func above.
17222     * @return A handle to the item added or @c NULL if not possible
17223     *
17224     * This inserts an item after another in the list. It will be in the
17225     * same tree level or group as the item it is inserted after.
17226     *
17227     * @see elm_genlist_item_append()
17228     * @see elm_genlist_item_prepend()
17229     * @see elm_genlist_item_insert_before()
17230     * @see elm_genlist_item_del()
17231     *
17232     * @ingroup Genlist
17233     */
17234    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);
17235    /**
17236     * Insert a new item into the sorted genlist object
17237     *
17238     * @param obj The genlist object
17239     * @param itc The item class for the item
17240     * @param data The item data
17241     * @param parent The parent item, or NULL if none
17242     * @param flags Item flags
17243     * @param comp The function called for the sort
17244     * @param func Convenience function called when item selected
17245     * @param func_data Data passed to @p func above.
17246     * @return A handle to the item added or NULL if not possible
17247     *
17248     * @ingroup Genlist
17249     */
17250    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);
17251    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);
17252    /* operations to retrieve existing items */
17253    /**
17254     * Get the selectd item in the genlist.
17255     *
17256     * @param obj The genlist object
17257     * @return The selected item, or NULL if none is selected.
17258     *
17259     * This gets the selected item in the list (if multi-selection is enabled, only
17260     * the item that was first selected in the list is returned - which is not very
17261     * useful, so see elm_genlist_selected_items_get() for when multi-selection is
17262     * used).
17263     *
17264     * If no item is selected, NULL is returned.
17265     *
17266     * @see elm_genlist_selected_items_get()
17267     *
17268     * @ingroup Genlist
17269     */
17270    EAPI Elm_Genlist_Item *elm_genlist_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17271    /**
17272     * Get a list of selected items in the genlist.
17273     *
17274     * @param obj The genlist object
17275     * @return The list of selected items, or NULL if none are selected.
17276     *
17277     * It returns a list of the selected items. This list pointer is only valid so
17278     * long as the selection doesn't change (no items are selected or unselected, or
17279     * unselected implicitly by deletion). The list contains Elm_Genlist_Item
17280     * pointers. The order of the items in this list is the order which they were
17281     * selected, i.e. the first item in this list is the first item that was
17282     * selected, and so on.
17283     *
17284     * @note If not in multi-select mode, consider using function
17285     * elm_genlist_selected_item_get() instead.
17286     *
17287     * @see elm_genlist_multi_select_set()
17288     * @see elm_genlist_selected_item_get()
17289     *
17290     * @ingroup Genlist
17291     */
17292    EAPI const Eina_List  *elm_genlist_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17293    /**
17294     * Get a list of realized items in genlist
17295     *
17296     * @param obj The genlist object
17297     * @return The list of realized items, nor NULL if none are realized.
17298     *
17299     * This returns a list of the realized items in the genlist. The list
17300     * contains Elm_Genlist_Item pointers. The list must be freed by the
17301     * caller when done with eina_list_free(). The item pointers in the
17302     * list are only valid so long as those items are not deleted or the
17303     * genlist is not deleted.
17304     *
17305     * @see elm_genlist_realized_items_update()
17306     *
17307     * @ingroup Genlist
17308     */
17309    EAPI Eina_List        *elm_genlist_realized_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17310    /**
17311     * Get the item that is at the x, y canvas coords.
17312     *
17313     * @param obj The gelinst object.
17314     * @param x The input x coordinate
17315     * @param y The input y coordinate
17316     * @param posret The position relative to the item returned here
17317     * @return The item at the coordinates or NULL if none
17318     *
17319     * This returns the item at the given coordinates (which are canvas
17320     * relative, not object-relative). If an item is at that coordinate,
17321     * that item handle is returned, and if @p posret is not NULL, the
17322     * integer pointed to is set to a value of -1, 0 or 1, depending if
17323     * the coordinate is on the upper portion of that item (-1), on the
17324     * middle section (0) or on the lower part (1). If NULL is returned as
17325     * an item (no item found there), then posret may indicate -1 or 1
17326     * based if the coordinate is above or below all items respectively in
17327     * the genlist.
17328     *
17329     * @ingroup Genlist
17330     */
17331    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);
17332    /**
17333     * Get the first item in the genlist
17334     *
17335     * This returns the first item in the list.
17336     *
17337     * @param obj The genlist object
17338     * @return The first item, or NULL if none
17339     *
17340     * @ingroup Genlist
17341     */
17342    EAPI Elm_Genlist_Item *elm_genlist_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17343    /**
17344     * Get the last item in the genlist
17345     *
17346     * This returns the last item in the list.
17347     *
17348     * @return The last item, or NULL if none
17349     *
17350     * @ingroup Genlist
17351     */
17352    EAPI Elm_Genlist_Item *elm_genlist_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17353    /**
17354     * Set the scrollbar policy
17355     *
17356     * @param obj The genlist object
17357     * @param policy_h Horizontal scrollbar policy.
17358     * @param policy_v Vertical scrollbar policy.
17359     *
17360     * This sets the scrollbar visibility policy for the given genlist
17361     * scroller. #ELM_SMART_SCROLLER_POLICY_AUTO means the scrollbar is
17362     * made visible if it is needed, and otherwise kept hidden.
17363     * #ELM_SMART_SCROLLER_POLICY_ON turns it on all the time, and
17364     * #ELM_SMART_SCROLLER_POLICY_OFF always keeps it off. This applies
17365     * respectively for the horizontal and vertical scrollbars. Default is
17366     * #ELM_SMART_SCROLLER_POLICY_AUTO
17367     *
17368     * @see elm_genlist_scroller_policy_get()
17369     *
17370     * @ingroup Genlist
17371     */
17372    EAPI void              elm_genlist_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
17373    /**
17374     * Get the scrollbar policy
17375     *
17376     * @param obj The genlist object
17377     * @param policy_h Pointer to store the horizontal scrollbar policy.
17378     * @param policy_v Pointer to store the vertical scrollbar policy.
17379     *
17380     * @see elm_genlist_scroller_policy_set()
17381     *
17382     * @ingroup Genlist
17383     */
17384    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);
17385    /**
17386     * Get the @b next item in a genlist widget's internal list of items,
17387     * given a handle to one of those items.
17388     *
17389     * @param item The genlist item to fetch next from
17390     * @return The item after @p item, or @c NULL if there's none (and
17391     * on errors)
17392     *
17393     * This returns the item placed after the @p item, on the container
17394     * genlist.
17395     *
17396     * @see elm_genlist_item_prev_get()
17397     *
17398     * @ingroup Genlist
17399     */
17400    EAPI Elm_Genlist_Item  *elm_genlist_item_next_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17401    /**
17402     * Get the @b previous item in a genlist widget's internal list of items,
17403     * given a handle to one of those items.
17404     *
17405     * @param item The genlist item to fetch previous from
17406     * @return The item before @p item, or @c NULL if there's none (and
17407     * on errors)
17408     *
17409     * This returns the item placed before the @p item, on the container
17410     * genlist.
17411     *
17412     * @see elm_genlist_item_next_get()
17413     *
17414     * @ingroup Genlist
17415     */
17416    EAPI Elm_Genlist_Item  *elm_genlist_item_prev_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17417    /**
17418     * Get the genlist object's handle which contains a given genlist
17419     * item
17420     *
17421     * @param item The item to fetch the container from
17422     * @return The genlist (parent) object
17423     *
17424     * This returns the genlist object itself that an item belongs to.
17425     *
17426     * @ingroup Genlist
17427     */
17428    EAPI Evas_Object       *elm_genlist_item_genlist_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17429    /**
17430     * Get the parent item of the given item
17431     *
17432     * @param it The item
17433     * @return The parent of the item or @c NULL if it has no parent.
17434     *
17435     * This returns the item that was specified as parent of the item @p it on
17436     * elm_genlist_item_append() and insertion related functions.
17437     *
17438     * @ingroup Genlist
17439     */
17440    EAPI Elm_Genlist_Item  *elm_genlist_item_parent_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17441    /**
17442     * Remove all sub-items (children) of the given item
17443     *
17444     * @param it The item
17445     *
17446     * This removes all items that are children (and their descendants) of the
17447     * given item @p it.
17448     *
17449     * @see elm_genlist_clear()
17450     * @see elm_genlist_item_del()
17451     *
17452     * @ingroup Genlist
17453     */
17454    EAPI void               elm_genlist_item_subitems_clear(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17455    /**
17456     * Set whether a given genlist item is selected or not
17457     *
17458     * @param it The item
17459     * @param selected Use @c EINA_TRUE, to make it selected, @c
17460     * EINA_FALSE to make it unselected
17461     *
17462     * This sets the selected state of an item. If multi selection is
17463     * not enabled on the containing genlist and @p selected is @c
17464     * EINA_TRUE, any other previously selected items will get
17465     * unselected in favor of this new one.
17466     *
17467     * @see elm_genlist_item_selected_get()
17468     *
17469     * @ingroup Genlist
17470     */
17471    EAPI void               elm_genlist_item_selected_set(Elm_Genlist_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
17472    /**
17473     * Get whether a given genlist item is selected or not
17474     *
17475     * @param it The item
17476     * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
17477     *
17478     * @see elm_genlist_item_selected_set() for more details
17479     *
17480     * @ingroup Genlist
17481     */
17482    EAPI Eina_Bool          elm_genlist_item_selected_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17483    /**
17484     * Sets the expanded state of an item.
17485     *
17486     * @param it The item
17487     * @param expanded The expanded state (@c EINA_TRUE expanded, @c EINA_FALSE not expanded).
17488     *
17489     * This function flags the item of type #ELM_GENLIST_ITEM_SUBITEMS as
17490     * expanded or not.
17491     *
17492     * The theme will respond to this change visually, and a signal "expanded" or
17493     * "contracted" will be sent from the genlist with a pointer to the item that
17494     * has been expanded/contracted.
17495     *
17496     * Calling this function won't show or hide any child of this item (if it is
17497     * a parent). You must manually delete and create them on the callbacks fo
17498     * the "expanded" or "contracted" signals.
17499     *
17500     * @see elm_genlist_item_expanded_get()
17501     *
17502     * @ingroup Genlist
17503     */
17504    EAPI void               elm_genlist_item_expanded_set(Elm_Genlist_Item *item, Eina_Bool expanded) EINA_ARG_NONNULL(1);
17505    /**
17506     * Get the expanded state of an item
17507     *
17508     * @param it The item
17509     * @return The expanded state
17510     *
17511     * This gets the expanded state of an item.
17512     *
17513     * @see elm_genlist_item_expanded_set()
17514     *
17515     * @ingroup Genlist
17516     */
17517    EAPI Eina_Bool          elm_genlist_item_expanded_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17518    /**
17519     * Get the depth of expanded item
17520     *
17521     * @param it The genlist item object
17522     * @return The depth of expanded item
17523     *
17524     * @ingroup Genlist
17525     */
17526    EAPI int                elm_genlist_item_expanded_depth_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17527    /**
17528     * Set whether a given genlist item is disabled or not.
17529     *
17530     * @param it The item
17531     * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
17532     * to enable it back.
17533     *
17534     * A disabled item cannot be selected or unselected. It will also
17535     * change its appearance, to signal the user it's disabled.
17536     *
17537     * @see elm_genlist_item_disabled_get()
17538     *
17539     * @ingroup Genlist
17540     */
17541    EAPI void               elm_genlist_item_disabled_set(Elm_Genlist_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
17542    /**
17543     * Get whether a given genlist item is disabled or not.
17544     *
17545     * @param it The item
17546     * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
17547     * (and on errors).
17548     *
17549     * @see elm_genlist_item_disabled_set() for more details
17550     *
17551     * @ingroup Genlist
17552     */
17553    EAPI Eina_Bool          elm_genlist_item_disabled_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17554    /**
17555     * Sets the display only state of an item.
17556     *
17557     * @param it The item
17558     * @param display_only @c EINA_TRUE if the item is display only, @c
17559     * EINA_FALSE otherwise.
17560     *
17561     * A display only item cannot be selected or unselected. It is for
17562     * display only and not selecting or otherwise clicking, dragging
17563     * etc. by the user, thus finger size rules will not be applied to
17564     * this item.
17565     *
17566     * It's good to set group index items to display only state.
17567     *
17568     * @see elm_genlist_item_display_only_get()
17569     *
17570     * @ingroup Genlist
17571     */
17572    EAPI void               elm_genlist_item_display_only_set(Elm_Genlist_Item *it, Eina_Bool display_only) EINA_ARG_NONNULL(1);
17573    /**
17574     * Get the display only state of an item
17575     *
17576     * @param it The item
17577     * @return @c EINA_TRUE if the item is display only, @c
17578     * EINA_FALSE otherwise.
17579     *
17580     * @see elm_genlist_item_display_only_set()
17581     *
17582     * @ingroup Genlist
17583     */
17584    EAPI Eina_Bool          elm_genlist_item_display_only_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17585    /**
17586     * Show the portion of a genlist's internal list containing a given
17587     * item, immediately.
17588     *
17589     * @param it The item to display
17590     *
17591     * This causes genlist to jump to the given item @p it and show it (by
17592     * immediately scrolling to that position), if it is not fully visible.
17593     *
17594     * @see elm_genlist_item_bring_in()
17595     * @see elm_genlist_item_top_show()
17596     * @see elm_genlist_item_middle_show()
17597     *
17598     * @ingroup Genlist
17599     */
17600    EAPI void               elm_genlist_item_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17601    /**
17602     * Animatedly bring in, to the visible are of a genlist, a given
17603     * item on it.
17604     *
17605     * @param it The item to display
17606     *
17607     * This causes genlist to jump to the given item @p it and show it (by
17608     * animatedly scrolling), if it is not fully visible. This may use animation
17609     * to do so and take a period of time
17610     *
17611     * @see elm_genlist_item_show()
17612     * @see elm_genlist_item_top_bring_in()
17613     * @see elm_genlist_item_middle_bring_in()
17614     *
17615     * @ingroup Genlist
17616     */
17617    EAPI void               elm_genlist_item_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17618    /**
17619     * Show the portion of a genlist's internal list containing a given
17620     * item, immediately.
17621     *
17622     * @param it The item to display
17623     *
17624     * This causes genlist to jump to the given item @p it and show it (by
17625     * immediately scrolling to that position), if it is not fully visible.
17626     *
17627     * The item will be positioned at the top of the genlist viewport.
17628     *
17629     * @see elm_genlist_item_show()
17630     * @see elm_genlist_item_top_bring_in()
17631     *
17632     * @ingroup Genlist
17633     */
17634    EAPI void               elm_genlist_item_top_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17635    /**
17636     * Animatedly bring in, to the visible are of a genlist, a given
17637     * item on it.
17638     *
17639     * @param it The item
17640     *
17641     * This causes genlist to jump to the given item @p it and show it (by
17642     * animatedly scrolling), if it is not fully visible. This may use animation
17643     * to do so and take a period of time
17644     *
17645     * The item will be positioned at the top of the genlist viewport.
17646     *
17647     * @see elm_genlist_item_bring_in()
17648     * @see elm_genlist_item_top_show()
17649     *
17650     * @ingroup Genlist
17651     */
17652    EAPI void               elm_genlist_item_top_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17653    /**
17654     * Show the portion of a genlist's internal list containing a given
17655     * item, immediately.
17656     *
17657     * @param it The item to display
17658     *
17659     * This causes genlist to jump to the given item @p it and show it (by
17660     * immediately scrolling to that position), if it is not fully visible.
17661     *
17662     * The item will be positioned at the middle of the genlist viewport.
17663     *
17664     * @see elm_genlist_item_show()
17665     * @see elm_genlist_item_middle_bring_in()
17666     *
17667     * @ingroup Genlist
17668     */
17669    EAPI void               elm_genlist_item_middle_show(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17670    /**
17671     * Animatedly bring in, to the visible are of a genlist, a given
17672     * item on it.
17673     *
17674     * @param it The item
17675     *
17676     * This causes genlist to jump to the given item @p it and show it (by
17677     * animatedly scrolling), if it is not fully visible. This may use animation
17678     * to do so and take a period of time
17679     *
17680     * The item will be positioned at the middle of the genlist viewport.
17681     *
17682     * @see elm_genlist_item_bring_in()
17683     * @see elm_genlist_item_middle_show()
17684     *
17685     * @ingroup Genlist
17686     */
17687    EAPI void               elm_genlist_item_middle_bring_in(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17688    /**
17689     * Remove a genlist item from the its parent, deleting it.
17690     *
17691     * @param item The item to be removed.
17692     * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
17693     *
17694     * @see elm_genlist_clear(), to remove all items in a genlist at
17695     * once.
17696     *
17697     * @ingroup Genlist
17698     */
17699    EAPI void               elm_genlist_item_del(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17700    /**
17701     * Return the data associated to a given genlist item
17702     *
17703     * @param item The genlist item.
17704     * @return the data associated to this item.
17705     *
17706     * This returns the @c data value passed on the
17707     * elm_genlist_item_append() and related item addition calls.
17708     *
17709     * @see elm_genlist_item_append()
17710     * @see elm_genlist_item_data_set()
17711     *
17712     * @ingroup Genlist
17713     */
17714    EAPI void              *elm_genlist_item_data_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17715    /**
17716     * Set the data associated to a given genlist item
17717     *
17718     * @param item The genlist item
17719     * @param data The new data pointer to set on it
17720     *
17721     * This @b overrides the @c data value passed on the
17722     * elm_genlist_item_append() and related item addition calls. This
17723     * function @b won't call elm_genlist_item_update() automatically,
17724     * so you'd issue it afterwards if you want to hove the item
17725     * updated to reflect the that new data.
17726     *
17727     * @see elm_genlist_item_data_get()
17728     *
17729     * @ingroup Genlist
17730     */
17731    EAPI void               elm_genlist_item_data_set(Elm_Genlist_Item *it, const void *data) EINA_ARG_NONNULL(1);
17732    /**
17733     * Tells genlist to "orphan" icons fetchs by the item class
17734     *
17735     * @param it The item
17736     *
17737     * This instructs genlist to release references to icons in the item,
17738     * meaning that they will no longer be managed by genlist and are
17739     * floating "orphans" that can be re-used elsewhere if the user wants
17740     * to.
17741     *
17742     * @ingroup Genlist
17743     */
17744    EAPI void               elm_genlist_item_icons_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17745    /**
17746     * Get the real Evas object created to implement the view of a
17747     * given genlist item
17748     *
17749     * @param item The genlist item.
17750     * @return the Evas object implementing this item's view.
17751     *
17752     * This returns the actual Evas object used to implement the
17753     * specified genlist item's view. This may be @c NULL, as it may
17754     * not have been created or may have been deleted, at any time, by
17755     * the genlist. <b>Do not modify this object</b> (move, resize,
17756     * show, hide, etc.), as the genlist is controlling it. This
17757     * function is for querying, emitting custom signals or hooking
17758     * lower level callbacks for events on that object. Do not delete
17759     * this object under any circumstances.
17760     *
17761     * @see elm_genlist_item_data_get()
17762     *
17763     * @ingroup Genlist
17764     */
17765    EAPI const Evas_Object *elm_genlist_item_object_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17766    /**
17767     * Update the contents of an item
17768     *
17769     * @param it The item
17770     *
17771     * This updates an item by calling all the item class functions again
17772     * to get the icons, labels and states. Use this when the original
17773     * item data has changed and the changes are desired to be reflected.
17774     *
17775     * Use elm_genlist_realized_items_update() to update all already realized
17776     * items.
17777     *
17778     * @see elm_genlist_realized_items_update()
17779     *
17780     * @ingroup Genlist
17781     */
17782    EAPI void               elm_genlist_item_update(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17783    /**
17784     * Update the item class of an item
17785     *
17786     * @param it The item
17787     * @param itc The item class for the item
17788     *
17789     * This sets another class fo the item, changing the way that it is
17790     * displayed. After changing the item class, elm_genlist_item_update() is
17791     * called on the item @p it.
17792     *
17793     * @ingroup Genlist
17794     */
17795    EAPI void               elm_genlist_item_item_class_update(Elm_Genlist_Item *it, const Elm_Genlist_Item_Class *itc) EINA_ARG_NONNULL(1, 2);
17796    EAPI const Elm_Genlist_Item_Class *elm_genlist_item_item_class_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
17797    /**
17798     * Set the text to be shown in a given genlist item's tooltips.
17799     *
17800     * @param item The genlist item
17801     * @param text The text to set in the content
17802     *
17803     * This call will setup the text to be used as tooltip to that item
17804     * (analogous to elm_object_tooltip_text_set(), but being item
17805     * tooltips with higher precedence than object tooltips). It can
17806     * have only one tooltip at a time, so any previous tooltip data
17807     * will get removed.
17808     *
17809     * In order to set an icon or something else as a tooltip, look at
17810     * elm_genlist_item_tooltip_content_cb_set().
17811     *
17812     * @ingroup Genlist
17813     */
17814    EAPI void               elm_genlist_item_tooltip_text_set(Elm_Genlist_Item *item, const char *text) EINA_ARG_NONNULL(1);
17815    /**
17816     * Set the content to be shown in a given genlist item's tooltips
17817     *
17818     * @param item The genlist item.
17819     * @param func The function returning the tooltip contents.
17820     * @param data What to provide to @a func as callback data/context.
17821     * @param del_cb Called when data is not needed anymore, either when
17822     *        another callback replaces @p func, the tooltip is unset with
17823     *        elm_genlist_item_tooltip_unset() or the owner @p item
17824     *        dies. This callback receives as its first parameter the
17825     *        given @p data, being @c event_info the item handle.
17826     *
17827     * This call will setup the tooltip's contents to @p item
17828     * (analogous to elm_object_tooltip_content_cb_set(), but being
17829     * item tooltips with higher precedence than object tooltips). It
17830     * can have only one tooltip at a time, so any previous tooltip
17831     * content will get removed. @p func (with @p data) will be called
17832     * every time Elementary needs to show the tooltip and it should
17833     * return a valid Evas object, which will be fully managed by the
17834     * tooltip system, getting deleted when the tooltip is gone.
17835     *
17836     * In order to set just a text as a tooltip, look at
17837     * elm_genlist_item_tooltip_text_set().
17838     *
17839     * @ingroup Genlist
17840     */
17841    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);
17842    /**
17843     * Unset a tooltip from a given genlist item
17844     *
17845     * @param item genlist item to remove a previously set tooltip from.
17846     *
17847     * This call removes any tooltip set on @p item. The callback
17848     * provided as @c del_cb to
17849     * elm_genlist_item_tooltip_content_cb_set() will be called to
17850     * notify it is not used anymore (and have resources cleaned, if
17851     * need be).
17852     *
17853     * @see elm_genlist_item_tooltip_content_cb_set()
17854     *
17855     * @ingroup Genlist
17856     */
17857    EAPI void               elm_genlist_item_tooltip_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17858    /**
17859     * Set a different @b style for a given genlist item's tooltip.
17860     *
17861     * @param item genlist item with tooltip set
17862     * @param style the <b>theme style</b> to use on tooltips (e.g. @c
17863     * "default", @c "transparent", etc)
17864     *
17865     * Tooltips can have <b>alternate styles</b> to be displayed on,
17866     * which are defined by the theme set on Elementary. This function
17867     * works analogously as elm_object_tooltip_style_set(), but here
17868     * applied only to genlist item objects. The default style for
17869     * tooltips is @c "default".
17870     *
17871     * @note before you set a style you should define a tooltip with
17872     *       elm_genlist_item_tooltip_content_cb_set() or
17873     *       elm_genlist_item_tooltip_text_set()
17874     *
17875     * @see elm_genlist_item_tooltip_style_get()
17876     *
17877     * @ingroup Genlist
17878     */
17879    EAPI void               elm_genlist_item_tooltip_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
17880    /**
17881     * Get the style set a given genlist item's tooltip.
17882     *
17883     * @param item genlist item with tooltip already set on.
17884     * @return style the theme style in use, which defaults to
17885     *         "default". If the object does not have a tooltip set,
17886     *         then @c NULL is returned.
17887     *
17888     * @see elm_genlist_item_tooltip_style_set() for more details
17889     *
17890     * @ingroup Genlist
17891     */
17892    EAPI const char        *elm_genlist_item_tooltip_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17893    /**
17894     * @brief Disable size restrictions on an object's tooltip
17895     * @param item The tooltip's anchor object
17896     * @param disable If EINA_TRUE, size restrictions are disabled
17897     * @return EINA_FALSE on failure, EINA_TRUE on success
17898     *
17899     * This function allows a tooltip to expand beyond its parant window's canvas.
17900     * It will instead be limited only by the size of the display.
17901     */
17902    EAPI Eina_Bool          elm_genlist_item_tooltip_size_restrict_disable(Elm_Genlist_Item *item, Eina_Bool disable);
17903    /**
17904     * @brief Retrieve size restriction state of an object's tooltip
17905     * @param item The tooltip's anchor object
17906     * @return If EINA_TRUE, size restrictions are disabled
17907     *
17908     * This function returns whether a tooltip is allowed to expand beyond
17909     * its parant window's canvas.
17910     * It will instead be limited only by the size of the display.
17911     */
17912    EAPI Eina_Bool          elm_genlist_item_tooltip_size_restrict_disabled_get(const Elm_Genlist_Item *item);
17913    /**
17914     * Set the type of mouse pointer/cursor decoration to be shown,
17915     * when the mouse pointer is over the given genlist widget item
17916     *
17917     * @param item genlist item to customize cursor on
17918     * @param cursor the cursor type's name
17919     *
17920     * This function works analogously as elm_object_cursor_set(), but
17921     * here the cursor's changing area is restricted to the item's
17922     * area, and not the whole widget's. Note that that item cursors
17923     * have precedence over widget cursors, so that a mouse over @p
17924     * item will always show cursor @p type.
17925     *
17926     * If this function is called twice for an object, a previously set
17927     * cursor will be unset on the second call.
17928     *
17929     * @see elm_object_cursor_set()
17930     * @see elm_genlist_item_cursor_get()
17931     * @see elm_genlist_item_cursor_unset()
17932     *
17933     * @ingroup Genlist
17934     */
17935    EAPI void               elm_genlist_item_cursor_set(Elm_Genlist_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
17936    /**
17937     * Get the type of mouse pointer/cursor decoration set to be shown,
17938     * when the mouse pointer is over the given genlist widget item
17939     *
17940     * @param item genlist item with custom cursor set
17941     * @return the cursor type's name or @c NULL, if no custom cursors
17942     * were set to @p item (and on errors)
17943     *
17944     * @see elm_object_cursor_get()
17945     * @see elm_genlist_item_cursor_set() for more details
17946     * @see elm_genlist_item_cursor_unset()
17947     *
17948     * @ingroup Genlist
17949     */
17950    EAPI const char        *elm_genlist_item_cursor_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17951    /**
17952     * Unset any custom mouse pointer/cursor decoration set to be
17953     * shown, when the mouse pointer is over the given genlist widget
17954     * item, thus making it show the @b default cursor again.
17955     *
17956     * @param item a genlist item
17957     *
17958     * Use this call to undo any custom settings on this item's cursor
17959     * decoration, bringing it back to defaults (no custom style set).
17960     *
17961     * @see elm_object_cursor_unset()
17962     * @see elm_genlist_item_cursor_set() for more details
17963     *
17964     * @ingroup Genlist
17965     */
17966    EAPI void               elm_genlist_item_cursor_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
17967    /**
17968     * Set a different @b style for a given custom cursor set for a
17969     * genlist item.
17970     *
17971     * @param item genlist item with custom cursor set
17972     * @param style the <b>theme style</b> to use (e.g. @c "default",
17973     * @c "transparent", etc)
17974     *
17975     * This function only makes sense when one is using custom mouse
17976     * cursor decorations <b>defined in a theme file</b> , which can
17977     * have, given a cursor name/type, <b>alternate styles</b> on
17978     * it. It works analogously as elm_object_cursor_style_set(), but
17979     * here applied only to genlist item objects.
17980     *
17981     * @warning Before you set a cursor style you should have defined a
17982     *       custom cursor previously on the item, with
17983     *       elm_genlist_item_cursor_set()
17984     *
17985     * @see elm_genlist_item_cursor_engine_only_set()
17986     * @see elm_genlist_item_cursor_style_get()
17987     *
17988     * @ingroup Genlist
17989     */
17990    EAPI void               elm_genlist_item_cursor_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
17991    /**
17992     * Get the current @b style set for a given genlist item's custom
17993     * cursor
17994     *
17995     * @param item genlist item with custom cursor set.
17996     * @return style the cursor style in use. If the object does not
17997     *         have a cursor set, then @c NULL is returned.
17998     *
17999     * @see elm_genlist_item_cursor_style_set() for more details
18000     *
18001     * @ingroup Genlist
18002     */
18003    EAPI const char        *elm_genlist_item_cursor_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18004    /**
18005     * Set if the (custom) cursor for a given genlist item should be
18006     * searched in its theme, also, or should only rely on the
18007     * rendering engine.
18008     *
18009     * @param item item with custom (custom) cursor already set on
18010     * @param engine_only Use @c EINA_TRUE to have cursors looked for
18011     * only on those provided by the rendering engine, @c EINA_FALSE to
18012     * have them searched on the widget's theme, as well.
18013     *
18014     * @note This call is of use only if you've set a custom cursor
18015     * for genlist items, with elm_genlist_item_cursor_set().
18016     *
18017     * @note By default, cursors will only be looked for between those
18018     * provided by the rendering engine.
18019     *
18020     * @ingroup Genlist
18021     */
18022    EAPI void               elm_genlist_item_cursor_engine_only_set(Elm_Genlist_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
18023    /**
18024     * Get if the (custom) cursor for a given genlist item is being
18025     * searched in its theme, also, or is only relying on the rendering
18026     * engine.
18027     *
18028     * @param item a genlist item
18029     * @return @c EINA_TRUE, if cursors are being looked for only on
18030     * those provided by the rendering engine, @c EINA_FALSE if they
18031     * are being searched on the widget's theme, as well.
18032     *
18033     * @see elm_genlist_item_cursor_engine_only_set(), for more details
18034     *
18035     * @ingroup Genlist
18036     */
18037    EAPI Eina_Bool          elm_genlist_item_cursor_engine_only_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
18038    /**
18039     * Update the contents of all realized items.
18040     *
18041     * @param obj The genlist object.
18042     *
18043     * This updates all realized items by calling all the item class functions again
18044     * to get the icons, labels and states. Use this when the original
18045     * item data has changed and the changes are desired to be reflected.
18046     *
18047     * To update just one item, use elm_genlist_item_update().
18048     *
18049     * @see elm_genlist_realized_items_get()
18050     * @see elm_genlist_item_update()
18051     *
18052     * @ingroup Genlist
18053     */
18054    EAPI void               elm_genlist_realized_items_update(Evas_Object *obj) EINA_ARG_NONNULL(1);
18055    /**
18056     * Activate a genlist mode on an item
18057     *
18058     * @param item The genlist item
18059     * @param mode Mode name
18060     * @param mode_set Boolean to define set or unset mode.
18061     *
18062     * A genlist mode is a different way of selecting an item. Once a mode is
18063     * activated on an item, any other selected item is immediately unselected.
18064     * This feature provides an easy way of implementing a new kind of animation
18065     * for selecting an item, without having to entirely rewrite the item style
18066     * theme. However, the elm_genlist_selected_* API can't be used to get what
18067     * item is activate for a mode.
18068     *
18069     * The current item style will still be used, but applying a genlist mode to
18070     * an item will select it using a different kind of animation.
18071     *
18072     * The current active item for a mode can be found by
18073     * elm_genlist_mode_item_get().
18074     *
18075     * The characteristics of genlist mode are:
18076     * - Only one mode can be active at any time, and for only one item.
18077     * - Genlist handles deactivating other items when one item is activated.
18078     * - A mode is defined in the genlist theme (edc), and more modes can easily
18079     *   be added.
18080     * - A mode style and the genlist item style are different things. They
18081     *   can be combined to provide a default style to the item, with some kind
18082     *   of animation for that item when the mode is activated.
18083     *
18084     * When a mode is activated on an item, a new view for that item is created.
18085     * The theme of this mode defines the animation that will be used to transit
18086     * the item from the old view to the new view. This second (new) view will be
18087     * active for that item while the mode is active on the item, and will be
18088     * destroyed after the mode is totally deactivated from that item.
18089     *
18090     * @see elm_genlist_mode_get()
18091     * @see elm_genlist_mode_item_get()
18092     *
18093     * @ingroup Genlist
18094     */
18095    EAPI void               elm_genlist_item_mode_set(Elm_Genlist_Item *it, const char *mode_type, Eina_Bool mode_set) EINA_ARG_NONNULL(1, 2);
18096    /**
18097     * Get the last (or current) genlist mode used.
18098     *
18099     * @param obj The genlist object
18100     *
18101     * This function just returns the name of the last used genlist mode. It will
18102     * be the current mode if it's still active.
18103     *
18104     * @see elm_genlist_item_mode_set()
18105     * @see elm_genlist_mode_item_get()
18106     *
18107     * @ingroup Genlist
18108     */
18109    EAPI const char        *elm_genlist_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18110    /**
18111     * Get active genlist mode item
18112     *
18113     * @param obj The genlist object
18114     * @return The active item for that current mode. Or @c NULL if no item is
18115     * activated with any mode.
18116     *
18117     * This function returns the item that was activated with a mode, by the
18118     * function elm_genlist_item_mode_set().
18119     *
18120     * @see elm_genlist_item_mode_set()
18121     * @see elm_genlist_mode_get()
18122     *
18123     * @ingroup Genlist
18124     */
18125    EAPI const Elm_Genlist_Item *elm_genlist_mode_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18126
18127    /**
18128     * Set reorder mode
18129     *
18130     * @param obj The genlist object
18131     * @param reorder_mode The reorder mode
18132     * (EINA_TRUE = on, EINA_FALSE = off)
18133     *
18134     * @ingroup Genlist
18135     */
18136    EAPI void               elm_genlist_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
18137
18138    /**
18139     * Get the reorder mode
18140     *
18141     * @param obj The genlist object
18142     * @return The reorder mode
18143     * (EINA_TRUE = on, EINA_FALSE = off)
18144     *
18145     * @ingroup Genlist
18146     */
18147    EAPI Eina_Bool          elm_genlist_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18148
18149    /**
18150     * @}
18151     */
18152
18153    /**
18154     * @defgroup Check Check
18155     *
18156     * @image html img/widget/check/preview-00.png
18157     * @image latex img/widget/check/preview-00.eps
18158     * @image html img/widget/check/preview-01.png
18159     * @image latex img/widget/check/preview-01.eps
18160     * @image html img/widget/check/preview-02.png
18161     * @image latex img/widget/check/preview-02.eps
18162     *
18163     * @brief The check widget allows for toggling a value between true and
18164     * false.
18165     *
18166     * Check objects are a lot like radio objects in layout and functionality
18167     * except they do not work as a group, but independently and only toggle the
18168     * value of a boolean from false to true (0 or 1). elm_check_state_set() sets
18169     * the boolean state (1 for true, 0 for false), and elm_check_state_get()
18170     * returns the current state. For convenience, like the radio objects, you
18171     * can set a pointer to a boolean directly with elm_check_state_pointer_set()
18172     * for it to modify.
18173     *
18174     * Signals that you can add callbacks for are:
18175     * "changed" - This is called whenever the user changes the state of one of
18176     *             the check object(event_info is NULL).
18177     *
18178     * @ref tutorial_check should give you a firm grasp of how to use this widget.
18179     * @{
18180     */
18181    /**
18182     * @brief Add a new Check object
18183     *
18184     * @param parent The parent object
18185     * @return The new object or NULL if it cannot be created
18186     */
18187    EAPI Evas_Object *elm_check_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18188    /**
18189     * @brief Set the text label of the check object
18190     *
18191     * @param obj The check object
18192     * @param label The text label string in UTF-8
18193     *
18194     * @deprecated use elm_object_text_set() instead.
18195     */
18196    EINA_DEPRECATED EAPI void         elm_check_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
18197    /**
18198     * @brief Get the text label of the check object
18199     *
18200     * @param obj The check object
18201     * @return The text label string in UTF-8
18202     *
18203     * @deprecated use elm_object_text_get() instead.
18204     */
18205    EINA_DEPRECATED EAPI const char  *elm_check_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18206    /**
18207     * @brief Set the icon object of the check object
18208     *
18209     * @param obj The check object
18210     * @param icon The icon object
18211     *
18212     * Once the icon object is set, a previously set one will be deleted.
18213     * If you want to keep that old content object, use the
18214     * elm_check_icon_unset() function.
18215     */
18216    EAPI void         elm_check_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
18217    /**
18218     * @brief Get the icon object of the check object
18219     *
18220     * @param obj The check object
18221     * @return The icon object
18222     */
18223    EAPI Evas_Object *elm_check_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18224    /**
18225     * @brief Unset the icon used for the check object
18226     *
18227     * @param obj The check object
18228     * @return The icon object that was being used
18229     *
18230     * Unparent and return the icon object which was set for this widget.
18231     */
18232    EAPI Evas_Object *elm_check_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
18233    /**
18234     * @brief Set the on/off state of the check object
18235     *
18236     * @param obj The check object
18237     * @param state The state to use (1 == on, 0 == off)
18238     *
18239     * This sets the state of the check. If set
18240     * with elm_check_state_pointer_set() the state of that variable is also
18241     * changed. Calling this @b doesn't cause the "changed" signal to be emited.
18242     */
18243    EAPI void         elm_check_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
18244    /**
18245     * @brief Get the state of the check object
18246     *
18247     * @param obj The check object
18248     * @return The boolean state
18249     */
18250    EAPI Eina_Bool    elm_check_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18251    /**
18252     * @brief Set a convenience pointer to a boolean to change
18253     *
18254     * @param obj The check object
18255     * @param statep Pointer to the boolean to modify
18256     *
18257     * This sets a pointer to a boolean, that, in addition to the check objects
18258     * state will also be modified directly. To stop setting the object pointed
18259     * to simply use NULL as the @p statep parameter. If @p statep is not NULL,
18260     * then when this is called, the check objects state will also be modified to
18261     * reflect the value of the boolean @p statep points to, just like calling
18262     * elm_check_state_set().
18263     */
18264    EAPI void         elm_check_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
18265    /**
18266     * @}
18267     */
18268
18269    /**
18270     * @defgroup Radio Radio
18271     *
18272     * @image html img/widget/radio/preview-00.png
18273     * @image latex img/widget/radio/preview-00.eps
18274     *
18275     * @brief Radio is a widget that allows for 1 or more options to be displayed
18276     * and have the user choose only 1 of them.
18277     *
18278     * A radio object contains an indicator, an optional Label and an optional
18279     * icon object. While it's possible to have a group of only one radio they,
18280     * are normally used in groups of 2 or more. To add a radio to a group use
18281     * elm_radio_group_add(). The radio object(s) will select from one of a set
18282     * of integer values, so any value they are configuring needs to be mapped to
18283     * a set of integers. To configure what value that radio object represents,
18284     * use  elm_radio_state_value_set() to set the integer it represents. To set
18285     * the value the whole group(which one is currently selected) is to indicate
18286     * use elm_radio_value_set() on any group member, and to get the groups value
18287     * use elm_radio_value_get(). For convenience the radio objects are also able
18288     * to directly set an integer(int) to the value that is selected. To specify
18289     * the pointer to this integer to modify, use elm_radio_value_pointer_set().
18290     * The radio objects will modify this directly. That implies the pointer must
18291     * point to valid memory for as long as the radio objects exist.
18292     *
18293     * Signals that you can add callbacks for are:
18294     * @li changed - This is called whenever the user changes the state of one of
18295     * the radio objects within the group of radio objects that work together.
18296     *
18297     * @ref tutorial_radio show most of this API in action.
18298     * @{
18299     */
18300    /**
18301     * @brief Add a new radio to the parent
18302     *
18303     * @param parent The parent object
18304     * @return The new object or NULL if it cannot be created
18305     */
18306    EAPI Evas_Object *elm_radio_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18307    /**
18308     * @brief Set the text label of the radio object
18309     *
18310     * @param obj The radio object
18311     * @param label The text label string in UTF-8
18312     *
18313     * @deprecated use elm_object_text_set() instead.
18314     */
18315    EINA_DEPRECATED EAPI void         elm_radio_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
18316    /**
18317     * @brief Get the text label of the radio object
18318     *
18319     * @param obj The radio object
18320     * @return The text label string in UTF-8
18321     *
18322     * @deprecated use elm_object_text_set() instead.
18323     */
18324    EINA_DEPRECATED EAPI const char  *elm_radio_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18325    /**
18326     * @brief Set the icon object of the radio object
18327     *
18328     * @param obj The radio object
18329     * @param icon The icon object
18330     *
18331     * Once the icon object is set, a previously set one will be deleted. If you
18332     * want to keep that old content object, use the elm_radio_icon_unset()
18333     * function.
18334     */
18335    EAPI void         elm_radio_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
18336    /**
18337     * @brief Get the icon object of the radio object
18338     *
18339     * @param obj The radio object
18340     * @return The icon object
18341     *
18342     * @see elm_radio_icon_set()
18343     */
18344    EAPI Evas_Object *elm_radio_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18345    /**
18346     * @brief Unset the icon used for the radio object
18347     *
18348     * @param obj The radio object
18349     * @return The icon object that was being used
18350     *
18351     * Unparent and return the icon object which was set for this widget.
18352     *
18353     * @see elm_radio_icon_set()
18354     */
18355    EAPI Evas_Object *elm_radio_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
18356    /**
18357     * @brief Add this radio to a group of other radio objects
18358     *
18359     * @param obj The radio object
18360     * @param group Any object whose group the @p obj is to join.
18361     *
18362     * Radio objects work in groups. Each member should have a different integer
18363     * value assigned. In order to have them work as a group, they need to know
18364     * about each other. This adds the given radio object to the group of which
18365     * the group object indicated is a member.
18366     */
18367    EAPI void         elm_radio_group_add(Evas_Object *obj, Evas_Object *group) EINA_ARG_NONNULL(1);
18368    /**
18369     * @brief Set the integer value that this radio object represents
18370     *
18371     * @param obj The radio object
18372     * @param value The value to use if this radio object is selected
18373     *
18374     * This sets the value of the radio.
18375     */
18376    EAPI void         elm_radio_state_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
18377    /**
18378     * @brief Get the integer value that this radio object represents
18379     *
18380     * @param obj The radio object
18381     * @return The value used if this radio object is selected
18382     *
18383     * This gets the value of the radio.
18384     *
18385     * @see elm_radio_value_set()
18386     */
18387    EAPI int          elm_radio_state_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18388    /**
18389     * @brief Set the value of the radio.
18390     *
18391     * @param obj The radio object
18392     * @param value The value to use for the group
18393     *
18394     * This sets the value of the radio group and will also set the value if
18395     * pointed to, to the value supplied, but will not call any callbacks.
18396     */
18397    EAPI void         elm_radio_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
18398    /**
18399     * @brief Get the state of the radio object
18400     *
18401     * @param obj The radio object
18402     * @return The integer state
18403     */
18404    EAPI int          elm_radio_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18405    /**
18406     * @brief Set a convenience pointer to a integer to change
18407     *
18408     * @param obj The radio object
18409     * @param valuep Pointer to the integer to modify
18410     *
18411     * This sets a pointer to a integer, that, in addition to the radio objects
18412     * state will also be modified directly. To stop setting the object pointed
18413     * to simply use NULL as the @p valuep argument. If valuep is not NULL, then
18414     * when this is called, the radio objects state will also be modified to
18415     * reflect the value of the integer valuep points to, just like calling
18416     * elm_radio_value_set().
18417     */
18418    EAPI void         elm_radio_value_pointer_set(Evas_Object *obj, int *valuep) EINA_ARG_NONNULL(1);
18419    /**
18420     * @}
18421     */
18422
18423    /**
18424     * @defgroup Pager Pager
18425     *
18426     * @image html img/widget/pager/preview-00.png
18427     * @image latex img/widget/pager/preview-00.eps
18428     *
18429     * @brief Widget that allows flipping between 1 or more “pages” of objects.
18430     *
18431     * The flipping between “pages” of objects is animated. All content in pager
18432     * is kept in a stack, the last content to be added will be on the top of the
18433     * stack(be visible).
18434     *
18435     * Objects can be pushed or popped from the stack or deleted as normal.
18436     * Pushes and pops will animate (and a pop will delete the object once the
18437     * animation is finished). Any object already in the pager can be promoted to
18438     * the top(from its current stacking position) through the use of
18439     * elm_pager_content_promote(). Objects are pushed to the top with
18440     * elm_pager_content_push() and when the top item is no longer wanted, simply
18441     * pop it with elm_pager_content_pop() and it will also be deleted. If an
18442     * object is no longer needed and is not the top item, just delete it as
18443     * normal. You can query which objects are the top and bottom with
18444     * elm_pager_content_bottom_get() and elm_pager_content_top_get().
18445     *
18446     * Signals that you can add callbacks for are:
18447     * "hide,finished" - when the previous page is hided
18448     *
18449     * This widget has the following styles available:
18450     * @li default
18451     * @li fade
18452     * @li fade_translucide
18453     * @li fade_invisible
18454     * @note This styles affect only the flipping animations, the appearance when
18455     * not animating is unaffected by styles.
18456     *
18457     * @ref tutorial_pager gives a good overview of the usage of the API.
18458     * @{
18459     */
18460    /**
18461     * Add a new pager to the parent
18462     *
18463     * @param parent The parent object
18464     * @return The new object or NULL if it cannot be created
18465     *
18466     * @ingroup Pager
18467     */
18468    EAPI Evas_Object *elm_pager_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18469    /**
18470     * @brief Push an object to the top of the pager stack (and show it).
18471     *
18472     * @param obj The pager object
18473     * @param content The object to push
18474     *
18475     * The object pushed becomes a child of the pager, it will be controlled and
18476     * deleted when the pager is deleted.
18477     *
18478     * @note If the content is already in the stack use
18479     * elm_pager_content_promote().
18480     * @warning Using this function on @p content already in the stack results in
18481     * undefined behavior.
18482     */
18483    EAPI void         elm_pager_content_push(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
18484    /**
18485     * @brief Pop the object that is on top of the stack
18486     *
18487     * @param obj The pager object
18488     *
18489     * This pops the object that is on the top(visible) of the pager, makes it
18490     * disappear, then deletes the object. The object that was underneath it on
18491     * the stack will become visible.
18492     */
18493    EAPI void         elm_pager_content_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
18494    /**
18495     * @brief Moves an object already in the pager stack to the top of the stack.
18496     *
18497     * @param obj The pager object
18498     * @param content The object to promote
18499     *
18500     * This will take the @p content and move it to the top of the stack as
18501     * if it had been pushed there.
18502     *
18503     * @note If the content isn't already in the stack use
18504     * elm_pager_content_push().
18505     * @warning Using this function on @p content not already in the stack
18506     * results in undefined behavior.
18507     */
18508    EAPI void         elm_pager_content_promote(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
18509    /**
18510     * @brief Return the object at the bottom of the pager stack
18511     *
18512     * @param obj The pager object
18513     * @return The bottom object or NULL if none
18514     */
18515    EAPI Evas_Object *elm_pager_content_bottom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18516    /**
18517     * @brief  Return the object at the top of the pager stack
18518     *
18519     * @param obj The pager object
18520     * @return The top object or NULL if none
18521     */
18522    EAPI Evas_Object *elm_pager_content_top_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18523    /**
18524     * @}
18525     */
18526
18527    /**
18528     * @defgroup Slideshow Slideshow
18529     *
18530     * @image html img/widget/slideshow/preview-00.png
18531     * @image latex img/widget/slideshow/preview-00.eps
18532     *
18533     * This widget, as the name indicates, is a pre-made image
18534     * slideshow panel, with API functions acting on (child) image
18535     * items presentation. Between those actions, are:
18536     * - advance to next/previous image
18537     * - select the style of image transition animation
18538     * - set the exhibition time for each image
18539     * - start/stop the slideshow
18540     *
18541     * The transition animations are defined in the widget's theme,
18542     * consequently new animations can be added without having to
18543     * update the widget's code.
18544     *
18545     * @section Slideshow_Items Slideshow items
18546     *
18547     * For slideshow items, just like for @ref Genlist "genlist" ones,
18548     * the user defines a @b classes, specifying functions that will be
18549     * called on the item's creation and deletion times.
18550     *
18551     * The #Elm_Slideshow_Item_Class structure contains the following
18552     * members:
18553     *
18554     * - @c func.get - When an item is displayed, this function is
18555     *   called, and it's where one should create the item object, de
18556     *   facto. For example, the object can be a pure Evas image object
18557     *   or an Elementary @ref Photocam "photocam" widget. See
18558     *   #SlideshowItemGetFunc.
18559     * - @c func.del - When an item is no more displayed, this function
18560     *   is called, where the user must delete any data associated to
18561     *   the item. See #SlideshowItemDelFunc.
18562     *
18563     * @section Slideshow_Caching Slideshow caching
18564     *
18565     * The slideshow provides facilities to have items adjacent to the
18566     * one being displayed <b>already "realized"</b> (i.e. loaded) for
18567     * you, so that the system does not have to decode image data
18568     * anymore at the time it has to actually switch images on its
18569     * viewport. The user is able to set the numbers of items to be
18570     * cached @b before and @b after the current item, in the widget's
18571     * item list.
18572     *
18573     * Smart events one can add callbacks for are:
18574     *
18575     * - @c "changed" - when the slideshow switches its view to a new
18576     *   item
18577     *
18578     * List of examples for the slideshow widget:
18579     * @li @ref slideshow_example
18580     */
18581
18582    /**
18583     * @addtogroup Slideshow
18584     * @{
18585     */
18586
18587    typedef struct _Elm_Slideshow_Item_Class Elm_Slideshow_Item_Class; /**< Slideshow item class definition struct */
18588    typedef struct _Elm_Slideshow_Item_Class_Func Elm_Slideshow_Item_Class_Func; /**< Class functions for slideshow item classes. */
18589    typedef struct _Elm_Slideshow_Item       Elm_Slideshow_Item; /**< Slideshow item handle */
18590    typedef Evas_Object *(*SlideshowItemGetFunc) (void *data, Evas_Object *obj); /**< Image fetching class function for slideshow item classes. */
18591    typedef void         (*SlideshowItemDelFunc) (void *data, Evas_Object *obj); /**< Deletion class function for slideshow item classes. */
18592
18593    /**
18594     * @struct _Elm_Slideshow_Item_Class
18595     *
18596     * Slideshow item class definition. See @ref Slideshow_Items for
18597     * field details.
18598     */
18599    struct _Elm_Slideshow_Item_Class
18600      {
18601         struct _Elm_Slideshow_Item_Class_Func
18602           {
18603              SlideshowItemGetFunc get;
18604              SlideshowItemDelFunc del;
18605           } func;
18606      }; /**< #Elm_Slideshow_Item_Class member definitions */
18607
18608    /**
18609     * Add a new slideshow widget to the given parent Elementary
18610     * (container) object
18611     *
18612     * @param parent The parent object
18613     * @return A new slideshow widget handle or @c NULL, on errors
18614     *
18615     * This function inserts a new slideshow widget on the canvas.
18616     *
18617     * @ingroup Slideshow
18618     */
18619    EAPI Evas_Object        *elm_slideshow_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18620
18621    /**
18622     * Add (append) a new item in a given slideshow widget.
18623     *
18624     * @param obj The slideshow object
18625     * @param itc The item class for the item
18626     * @param data The item's data
18627     * @return A handle to the item added or @c NULL, on errors
18628     *
18629     * Add a new item to @p obj's internal list of items, appending it.
18630     * The item's class must contain the function really fetching the
18631     * image object to show for this item, which could be an Evas image
18632     * object or an Elementary photo, for example. The @p data
18633     * parameter is going to be passed to both class functions of the
18634     * item.
18635     *
18636     * @see #Elm_Slideshow_Item_Class
18637     * @see elm_slideshow_item_sorted_insert()
18638     *
18639     * @ingroup Slideshow
18640     */
18641    EAPI Elm_Slideshow_Item *elm_slideshow_item_add(Evas_Object *obj, const Elm_Slideshow_Item_Class *itc, const void *data) EINA_ARG_NONNULL(1);
18642
18643    /**
18644     * Insert a new item into the given slideshow widget, using the @p func
18645     * function to sort items (by item handles).
18646     *
18647     * @param obj The slideshow object
18648     * @param itc The item class for the item
18649     * @param data The item's data
18650     * @param func The comparing function to be used to sort slideshow
18651     * items <b>by #Elm_Slideshow_Item item handles</b>
18652     * @return Returns The slideshow item handle, on success, or
18653     * @c NULL, on errors
18654     *
18655     * Add a new item to @p obj's internal list of items, in a position
18656     * determined by the @p func comparing function. The item's class
18657     * must contain the function really fetching the image object to
18658     * show for this item, which could be an Evas image object or an
18659     * Elementary photo, for example. The @p data parameter is going to
18660     * be passed to both class functions of the item.
18661     *
18662     * @see #Elm_Slideshow_Item_Class
18663     * @see elm_slideshow_item_add()
18664     *
18665     * @ingroup Slideshow
18666     */
18667    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);
18668
18669    /**
18670     * Display a given slideshow widget's item, programmatically.
18671     *
18672     * @param obj The slideshow object
18673     * @param item The item to display on @p obj's viewport
18674     *
18675     * The change between the current item and @p item will use the
18676     * transition @p obj is set to use (@see
18677     * elm_slideshow_transition_set()).
18678     *
18679     * @ingroup Slideshow
18680     */
18681    EAPI void                elm_slideshow_show(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
18682
18683    /**
18684     * Slide to the @b next item, in a given slideshow widget
18685     *
18686     * @param obj The slideshow object
18687     *
18688     * The sliding animation @p obj is set to use will be the
18689     * transition effect used, after this call is issued.
18690     *
18691     * @note If the end of the slideshow's internal list of items is
18692     * reached, it'll wrap around to the list's beginning, again.
18693     *
18694     * @ingroup Slideshow
18695     */
18696    EAPI void                elm_slideshow_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
18697
18698    /**
18699     * Slide to the @b previous item, in a given slideshow widget
18700     *
18701     * @param obj The slideshow object
18702     *
18703     * The sliding animation @p obj is set to use will be the
18704     * transition effect used, after this call is issued.
18705     *
18706     * @note If the beginning of the slideshow's internal list of items
18707     * is reached, it'll wrap around to the list's end, again.
18708     *
18709     * @ingroup Slideshow
18710     */
18711    EAPI void                elm_slideshow_previous(Evas_Object *obj) EINA_ARG_NONNULL(1);
18712
18713    /**
18714     * Returns the list of sliding transition/effect names available, for a
18715     * given slideshow widget.
18716     *
18717     * @param obj The slideshow object
18718     * @return The list of transitions (list of @b stringshared strings
18719     * as data)
18720     *
18721     * The transitions, which come from @p obj's theme, must be an EDC
18722     * data item named @c "transitions" on the theme file, with (prefix)
18723     * names of EDC programs actually implementing them.
18724     *
18725     * The available transitions for slideshows on the default theme are:
18726     * - @c "fade" - the current item fades out, while the new one
18727     *   fades in to the slideshow's viewport.
18728     * - @c "black_fade" - the current item fades to black, and just
18729     *   then, the new item will fade in.
18730     * - @c "horizontal" - the current item slides horizontally, until
18731     *   it gets out of the slideshow's viewport, while the new item
18732     *   comes from the left to take its place.
18733     * - @c "vertical" - the current item slides vertically, until it
18734     *   gets out of the slideshow's viewport, while the new item comes
18735     *   from the bottom to take its place.
18736     * - @c "square" - the new item starts to appear from the middle of
18737     *   the current one, but with a tiny size, growing until its
18738     *   target (full) size and covering the old one.
18739     *
18740     * @warning The stringshared strings get no new references
18741     * exclusive to the user grabbing the list, here, so if you'd like
18742     * to use them out of this call's context, you'd better @c
18743     * eina_stringshare_ref() them.
18744     *
18745     * @see elm_slideshow_transition_set()
18746     *
18747     * @ingroup Slideshow
18748     */
18749    EAPI const Eina_List    *elm_slideshow_transitions_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18750
18751    /**
18752     * Set the current slide transition/effect in use for a given
18753     * slideshow widget
18754     *
18755     * @param obj The slideshow object
18756     * @param transition The new transition's name string
18757     *
18758     * If @p transition is implemented in @p obj's theme (i.e., is
18759     * contained in the list returned by
18760     * elm_slideshow_transitions_get()), this new sliding effect will
18761     * be used on the widget.
18762     *
18763     * @see elm_slideshow_transitions_get() for more details
18764     *
18765     * @ingroup Slideshow
18766     */
18767    EAPI void                elm_slideshow_transition_set(Evas_Object *obj, const char *transition) EINA_ARG_NONNULL(1);
18768
18769    /**
18770     * Get the current slide transition/effect in use for a given
18771     * slideshow widget
18772     *
18773     * @param obj The slideshow object
18774     * @return The current transition's name
18775     *
18776     * @see elm_slideshow_transition_set() for more details
18777     *
18778     * @ingroup Slideshow
18779     */
18780    EAPI const char         *elm_slideshow_transition_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18781
18782    /**
18783     * Set the interval between each image transition on a given
18784     * slideshow widget, <b>and start the slideshow, itself</b>
18785     *
18786     * @param obj The slideshow object
18787     * @param timeout The new displaying timeout for images
18788     *
18789     * After this call, the slideshow widget will start cycling its
18790     * view, sequentially and automatically, with the images of the
18791     * items it has. The time between each new image displayed is going
18792     * to be @p timeout, in @b seconds. If a different timeout was set
18793     * previously and an slideshow was in progress, it will continue
18794     * with the new time between transitions, after this call.
18795     *
18796     * @note A value less than or equal to 0 on @p timeout will disable
18797     * the widget's internal timer, thus halting any slideshow which
18798     * could be happening on @p obj.
18799     *
18800     * @see elm_slideshow_timeout_get()
18801     *
18802     * @ingroup Slideshow
18803     */
18804    EAPI void                elm_slideshow_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
18805
18806    /**
18807     * Get the interval set for image transitions on a given slideshow
18808     * widget.
18809     *
18810     * @param obj The slideshow object
18811     * @return Returns the timeout set on it
18812     *
18813     * @see elm_slideshow_timeout_set() for more details
18814     *
18815     * @ingroup Slideshow
18816     */
18817    EAPI double              elm_slideshow_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18818
18819    /**
18820     * Set if, after a slideshow is started, for a given slideshow
18821     * widget, its items should be displayed cyclically or not.
18822     *
18823     * @param obj The slideshow object
18824     * @param loop Use @c EINA_TRUE to make it cycle through items or
18825     * @c EINA_FALSE for it to stop at the end of @p obj's internal
18826     * list of items
18827     *
18828     * @note elm_slideshow_next() and elm_slideshow_previous() will @b
18829     * ignore what is set by this functions, i.e., they'll @b always
18830     * cycle through items. This affects only the "automatic"
18831     * slideshow, as set by elm_slideshow_timeout_set().
18832     *
18833     * @see elm_slideshow_loop_get()
18834     *
18835     * @ingroup Slideshow
18836     */
18837    EAPI void                elm_slideshow_loop_set(Evas_Object *obj, Eina_Bool loop) EINA_ARG_NONNULL(1);
18838
18839    /**
18840     * Get if, after a slideshow is started, for a given slideshow
18841     * widget, its items are to be displayed cyclically or not.
18842     *
18843     * @param obj The slideshow object
18844     * @return @c EINA_TRUE, if the items in @p obj will be cycled
18845     * through or @c EINA_FALSE, otherwise
18846     *
18847     * @see elm_slideshow_loop_set() for more details
18848     *
18849     * @ingroup Slideshow
18850     */
18851    EAPI Eina_Bool           elm_slideshow_loop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18852
18853    /**
18854     * Remove all items from a given slideshow widget
18855     *
18856     * @param obj The slideshow object
18857     *
18858     * This removes (and deletes) all items in @p obj, leaving it
18859     * empty.
18860     *
18861     * @see elm_slideshow_item_del(), to remove just one item.
18862     *
18863     * @ingroup Slideshow
18864     */
18865    EAPI void                elm_slideshow_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
18866
18867    /**
18868     * Get the internal list of items in a given slideshow widget.
18869     *
18870     * @param obj The slideshow object
18871     * @return The list of items (#Elm_Slideshow_Item as data) or
18872     * @c NULL on errors.
18873     *
18874     * This list is @b not to be modified in any way and must not be
18875     * freed. Use the list members with functions like
18876     * elm_slideshow_item_del(), elm_slideshow_item_data_get().
18877     *
18878     * @warning This list is only valid until @p obj object's internal
18879     * items list is changed. It should be fetched again with another
18880     * call to this function when changes happen.
18881     *
18882     * @ingroup Slideshow
18883     */
18884    EAPI const Eina_List    *elm_slideshow_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18885
18886    /**
18887     * Delete a given item from a slideshow widget.
18888     *
18889     * @param item The slideshow item
18890     *
18891     * @ingroup Slideshow
18892     */
18893    EAPI void                elm_slideshow_item_del(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
18894
18895    /**
18896     * Return the data associated with a given slideshow item
18897     *
18898     * @param item The slideshow item
18899     * @return Returns the data associated to this item
18900     *
18901     * @ingroup Slideshow
18902     */
18903    EAPI void               *elm_slideshow_item_data_get(const Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
18904
18905    /**
18906     * Returns the currently displayed item, in a given slideshow widget
18907     *
18908     * @param obj The slideshow object
18909     * @return A handle to the item being displayed in @p obj or
18910     * @c NULL, if none is (and on errors)
18911     *
18912     * @ingroup Slideshow
18913     */
18914    EAPI Elm_Slideshow_Item *elm_slideshow_item_current_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18915
18916    /**
18917     * Get the real Evas object created to implement the view of a
18918     * given slideshow item
18919     *
18920     * @param item The slideshow item.
18921     * @return the Evas object implementing this item's view.
18922     *
18923     * This returns the actual Evas object used to implement the
18924     * specified slideshow item's view. This may be @c NULL, as it may
18925     * not have been created or may have been deleted, at any time, by
18926     * the slideshow. <b>Do not modify this object</b> (move, resize,
18927     * show, hide, etc.), as the slideshow is controlling it. This
18928     * function is for querying, emitting custom signals or hooking
18929     * lower level callbacks for events on that object. Do not delete
18930     * this object under any circumstances.
18931     *
18932     * @see elm_slideshow_item_data_get()
18933     *
18934     * @ingroup Slideshow
18935     */
18936    EAPI Evas_Object*        elm_slideshow_item_object_get(const Elm_Slideshow_Item* item) EINA_ARG_NONNULL(1);
18937
18938    /**
18939     * Get the the item, in a given slideshow widget, placed at
18940     * position @p nth, in its internal items list
18941     *
18942     * @param obj The slideshow object
18943     * @param nth The number of the item to grab a handle to (0 being
18944     * the first)
18945     * @return The item stored in @p obj at position @p nth or @c NULL,
18946     * if there's no item with that index (and on errors)
18947     *
18948     * @ingroup Slideshow
18949     */
18950    EAPI Elm_Slideshow_Item *elm_slideshow_item_nth_get(const Evas_Object *obj, unsigned int nth) EINA_ARG_NONNULL(1);
18951
18952    /**
18953     * Set the current slide layout in use for a given slideshow widget
18954     *
18955     * @param obj The slideshow object
18956     * @param layout The new layout's name string
18957     *
18958     * If @p layout is implemented in @p obj's theme (i.e., is contained
18959     * in the list returned by elm_slideshow_layouts_get()), this new
18960     * images layout will be used on the widget.
18961     *
18962     * @see elm_slideshow_layouts_get() for more details
18963     *
18964     * @ingroup Slideshow
18965     */
18966    EAPI void                elm_slideshow_layout_set(Evas_Object *obj, const char *layout) EINA_ARG_NONNULL(1);
18967
18968    /**
18969     * Get the current slide layout in use for a given slideshow widget
18970     *
18971     * @param obj The slideshow object
18972     * @return The current layout's name
18973     *
18974     * @see elm_slideshow_layout_set() for more details
18975     *
18976     * @ingroup Slideshow
18977     */
18978    EAPI const char         *elm_slideshow_layout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18979
18980    /**
18981     * Returns the list of @b layout names available, for a given
18982     * slideshow widget.
18983     *
18984     * @param obj The slideshow object
18985     * @return The list of layouts (list of @b stringshared strings
18986     * as data)
18987     *
18988     * Slideshow layouts will change how the widget is to dispose each
18989     * image item in its viewport, with regard to cropping, scaling,
18990     * etc.
18991     *
18992     * The layouts, which come from @p obj's theme, must be an EDC
18993     * data item name @c "layouts" on the theme file, with (prefix)
18994     * names of EDC programs actually implementing them.
18995     *
18996     * The available layouts for slideshows on the default theme are:
18997     * - @c "fullscreen" - item images with original aspect, scaled to
18998     *   touch top and down slideshow borders or, if the image's heigh
18999     *   is not enough, left and right slideshow borders.
19000     * - @c "not_fullscreen" - the same behavior as the @c "fullscreen"
19001     *   one, but always leaving 10% of the slideshow's dimensions of
19002     *   distance between the item image's borders and the slideshow
19003     *   borders, for each axis.
19004     *
19005     * @warning The stringshared strings get no new references
19006     * exclusive to the user grabbing the list, here, so if you'd like
19007     * to use them out of this call's context, you'd better @c
19008     * eina_stringshare_ref() them.
19009     *
19010     * @see elm_slideshow_layout_set()
19011     *
19012     * @ingroup Slideshow
19013     */
19014    EAPI const Eina_List    *elm_slideshow_layouts_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19015
19016    /**
19017     * Set the number of items to cache, on a given slideshow widget,
19018     * <b>before the current item</b>
19019     *
19020     * @param obj The slideshow object
19021     * @param count Number of items to cache before the current one
19022     *
19023     * The default value for this property is @c 2. See
19024     * @ref Slideshow_Caching "slideshow caching" for more details.
19025     *
19026     * @see elm_slideshow_cache_before_get()
19027     *
19028     * @ingroup Slideshow
19029     */
19030    EAPI void                elm_slideshow_cache_before_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
19031
19032    /**
19033     * Retrieve the number of items to cache, on a given slideshow widget,
19034     * <b>before the current item</b>
19035     *
19036     * @param obj The slideshow object
19037     * @return The number of items set to be cached before the current one
19038     *
19039     * @see elm_slideshow_cache_before_set() for more details
19040     *
19041     * @ingroup Slideshow
19042     */
19043    EAPI int                 elm_slideshow_cache_before_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19044
19045    /**
19046     * Set the number of items to cache, on a given slideshow widget,
19047     * <b>after the current item</b>
19048     *
19049     * @param obj The slideshow object
19050     * @param count Number of items to cache after the current one
19051     *
19052     * The default value for this property is @c 2. See
19053     * @ref Slideshow_Caching "slideshow caching" for more details.
19054     *
19055     * @see elm_slideshow_cache_after_get()
19056     *
19057     * @ingroup Slideshow
19058     */
19059    EAPI void                elm_slideshow_cache_after_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
19060
19061    /**
19062     * Retrieve the number of items to cache, on a given slideshow widget,
19063     * <b>after the current item</b>
19064     *
19065     * @param obj The slideshow object
19066     * @return The number of items set to be cached after the current one
19067     *
19068     * @see elm_slideshow_cache_after_set() for more details
19069     *
19070     * @ingroup Slideshow
19071     */
19072    EAPI int                 elm_slideshow_cache_after_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19073
19074    /**
19075     * Get the number of items stored in a given slideshow widget
19076     *
19077     * @param obj The slideshow object
19078     * @return The number of items on @p obj, at the moment of this call
19079     *
19080     * @ingroup Slideshow
19081     */
19082    EAPI unsigned int        elm_slideshow_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19083
19084    /**
19085     * @}
19086     */
19087
19088    /**
19089     * @defgroup Fileselector File Selector
19090     *
19091     * @image html img/widget/fileselector/preview-00.png
19092     * @image latex img/widget/fileselector/preview-00.eps
19093     *
19094     * A file selector is a widget that allows a user to navigate
19095     * through a file system, reporting file selections back via its
19096     * API.
19097     *
19098     * It contains shortcut buttons for home directory (@c ~) and to
19099     * jump one directory upwards (..), as well as cancel/ok buttons to
19100     * confirm/cancel a given selection. After either one of those two
19101     * former actions, the file selector will issue its @c "done" smart
19102     * callback.
19103     *
19104     * There's a text entry on it, too, showing the name of the current
19105     * selection. There's the possibility of making it editable, so it
19106     * is useful on file saving dialogs on applications, where one
19107     * gives a file name to save contents to, in a given directory in
19108     * the system. This custom file name will be reported on the @c
19109     * "done" smart callback (explained in sequence).
19110     *
19111     * Finally, it has a view to display file system items into in two
19112     * possible forms:
19113     * - list
19114     * - grid
19115     *
19116     * If Elementary is built with support of the Ethumb thumbnailing
19117     * library, the second form of view will display preview thumbnails
19118     * of files which it supports.
19119     *
19120     * Smart callbacks one can register to:
19121     *
19122     * - @c "selected" - the user has clicked on a file (when not in
19123     *      folders-only mode) or directory (when in folders-only mode)
19124     * - @c "directory,open" - the list has been populated with new
19125     *      content (@c event_info is a pointer to the directory's
19126     *      path, a @b stringshared string)
19127     * - @c "done" - the user has clicked on the "ok" or "cancel"
19128     *      buttons (@c event_info is a pointer to the selection's
19129     *      path, a @b stringshared string)
19130     *
19131     * Here is an example on its usage:
19132     * @li @ref fileselector_example
19133     */
19134
19135    /**
19136     * @addtogroup Fileselector
19137     * @{
19138     */
19139
19140    /**
19141     * Defines how a file selector widget is to layout its contents
19142     * (file system entries).
19143     */
19144    typedef enum _Elm_Fileselector_Mode
19145      {
19146         ELM_FILESELECTOR_LIST = 0, /**< layout as a list */
19147         ELM_FILESELECTOR_GRID, /**< layout as a grid */
19148         ELM_FILESELECTOR_LAST /**< sentinel (helper) value, not used */
19149      } Elm_Fileselector_Mode;
19150
19151    /**
19152     * Add a new file selector widget to the given parent Elementary
19153     * (container) object
19154     *
19155     * @param parent The parent object
19156     * @return a new file selector widget handle or @c NULL, on errors
19157     *
19158     * This function inserts a new file selector widget on the canvas.
19159     *
19160     * @ingroup Fileselector
19161     */
19162    EAPI Evas_Object          *elm_fileselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19163
19164    /**
19165     * Enable/disable the file name entry box where the user can type
19166     * in a name for a file, in a given file selector widget
19167     *
19168     * @param obj The file selector object
19169     * @param is_save @c EINA_TRUE to make the file selector a "saving
19170     * dialog", @c EINA_FALSE otherwise
19171     *
19172     * Having the entry editable is useful on file saving dialogs on
19173     * applications, where one gives a file name to save contents to,
19174     * in a given directory in the system. This custom file name will
19175     * be reported on the @c "done" smart callback.
19176     *
19177     * @see elm_fileselector_is_save_get()
19178     *
19179     * @ingroup Fileselector
19180     */
19181    EAPI void                  elm_fileselector_is_save_set(Evas_Object *obj, Eina_Bool is_save) EINA_ARG_NONNULL(1);
19182
19183    /**
19184     * Get whether the given file selector is in "saving dialog" mode
19185     *
19186     * @param obj The file selector object
19187     * @return @c EINA_TRUE, if the file selector is in "saving dialog"
19188     * mode, @c EINA_FALSE otherwise (and on errors)
19189     *
19190     * @see elm_fileselector_is_save_set() for more details
19191     *
19192     * @ingroup Fileselector
19193     */
19194    EAPI Eina_Bool             elm_fileselector_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19195
19196    /**
19197     * Enable/disable folder-only view for a given file selector widget
19198     *
19199     * @param obj The file selector object
19200     * @param only @c EINA_TRUE to make @p obj only display
19201     * directories, @c EINA_FALSE to make files to be displayed in it
19202     * too
19203     *
19204     * If enabled, the widget's view will only display folder items,
19205     * naturally.
19206     *
19207     * @see elm_fileselector_folder_only_get()
19208     *
19209     * @ingroup Fileselector
19210     */
19211    EAPI void                  elm_fileselector_folder_only_set(Evas_Object *obj, Eina_Bool only) EINA_ARG_NONNULL(1);
19212
19213    /**
19214     * Get whether folder-only view is set for a given file selector
19215     * widget
19216     *
19217     * @param obj The file selector object
19218     * @return only @c EINA_TRUE if @p obj is only displaying
19219     * directories, @c EINA_FALSE if files are being displayed in it
19220     * too (and on errors)
19221     *
19222     * @see elm_fileselector_folder_only_get()
19223     *
19224     * @ingroup Fileselector
19225     */
19226    EAPI Eina_Bool             elm_fileselector_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19227
19228    /**
19229     * Enable/disable the "ok" and "cancel" buttons on a given file
19230     * selector widget
19231     *
19232     * @param obj The file selector object
19233     * @param only @c EINA_TRUE to show them, @c EINA_FALSE to hide.
19234     *
19235     * @note A file selector without those buttons will never emit the
19236     * @c "done" smart event, and is only usable if one is just hooking
19237     * to the other two events.
19238     *
19239     * @see elm_fileselector_buttons_ok_cancel_get()
19240     *
19241     * @ingroup Fileselector
19242     */
19243    EAPI void                  elm_fileselector_buttons_ok_cancel_set(Evas_Object *obj, Eina_Bool buttons) EINA_ARG_NONNULL(1);
19244
19245    /**
19246     * Get whether the "ok" and "cancel" buttons on a given file
19247     * selector widget are being shown.
19248     *
19249     * @param obj The file selector object
19250     * @return @c EINA_TRUE if they are being shown, @c EINA_FALSE
19251     * otherwise (and on errors)
19252     *
19253     * @see elm_fileselector_buttons_ok_cancel_set() for more details
19254     *
19255     * @ingroup Fileselector
19256     */
19257    EAPI Eina_Bool             elm_fileselector_buttons_ok_cancel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19258
19259    /**
19260     * Enable/disable a tree view in the given file selector widget,
19261     * <b>if it's in @c #ELM_FILESELECTOR_LIST mode</b>
19262     *
19263     * @param obj The file selector object
19264     * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
19265     * disable
19266     *
19267     * In a tree view, arrows are created on the sides of directories,
19268     * allowing them to expand in place.
19269     *
19270     * @note If it's in other mode, the changes made by this function
19271     * will only be visible when one switches back to "list" mode.
19272     *
19273     * @see elm_fileselector_expandable_get()
19274     *
19275     * @ingroup Fileselector
19276     */
19277    EAPI void                  elm_fileselector_expandable_set(Evas_Object *obj, Eina_Bool expand) EINA_ARG_NONNULL(1);
19278
19279    /**
19280     * Get whether tree view is enabled for the given file selector
19281     * widget
19282     *
19283     * @param obj The file selector object
19284     * @return @c EINA_TRUE if @p obj is in tree view, @c EINA_FALSE
19285     * otherwise (and or errors)
19286     *
19287     * @see elm_fileselector_expandable_set() for more details
19288     *
19289     * @ingroup Fileselector
19290     */
19291    EAPI Eina_Bool             elm_fileselector_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19292
19293    /**
19294     * Set, programmatically, the @b directory that a given file
19295     * selector widget will display contents from
19296     *
19297     * @param obj The file selector object
19298     * @param path The path to display in @p obj
19299     *
19300     * This will change the @b directory that @p obj is displaying. It
19301     * will also clear the text entry area on the @p obj object, which
19302     * displays select files' names.
19303     *
19304     * @see elm_fileselector_path_get()
19305     *
19306     * @ingroup Fileselector
19307     */
19308    EAPI void                  elm_fileselector_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
19309
19310    /**
19311     * Get the parent directory's path that a given file selector
19312     * widget is displaying
19313     *
19314     * @param obj The file selector object
19315     * @return The (full) path of the directory the file selector is
19316     * displaying, a @b stringshared string
19317     *
19318     * @see elm_fileselector_path_set()
19319     *
19320     * @ingroup Fileselector
19321     */
19322    EAPI const char           *elm_fileselector_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19323
19324    /**
19325     * Set, programmatically, the currently selected file/directory in
19326     * the given file selector widget
19327     *
19328     * @param obj The file selector object
19329     * @param path The (full) path to a file or directory
19330     * @return @c EINA_TRUE on success, @c EINA_FALSE on failure. The
19331     * latter case occurs if the directory or file pointed to do not
19332     * exist.
19333     *
19334     * @see elm_fileselector_selected_get()
19335     *
19336     * @ingroup Fileselector
19337     */
19338    EAPI Eina_Bool             elm_fileselector_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
19339
19340    /**
19341     * Get the currently selected item's (full) path, in the given file
19342     * selector widget
19343     *
19344     * @param obj The file selector object
19345     * @return The absolute path of the selected item, a @b
19346     * stringshared string
19347     *
19348     * @note Custom editions on @p obj object's text entry, if made,
19349     * will appear on the return string of this function, naturally.
19350     *
19351     * @see elm_fileselector_selected_set() for more details
19352     *
19353     * @ingroup Fileselector
19354     */
19355    EAPI const char           *elm_fileselector_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19356
19357    /**
19358     * Set the mode in which a given file selector widget will display
19359     * (layout) file system entries in its view
19360     *
19361     * @param obj The file selector object
19362     * @param mode The mode of the fileselector, being it one of
19363     * #ELM_FILESELECTOR_LIST (default) or #ELM_FILESELECTOR_GRID. The
19364     * first one, naturally, will display the files in a list. The
19365     * latter will make the widget to display its entries in a grid
19366     * form.
19367     *
19368     * @note By using elm_fileselector_expandable_set(), the user may
19369     * trigger a tree view for that list.
19370     *
19371     * @note If Elementary is built with support of the Ethumb
19372     * thumbnailing library, the second form of view will display
19373     * preview thumbnails of files which it supports. You must have
19374     * elm_need_ethumb() called in your Elementary for thumbnailing to
19375     * work, though.
19376     *
19377     * @see elm_fileselector_expandable_set().
19378     * @see elm_fileselector_mode_get().
19379     *
19380     * @ingroup Fileselector
19381     */
19382    EAPI void                  elm_fileselector_mode_set(Evas_Object *obj, Elm_Fileselector_Mode mode) EINA_ARG_NONNULL(1);
19383
19384    /**
19385     * Get the mode in which a given file selector widget is displaying
19386     * (layouting) file system entries in its view
19387     *
19388     * @param obj The fileselector object
19389     * @return The mode in which the fileselector is at
19390     *
19391     * @see elm_fileselector_mode_set() for more details
19392     *
19393     * @ingroup Fileselector
19394     */
19395    EAPI Elm_Fileselector_Mode elm_fileselector_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19396
19397    /**
19398     * @}
19399     */
19400
19401    /**
19402     * @defgroup Progressbar Progress bar
19403     *
19404     * The progress bar is a widget for visually representing the
19405     * progress status of a given job/task.
19406     *
19407     * A progress bar may be horizontal or vertical. It may display an
19408     * icon besides it, as well as primary and @b units labels. The
19409     * former is meant to label the widget as a whole, while the
19410     * latter, which is formatted with floating point values (and thus
19411     * accepts a <c>printf</c>-style format string, like <c>"%1.2f
19412     * units"</c>), is meant to label the widget's <b>progress
19413     * value</b>. Label, icon and unit strings/objects are @b optional
19414     * for progress bars.
19415     *
19416     * A progress bar may be @b inverted, in which state it gets its
19417     * values inverted, with high values being on the left or top and
19418     * low values on the right or bottom, as opposed to normally have
19419     * the low values on the former and high values on the latter,
19420     * respectively, for horizontal and vertical modes.
19421     *
19422     * The @b span of the progress, as set by
19423     * elm_progressbar_span_size_set(), is its length (horizontally or
19424     * vertically), unless one puts size hints on the widget to expand
19425     * on desired directions, by any container. That length will be
19426     * scaled by the object or applications scaling factor. At any
19427     * point code can query the progress bar for its value with
19428     * elm_progressbar_value_get().
19429     *
19430     * Available widget styles for progress bars:
19431     * - @c "default"
19432     * - @c "wheel" (simple style, no text, no progression, only
19433     *      "pulse" effect is available)
19434     *
19435     * Here is an example on its usage:
19436     * @li @ref progressbar_example
19437     */
19438
19439    /**
19440     * Add a new progress bar widget to the given parent Elementary
19441     * (container) object
19442     *
19443     * @param parent The parent object
19444     * @return a new progress bar widget handle or @c NULL, on errors
19445     *
19446     * This function inserts a new progress bar widget on the canvas.
19447     *
19448     * @ingroup Progressbar
19449     */
19450    EAPI Evas_Object *elm_progressbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19451
19452    /**
19453     * Set whether a given progress bar widget is at "pulsing mode" or
19454     * not.
19455     *
19456     * @param obj The progress bar object
19457     * @param pulse @c EINA_TRUE to put @p obj in pulsing mode,
19458     * @c EINA_FALSE to put it back to its default one
19459     *
19460     * By default, progress bars will display values from the low to
19461     * high value boundaries. There are, though, contexts in which the
19462     * state of progression of a given task is @b unknown.  For those,
19463     * one can set a progress bar widget to a "pulsing state", to give
19464     * the user an idea that some computation is being held, but
19465     * without exact progress values. In the default theme it will
19466     * animate its bar with the contents filling in constantly and back
19467     * to non-filled, in a loop. To start and stop this pulsing
19468     * animation, one has to explicitly call elm_progressbar_pulse().
19469     *
19470     * @see elm_progressbar_pulse_get()
19471     * @see elm_progressbar_pulse()
19472     *
19473     * @ingroup Progressbar
19474     */
19475    EAPI void         elm_progressbar_pulse_set(Evas_Object *obj, Eina_Bool pulse) EINA_ARG_NONNULL(1);
19476
19477    /**
19478     * Get whether a given progress bar widget is at "pulsing mode" or
19479     * not.
19480     *
19481     * @param obj The progress bar object
19482     * @return @c EINA_TRUE, if @p obj is in pulsing mode, @c EINA_FALSE
19483     * if it's in the default one (and on errors)
19484     *
19485     * @ingroup Progressbar
19486     */
19487    EAPI Eina_Bool    elm_progressbar_pulse_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19488
19489    /**
19490     * Start/stop a given progress bar "pulsing" animation, if its
19491     * under that mode
19492     *
19493     * @param obj The progress bar object
19494     * @param state @c EINA_TRUE, to @b start the pulsing animation,
19495     * @c EINA_FALSE to @b stop it
19496     *
19497     * @note This call won't do anything if @p obj is not under "pulsing mode".
19498     *
19499     * @see elm_progressbar_pulse_set() for more details.
19500     *
19501     * @ingroup Progressbar
19502     */
19503    EAPI void         elm_progressbar_pulse(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
19504
19505    /**
19506     * Set the progress value (in percentage) on a given progress bar
19507     * widget
19508     *
19509     * @param obj The progress bar object
19510     * @param val The progress value (@b must be between @c 0.0 and @c
19511     * 1.0)
19512     *
19513     * Use this call to set progress bar levels.
19514     *
19515     * @note If you passes a value out of the specified range for @p
19516     * val, it will be interpreted as the @b closest of the @b boundary
19517     * values in the range.
19518     *
19519     * @ingroup Progressbar
19520     */
19521    EAPI void         elm_progressbar_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
19522
19523    /**
19524     * Get the progress value (in percentage) on a given progress bar
19525     * widget
19526     *
19527     * @param obj The progress bar object
19528     * @return The value of the progressbar
19529     *
19530     * @see elm_progressbar_value_set() for more details
19531     *
19532     * @ingroup Progressbar
19533     */
19534    EAPI double       elm_progressbar_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19535
19536    /**
19537     * Set the label of a given progress bar widget
19538     *
19539     * @param obj The progress bar object
19540     * @param label The text label string, in UTF-8
19541     *
19542     * @ingroup Progressbar
19543     * @deprecated use elm_object_text_set() instead.
19544     */
19545    EINA_DEPRECATED EAPI void         elm_progressbar_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
19546
19547    /**
19548     * Get the label of a given progress bar widget
19549     *
19550     * @param obj The progressbar object
19551     * @return The text label string, in UTF-8
19552     *
19553     * @ingroup Progressbar
19554     * @deprecated use elm_object_text_set() instead.
19555     */
19556    EINA_DEPRECATED EAPI const char  *elm_progressbar_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19557
19558    /**
19559     * Set the icon object of a given progress bar widget
19560     *
19561     * @param obj The progress bar object
19562     * @param icon The icon object
19563     *
19564     * Use this call to decorate @p obj with an icon next to it.
19565     *
19566     * @note Once the icon object is set, a previously set one will be
19567     * deleted. If you want to keep that old content object, use the
19568     * elm_progressbar_icon_unset() function.
19569     *
19570     * @see elm_progressbar_icon_get()
19571     *
19572     * @ingroup Progressbar
19573     */
19574    EAPI void         elm_progressbar_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
19575
19576    /**
19577     * Retrieve the icon object set for a given progress bar widget
19578     *
19579     * @param obj The progress bar object
19580     * @return The icon object's handle, if @p obj had one set, or @c NULL,
19581     * otherwise (and on errors)
19582     *
19583     * @see elm_progressbar_icon_set() for more details
19584     *
19585     * @ingroup Progressbar
19586     */
19587    EAPI Evas_Object *elm_progressbar_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19588
19589    /**
19590     * Unset an icon set on a given progress bar widget
19591     *
19592     * @param obj The progress bar object
19593     * @return The icon object that was being used, if any was set, or
19594     * @c NULL, otherwise (and on errors)
19595     *
19596     * This call will unparent and return the icon object which was set
19597     * for this widget, previously, on success.
19598     *
19599     * @see elm_progressbar_icon_set() for more details
19600     *
19601     * @ingroup Progressbar
19602     */
19603    EAPI Evas_Object *elm_progressbar_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
19604
19605    /**
19606     * Set the (exact) length of the bar region of a given progress bar
19607     * widget
19608     *
19609     * @param obj The progress bar object
19610     * @param size The length of the progress bar's bar region
19611     *
19612     * This sets the minimum width (when in horizontal mode) or height
19613     * (when in vertical mode) of the actual bar area of the progress
19614     * bar @p obj. This in turn affects the object's minimum size. Use
19615     * this when you're not setting other size hints expanding on the
19616     * given direction (like weight and alignment hints) and you would
19617     * like it to have a specific size.
19618     *
19619     * @note Icon, label and unit text around @p obj will require their
19620     * own space, which will make @p obj to require more the @p size,
19621     * actually.
19622     *
19623     * @see elm_progressbar_span_size_get()
19624     *
19625     * @ingroup Progressbar
19626     */
19627    EAPI void         elm_progressbar_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
19628
19629    /**
19630     * Get the length set for the bar region of a given progress bar
19631     * widget
19632     *
19633     * @param obj The progress bar object
19634     * @return The length of the progress bar's bar region
19635     *
19636     * If that size was not set previously, with
19637     * elm_progressbar_span_size_set(), this call will return @c 0.
19638     *
19639     * @ingroup Progressbar
19640     */
19641    EAPI Evas_Coord   elm_progressbar_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19642
19643    /**
19644     * Set the format string for a given progress bar widget's units
19645     * label
19646     *
19647     * @param obj The progress bar object
19648     * @param format The format string for @p obj's units label
19649     *
19650     * If @c NULL is passed on @p format, it will make @p obj's units
19651     * area to be hidden completely. If not, it'll set the <b>format
19652     * string</b> for the units label's @b text. The units label is
19653     * provided a floating point value, so the units text is up display
19654     * at most one floating point falue. Note that the units label is
19655     * optional. Use a format string such as "%1.2f meters" for
19656     * example.
19657     *
19658     * @note The default format string for a progress bar is an integer
19659     * percentage, as in @c "%.0f %%".
19660     *
19661     * @see elm_progressbar_unit_format_get()
19662     *
19663     * @ingroup Progressbar
19664     */
19665    EAPI void         elm_progressbar_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
19666
19667    /**
19668     * Retrieve the format string set for a given progress bar widget's
19669     * units label
19670     *
19671     * @param obj The progress bar object
19672     * @return The format set string for @p obj's units label or
19673     * @c NULL, if none was set (and on errors)
19674     *
19675     * @see elm_progressbar_unit_format_set() for more details
19676     *
19677     * @ingroup Progressbar
19678     */
19679    EAPI const char  *elm_progressbar_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19680
19681    /**
19682     * Set the orientation of a given progress bar widget
19683     *
19684     * @param obj The progress bar object
19685     * @param horizontal Use @c EINA_TRUE to make @p obj to be
19686     * @b horizontal, @c EINA_FALSE to make it @b vertical
19687     *
19688     * Use this function to change how your progress bar is to be
19689     * disposed: vertically or horizontally.
19690     *
19691     * @see elm_progressbar_horizontal_get()
19692     *
19693     * @ingroup Progressbar
19694     */
19695    EAPI void         elm_progressbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
19696
19697    /**
19698     * Retrieve the orientation of a given progress bar widget
19699     *
19700     * @param obj The progress bar object
19701     * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
19702     * @c EINA_FALSE if it's @b vertical (and on errors)
19703     *
19704     * @see elm_progressbar_horizontal_set() for more details
19705     *
19706     * @ingroup Progressbar
19707     */
19708    EAPI Eina_Bool    elm_progressbar_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19709
19710    /**
19711     * Invert a given progress bar widget's displaying values order
19712     *
19713     * @param obj The progress bar object
19714     * @param inverted Use @c EINA_TRUE to make @p obj inverted,
19715     * @c EINA_FALSE to bring it back to default, non-inverted values.
19716     *
19717     * A progress bar may be @b inverted, in which state it gets its
19718     * values inverted, with high values being on the left or top and
19719     * low values on the right or bottom, as opposed to normally have
19720     * the low values on the former and high values on the latter,
19721     * respectively, for horizontal and vertical modes.
19722     *
19723     * @see elm_progressbar_inverted_get()
19724     *
19725     * @ingroup Progressbar
19726     */
19727    EAPI void         elm_progressbar_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
19728
19729    /**
19730     * Get whether a given progress bar widget's displaying values are
19731     * inverted or not
19732     *
19733     * @param obj The progress bar object
19734     * @return @c EINA_TRUE, if @p obj has inverted values,
19735     * @c EINA_FALSE otherwise (and on errors)
19736     *
19737     * @see elm_progressbar_inverted_set() for more details
19738     *
19739     * @ingroup Progressbar
19740     */
19741    EAPI Eina_Bool    elm_progressbar_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19742
19743    /**
19744     * @defgroup Separator Separator
19745     *
19746     * @brief Separator is a very thin object used to separate other objects.
19747     *
19748     * A separator can be vertical or horizontal.
19749     *
19750     * @ref tutorial_separator is a good example of how to use a separator.
19751     * @{
19752     */
19753    /**
19754     * @brief Add a separator object to @p parent
19755     *
19756     * @param parent The parent object
19757     *
19758     * @return The separator object, or NULL upon failure
19759     */
19760    EAPI Evas_Object *elm_separator_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19761    /**
19762     * @brief Set the horizontal mode of a separator object
19763     *
19764     * @param obj The separator object
19765     * @param horizontal If true, the separator is horizontal
19766     */
19767    EAPI void         elm_separator_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
19768    /**
19769     * @brief Get the horizontal mode of a separator object
19770     *
19771     * @param obj The separator object
19772     * @return If true, the separator is horizontal
19773     *
19774     * @see elm_separator_horizontal_set()
19775     */
19776    EAPI Eina_Bool    elm_separator_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19777    /**
19778     * @}
19779     */
19780
19781    /**
19782     * @defgroup Spinner Spinner
19783     * @ingroup Elementary
19784     *
19785     * @image html img/widget/spinner/preview-00.png
19786     * @image latex img/widget/spinner/preview-00.eps
19787     *
19788     * A spinner is a widget which allows the user to increase or decrease
19789     * numeric values using arrow buttons, or edit values directly, clicking
19790     * over it and typing the new value.
19791     *
19792     * By default the spinner will not wrap and has a label
19793     * of "%.0f" (just showing the integer value of the double).
19794     *
19795     * A spinner has a label that is formatted with floating
19796     * point values and thus accepts a printf-style format string, like
19797     * “%1.2f units”.
19798     *
19799     * It also allows specific values to be replaced by pre-defined labels.
19800     *
19801     * Smart callbacks one can register to:
19802     *
19803     * - "changed" - Whenever the spinner value is changed.
19804     * - "delay,changed" - A short time after the value is changed by the user.
19805     *    This will be called only when the user stops dragging for a very short
19806     *    period or when they release their finger/mouse, so it avoids possibly
19807     *    expensive reactions to the value change.
19808     *
19809     * Available styles for it:
19810     * - @c "default";
19811     * - @c "vertical": up/down buttons at the right side and text left aligned.
19812     *
19813     * Here is an example on its usage:
19814     * @ref spinner_example
19815     */
19816
19817    /**
19818     * @addtogroup Spinner
19819     * @{
19820     */
19821
19822    /**
19823     * Add a new spinner widget to the given parent Elementary
19824     * (container) object.
19825     *
19826     * @param parent The parent object.
19827     * @return a new spinner widget handle or @c NULL, on errors.
19828     *
19829     * This function inserts a new spinner widget on the canvas.
19830     *
19831     * @ingroup Spinner
19832     *
19833     */
19834    EAPI Evas_Object *elm_spinner_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19835
19836    /**
19837     * Set the format string of the displayed label.
19838     *
19839     * @param obj The spinner object.
19840     * @param fmt The format string for the label display.
19841     *
19842     * If @c NULL, this sets the format to "%.0f". If not it sets the format
19843     * string for the label text. The label text is provided a floating point
19844     * value, so the label text can display up to 1 floating point value.
19845     * Note that this is optional.
19846     *
19847     * Use a format string such as "%1.2f meters" for example, and it will
19848     * display values like: "3.14 meters" for a value equal to 3.14159.
19849     *
19850     * Default is "%0.f".
19851     *
19852     * @see elm_spinner_label_format_get()
19853     *
19854     * @ingroup Spinner
19855     */
19856    EAPI void         elm_spinner_label_format_set(Evas_Object *obj, const char *fmt) EINA_ARG_NONNULL(1);
19857
19858    /**
19859     * Get the label format of the spinner.
19860     *
19861     * @param obj The spinner object.
19862     * @return The text label format string in UTF-8.
19863     *
19864     * @see elm_spinner_label_format_set() for details.
19865     *
19866     * @ingroup Spinner
19867     */
19868    EAPI const char  *elm_spinner_label_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19869
19870    /**
19871     * Set the minimum and maximum values for the spinner.
19872     *
19873     * @param obj The spinner object.
19874     * @param min The minimum value.
19875     * @param max The maximum value.
19876     *
19877     * Define the allowed range of values to be selected by the user.
19878     *
19879     * If actual value is less than @p min, it will be updated to @p min. If it
19880     * is bigger then @p max, will be updated to @p max. Actual value can be
19881     * get with elm_spinner_value_get().
19882     *
19883     * By default, min is equal to 0, and max is equal to 100.
19884     *
19885     * @warning Maximum must be greater than minimum.
19886     *
19887     * @see elm_spinner_min_max_get()
19888     *
19889     * @ingroup Spinner
19890     */
19891    EAPI void         elm_spinner_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
19892
19893    /**
19894     * Get the minimum and maximum values of the spinner.
19895     *
19896     * @param obj The spinner object.
19897     * @param min Pointer where to store the minimum value.
19898     * @param max Pointer where to store the maximum value.
19899     *
19900     * @note If only one value is needed, the other pointer can be passed
19901     * as @c NULL.
19902     *
19903     * @see elm_spinner_min_max_set() for details.
19904     *
19905     * @ingroup Spinner
19906     */
19907    EAPI void         elm_spinner_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
19908
19909    /**
19910     * Set the step used to increment or decrement the spinner value.
19911     *
19912     * @param obj The spinner object.
19913     * @param step The step value.
19914     *
19915     * This value will be incremented or decremented to the displayed value.
19916     * It will be incremented while the user keep right or top arrow pressed,
19917     * and will be decremented while the user keep left or bottom arrow pressed.
19918     *
19919     * The interval to increment / decrement can be set with
19920     * elm_spinner_interval_set().
19921     *
19922     * By default step value is equal to 1.
19923     *
19924     * @see elm_spinner_step_get()
19925     *
19926     * @ingroup Spinner
19927     */
19928    EAPI void         elm_spinner_step_set(Evas_Object *obj, double step) EINA_ARG_NONNULL(1);
19929
19930    /**
19931     * Get the step used to increment or decrement the spinner value.
19932     *
19933     * @param obj The spinner object.
19934     * @return The step value.
19935     *
19936     * @see elm_spinner_step_get() for more details.
19937     *
19938     * @ingroup Spinner
19939     */
19940    EAPI double       elm_spinner_step_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19941
19942    /**
19943     * Set the value the spinner displays.
19944     *
19945     * @param obj The spinner object.
19946     * @param val The value to be displayed.
19947     *
19948     * Value will be presented on the label following format specified with
19949     * elm_spinner_format_set().
19950     *
19951     * @warning The value must to be between min and max values. This values
19952     * are set by elm_spinner_min_max_set().
19953     *
19954     * @see elm_spinner_value_get().
19955     * @see elm_spinner_format_set().
19956     * @see elm_spinner_min_max_set().
19957     *
19958     * @ingroup Spinner
19959     */
19960    EAPI void         elm_spinner_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
19961
19962    /**
19963     * Get the value displayed by the spinner.
19964     *
19965     * @param obj The spinner object.
19966     * @return The value displayed.
19967     *
19968     * @see elm_spinner_value_set() for details.
19969     *
19970     * @ingroup Spinner
19971     */
19972    EAPI double       elm_spinner_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19973
19974    /**
19975     * Set whether the spinner should wrap when it reaches its
19976     * minimum or maximum value.
19977     *
19978     * @param obj The spinner object.
19979     * @param wrap @c EINA_TRUE to enable wrap or @c EINA_FALSE to
19980     * disable it.
19981     *
19982     * Disabled by default. If disabled, when the user tries to increment the
19983     * value,
19984     * but displayed value plus step value is bigger than maximum value,
19985     * the spinner
19986     * won't allow it. The same happens when the user tries to decrement it,
19987     * but the value less step is less than minimum value.
19988     *
19989     * When wrap is enabled, in such situations it will allow these changes,
19990     * but will get the value that would be less than minimum and subtracts
19991     * from maximum. Or add the value that would be more than maximum to
19992     * the minimum.
19993     *
19994     * E.g.:
19995     * @li min value = 10
19996     * @li max value = 50
19997     * @li step value = 20
19998     * @li displayed value = 20
19999     *
20000     * When the user decrement value (using left or bottom arrow), it will
20001     * displays @c 40, because max - (min - (displayed - step)) is
20002     * @c 50 - (@c 10 - (@c 20 - @c 20)) = @c 40.
20003     *
20004     * @see elm_spinner_wrap_get().
20005     *
20006     * @ingroup Spinner
20007     */
20008    EAPI void         elm_spinner_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
20009
20010    /**
20011     * Get whether the spinner should wrap when it reaches its
20012     * minimum or maximum value.
20013     *
20014     * @param obj The spinner object
20015     * @return @c EINA_TRUE means wrap is enabled. @c EINA_FALSE indicates
20016     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
20017     *
20018     * @see elm_spinner_wrap_set() for details.
20019     *
20020     * @ingroup Spinner
20021     */
20022    EAPI Eina_Bool    elm_spinner_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20023
20024    /**
20025     * Set whether the spinner can be directly edited by the user or not.
20026     *
20027     * @param obj The spinner object.
20028     * @param editable @c EINA_TRUE to allow users to edit it or @c EINA_FALSE to
20029     * don't allow users to edit it directly.
20030     *
20031     * Spinner objects can have edition @b disabled, in which state they will
20032     * be changed only by arrows.
20033     * Useful for contexts
20034     * where you don't want your users to interact with it writting the value.
20035     * Specially
20036     * when using special values, the user can see real value instead
20037     * of special label on edition.
20038     *
20039     * It's enabled by default.
20040     *
20041     * @see elm_spinner_editable_get()
20042     *
20043     * @ingroup Spinner
20044     */
20045    EAPI void         elm_spinner_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
20046
20047    /**
20048     * Get whether the spinner can be directly edited by the user or not.
20049     *
20050     * @param obj The spinner object.
20051     * @return @c EINA_TRUE means edition is enabled. @c EINA_FALSE indicates
20052     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
20053     *
20054     * @see elm_spinner_editable_set() for details.
20055     *
20056     * @ingroup Spinner
20057     */
20058    EAPI Eina_Bool    elm_spinner_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20059
20060    /**
20061     * Set a special string to display in the place of the numerical value.
20062     *
20063     * @param obj The spinner object.
20064     * @param value The value to be replaced.
20065     * @param label The label to be used.
20066     *
20067     * It's useful for cases when a user should select an item that is
20068     * better indicated by a label than a value. For example, weekdays or months.
20069     *
20070     * E.g.:
20071     * @code
20072     * sp = elm_spinner_add(win);
20073     * elm_spinner_min_max_set(sp, 1, 3);
20074     * elm_spinner_special_value_add(sp, 1, "January");
20075     * elm_spinner_special_value_add(sp, 2, "February");
20076     * elm_spinner_special_value_add(sp, 3, "March");
20077     * evas_object_show(sp);
20078     * @endcode
20079     *
20080     * @ingroup Spinner
20081     */
20082    EAPI void         elm_spinner_special_value_add(Evas_Object *obj, double value, const char *label) EINA_ARG_NONNULL(1);
20083
20084    /**
20085     * Set the interval on time updates for an user mouse button hold
20086     * on spinner widgets' arrows.
20087     *
20088     * @param obj The spinner object.
20089     * @param interval The (first) interval value in seconds.
20090     *
20091     * This interval value is @b decreased while the user holds the
20092     * mouse pointer either incrementing or decrementing spinner's value.
20093     *
20094     * This helps the user to get to a given value distant from the
20095     * current one easier/faster, as it will start to change quicker and
20096     * quicker on mouse button holds.
20097     *
20098     * The calculation for the next change interval value, starting from
20099     * the one set with this call, is the previous interval divided by
20100     * @c 1.05, so it decreases a little bit.
20101     *
20102     * The default starting interval value for automatic changes is
20103     * @c 0.85 seconds.
20104     *
20105     * @see elm_spinner_interval_get()
20106     *
20107     * @ingroup Spinner
20108     */
20109    EAPI void         elm_spinner_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
20110
20111    /**
20112     * Get the interval on time updates for an user mouse button hold
20113     * on spinner widgets' arrows.
20114     *
20115     * @param obj The spinner object.
20116     * @return The (first) interval value, in seconds, set on it.
20117     *
20118     * @see elm_spinner_interval_set() for more details.
20119     *
20120     * @ingroup Spinner
20121     */
20122    EAPI double       elm_spinner_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20123
20124    /**
20125     * @}
20126     */
20127
20128    /**
20129     * @defgroup Index Index
20130     *
20131     * @image html img/widget/index/preview-00.png
20132     * @image latex img/widget/index/preview-00.eps
20133     *
20134     * An index widget gives you an index for fast access to whichever
20135     * group of other UI items one might have. It's a list of text
20136     * items (usually letters, for alphabetically ordered access).
20137     *
20138     * Index widgets are by default hidden and just appear when the
20139     * user clicks over it's reserved area in the canvas. In its
20140     * default theme, it's an area one @ref Fingers "finger" wide on
20141     * the right side of the index widget's container.
20142     *
20143     * When items on the index are selected, smart callbacks get
20144     * called, so that its user can make other container objects to
20145     * show a given area or child object depending on the index item
20146     * selected. You'd probably be using an index together with @ref
20147     * List "lists", @ref Genlist "generic lists" or @ref Gengrid
20148     * "general grids".
20149     *
20150     * Smart events one  can add callbacks for are:
20151     * - @c "changed" - When the selected index item changes. @c
20152     *      event_info is the selected item's data pointer.
20153     * - @c "delay,changed" - When the selected index item changes, but
20154     *      after a small idling period. @c event_info is the selected
20155     *      item's data pointer.
20156     * - @c "selected" - When the user releases a mouse button and
20157     *      selects an item. @c event_info is the selected item's data
20158     *      pointer.
20159     * - @c "level,up" - when the user moves a finger from the first
20160     *      level to the second level
20161     * - @c "level,down" - when the user moves a finger from the second
20162     *      level to the first level
20163     *
20164     * The @c "delay,changed" event is so that it'll wait a small time
20165     * before actually reporting those events and, moreover, just the
20166     * last event happening on those time frames will actually be
20167     * reported.
20168     *
20169     * Here are some examples on its usage:
20170     * @li @ref index_example_01
20171     * @li @ref index_example_02
20172     */
20173
20174    /**
20175     * @addtogroup Index
20176     * @{
20177     */
20178
20179    typedef struct _Elm_Index_Item Elm_Index_Item; /**< Opaque handle for items of Elementary index widgets */
20180
20181    /**
20182     * Add a new index widget to the given parent Elementary
20183     * (container) object
20184     *
20185     * @param parent The parent object
20186     * @return a new index widget handle or @c NULL, on errors
20187     *
20188     * This function inserts a new index widget on the canvas.
20189     *
20190     * @ingroup Index
20191     */
20192    EAPI Evas_Object    *elm_index_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20193
20194    /**
20195     * Set whether a given index widget is or not visible,
20196     * programatically.
20197     *
20198     * @param obj The index object
20199     * @param active @c EINA_TRUE to show it, @c EINA_FALSE to hide it
20200     *
20201     * Not to be confused with visible as in @c evas_object_show() --
20202     * visible with regard to the widget's auto hiding feature.
20203     *
20204     * @see elm_index_active_get()
20205     *
20206     * @ingroup Index
20207     */
20208    EAPI void            elm_index_active_set(Evas_Object *obj, Eina_Bool active) EINA_ARG_NONNULL(1);
20209
20210    /**
20211     * Get whether a given index widget is currently visible or not.
20212     *
20213     * @param obj The index object
20214     * @return @c EINA_TRUE, if it's shown, @c EINA_FALSE otherwise
20215     *
20216     * @see elm_index_active_set() for more details
20217     *
20218     * @ingroup Index
20219     */
20220    EAPI Eina_Bool       elm_index_active_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20221
20222    /**
20223     * Set the items level for a given index widget.
20224     *
20225     * @param obj The index object.
20226     * @param level @c 0 or @c 1, the currently implemented levels.
20227     *
20228     * @see elm_index_item_level_get()
20229     *
20230     * @ingroup Index
20231     */
20232    EAPI void            elm_index_item_level_set(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
20233
20234    /**
20235     * Get the items level set for a given index widget.
20236     *
20237     * @param obj The index object.
20238     * @return @c 0 or @c 1, which are the levels @p obj might be at.
20239     *
20240     * @see elm_index_item_level_set() for more information
20241     *
20242     * @ingroup Index
20243     */
20244    EAPI int             elm_index_item_level_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20245
20246    /**
20247     * Returns the last selected item's data, for a given index widget.
20248     *
20249     * @param obj The index object.
20250     * @return The item @b data associated to the last selected item on
20251     * @p obj (or @c NULL, on errors).
20252     *
20253     * @warning The returned value is @b not an #Elm_Index_Item item
20254     * handle, but the data associated to it (see the @c item parameter
20255     * in elm_index_item_append(), as an example).
20256     *
20257     * @ingroup Index
20258     */
20259    EAPI void           *elm_index_item_selected_get(const Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
20260
20261    /**
20262     * Append a new item on a given index widget.
20263     *
20264     * @param obj The index object.
20265     * @param letter Letter under which the item should be indexed
20266     * @param item The item data to set for the index's item
20267     *
20268     * Despite the most common usage of the @p letter argument is for
20269     * single char strings, one could use arbitrary strings as index
20270     * entries.
20271     *
20272     * @c item will be the pointer returned back on @c "changed", @c
20273     * "delay,changed" and @c "selected" smart events.
20274     *
20275     * @ingroup Index
20276     */
20277    EAPI void            elm_index_item_append(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
20278
20279    /**
20280     * Prepend a new item on a given index widget.
20281     *
20282     * @param obj The index object.
20283     * @param letter Letter under which the item should be indexed
20284     * @param item The item data to set for the index's item
20285     *
20286     * Despite the most common usage of the @p letter argument is for
20287     * single char strings, one could use arbitrary strings as index
20288     * entries.
20289     *
20290     * @c item will be the pointer returned back on @c "changed", @c
20291     * "delay,changed" and @c "selected" smart events.
20292     *
20293     * @ingroup Index
20294     */
20295    EAPI void            elm_index_item_prepend(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
20296
20297    /**
20298     * Append a new item, on a given index widget, <b>after the item
20299     * having @p relative as data</b>.
20300     *
20301     * @param obj The index object.
20302     * @param letter Letter under which the item should be indexed
20303     * @param item The item data to set for the index's item
20304     * @param relative The item data of the index item to be the
20305     * predecessor of this new one
20306     *
20307     * Despite the most common usage of the @p letter argument is for
20308     * single char strings, one could use arbitrary strings as index
20309     * entries.
20310     *
20311     * @c item will be the pointer returned back on @c "changed", @c
20312     * "delay,changed" and @c "selected" smart events.
20313     *
20314     * @note If @p relative is @c NULL or if it's not found to be data
20315     * set on any previous item on @p obj, this function will behave as
20316     * elm_index_item_append().
20317     *
20318     * @ingroup Index
20319     */
20320    EAPI void            elm_index_item_append_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
20321
20322    /**
20323     * Prepend a new item, on a given index widget, <b>after the item
20324     * having @p relative as data</b>.
20325     *
20326     * @param obj The index object.
20327     * @param letter Letter under which the item should be indexed
20328     * @param item The item data to set for the index's item
20329     * @param relative The item data of the index item to be the
20330     * successor of this new one
20331     *
20332     * Despite the most common usage of the @p letter argument is for
20333     * single char strings, one could use arbitrary strings as index
20334     * entries.
20335     *
20336     * @c item will be the pointer returned back on @c "changed", @c
20337     * "delay,changed" and @c "selected" smart events.
20338     *
20339     * @note If @p relative is @c NULL or if it's not found to be data
20340     * set on any previous item on @p obj, this function will behave as
20341     * elm_index_item_prepend().
20342     *
20343     * @ingroup Index
20344     */
20345    EAPI void            elm_index_item_prepend_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
20346
20347    /**
20348     * Insert a new item into the given index widget, using @p cmp_func
20349     * function to sort items (by item handles).
20350     *
20351     * @param obj The index object.
20352     * @param letter Letter under which the item should be indexed
20353     * @param item The item data to set for the index's item
20354     * @param cmp_func The comparing function to be used to sort index
20355     * items <b>by #Elm_Index_Item item handles</b>
20356     * @param cmp_data_func A @b fallback function to be called for the
20357     * sorting of index items <b>by item data</b>). It will be used
20358     * when @p cmp_func returns @c 0 (equality), which means an index
20359     * item with provided item data already exists. To decide which
20360     * data item should be pointed to by the index item in question, @p
20361     * cmp_data_func will be used. If @p cmp_data_func returns a
20362     * non-negative value, the previous index item data will be
20363     * replaced by the given @p item pointer. If the previous data need
20364     * to be freed, it should be done by the @p cmp_data_func function,
20365     * because all references to it will be lost. If this function is
20366     * not provided (@c NULL is given), index items will be @b
20367     * duplicated, if @p cmp_func returns @c 0.
20368     *
20369     * Despite the most common usage of the @p letter argument is for
20370     * single char strings, one could use arbitrary strings as index
20371     * entries.
20372     *
20373     * @c item will be the pointer returned back on @c "changed", @c
20374     * "delay,changed" and @c "selected" smart events.
20375     *
20376     * @ingroup Index
20377     */
20378    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);
20379
20380    /**
20381     * Remove an item from a given index widget, <b>to be referenced by
20382     * it's data value</b>.
20383     *
20384     * @param obj The index object
20385     * @param item The item's data pointer for the item to be removed
20386     * from @p obj
20387     *
20388     * If a deletion callback is set, via elm_index_item_del_cb_set(),
20389     * that callback function will be called by this one.
20390     *
20391     * @warning The item to be removed from @p obj will be found via
20392     * its item data pointer, and not by an #Elm_Index_Item handle.
20393     *
20394     * @ingroup Index
20395     */
20396    EAPI void            elm_index_item_del(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
20397
20398    /**
20399     * Find a given index widget's item, <b>using item data</b>.
20400     *
20401     * @param obj The index object
20402     * @param item The item data pointed to by the desired index item
20403     * @return The index item handle, if found, or @c NULL otherwise
20404     *
20405     * @ingroup Index
20406     */
20407    EAPI Elm_Index_Item *elm_index_item_find(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
20408
20409    /**
20410     * Removes @b all items from a given index widget.
20411     *
20412     * @param obj The index object.
20413     *
20414     * If deletion callbacks are set, via elm_index_item_del_cb_set(),
20415     * that callback function will be called for each item in @p obj.
20416     *
20417     * @ingroup Index
20418     */
20419    EAPI void            elm_index_item_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
20420
20421    /**
20422     * Go to a given items level on a index widget
20423     *
20424     * @param obj The index object
20425     * @param level The index level (one of @c 0 or @c 1)
20426     *
20427     * @ingroup Index
20428     */
20429    EAPI void            elm_index_item_go(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
20430
20431    /**
20432     * Return the data associated with a given index widget item
20433     *
20434     * @param it The index widget item handle
20435     * @return The data associated with @p it
20436     *
20437     * @see elm_index_item_data_set()
20438     *
20439     * @ingroup Index
20440     */
20441    EAPI void           *elm_index_item_data_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
20442
20443    /**
20444     * Set the data associated with a given index widget item
20445     *
20446     * @param it The index widget item handle
20447     * @param data The new data pointer to set to @p it
20448     *
20449     * This sets new item data on @p it.
20450     *
20451     * @warning The old data pointer won't be touched by this function, so
20452     * the user had better to free that old data himself/herself.
20453     *
20454     * @ingroup Index
20455     */
20456    EAPI void            elm_index_item_data_set(Elm_Index_Item *it, const void *data) EINA_ARG_NONNULL(1);
20457
20458    /**
20459     * Set the function to be called when a given index widget item is freed.
20460     *
20461     * @param it The item to set the callback on
20462     * @param func The function to call on the item's deletion
20463     *
20464     * When called, @p func will have both @c data and @c event_info
20465     * arguments with the @p it item's data value and, naturally, the
20466     * @c obj argument with a handle to the parent index widget.
20467     *
20468     * @ingroup Index
20469     */
20470    EAPI void            elm_index_item_del_cb_set(Elm_Index_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
20471
20472    /**
20473     * Get the letter (string) set on a given index widget item.
20474     *
20475     * @param it The index item handle
20476     * @return The letter string set on @p it
20477     *
20478     * @ingroup Index
20479     */
20480    EAPI const char     *elm_index_item_letter_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
20481
20482    /**
20483     * @}
20484     */
20485
20486    /**
20487     * @defgroup Photocam Photocam
20488     *
20489     * @image html img/widget/photocam/preview-00.png
20490     * @image latex img/widget/photocam/preview-00.eps
20491     *
20492     * This is a widget specifically for displaying high-resolution digital
20493     * camera photos giving speedy feedback (fast load), low memory footprint
20494     * and zooming and panning as well as fitting logic. It is entirely focused
20495     * on jpeg images, and takes advantage of properties of the jpeg format (via
20496     * evas loader features in the jpeg loader).
20497     *
20498     * Signals that you can add callbacks for are:
20499     * @li "clicked" - This is called when a user has clicked the photo without
20500     *                 dragging around.
20501     * @li "press" - This is called when a user has pressed down on the photo.
20502     * @li "longpressed" - This is called when a user has pressed down on the
20503     *                     photo for a long time without dragging around.
20504     * @li "clicked,double" - This is called when a user has double-clicked the
20505     *                        photo.
20506     * @li "load" - Photo load begins.
20507     * @li "loaded" - This is called when the image file load is complete for the
20508     *                first view (low resolution blurry version).
20509     * @li "load,detail" - Photo detailed data load begins.
20510     * @li "loaded,detail" - This is called when the image file load is complete
20511     *                      for the detailed image data (full resolution needed).
20512     * @li "zoom,start" - Zoom animation started.
20513     * @li "zoom,stop" - Zoom animation stopped.
20514     * @li "zoom,change" - Zoom changed when using an auto zoom mode.
20515     * @li "scroll" - the content has been scrolled (moved)
20516     * @li "scroll,anim,start" - scrolling animation has started
20517     * @li "scroll,anim,stop" - scrolling animation has stopped
20518     * @li "scroll,drag,start" - dragging the contents around has started
20519     * @li "scroll,drag,stop" - dragging the contents around has stopped
20520     *
20521     * @ref tutorial_photocam shows the API in action.
20522     * @{
20523     */
20524    /**
20525     * @brief Types of zoom available.
20526     */
20527    typedef enum _Elm_Photocam_Zoom_Mode
20528      {
20529         ELM_PHOTOCAM_ZOOM_MODE_MANUAL = 0, /**< Zoom controled normally by elm_photocam_zoom_set */
20530         ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT, /**< Zoom until photo fits in photocam */
20531         ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL, /**< Zoom until photo fills photocam */
20532         ELM_PHOTOCAM_ZOOM_MODE_LAST
20533      } Elm_Photocam_Zoom_Mode;
20534    /**
20535     * @brief Add a new Photocam object
20536     *
20537     * @param parent The parent object
20538     * @return The new object or NULL if it cannot be created
20539     */
20540    EAPI Evas_Object           *elm_photocam_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20541    /**
20542     * @brief Set the photo file to be shown
20543     *
20544     * @param obj The photocam object
20545     * @param file The photo file
20546     * @return The return error (see EVAS_LOAD_ERROR_NONE, EVAS_LOAD_ERROR_GENERIC etc.)
20547     *
20548     * This sets (and shows) the specified file (with a relative or absolute
20549     * path) and will return a load error (same error that
20550     * evas_object_image_load_error_get() will return). The image will change and
20551     * adjust its size at this point and begin a background load process for this
20552     * photo that at some time in the future will be displayed at the full
20553     * quality needed.
20554     */
20555    EAPI Evas_Load_Error        elm_photocam_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
20556    /**
20557     * @brief Returns the path of the current image file
20558     *
20559     * @param obj The photocam object
20560     * @return Returns the path
20561     *
20562     * @see elm_photocam_file_set()
20563     */
20564    EAPI const char            *elm_photocam_file_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20565    /**
20566     * @brief Set the zoom level of the photo
20567     *
20568     * @param obj The photocam object
20569     * @param zoom The zoom level to set
20570     *
20571     * This sets the zoom level. 1 will be 1:1 pixel for pixel. 2 will be 2:1
20572     * (that is 2x2 photo pixels will display as 1 on-screen pixel). 4:1 will be
20573     * 4x4 photo pixels as 1 screen pixel, and so on. The @p zoom parameter must
20574     * be greater than 0. It is usggested to stick to powers of 2. (1, 2, 4, 8,
20575     * 16, 32, etc.).
20576     */
20577    EAPI void                   elm_photocam_zoom_set(Evas_Object *obj, double zoom) EINA_ARG_NONNULL(1);
20578    /**
20579     * @brief Get the zoom level of the photo
20580     *
20581     * @param obj The photocam object
20582     * @return The current zoom level
20583     *
20584     * This returns the current zoom level of the photocam object. Note that if
20585     * you set the fill mode to other than ELM_PHOTOCAM_ZOOM_MODE_MANUAL
20586     * (which is the default), the zoom level may be changed at any time by the
20587     * photocam object itself to account for photo size and photocam viewpoer
20588     * size.
20589     *
20590     * @see elm_photocam_zoom_set()
20591     * @see elm_photocam_zoom_mode_set()
20592     */
20593    EAPI double                 elm_photocam_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20594    /**
20595     * @brief Set the zoom mode
20596     *
20597     * @param obj The photocam object
20598     * @param mode The desired mode
20599     *
20600     * This sets the zoom mode to manual or one of several automatic levels.
20601     * Manual (ELM_PHOTOCAM_ZOOM_MODE_MANUAL) means that zoom is set manually by
20602     * elm_photocam_zoom_set() and will stay at that level until changed by code
20603     * or until zoom mode is changed. This is the default mode. The Automatic
20604     * modes will allow the photocam object to automatically adjust zoom mode
20605     * based on properties. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT) will adjust zoom so
20606     * the photo fits EXACTLY inside the scroll frame with no pixels outside this
20607     * area. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL will be similar but ensure no
20608     * pixels within the frame are left unfilled.
20609     */
20610    EAPI void                   elm_photocam_zoom_mode_set(Evas_Object *obj, Elm_Photocam_Zoom_Mode mode) EINA_ARG_NONNULL(1);
20611    /**
20612     * @brief Get the zoom mode
20613     *
20614     * @param obj The photocam object
20615     * @return The current zoom mode
20616     *
20617     * This gets the current zoom mode of the photocam object.
20618     *
20619     * @see elm_photocam_zoom_mode_set()
20620     */
20621    EAPI Elm_Photocam_Zoom_Mode elm_photocam_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20622    /**
20623     * @brief Get the current image pixel width and height
20624     *
20625     * @param obj The photocam object
20626     * @param w A pointer to the width return
20627     * @param h A pointer to the height return
20628     *
20629     * This gets the current photo pixel width and height (for the original).
20630     * The size will be returned in the integers @p w and @p h that are pointed
20631     * to.
20632     */
20633    EAPI void                   elm_photocam_image_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
20634    /**
20635     * @brief Get the area of the image that is currently shown
20636     *
20637     * @param obj
20638     * @param x A pointer to the X-coordinate of region
20639     * @param y A pointer to the Y-coordinate of region
20640     * @param w A pointer to the width
20641     * @param h A pointer to the height
20642     *
20643     * @see elm_photocam_image_region_show()
20644     * @see elm_photocam_image_region_bring_in()
20645     */
20646    EAPI void                   elm_photocam_region_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
20647    /**
20648     * @brief Set the viewed portion of the image
20649     *
20650     * @param obj The photocam object
20651     * @param x X-coordinate of region in image original pixels
20652     * @param y Y-coordinate of region in image original pixels
20653     * @param w Width of region in image original pixels
20654     * @param h Height of region in image original pixels
20655     *
20656     * This shows the region of the image without using animation.
20657     */
20658    EAPI void                   elm_photocam_image_region_show(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
20659    /**
20660     * @brief Bring in the viewed portion of the image
20661     *
20662     * @param obj The photocam object
20663     * @param x X-coordinate of region in image original pixels
20664     * @param y Y-coordinate of region in image original pixels
20665     * @param w Width of region in image original pixels
20666     * @param h Height of region in image original pixels
20667     *
20668     * This shows the region of the image using animation.
20669     */
20670    EAPI void                   elm_photocam_image_region_bring_in(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
20671    /**
20672     * @brief Set the paused state for photocam
20673     *
20674     * @param obj The photocam object
20675     * @param paused The pause state to set
20676     *
20677     * This sets the paused state to on(EINA_TRUE) or off (EINA_FALSE) for
20678     * photocam. The default is off. This will stop zooming using animation on
20679     * zoom levels changes and change instantly. This will stop any existing
20680     * animations that are running.
20681     */
20682    EAPI void                   elm_photocam_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
20683    /**
20684     * @brief Get the paused state for photocam
20685     *
20686     * @param obj The photocam object
20687     * @return The current paused state
20688     *
20689     * This gets the current paused state for the photocam object.
20690     *
20691     * @see elm_photocam_paused_set()
20692     */
20693    EAPI Eina_Bool              elm_photocam_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20694    /**
20695     * @brief Get the internal low-res image used for photocam
20696     *
20697     * @param obj The photocam object
20698     * @return The internal image object handle, or NULL if none exists
20699     *
20700     * This gets the internal image object inside photocam. Do not modify it. It
20701     * is for inspection only, and hooking callbacks to. Nothing else. It may be
20702     * deleted at any time as well.
20703     */
20704    EAPI Evas_Object           *elm_photocam_internal_image_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20705    /**
20706     * @brief Set the photocam scrolling bouncing.
20707     *
20708     * @param obj The photocam object
20709     * @param h_bounce bouncing for horizontal
20710     * @param v_bounce bouncing for vertical
20711     */
20712    EAPI void                   elm_photocam_bounce_set(Evas_Object *obj,  Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
20713    /**
20714     * @brief Get the photocam scrolling bouncing.
20715     *
20716     * @param obj The photocam object
20717     * @param h_bounce bouncing for horizontal
20718     * @param v_bounce bouncing for vertical
20719     *
20720     * @see elm_photocam_bounce_set()
20721     */
20722    EAPI void                   elm_photocam_bounce_get(const Evas_Object *obj,  Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
20723    /**
20724     * @}
20725     */
20726
20727    /**
20728     * @defgroup Map Map
20729     * @ingroup Elementary
20730     *
20731     * @image html img/widget/map/preview-00.png
20732     * @image latex img/widget/map/preview-00.eps
20733     *
20734     * This is a widget specifically for displaying a map. It uses basically
20735     * OpenStreetMap provider http://www.openstreetmap.org/,
20736     * but custom providers can be added.
20737     *
20738     * It supports some basic but yet nice features:
20739     * @li zoom and scroll
20740     * @li markers with content to be displayed when user clicks over it
20741     * @li group of markers
20742     * @li routes
20743     *
20744     * Smart callbacks one can listen to:
20745     *
20746     * - "clicked" - This is called when a user has clicked the map without
20747     *   dragging around.
20748     * - "press" - This is called when a user has pressed down on the map.
20749     * - "longpressed" - This is called when a user has pressed down on the map
20750     *   for a long time without dragging around.
20751     * - "clicked,double" - This is called when a user has double-clicked
20752     *   the map.
20753     * - "load,detail" - Map detailed data load begins.
20754     * - "loaded,detail" - This is called when all currently visible parts of
20755     *   the map are loaded.
20756     * - "zoom,start" - Zoom animation started.
20757     * - "zoom,stop" - Zoom animation stopped.
20758     * - "zoom,change" - Zoom changed when using an auto zoom mode.
20759     * - "scroll" - the content has been scrolled (moved).
20760     * - "scroll,anim,start" - scrolling animation has started.
20761     * - "scroll,anim,stop" - scrolling animation has stopped.
20762     * - "scroll,drag,start" - dragging the contents around has started.
20763     * - "scroll,drag,stop" - dragging the contents around has stopped.
20764     * - "downloaded" - This is called when all currently required map images
20765     *   are downloaded.
20766     * - "route,load" - This is called when route request begins.
20767     * - "route,loaded" - This is called when route request ends.
20768     * - "name,load" - This is called when name request begins.
20769     * - "name,loaded- This is called when name request ends.
20770     *
20771     * Available style for map widget:
20772     * - @c "default"
20773     *
20774     * Available style for markers:
20775     * - @c "radio"
20776     * - @c "radio2"
20777     * - @c "empty"
20778     *
20779     * Available style for marker bubble:
20780     * - @c "default"
20781     *
20782     * List of examples:
20783     * @li @ref map_example_01
20784     * @li @ref map_example_02
20785     * @li @ref map_example_03
20786     */
20787
20788    /**
20789     * @addtogroup Map
20790     * @{
20791     */
20792
20793    /**
20794     * @enum _Elm_Map_Zoom_Mode
20795     * @typedef Elm_Map_Zoom_Mode
20796     *
20797     * Set map's zoom behavior. It can be set to manual or automatic.
20798     *
20799     * Default value is #ELM_MAP_ZOOM_MODE_MANUAL.
20800     *
20801     * Values <b> don't </b> work as bitmask, only one can be choosen.
20802     *
20803     * @note Valid sizes are 2^zoom, consequently the map may be smaller
20804     * than the scroller view.
20805     *
20806     * @see elm_map_zoom_mode_set()
20807     * @see elm_map_zoom_mode_get()
20808     *
20809     * @ingroup Map
20810     */
20811    typedef enum _Elm_Map_Zoom_Mode
20812      {
20813         ELM_MAP_ZOOM_MODE_MANUAL, /**< Zoom controled manually by elm_map_zoom_set(). It's set by default. */
20814         ELM_MAP_ZOOM_MODE_AUTO_FIT, /**< Zoom until map fits inside the scroll frame with no pixels outside this area. */
20815         ELM_MAP_ZOOM_MODE_AUTO_FILL, /**< Zoom until map fills scroll, ensuring no pixels are left unfilled. */
20816         ELM_MAP_ZOOM_MODE_LAST
20817      } Elm_Map_Zoom_Mode;
20818
20819    /**
20820     * @enum _Elm_Map_Route_Sources
20821     * @typedef Elm_Map_Route_Sources
20822     *
20823     * Set route service to be used. By default used source is
20824     * #ELM_MAP_ROUTE_SOURCE_YOURS.
20825     *
20826     * @see elm_map_route_source_set()
20827     * @see elm_map_route_source_get()
20828     *
20829     * @ingroup Map
20830     */
20831    typedef enum _Elm_Map_Route_Sources
20832      {
20833         ELM_MAP_ROUTE_SOURCE_YOURS, /**< Routing service http://www.yournavigation.org/ . Set by default.*/
20834         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. */
20835         ELM_MAP_ROUTE_SOURCE_ORS, /**< Open Route Service: http://www.openrouteservice.org/ . It's not working with Map yet. */
20836         ELM_MAP_ROUTE_SOURCE_LAST
20837      } Elm_Map_Route_Sources;
20838
20839    typedef enum _Elm_Map_Name_Sources
20840      {
20841         ELM_MAP_NAME_SOURCE_NOMINATIM,
20842         ELM_MAP_NAME_SOURCE_LAST
20843      } Elm_Map_Name_Sources;
20844
20845    /**
20846     * @enum _Elm_Map_Route_Type
20847     * @typedef Elm_Map_Route_Type
20848     *
20849     * Set type of transport used on route.
20850     *
20851     * @see elm_map_route_add()
20852     *
20853     * @ingroup Map
20854     */
20855    typedef enum _Elm_Map_Route_Type
20856      {
20857         ELM_MAP_ROUTE_TYPE_MOTOCAR, /**< Route should consider an automobile will be used. */
20858         ELM_MAP_ROUTE_TYPE_BICYCLE, /**< Route should consider a bicycle will be used by the user. */
20859         ELM_MAP_ROUTE_TYPE_FOOT, /**< Route should consider user will be walking. */
20860         ELM_MAP_ROUTE_TYPE_LAST
20861      } Elm_Map_Route_Type;
20862
20863    /**
20864     * @enum _Elm_Map_Route_Method
20865     * @typedef Elm_Map_Route_Method
20866     *
20867     * Set the routing method, what should be priorized, time or distance.
20868     *
20869     * @see elm_map_route_add()
20870     *
20871     * @ingroup Map
20872     */
20873    typedef enum _Elm_Map_Route_Method
20874      {
20875         ELM_MAP_ROUTE_METHOD_FASTEST, /**< Route should priorize time. */
20876         ELM_MAP_ROUTE_METHOD_SHORTEST, /**< Route should priorize distance. */
20877         ELM_MAP_ROUTE_METHOD_LAST
20878      } Elm_Map_Route_Method;
20879
20880    typedef enum _Elm_Map_Name_Method
20881      {
20882         ELM_MAP_NAME_METHOD_SEARCH,
20883         ELM_MAP_NAME_METHOD_REVERSE,
20884         ELM_MAP_NAME_METHOD_LAST
20885      } Elm_Map_Name_Method;
20886
20887    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(). */
20888    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(). */
20889    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(). */
20890    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(). */
20891    typedef struct _Elm_Map_Name            Elm_Map_Name; /**< A handle for specific coordinates. */
20892    typedef struct _Elm_Map_Track           Elm_Map_Track;
20893
20894    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. */
20895    typedef void         (*ElmMapMarkerDelFunc)      (Evas_Object *obj, Elm_Map_Marker *marker, void *data, Evas_Object *o); /**< Function to delete bubble content for marker classes. */
20896    typedef Evas_Object *(*ElmMapMarkerIconGetFunc)  (Evas_Object *obj, Elm_Map_Marker *marker, void *data); /**< Icon fetching class function for marker classes. */
20897    typedef Evas_Object *(*ElmMapGroupIconGetFunc)   (Evas_Object *obj, void *data); /**< Icon fetching class function for markers group classes. */
20898
20899    typedef char        *(*ElmMapModuleSourceFunc) (void);
20900    typedef int          (*ElmMapModuleZoomMinFunc) (void);
20901    typedef int          (*ElmMapModuleZoomMaxFunc) (void);
20902    typedef char        *(*ElmMapModuleUrlFunc) (Evas_Object *obj, int x, int y, int zoom);
20903    typedef int          (*ElmMapModuleRouteSourceFunc) (void);
20904    typedef char        *(*ElmMapModuleRouteUrlFunc) (Evas_Object *obj, char *type_name, int method, double flon, double flat, double tlon, double tlat);
20905    typedef char        *(*ElmMapModuleNameUrlFunc) (Evas_Object *obj, int method, char *name, double lon, double lat);
20906    typedef Eina_Bool    (*ElmMapModuleGeoIntoCoordFunc) (const Evas_Object *obj, int zoom, double lon, double lat, int size, int *x, int *y);
20907    typedef Eina_Bool    (*ElmMapModuleCoordIntoGeoFunc) (const Evas_Object *obj, int zoom, int x, int y, int size, double *lon, double *lat);
20908
20909    /**
20910     * Add a new map widget to the given parent Elementary (container) object.
20911     *
20912     * @param parent The parent object.
20913     * @return a new map widget handle or @c NULL, on errors.
20914     *
20915     * This function inserts a new map widget on the canvas.
20916     *
20917     * @ingroup Map
20918     */
20919    EAPI Evas_Object          *elm_map_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20920
20921    /**
20922     * Set the zoom level of the map.
20923     *
20924     * @param obj The map object.
20925     * @param zoom The zoom level to set.
20926     *
20927     * This sets the zoom level.
20928     *
20929     * It will respect limits defined by elm_map_source_zoom_min_set() and
20930     * elm_map_source_zoom_max_set().
20931     *
20932     * By default these values are 0 (world map) and 18 (maximum zoom).
20933     *
20934     * This function should be used when zoom mode is set to
20935     * #ELM_MAP_ZOOM_MODE_MANUAL. This is the default mode, and can be set
20936     * with elm_map_zoom_mode_set().
20937     *
20938     * @see elm_map_zoom_mode_set().
20939     * @see elm_map_zoom_get().
20940     *
20941     * @ingroup Map
20942     */
20943    EAPI void                  elm_map_zoom_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
20944
20945    /**
20946     * Get the zoom level of the map.
20947     *
20948     * @param obj The map object.
20949     * @return The current zoom level.
20950     *
20951     * This returns the current zoom level of the map object.
20952     *
20953     * Note that if you set the fill mode to other than #ELM_MAP_ZOOM_MODE_MANUAL
20954     * (which is the default), the zoom level may be changed at any time by the
20955     * map object itself to account for map size and map viewport size.
20956     *
20957     * @see elm_map_zoom_set() for details.
20958     *
20959     * @ingroup Map
20960     */
20961    EAPI int                   elm_map_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20962
20963    /**
20964     * Set the zoom mode used by the map object.
20965     *
20966     * @param obj The map object.
20967     * @param mode The zoom mode of the map, being it one of
20968     * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
20969     * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
20970     *
20971     * This sets the zoom mode to manual or one of the automatic levels.
20972     * Manual (#ELM_MAP_ZOOM_MODE_MANUAL) means that zoom is set manually by
20973     * elm_map_zoom_set() and will stay at that level until changed by code
20974     * or until zoom mode is changed. This is the default mode.
20975     *
20976     * The Automatic modes will allow the map object to automatically
20977     * adjust zoom mode based on properties. #ELM_MAP_ZOOM_MODE_AUTO_FIT will
20978     * adjust zoom so the map fits inside the scroll frame with no pixels
20979     * outside this area. #ELM_MAP_ZOOM_MODE_AUTO_FILL will be similar but
20980     * ensure no pixels within the frame are left unfilled. Do not forget that
20981     * the valid sizes are 2^zoom, consequently the map may be smaller than
20982     * the scroller view.
20983     *
20984     * @see elm_map_zoom_set()
20985     *
20986     * @ingroup Map
20987     */
20988    EAPI void                  elm_map_zoom_mode_set(Evas_Object *obj, Elm_Map_Zoom_Mode mode) EINA_ARG_NONNULL(1);
20989
20990    /**
20991     * Get the zoom mode used by the map object.
20992     *
20993     * @param obj The map object.
20994     * @return The zoom mode of the map, being it one of
20995     * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
20996     * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
20997     *
20998     * This function returns the current zoom mode used by the map object.
20999     *
21000     * @see elm_map_zoom_mode_set() for more details.
21001     *
21002     * @ingroup Map
21003     */
21004    EAPI Elm_Map_Zoom_Mode     elm_map_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21005
21006    /**
21007     * Get the current coordinates of the map.
21008     *
21009     * @param obj The map object.
21010     * @param lon Pointer where to store longitude.
21011     * @param lat Pointer where to store latitude.
21012     *
21013     * This gets the current center coordinates of the map object. It can be
21014     * set by elm_map_geo_region_bring_in() and elm_map_geo_region_show().
21015     *
21016     * @see elm_map_geo_region_bring_in()
21017     * @see elm_map_geo_region_show()
21018     *
21019     * @ingroup Map
21020     */
21021    EAPI void                  elm_map_geo_region_get(const Evas_Object *obj, double *lon, double *lat) EINA_ARG_NONNULL(1);
21022
21023    /**
21024     * Animatedly bring in given coordinates to the center of the map.
21025     *
21026     * @param obj The map object.
21027     * @param lon Longitude to center at.
21028     * @param lat Latitude to center at.
21029     *
21030     * This causes map to jump to the given @p lat and @p lon coordinates
21031     * and show it (by scrolling) in the center of the viewport, if it is not
21032     * already centered. This will use animation to do so and take a period
21033     * of time to complete.
21034     *
21035     * @see elm_map_geo_region_show() for a function to avoid animation.
21036     * @see elm_map_geo_region_get()
21037     *
21038     * @ingroup Map
21039     */
21040    EAPI void                  elm_map_geo_region_bring_in(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
21041
21042    /**
21043     * Show the given coordinates at the center of the map, @b immediately.
21044     *
21045     * @param obj The map object.
21046     * @param lon Longitude to center at.
21047     * @param lat Latitude to center at.
21048     *
21049     * This causes map to @b redraw its viewport's contents to the
21050     * region contining the given @p lat and @p lon, that will be moved to the
21051     * center of the map.
21052     *
21053     * @see elm_map_geo_region_bring_in() for a function to move with animation.
21054     * @see elm_map_geo_region_get()
21055     *
21056     * @ingroup Map
21057     */
21058    EAPI void                  elm_map_geo_region_show(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
21059
21060    /**
21061     * Pause or unpause the map.
21062     *
21063     * @param obj The map object.
21064     * @param paused Use @c EINA_TRUE to pause the map @p obj or @c EINA_FALSE
21065     * to unpause it.
21066     *
21067     * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
21068     * for map.
21069     *
21070     * The default is off.
21071     *
21072     * This will stop zooming using animation, changing zoom levels will
21073     * change instantly. This will stop any existing animations that are running.
21074     *
21075     * @see elm_map_paused_get()
21076     *
21077     * @ingroup Map
21078     */
21079    EAPI void                  elm_map_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
21080
21081    /**
21082     * Get a value whether map is paused or not.
21083     *
21084     * @param obj The map object.
21085     * @return @c EINA_TRUE means map is pause. @c EINA_FALSE indicates
21086     * it is not. If @p obj is @c NULL, @c EINA_FALSE is returned.
21087     *
21088     * This gets the current paused state for the map object.
21089     *
21090     * @see elm_map_paused_set() for details.
21091     *
21092     * @ingroup Map
21093     */
21094    EAPI Eina_Bool             elm_map_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21095
21096    /**
21097     * Set to show markers during zoom level changes or not.
21098     *
21099     * @param obj The map object.
21100     * @param paused Use @c EINA_TRUE to @b not show markers or @c EINA_FALSE
21101     * to show them.
21102     *
21103     * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
21104     * for map.
21105     *
21106     * The default is off.
21107     *
21108     * This will stop zooming using animation, changing zoom levels will
21109     * change instantly. This will stop any existing animations that are running.
21110     *
21111     * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
21112     * for the markers.
21113     *
21114     * The default  is off.
21115     *
21116     * Enabling it will force the map to stop displaying the markers during
21117     * zoom level changes. Set to on if you have a large number of markers.
21118     *
21119     * @see elm_map_paused_markers_get()
21120     *
21121     * @ingroup Map
21122     */
21123    EAPI void                  elm_map_paused_markers_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
21124
21125    /**
21126     * Get a value whether markers will be displayed on zoom level changes or not
21127     *
21128     * @param obj The map object.
21129     * @return @c EINA_TRUE means map @b won't display markers or @c EINA_FALSE
21130     * indicates it will. If @p obj is @c NULL, @c EINA_FALSE is returned.
21131     *
21132     * This gets the current markers paused state for the map object.
21133     *
21134     * @see elm_map_paused_markers_set() for details.
21135     *
21136     * @ingroup Map
21137     */
21138    EAPI Eina_Bool             elm_map_paused_markers_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21139
21140    /**
21141     * Get the information of downloading status.
21142     *
21143     * @param obj The map object.
21144     * @param try_num Pointer where to store number of tiles being downloaded.
21145     * @param finish_num Pointer where to store number of tiles successfully
21146     * downloaded.
21147     *
21148     * This gets the current downloading status for the map object, the number
21149     * of tiles being downloaded and the number of tiles already downloaded.
21150     *
21151     * @ingroup Map
21152     */
21153    EAPI void                  elm_map_utils_downloading_status_get(const Evas_Object *obj, int *try_num, int *finish_num) EINA_ARG_NONNULL(1, 2, 3);
21154
21155    /**
21156     * Convert a pixel coordinate (x,y) into a geographic coordinate
21157     * (longitude, latitude).
21158     *
21159     * @param obj The map object.
21160     * @param x the coordinate.
21161     * @param y the coordinate.
21162     * @param size the size in pixels of the map.
21163     * The map is a square and generally his size is : pow(2.0, zoom)*256.
21164     * @param lon Pointer where to store the longitude that correspond to x.
21165     * @param lat Pointer where to store the latitude that correspond to y.
21166     *
21167     * @note Origin pixel point is the top left corner of the viewport.
21168     * Map zoom and size are taken on account.
21169     *
21170     * @see elm_map_utils_convert_geo_into_coord() if you need the inverse.
21171     *
21172     * @ingroup Map
21173     */
21174    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);
21175
21176    /**
21177     * Convert a geographic coordinate (longitude, latitude) into a pixel
21178     * coordinate (x, y).
21179     *
21180     * @param obj The map object.
21181     * @param lon the longitude.
21182     * @param lat the latitude.
21183     * @param size the size in pixels of the map. The map is a square
21184     * and generally his size is : pow(2.0, zoom)*256.
21185     * @param x Pointer where to store the horizontal pixel coordinate that
21186     * correspond to the longitude.
21187     * @param y Pointer where to store the vertical pixel coordinate that
21188     * correspond to the latitude.
21189     *
21190     * @note Origin pixel point is the top left corner of the viewport.
21191     * Map zoom and size are taken on account.
21192     *
21193     * @see elm_map_utils_convert_coord_into_geo() if you need the inverse.
21194     *
21195     * @ingroup Map
21196     */
21197    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);
21198
21199    /**
21200     * Convert a geographic coordinate (longitude, latitude) into a name
21201     * (address).
21202     *
21203     * @param obj The map object.
21204     * @param lon the longitude.
21205     * @param lat the latitude.
21206     * @return name A #Elm_Map_Name handle for this coordinate.
21207     *
21208     * To get the string for this address, elm_map_name_address_get()
21209     * should be used.
21210     *
21211     * @see elm_map_utils_convert_name_into_coord() if you need the inverse.
21212     *
21213     * @ingroup Map
21214     */
21215    EAPI Elm_Map_Name         *elm_map_utils_convert_coord_into_name(const Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
21216
21217    /**
21218     * Convert a name (address) into a geographic coordinate
21219     * (longitude, latitude).
21220     *
21221     * @param obj The map object.
21222     * @param name The address.
21223     * @return name A #Elm_Map_Name handle for this address.
21224     *
21225     * To get the longitude and latitude, elm_map_name_region_get()
21226     * should be used.
21227     *
21228     * @see elm_map_utils_convert_coord_into_name() if you need the inverse.
21229     *
21230     * @ingroup Map
21231     */
21232    EAPI Elm_Map_Name         *elm_map_utils_convert_name_into_coord(const Evas_Object *obj, char *address) EINA_ARG_NONNULL(1, 2);
21233
21234    /**
21235     * Convert a pixel coordinate into a rotated pixel coordinate.
21236     *
21237     * @param obj The map object.
21238     * @param x horizontal coordinate of the point to rotate.
21239     * @param y vertical coordinate of the point to rotate.
21240     * @param cx rotation's center horizontal position.
21241     * @param cy rotation's center vertical position.
21242     * @param degree amount of degrees from 0.0 to 360.0 to rotate arount Z axis.
21243     * @param xx Pointer where to store rotated x.
21244     * @param yy Pointer where to store rotated y.
21245     *
21246     * @ingroup Map
21247     */
21248    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);
21249
21250    /**
21251     * Add a new marker to the map object.
21252     *
21253     * @param obj The map object.
21254     * @param lon The longitude of the marker.
21255     * @param lat The latitude of the marker.
21256     * @param clas The class, to use when marker @b isn't grouped to others.
21257     * @param clas_group The class group, to use when marker is grouped to others
21258     * @param data The data passed to the callbacks.
21259     *
21260     * @return The created marker or @c NULL upon failure.
21261     *
21262     * A marker will be created and shown in a specific point of the map, defined
21263     * by @p lon and @p lat.
21264     *
21265     * It will be displayed using style defined by @p class when this marker
21266     * is displayed alone (not grouped). A new class can be created with
21267     * elm_map_marker_class_new().
21268     *
21269     * If the marker is grouped to other markers, it will be displayed with
21270     * style defined by @p class_group. Markers with the same group are grouped
21271     * if they are close. A new group class can be created with
21272     * elm_map_marker_group_class_new().
21273     *
21274     * Markers created with this method can be deleted with
21275     * elm_map_marker_remove().
21276     *
21277     * A marker can have associated content to be displayed by a bubble,
21278     * when a user click over it, as well as an icon. These objects will
21279     * be fetch using class' callback functions.
21280     *
21281     * @see elm_map_marker_class_new()
21282     * @see elm_map_marker_group_class_new()
21283     * @see elm_map_marker_remove()
21284     *
21285     * @ingroup Map
21286     */
21287    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);
21288
21289    /**
21290     * Set the maximum numbers of markers' content to be displayed in a group.
21291     *
21292     * @param obj The map object.
21293     * @param max The maximum numbers of items displayed in a bubble.
21294     *
21295     * A bubble will be displayed when the user clicks over the group,
21296     * and will place the content of markers that belong to this group
21297     * inside it.
21298     *
21299     * A group can have a long list of markers, consequently the creation
21300     * of the content of the bubble can be very slow.
21301     *
21302     * In order to avoid this, a maximum number of items is displayed
21303     * in a bubble.
21304     *
21305     * By default this number is 30.
21306     *
21307     * Marker with the same group class are grouped if they are close.
21308     *
21309     * @see elm_map_marker_add()
21310     *
21311     * @ingroup Map
21312     */
21313    EAPI void                  elm_map_max_marker_per_group_set(Evas_Object *obj, int max) EINA_ARG_NONNULL(1);
21314
21315    /**
21316     * Remove a marker from the map.
21317     *
21318     * @param marker The marker to remove.
21319     *
21320     * @see elm_map_marker_add()
21321     *
21322     * @ingroup Map
21323     */
21324    EAPI void                  elm_map_marker_remove(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
21325
21326    /**
21327     * Get the current coordinates of the marker.
21328     *
21329     * @param marker marker.
21330     * @param lat Pointer where to store the marker's latitude.
21331     * @param lon Pointer where to store the marker's longitude.
21332     *
21333     * These values are set when adding markers, with function
21334     * elm_map_marker_add().
21335     *
21336     * @see elm_map_marker_add()
21337     *
21338     * @ingroup Map
21339     */
21340    EAPI void                  elm_map_marker_region_get(const Elm_Map_Marker *marker, double *lon, double *lat) EINA_ARG_NONNULL(1);
21341
21342    /**
21343     * Animatedly bring in given marker to the center of the map.
21344     *
21345     * @param marker The marker to center at.
21346     *
21347     * This causes map to jump to the given @p marker's coordinates
21348     * and show it (by scrolling) in the center of the viewport, if it is not
21349     * already centered. This will use animation to do so and take a period
21350     * of time to complete.
21351     *
21352     * @see elm_map_marker_show() for a function to avoid animation.
21353     * @see elm_map_marker_region_get()
21354     *
21355     * @ingroup Map
21356     */
21357    EAPI void                  elm_map_marker_bring_in(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
21358
21359    /**
21360     * Show the given marker at the center of the map, @b immediately.
21361     *
21362     * @param marker The marker to center at.
21363     *
21364     * This causes map to @b redraw its viewport's contents to the
21365     * region contining the given @p marker's coordinates, that will be
21366     * moved to the center of the map.
21367     *
21368     * @see elm_map_marker_bring_in() for a function to move with animation.
21369     * @see elm_map_markers_list_show() if more than one marker need to be
21370     * displayed.
21371     * @see elm_map_marker_region_get()
21372     *
21373     * @ingroup Map
21374     */
21375    EAPI void                  elm_map_marker_show(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
21376
21377    /**
21378     * Move and zoom the map to display a list of markers.
21379     *
21380     * @param markers A list of #Elm_Map_Marker handles.
21381     *
21382     * The map will be centered on the center point of the markers in the list.
21383     * Then the map will be zoomed in order to fit the markers using the maximum
21384     * zoom which allows display of all the markers.
21385     *
21386     * @warning All the markers should belong to the same map object.
21387     *
21388     * @see elm_map_marker_show() to show a single marker.
21389     * @see elm_map_marker_bring_in()
21390     *
21391     * @ingroup Map
21392     */
21393    EAPI void                  elm_map_markers_list_show(Eina_List *markers) EINA_ARG_NONNULL(1);
21394
21395    /**
21396     * Get the Evas object returned by the ElmMapMarkerGetFunc callback
21397     *
21398     * @param marker The marker wich content should be returned.
21399     * @return Return the evas object if it exists, else @c NULL.
21400     *
21401     * To set callback function #ElmMapMarkerGetFunc for the marker class,
21402     * elm_map_marker_class_get_cb_set() should be used.
21403     *
21404     * This content is what will be inside the bubble that will be displayed
21405     * when an user clicks over the marker.
21406     *
21407     * This returns the actual Evas object used to be placed inside
21408     * the bubble. This may be @c NULL, as it may
21409     * not have been created or may have been deleted, at any time, by
21410     * the map. <b>Do not modify this object</b> (move, resize,
21411     * show, hide, etc.), as the map is controlling it. This
21412     * function is for querying, emitting custom signals or hooking
21413     * lower level callbacks for events on that object. Do not delete
21414     * this object under any circumstances.
21415     *
21416     * @ingroup Map
21417     */
21418    EAPI Evas_Object          *elm_map_marker_object_get(const Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
21419
21420    /**
21421     * Update the marker
21422     *
21423     * @param marker The marker to be updated.
21424     *
21425     * If a content is set to this marker, it will call function to delete it,
21426     * #ElmMapMarkerDelFunc, and then will fetch the content again with
21427     * #ElmMapMarkerGetFunc.
21428     *
21429     * These functions are set for the marker class with
21430     * elm_map_marker_class_get_cb_set() and elm_map_marker_class_del_cb_set().
21431     *
21432     * @ingroup Map
21433     */
21434    EAPI void                  elm_map_marker_update(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
21435
21436    /**
21437     * Close all the bubbles opened by the user.
21438     *
21439     * @param obj The map object.
21440     *
21441     * A bubble is displayed with a content fetched with #ElmMapMarkerGetFunc
21442     * when the user clicks on a marker.
21443     *
21444     * This functions is set for the marker class with
21445     * elm_map_marker_class_get_cb_set().
21446     *
21447     * @ingroup Map
21448     */
21449    EAPI void                  elm_map_bubbles_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
21450
21451    /**
21452     * Create a new group class.
21453     *
21454     * @param obj The map object.
21455     * @return Returns the new group class.
21456     *
21457     * Each marker must be associated to a group class. Markers in the same
21458     * group are grouped if they are close.
21459     *
21460     * The group class defines the style of the marker when a marker is grouped
21461     * to others markers. When it is alone, another class will be used.
21462     *
21463     * A group class will need to be provided when creating a marker with
21464     * elm_map_marker_add().
21465     *
21466     * Some properties and functions can be set by class, as:
21467     * - style, with elm_map_group_class_style_set()
21468     * - data - to be associated to the group class. It can be set using
21469     *   elm_map_group_class_data_set().
21470     * - min zoom to display markers, set with
21471     *   elm_map_group_class_zoom_displayed_set().
21472     * - max zoom to group markers, set using
21473     *   elm_map_group_class_zoom_grouped_set().
21474     * - visibility - set if markers will be visible or not, set with
21475     *   elm_map_group_class_hide_set().
21476     * - #ElmMapGroupIconGetFunc - used to fetch icon for markers group classes.
21477     *   It can be set using elm_map_group_class_icon_cb_set().
21478     *
21479     * @see elm_map_marker_add()
21480     * @see elm_map_group_class_style_set()
21481     * @see elm_map_group_class_data_set()
21482     * @see elm_map_group_class_zoom_displayed_set()
21483     * @see elm_map_group_class_zoom_grouped_set()
21484     * @see elm_map_group_class_hide_set()
21485     * @see elm_map_group_class_icon_cb_set()
21486     *
21487     * @ingroup Map
21488     */
21489    EAPI Elm_Map_Group_Class  *elm_map_group_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
21490
21491    /**
21492     * Set the marker's style of a group class.
21493     *
21494     * @param clas The group class.
21495     * @param style The style to be used by markers.
21496     *
21497     * Each marker must be associated to a group class, and will use the style
21498     * defined by such class when grouped to other markers.
21499     *
21500     * The following styles are provided by default theme:
21501     * @li @c radio - blue circle
21502     * @li @c radio2 - green circle
21503     * @li @c empty
21504     *
21505     * @see elm_map_group_class_new() for more details.
21506     * @see elm_map_marker_add()
21507     *
21508     * @ingroup Map
21509     */
21510    EAPI void                  elm_map_group_class_style_set(Elm_Map_Group_Class *clas, const char *style) EINA_ARG_NONNULL(1);
21511
21512    /**
21513     * Set the icon callback function of a group class.
21514     *
21515     * @param clas The group class.
21516     * @param icon_get The callback function that will return the icon.
21517     *
21518     * Each marker must be associated to a group class, and it can display a
21519     * custom icon. The function @p icon_get must return this icon.
21520     *
21521     * @see elm_map_group_class_new() for more details.
21522     * @see elm_map_marker_add()
21523     *
21524     * @ingroup Map
21525     */
21526    EAPI void                  elm_map_group_class_icon_cb_set(Elm_Map_Group_Class *clas, ElmMapGroupIconGetFunc icon_get) EINA_ARG_NONNULL(1);
21527
21528    /**
21529     * Set the data associated to the group class.
21530     *
21531     * @param clas The group class.
21532     * @param data The new user data.
21533     *
21534     * This data will be passed for callback functions, like icon get callback,
21535     * that can be set with elm_map_group_class_icon_cb_set().
21536     *
21537     * If a data was previously set, the object will lose the pointer for it,
21538     * so if needs to be freed, you must do it yourself.
21539     *
21540     * @see elm_map_group_class_new() for more details.
21541     * @see elm_map_group_class_icon_cb_set()
21542     * @see elm_map_marker_add()
21543     *
21544     * @ingroup Map
21545     */
21546    EAPI void                  elm_map_group_class_data_set(Elm_Map_Group_Class *clas, void *data) EINA_ARG_NONNULL(1);
21547
21548    /**
21549     * Set the minimum zoom from where the markers are displayed.
21550     *
21551     * @param clas The group class.
21552     * @param zoom The minimum zoom.
21553     *
21554     * Markers only will be displayed when the map is displayed at @p zoom
21555     * or bigger.
21556     *
21557     * @see elm_map_group_class_new() for more details.
21558     * @see elm_map_marker_add()
21559     *
21560     * @ingroup Map
21561     */
21562    EAPI void                  elm_map_group_class_zoom_displayed_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
21563
21564    /**
21565     * Set the zoom from where the markers are no more grouped.
21566     *
21567     * @param clas The group class.
21568     * @param zoom The maximum zoom.
21569     *
21570     * Markers only will be grouped when the map is displayed at
21571     * less than @p zoom.
21572     *
21573     * @see elm_map_group_class_new() for more details.
21574     * @see elm_map_marker_add()
21575     *
21576     * @ingroup Map
21577     */
21578    EAPI void                  elm_map_group_class_zoom_grouped_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
21579
21580    /**
21581     * Set if the markers associated to the group class @clas are hidden or not.
21582     *
21583     * @param clas The group class.
21584     * @param hide Use @c EINA_TRUE to hide markers or @c EINA_FALSE
21585     * to show them.
21586     *
21587     * If @p hide is @c EINA_TRUE the markers will be hidden, but default
21588     * is to show them.
21589     *
21590     * @ingroup Map
21591     */
21592    EAPI void                  elm_map_group_class_hide_set(Evas_Object *obj, Elm_Map_Group_Class *clas, Eina_Bool hide) EINA_ARG_NONNULL(1, 2);
21593
21594    /**
21595     * Create a new marker class.
21596     *
21597     * @param obj The map object.
21598     * @return Returns the new group class.
21599     *
21600     * Each marker must be associated to a class.
21601     *
21602     * The marker class defines the style of the marker when a marker is
21603     * displayed alone, i.e., not grouped to to others markers. When grouped
21604     * it will use group class style.
21605     *
21606     * A marker class will need to be provided when creating a marker with
21607     * elm_map_marker_add().
21608     *
21609     * Some properties and functions can be set by class, as:
21610     * - style, with elm_map_marker_class_style_set()
21611     * - #ElmMapMarkerIconGetFunc - used to fetch icon for markers classes.
21612     *   It can be set using elm_map_marker_class_icon_cb_set().
21613     * - #ElmMapMarkerGetFunc - used to fetch bubble content for marker classes.
21614     *   Set using elm_map_marker_class_get_cb_set().
21615     * - #ElmMapMarkerDelFunc - used to delete bubble content for marker classes.
21616     *   Set using elm_map_marker_class_del_cb_set().
21617     *
21618     * @see elm_map_marker_add()
21619     * @see elm_map_marker_class_style_set()
21620     * @see elm_map_marker_class_icon_cb_set()
21621     * @see elm_map_marker_class_get_cb_set()
21622     * @see elm_map_marker_class_del_cb_set()
21623     *
21624     * @ingroup Map
21625     */
21626    EAPI Elm_Map_Marker_Class *elm_map_marker_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
21627
21628    /**
21629     * Set the marker's style of a marker class.
21630     *
21631     * @param clas The marker class.
21632     * @param style The style to be used by markers.
21633     *
21634     * Each marker must be associated to a marker class, and will use the style
21635     * defined by such class when alone, i.e., @b not grouped to other markers.
21636     *
21637     * The following styles are provided by default theme:
21638     * @li @c radio
21639     * @li @c radio2
21640     * @li @c empty
21641     *
21642     * @see elm_map_marker_class_new() for more details.
21643     * @see elm_map_marker_add()
21644     *
21645     * @ingroup Map
21646     */
21647    EAPI void                  elm_map_marker_class_style_set(Elm_Map_Marker_Class *clas, const char *style) EINA_ARG_NONNULL(1);
21648
21649    /**
21650     * Set the icon callback function of a marker class.
21651     *
21652     * @param clas The marker class.
21653     * @param icon_get The callback function that will return the icon.
21654     *
21655     * Each marker must be associated to a marker class, and it can display a
21656     * custom icon. The function @p icon_get must return this icon.
21657     *
21658     * @see elm_map_marker_class_new() for more details.
21659     * @see elm_map_marker_add()
21660     *
21661     * @ingroup Map
21662     */
21663    EAPI void                  elm_map_marker_class_icon_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerIconGetFunc icon_get) EINA_ARG_NONNULL(1);
21664
21665    /**
21666     * Set the bubble content callback function of a marker class.
21667     *
21668     * @param clas The marker class.
21669     * @param get The callback function that will return the content.
21670     *
21671     * Each marker must be associated to a marker class, and it can display a
21672     * a content on a bubble that opens when the user click over the marker.
21673     * The function @p get must return this content object.
21674     *
21675     * If this content will need to be deleted, elm_map_marker_class_del_cb_set()
21676     * can be used.
21677     *
21678     * @see elm_map_marker_class_new() for more details.
21679     * @see elm_map_marker_class_del_cb_set()
21680     * @see elm_map_marker_add()
21681     *
21682     * @ingroup Map
21683     */
21684    EAPI void                  elm_map_marker_class_get_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerGetFunc get) EINA_ARG_NONNULL(1);
21685
21686    /**
21687     * Set the callback function used to delete bubble content of a marker class.
21688     *
21689     * @param clas The marker class.
21690     * @param del The callback function that will delete the content.
21691     *
21692     * Each marker must be associated to a marker class, and it can display a
21693     * a content on a bubble that opens when the user click over the marker.
21694     * The function to return such content can be set with
21695     * elm_map_marker_class_get_cb_set().
21696     *
21697     * If this content must be freed, a callback function need to be
21698     * set for that task with this function.
21699     *
21700     * If this callback is defined it will have to delete (or not) the
21701     * object inside, but if the callback is not defined the object will be
21702     * destroyed with evas_object_del().
21703     *
21704     * @see elm_map_marker_class_new() for more details.
21705     * @see elm_map_marker_class_get_cb_set()
21706     * @see elm_map_marker_add()
21707     *
21708     * @ingroup Map
21709     */
21710    EAPI void                  elm_map_marker_class_del_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerDelFunc del) EINA_ARG_NONNULL(1);
21711
21712    /**
21713     * Get the list of available sources.
21714     *
21715     * @param obj The map object.
21716     * @return The source names list.
21717     *
21718     * It will provide a list with all available sources, that can be set as
21719     * current source with elm_map_source_name_set(), or get with
21720     * elm_map_source_name_get().
21721     *
21722     * Available sources:
21723     * @li "Mapnik"
21724     * @li "Osmarender"
21725     * @li "CycleMap"
21726     * @li "Maplint"
21727     *
21728     * @see elm_map_source_name_set() for more details.
21729     * @see elm_map_source_name_get()
21730     *
21731     * @ingroup Map
21732     */
21733    EAPI const char          **elm_map_source_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21734
21735    /**
21736     * Set the source of the map.
21737     *
21738     * @param obj The map object.
21739     * @param source The source to be used.
21740     *
21741     * Map widget retrieves images that composes the map from a web service.
21742     * This web service can be set with this method.
21743     *
21744     * A different service can return a different maps with different
21745     * information and it can use different zoom values.
21746     *
21747     * The @p source_name need to match one of the names provided by
21748     * elm_map_source_names_get().
21749     *
21750     * The current source can be get using elm_map_source_name_get().
21751     *
21752     * @see elm_map_source_names_get()
21753     * @see elm_map_source_name_get()
21754     *
21755     *
21756     * @ingroup Map
21757     */
21758    EAPI void                  elm_map_source_name_set(Evas_Object *obj, const char *source_name) EINA_ARG_NONNULL(1);
21759
21760    /**
21761     * Get the name of currently used source.
21762     *
21763     * @param obj The map object.
21764     * @return Returns the name of the source in use.
21765     *
21766     * @see elm_map_source_name_set() for more details.
21767     *
21768     * @ingroup Map
21769     */
21770    EAPI const char           *elm_map_source_name_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21771
21772    /**
21773     * Set the source of the route service to be used by the map.
21774     *
21775     * @param obj The map object.
21776     * @param source The route service to be used, being it one of
21777     * #ELM_MAP_ROUTE_SOURCE_YOURS (default), #ELM_MAP_ROUTE_SOURCE_MONAV,
21778     * and #ELM_MAP_ROUTE_SOURCE_ORS.
21779     *
21780     * Each one has its own algorithm, so the route retrieved may
21781     * differ depending on the source route. Now, only the default is working.
21782     *
21783     * #ELM_MAP_ROUTE_SOURCE_YOURS is the routing service provided at
21784     * http://www.yournavigation.org/.
21785     *
21786     * #ELM_MAP_ROUTE_SOURCE_MONAV, offers exact routing without heuristic
21787     * assumptions. Its routing core is based on Contraction Hierarchies.
21788     *
21789     * #ELM_MAP_ROUTE_SOURCE_ORS, is provided at http://www.openrouteservice.org/
21790     *
21791     * @see elm_map_route_source_get().
21792     *
21793     * @ingroup Map
21794     */
21795    EAPI void                  elm_map_route_source_set(Evas_Object *obj, Elm_Map_Route_Sources source) EINA_ARG_NONNULL(1);
21796
21797    /**
21798     * Get the current route source.
21799     *
21800     * @param obj The map object.
21801     * @return The source of the route service used by the map.
21802     *
21803     * @see elm_map_route_source_set() for details.
21804     *
21805     * @ingroup Map
21806     */
21807    EAPI Elm_Map_Route_Sources elm_map_route_source_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21808
21809    /**
21810     * Set the minimum zoom of the source.
21811     *
21812     * @param obj The map object.
21813     * @param zoom New minimum zoom value to be used.
21814     *
21815     * By default, it's 0.
21816     *
21817     * @ingroup Map
21818     */
21819    EAPI void                  elm_map_source_zoom_min_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
21820
21821    /**
21822     * Get the minimum zoom of the source.
21823     *
21824     * @param obj The map object.
21825     * @return Returns the minimum zoom of the source.
21826     *
21827     * @see elm_map_source_zoom_min_set() for details.
21828     *
21829     * @ingroup Map
21830     */
21831    EAPI int                   elm_map_source_zoom_min_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21832
21833    /**
21834     * Set the maximum zoom of the source.
21835     *
21836     * @param obj The map object.
21837     * @param zoom New maximum zoom value to be used.
21838     *
21839     * By default, it's 18.
21840     *
21841     * @ingroup Map
21842     */
21843    EAPI void                  elm_map_source_zoom_max_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
21844
21845    /**
21846     * Get the maximum zoom of the source.
21847     *
21848     * @param obj The map object.
21849     * @return Returns the maximum zoom of the source.
21850     *
21851     * @see elm_map_source_zoom_min_set() for details.
21852     *
21853     * @ingroup Map
21854     */
21855    EAPI int                   elm_map_source_zoom_max_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21856
21857    /**
21858     * Set the user agent used by the map object to access routing services.
21859     *
21860     * @param obj The map object.
21861     * @param user_agent The user agent to be used by the map.
21862     *
21863     * User agent is a client application implementing a network protocol used
21864     * in communications within a client–server distributed computing system
21865     *
21866     * The @p user_agent identification string will transmitted in a header
21867     * field @c User-Agent.
21868     *
21869     * @see elm_map_user_agent_get()
21870     *
21871     * @ingroup Map
21872     */
21873    EAPI void                  elm_map_user_agent_set(Evas_Object *obj, const char *user_agent) EINA_ARG_NONNULL(1, 2);
21874
21875    /**
21876     * Get the user agent used by the map object.
21877     *
21878     * @param obj The map object.
21879     * @return The user agent identification string used by the map.
21880     *
21881     * @see elm_map_user_agent_set() for details.
21882     *
21883     * @ingroup Map
21884     */
21885    EAPI const char           *elm_map_user_agent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21886
21887    /**
21888     * Add a new route to the map object.
21889     *
21890     * @param obj The map object.
21891     * @param type The type of transport to be considered when tracing a route.
21892     * @param method The routing method, what should be priorized.
21893     * @param flon The start longitude.
21894     * @param flat The start latitude.
21895     * @param tlon The destination longitude.
21896     * @param tlat The destination latitude.
21897     *
21898     * @return The created route or @c NULL upon failure.
21899     *
21900     * A route will be traced by point on coordinates (@p flat, @p flon)
21901     * to point on coordinates (@p tlat, @p tlon), using the route service
21902     * set with elm_map_route_source_set().
21903     *
21904     * It will take @p type on consideration to define the route,
21905     * depending if the user will be walking or driving, the route may vary.
21906     * One of #ELM_MAP_ROUTE_TYPE_MOTOCAR, #ELM_MAP_ROUTE_TYPE_BICYCLE, or
21907     * #ELM_MAP_ROUTE_TYPE_FOOT need to be used.
21908     *
21909     * Another parameter is what the route should priorize, the minor distance
21910     * or the less time to be spend on the route. So @p method should be one
21911     * of #ELM_MAP_ROUTE_METHOD_SHORTEST or #ELM_MAP_ROUTE_METHOD_FASTEST.
21912     *
21913     * Routes created with this method can be deleted with
21914     * elm_map_route_remove(), colored with elm_map_route_color_set(),
21915     * and distance can be get with elm_map_route_distance_get().
21916     *
21917     * @see elm_map_route_remove()
21918     * @see elm_map_route_color_set()
21919     * @see elm_map_route_distance_get()
21920     * @see elm_map_route_source_set()
21921     *
21922     * @ingroup Map
21923     */
21924    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);
21925
21926    /**
21927     * Remove a route from the map.
21928     *
21929     * @param route The route to remove.
21930     *
21931     * @see elm_map_route_add()
21932     *
21933     * @ingroup Map
21934     */
21935    EAPI void                  elm_map_route_remove(Elm_Map_Route *route) EINA_ARG_NONNULL(1);
21936
21937    /**
21938     * Set the route color.
21939     *
21940     * @param route The route object.
21941     * @param r Red channel value, from 0 to 255.
21942     * @param g Green channel value, from 0 to 255.
21943     * @param b Blue channel value, from 0 to 255.
21944     * @param a Alpha channel value, from 0 to 255.
21945     *
21946     * It uses an additive color model, so each color channel represents
21947     * how much of each primary colors must to be used. 0 represents
21948     * ausence of this color, so if all of the three are set to 0,
21949     * the color will be black.
21950     *
21951     * These component values should be integers in the range 0 to 255,
21952     * (single 8-bit byte).
21953     *
21954     * This sets the color used for the route. By default, it is set to
21955     * solid red (r = 255, g = 0, b = 0, a = 255).
21956     *
21957     * For alpha channel, 0 represents completely transparent, and 255, opaque.
21958     *
21959     * @see elm_map_route_color_get()
21960     *
21961     * @ingroup Map
21962     */
21963    EAPI void                  elm_map_route_color_set(Elm_Map_Route *route, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
21964
21965    /**
21966     * Get the route color.
21967     *
21968     * @param route The route object.
21969     * @param r Pointer where to store the red channel value.
21970     * @param g Pointer where to store the green channel value.
21971     * @param b Pointer where to store the blue channel value.
21972     * @param a Pointer where to store the alpha channel value.
21973     *
21974     * @see elm_map_route_color_set() for details.
21975     *
21976     * @ingroup Map
21977     */
21978    EAPI void                  elm_map_route_color_get(const Elm_Map_Route *route, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
21979
21980    /**
21981     * Get the route distance in kilometers.
21982     *
21983     * @param route The route object.
21984     * @return The distance of route (unit : km).
21985     *
21986     * @ingroup Map
21987     */
21988    EAPI double                elm_map_route_distance_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
21989
21990    /**
21991     * Get the information of route nodes.
21992     *
21993     * @param route The route object.
21994     * @return Returns a string with the nodes of route.
21995     *
21996     * @ingroup Map
21997     */
21998    EAPI const char           *elm_map_route_node_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
21999
22000    /**
22001     * Get the information of route waypoint.
22002     *
22003     * @param route the route object.
22004     * @return Returns a string with information about waypoint of route.
22005     *
22006     * @ingroup Map
22007     */
22008    EAPI const char           *elm_map_route_waypoint_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
22009
22010    /**
22011     * Get the address of the name.
22012     *
22013     * @param name The name handle.
22014     * @return Returns the address string of @p name.
22015     *
22016     * This gets the coordinates of the @p name, created with one of the
22017     * conversion functions.
22018     *
22019     * @see elm_map_utils_convert_name_into_coord()
22020     * @see elm_map_utils_convert_coord_into_name()
22021     *
22022     * @ingroup Map
22023     */
22024    EAPI const char           *elm_map_name_address_get(const Elm_Map_Name *name) EINA_ARG_NONNULL(1);
22025
22026    /**
22027     * Get the current coordinates of the name.
22028     *
22029     * @param name The name handle.
22030     * @param lat Pointer where to store the latitude.
22031     * @param lon Pointer where to store The longitude.
22032     *
22033     * This gets the coordinates of the @p name, created with one of the
22034     * conversion functions.
22035     *
22036     * @see elm_map_utils_convert_name_into_coord()
22037     * @see elm_map_utils_convert_coord_into_name()
22038     *
22039     * @ingroup Map
22040     */
22041    EAPI void                  elm_map_name_region_get(const Elm_Map_Name *name, double *lon, double *lat) EINA_ARG_NONNULL(1);
22042
22043    /**
22044     * Remove a name from the map.
22045     *
22046     * @param name The name to remove.
22047     *
22048     * Basically the struct handled by @p name will be freed, so convertions
22049     * between address and coordinates will be lost.
22050     *
22051     * @see elm_map_utils_convert_name_into_coord()
22052     * @see elm_map_utils_convert_coord_into_name()
22053     *
22054     * @ingroup Map
22055     */
22056    EAPI void                  elm_map_name_remove(Elm_Map_Name *name) EINA_ARG_NONNULL(1);
22057
22058    /**
22059     * Rotate the map.
22060     *
22061     * @param obj The map object.
22062     * @param degree Angle from 0.0 to 360.0 to rotate arount Z axis.
22063     * @param cx Rotation's center horizontal position.
22064     * @param cy Rotation's center vertical position.
22065     *
22066     * @see elm_map_rotate_get()
22067     *
22068     * @ingroup Map
22069     */
22070    EAPI void                  elm_map_rotate_set(Evas_Object *obj, double degree, Evas_Coord cx, Evas_Coord cy) EINA_ARG_NONNULL(1);
22071
22072    /**
22073     * Get the rotate degree of the map
22074     *
22075     * @param obj The map object
22076     * @param degree Pointer where to store degrees from 0.0 to 360.0
22077     * to rotate arount Z axis.
22078     * @param cx Pointer where to store rotation's center horizontal position.
22079     * @param cy Pointer where to store rotation's center vertical position.
22080     *
22081     * @see elm_map_rotate_set() to set map rotation.
22082     *
22083     * @ingroup Map
22084     */
22085    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);
22086
22087    /**
22088     * Enable or disable mouse wheel to be used to zoom in / out the map.
22089     *
22090     * @param obj The map object.
22091     * @param disabled Use @c EINA_TRUE to disable mouse wheel or @c EINA_FALSE
22092     * to enable it.
22093     *
22094     * Mouse wheel can be used for the user to zoom in or zoom out the map.
22095     *
22096     * It's disabled by default.
22097     *
22098     * @see elm_map_wheel_disabled_get()
22099     *
22100     * @ingroup Map
22101     */
22102    EAPI void                  elm_map_wheel_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
22103
22104    /**
22105     * Get a value whether mouse wheel is enabled or not.
22106     *
22107     * @param obj The map object.
22108     * @return @c EINA_TRUE means map is disabled. @c EINA_FALSE indicates
22109     * it is enabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
22110     *
22111     * Mouse wheel can be used for the user to zoom in or zoom out the map.
22112     *
22113     * @see elm_map_wheel_disabled_set() for details.
22114     *
22115     * @ingroup Map
22116     */
22117    EAPI Eina_Bool             elm_map_wheel_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22118
22119 #ifdef ELM_EMAP
22120    /**
22121     * Add a track on the map
22122     *
22123     * @param obj The map object.
22124     * @param emap The emap route object.
22125     * @return The route object. This is an elm object of type Route.
22126     *
22127     * @see elm_route_add() for details.
22128     *
22129     * @ingroup Map
22130     */
22131    EAPI Evas_Object          *elm_map_track_add(Evas_Object *obj, EMap_Route *emap) EINA_ARG_NONNULL(1);
22132 #endif
22133
22134    /**
22135     * Remove a track from the map
22136     *
22137     * @param obj The map object.
22138     * @param route The track to remove.
22139     *
22140     * @ingroup Map
22141     */
22142    EAPI void                  elm_map_track_remove(Evas_Object *obj, Evas_Object *route) EINA_ARG_NONNULL(1);
22143
22144    /**
22145     * @}
22146     */
22147
22148    /* Route */
22149    EAPI Evas_Object *elm_route_add(Evas_Object *parent);
22150 #ifdef ELM_EMAP
22151    EAPI void elm_route_emap_set(Evas_Object *obj, EMap_Route *emap);
22152 #endif
22153    EAPI double elm_route_lon_min_get(Evas_Object *obj);
22154    EAPI double elm_route_lat_min_get(Evas_Object *obj);
22155    EAPI double elm_route_lon_max_get(Evas_Object *obj);
22156    EAPI double elm_route_lat_max_get(Evas_Object *obj);
22157
22158
22159    /**
22160     * @defgroup Panel Panel
22161     *
22162     * @image html img/widget/panel/preview-00.png
22163     * @image latex img/widget/panel/preview-00.eps
22164     *
22165     * @brief A panel is a type of animated container that contains subobjects.
22166     * It can be expanded or contracted by clicking the button on it's edge.
22167     *
22168     * Orientations are as follows:
22169     * @li ELM_PANEL_ORIENT_TOP
22170     * @li ELM_PANEL_ORIENT_LEFT
22171     * @li ELM_PANEL_ORIENT_RIGHT
22172     *
22173     * @ref tutorial_panel shows one way to use this widget.
22174     * @{
22175     */
22176    typedef enum _Elm_Panel_Orient
22177      {
22178         ELM_PANEL_ORIENT_TOP, /**< Panel (dis)appears from the top */
22179         ELM_PANEL_ORIENT_BOTTOM, /**< Not implemented */
22180         ELM_PANEL_ORIENT_LEFT, /**< Panel (dis)appears from the left */
22181         ELM_PANEL_ORIENT_RIGHT, /**< Panel (dis)appears from the right */
22182      } Elm_Panel_Orient;
22183    /**
22184     * @brief Adds a panel object
22185     *
22186     * @param parent The parent object
22187     *
22188     * @return The panel object, or NULL on failure
22189     */
22190    EAPI Evas_Object          *elm_panel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22191    /**
22192     * @brief Sets the orientation of the panel
22193     *
22194     * @param parent The parent object
22195     * @param orient The panel orientation. Can be one of the following:
22196     * @li ELM_PANEL_ORIENT_TOP
22197     * @li ELM_PANEL_ORIENT_LEFT
22198     * @li ELM_PANEL_ORIENT_RIGHT
22199     *
22200     * Sets from where the panel will (dis)appear.
22201     */
22202    EAPI void                  elm_panel_orient_set(Evas_Object *obj, Elm_Panel_Orient orient) EINA_ARG_NONNULL(1);
22203    /**
22204     * @brief Get the orientation of the panel.
22205     *
22206     * @param obj The panel object
22207     * @return The Elm_Panel_Orient, or ELM_PANEL_ORIENT_LEFT on failure.
22208     */
22209    EAPI Elm_Panel_Orient      elm_panel_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22210    /**
22211     * @brief Set the content of the panel.
22212     *
22213     * @param obj The panel object
22214     * @param content The panel content
22215     *
22216     * Once the content object is set, a previously set one will be deleted.
22217     * If you want to keep that old content object, use the
22218     * elm_panel_content_unset() function.
22219     */
22220    EAPI void                  elm_panel_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22221    /**
22222     * @brief Get the content of the panel.
22223     *
22224     * @param obj The panel object
22225     * @return The content that is being used
22226     *
22227     * Return the content object which is set for this widget.
22228     *
22229     * @see elm_panel_content_set()
22230     */
22231    EAPI Evas_Object          *elm_panel_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22232    /**
22233     * @brief Unset the content of the panel.
22234     *
22235     * @param obj The panel object
22236     * @return The content that was being used
22237     *
22238     * Unparent and return the content object which was set for this widget.
22239     *
22240     * @see elm_panel_content_set()
22241     */
22242    EAPI Evas_Object          *elm_panel_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22243    /**
22244     * @brief Set the state of the panel.
22245     *
22246     * @param obj The panel object
22247     * @param hidden If true, the panel will run the animation to contract
22248     */
22249    EAPI void                  elm_panel_hidden_set(Evas_Object *obj, Eina_Bool hidden) EINA_ARG_NONNULL(1);
22250    /**
22251     * @brief Get the state of the panel.
22252     *
22253     * @param obj The panel object
22254     * @param hidden If true, the panel is in the "hide" state
22255     */
22256    EAPI Eina_Bool             elm_panel_hidden_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22257    /**
22258     * @brief Toggle the hidden state of the panel from code
22259     *
22260     * @param obj The panel object
22261     */
22262    EAPI void                  elm_panel_toggle(Evas_Object *obj) EINA_ARG_NONNULL(1);
22263    /**
22264     * @}
22265     */
22266
22267    /**
22268     * @defgroup Panes Panes
22269     * @ingroup Elementary
22270     *
22271     * @image html img/widget/panes/preview-00.png
22272     * @image latex img/widget/panes/preview-00.eps width=\textwidth
22273     *
22274     * @image html img/panes.png
22275     * @image latex img/panes.eps width=\textwidth
22276     *
22277     * The panes adds a dragable bar between two contents. When dragged
22278     * this bar will resize contents size.
22279     *
22280     * Panes can be displayed vertically or horizontally, and contents
22281     * size proportion can be customized (homogeneous by default).
22282     *
22283     * Smart callbacks one can listen to:
22284     * - "press" - The panes has been pressed (button wasn't released yet).
22285     * - "unpressed" - The panes was released after being pressed.
22286     * - "clicked" - The panes has been clicked>
22287     * - "clicked,double" - The panes has been double clicked
22288     *
22289     * Available styles for it:
22290     * - @c "default"
22291     *
22292     * Here is an example on its usage:
22293     * @li @ref panes_example
22294     */
22295
22296    /**
22297     * @addtogroup Panes
22298     * @{
22299     */
22300
22301    /**
22302     * Add a new panes widget to the given parent Elementary
22303     * (container) object.
22304     *
22305     * @param parent The parent object.
22306     * @return a new panes widget handle or @c NULL, on errors.
22307     *
22308     * This function inserts a new panes widget on the canvas.
22309     *
22310     * @ingroup Panes
22311     */
22312    EAPI Evas_Object          *elm_panes_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22313
22314    /**
22315     * Set the left content of the panes widget.
22316     *
22317     * @param obj The panes object.
22318     * @param content The new left content object.
22319     *
22320     * Once the content object is set, a previously set one will be deleted.
22321     * If you want to keep that old content object, use the
22322     * elm_panes_content_left_unset() function.
22323     *
22324     * If panes is displayed vertically, left content will be displayed at
22325     * top.
22326     *
22327     * @see elm_panes_content_left_get()
22328     * @see elm_panes_content_right_set() to set content on the other side.
22329     *
22330     * @ingroup Panes
22331     */
22332    EAPI void                  elm_panes_content_left_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22333
22334    /**
22335     * Set the right content of the panes widget.
22336     *
22337     * @param obj The panes object.
22338     * @param content The new right content object.
22339     *
22340     * Once the content object is set, a previously set one will be deleted.
22341     * If you want to keep that old content object, use the
22342     * elm_panes_content_right_unset() function.
22343     *
22344     * If panes is displayed vertically, left content will be displayed at
22345     * bottom.
22346     *
22347     * @see elm_panes_content_right_get()
22348     * @see elm_panes_content_left_set() to set content on the other side.
22349     *
22350     * @ingroup Panes
22351     */
22352    EAPI void                  elm_panes_content_right_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22353
22354    /**
22355     * Get the left content of the panes.
22356     *
22357     * @param obj The panes object.
22358     * @return The left content object that is being used.
22359     *
22360     * Return the left content object which is set for this widget.
22361     *
22362     * @see elm_panes_content_left_set() for details.
22363     *
22364     * @ingroup Panes
22365     */
22366    EAPI Evas_Object          *elm_panes_content_left_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22367
22368    /**
22369     * Get the right content of the panes.
22370     *
22371     * @param obj The panes object
22372     * @return The right content object that is being used
22373     *
22374     * Return the right content object which is set for this widget.
22375     *
22376     * @see elm_panes_content_right_set() for details.
22377     *
22378     * @ingroup Panes
22379     */
22380    EAPI Evas_Object          *elm_panes_content_right_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22381
22382    /**
22383     * Unset the left content used for the panes.
22384     *
22385     * @param obj The panes object.
22386     * @return The left content object that was being used.
22387     *
22388     * Unparent and return the left content object which was set for this widget.
22389     *
22390     * @see elm_panes_content_left_set() for details.
22391     * @see elm_panes_content_left_get().
22392     *
22393     * @ingroup Panes
22394     */
22395    EAPI Evas_Object          *elm_panes_content_left_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22396
22397    /**
22398     * Unset the right content used for the panes.
22399     *
22400     * @param obj The panes object.
22401     * @return The right content object that was being used.
22402     *
22403     * Unparent and return the right content object which was set for this
22404     * widget.
22405     *
22406     * @see elm_panes_content_right_set() for details.
22407     * @see elm_panes_content_right_get().
22408     *
22409     * @ingroup Panes
22410     */
22411    EAPI Evas_Object          *elm_panes_content_right_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22412
22413    /**
22414     * Get the size proportion of panes widget's left side.
22415     *
22416     * @param obj The panes object.
22417     * @return float value between 0.0 and 1.0 representing size proportion
22418     * of left side.
22419     *
22420     * @see elm_panes_content_left_size_set() for more details.
22421     *
22422     * @ingroup Panes
22423     */
22424    EAPI double                elm_panes_content_left_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22425
22426    /**
22427     * Set the size proportion of panes widget's left side.
22428     *
22429     * @param obj The panes object.
22430     * @param size Value between 0.0 and 1.0 representing size proportion
22431     * of left side.
22432     *
22433     * By default it's homogeneous, i.e., both sides have the same size.
22434     *
22435     * If something different is required, it can be set with this function.
22436     * For example, if the left content should be displayed over
22437     * 75% of the panes size, @p size should be passed as @c 0.75.
22438     * This way, right content will be resized to 25% of panes size.
22439     *
22440     * If displayed vertically, left content is displayed at top, and
22441     * right content at bottom.
22442     *
22443     * @note This proportion will change when user drags the panes bar.
22444     *
22445     * @see elm_panes_content_left_size_get()
22446     *
22447     * @ingroup Panes
22448     */
22449    EAPI void                  elm_panes_content_left_size_set(Evas_Object *obj, double size) EINA_ARG_NONNULL(1);
22450
22451   /**
22452    * Set the orientation of a given panes widget.
22453    *
22454    * @param obj The panes object.
22455    * @param horizontal Use @c EINA_TRUE to make @p obj to be
22456    * @b horizontal, @c EINA_FALSE to make it @b vertical.
22457    *
22458    * Use this function to change how your panes is to be
22459    * disposed: vertically or horizontally.
22460    *
22461    * By default it's displayed horizontally.
22462    *
22463    * @see elm_panes_horizontal_get()
22464    *
22465    * @ingroup Panes
22466    */
22467    EAPI void                  elm_panes_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
22468
22469    /**
22470     * Retrieve the orientation of a given panes widget.
22471     *
22472     * @param obj The panes object.
22473     * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
22474     * @c EINA_FALSE if it's @b vertical (and on errors).
22475     *
22476     * @see elm_panes_horizontal_set() for more details.
22477     *
22478     * @ingroup Panes
22479     */
22480    EAPI Eina_Bool             elm_panes_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22481
22482    /**
22483     * @}
22484     */
22485
22486    /**
22487     * @defgroup Flip Flip
22488     *
22489     * @image html img/widget/flip/preview-00.png
22490     * @image latex img/widget/flip/preview-00.eps
22491     *
22492     * This widget holds 2 content objects(Evas_Object): one on the front and one
22493     * on the back. It allows you to flip from front to back and vice-versa using
22494     * various animations.
22495     *
22496     * If either the front or back contents are not set the flip will treat that
22497     * as transparent. So if you wore to set the front content but not the back,
22498     * and then call elm_flip_go() you would see whatever is below the flip.
22499     *
22500     * For a list of supported animations see elm_flip_go().
22501     *
22502     * Signals that you can add callbacks for are:
22503     * "animate,begin" - when a flip animation was started
22504     * "animate,done" - when a flip animation is finished
22505     *
22506     * @ref tutorial_flip show how to use most of the API.
22507     *
22508     * @{
22509     */
22510    typedef enum _Elm_Flip_Mode
22511      {
22512         ELM_FLIP_ROTATE_Y_CENTER_AXIS,
22513         ELM_FLIP_ROTATE_X_CENTER_AXIS,
22514         ELM_FLIP_ROTATE_XZ_CENTER_AXIS,
22515         ELM_FLIP_ROTATE_YZ_CENTER_AXIS,
22516         ELM_FLIP_CUBE_LEFT,
22517         ELM_FLIP_CUBE_RIGHT,
22518         ELM_FLIP_CUBE_UP,
22519         ELM_FLIP_CUBE_DOWN,
22520         ELM_FLIP_PAGE_LEFT,
22521         ELM_FLIP_PAGE_RIGHT,
22522         ELM_FLIP_PAGE_UP,
22523         ELM_FLIP_PAGE_DOWN
22524      } Elm_Flip_Mode;
22525    typedef enum _Elm_Flip_Interaction
22526      {
22527         ELM_FLIP_INTERACTION_NONE,
22528         ELM_FLIP_INTERACTION_ROTATE,
22529         ELM_FLIP_INTERACTION_CUBE,
22530         ELM_FLIP_INTERACTION_PAGE
22531      } Elm_Flip_Interaction;
22532    typedef enum _Elm_Flip_Direction
22533      {
22534         ELM_FLIP_DIRECTION_UP, /**< Allows interaction with the top of the widget */
22535         ELM_FLIP_DIRECTION_DOWN, /**< Allows interaction with the bottom of the widget */
22536         ELM_FLIP_DIRECTION_LEFT, /**< Allows interaction with the left portion of the widget */
22537         ELM_FLIP_DIRECTION_RIGHT /**< Allows interaction with the right portion of the widget */
22538      } Elm_Flip_Direction;
22539    /**
22540     * @brief Add a new flip to the parent
22541     *
22542     * @param parent The parent object
22543     * @return The new object or NULL if it cannot be created
22544     */
22545    EAPI Evas_Object *elm_flip_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22546    /**
22547     * @brief Set the front content of the flip widget.
22548     *
22549     * @param obj The flip object
22550     * @param content The new front content object
22551     *
22552     * Once the content object is set, a previously set one will be deleted.
22553     * If you want to keep that old content object, use the
22554     * elm_flip_content_front_unset() function.
22555     */
22556    EAPI void         elm_flip_content_front_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22557    /**
22558     * @brief Set the back content of the flip widget.
22559     *
22560     * @param obj The flip object
22561     * @param content The new back content object
22562     *
22563     * Once the content object is set, a previously set one will be deleted.
22564     * If you want to keep that old content object, use the
22565     * elm_flip_content_back_unset() function.
22566     */
22567    EAPI void         elm_flip_content_back_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22568    /**
22569     * @brief Get the front content used for the flip
22570     *
22571     * @param obj The flip object
22572     * @return The front content object that is being used
22573     *
22574     * Return the front content object which is set for this widget.
22575     */
22576    EAPI Evas_Object *elm_flip_content_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22577    /**
22578     * @brief Get the back content used for the flip
22579     *
22580     * @param obj The flip object
22581     * @return The back content object that is being used
22582     *
22583     * Return the back content object which is set for this widget.
22584     */
22585    EAPI Evas_Object *elm_flip_content_back_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22586    /**
22587     * @brief Unset the front content used for the flip
22588     *
22589     * @param obj The flip object
22590     * @return The front content object that was being used
22591     *
22592     * Unparent and return the front content object which was set for this widget.
22593     */
22594    EAPI Evas_Object *elm_flip_content_front_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22595    /**
22596     * @brief Unset the back content used for the flip
22597     *
22598     * @param obj The flip object
22599     * @return The back content object that was being used
22600     *
22601     * Unparent and return the back content object which was set for this widget.
22602     */
22603    EAPI Evas_Object *elm_flip_content_back_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22604    /**
22605     * @brief Get flip front visibility state
22606     *
22607     * @param obj The flip objct
22608     * @return EINA_TRUE if front front is showing, EINA_FALSE if the back is
22609     * showing.
22610     */
22611    EAPI Eina_Bool    elm_flip_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22612    /**
22613     * @brief Set flip perspective
22614     *
22615     * @param obj The flip object
22616     * @param foc The coordinate to set the focus on
22617     * @param x The X coordinate
22618     * @param y The Y coordinate
22619     *
22620     * @warning This function currently does nothing.
22621     */
22622    EAPI void         elm_flip_perspective_set(Evas_Object *obj, Evas_Coord foc, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
22623    /**
22624     * @brief Runs the flip animation
22625     *
22626     * @param obj The flip object
22627     * @param mode The mode type
22628     *
22629     * Flips the front and back contents using the @p mode animation. This
22630     * efectively hides the currently visible content and shows the hidden one.
22631     *
22632     * There a number of possible animations to use for the flipping:
22633     * @li ELM_FLIP_ROTATE_X_CENTER_AXIS - Rotate the currently visible content
22634     * around a horizontal axis in the middle of its height, the other content
22635     * is shown as the other side of the flip.
22636     * @li ELM_FLIP_ROTATE_Y_CENTER_AXIS - Rotate the currently visible content
22637     * around a vertical axis in the middle of its width, the other content is
22638     * shown as the other side of the flip.
22639     * @li ELM_FLIP_ROTATE_XZ_CENTER_AXIS - Rotate the currently visible content
22640     * around a diagonal axis in the middle of its width, the other content is
22641     * shown as the other side of the flip.
22642     * @li ELM_FLIP_ROTATE_YZ_CENTER_AXIS - Rotate the currently visible content
22643     * around a diagonal axis in the middle of its height, the other content is
22644     * shown as the other side of the flip.
22645     * @li ELM_FLIP_CUBE_LEFT - Rotate the currently visible content to the left
22646     * as if the flip was a cube, the other content is show as the right face of
22647     * the cube.
22648     * @li ELM_FLIP_CUBE_RIGHT - Rotate the currently visible content to the
22649     * right as if the flip was a cube, the other content is show as the left
22650     * face of the cube.
22651     * @li ELM_FLIP_CUBE_UP - Rotate the currently visible content up as if the
22652     * flip was a cube, the other content is show as the bottom face of the cube.
22653     * @li ELM_FLIP_CUBE_DOWN - Rotate the currently visible content down as if
22654     * the flip was a cube, the other content is show as the upper face of the
22655     * cube.
22656     * @li ELM_FLIP_PAGE_LEFT - Move the currently visible content to the left as
22657     * if the flip was a book, the other content is shown as the page below that.
22658     * @li ELM_FLIP_PAGE_RIGHT - Move the currently visible content to the right
22659     * as if the flip was a book, the other content is shown as the page below
22660     * that.
22661     * @li ELM_FLIP_PAGE_UP - Move the currently visible content up as if the
22662     * flip was a book, the other content is shown as the page below that.
22663     * @li ELM_FLIP_PAGE_DOWN - Move the currently visible content down as if the
22664     * flip was a book, the other content is shown as the page below that.
22665     *
22666     * @image html elm_flip.png
22667     * @image latex elm_flip.eps width=\textwidth
22668     */
22669    EAPI void         elm_flip_go(Evas_Object *obj, Elm_Flip_Mode mode) EINA_ARG_NONNULL(1);
22670    /**
22671     * @brief Set the interactive flip mode
22672     *
22673     * @param obj The flip object
22674     * @param mode The interactive flip mode to use
22675     *
22676     * This sets if the flip should be interactive (allow user to click and
22677     * drag a side of the flip to reveal the back page and cause it to flip).
22678     * By default a flip is not interactive. You may also need to set which
22679     * sides of the flip are "active" for flipping and how much space they use
22680     * (a minimum of a finger size) with elm_flip_interacton_direction_enabled_set()
22681     * and elm_flip_interacton_direction_hitsize_set()
22682     *
22683     * The four avilable mode of interaction are:
22684     * @li ELM_FLIP_INTERACTION_NONE - No interaction is allowed
22685     * @li ELM_FLIP_INTERACTION_ROTATE - Interaction will cause rotate animation
22686     * @li ELM_FLIP_INTERACTION_CUBE - Interaction will cause cube animation
22687     * @li ELM_FLIP_INTERACTION_PAGE - Interaction will cause page animation
22688     *
22689     * @note ELM_FLIP_INTERACTION_ROTATE won't cause
22690     * ELM_FLIP_ROTATE_XZ_CENTER_AXIS or ELM_FLIP_ROTATE_YZ_CENTER_AXIS to
22691     * happen, those can only be acheived with elm_flip_go();
22692     */
22693    EAPI void         elm_flip_interaction_set(Evas_Object *obj, Elm_Flip_Interaction mode);
22694    /**
22695     * @brief Get the interactive flip mode
22696     *
22697     * @param obj The flip object
22698     * @return The interactive flip mode
22699     *
22700     * Returns the interactive flip mode set by elm_flip_interaction_set()
22701     */
22702    EAPI Elm_Flip_Interaction elm_flip_interaction_get(const Evas_Object *obj);
22703    /**
22704     * @brief Set which directions of the flip respond to interactive flip
22705     *
22706     * @param obj The flip object
22707     * @param dir The direction to change
22708     * @param enabled If that direction is enabled or not
22709     *
22710     * By default all directions are disabled, so you may want to enable the
22711     * desired directions for flipping if you need interactive flipping. You must
22712     * call this function once for each direction that should be enabled.
22713     *
22714     * @see elm_flip_interaction_set()
22715     */
22716    EAPI void         elm_flip_interacton_direction_enabled_set(Evas_Object *obj, Elm_Flip_Direction dir, Eina_Bool enabled);
22717    /**
22718     * @brief Get the enabled state of that flip direction
22719     *
22720     * @param obj The flip object
22721     * @param dir The direction to check
22722     * @return If that direction is enabled or not
22723     *
22724     * Gets the enabled state set by elm_flip_interacton_direction_enabled_set()
22725     *
22726     * @see elm_flip_interaction_set()
22727     */
22728    EAPI Eina_Bool    elm_flip_interacton_direction_enabled_get(Evas_Object *obj, Elm_Flip_Direction dir);
22729    /**
22730     * @brief Set the amount of the flip that is sensitive to interactive flip
22731     *
22732     * @param obj The flip object
22733     * @param dir The direction to modify
22734     * @param hitsize The amount of that dimension (0.0 to 1.0) to use
22735     *
22736     * Set the amount of the flip that is sensitive to interactive flip, with 0
22737     * representing no area in the flip and 1 representing the entire flip. There
22738     * is however a consideration to be made in that the area will never be
22739     * smaller than the finger size set(as set in your Elementary configuration).
22740     *
22741     * @see elm_flip_interaction_set()
22742     */
22743    EAPI void         elm_flip_interacton_direction_hitsize_set(Evas_Object *obj, Elm_Flip_Direction dir, double hitsize);
22744    /**
22745     * @brief Get the amount of the flip that is sensitive to interactive flip
22746     *
22747     * @param obj The flip object
22748     * @param dir The direction to check
22749     * @return The size set for that direction
22750     *
22751     * Returns the amount os sensitive area set by
22752     * elm_flip_interacton_direction_hitsize_set().
22753     */
22754    EAPI double       elm_flip_interacton_direction_hitsize_get(Evas_Object *obj, Elm_Flip_Direction dir);
22755    /**
22756     * @}
22757     */
22758
22759    /* scrolledentry */
22760    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22761    EINA_DEPRECATED EAPI void         elm_scrolled_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
22762    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22763    EINA_DEPRECATED EAPI void         elm_scrolled_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
22764    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22765    EINA_DEPRECATED EAPI void         elm_scrolled_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
22766    EINA_DEPRECATED EAPI const char  *elm_scrolled_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22767    EINA_DEPRECATED EAPI void         elm_scrolled_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
22768    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22769    EINA_DEPRECATED EAPI const char  *elm_scrolled_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22770    EINA_DEPRECATED EAPI void         elm_scrolled_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
22771    EINA_DEPRECATED EAPI void         elm_scrolled_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
22772    EINA_DEPRECATED EAPI void         elm_scrolled_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
22773    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22774    EINA_DEPRECATED EAPI void         elm_scrolled_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
22775    EINA_DEPRECATED EAPI void         elm_scrolled_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
22776    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
22777    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
22778    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
22779    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
22780    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
22781    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
22782    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
22783    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
22784    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
22785    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
22786    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22787    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22788    EINA_DEPRECATED EAPI const char  *elm_scrolled_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22789    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
22790    EINA_DEPRECATED EAPI int          elm_scrolled_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22791    EINA_DEPRECATED EAPI void         elm_scrolled_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
22792    EINA_DEPRECATED EAPI void         elm_scrolled_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
22793    EINA_DEPRECATED EAPI void         elm_scrolled_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
22794    EINA_DEPRECATED EAPI void         elm_scrolled_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
22795    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);
22796    EINA_DEPRECATED EAPI void         elm_scrolled_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
22797    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22798    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);
22799    EINA_DEPRECATED EAPI void         elm_scrolled_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
22800    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);
22801    EINA_DEPRECATED EAPI void         elm_scrolled_entry_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1, 2);
22802    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22803    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22804    EINA_DEPRECATED EAPI void         elm_scrolled_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
22805    EINA_DEPRECATED EAPI void         elm_scrolled_entry_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1, 2);
22806    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22807    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22808    EINA_DEPRECATED EAPI void         elm_scrolled_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
22809    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);
22810    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);
22811    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);
22812    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);
22813    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);
22814    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);
22815    EINA_DEPRECATED EAPI void         elm_scrolled_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
22816    EINA_DEPRECATED EAPI void         elm_scrolled_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
22817    EINA_DEPRECATED EAPI void         elm_scrolled_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
22818    EINA_DEPRECATED EAPI void         elm_scrolled_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
22819    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22820    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
22821    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cnp_textonly_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
22822
22823    /**
22824     * @defgroup Conformant Conformant
22825     * @ingroup Elementary
22826     *
22827     * @image html img/widget/conformant/preview-00.png
22828     * @image latex img/widget/conformant/preview-00.eps width=\textwidth
22829     *
22830     * @image html img/conformant.png
22831     * @image latex img/conformant.eps width=\textwidth
22832     *
22833     * The aim is to provide a widget that can be used in elementary apps to
22834     * account for space taken up by the indicator, virtual keypad & softkey
22835     * windows when running the illume2 module of E17.
22836     *
22837     * So conformant content will be sized and positioned considering the
22838     * space required for such stuff, and when they popup, as a keyboard
22839     * shows when an entry is selected, conformant content won't change.
22840     *
22841     * Available styles for it:
22842     * - @c "default"
22843     *
22844     * See how to use this widget in this example:
22845     * @ref conformant_example
22846     */
22847
22848    /**
22849     * @addtogroup Conformant
22850     * @{
22851     */
22852
22853    /**
22854     * Add a new conformant widget to the given parent Elementary
22855     * (container) object.
22856     *
22857     * @param parent The parent object.
22858     * @return A new conformant widget handle or @c NULL, on errors.
22859     *
22860     * This function inserts a new conformant widget on the canvas.
22861     *
22862     * @ingroup Conformant
22863     */
22864    EAPI Evas_Object *elm_conformant_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22865
22866    /**
22867     * Set the content of the conformant widget.
22868     *
22869     * @param obj The conformant object.
22870     * @param content The content to be displayed by the conformant.
22871     *
22872     * Content will be sized and positioned considering the space required
22873     * to display a virtual keyboard. So it won't fill all the conformant
22874     * size. This way is possible to be sure that content won't resize
22875     * or be re-positioned after the keyboard is displayed.
22876     *
22877     * Once the content object is set, a previously set one will be deleted.
22878     * If you want to keep that old content object, use the
22879     * elm_conformat_content_unset() function.
22880     *
22881     * @see elm_conformant_content_unset()
22882     * @see elm_conformant_content_get()
22883     *
22884     * @ingroup Conformant
22885     */
22886    EAPI void         elm_conformant_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22887
22888    /**
22889     * Get the content of the conformant widget.
22890     *
22891     * @param obj The conformant object.
22892     * @return The content that is being used.
22893     *
22894     * Return the content object which is set for this widget.
22895     * It won't be unparent from conformant. For that, use
22896     * elm_conformant_content_unset().
22897     *
22898     * @see elm_conformant_content_set() for more details.
22899     * @see elm_conformant_content_unset()
22900     *
22901     * @ingroup Conformant
22902     */
22903    EAPI Evas_Object *elm_conformant_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22904
22905    /**
22906     * Unset the content of the conformant widget.
22907     *
22908     * @param obj The conformant object.
22909     * @return The content that was being used.
22910     *
22911     * Unparent and return the content object which was set for this widget.
22912     *
22913     * @see elm_conformant_content_set() for more details.
22914     *
22915     * @ingroup Conformant
22916     */
22917    EAPI Evas_Object *elm_conformant_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
22918
22919    /**
22920     * Returns the Evas_Object that represents the content area.
22921     *
22922     * @param obj The conformant object.
22923     * @return The content area of the widget.
22924     *
22925     * @ingroup Conformant
22926     */
22927    EAPI Evas_Object *elm_conformant_content_area_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22928
22929    /**
22930     * @}
22931     */
22932
22933    /**
22934     * @defgroup Mapbuf Mapbuf
22935     * @ingroup Elementary
22936     *
22937     * @image html img/widget/mapbuf/preview-00.png
22938     * @image latex img/widget/mapbuf/preview-00.eps width=\textwidth
22939     *
22940     * This holds one content object and uses an Evas Map of transformation
22941     * points to be later used with this content. So the content will be
22942     * moved, resized, etc as a single image. So it will improve performance
22943     * when you have a complex interafce, with a lot of elements, and will
22944     * need to resize or move it frequently (the content object and its
22945     * children).
22946     *
22947     * See how to use this widget in this example:
22948     * @ref mapbuf_example
22949     */
22950
22951    /**
22952     * @addtogroup Mapbuf
22953     * @{
22954     */
22955
22956    /**
22957     * Add a new mapbuf widget to the given parent Elementary
22958     * (container) object.
22959     *
22960     * @param parent The parent object.
22961     * @return A new mapbuf widget handle or @c NULL, on errors.
22962     *
22963     * This function inserts a new mapbuf widget on the canvas.
22964     *
22965     * @ingroup Mapbuf
22966     */
22967    EAPI Evas_Object *elm_mapbuf_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22968
22969    /**
22970     * Set the content of the mapbuf.
22971     *
22972     * @param obj The mapbuf object.
22973     * @param content The content that will be filled in this mapbuf object.
22974     *
22975     * Once the content object is set, a previously set one will be deleted.
22976     * If you want to keep that old content object, use the
22977     * elm_mapbuf_content_unset() function.
22978     *
22979     * To enable map, elm_mapbuf_enabled_set() should be used.
22980     *
22981     * @ingroup Mapbuf
22982     */
22983    EAPI void         elm_mapbuf_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
22984
22985    /**
22986     * Get the content of the mapbuf.
22987     *
22988     * @param obj The mapbuf object.
22989     * @return The content that is being used.
22990     *
22991     * Return the content object which is set for this widget.
22992     *
22993     * @see elm_mapbuf_content_set() for details.
22994     *
22995     * @ingroup Mapbuf
22996     */
22997    EAPI Evas_Object *elm_mapbuf_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22998
22999    /**
23000     * Unset the content of the mapbuf.
23001     *
23002     * @param obj The mapbuf object.
23003     * @return The content that was being used.
23004     *
23005     * Unparent and return the content object which was set for this widget.
23006     *
23007     * @see elm_mapbuf_content_set() for details.
23008     *
23009     * @ingroup Mapbuf
23010     */
23011    EAPI Evas_Object *elm_mapbuf_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
23012
23013    /**
23014     * Enable or disable the map.
23015     *
23016     * @param obj The mapbuf object.
23017     * @param enabled @c EINA_TRUE to enable map or @c EINA_FALSE to disable it.
23018     *
23019     * This enables the map that is set or disables it. On enable, the object
23020     * geometry will be saved, and the new geometry will change (position and
23021     * size) to reflect the map geometry set.
23022     *
23023     * Also, when enabled, alpha and smooth states will be used, so if the
23024     * content isn't solid, alpha should be enabled, for example, otherwise
23025     * a black retangle will fill the content.
23026     *
23027     * When disabled, the stored map will be freed and geometry prior to
23028     * enabling the map will be restored.
23029     *
23030     * It's disabled by default.
23031     *
23032     * @see elm_mapbuf_alpha_set()
23033     * @see elm_mapbuf_smooth_set()
23034     *
23035     * @ingroup Mapbuf
23036     */
23037    EAPI void         elm_mapbuf_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
23038
23039    /**
23040     * Get a value whether map is enabled or not.
23041     *
23042     * @param obj The mapbuf object.
23043     * @return @c EINA_TRUE means map is enabled. @c EINA_FALSE indicates
23044     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
23045     *
23046     * @see elm_mapbuf_enabled_set() for details.
23047     *
23048     * @ingroup Mapbuf
23049     */
23050    EAPI Eina_Bool    elm_mapbuf_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23051
23052    /**
23053     * Enable or disable smooth map rendering.
23054     *
23055     * @param obj The mapbuf object.
23056     * @param smooth @c EINA_TRUE to enable smooth map rendering or @c EINA_FALSE
23057     * to disable it.
23058     *
23059     * This sets smoothing for map rendering. If the object is a type that has
23060     * its own smoothing settings, then both the smooth settings for this object
23061     * and the map must be turned off.
23062     *
23063     * By default smooth maps are enabled.
23064     *
23065     * @ingroup Mapbuf
23066     */
23067    EAPI void         elm_mapbuf_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
23068
23069    /**
23070     * Get a value whether smooth map rendering is enabled or not.
23071     *
23072     * @param obj The mapbuf object.
23073     * @return @c EINA_TRUE means smooth map rendering is enabled. @c EINA_FALSE
23074     * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
23075     *
23076     * @see elm_mapbuf_smooth_set() for details.
23077     *
23078     * @ingroup Mapbuf
23079     */
23080    EAPI Eina_Bool    elm_mapbuf_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23081
23082    /**
23083     * Set or unset alpha flag for map rendering.
23084     *
23085     * @param obj The mapbuf object.
23086     * @param alpha @c EINA_TRUE to enable alpha blending or @c EINA_FALSE
23087     * to disable it.
23088     *
23089     * This sets alpha flag for map rendering. If the object is a type that has
23090     * its own alpha settings, then this will take precedence. Only image objects
23091     * have this currently. It stops alpha blending of the map area, and is
23092     * useful if you know the object and/or all sub-objects is 100% solid.
23093     *
23094     * Alpha is enabled by default.
23095     *
23096     * @ingroup Mapbuf
23097     */
23098    EAPI void         elm_mapbuf_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
23099
23100    /**
23101     * Get a value whether alpha blending is enabled or not.
23102     *
23103     * @param obj The mapbuf object.
23104     * @return @c EINA_TRUE means alpha blending is enabled. @c EINA_FALSE
23105     * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
23106     *
23107     * @see elm_mapbuf_alpha_set() for details.
23108     *
23109     * @ingroup Mapbuf
23110     */
23111    EAPI Eina_Bool    elm_mapbuf_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23112
23113    /**
23114     * @}
23115     */
23116
23117    /**
23118     * @defgroup Flipselector Flip Selector
23119     *
23120     * @image html img/widget/flipselector/preview-00.png
23121     * @image latex img/widget/flipselector/preview-00.eps
23122     *
23123     * A flip selector is a widget to show a set of @b text items, one
23124     * at a time, with the same sheet switching style as the @ref Clock
23125     * "clock" widget, when one changes the current displaying sheet
23126     * (thus, the "flip" in the name).
23127     *
23128     * User clicks to flip sheets which are @b held for some time will
23129     * make the flip selector to flip continuosly and automatically for
23130     * the user. The interval between flips will keep growing in time,
23131     * so that it helps the user to reach an item which is distant from
23132     * the current selection.
23133     *
23134     * Smart callbacks one can register to:
23135     * - @c "selected" - when the widget's selected text item is changed
23136     * - @c "overflowed" - when the widget's current selection is changed
23137     *   from the first item in its list to the last
23138     * - @c "underflowed" - when the widget's current selection is changed
23139     *   from the last item in its list to the first
23140     *
23141     * Available styles for it:
23142     * - @c "default"
23143     *
23144     * Here is an example on its usage:
23145     * @li @ref flipselector_example
23146     */
23147
23148    /**
23149     * @addtogroup Flipselector
23150     * @{
23151     */
23152
23153    typedef struct _Elm_Flipselector_Item Elm_Flipselector_Item; /**< Item handle for a flip selector widget. */
23154
23155    /**
23156     * Add a new flip selector widget to the given parent Elementary
23157     * (container) widget
23158     *
23159     * @param parent The parent object
23160     * @return a new flip selector widget handle or @c NULL, on errors
23161     *
23162     * This function inserts a new flip selector widget on the canvas.
23163     *
23164     * @ingroup Flipselector
23165     */
23166    EAPI Evas_Object               *elm_flipselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23167
23168    /**
23169     * Programmatically select the next item of a flip selector widget
23170     *
23171     * @param obj The flipselector object
23172     *
23173     * @note The selection will be animated. Also, if it reaches the
23174     * end of its list of member items, it will continue with the first
23175     * one onwards.
23176     *
23177     * @ingroup Flipselector
23178     */
23179    EAPI void                       elm_flipselector_flip_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
23180
23181    /**
23182     * Programmatically select the previous item of a flip selector
23183     * widget
23184     *
23185     * @param obj The flipselector object
23186     *
23187     * @note The selection will be animated.  Also, if it reaches the
23188     * beginning of its list of member items, it will continue with the
23189     * last one backwards.
23190     *
23191     * @ingroup Flipselector
23192     */
23193    EAPI void                       elm_flipselector_flip_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
23194
23195    /**
23196     * Append a (text) item to a flip selector widget
23197     *
23198     * @param obj The flipselector object
23199     * @param label The (text) label of the new item
23200     * @param func Convenience callback function to take place when
23201     * item is selected
23202     * @param data Data passed to @p func, above
23203     * @return A handle to the item added or @c NULL, on errors
23204     *
23205     * The widget's list of labels to show will be appended with the
23206     * given value. If the user wishes so, a callback function pointer
23207     * can be passed, which will get called when this same item is
23208     * selected.
23209     *
23210     * @note The current selection @b won't be modified by appending an
23211     * element to the list.
23212     *
23213     * @note The maximum length of the text label is going to be
23214     * determined <b>by the widget's theme</b>. Strings larger than
23215     * that value are going to be @b truncated.
23216     *
23217     * @ingroup Flipselector
23218     */
23219    EAPI Elm_Flipselector_Item     *elm_flipselector_item_append(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
23220
23221    /**
23222     * Prepend a (text) item to a flip selector widget
23223     *
23224     * @param obj The flipselector object
23225     * @param label The (text) label of the new item
23226     * @param func Convenience callback function to take place when
23227     * item is selected
23228     * @param data Data passed to @p func, above
23229     * @return A handle to the item added or @c NULL, on errors
23230     *
23231     * The widget's list of labels to show will be prepended with the
23232     * given value. If the user wishes so, a callback function pointer
23233     * can be passed, which will get called when this same item is
23234     * selected.
23235     *
23236     * @note The current selection @b won't be modified by prepending
23237     * an element to the list.
23238     *
23239     * @note The maximum length of the text label is going to be
23240     * determined <b>by the widget's theme</b>. Strings larger than
23241     * that value are going to be @b truncated.
23242     *
23243     * @ingroup Flipselector
23244     */
23245    EAPI Elm_Flipselector_Item     *elm_flipselector_item_prepend(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
23246
23247    /**
23248     * Get the internal list of items in a given flip selector widget.
23249     *
23250     * @param obj The flipselector object
23251     * @return The list of items (#Elm_Flipselector_Item as data) or
23252     * @c NULL on errors.
23253     *
23254     * This list is @b not to be modified in any way and must not be
23255     * freed. Use the list members with functions like
23256     * elm_flipselector_item_label_set(),
23257     * elm_flipselector_item_label_get(),
23258     * elm_flipselector_item_del(),
23259     * elm_flipselector_item_selected_get(),
23260     * elm_flipselector_item_selected_set().
23261     *
23262     * @warning This list is only valid until @p obj object's internal
23263     * items list is changed. It should be fetched again with another
23264     * call to this function when changes happen.
23265     *
23266     * @ingroup Flipselector
23267     */
23268    EAPI const Eina_List           *elm_flipselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23269
23270    /**
23271     * Get the first item in the given flip selector widget's list of
23272     * items.
23273     *
23274     * @param obj The flipselector object
23275     * @return The first item or @c NULL, if it has no items (and on
23276     * errors)
23277     *
23278     * @see elm_flipselector_item_append()
23279     * @see elm_flipselector_last_item_get()
23280     *
23281     * @ingroup Flipselector
23282     */
23283    EAPI Elm_Flipselector_Item     *elm_flipselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23284
23285    /**
23286     * Get the last item in the given flip selector widget's list of
23287     * items.
23288     *
23289     * @param obj The flipselector object
23290     * @return The last item or @c NULL, if it has no items (and on
23291     * errors)
23292     *
23293     * @see elm_flipselector_item_prepend()
23294     * @see elm_flipselector_first_item_get()
23295     *
23296     * @ingroup Flipselector
23297     */
23298    EAPI Elm_Flipselector_Item     *elm_flipselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23299
23300    /**
23301     * Get the currently selected item in a flip selector widget.
23302     *
23303     * @param obj The flipselector object
23304     * @return The selected item or @c NULL, if the widget has no items
23305     * (and on erros)
23306     *
23307     * @ingroup Flipselector
23308     */
23309    EAPI Elm_Flipselector_Item     *elm_flipselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23310
23311    /**
23312     * Set whether a given flip selector widget's item should be the
23313     * currently selected one.
23314     *
23315     * @param item The flip selector item
23316     * @param selected @c EINA_TRUE to select it, @c EINA_FALSE to unselect.
23317     *
23318     * This sets whether @p item is or not the selected (thus, under
23319     * display) one. If @p item is different than one under display,
23320     * the latter will be unselected. If the @p item is set to be
23321     * unselected, on the other hand, the @b first item in the widget's
23322     * internal members list will be the new selected one.
23323     *
23324     * @see elm_flipselector_item_selected_get()
23325     *
23326     * @ingroup Flipselector
23327     */
23328    EAPI void                       elm_flipselector_item_selected_set(Elm_Flipselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
23329
23330    /**
23331     * Get whether a given flip selector widget's item is the currently
23332     * selected one.
23333     *
23334     * @param item The flip selector item
23335     * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
23336     * (or on errors).
23337     *
23338     * @see elm_flipselector_item_selected_set()
23339     *
23340     * @ingroup Flipselector
23341     */
23342    EAPI Eina_Bool                  elm_flipselector_item_selected_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
23343
23344    /**
23345     * Delete a given item from a flip selector widget.
23346     *
23347     * @param item The item to delete
23348     *
23349     * @ingroup Flipselector
23350     */
23351    EAPI void                       elm_flipselector_item_del(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
23352
23353    /**
23354     * Get the label of a given flip selector widget's item.
23355     *
23356     * @param item The item to get label from
23357     * @return The text label of @p item or @c NULL, on errors
23358     *
23359     * @see elm_flipselector_item_label_set()
23360     *
23361     * @ingroup Flipselector
23362     */
23363    EAPI const char                *elm_flipselector_item_label_get(const Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
23364
23365    /**
23366     * Set the label of a given flip selector widget's item.
23367     *
23368     * @param item The item to set label on
23369     * @param label The text label string, in UTF-8 encoding
23370     *
23371     * @see elm_flipselector_item_label_get()
23372     *
23373     * @ingroup Flipselector
23374     */
23375    EAPI void                       elm_flipselector_item_label_set(Elm_Flipselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
23376
23377    /**
23378     * Gets the item before @p item in a flip selector widget's
23379     * internal list of items.
23380     *
23381     * @param item The item to fetch previous from
23382     * @return The item before the @p item, in its parent's list. If
23383     *         there is no previous item for @p item or there's an
23384     *         error, @c NULL is returned.
23385     *
23386     * @see elm_flipselector_item_next_get()
23387     *
23388     * @ingroup Flipselector
23389     */
23390    EAPI Elm_Flipselector_Item     *elm_flipselector_item_prev_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
23391
23392    /**
23393     * Gets the item after @p item in a flip selector widget's
23394     * internal list of items.
23395     *
23396     * @param item The item to fetch next from
23397     * @return The item after the @p item, in its parent's list. If
23398     *         there is no next item for @p item or there's an
23399     *         error, @c NULL is returned.
23400     *
23401     * @see elm_flipselector_item_next_get()
23402     *
23403     * @ingroup Flipselector
23404     */
23405    EAPI Elm_Flipselector_Item     *elm_flipselector_item_next_get(Elm_Flipselector_Item *item) EINA_ARG_NONNULL(1);
23406
23407    /**
23408     * Set the interval on time updates for an user mouse button hold
23409     * on a flip selector widget.
23410     *
23411     * @param obj The flip selector object
23412     * @param interval The (first) interval value in seconds
23413     *
23414     * This interval value is @b decreased while the user holds the
23415     * mouse pointer either flipping up or flipping doww a given flip
23416     * selector.
23417     *
23418     * This helps the user to get to a given item distant from the
23419     * current one easier/faster, as it will start to flip quicker and
23420     * quicker on mouse button holds.
23421     *
23422     * The calculation for the next flip interval value, starting from
23423     * the one set with this call, is the previous interval divided by
23424     * 1.05, so it decreases a little bit.
23425     *
23426     * The default starting interval value for automatic flips is
23427     * @b 0.85 seconds.
23428     *
23429     * @see elm_flipselector_interval_get()
23430     *
23431     * @ingroup Flipselector
23432     */
23433    EAPI void                       elm_flipselector_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
23434
23435    /**
23436     * Get the interval on time updates for an user mouse button hold
23437     * on a flip selector widget.
23438     *
23439     * @param obj The flip selector object
23440     * @return The (first) interval value, in seconds, set on it
23441     *
23442     * @see elm_flipselector_interval_set() for more details
23443     *
23444     * @ingroup Flipselector
23445     */
23446    EAPI double                     elm_flipselector_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23447    /**
23448     * @}
23449     */
23450
23451    /**
23452     * @addtogroup Calendar
23453     * @{
23454     */
23455
23456    /**
23457     * @enum _Elm_Calendar_Mark_Repeat
23458     * @typedef Elm_Calendar_Mark_Repeat
23459     *
23460     * Event periodicity, used to define if a mark should be repeated
23461     * @b beyond event's day. It's set when a mark is added.
23462     *
23463     * So, for a mark added to 13th May with periodicity set to WEEKLY,
23464     * there will be marks every week after this date. Marks will be displayed
23465     * at 13th, 20th, 27th, 3rd June ...
23466     *
23467     * Values don't work as bitmask, only one can be choosen.
23468     *
23469     * @see elm_calendar_mark_add()
23470     *
23471     * @ingroup Calendar
23472     */
23473    typedef enum _Elm_Calendar_Mark_Repeat
23474      {
23475         ELM_CALENDAR_UNIQUE, /**< Default value. Marks will be displayed only on event day. */
23476         ELM_CALENDAR_DAILY, /**< Marks will be displayed everyday after event day (inclusive). */
23477         ELM_CALENDAR_WEEKLY, /**< Marks will be displayed every week after event day (inclusive) - i.e. each seven days. */
23478         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*/
23479         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. */
23480      } Elm_Calendar_Mark_Repeat;
23481
23482    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(). */
23483
23484    /**
23485     * Add a new calendar widget to the given parent Elementary
23486     * (container) object.
23487     *
23488     * @param parent The parent object.
23489     * @return a new calendar widget handle or @c NULL, on errors.
23490     *
23491     * This function inserts a new calendar widget on the canvas.
23492     *
23493     * @ref calendar_example_01
23494     *
23495     * @ingroup Calendar
23496     */
23497    EAPI Evas_Object       *elm_calendar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23498
23499    /**
23500     * Get weekdays names displayed by the calendar.
23501     *
23502     * @param obj The calendar object.
23503     * @return Array of seven strings to be used as weekday names.
23504     *
23505     * By default, weekdays abbreviations get from system are displayed:
23506     * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
23507     * The first string is related to Sunday, the second to Monday...
23508     *
23509     * @see elm_calendar_weekdays_name_set()
23510     *
23511     * @ref calendar_example_05
23512     *
23513     * @ingroup Calendar
23514     */
23515    EAPI const char       **elm_calendar_weekdays_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23516
23517    /**
23518     * Set weekdays names to be displayed by the calendar.
23519     *
23520     * @param obj The calendar object.
23521     * @param weekdays Array of seven strings to be used as weekday names.
23522     * @warning It must have 7 elements, or it will access invalid memory.
23523     * @warning The strings must be NULL terminated ('@\0').
23524     *
23525     * By default, weekdays abbreviations get from system are displayed:
23526     * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
23527     *
23528     * The first string should be related to Sunday, the second to Monday...
23529     *
23530     * The usage should be like this:
23531     * @code
23532     *   const char *weekdays[] =
23533     *   {
23534     *      "Sunday", "Monday", "Tuesday", "Wednesday",
23535     *      "Thursday", "Friday", "Saturday"
23536     *   };
23537     *   elm_calendar_weekdays_names_set(calendar, weekdays);
23538     * @endcode
23539     *
23540     * @see elm_calendar_weekdays_name_get()
23541     *
23542     * @ref calendar_example_02
23543     *
23544     * @ingroup Calendar
23545     */
23546    EAPI void               elm_calendar_weekdays_names_set(Evas_Object *obj, const char *weekdays[]) EINA_ARG_NONNULL(1, 2);
23547
23548    /**
23549     * Set the minimum and maximum values for the year
23550     *
23551     * @param obj The calendar object
23552     * @param min The minimum year, greater than 1901;
23553     * @param max The maximum year;
23554     *
23555     * Maximum must be greater than minimum, except if you don't wan't to set
23556     * maximum year.
23557     * Default values are 1902 and -1.
23558     *
23559     * If the maximum year is a negative value, it will be limited depending
23560     * on the platform architecture (year 2037 for 32 bits);
23561     *
23562     * @see elm_calendar_min_max_year_get()
23563     *
23564     * @ref calendar_example_03
23565     *
23566     * @ingroup Calendar
23567     */
23568    EAPI void               elm_calendar_min_max_year_set(Evas_Object *obj, int min, int max) EINA_ARG_NONNULL(1);
23569
23570    /**
23571     * Get the minimum and maximum values for the year
23572     *
23573     * @param obj The calendar object.
23574     * @param min The minimum year.
23575     * @param max The maximum year.
23576     *
23577     * Default values are 1902 and -1.
23578     *
23579     * @see elm_calendar_min_max_year_get() for more details.
23580     *
23581     * @ref calendar_example_05
23582     *
23583     * @ingroup Calendar
23584     */
23585    EAPI void               elm_calendar_min_max_year_get(const Evas_Object *obj, int *min, int *max) EINA_ARG_NONNULL(1);
23586
23587    /**
23588     * Enable or disable day selection
23589     *
23590     * @param obj The calendar object.
23591     * @param enabled @c EINA_TRUE to enable selection or @c EINA_FALSE to
23592     * disable it.
23593     *
23594     * Enabled by default. If disabled, the user still can select months,
23595     * but not days. Selected days are highlighted on calendar.
23596     * It should be used if you won't need such selection for the widget usage.
23597     *
23598     * When a day is selected, or month is changed, smart callbacks for
23599     * signal "changed" will be called.
23600     *
23601     * @see elm_calendar_day_selection_enable_get()
23602     *
23603     * @ref calendar_example_04
23604     *
23605     * @ingroup Calendar
23606     */
23607    EAPI void               elm_calendar_day_selection_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
23608
23609    /**
23610     * Get a value whether day selection is enabled or not.
23611     *
23612     * @see elm_calendar_day_selection_enable_set() for details.
23613     *
23614     * @param obj The calendar object.
23615     * @return EINA_TRUE means day selection is enabled. EINA_FALSE indicates
23616     * it's disabled. If @p obj is NULL, EINA_FALSE is returned.
23617     *
23618     * @ref calendar_example_05
23619     *
23620     * @ingroup Calendar
23621     */
23622    EAPI Eina_Bool          elm_calendar_day_selection_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23623
23624
23625    /**
23626     * Set selected date to be highlighted on calendar.
23627     *
23628     * @param obj The calendar object.
23629     * @param selected_time A @b tm struct to represent the selected date.
23630     *
23631     * Set the selected date, changing the displayed month if needed.
23632     * Selected date changes when the user goes to next/previous month or
23633     * select a day pressing over it on calendar.
23634     *
23635     * @see elm_calendar_selected_time_get()
23636     *
23637     * @ref calendar_example_04
23638     *
23639     * @ingroup Calendar
23640     */
23641    EAPI void               elm_calendar_selected_time_set(Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1);
23642
23643    /**
23644     * Get selected date.
23645     *
23646     * @param obj The calendar object
23647     * @param selected_time A @b tm struct to point to selected date
23648     * @return EINA_FALSE means an error ocurred and returned time shouldn't
23649     * be considered.
23650     *
23651     * Get date selected by the user or set by function
23652     * elm_calendar_selected_time_set().
23653     * Selected date changes when the user goes to next/previous month or
23654     * select a day pressing over it on calendar.
23655     *
23656     * @see elm_calendar_selected_time_get()
23657     *
23658     * @ref calendar_example_05
23659     *
23660     * @ingroup Calendar
23661     */
23662    EAPI Eina_Bool          elm_calendar_selected_time_get(const Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1, 2);
23663
23664    /**
23665     * Set a function to format the string that will be used to display
23666     * month and year;
23667     *
23668     * @param obj The calendar object
23669     * @param format_function Function to set the month-year string given
23670     * the selected date
23671     *
23672     * By default it uses strftime with "%B %Y" format string.
23673     * It should allocate the memory that will be used by the string,
23674     * that will be freed by the widget after usage.
23675     * A pointer to the string and a pointer to the time struct will be provided.
23676     *
23677     * Example:
23678     * @code
23679     * static char *
23680     * _format_month_year(struct tm *selected_time)
23681     * {
23682     *    char buf[32];
23683     *    if (!strftime(buf, sizeof(buf), "%B %Y", selected_time)) return NULL;
23684     *    return strdup(buf);
23685     * }
23686     *
23687     * elm_calendar_format_function_set(calendar, _format_month_year);
23688     * @endcode
23689     *
23690     * @ref calendar_example_02
23691     *
23692     * @ingroup Calendar
23693     */
23694    EAPI void               elm_calendar_format_function_set(Evas_Object *obj, char * (*format_function) (struct tm *stime)) EINA_ARG_NONNULL(1);
23695
23696    /**
23697     * Add a new mark to the calendar
23698     *
23699     * @param obj The calendar object
23700     * @param mark_type A string used to define the type of mark. It will be
23701     * emitted to the theme, that should display a related modification on these
23702     * days representation.
23703     * @param mark_time A time struct to represent the date of inclusion of the
23704     * mark. For marks that repeats it will just be displayed after the inclusion
23705     * date in the calendar.
23706     * @param repeat Repeat the event following this periodicity. Can be a unique
23707     * mark (that don't repeat), daily, weekly, monthly or annually.
23708     * @return The created mark or @p NULL upon failure.
23709     *
23710     * Add a mark that will be drawn in the calendar respecting the insertion
23711     * time and periodicity. It will emit the type as signal to the widget theme.
23712     * Default theme supports "holiday" and "checked", but it can be extended.
23713     *
23714     * It won't immediately update the calendar, drawing the marks.
23715     * For this, call elm_calendar_marks_draw(). However, when user selects
23716     * next or previous month calendar forces marks drawn.
23717     *
23718     * Marks created with this method can be deleted with
23719     * elm_calendar_mark_del().
23720     *
23721     * Example
23722     * @code
23723     * struct tm selected_time;
23724     * time_t current_time;
23725     *
23726     * current_time = time(NULL) + 5 * 84600;
23727     * localtime_r(&current_time, &selected_time);
23728     * elm_calendar_mark_add(cal, "holiday", selected_time,
23729     *     ELM_CALENDAR_ANNUALLY);
23730     *
23731     * current_time = time(NULL) + 1 * 84600;
23732     * localtime_r(&current_time, &selected_time);
23733     * elm_calendar_mark_add(cal, "checked", selected_time, ELM_CALENDAR_UNIQUE);
23734     *
23735     * elm_calendar_marks_draw(cal);
23736     * @endcode
23737     *
23738     * @see elm_calendar_marks_draw()
23739     * @see elm_calendar_mark_del()
23740     *
23741     * @ref calendar_example_06
23742     *
23743     * @ingroup Calendar
23744     */
23745    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);
23746
23747    /**
23748     * Delete mark from the calendar.
23749     *
23750     * @param mark The mark to be deleted.
23751     *
23752     * If deleting all calendar marks is required, elm_calendar_marks_clear()
23753     * should be used instead of getting marks list and deleting each one.
23754     *
23755     * @see elm_calendar_mark_add()
23756     *
23757     * @ref calendar_example_06
23758     *
23759     * @ingroup Calendar
23760     */
23761    EAPI void               elm_calendar_mark_del(Elm_Calendar_Mark *mark) EINA_ARG_NONNULL(1);
23762
23763    /**
23764     * Remove all calendar's marks
23765     *
23766     * @param obj The calendar object.
23767     *
23768     * @see elm_calendar_mark_add()
23769     * @see elm_calendar_mark_del()
23770     *
23771     * @ingroup Calendar
23772     */
23773    EAPI void               elm_calendar_marks_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
23774
23775
23776    /**
23777     * Get a list of all the calendar marks.
23778     *
23779     * @param obj The calendar object.
23780     * @return An @c Eina_List of calendar marks objects, or @c NULL on failure.
23781     *
23782     * @see elm_calendar_mark_add()
23783     * @see elm_calendar_mark_del()
23784     * @see elm_calendar_marks_clear()
23785     *
23786     * @ingroup Calendar
23787     */
23788    EAPI const Eina_List   *elm_calendar_marks_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23789
23790    /**
23791     * Draw calendar marks.
23792     *
23793     * @param obj The calendar object.
23794     *
23795     * Should be used after adding, removing or clearing marks.
23796     * It will go through the entire marks list updating the calendar.
23797     * If lots of marks will be added, add all the marks and then call
23798     * this function.
23799     *
23800     * When the month is changed, i.e. user selects next or previous month,
23801     * marks will be drawed.
23802     *
23803     * @see elm_calendar_mark_add()
23804     * @see elm_calendar_mark_del()
23805     * @see elm_calendar_marks_clear()
23806     *
23807     * @ref calendar_example_06
23808     *
23809     * @ingroup Calendar
23810     */
23811    EAPI void               elm_calendar_marks_draw(Evas_Object *obj) EINA_ARG_NONNULL(1);
23812
23813    /**
23814     * Set a day text color to the same that represents Saturdays.
23815     *
23816     * @param obj The calendar object.
23817     * @param pos The text position. Position is the cell counter, from left
23818     * to right, up to down. It starts on 0 and ends on 41.
23819     *
23820     * @deprecated use elm_calendar_mark_add() instead like:
23821     *
23822     * @code
23823     * struct tm t = { 0, 0, 12, 6, 0, 0, 6, 6, -1 };
23824     * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
23825     * @endcode
23826     *
23827     * @see elm_calendar_mark_add()
23828     *
23829     * @ingroup Calendar
23830     */
23831    EINA_DEPRECATED EAPI void               elm_calendar_text_saturday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
23832
23833    /**
23834     * Set a day text color to the same that represents Sundays.
23835     *
23836     * @param obj The calendar object.
23837     * @param pos The text position. Position is the cell counter, from left
23838     * to right, up to down. It starts on 0 and ends on 41.
23839
23840     * @deprecated use elm_calendar_mark_add() instead like:
23841     *
23842     * @code
23843     * struct tm t = { 0, 0, 12, 7, 0, 0, 0, 0, -1 };
23844     * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
23845     * @endcode
23846     *
23847     * @see elm_calendar_mark_add()
23848     *
23849     * @ingroup Calendar
23850     */
23851    EINA_DEPRECATED EAPI void               elm_calendar_text_sunday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
23852
23853    /**
23854     * Set a day text color to the same that represents Weekdays.
23855     *
23856     * @param obj The calendar object
23857     * @param pos The text position. Position is the cell counter, from left
23858     * to right, up to down. It starts on 0 and ends on 41.
23859     *
23860     * @deprecated use elm_calendar_mark_add() instead like:
23861     *
23862     * @code
23863     * struct tm t = { 0, 0, 12, 1, 0, 0, 0, 0, -1 };
23864     *
23865     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // monday
23866     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
23867     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // tuesday
23868     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
23869     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // wednesday
23870     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
23871     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // thursday
23872     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
23873     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // friday
23874     * @endcode
23875     *
23876     * @see elm_calendar_mark_add()
23877     *
23878     * @ingroup Calendar
23879     */
23880    EINA_DEPRECATED EAPI void               elm_calendar_text_weekday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
23881
23882    /**
23883     * Set the interval on time updates for an user mouse button hold
23884     * on calendar widgets' month selection.
23885     *
23886     * @param obj The calendar object
23887     * @param interval The (first) interval value in seconds
23888     *
23889     * This interval value is @b decreased while the user holds the
23890     * mouse pointer either selecting next or previous month.
23891     *
23892     * This helps the user to get to a given month distant from the
23893     * current one easier/faster, as it will start to change quicker and
23894     * quicker on mouse button holds.
23895     *
23896     * The calculation for the next change interval value, starting from
23897     * the one set with this call, is the previous interval divided by
23898     * 1.05, so it decreases a little bit.
23899     *
23900     * The default starting interval value for automatic changes is
23901     * @b 0.85 seconds.
23902     *
23903     * @see elm_calendar_interval_get()
23904     *
23905     * @ingroup Calendar
23906     */
23907    EAPI void               elm_calendar_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
23908
23909    /**
23910     * Get the interval on time updates for an user mouse button hold
23911     * on calendar widgets' month selection.
23912     *
23913     * @param obj The calendar object
23914     * @return The (first) interval value, in seconds, set on it
23915     *
23916     * @see elm_calendar_interval_set() for more details
23917     *
23918     * @ingroup Calendar
23919     */
23920    EAPI double             elm_calendar_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23921
23922    /**
23923     * @}
23924     */
23925
23926    /**
23927     * @defgroup Diskselector Diskselector
23928     * @ingroup Elementary
23929     *
23930     * @image html img/widget/diskselector/preview-00.png
23931     * @image latex img/widget/diskselector/preview-00.eps
23932     *
23933     * A diskselector is a kind of list widget. It scrolls horizontally,
23934     * and can contain label and icon objects. Three items are displayed
23935     * with the selected one in the middle.
23936     *
23937     * It can act like a circular list with round mode and labels can be
23938     * reduced for a defined length for side items.
23939     *
23940     * Smart callbacks one can listen to:
23941     * - "selected" - when item is selected, i.e. scroller stops.
23942     *
23943     * Available styles for it:
23944     * - @c "default"
23945     *
23946     * List of examples:
23947     * @li @ref diskselector_example_01
23948     * @li @ref diskselector_example_02
23949     */
23950
23951    /**
23952     * @addtogroup Diskselector
23953     * @{
23954     */
23955
23956    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(). */
23957
23958    /**
23959     * Add a new diskselector widget to the given parent Elementary
23960     * (container) object.
23961     *
23962     * @param parent The parent object.
23963     * @return a new diskselector widget handle or @c NULL, on errors.
23964     *
23965     * This function inserts a new diskselector widget on the canvas.
23966     *
23967     * @ingroup Diskselector
23968     */
23969    EAPI Evas_Object           *elm_diskselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
23970
23971    /**
23972     * Enable or disable round mode.
23973     *
23974     * @param obj The diskselector object.
23975     * @param round @c EINA_TRUE to enable round mode or @c EINA_FALSE to
23976     * disable it.
23977     *
23978     * Disabled by default. If round mode is enabled the items list will
23979     * work like a circle list, so when the user reaches the last item,
23980     * the first one will popup.
23981     *
23982     * @see elm_diskselector_round_get()
23983     *
23984     * @ingroup Diskselector
23985     */
23986    EAPI void                   elm_diskselector_round_set(Evas_Object *obj, Eina_Bool round) EINA_ARG_NONNULL(1);
23987
23988    /**
23989     * Get a value whether round mode is enabled or not.
23990     *
23991     * @see elm_diskselector_round_set() for details.
23992     *
23993     * @param obj The diskselector object.
23994     * @return @c EINA_TRUE means round mode is enabled. @c EINA_FALSE indicates
23995     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
23996     *
23997     * @ingroup Diskselector
23998     */
23999    EAPI Eina_Bool              elm_diskselector_round_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24000
24001    /**
24002     * Get the side labels max length.
24003     *
24004     * @deprecated use elm_diskselector_side_label_length_get() instead:
24005     *
24006     * @param obj The diskselector object.
24007     * @return The max length defined for side labels, or 0 if not a valid
24008     * diskselector.
24009     *
24010     * @ingroup Diskselector
24011     */
24012    EINA_DEPRECATED EAPI int    elm_diskselector_side_label_lenght_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24013
24014    /**
24015     * Set the side labels max length.
24016     *
24017     * @deprecated use elm_diskselector_side_label_length_set() instead:
24018     *
24019     * @param obj The diskselector object.
24020     * @param len The max length defined for side labels.
24021     *
24022     * @ingroup Diskselector
24023     */
24024    EINA_DEPRECATED EAPI void   elm_diskselector_side_label_lenght_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
24025
24026    /**
24027     * Get the side labels max length.
24028     *
24029     * @see elm_diskselector_side_label_length_set() for details.
24030     *
24031     * @param obj The diskselector object.
24032     * @return The max length defined for side labels, or 0 if not a valid
24033     * diskselector.
24034     *
24035     * @ingroup Diskselector
24036     */
24037    EAPI int                    elm_diskselector_side_label_length_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24038
24039    /**
24040     * Set the side labels max length.
24041     *
24042     * @param obj The diskselector object.
24043     * @param len The max length defined for side labels.
24044     *
24045     * Length is the number of characters of items' label that will be
24046     * visible when it's set on side positions. It will just crop
24047     * the string after defined size. E.g.:
24048     *
24049     * An item with label "January" would be displayed on side position as
24050     * "Jan" if max length is set to 3, or "Janu", if this property
24051     * is set to 4.
24052     *
24053     * When it's selected, the entire label will be displayed, except for
24054     * width restrictions. In this case label will be cropped and "..."
24055     * will be concatenated.
24056     *
24057     * Default side label max length is 3.
24058     *
24059     * This property will be applyed over all items, included before or
24060     * later this function call.
24061     *
24062     * @ingroup Diskselector
24063     */
24064    EAPI void                   elm_diskselector_side_label_length_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
24065
24066    /**
24067     * Set the number of items to be displayed.
24068     *
24069     * @param obj The diskselector object.
24070     * @param num The number of items the diskselector will display.
24071     *
24072     * Default value is 3, and also it's the minimun. If @p num is less
24073     * than 3, it will be set to 3.
24074     *
24075     * Also, it can be set on theme, using data item @c display_item_num
24076     * on group "elm/diskselector/item/X", where X is style set.
24077     * E.g.:
24078     *
24079     * group { name: "elm/diskselector/item/X";
24080     * data {
24081     *     item: "display_item_num" "5";
24082     *     }
24083     *
24084     * @ingroup Diskselector
24085     */
24086    EAPI void                   elm_diskselector_display_item_num_set(Evas_Object *obj, int num) EINA_ARG_NONNULL(1);
24087
24088    /**
24089     * Set bouncing behaviour when the scrolled content reaches an edge.
24090     *
24091     * Tell the internal scroller object whether it should bounce or not
24092     * when it reaches the respective edges for each axis.
24093     *
24094     * @param obj The diskselector object.
24095     * @param h_bounce Whether to bounce or not in the horizontal axis.
24096     * @param v_bounce Whether to bounce or not in the vertical axis.
24097     *
24098     * @see elm_scroller_bounce_set()
24099     *
24100     * @ingroup Diskselector
24101     */
24102    EAPI void                   elm_diskselector_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
24103
24104    /**
24105     * Get the bouncing behaviour of the internal scroller.
24106     *
24107     * Get whether the internal scroller should bounce when the edge of each
24108     * axis is reached scrolling.
24109     *
24110     * @param obj The diskselector object.
24111     * @param h_bounce Pointer where to store the bounce state of the horizontal
24112     * axis.
24113     * @param v_bounce Pointer where to store the bounce state of the vertical
24114     * axis.
24115     *
24116     * @see elm_scroller_bounce_get()
24117     * @see elm_diskselector_bounce_set()
24118     *
24119     * @ingroup Diskselector
24120     */
24121    EAPI void                   elm_diskselector_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
24122
24123    /**
24124     * Get the scrollbar policy.
24125     *
24126     * @see elm_diskselector_scroller_policy_get() for details.
24127     *
24128     * @param obj The diskselector object.
24129     * @param policy_h Pointer where to store horizontal scrollbar policy.
24130     * @param policy_v Pointer where to store vertical scrollbar policy.
24131     *
24132     * @ingroup Diskselector
24133     */
24134    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);
24135
24136    /**
24137     * Set the scrollbar policy.
24138     *
24139     * @param obj The diskselector object.
24140     * @param policy_h Horizontal scrollbar policy.
24141     * @param policy_v Vertical scrollbar policy.
24142     *
24143     * This sets the scrollbar visibility policy for the given scroller.
24144     * #ELM_SCROLLER_POLICY_AUTO means the scrollber is made visible if it
24145     * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
24146     * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
24147     * This applies respectively for the horizontal and vertical scrollbars.
24148     *
24149     * The both are disabled by default, i.e., are set to
24150     * #ELM_SCROLLER_POLICY_OFF.
24151     *
24152     * @ingroup Diskselector
24153     */
24154    EAPI void                   elm_diskselector_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
24155
24156    /**
24157     * Remove all diskselector's items.
24158     *
24159     * @param obj The diskselector object.
24160     *
24161     * @see elm_diskselector_item_del()
24162     * @see elm_diskselector_item_append()
24163     *
24164     * @ingroup Diskselector
24165     */
24166    EAPI void                   elm_diskselector_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
24167
24168    /**
24169     * Get a list of all the diskselector items.
24170     *
24171     * @param obj The diskselector object.
24172     * @return An @c Eina_List of diskselector items, #Elm_Diskselector_Item,
24173     * or @c NULL on failure.
24174     *
24175     * @see elm_diskselector_item_append()
24176     * @see elm_diskselector_item_del()
24177     * @see elm_diskselector_clear()
24178     *
24179     * @ingroup Diskselector
24180     */
24181    EAPI const Eina_List       *elm_diskselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24182
24183    /**
24184     * Appends a new item to the diskselector object.
24185     *
24186     * @param obj The diskselector object.
24187     * @param label The label of the diskselector item.
24188     * @param icon The icon object to use at left side of the item. An
24189     * icon can be any Evas object, but usually it is an icon created
24190     * with elm_icon_add().
24191     * @param func The function to call when the item is selected.
24192     * @param data The data to associate with the item for related callbacks.
24193     *
24194     * @return The created item or @c NULL upon failure.
24195     *
24196     * A new item will be created and appended to the diskselector, i.e., will
24197     * be set as last item. Also, if there is no selected item, it will
24198     * be selected. This will always happens for the first appended item.
24199     *
24200     * If no icon is set, label will be centered on item position, otherwise
24201     * the icon will be placed at left of the label, that will be shifted
24202     * to the right.
24203     *
24204     * Items created with this method can be deleted with
24205     * elm_diskselector_item_del().
24206     *
24207     * Associated @p data can be properly freed when item is deleted if a
24208     * callback function is set with elm_diskselector_item_del_cb_set().
24209     *
24210     * If a function is passed as argument, it will be called everytime this item
24211     * is selected, i.e., the user stops the diskselector with this
24212     * item on center position. If such function isn't needed, just passing
24213     * @c NULL as @p func is enough. The same should be done for @p data.
24214     *
24215     * Simple example (with no function callback or data associated):
24216     * @code
24217     * disk = elm_diskselector_add(win);
24218     * ic = elm_icon_add(win);
24219     * elm_icon_file_set(ic, "path/to/image", NULL);
24220     * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
24221     * elm_diskselector_item_append(disk, "label", ic, NULL, NULL);
24222     * @endcode
24223     *
24224     * @see elm_diskselector_item_del()
24225     * @see elm_diskselector_item_del_cb_set()
24226     * @see elm_diskselector_clear()
24227     * @see elm_icon_add()
24228     *
24229     * @ingroup Diskselector
24230     */
24231    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);
24232
24233
24234    /**
24235     * Delete them item from the diskselector.
24236     *
24237     * @param it The item of diskselector to be deleted.
24238     *
24239     * If deleting all diskselector items is required, elm_diskselector_clear()
24240     * should be used instead of getting items list and deleting each one.
24241     *
24242     * @see elm_diskselector_clear()
24243     * @see elm_diskselector_item_append()
24244     * @see elm_diskselector_item_del_cb_set()
24245     *
24246     * @ingroup Diskselector
24247     */
24248    EAPI void                   elm_diskselector_item_del(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24249
24250    /**
24251     * Set the function called when a diskselector item is freed.
24252     *
24253     * @param it The item to set the callback on
24254     * @param func The function called
24255     *
24256     * If there is a @p func, then it will be called prior item's memory release.
24257     * That will be called with the following arguments:
24258     * @li item's data;
24259     * @li item's Evas object;
24260     * @li item itself;
24261     *
24262     * This way, a data associated to a diskselector item could be properly
24263     * freed.
24264     *
24265     * @ingroup Diskselector
24266     */
24267    EAPI void                   elm_diskselector_item_del_cb_set(Elm_Diskselector_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
24268
24269    /**
24270     * Get the data associated to the item.
24271     *
24272     * @param it The diskselector item
24273     * @return The data associated to @p it
24274     *
24275     * The return value is a pointer to data associated to @p item when it was
24276     * created, with function elm_diskselector_item_append(). If no data
24277     * was passed as argument, it will return @c NULL.
24278     *
24279     * @see elm_diskselector_item_append()
24280     *
24281     * @ingroup Diskselector
24282     */
24283    EAPI void                  *elm_diskselector_item_data_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24284
24285    /**
24286     * Set the icon associated to the item.
24287     *
24288     * @param it The diskselector item
24289     * @param icon The icon object to associate with @p it
24290     *
24291     * The icon object to use at left side of the item. An
24292     * icon can be any Evas object, but usually it is an icon created
24293     * with elm_icon_add().
24294     *
24295     * Once the icon object is set, a previously set one will be deleted.
24296     * @warning Setting the same icon for two items will cause the icon to
24297     * dissapear from the first item.
24298     *
24299     * If an icon was passed as argument on item creation, with function
24300     * elm_diskselector_item_append(), it will be already
24301     * associated to the item.
24302     *
24303     * @see elm_diskselector_item_append()
24304     * @see elm_diskselector_item_icon_get()
24305     *
24306     * @ingroup Diskselector
24307     */
24308    EAPI void                   elm_diskselector_item_icon_set(Elm_Diskselector_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
24309
24310    /**
24311     * Get the icon associated to the item.
24312     *
24313     * @param it The diskselector item
24314     * @return The icon associated to @p it
24315     *
24316     * The return value is a pointer to the icon associated to @p item when it was
24317     * created, with function elm_diskselector_item_append(), or later
24318     * with function elm_diskselector_item_icon_set. If no icon
24319     * was passed as argument, it will return @c NULL.
24320     *
24321     * @see elm_diskselector_item_append()
24322     * @see elm_diskselector_item_icon_set()
24323     *
24324     * @ingroup Diskselector
24325     */
24326    EAPI Evas_Object           *elm_diskselector_item_icon_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24327
24328    /**
24329     * Set the label of item.
24330     *
24331     * @param it The item of diskselector.
24332     * @param label The label of item.
24333     *
24334     * The label to be displayed by the item.
24335     *
24336     * If no icon is set, label will be centered on item position, otherwise
24337     * the icon will be placed at left of the label, that will be shifted
24338     * to the right.
24339     *
24340     * An item with label "January" would be displayed on side position as
24341     * "Jan" if max length is set to 3 with function
24342     * elm_diskselector_side_label_lenght_set(), or "Janu", if this property
24343     * is set to 4.
24344     *
24345     * When this @p item is selected, the entire label will be displayed,
24346     * except for width restrictions.
24347     * In this case label will be cropped and "..." will be concatenated,
24348     * but only for display purposes. It will keep the entire string, so
24349     * if diskselector is resized the remaining characters will be displayed.
24350     *
24351     * If a label was passed as argument on item creation, with function
24352     * elm_diskselector_item_append(), it will be already
24353     * displayed by the item.
24354     *
24355     * @see elm_diskselector_side_label_lenght_set()
24356     * @see elm_diskselector_item_label_get()
24357     * @see elm_diskselector_item_append()
24358     *
24359     * @ingroup Diskselector
24360     */
24361    EAPI void                   elm_diskselector_item_label_set(Elm_Diskselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
24362
24363    /**
24364     * Get the label of item.
24365     *
24366     * @param it The item of diskselector.
24367     * @return The label of item.
24368     *
24369     * The return value is a pointer to the label associated to @p item when it was
24370     * created, with function elm_diskselector_item_append(), or later
24371     * with function elm_diskselector_item_label_set. If no label
24372     * was passed as argument, it will return @c NULL.
24373     *
24374     * @see elm_diskselector_item_label_set() for more details.
24375     * @see elm_diskselector_item_append()
24376     *
24377     * @ingroup Diskselector
24378     */
24379    EAPI const char            *elm_diskselector_item_label_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24380
24381    /**
24382     * Get the selected item.
24383     *
24384     * @param obj The diskselector object.
24385     * @return The selected diskselector item.
24386     *
24387     * The selected item can be unselected with function
24388     * elm_diskselector_item_selected_set(), and the first item of
24389     * diskselector will be selected.
24390     *
24391     * The selected item always will be centered on diskselector, with
24392     * full label displayed, i.e., max lenght set to side labels won't
24393     * apply on the selected item. More details on
24394     * elm_diskselector_side_label_length_set().
24395     *
24396     * @ingroup Diskselector
24397     */
24398    EAPI Elm_Diskselector_Item *elm_diskselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24399
24400    /**
24401     * Set the selected state of an item.
24402     *
24403     * @param it The diskselector item
24404     * @param selected The selected state
24405     *
24406     * This sets the selected state of the given item @p it.
24407     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
24408     *
24409     * If a new item is selected the previosly selected will be unselected.
24410     * Previoulsy selected item can be get with function
24411     * elm_diskselector_selected_item_get().
24412     *
24413     * If the item @p it is unselected, the first item of diskselector will
24414     * be selected.
24415     *
24416     * Selected items will be visible on center position of diskselector.
24417     * So if it was on another position before selected, or was invisible,
24418     * diskselector will animate items until the selected item reaches center
24419     * position.
24420     *
24421     * @see elm_diskselector_item_selected_get()
24422     * @see elm_diskselector_selected_item_get()
24423     *
24424     * @ingroup Diskselector
24425     */
24426    EAPI void                   elm_diskselector_item_selected_set(Elm_Diskselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
24427
24428    /*
24429     * Get whether the @p item is selected or not.
24430     *
24431     * @param it The diskselector item.
24432     * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
24433     * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
24434     *
24435     * @see elm_diskselector_selected_item_set() for details.
24436     * @see elm_diskselector_item_selected_get()
24437     *
24438     * @ingroup Diskselector
24439     */
24440    EAPI Eina_Bool              elm_diskselector_item_selected_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24441
24442    /**
24443     * Get the first item of the diskselector.
24444     *
24445     * @param obj The diskselector object.
24446     * @return The first item, or @c NULL if none.
24447     *
24448     * The list of items follows append order. So it will return the first
24449     * item appended to the widget that wasn't deleted.
24450     *
24451     * @see elm_diskselector_item_append()
24452     * @see elm_diskselector_items_get()
24453     *
24454     * @ingroup Diskselector
24455     */
24456    EAPI Elm_Diskselector_Item *elm_diskselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24457
24458    /**
24459     * Get the last item of the diskselector.
24460     *
24461     * @param obj The diskselector object.
24462     * @return The last item, or @c NULL if none.
24463     *
24464     * The list of items follows append order. So it will return last first
24465     * item appended to the widget that wasn't deleted.
24466     *
24467     * @see elm_diskselector_item_append()
24468     * @see elm_diskselector_items_get()
24469     *
24470     * @ingroup Diskselector
24471     */
24472    EAPI Elm_Diskselector_Item *elm_diskselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24473
24474    /**
24475     * Get the item before @p item in diskselector.
24476     *
24477     * @param it The diskselector item.
24478     * @return The item before @p item, or @c NULL if none or on failure.
24479     *
24480     * The list of items follows append order. So it will return item appended
24481     * just before @p item and that wasn't deleted.
24482     *
24483     * If it is the first item, @c NULL will be returned.
24484     * First item can be get by elm_diskselector_first_item_get().
24485     *
24486     * @see elm_diskselector_item_append()
24487     * @see elm_diskselector_items_get()
24488     *
24489     * @ingroup Diskselector
24490     */
24491    EAPI Elm_Diskselector_Item *elm_diskselector_item_prev_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24492
24493    /**
24494     * Get the item after @p item in diskselector.
24495     *
24496     * @param it The diskselector item.
24497     * @return The item after @p item, or @c NULL if none or on failure.
24498     *
24499     * The list of items follows append order. So it will return item appended
24500     * just after @p item and that wasn't deleted.
24501     *
24502     * If it is the last item, @c NULL will be returned.
24503     * Last item can be get by elm_diskselector_last_item_get().
24504     *
24505     * @see elm_diskselector_item_append()
24506     * @see elm_diskselector_items_get()
24507     *
24508     * @ingroup Diskselector
24509     */
24510    EAPI Elm_Diskselector_Item *elm_diskselector_item_next_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24511
24512    /**
24513     * Set the text to be shown in the diskselector item.
24514     *
24515     * @param item Target item
24516     * @param text The text to set in the content
24517     *
24518     * Setup the text as tooltip to object. The item can have only one tooltip,
24519     * so any previous tooltip data is removed.
24520     *
24521     * @see elm_object_tooltip_text_set() for more details.
24522     *
24523     * @ingroup Diskselector
24524     */
24525    EAPI void                   elm_diskselector_item_tooltip_text_set(Elm_Diskselector_Item *item, const char *text) EINA_ARG_NONNULL(1);
24526
24527    /**
24528     * Set the content to be shown in the tooltip item.
24529     *
24530     * Setup the tooltip to item. The item can have only one tooltip,
24531     * so any previous tooltip data is removed. @p func(with @p data) will
24532     * be called every time that need show the tooltip and it should
24533     * return a valid Evas_Object. This object is then managed fully by
24534     * tooltip system and is deleted when the tooltip is gone.
24535     *
24536     * @param item the diskselector item being attached a tooltip.
24537     * @param func the function used to create the tooltip contents.
24538     * @param data what to provide to @a func as callback data/context.
24539     * @param del_cb called when data is not needed anymore, either when
24540     *        another callback replaces @p func, the tooltip is unset with
24541     *        elm_diskselector_item_tooltip_unset() or the owner @a item
24542     *        dies. This callback receives as the first parameter the
24543     *        given @a data, and @c event_info is the item.
24544     *
24545     * @see elm_object_tooltip_content_cb_set() for more details.
24546     *
24547     * @ingroup Diskselector
24548     */
24549    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);
24550
24551    /**
24552     * Unset tooltip from item.
24553     *
24554     * @param item diskselector item to remove previously set tooltip.
24555     *
24556     * Remove tooltip from item. The callback provided as del_cb to
24557     * elm_diskselector_item_tooltip_content_cb_set() will be called to notify
24558     * it is not used anymore.
24559     *
24560     * @see elm_object_tooltip_unset() for more details.
24561     * @see elm_diskselector_item_tooltip_content_cb_set()
24562     *
24563     * @ingroup Diskselector
24564     */
24565    EAPI void                   elm_diskselector_item_tooltip_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24566
24567
24568    /**
24569     * Sets a different style for this item tooltip.
24570     *
24571     * @note before you set a style you should define a tooltip with
24572     *       elm_diskselector_item_tooltip_content_cb_set() or
24573     *       elm_diskselector_item_tooltip_text_set()
24574     *
24575     * @param item diskselector item with tooltip already set.
24576     * @param style the theme style to use (default, transparent, ...)
24577     *
24578     * @see elm_object_tooltip_style_set() for more details.
24579     *
24580     * @ingroup Diskselector
24581     */
24582    EAPI void                   elm_diskselector_item_tooltip_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
24583
24584    /**
24585     * Get the style for this item tooltip.
24586     *
24587     * @param item diskselector item with tooltip already set.
24588     * @return style the theme style in use, defaults to "default". If the
24589     *         object does not have a tooltip set, then NULL is returned.
24590     *
24591     * @see elm_object_tooltip_style_get() for more details.
24592     * @see elm_diskselector_item_tooltip_style_set()
24593     *
24594     * @ingroup Diskselector
24595     */
24596    EAPI const char            *elm_diskselector_item_tooltip_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24597
24598    /**
24599     * Set the cursor to be shown when mouse is over the diskselector item
24600     *
24601     * @param item Target item
24602     * @param cursor the cursor name to be used.
24603     *
24604     * @see elm_object_cursor_set() for more details.
24605     *
24606     * @ingroup Diskselector
24607     */
24608    EAPI void                   elm_diskselector_item_cursor_set(Elm_Diskselector_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
24609
24610    /**
24611     * Get the cursor to be shown when mouse is over the diskselector item
24612     *
24613     * @param item diskselector item with cursor already set.
24614     * @return the cursor name.
24615     *
24616     * @see elm_object_cursor_get() for more details.
24617     * @see elm_diskselector_cursor_set()
24618     *
24619     * @ingroup Diskselector
24620     */
24621    EAPI const char            *elm_diskselector_item_cursor_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24622
24623
24624    /**
24625     * Unset the cursor to be shown when mouse is over the diskselector item
24626     *
24627     * @param item Target item
24628     *
24629     * @see elm_object_cursor_unset() for more details.
24630     * @see elm_diskselector_cursor_set()
24631     *
24632     * @ingroup Diskselector
24633     */
24634    EAPI void                   elm_diskselector_item_cursor_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24635
24636    /**
24637     * Sets a different style for this item cursor.
24638     *
24639     * @note before you set a style you should define a cursor with
24640     *       elm_diskselector_item_cursor_set()
24641     *
24642     * @param item diskselector item with cursor already set.
24643     * @param style the theme style to use (default, transparent, ...)
24644     *
24645     * @see elm_object_cursor_style_set() for more details.
24646     *
24647     * @ingroup Diskselector
24648     */
24649    EAPI void                   elm_diskselector_item_cursor_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
24650
24651
24652    /**
24653     * Get the style for this item cursor.
24654     *
24655     * @param item diskselector item with cursor already set.
24656     * @return style the theme style in use, defaults to "default". If the
24657     *         object does not have a cursor set, then @c NULL is returned.
24658     *
24659     * @see elm_object_cursor_style_get() for more details.
24660     * @see elm_diskselector_item_cursor_style_set()
24661     *
24662     * @ingroup Diskselector
24663     */
24664    EAPI const char            *elm_diskselector_item_cursor_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24665
24666
24667    /**
24668     * Set if the cursor set should be searched on the theme or should use
24669     * the provided by the engine, only.
24670     *
24671     * @note before you set if should look on theme you should define a cursor
24672     * with elm_diskselector_item_cursor_set().
24673     * By default it will only look for cursors provided by the engine.
24674     *
24675     * @param item widget item with cursor already set.
24676     * @param engine_only boolean to define if cursors set with
24677     * elm_diskselector_item_cursor_set() should be searched only
24678     * between cursors provided by the engine or searched on widget's
24679     * theme as well.
24680     *
24681     * @see elm_object_cursor_engine_only_set() for more details.
24682     *
24683     * @ingroup Diskselector
24684     */
24685    EAPI void                   elm_diskselector_item_cursor_engine_only_set(Elm_Diskselector_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
24686
24687    /**
24688     * Get the cursor engine only usage for this item cursor.
24689     *
24690     * @param item widget item with cursor already set.
24691     * @return engine_only boolean to define it cursors should be looked only
24692     * between the provided by the engine or searched on widget's theme as well.
24693     * If the item does not have a cursor set, then @c EINA_FALSE is returned.
24694     *
24695     * @see elm_object_cursor_engine_only_get() for more details.
24696     * @see elm_diskselector_item_cursor_engine_only_set()
24697     *
24698     * @ingroup Diskselector
24699     */
24700    EAPI Eina_Bool              elm_diskselector_item_cursor_engine_only_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
24701
24702    /**
24703     * @}
24704     */
24705
24706    /**
24707     * @defgroup Colorselector Colorselector
24708     *
24709     * @{
24710     *
24711     * @image html img/widget/colorselector/preview-00.png
24712     * @image latex img/widget/colorselector/preview-00.eps
24713     *
24714     * @brief Widget for user to select a color.
24715     *
24716     * Signals that you can add callbacks for are:
24717     * "changed" - When the color value changes(event_info is NULL).
24718     *
24719     * See @ref tutorial_colorselector.
24720     */
24721    /**
24722     * @brief Add a new colorselector to the parent
24723     *
24724     * @param parent The parent object
24725     * @return The new object or NULL if it cannot be created
24726     *
24727     * @ingroup Colorselector
24728     */
24729    EAPI Evas_Object *elm_colorselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24730    /**
24731     * Set a color for the colorselector
24732     *
24733     * @param obj   Colorselector object
24734     * @param r     r-value of color
24735     * @param g     g-value of color
24736     * @param b     b-value of color
24737     * @param a     a-value of color
24738     *
24739     * @ingroup Colorselector
24740     */
24741    EAPI void         elm_colorselector_color_set(Evas_Object *obj, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
24742    /**
24743     * Get a color from the colorselector
24744     *
24745     * @param obj   Colorselector object
24746     * @param r     integer pointer for r-value of color
24747     * @param g     integer pointer for g-value of color
24748     * @param b     integer pointer for b-value of color
24749     * @param a     integer pointer for a-value of color
24750     *
24751     * @ingroup Colorselector
24752     */
24753    EAPI void         elm_colorselector_color_get(const Evas_Object *obj, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
24754    /**
24755     * @}
24756     */
24757
24758    /**
24759     * @defgroup Ctxpopup Ctxpopup
24760     *
24761     * @image html img/widget/ctxpopup/preview-00.png
24762     * @image latex img/widget/ctxpopup/preview-00.eps
24763     *
24764     * @brief Context popup widet.
24765     *
24766     * A ctxpopup is a widget that, when shown, pops up a list of items.
24767     * It automatically chooses an area inside its parent object's view
24768     * (set via elm_ctxpopup_add() and elm_ctxpopup_hover_parent_set()) to
24769     * optimally fit into it. In the default theme, it will also point an
24770     * arrow to it's top left position at the time one shows it. Ctxpopup
24771     * items have a label and/or an icon. It is intended for a small
24772     * number of items (hence the use of list, not genlist).
24773     *
24774     * @note Ctxpopup is a especialization of @ref Hover.
24775     *
24776     * Signals that you can add callbacks for are:
24777     * "dismissed" - the ctxpopup was dismissed
24778     *
24779     * @ref tutorial_ctxpopup shows the usage of a good deal of the API.
24780     * @{
24781     */
24782    typedef enum _Elm_Ctxpopup_Direction
24783      {
24784         ELM_CTXPOPUP_DIRECTION_DOWN, /**< ctxpopup show appear below clicked
24785                                           area */
24786         ELM_CTXPOPUP_DIRECTION_RIGHT, /**< ctxpopup show appear to the right of
24787                                            the clicked area */
24788         ELM_CTXPOPUP_DIRECTION_LEFT, /**< ctxpopup show appear to the left of
24789                                           the clicked area */
24790         ELM_CTXPOPUP_DIRECTION_UP, /**< ctxpopup show appear above the clicked
24791                                         area */
24792      } Elm_Ctxpopup_Direction;
24793
24794    /**
24795     * @brief Add a new Ctxpopup object to the parent.
24796     *
24797     * @param parent Parent object
24798     * @return New object or @c NULL, if it cannot be created
24799     */
24800    EAPI Evas_Object  *elm_ctxpopup_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24801    /**
24802     * @brief Set the Ctxpopup's parent
24803     *
24804     * @param obj The ctxpopup object
24805     * @param area The parent to use
24806     *
24807     * Set the parent object.
24808     *
24809     * @note elm_ctxpopup_add() will automatically call this function
24810     * with its @c parent argument.
24811     *
24812     * @see elm_ctxpopup_add()
24813     * @see elm_hover_parent_set()
24814     */
24815    EAPI void          elm_ctxpopup_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1, 2);
24816    /**
24817     * @brief Get the Ctxpopup's parent
24818     *
24819     * @param obj The ctxpopup object
24820     *
24821     * @see elm_ctxpopup_hover_parent_set() for more information
24822     */
24823    EAPI Evas_Object  *elm_ctxpopup_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24824    /**
24825     * @brief Clear all items in the given ctxpopup object.
24826     *
24827     * @param obj Ctxpopup object
24828     */
24829    EAPI void          elm_ctxpopup_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
24830    /**
24831     * @brief Change the ctxpopup's orientation to horizontal or vertical.
24832     *
24833     * @param obj Ctxpopup object
24834     * @param horizontal @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical
24835     */
24836    EAPI void          elm_ctxpopup_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
24837    /**
24838     * @brief Get the value of current ctxpopup object's orientation.
24839     *
24840     * @param obj Ctxpopup object
24841     * @return @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical mode (or errors)
24842     *
24843     * @see elm_ctxpopup_horizontal_set()
24844     */
24845    EAPI Eina_Bool     elm_ctxpopup_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24846    /**
24847     * @brief Add a new item to a ctxpopup object.
24848     *
24849     * @param obj Ctxpopup object
24850     * @param icon Icon to be set on new item
24851     * @param label The Label of the new item
24852     * @param func Convenience function called when item selected
24853     * @param data Data passed to @p func
24854     * @return A handle to the item added or @c NULL, on errors
24855     *
24856     * @warning Ctxpopup can't hold both an item list and a content at the same
24857     * time. When an item is added, any previous content will be removed.
24858     *
24859     * @see elm_ctxpopup_content_set()
24860     */
24861    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);
24862    /**
24863     * @brief Delete the given item in a ctxpopup object.
24864     *
24865     * @param it Ctxpopup item to be deleted
24866     *
24867     * @see elm_ctxpopup_item_append()
24868     */
24869    EAPI void          elm_ctxpopup_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
24870    /**
24871     * @brief Set the ctxpopup item's state as disabled or enabled.
24872     *
24873     * @param it Ctxpopup item to be enabled/disabled
24874     * @param disabled @c EINA_TRUE to disable it, @c EINA_FALSE to enable it
24875     *
24876     * When disabled the item is greyed out to indicate it's state.
24877     */
24878    EAPI void          elm_ctxpopup_item_disabled_set(Elm_Object_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
24879    /**
24880     * @brief Get the ctxpopup item's disabled/enabled state.
24881     *
24882     * @param it Ctxpopup item to be enabled/disabled
24883     * @return disabled @c EINA_TRUE, if disabled, @c EINA_FALSE otherwise
24884     *
24885     * @see elm_ctxpopup_item_disabled_set()
24886     */
24887    EAPI Eina_Bool     elm_ctxpopup_item_disabled_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
24888    /**
24889     * @brief Get the icon object for the given ctxpopup item.
24890     *
24891     * @param it Ctxpopup item
24892     * @return icon object or @c NULL, if the item does not have icon or an error
24893     * occurred
24894     *
24895     * @see elm_ctxpopup_item_append()
24896     * @see elm_ctxpopup_item_icon_set()
24897     */
24898    EAPI Evas_Object  *elm_ctxpopup_item_icon_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
24899    /**
24900     * @brief Sets the side icon associated with the ctxpopup item
24901     *
24902     * @param it Ctxpopup item
24903     * @param icon Icon object to be set
24904     *
24905     * Once the icon object is set, a previously set one will be deleted.
24906     * @warning Setting the same icon for two items will cause the icon to
24907     * dissapear from the first item.
24908     *
24909     * @see elm_ctxpopup_item_append()
24910     */
24911    EAPI void          elm_ctxpopup_item_icon_set(Elm_Object_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
24912    /**
24913     * @brief Get the label for the given ctxpopup item.
24914     *
24915     * @param it Ctxpopup item
24916     * @return label string or @c NULL, if the item does not have label or an
24917     * error occured
24918     *
24919     * @see elm_ctxpopup_item_append()
24920     * @see elm_ctxpopup_item_label_set()
24921     */
24922    EAPI const char   *elm_ctxpopup_item_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
24923    /**
24924     * @brief (Re)set the label on the given ctxpopup item.
24925     *
24926     * @param it Ctxpopup item
24927     * @param label String to set as label
24928     */
24929    EAPI void          elm_ctxpopup_item_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
24930    /**
24931     * @brief Set an elm widget as the content of the ctxpopup.
24932     *
24933     * @param obj Ctxpopup object
24934     * @param content Content to be swallowed
24935     *
24936     * If the content object is already set, a previous one will bedeleted. If
24937     * you want to keep that old content object, use the
24938     * elm_ctxpopup_content_unset() function.
24939     *
24940     * @deprecated use elm_object_content_set()
24941     *
24942     * @warning Ctxpopup can't hold both a item list and a content at the same
24943     * time. When a content is set, any previous items will be removed.
24944     */
24945    EINA_DEPRECATED EAPI void          elm_ctxpopup_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1, 2);
24946    /**
24947     * @brief Unset the ctxpopup content
24948     *
24949     * @param obj Ctxpopup object
24950     * @return The content that was being used
24951     *
24952     * Unparent and return the content object which was set for this widget.
24953     *
24954     * @deprecated use elm_object_content_unset()
24955     *
24956     * @see elm_ctxpopup_content_set()
24957     */
24958    EINA_DEPRECATED EAPI Evas_Object  *elm_ctxpopup_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24959    /**
24960     * @brief Set the direction priority of a ctxpopup.
24961     *
24962     * @param obj Ctxpopup object
24963     * @param first 1st priority of direction
24964     * @param second 2nd priority of direction
24965     * @param third 3th priority of direction
24966     * @param fourth 4th priority of direction
24967     *
24968     * This functions gives a chance to user to set the priority of ctxpopup
24969     * showing direction. This doesn't guarantee the ctxpopup will appear in the
24970     * requested direction.
24971     *
24972     * @see Elm_Ctxpopup_Direction
24973     */
24974    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);
24975    /**
24976     * @brief Get the direction priority of a ctxpopup.
24977     *
24978     * @param obj Ctxpopup object
24979     * @param first 1st priority of direction to be returned
24980     * @param second 2nd priority of direction to be returned
24981     * @param third 3th priority of direction to be returned
24982     * @param fourth 4th priority of direction to be returned
24983     *
24984     * @see elm_ctxpopup_direction_priority_set() for more information.
24985     */
24986    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);
24987    /**
24988     * @}
24989     */
24990
24991    /* transit */
24992    /**
24993     *
24994     * @defgroup Transit Transit
24995     * @ingroup Elementary
24996     *
24997     * Transit is designed to apply various animated transition effects to @c
24998     * Evas_Object, such like translation, rotation, etc. For using these
24999     * effects, create an @ref Elm_Transit and add the desired transition effects.
25000     *
25001     * Once the effects are added into transit, they will be automatically
25002     * managed (their callback will be called until the duration is ended, and
25003     * they will be deleted on completion).
25004     *
25005     * Example:
25006     * @code
25007     * Elm_Transit *trans = elm_transit_add();
25008     * elm_transit_object_add(trans, obj);
25009     * elm_transit_effect_translation_add(trans, 0, 0, 280, 280
25010     * elm_transit_duration_set(transit, 1);
25011     * elm_transit_auto_reverse_set(transit, EINA_TRUE);
25012     * elm_transit_tween_mode_set(transit, ELM_TRANSIT_TWEEN_MODE_DECELERATE);
25013     * elm_transit_repeat_times_set(transit, 3);
25014     * @endcode
25015     *
25016     * Some transition effects are used to change the properties of objects. They
25017     * are:
25018     * @li @ref elm_transit_effect_translation_add
25019     * @li @ref elm_transit_effect_color_add
25020     * @li @ref elm_transit_effect_rotation_add
25021     * @li @ref elm_transit_effect_wipe_add
25022     * @li @ref elm_transit_effect_zoom_add
25023     * @li @ref elm_transit_effect_resizing_add
25024     *
25025     * Other transition effects are used to make one object disappear and another
25026     * object appear on its old place. These effects are:
25027     *
25028     * @li @ref elm_transit_effect_flip_add
25029     * @li @ref elm_transit_effect_resizable_flip_add
25030     * @li @ref elm_transit_effect_fade_add
25031     * @li @ref elm_transit_effect_blend_add
25032     *
25033     * It's also possible to make a transition chain with @ref
25034     * elm_transit_chain_transit_add.
25035     *
25036     * @warning We strongly recommend to use elm_transit just when edje can not do
25037     * the trick. Edje has more advantage than Elm_Transit, it has more flexibility and
25038     * animations can be manipulated inside the theme.
25039     *
25040     * List of examples:
25041     * @li @ref transit_example_01_explained
25042     * @li @ref transit_example_02_explained
25043     * @li @ref transit_example_03_c
25044     * @li @ref transit_example_04_c
25045     *
25046     * @{
25047     */
25048
25049    /**
25050     * @enum Elm_Transit_Tween_Mode
25051     *
25052     * The type of acceleration used in the transition.
25053     */
25054    typedef enum
25055      {
25056         ELM_TRANSIT_TWEEN_MODE_LINEAR, /**< Constant speed */
25057         ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL, /**< Starts slow, increase speed
25058                                              over time, then decrease again
25059                                              and stop slowly */
25060         ELM_TRANSIT_TWEEN_MODE_DECELERATE, /**< Starts fast and decrease
25061                                              speed over time */
25062         ELM_TRANSIT_TWEEN_MODE_ACCELERATE /**< Starts slow and increase speed
25063                                             over time */
25064      } Elm_Transit_Tween_Mode;
25065
25066    /**
25067     * @enum Elm_Transit_Effect_Flip_Axis
25068     *
25069     * The axis where flip effect should be applied.
25070     */
25071    typedef enum
25072      {
25073         ELM_TRANSIT_EFFECT_FLIP_AXIS_X, /**< Flip on X axis */
25074         ELM_TRANSIT_EFFECT_FLIP_AXIS_Y /**< Flip on Y axis */
25075      } Elm_Transit_Effect_Flip_Axis;
25076    /**
25077     * @enum Elm_Transit_Effect_Wipe_Dir
25078     *
25079     * The direction where the wipe effect should occur.
25080     */
25081    typedef enum
25082      {
25083         ELM_TRANSIT_EFFECT_WIPE_DIR_LEFT, /**< Wipe to the left */
25084         ELM_TRANSIT_EFFECT_WIPE_DIR_RIGHT, /**< Wipe to the right */
25085         ELM_TRANSIT_EFFECT_WIPE_DIR_UP, /**< Wipe up */
25086         ELM_TRANSIT_EFFECT_WIPE_DIR_DOWN /**< Wipe down */
25087      } Elm_Transit_Effect_Wipe_Dir;
25088    /** @enum Elm_Transit_Effect_Wipe_Type
25089     *
25090     * Whether the wipe effect should show or hide the object.
25091     */
25092    typedef enum
25093      {
25094         ELM_TRANSIT_EFFECT_WIPE_TYPE_HIDE, /**< Hide the object during the
25095                                              animation */
25096         ELM_TRANSIT_EFFECT_WIPE_TYPE_SHOW /**< Show the object during the
25097                                             animation */
25098      } Elm_Transit_Effect_Wipe_Type;
25099
25100    /**
25101     * @typedef Elm_Transit
25102     *
25103     * The Transit created with elm_transit_add(). This type has the information
25104     * about the objects which the transition will be applied, and the
25105     * transition effects that will be used. It also contains info about
25106     * duration, number of repetitions, auto-reverse, etc.
25107     */
25108    typedef struct _Elm_Transit Elm_Transit;
25109    typedef void Elm_Transit_Effect;
25110    /**
25111     * @typedef Elm_Transit_Effect_Transition_Cb
25112     *
25113     * Transition callback called for this effect on each transition iteration.
25114     */
25115    typedef void (*Elm_Transit_Effect_Transition_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit, double progress);
25116    /**
25117     * Elm_Transit_Effect_End_Cb
25118     *
25119     * Transition callback called for this effect when the transition is over.
25120     */
25121    typedef void (*Elm_Transit_Effect_End_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit);
25122
25123    /**
25124     * Elm_Transit_Del_Cb
25125     *
25126     * A callback called when the transit is deleted.
25127     */
25128    typedef void (*Elm_Transit_Del_Cb) (void *data, Elm_Transit *transit);
25129
25130    /**
25131     * Add new transit.
25132     *
25133     * @note Is not necessary to delete the transit object, it will be deleted at
25134     * the end of its operation.
25135     * @note The transit will start playing when the program enter in the main loop, is not
25136     * necessary to give a start to the transit.
25137     *
25138     * @return The transit object.
25139     *
25140     * @ingroup Transit
25141     */
25142    EAPI Elm_Transit                *elm_transit_add(void);
25143
25144    /**
25145     * Stops the animation and delete the @p transit object.
25146     *
25147     * Call this function if you wants to stop the animation before the duration
25148     * time. Make sure the @p transit object is still alive with
25149     * elm_transit_del_cb_set() function.
25150     * All added effects will be deleted, calling its repective data_free_cb
25151     * functions. The function setted by elm_transit_del_cb_set() will be called.
25152     *
25153     * @see elm_transit_del_cb_set()
25154     *
25155     * @param transit The transit object to be deleted.
25156     *
25157     * @ingroup Transit
25158     * @warning Just call this function if you are sure the transit is alive.
25159     */
25160    EAPI void                        elm_transit_del(Elm_Transit *transit) EINA_ARG_NONNULL(1);
25161
25162    /**
25163     * Add a new effect to the transit.
25164     *
25165     * @note The cb function and the data are the key to the effect. If you try to
25166     * add an already added effect, nothing is done.
25167     * @note After the first addition of an effect in @p transit, if its
25168     * effect list become empty again, the @p transit will be killed by
25169     * elm_transit_del(transit) function.
25170     *
25171     * Exemple:
25172     * @code
25173     * Elm_Transit *transit = elm_transit_add();
25174     * elm_transit_effect_add(transit,
25175     *                        elm_transit_effect_blend_op,
25176     *                        elm_transit_effect_blend_context_new(),
25177     *                        elm_transit_effect_blend_context_free);
25178     * @endcode
25179     *
25180     * @param transit The transit object.
25181     * @param transition_cb The operation function. It is called when the
25182     * animation begins, it is the function that actually performs the animation.
25183     * It is called with the @p data, @p transit and the time progression of the
25184     * animation (a double value between 0.0 and 1.0).
25185     * @param effect The context data of the effect.
25186     * @param end_cb The function to free the context data, it will be called
25187     * at the end of the effect, it must finalize the animation and free the
25188     * @p data.
25189     *
25190     * @ingroup Transit
25191     * @warning The transit free the context data at the and of the transition with
25192     * the data_free_cb function, do not use the context data in another transit.
25193     */
25194    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);
25195
25196    /**
25197     * Delete an added effect.
25198     *
25199     * This function will remove the effect from the @p transit, calling the
25200     * data_free_cb to free the @p data.
25201     *
25202     * @see elm_transit_effect_add()
25203     *
25204     * @note If the effect is not found, nothing is done.
25205     * @note If the effect list become empty, this function will call
25206     * elm_transit_del(transit), that is, it will kill the @p transit.
25207     *
25208     * @param transit The transit object.
25209     * @param transition_cb The operation function.
25210     * @param effect The context data of the effect.
25211     *
25212     * @ingroup Transit
25213     */
25214    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);
25215
25216    /**
25217     * Add new object to apply the effects.
25218     *
25219     * @note After the first addition of an object in @p transit, if its
25220     * object list become empty again, the @p transit will be killed by
25221     * elm_transit_del(transit) function.
25222     * @note If the @p obj belongs to another transit, the @p obj will be
25223     * removed from it and it will only belong to the @p transit. If the old
25224     * transit stays without objects, it will die.
25225     * @note When you add an object into the @p transit, its state from
25226     * evas_object_pass_events_get(obj) is saved, and it is applied when the
25227     * transit ends, if you change this state whith evas_object_pass_events_set()
25228     * after add the object, this state will change again when @p transit stops to
25229     * run.
25230     *
25231     * @param transit The transit object.
25232     * @param obj Object to be animated.
25233     *
25234     * @ingroup Transit
25235     * @warning It is not allowed to add a new object after transit begins to go.
25236     */
25237    EAPI void                        elm_transit_object_add(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
25238
25239    /**
25240     * Removes an added object from the transit.
25241     *
25242     * @note If the @p obj is not in the @p transit, nothing is done.
25243     * @note If the list become empty, this function will call
25244     * elm_transit_del(transit), that is, it will kill the @p transit.
25245     *
25246     * @param transit The transit object.
25247     * @param obj Object to be removed from @p transit.
25248     *
25249     * @ingroup Transit
25250     * @warning It is not allowed to remove objects after transit begins to go.
25251     */
25252    EAPI void                        elm_transit_object_remove(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
25253
25254    /**
25255     * Get the objects of the transit.
25256     *
25257     * @param transit The transit object.
25258     * @return a Eina_List with the objects from the transit.
25259     *
25260     * @ingroup Transit
25261     */
25262    EAPI const Eina_List            *elm_transit_objects_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25263
25264    /**
25265     * Enable/disable keeping up the objects states.
25266     * If it is not kept, the objects states will be reset when transition ends.
25267     *
25268     * @note @p transit can not be NULL.
25269     * @note One state includes geometry, color, map data.
25270     *
25271     * @param transit The transit object.
25272     * @param state_keep Keeping or Non Keeping.
25273     *
25274     * @ingroup Transit
25275     */
25276    EAPI void                        elm_transit_objects_final_state_keep_set(Elm_Transit *transit, Eina_Bool state_keep) EINA_ARG_NONNULL(1);
25277
25278    /**
25279     * Get a value whether the objects states will be reset or not.
25280     *
25281     * @note @p transit can not be NULL
25282     *
25283     * @see elm_transit_objects_final_state_keep_set()
25284     *
25285     * @param transit The transit object.
25286     * @return EINA_TRUE means the states of the objects will be reset.
25287     * If @p transit is NULL, EINA_FALSE is returned
25288     *
25289     * @ingroup Transit
25290     */
25291    EAPI Eina_Bool                   elm_transit_objects_final_state_keep_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25292
25293    /**
25294     * Set the event enabled when transit is operating.
25295     *
25296     * If @p enabled is EINA_TRUE, the objects of the transit will receives
25297     * events from mouse and keyboard during the animation.
25298     * @note When you add an object with elm_transit_object_add(), its state from
25299     * evas_object_pass_events_get(obj) is saved, and it is applied when the
25300     * transit ends, if you change this state with evas_object_pass_events_set()
25301     * after adding the object, this state will change again when @p transit stops
25302     * to run.
25303     *
25304     * @param transit The transit object.
25305     * @param enabled Events are received when enabled is @c EINA_TRUE, and
25306     * ignored otherwise.
25307     *
25308     * @ingroup Transit
25309     */
25310    EAPI void                        elm_transit_event_enabled_set(Elm_Transit *transit, Eina_Bool enabled) EINA_ARG_NONNULL(1);
25311
25312    /**
25313     * Get the value of event enabled status.
25314     *
25315     * @see elm_transit_event_enabled_set()
25316     *
25317     * @param transit The Transit object
25318     * @return EINA_TRUE, when event is enabled. If @p transit is NULL
25319     * EINA_FALSE is returned
25320     *
25321     * @ingroup Transit
25322     */
25323    EAPI Eina_Bool                   elm_transit_event_enabled_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25324
25325    /**
25326     * Set the user-callback function when the transit is deleted.
25327     *
25328     * @note Using this function twice will overwrite the first function setted.
25329     * @note the @p transit object will be deleted after call @p cb function.
25330     *
25331     * @param transit The transit object.
25332     * @param cb Callback function pointer. This function will be called before
25333     * the deletion of the transit.
25334     * @param data Callback funtion user data. It is the @p op parameter.
25335     *
25336     * @ingroup Transit
25337     */
25338    EAPI void                        elm_transit_del_cb_set(Elm_Transit *transit, Elm_Transit_Del_Cb cb, void *data) EINA_ARG_NONNULL(1);
25339
25340    /**
25341     * Set reverse effect automatically.
25342     *
25343     * If auto reverse is setted, after running the effects with the progress
25344     * parameter from 0 to 1, it will call the effecs again with the progress
25345     * from 1 to 0. The transit will last for a time iqual to (2 * duration * repeat),
25346     * where the duration was setted with the function elm_transit_add and
25347     * the repeat with the function elm_transit_repeat_times_set().
25348     *
25349     * @param transit The transit object.
25350     * @param reverse EINA_TRUE means the auto_reverse is on.
25351     *
25352     * @ingroup Transit
25353     */
25354    EAPI void                        elm_transit_auto_reverse_set(Elm_Transit *transit, Eina_Bool reverse) EINA_ARG_NONNULL(1);
25355
25356    /**
25357     * Get if the auto reverse is on.
25358     *
25359     * @see elm_transit_auto_reverse_set()
25360     *
25361     * @param transit The transit object.
25362     * @return EINA_TRUE means auto reverse is on. If @p transit is NULL
25363     * EINA_FALSE is returned
25364     *
25365     * @ingroup Transit
25366     */
25367    EAPI Eina_Bool                   elm_transit_auto_reverse_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25368
25369    /**
25370     * Set the transit repeat count. Effect will be repeated by repeat count.
25371     *
25372     * This function sets the number of repetition the transit will run after
25373     * the first one, that is, if @p repeat is 1, the transit will run 2 times.
25374     * If the @p repeat is a negative number, it will repeat infinite times.
25375     *
25376     * @note If this function is called during the transit execution, the transit
25377     * will run @p repeat times, ignoring the times it already performed.
25378     *
25379     * @param transit The transit object
25380     * @param repeat Repeat count
25381     *
25382     * @ingroup Transit
25383     */
25384    EAPI void                        elm_transit_repeat_times_set(Elm_Transit *transit, int repeat) EINA_ARG_NONNULL(1);
25385
25386    /**
25387     * Get the transit repeat count.
25388     *
25389     * @see elm_transit_repeat_times_set()
25390     *
25391     * @param transit The Transit object.
25392     * @return The repeat count. If @p transit is NULL
25393     * 0 is returned
25394     *
25395     * @ingroup Transit
25396     */
25397    EAPI int                         elm_transit_repeat_times_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25398
25399    /**
25400     * Set the transit animation acceleration type.
25401     *
25402     * This function sets the tween mode of the transit that can be:
25403     * ELM_TRANSIT_TWEEN_MODE_LINEAR - The default mode.
25404     * ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL - Starts in accelerate mode and ends decelerating.
25405     * ELM_TRANSIT_TWEEN_MODE_DECELERATE - The animation will be slowed over time.
25406     * ELM_TRANSIT_TWEEN_MODE_ACCELERATE - The animation will accelerate over time.
25407     *
25408     * @param transit The transit object.
25409     * @param tween_mode The tween type.
25410     *
25411     * @ingroup Transit
25412     */
25413    EAPI void                        elm_transit_tween_mode_set(Elm_Transit *transit, Elm_Transit_Tween_Mode tween_mode) EINA_ARG_NONNULL(1);
25414
25415    /**
25416     * Get the transit animation acceleration type.
25417     *
25418     * @note @p transit can not be NULL
25419     *
25420     * @param transit The transit object.
25421     * @return The tween type. If @p transit is NULL
25422     * ELM_TRANSIT_TWEEN_MODE_LINEAR is returned.
25423     *
25424     * @ingroup Transit
25425     */
25426    EAPI Elm_Transit_Tween_Mode      elm_transit_tween_mode_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25427
25428    /**
25429     * Set the transit animation time
25430     *
25431     * @note @p transit can not be NULL
25432     *
25433     * @param transit The transit object.
25434     * @param duration The animation time.
25435     *
25436     * @ingroup Transit
25437     */
25438    EAPI void                        elm_transit_duration_set(Elm_Transit *transit, double duration) EINA_ARG_NONNULL(1);
25439
25440    /**
25441     * Get the transit animation time
25442     *
25443     * @note @p transit can not be NULL
25444     *
25445     * @param transit The transit object.
25446     *
25447     * @return The transit animation time.
25448     *
25449     * @ingroup Transit
25450     */
25451    EAPI double                      elm_transit_duration_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25452
25453    /**
25454     * Starts the transition.
25455     * Once this API is called, the transit begins to measure the time.
25456     *
25457     * @note @p transit can not be NULL
25458     *
25459     * @param transit The transit object.
25460     *
25461     * @ingroup Transit
25462     */
25463    EAPI void                        elm_transit_go(Elm_Transit *transit) EINA_ARG_NONNULL(1);
25464
25465    /**
25466     * Pause/Resume the transition.
25467     *
25468     * If you call elm_transit_go again, the transit will be started from the
25469     * beginning, and will be unpaused.
25470     *
25471     * @note @p transit can not be NULL
25472     *
25473     * @param transit The transit object.
25474     * @param paused Whether the transition should be paused or not.
25475     *
25476     * @ingroup Transit
25477     */
25478    EAPI void                        elm_transit_paused_set(Elm_Transit *transit, Eina_Bool paused) EINA_ARG_NONNULL(1);
25479
25480    /**
25481     * Get the value of paused status.
25482     *
25483     * @see elm_transit_paused_set()
25484     *
25485     * @note @p transit can not be NULL
25486     *
25487     * @param transit The transit object.
25488     * @return EINA_TRUE means transition is paused. If @p transit is NULL
25489     * EINA_FALSE is returned
25490     *
25491     * @ingroup Transit
25492     */
25493    EAPI Eina_Bool                   elm_transit_paused_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25494
25495    /**
25496     * Get the time progression of the animation (a double value between 0.0 and 1.0).
25497     *
25498     * The value returned is a fraction (current time / total time). It
25499     * represents the progression position relative to the total.
25500     *
25501     * @note @p transit can not be NULL
25502     *
25503     * @param transit The transit object.
25504     *
25505     * @return The time progression value. If @p transit is NULL
25506     * 0 is returned
25507     *
25508     * @ingroup Transit
25509     */
25510    EAPI double                      elm_transit_progress_value_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
25511
25512    /**
25513     * Makes the chain relationship between two transits.
25514     *
25515     * @note @p transit can not be NULL. Transit would have multiple chain transits.
25516     * @note @p chain_transit can not be NULL. Chain transits could be chained to the only one transit.
25517     *
25518     * @param transit The transit object.
25519     * @param chain_transit The chain transit object. This transit will be operated
25520     *        after transit is done.
25521     *
25522     * This function adds @p chain_transit transition to a chain after the @p
25523     * transit, and will be started as soon as @p transit ends. See @ref
25524     * transit_example_02_explained for a full example.
25525     *
25526     * @ingroup Transit
25527     */
25528    EAPI void                        elm_transit_chain_transit_add(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1, 2);
25529
25530    /**
25531     * Cut off the chain relationship between two transits.
25532     *
25533     * @note @p transit can not be NULL. Transit would have the chain relationship with @p chain transit.
25534     * @note @p chain_transit can not be NULL. Chain transits should be chained to the @p transit.
25535     *
25536     * @param transit The transit object.
25537     * @param chain_transit The chain transit object.
25538     *
25539     * This function remove the @p chain_transit transition from the @p transit.
25540     *
25541     * @ingroup Transit
25542     */
25543    EAPI void                        elm_transit_chain_transit_del(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1,2);
25544
25545    /**
25546     * Get the current chain transit list.
25547     *
25548     * @note @p transit can not be NULL.
25549     *
25550     * @param transit The transit object.
25551     * @return chain transit list.
25552     *
25553     * @ingroup Transit
25554     */
25555    EAPI Eina_List                  *elm_transit_chain_transits_get(const Elm_Transit *transit);
25556
25557    /**
25558     * Add the Resizing Effect to Elm_Transit.
25559     *
25560     * @note This API is one of the facades. It creates resizing effect context
25561     * and add it's required APIs to elm_transit_effect_add.
25562     *
25563     * @see elm_transit_effect_add()
25564     *
25565     * @param transit Transit object.
25566     * @param from_w Object width size when effect begins.
25567     * @param from_h Object height size when effect begins.
25568     * @param to_w Object width size when effect ends.
25569     * @param to_h Object height size when effect ends.
25570     * @return Resizing effect context data.
25571     *
25572     * @ingroup Transit
25573     */
25574    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);
25575
25576    /**
25577     * Add the Translation Effect to Elm_Transit.
25578     *
25579     * @note This API is one of the facades. It creates translation effect context
25580     * and add it's required APIs to elm_transit_effect_add.
25581     *
25582     * @see elm_transit_effect_add()
25583     *
25584     * @param transit Transit object.
25585     * @param from_dx X Position variation when effect begins.
25586     * @param from_dy Y Position variation when effect begins.
25587     * @param to_dx X Position variation when effect ends.
25588     * @param to_dy Y Position variation when effect ends.
25589     * @return Translation effect context data.
25590     *
25591     * @ingroup Transit
25592     * @warning It is highly recommended just create a transit with this effect when
25593     * the window that the objects of the transit belongs has already been created.
25594     * This is because this effect needs the geometry information about the objects,
25595     * and if the window was not created yet, it can get a wrong information.
25596     */
25597    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);
25598
25599    /**
25600     * Add the Zoom Effect to Elm_Transit.
25601     *
25602     * @note This API is one of the facades. It creates zoom effect context
25603     * and add it's required APIs to elm_transit_effect_add.
25604     *
25605     * @see elm_transit_effect_add()
25606     *
25607     * @param transit Transit object.
25608     * @param from_rate Scale rate when effect begins (1 is current rate).
25609     * @param to_rate Scale rate when effect ends.
25610     * @return Zoom effect context data.
25611     *
25612     * @ingroup Transit
25613     * @warning It is highly recommended just create a transit with this effect when
25614     * the window that the objects of the transit belongs has already been created.
25615     * This is because this effect needs the geometry information about the objects,
25616     * and if the window was not created yet, it can get a wrong information.
25617     */
25618    EAPI Elm_Transit_Effect *elm_transit_effect_zoom_add(Elm_Transit *transit, float from_rate, float to_rate);
25619
25620    /**
25621     * Add the Flip Effect to Elm_Transit.
25622     *
25623     * @note This API is one of the facades. It creates flip effect context
25624     * and add it's required APIs to elm_transit_effect_add.
25625     * @note This effect is applied to each pair of objects in the order they are listed
25626     * in the transit list of objects. The first object in the pair will be the
25627     * "front" object and the second will be the "back" object.
25628     *
25629     * @see elm_transit_effect_add()
25630     *
25631     * @param transit Transit object.
25632     * @param axis Flipping Axis(X or Y).
25633     * @param cw Flipping Direction. EINA_TRUE is clock-wise.
25634     * @return Flip effect context data.
25635     *
25636     * @ingroup Transit
25637     * @warning It is highly recommended just create a transit with this effect when
25638     * the window that the objects of the transit belongs has already been created.
25639     * This is because this effect needs the geometry information about the objects,
25640     * and if the window was not created yet, it can get a wrong information.
25641     */
25642    EAPI Elm_Transit_Effect *elm_transit_effect_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
25643
25644    /**
25645     * Add the Resizable Flip Effect to Elm_Transit.
25646     *
25647     * @note This API is one of the facades. It creates resizable flip effect context
25648     * and add it's required APIs to elm_transit_effect_add.
25649     * @note This effect is applied to each pair of objects in the order they are listed
25650     * in the transit list of objects. The first object in the pair will be the
25651     * "front" object and the second will be the "back" object.
25652     *
25653     * @see elm_transit_effect_add()
25654     *
25655     * @param transit Transit object.
25656     * @param axis Flipping Axis(X or Y).
25657     * @param cw Flipping Direction. EINA_TRUE is clock-wise.
25658     * @return Resizable flip effect context data.
25659     *
25660     * @ingroup Transit
25661     * @warning It is highly recommended just create a transit with this effect when
25662     * the window that the objects of the transit belongs has already been created.
25663     * This is because this effect needs the geometry information about the objects,
25664     * and if the window was not created yet, it can get a wrong information.
25665     */
25666    EAPI Elm_Transit_Effect *elm_transit_effect_resizable_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
25667
25668    /**
25669     * Add the Wipe Effect to Elm_Transit.
25670     *
25671     * @note This API is one of the facades. It creates wipe effect context
25672     * and add it's required APIs to elm_transit_effect_add.
25673     *
25674     * @see elm_transit_effect_add()
25675     *
25676     * @param transit Transit object.
25677     * @param type Wipe type. Hide or show.
25678     * @param dir Wipe Direction.
25679     * @return Wipe effect context data.
25680     *
25681     * @ingroup Transit
25682     * @warning It is highly recommended just create a transit with this effect when
25683     * the window that the objects of the transit belongs has already been created.
25684     * This is because this effect needs the geometry information about the objects,
25685     * and if the window was not created yet, it can get a wrong information.
25686     */
25687    EAPI Elm_Transit_Effect *elm_transit_effect_wipe_add(Elm_Transit *transit, Elm_Transit_Effect_Wipe_Type type, Elm_Transit_Effect_Wipe_Dir dir);
25688
25689    /**
25690     * Add the Color Effect to Elm_Transit.
25691     *
25692     * @note This API is one of the facades. It creates color effect context
25693     * and add it's required APIs to elm_transit_effect_add.
25694     *
25695     * @see elm_transit_effect_add()
25696     *
25697     * @param transit        Transit object.
25698     * @param  from_r        RGB R when effect begins.
25699     * @param  from_g        RGB G when effect begins.
25700     * @param  from_b        RGB B when effect begins.
25701     * @param  from_a        RGB A when effect begins.
25702     * @param  to_r          RGB R when effect ends.
25703     * @param  to_g          RGB G when effect ends.
25704     * @param  to_b          RGB B when effect ends.
25705     * @param  to_a          RGB A when effect ends.
25706     * @return               Color effect context data.
25707     *
25708     * @ingroup Transit
25709     */
25710    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);
25711
25712    /**
25713     * Add the Fade Effect to Elm_Transit.
25714     *
25715     * @note This API is one of the facades. It creates fade effect context
25716     * and add it's required APIs to elm_transit_effect_add.
25717     * @note This effect is applied to each pair of objects in the order they are listed
25718     * in the transit list of objects. The first object in the pair will be the
25719     * "before" object and the second will be the "after" object.
25720     *
25721     * @see elm_transit_effect_add()
25722     *
25723     * @param transit Transit object.
25724     * @return Fade effect context data.
25725     *
25726     * @ingroup Transit
25727     * @warning It is highly recommended just create a transit with this effect when
25728     * the window that the objects of the transit belongs has already been created.
25729     * This is because this effect needs the color information about the objects,
25730     * and if the window was not created yet, it can get a wrong information.
25731     */
25732    EAPI Elm_Transit_Effect *elm_transit_effect_fade_add(Elm_Transit *transit);
25733
25734    /**
25735     * Add the Blend Effect to Elm_Transit.
25736     *
25737     * @note This API is one of the facades. It creates blend effect context
25738     * and add it's required APIs to elm_transit_effect_add.
25739     * @note This effect is applied to each pair of objects in the order they are listed
25740     * in the transit list of objects. The first object in the pair will be the
25741     * "before" object and the second will be the "after" object.
25742     *
25743     * @see elm_transit_effect_add()
25744     *
25745     * @param transit Transit object.
25746     * @return Blend effect context data.
25747     *
25748     * @ingroup Transit
25749     * @warning It is highly recommended just create a transit with this effect when
25750     * the window that the objects of the transit belongs has already been created.
25751     * This is because this effect needs the color information about the objects,
25752     * and if the window was not created yet, it can get a wrong information.
25753     */
25754    EAPI Elm_Transit_Effect *elm_transit_effect_blend_add(Elm_Transit *transit);
25755
25756    /**
25757     * Add the Rotation Effect to Elm_Transit.
25758     *
25759     * @note This API is one of the facades. It creates rotation effect context
25760     * and add it's required APIs to elm_transit_effect_add.
25761     *
25762     * @see elm_transit_effect_add()
25763     *
25764     * @param transit Transit object.
25765     * @param from_degree Degree when effect begins.
25766     * @param to_degree Degree when effect is ends.
25767     * @return Rotation effect context data.
25768     *
25769     * @ingroup Transit
25770     * @warning It is highly recommended just create a transit with this effect when
25771     * the window that the objects of the transit belongs has already been created.
25772     * This is because this effect needs the geometry information about the objects,
25773     * and if the window was not created yet, it can get a wrong information.
25774     */
25775    EAPI Elm_Transit_Effect *elm_transit_effect_rotation_add(Elm_Transit *transit, float from_degree, float to_degree);
25776
25777    /**
25778     * Add the ImageAnimation Effect to Elm_Transit.
25779     *
25780     * @note This API is one of the facades. It creates image animation effect context
25781     * and add it's required APIs to elm_transit_effect_add.
25782     * The @p images parameter is a list images paths. This list and
25783     * its contents will be deleted at the end of the effect by
25784     * elm_transit_effect_image_animation_context_free() function.
25785     *
25786     * Example:
25787     * @code
25788     * char buf[PATH_MAX];
25789     * Eina_List *images = NULL;
25790     * Elm_Transit *transi = elm_transit_add();
25791     *
25792     * snprintf(buf, sizeof(buf), "%s/images/icon_11.png", PACKAGE_DATA_DIR);
25793     * images = eina_list_append(images, eina_stringshare_add(buf));
25794     *
25795     * snprintf(buf, sizeof(buf), "%s/images/logo_small.png", PACKAGE_DATA_DIR);
25796     * images = eina_list_append(images, eina_stringshare_add(buf));
25797     * elm_transit_effect_image_animation_add(transi, images);
25798     *
25799     * @endcode
25800     *
25801     * @see elm_transit_effect_add()
25802     *
25803     * @param transit Transit object.
25804     * @param images Eina_List of images file paths. This list and
25805     * its contents will be deleted at the end of the effect by
25806     * elm_transit_effect_image_animation_context_free() function.
25807     * @return Image Animation effect context data.
25808     *
25809     * @ingroup Transit
25810     */
25811    EAPI Elm_Transit_Effect *elm_transit_effect_image_animation_add(Elm_Transit *transit, Eina_List *images);
25812    /**
25813     * @}
25814     */
25815
25816   typedef struct _Elm_Store                      Elm_Store;
25817   typedef struct _Elm_Store_Filesystem           Elm_Store_Filesystem;
25818   typedef struct _Elm_Store_Item                 Elm_Store_Item;
25819   typedef struct _Elm_Store_Item_Filesystem      Elm_Store_Item_Filesystem;
25820   typedef struct _Elm_Store_Item_Info            Elm_Store_Item_Info;
25821   typedef struct _Elm_Store_Item_Info_Filesystem Elm_Store_Item_Info_Filesystem;
25822   typedef struct _Elm_Store_Item_Mapping         Elm_Store_Item_Mapping;
25823   typedef struct _Elm_Store_Item_Mapping_Empty   Elm_Store_Item_Mapping_Empty;
25824   typedef struct _Elm_Store_Item_Mapping_Icon    Elm_Store_Item_Mapping_Icon;
25825   typedef struct _Elm_Store_Item_Mapping_Photo   Elm_Store_Item_Mapping_Photo;
25826   typedef struct _Elm_Store_Item_Mapping_Custom  Elm_Store_Item_Mapping_Custom;
25827
25828   typedef Eina_Bool (*Elm_Store_Item_List_Cb) (void *data, Elm_Store_Item_Info *info);
25829   typedef void      (*Elm_Store_Item_Fetch_Cb) (void *data, Elm_Store_Item *sti);
25830   typedef void      (*Elm_Store_Item_Unfetch_Cb) (void *data, Elm_Store_Item *sti);
25831   typedef void     *(*Elm_Store_Item_Mapping_Cb) (void *data, Elm_Store_Item *sti, const char *part);
25832
25833   typedef enum
25834     {
25835        ELM_STORE_ITEM_MAPPING_NONE = 0,
25836        ELM_STORE_ITEM_MAPPING_LABEL, // const char * -> label
25837        ELM_STORE_ITEM_MAPPING_STATE, // Eina_Bool -> state
25838        ELM_STORE_ITEM_MAPPING_ICON, // char * -> icon path
25839        ELM_STORE_ITEM_MAPPING_PHOTO, // char * -> photo path
25840        ELM_STORE_ITEM_MAPPING_CUSTOM, // item->custom(it->data, it, part) -> void * (-> any)
25841        // can add more here as needed by common apps
25842        ELM_STORE_ITEM_MAPPING_LAST
25843     } Elm_Store_Item_Mapping_Type;
25844
25845   struct _Elm_Store_Item_Mapping_Icon
25846     {
25847        // FIXME: allow edje file icons
25848        int                   w, h;
25849        Elm_Icon_Lookup_Order lookup_order;
25850        Eina_Bool             standard_name : 1;
25851        Eina_Bool             no_scale : 1;
25852        Eina_Bool             smooth : 1;
25853        Eina_Bool             scale_up : 1;
25854        Eina_Bool             scale_down : 1;
25855     };
25856
25857   struct _Elm_Store_Item_Mapping_Empty
25858     {
25859        Eina_Bool             dummy;
25860     };
25861
25862   struct _Elm_Store_Item_Mapping_Photo
25863     {
25864        int                   size;
25865     };
25866
25867   struct _Elm_Store_Item_Mapping_Custom
25868     {
25869        Elm_Store_Item_Mapping_Cb func;
25870     };
25871
25872   struct _Elm_Store_Item_Mapping
25873     {
25874        Elm_Store_Item_Mapping_Type     type;
25875        const char                     *part;
25876        int                             offset;
25877        union
25878          {
25879             Elm_Store_Item_Mapping_Empty  empty;
25880             Elm_Store_Item_Mapping_Icon   icon;
25881             Elm_Store_Item_Mapping_Photo  photo;
25882             Elm_Store_Item_Mapping_Custom custom;
25883             // add more types here
25884          } details;
25885     };
25886
25887   struct _Elm_Store_Item_Info
25888     {
25889       Elm_Genlist_Item_Class       *item_class;
25890       const Elm_Store_Item_Mapping *mapping;
25891       void                         *data;
25892       char                         *sort_id;
25893     };
25894
25895   struct _Elm_Store_Item_Info_Filesystem
25896     {
25897       Elm_Store_Item_Info  base;
25898       char                *path;
25899     };
25900
25901 #define ELM_STORE_ITEM_MAPPING_END { ELM_STORE_ITEM_MAPPING_NONE, NULL, 0, { .empty = { EINA_TRUE } } }
25902 #define ELM_STORE_ITEM_MAPPING_OFFSET(st, it) offsetof(st, it)
25903
25904   EAPI void                    elm_store_free(Elm_Store *st);
25905
25906   EAPI Elm_Store              *elm_store_filesystem_new(void);
25907   EAPI void                    elm_store_filesystem_directory_set(Elm_Store *st, const char *dir) EINA_ARG_NONNULL(1);
25908   EAPI const char             *elm_store_filesystem_directory_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
25909   EAPI const char             *elm_store_item_filesystem_path_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
25910
25911   EAPI void                    elm_store_target_genlist_set(Elm_Store *st, Evas_Object *obj) EINA_ARG_NONNULL(1);
25912
25913   EAPI void                    elm_store_cache_set(Elm_Store *st, int max) EINA_ARG_NONNULL(1);
25914   EAPI int                     elm_store_cache_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
25915   EAPI void                    elm_store_list_func_set(Elm_Store *st, Elm_Store_Item_List_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
25916   EAPI void                    elm_store_fetch_func_set(Elm_Store *st, Elm_Store_Item_Fetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
25917   EAPI void                    elm_store_fetch_thread_set(Elm_Store *st, Eina_Bool use_thread) EINA_ARG_NONNULL(1);
25918   EAPI Eina_Bool               elm_store_fetch_thread_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
25919
25920   EAPI void                    elm_store_unfetch_func_set(Elm_Store *st, Elm_Store_Item_Unfetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
25921   EAPI void                    elm_store_sorted_set(Elm_Store *st, Eina_Bool sorted) EINA_ARG_NONNULL(1);
25922   EAPI Eina_Bool               elm_store_sorted_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
25923   EAPI void                    elm_store_item_data_set(Elm_Store_Item *sti, void *data) EINA_ARG_NONNULL(1);
25924   EAPI void                   *elm_store_item_data_get(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
25925   EAPI const Elm_Store        *elm_store_item_store_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
25926   EAPI const Elm_Genlist_Item *elm_store_item_genlist_item_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
25927
25928    /**
25929     * @defgroup SegmentControl SegmentControl
25930     * @ingroup Elementary
25931     *
25932     * @image html img/widget/segment_control/preview-00.png
25933     * @image latex img/widget/segment_control/preview-00.eps width=\textwidth
25934     *
25935     * @image html img/segment_control.png
25936     * @image latex img/segment_control.eps width=\textwidth
25937     *
25938     * Segment control widget is a horizontal control made of multiple segment
25939     * items, each segment item functioning similar to discrete two state button.
25940     * A segment control groups the items together and provides compact
25941     * single button with multiple equal size segments.
25942     *
25943     * Segment item size is determined by base widget
25944     * size and the number of items added.
25945     * Only one segment item can be at selected state. A segment item can display
25946     * combination of Text and any Evas_Object like Images or other widget.
25947     *
25948     * Smart callbacks one can listen to:
25949     * - "changed" - When the user clicks on a segment item which is not
25950     *   previously selected and get selected. The event_info parameter is the
25951     *   segment item index.
25952     *
25953     * Available styles for it:
25954     * - @c "default"
25955     *
25956     * Here is an example on its usage:
25957     * @li @ref segment_control_example
25958     */
25959
25960    /**
25961     * @addtogroup SegmentControl
25962     * @{
25963     */
25964
25965    typedef struct _Elm_Segment_Item Elm_Segment_Item; /**< Item handle for a segment control widget. */
25966
25967    /**
25968     * Add a new segment control widget to the given parent Elementary
25969     * (container) object.
25970     *
25971     * @param parent The parent object.
25972     * @return a new segment control widget handle or @c NULL, on errors.
25973     *
25974     * This function inserts a new segment control widget on the canvas.
25975     *
25976     * @ingroup SegmentControl
25977     */
25978    EAPI Evas_Object      *elm_segment_control_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25979
25980    /**
25981     * Append a new item to the segment control object.
25982     *
25983     * @param obj The segment control object.
25984     * @param icon The icon object to use for the left side of the item. An
25985     * icon can be any Evas object, but usually it is an icon created
25986     * with elm_icon_add().
25987     * @param label The label of the item.
25988     *        Note that, NULL is different from empty string "".
25989     * @return The created item or @c NULL upon failure.
25990     *
25991     * A new item will be created and appended to the segment control, i.e., will
25992     * be set as @b last item.
25993     *
25994     * If it should be inserted at another position,
25995     * elm_segment_control_item_insert_at() should be used instead.
25996     *
25997     * Items created with this function can be deleted with function
25998     * elm_segment_control_item_del() or elm_segment_control_item_del_at().
25999     *
26000     * @note @p label set to @c NULL is different from empty string "".
26001     * If an item
26002     * only has icon, it will be displayed bigger and centered. If it has
26003     * icon and label, even that an empty string, icon will be smaller and
26004     * positioned at left.
26005     *
26006     * Simple example:
26007     * @code
26008     * sc = elm_segment_control_add(win);
26009     * ic = elm_icon_add(win);
26010     * elm_icon_file_set(ic, "path/to/image", NULL);
26011     * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
26012     * elm_segment_control_item_add(sc, ic, "label");
26013     * evas_object_show(sc);
26014     * @endcode
26015     *
26016     * @see elm_segment_control_item_insert_at()
26017     * @see elm_segment_control_item_del()
26018     *
26019     * @ingroup SegmentControl
26020     */
26021    EAPI Elm_Segment_Item *elm_segment_control_item_add(Evas_Object *obj, Evas_Object *icon, const char *label) EINA_ARG_NONNULL(1);
26022
26023    /**
26024     * Insert a new item to the segment control object at specified position.
26025     *
26026     * @param obj The segment control object.
26027     * @param icon The icon object to use for the left side of the item. An
26028     * icon can be any Evas object, but usually it is an icon created
26029     * with elm_icon_add().
26030     * @param label The label of the item.
26031     * @param index Item position. Value should be between 0 and items count.
26032     * @return The created item or @c NULL upon failure.
26033
26034     * Index values must be between @c 0, when item will be prepended to
26035     * segment control, and items count, that can be get with
26036     * elm_segment_control_item_count_get(), case when item will be appended
26037     * to segment control, just like elm_segment_control_item_add().
26038     *
26039     * Items created with this function can be deleted with function
26040     * elm_segment_control_item_del() or elm_segment_control_item_del_at().
26041     *
26042     * @note @p label set to @c NULL is different from empty string "".
26043     * If an item
26044     * only has icon, it will be displayed bigger and centered. If it has
26045     * icon and label, even that an empty string, icon will be smaller and
26046     * positioned at left.
26047     *
26048     * @see elm_segment_control_item_add()
26049     * @see elm_segment_control_count_get()
26050     * @see elm_segment_control_item_del()
26051     *
26052     * @ingroup SegmentControl
26053     */
26054    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);
26055
26056    /**
26057     * Remove a segment control item from its parent, deleting it.
26058     *
26059     * @param it The item to be removed.
26060     *
26061     * Items can be added with elm_segment_control_item_add() or
26062     * elm_segment_control_item_insert_at().
26063     *
26064     * @ingroup SegmentControl
26065     */
26066    EAPI void              elm_segment_control_item_del(Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
26067
26068    /**
26069     * Remove a segment control item at given index from its parent,
26070     * deleting it.
26071     *
26072     * @param obj The segment control object.
26073     * @param index The position of the segment control item to be deleted.
26074     *
26075     * Items can be added with elm_segment_control_item_add() or
26076     * elm_segment_control_item_insert_at().
26077     *
26078     * @ingroup SegmentControl
26079     */
26080    EAPI void              elm_segment_control_item_del_at(Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
26081
26082    /**
26083     * Get the Segment items count from segment control.
26084     *
26085     * @param obj The segment control object.
26086     * @return Segment items count.
26087     *
26088     * It will just return the number of items added to segment control @p obj.
26089     *
26090     * @ingroup SegmentControl
26091     */
26092    EAPI int               elm_segment_control_item_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26093
26094    /**
26095     * Get the item placed at specified index.
26096     *
26097     * @param obj The segment control object.
26098     * @param index The index of the segment item.
26099     * @return The segment control item or @c NULL on failure.
26100     *
26101     * Index is the position of an item in segment control widget. Its
26102     * range is from @c 0 to <tt> count - 1 </tt>.
26103     * Count is the number of items, that can be get with
26104     * elm_segment_control_item_count_get().
26105     *
26106     * @ingroup SegmentControl
26107     */
26108    EAPI Elm_Segment_Item *elm_segment_control_item_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
26109
26110    /**
26111     * Get the label of item.
26112     *
26113     * @param obj The segment control object.
26114     * @param index The index of the segment item.
26115     * @return The label of the item at @p index.
26116     *
26117     * The return value is a pointer to the label associated to the item when
26118     * it was created, with function elm_segment_control_item_add(), or later
26119     * with function elm_segment_control_item_label_set. If no label
26120     * was passed as argument, it will return @c NULL.
26121     *
26122     * @see elm_segment_control_item_label_set() for more details.
26123     * @see elm_segment_control_item_add()
26124     *
26125     * @ingroup SegmentControl
26126     */
26127    EAPI const char       *elm_segment_control_item_label_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
26128
26129    /**
26130     * Set the label of item.
26131     *
26132     * @param it The item of segment control.
26133     * @param text The label of item.
26134     *
26135     * The label to be displayed by the item.
26136     * Label will be at right of the icon (if set).
26137     *
26138     * If a label was passed as argument on item creation, with function
26139     * elm_control_segment_item_add(), it will be already
26140     * displayed by the item.
26141     *
26142     * @see elm_segment_control_item_label_get()
26143     * @see elm_segment_control_item_add()
26144     *
26145     * @ingroup SegmentControl
26146     */
26147    EAPI void              elm_segment_control_item_label_set(Elm_Segment_Item* it, const char* label) EINA_ARG_NONNULL(1);
26148
26149    /**
26150     * Get the icon associated to the item.
26151     *
26152     * @param obj The segment control object.
26153     * @param index The index of the segment item.
26154     * @return The left side icon associated to the item at @p index.
26155     *
26156     * The return value is a pointer to the icon associated to the item when
26157     * it was created, with function elm_segment_control_item_add(), or later
26158     * with function elm_segment_control_item_icon_set(). If no icon
26159     * was passed as argument, it will return @c NULL.
26160     *
26161     * @see elm_segment_control_item_add()
26162     * @see elm_segment_control_item_icon_set()
26163     *
26164     * @ingroup SegmentControl
26165     */
26166    EAPI Evas_Object      *elm_segment_control_item_icon_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
26167
26168    /**
26169     * Set the icon associated to the item.
26170     *
26171     * @param it The segment control item.
26172     * @param icon The icon object to associate with @p it.
26173     *
26174     * The icon object to use at left side of the item. An
26175     * icon can be any Evas object, but usually it is an icon created
26176     * with elm_icon_add().
26177     *
26178     * Once the icon object is set, a previously set one will be deleted.
26179     * @warning Setting the same icon for two items will cause the icon to
26180     * dissapear from the first item.
26181     *
26182     * If an icon was passed as argument on item creation, with function
26183     * elm_segment_control_item_add(), it will be already
26184     * associated to the item.
26185     *
26186     * @see elm_segment_control_item_add()
26187     * @see elm_segment_control_item_icon_get()
26188     *
26189     * @ingroup SegmentControl
26190     */
26191    EAPI void              elm_segment_control_item_icon_set(Elm_Segment_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
26192
26193    /**
26194     * Get the index of an item.
26195     *
26196     * @param it The segment control item.
26197     * @return The position of item in segment control widget.
26198     *
26199     * Index is the position of an item in segment control widget. Its
26200     * range is from @c 0 to <tt> count - 1 </tt>.
26201     * Count is the number of items, that can be get with
26202     * elm_segment_control_item_count_get().
26203     *
26204     * @ingroup SegmentControl
26205     */
26206    EAPI int               elm_segment_control_item_index_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
26207
26208    /**
26209     * Get the base object of the item.
26210     *
26211     * @param it The segment control item.
26212     * @return The base object associated with @p it.
26213     *
26214     * Base object is the @c Evas_Object that represents that item.
26215     *
26216     * @ingroup SegmentControl
26217     */
26218    EAPI Evas_Object      *elm_segment_control_item_object_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
26219
26220    /**
26221     * Get the selected item.
26222     *
26223     * @param obj The segment control object.
26224     * @return The selected item or @c NULL if none of segment items is
26225     * selected.
26226     *
26227     * The selected item can be unselected with function
26228     * elm_segment_control_item_selected_set().
26229     *
26230     * The selected item always will be highlighted on segment control.
26231     *
26232     * @ingroup SegmentControl
26233     */
26234    EAPI Elm_Segment_Item *elm_segment_control_item_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26235
26236    /**
26237     * Set the selected state of an item.
26238     *
26239     * @param it The segment control item
26240     * @param select The selected state
26241     *
26242     * This sets the selected state of the given item @p it.
26243     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
26244     *
26245     * If a new item is selected the previosly selected will be unselected.
26246     * Previoulsy selected item can be get with function
26247     * elm_segment_control_item_selected_get().
26248     *
26249     * The selected item always will be highlighted on segment control.
26250     *
26251     * @see elm_segment_control_item_selected_get()
26252     *
26253     * @ingroup SegmentControl
26254     */
26255    EAPI void              elm_segment_control_item_selected_set(Elm_Segment_Item *it, Eina_Bool select) EINA_ARG_NONNULL(1);
26256
26257    /**
26258     * @}
26259     */
26260
26261    /**
26262     * @defgroup Grid Grid
26263     *
26264     * The grid is a grid layout widget that lays out a series of children as a
26265     * fixed "grid" of widgets using a given percentage of the grid width and
26266     * height each using the child object.
26267     *
26268     * The Grid uses a "Virtual resolution" that is stretched to fill the grid
26269     * widgets size itself. The default is 100 x 100, so that means the
26270     * position and sizes of children will effectively be percentages (0 to 100)
26271     * of the width or height of the grid widget
26272     *
26273     * @{
26274     */
26275
26276    /**
26277     * Add a new grid to the parent
26278     *
26279     * @param parent The parent object
26280     * @return The new object or NULL if it cannot be created
26281     *
26282     * @ingroup Grid
26283     */
26284    EAPI Evas_Object *elm_grid_add(Evas_Object *parent);
26285
26286    /**
26287     * Set the virtual size of the grid
26288     *
26289     * @param obj The grid object
26290     * @param w The virtual width of the grid
26291     * @param h The virtual height of the grid
26292     *
26293     * @ingroup Grid
26294     */
26295    EAPI void         elm_grid_size_set(Evas_Object *obj, int w, int h);
26296
26297    /**
26298     * Get the virtual size of the grid
26299     *
26300     * @param obj The grid object
26301     * @param w Pointer to integer to store the virtual width of the grid
26302     * @param h Pointer to integer to store the virtual height of the grid
26303     *
26304     * @ingroup Grid
26305     */
26306    EAPI void         elm_grid_size_get(Evas_Object *obj, int *w, int *h);
26307
26308    /**
26309     * Pack child at given position and size
26310     *
26311     * @param obj The grid object
26312     * @param subobj The child to pack
26313     * @param x The virtual x coord at which to pack it
26314     * @param y The virtual y coord at which to pack it
26315     * @param w The virtual width at which to pack it
26316     * @param h The virtual height at which to pack it
26317     *
26318     * @ingroup Grid
26319     */
26320    EAPI void         elm_grid_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h);
26321
26322    /**
26323     * Unpack a child from a grid object
26324     *
26325     * @param obj The grid object
26326     * @param subobj The child to unpack
26327     *
26328     * @ingroup Grid
26329     */
26330    EAPI void         elm_grid_unpack(Evas_Object *obj, Evas_Object *subobj);
26331
26332    /**
26333     * Faster way to remove all child objects from a grid object.
26334     *
26335     * @param obj The grid object
26336     * @param clear If true, it will delete just removed children
26337     *
26338     * @ingroup Grid
26339     */
26340    EAPI void         elm_grid_clear(Evas_Object *obj, Eina_Bool clear);
26341
26342    /**
26343     * Set packing of an existing child at to position and size
26344     *
26345     * @param subobj The child to set packing of
26346     * @param x The virtual x coord at which to pack it
26347     * @param y The virtual y coord at which to pack it
26348     * @param w The virtual width at which to pack it
26349     * @param h The virtual height at which to pack it
26350     *
26351     * @ingroup Grid
26352     */
26353    EAPI void         elm_grid_pack_set(Evas_Object *subobj, int x, int y, int w, int h);
26354
26355    /**
26356     * get packing of a child
26357     *
26358     * @param subobj The child to query
26359     * @param x Pointer to integer to store the virtual x coord
26360     * @param y Pointer to integer to store the virtual y coord
26361     * @param w Pointer to integer to store the virtual width
26362     * @param h Pointer to integer to store the virtual height
26363     *
26364     * @ingroup Grid
26365     */
26366    EAPI void         elm_grid_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h);
26367
26368    /**
26369     * @}
26370     */
26371
26372    EAPI Evas_Object *elm_factory_add(Evas_Object *parent);
26373    EAPI void         elm_factory_content_set(Evas_Object *obj, Evas_Object *content);
26374    EAPI Evas_Object *elm_factory_content_get(const Evas_Object *obj);
26375
26376    /**
26377     * @defgroup Video Video
26378     *
26379     * This object display an player that let you control an Elm_Video
26380     * object. It take care of updating it's content according to what is
26381     * going on inside the Emotion object. It does activate the remember
26382     * function on the linked Elm_Video object.
26383     *
26384     * Signals that you cann add callback for are :
26385     *
26386     * "forward,clicked" - the user clicked the forward button.
26387     * "info,clicked" - the user clicked the info button.
26388     * "next,clicked" - the user clicked the next button.
26389     * "pause,clicked" - the user clicked the pause button.
26390     * "play,clicked" - the user clicked the play button.
26391     * "prev,clicked" - the user clicked the prev button.
26392     * "rewind,clicked" - the user clicked the rewind button.
26393     * "stop,clicked" - the user clicked the stop button.
26394     */
26395    EAPI Evas_Object *elm_video_add(Evas_Object *parent);
26396    EAPI void elm_video_file_set(Evas_Object *video, const char *filename);
26397    EAPI void elm_video_uri_set(Evas_Object *video, const char *uri);
26398    EAPI Evas_Object *elm_video_emotion_get(Evas_Object *video);
26399    EAPI void elm_video_play(Evas_Object *video);
26400    EAPI void elm_video_pause(Evas_Object *video);
26401    EAPI void elm_video_stop(Evas_Object *video);
26402    EAPI Eina_Bool elm_video_is_playing(Evas_Object *video);
26403    EAPI Eina_Bool elm_video_is_seekable(Evas_Object *video);
26404    EAPI Eina_Bool elm_video_audio_mute_get(Evas_Object *video);
26405    EAPI void elm_video_audio_mute_set(Evas_Object *video, Eina_Bool mute);
26406    EAPI double elm_video_audio_level_get(Evas_Object *video);
26407    EAPI void elm_video_audio_level_set(Evas_Object *video, double volume);
26408    EAPI double elm_video_play_position_get(Evas_Object *video);
26409    EAPI void elm_video_play_position_set(Evas_Object *video, double position);
26410    EAPI double elm_video_play_length_get(Evas_Object *video);
26411    EAPI void elm_video_remember_position_set(Evas_Object *video, Eina_Bool remember);
26412    EAPI Eina_Bool elm_video_remember_position_get(Evas_Object *video);
26413    EAPI const char *elm_video_title_get(Evas_Object *video);
26414
26415    EAPI Evas_Object *elm_player_add(Evas_Object *parent);
26416    EAPI void elm_player_video_set(Evas_Object *player, Evas_Object *video);
26417
26418   /* naviframe */
26419    EAPI Evas_Object        *elm_naviframe_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26420    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);
26421    EAPI Evas_Object        *elm_naviframe_item_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
26422    EAPI void                elm_naviframe_content_preserve_on_pop_set(Evas_Object *obj, Eina_Bool preserve) EINA_ARG_NONNULL(1);
26423    EAPI Eina_Bool           elm_naviframe_content_preserve_on_pop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26424    EAPI void                elm_naviframe_item_title_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
26425    EAPI const char         *elm_naviframe_item_title_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26426    EAPI void                elm_naviframe_item_subtitle_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
26427    EAPI const char         *elm_naviframe_item_subtitle_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26428    EAPI Elm_Object_Item    *elm_naviframe_top_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26429    EAPI Elm_Object_Item    *elm_naviframe_bottom_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26430    EAPI void                elm_naviframe_item_style_set(Elm_Object_Item *it, const char *item_style) EINA_ARG_NONNULL(1);
26431    EAPI const char         *elm_naviframe_item_style_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26432    EAPI void                elm_naviframe_item_title_visible_set(Elm_Object_Item *it, Eina_Bool visible) EINA_ARG_NONNULL(1);
26433    EAPI Eina_Bool           elm_naviframe_item_title_visible_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26434
26435 #ifdef __cplusplus
26436 }
26437 #endif
26438
26439 #endif