elementary - removed deprecated widgets & 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.8.0
15 @date 2008-2011
16
17 @section intro What is Elementary?
18
19 This is a VERY SIMPLE toolkit. It is not meant for writing extensive desktop
20 applications (yet). Small simple ones with simple needs.
21
22 It is meant to make the programmers work almost brainless but give them lots
23 of flexibility.
24
25 @li @ref Start - Go here to quickly get started with writing Apps
26
27 @section organization Organization
28
29 One can divide Elemementary into three main groups:
30 @li @ref infralist - These are modules that deal with Elementary as a whole.
31 @li @ref widgetslist - These are the widgets you'll compose your UI out of.
32 @li @ref containerslist - These are the containers which hold the widgets.
33
34 @section license License
35
36 LGPL v2 (see COPYING in the base of Elementary's source). This applies to
37 all files in the source tree.
38
39 @section ack Acknowledgements
40 There is a lot that goes into making a widget set, and they don't happen out of
41 nothing. It's like trying to make everyone everywhere happy, regardless of age,
42 gender, race or nationality - and that is really tough. So thanks to people and
43 organisations behind this, as listed in the @ref authors page.
44 */
45
46
47 /**
48  * @defgroup Start Getting Started
49  *
50  * To write an Elementary app, you can get started with the following:
51  *
52 @code
53 #include <Elementary.h>
54 EAPI_MAIN int
55 elm_main(int argc, char **argv)
56 {
57    // create window(s) here and do any application init
58    elm_run(); // run main loop
59    elm_shutdown(); // after mainloop finishes running, shutdown
60    return 0; // exit 0 for exit code
61 }
62 ELM_MAIN()
63 @endcode
64  *
65  * To use autotools (which helps in many ways in the long run, like being able
66  * to immediately create releases of your software directly from your tree
67  * and ensure everything needed to build it is there) you will need a
68  * configure.ac, Makefile.am and autogen.sh file.
69  *
70  * configure.ac:
71  *
72 @verbatim
73 AC_INIT(myapp, 0.0.0, myname@mydomain.com)
74 AC_PREREQ(2.52)
75 AC_CONFIG_SRCDIR(configure.ac)
76 AM_CONFIG_HEADER(config.h)
77 AC_PROG_CC
78 AM_INIT_AUTOMAKE(1.6 dist-bzip2)
79 PKG_CHECK_MODULES([ELEMENTARY], elementary)
80 AC_OUTPUT(Makefile)
81 @endverbatim
82  *
83  * Makefile.am:
84  *
85 @verbatim
86 AUTOMAKE_OPTIONS = 1.4 foreign
87 MAINTAINERCLEANFILES = Makefile.in aclocal.m4 config.h.in configure depcomp install-sh missing
88
89 INCLUDES = -I$(top_srcdir)
90
91 bin_PROGRAMS = myapp
92
93 myapp_SOURCES = main.c
94 myapp_LDADD = @ELEMENTARY_LIBS@
95 myapp_CFLAGS = @ELEMENTARY_CFLAGS@
96 @endverbatim
97  *
98  * autogen.sh:
99  *
100 @verbatim
101 #!/bin/sh
102 echo "Running aclocal..." ; aclocal $ACLOCAL_FLAGS || exit 1
103 echo "Running autoheader..." ; autoheader || exit 1
104 echo "Running autoconf..." ; autoconf || exit 1
105 echo "Running automake..." ; automake --add-missing --copy --gnu || exit 1
106 ./configure "$@"
107 @endverbatim
108  *
109  * To generate all the things needed to bootstrap just run:
110  *
111 @verbatim
112 ./autogen.sh
113 @endverbatim
114  *
115  * This will generate Makefile.in's, the confgure script and everything else.
116  * After this it works like all normal autotools projects:
117 @verbatim
118 ./configure
119 make
120 sudo make install
121 @endverbatim
122  *
123  * Note sudo was assumed to get root permissions, as this would install in
124  * /usr/local which is system-owned. Use any way you like to gain root, or
125  * specify a different prefix with configure:
126  *
127 @verbatim
128 ./confiugre --prefix=$HOME/mysoftware
129 @endverbatim
130  *
131  * Also remember that autotools buys you some useful commands like:
132 @verbatim
133 make uninstall
134 @endverbatim
135  *
136  * This uninstalls the software after it was installed with "make install".
137  * It is very useful to clear up what you built if you wish to clean the
138  * system.
139  *
140 @verbatim
141 make distcheck
142 @endverbatim
143  *
144  * This firstly checks if your build tree is "clean" and ready for
145  * distribution. It also builds a tarball (myapp-0.0.0.tar.gz) that is
146  * ready to upload and distribute to the world, that contains the generated
147  * Makefile.in's and configure script. The users do not need to run
148  * autogen.sh - just configure and on. They don't need autotools installed.
149  * This tarball also builds cleanly, has all the sources it needs to build
150  * included (that is sources for your application, not libraries it depends
151  * on like Elementary). It builds cleanly in a buildroot and does not
152  * contain any files that are temporarily generated like binaries and other
153  * build-generated files, so the tarball is clean, and no need to worry
154  * about cleaning up your tree before packaging.
155  *
156 @verbatim
157 make clean
158 @endverbatim
159  *
160  * This cleans up all build files (binaries, objects etc.) from the tree.
161  *
162 @verbatim
163 make distclean
164 @endverbatim
165  *
166  * This cleans out all files from the build and from configure's output too.
167  *
168 @verbatim
169 make maintainer-clean
170 @endverbatim
171  *
172  * This deletes all the files autogen.sh will produce so the tree is clean
173  * to be put into a revision-control system (like CVS, SVN or GIT for example).
174  *
175  * There is a more advanced way of making use of the quicklaunch infrastructure
176  * in Elementary (which will not be covered here due to its more advanced
177  * nature).
178  *
179  * Now let's actually create an interactive "Hello World" gui that you can
180  * click the ok button to exit. It's more code because this now does something
181  * much more significant, but it's still very simple:
182  *
183 @code
184 #include <Elementary.h>
185
186 static void
187 on_done(void *data, Evas_Object *obj, void *event_info)
188 {
189    // quit the mainloop (elm_run function will return)
190    elm_exit();
191 }
192
193 EAPI_MAIN int
194 elm_main(int argc, char **argv)
195 {
196    Evas_Object *win, *bg, *box, *lab, *btn;
197
198    // new window - do the usual and give it a name (hello) and title (Hello)
199    win = elm_win_util_standard_add("hello", "Hello");
200    // when the user clicks "close" on a window there is a request to delete
201    evas_object_smart_callback_add(win, "delete,request", on_done, NULL);
202
203    // add a box object - default is vertical. a box holds children in a row,
204    // either horizontally or vertically. nothing more.
205    box = elm_box_add(win);
206    // make the box hotizontal
207    elm_box_horizontal_set(box, EINA_TRUE);
208    // add object as a resize object for the window (controls window minimum
209    // size as well as gets resized if window is resized)
210    elm_win_resize_object_add(win, box);
211    evas_object_show(box);
212
213    // add a label widget, set the text and put it in the pad frame
214    lab = elm_label_add(win);
215    // set default text of the label
216    elm_object_text_set(lab, "Hello out there world!");
217    // pack the label at the end of the box
218    elm_box_pack_end(box, lab);
219    evas_object_show(lab);
220
221    // add an ok button
222    btn = elm_button_add(win);
223    // set default text of button to "OK"
224    elm_object_text_set(btn, "OK");
225    // pack the button at the end of the box
226    elm_box_pack_end(box, btn);
227    evas_object_show(btn);
228    // call on_done when button is clicked
229    evas_object_smart_callback_add(btn, "clicked", on_done, NULL);
230
231    // now we are done, show the window
232    evas_object_show(win);
233
234    // run the mainloop and process events and callbacks
235    elm_run();
236    return 0;
237 }
238 ELM_MAIN()
239 @endcode
240    *
241    */
242
243 /**
244 @page authors Authors
245 @author Carsten Haitzler <raster@@rasterman.com>
246 @author Gustavo Sverzut Barbieri <barbieri@@profusion.mobi>
247 @author Cedric Bail <cedric.bail@@free.fr>
248 @author Vincent Torri <vtorri@@univ-evry.fr>
249 @author Daniel Kolesa <quaker66@@gmail.com>
250 @author Jaime Thomas <avi.thomas@@gmail.com>
251 @author Swisscom - http://www.swisscom.ch/
252 @author Christopher Michael <devilhorns@@comcast.net>
253 @author Marco Trevisan (Treviño) <mail@@3v1n0.net>
254 @author Michael Bouchaud <michael.bouchaud@@gmail.com>
255 @author Jonathan Atton (Watchwolf) <jonathan.atton@@gmail.com>
256 @author Brian Wang <brian.wang.0721@@gmail.com>
257 @author Mike Blumenkrantz (discomfitor/zmike) <michael.blumenkrantz@@gmail.com>
258 @author Samsung Electronics <tbd>
259 @author Samsung SAIT <tbd>
260 @author Brett Nash <nash@@nash.id.au>
261 @author Bruno Dilly <bdilly@@profusion.mobi>
262 @author Rafael Fonseca <rfonseca@@profusion.mobi>
263 @author Chuneon Park <hermet@@hermet.pe.kr>
264 @author Woohyun Jung <wh0705.jung@@samsung.com>
265 @author Jaehwan Kim <jae.hwan.kim@@samsung.com>
266 @author Wonguk Jeong <wonguk.jeong@@samsung.com>
267 @author Leandro A. F. Pereira <leandro@@profusion.mobi>
268 @author Helen Fornazier <helen.fornazier@@profusion.mobi>
269 @author Gustavo Lima Chaves <glima@@profusion.mobi>
270 @author Fabiano Fidêncio <fidencio@@profusion.mobi>
271 @author Tiago Falcão <tiago@@profusion.mobi>
272 @author Otavio Pontes <otavio@@profusion.mobi>
273 @author Viktor Kojouharov <vkojouharov@@gmail.com>
274 @author Daniel Juyung Seo (SeoZ) <juyung.seo@@samsung.com> <seojuyung2@@gmail.com>
275 @author Sangho Park <sangho.g.park@@samsung.com> <gouache95@@gmail.com>
276 @author Rajeev Ranjan (Rajeev) <rajeev.r@@samsung.com> <rajeev.jnnce@@gmail.com>
277 @author Seunggyun Kim <sgyun.kim@@samsung.com> <tmdrbs@@gmail.com>
278 @author Sohyun Kim <anna1014.kim@@samsung.com> <sohyun.anna@@gmail.com>
279 @author Jihoon Kim <jihoon48.kim@@samsung.com>
280 @author Jeonghyun Yun (arosis) <jh0506.yun@@samsung.com>
281 @author Tom Hacohen <tom@@stosb.com>
282 @author Aharon Hillel <a.hillel@@partner.samsung.com>
283 @author Jonathan Atton (Watchwolf) <jonathan.atton@@gmail.com>
284 @author Shinwoo Kim <kimcinoo@@gmail.com>
285 @author Govindaraju SM <govi.sm@@samsung.com> <govism@@gmail.com>
286 @author Prince Kumar Dubey <prince.dubey@@samsung.com> <prince.dubey@@gmail.com>
287 @author Sung W. Park <sungwoo@@gmail.com>
288 @author Thierry el Borgi <thierry@@substantiel.fr>
289 @author Shilpa Singh <shilpa.singh@@samsung.com> <shilpasingh.o@@gmail.com>
290 @author Chanwook Jung <joey.jung@@samsung.com>
291 @author Hyoyoung Chang <hyoyoung.chang@@samsung.com>
292 @author Guillaume "Kuri" Friloux <guillaume.friloux@@asp64.com>
293 @author Kim Yunhan <spbear@@gmail.com>
294 @author Bluezery <ohpowel@@gmail.com>
295 @author Nicolas Aguirre <aguirre.nicolas@@gmail.com>
296 @author Sanjeev BA <iamsanjeev@@gmail.com>
297
298 Please contact <enlightenment-devel@lists.sourceforge.net> to get in
299 contact with the developers and maintainers.
300  */
301
302 #ifndef ELEMENTARY_H
303 #define ELEMENTARY_H
304
305 /**
306  * @file Elementary.h
307  * @brief Elementary's API
308  *
309  * Elementary API.
310  */
311
312 @ELM_UNIX_DEF@ ELM_UNIX
313 @ELM_WIN32_DEF@ ELM_WIN32
314 @ELM_WINCE_DEF@ ELM_WINCE
315 @ELM_EDBUS_DEF@ ELM_EDBUS
316 @ELM_EFREET_DEF@ ELM_EFREET
317 @ELM_ETHUMB_DEF@ ELM_ETHUMB
318 @ELM_WEB_DEF@ ELM_WEB
319 @ELM_EMAP_DEF@ ELM_EMAP
320 @ELM_DEBUG_DEF@ ELM_DEBUG
321 @ELM_ALLOCA_H_DEF@ ELM_ALLOCA_H
322 @ELM_LIBINTL_H_DEF@ ELM_LIBINTL_H
323
324 /* Standard headers for standard system calls etc. */
325 #include <stdio.h>
326 #include <stdlib.h>
327 #include <unistd.h>
328 #include <string.h>
329 #include <sys/types.h>
330 #include <sys/stat.h>
331 #include <sys/time.h>
332 #include <sys/param.h>
333 #include <dlfcn.h>
334 #include <math.h>
335 #include <fnmatch.h>
336 #include <limits.h>
337 #include <ctype.h>
338 #include <time.h>
339 #include <dirent.h>
340 #include <pwd.h>
341 #include <errno.h>
342
343 #ifdef ELM_UNIX
344 # include <locale.h>
345 # ifdef ELM_LIBINTL_H
346 #  include <libintl.h>
347 # endif
348 # include <signal.h>
349 # include <grp.h>
350 # include <glob.h>
351 #endif
352
353 #ifdef ELM_ALLOCA_H
354 # include <alloca.h>
355 #endif
356
357 #if defined (ELM_WIN32) || defined (ELM_WINCE)
358 # include <malloc.h>
359 # ifndef alloca
360 #  define alloca _alloca
361 # endif
362 #endif
363
364
365 /* EFL headers */
366 #include <Eina.h>
367 #include <Eet.h>
368 #include <Evas.h>
369 #include <Evas_GL.h>
370 #include <Ecore.h>
371 #include <Ecore_Evas.h>
372 #include <Ecore_File.h>
373 #include <Ecore_IMF.h>
374 @ELEMENTARY_ECORE_CON_INC@
375 #include <Edje.h>
376
377 #ifdef ELM_EDBUS
378 # include <E_DBus.h>
379 #endif
380
381 #ifdef ELM_EFREET
382 # include <Efreet.h>
383 # include <Efreet_Mime.h>
384 # include <Efreet_Trash.h>
385 #endif
386
387 #ifdef ELM_ETHUMB
388 # include <Ethumb_Client.h>
389 #endif
390
391 #ifdef ELM_EMAP
392 # include <EMap.h>
393 #endif
394
395 #ifdef EAPI
396 # undef EAPI
397 #endif
398
399 #ifdef _WIN32
400 # ifdef ELEMENTARY_BUILD
401 #  ifdef DLL_EXPORT
402 #   define EAPI __declspec(dllexport)
403 #  else
404 #   define EAPI
405 #  endif /* ! DLL_EXPORT */
406 # else
407 #  define EAPI __declspec(dllimport)
408 # endif /* ! EFL_EVAS_BUILD */
409 #else
410 # ifdef __GNUC__
411 #  if __GNUC__ >= 4
412 #   define EAPI __attribute__ ((visibility("default")))
413 #  else
414 #   define EAPI
415 #  endif
416 # else
417 #  define EAPI
418 # endif
419 #endif /* ! _WIN32 */
420
421 #ifdef _WIN32
422 # define EAPI_MAIN
423 #else
424 # define EAPI_MAIN EAPI
425 #endif
426
427 #define WILL_DEPRECATE /* API is deprecated in upstream EFL, will be deprecated in SLP soon */
428
429 /* allow usage from c++ */
430 #ifdef __cplusplus
431 extern "C" {
432 #endif
433
434 #define ELM_VERSION_MAJOR @VMAJ@
435 #define ELM_VERSION_MINOR @VMIN@
436
437    typedef struct _Elm_Version
438      {
439         int major;
440         int minor;
441         int micro;
442         int revision;
443      } Elm_Version;
444
445    EAPI extern Elm_Version *elm_version;
446
447 /* handy macros */
448 #define ELM_RECTS_INTERSECT(x, y, w, h, xx, yy, ww, hh) (((x) < ((xx) + (ww))) && ((y) < ((yy) + (hh))) && (((x) + (w)) > (xx)) && (((y) + (h)) > (yy)))
449 #define ELM_PI 3.14159265358979323846
450
451    /**
452     * @defgroup General General
453     *
454     * @brief General Elementary API. Functions that don't relate to
455     * Elementary objects specifically.
456     *
457     * Here are documented functions which init/shutdown the library,
458     * that apply to generic Elementary objects, that deal with
459     * configuration, et cetera.
460     *
461     * @ref general_functions_example_page "This" example contemplates
462     * some of these functions.
463     */
464
465    /**
466     * @addtogroup General
467     * @{
468     */
469
470   /**
471    * Defines couple of standard Evas_Object layers to be used
472    * with evas_object_layer_set().
473    *
474    * @note whenever extending with new values, try to keep some padding
475    *       to siblings so there is room for further extensions.
476    */
477   typedef enum _Elm_Object_Layer
478     {
479        ELM_OBJECT_LAYER_BACKGROUND = EVAS_LAYER_MIN + 64, /**< where to place backgrounds */
480        ELM_OBJECT_LAYER_DEFAULT = 0, /**< Evas_Object default layer (and thus for Elementary) */
481        ELM_OBJECT_LAYER_FOCUS = EVAS_LAYER_MAX - 128, /**< where focus object visualization is */
482        ELM_OBJECT_LAYER_TOOLTIP = EVAS_LAYER_MAX - 64, /**< where to show tooltips */
483        ELM_OBJECT_LAYER_CURSOR = EVAS_LAYER_MAX - 32, /**< where to show cursors */
484        ELM_OBJECT_LAYER_LAST /**< last layer known by Elementary */
485     } Elm_Object_Layer;
486
487 /**************************************************************************/
488    EAPI extern int ELM_ECORE_EVENT_ETHUMB_CONNECT;
489
490    /**
491     * Emitted when any Elementary's policy value is changed.
492     */
493    EAPI extern int ELM_EVENT_POLICY_CHANGED;
494
495    /**
496     * @typedef Elm_Event_Policy_Changed
497     *
498     * Data on the event when an Elementary policy has changed
499     */
500     typedef struct _Elm_Event_Policy_Changed Elm_Event_Policy_Changed;
501
502    /**
503     * @struct _Elm_Event_Policy_Changed
504     *
505     * Data on the event when an Elementary policy has changed
506     */
507     struct _Elm_Event_Policy_Changed
508      {
509         unsigned int policy; /**< the policy identifier */
510         int          new_value; /**< value the policy had before the change */
511         int          old_value; /**< new value the policy got */
512     };
513
514    /**
515     * Policy identifiers.
516     */
517     typedef enum _Elm_Policy
518     {
519         ELM_POLICY_QUIT, /**< under which circumstances the application
520                           * should quit automatically. @see
521                           * Elm_Policy_Quit.
522                           */
523         ELM_POLICY_LAST
524     } Elm_Policy; /**< Elementary policy identifiers/groups enumeration.  @see elm_policy_set()
525  */
526
527    typedef enum _Elm_Policy_Quit
528      {
529         ELM_POLICY_QUIT_NONE = 0, /**< never quit the application
530                                    * automatically */
531         ELM_POLICY_QUIT_LAST_WINDOW_CLOSED /**< quit when the
532                                             * application's last
533                                             * window is closed */
534      } Elm_Policy_Quit; /**< Possible values for the #ELM_POLICY_QUIT policy */
535
536    typedef enum _Elm_Focus_Direction
537      {
538         ELM_FOCUS_PREVIOUS,
539         ELM_FOCUS_NEXT
540      } Elm_Focus_Direction;
541
542    typedef enum _Elm_Text_Format
543      {
544         ELM_TEXT_FORMAT_PLAIN_UTF8,
545         ELM_TEXT_FORMAT_MARKUP_UTF8
546      } Elm_Text_Format;
547
548    /**
549     * Line wrapping types.
550     */
551    typedef enum _Elm_Wrap_Type
552      {
553         ELM_WRAP_NONE = 0, /**< No wrap - value is zero */
554         ELM_WRAP_CHAR, /**< Char wrap - wrap between characters */
555         ELM_WRAP_WORD, /**< Word wrap - wrap in allowed wrapping points (as defined in the unicode standard) */
556         ELM_WRAP_MIXED, /**< Mixed wrap - Word wrap, and if that fails, char wrap. */
557         ELM_WRAP_LAST
558      } Elm_Wrap_Type;
559
560    typedef enum
561      {
562         ELM_INPUT_PANEL_LAYOUT_NORMAL,          /**< Default layout */
563         ELM_INPUT_PANEL_LAYOUT_NUMBER,          /**< Number layout */
564         ELM_INPUT_PANEL_LAYOUT_EMAIL,           /**< Email layout */
565         ELM_INPUT_PANEL_LAYOUT_URL,             /**< URL layout */
566         ELM_INPUT_PANEL_LAYOUT_PHONENUMBER,     /**< Phone Number layout */
567         ELM_INPUT_PANEL_LAYOUT_IP,              /**< IP layout */
568         ELM_INPUT_PANEL_LAYOUT_MONTH,           /**< Month layout */
569         ELM_INPUT_PANEL_LAYOUT_NUMBERONLY,      /**< Number Only layout */
570         ELM_INPUT_PANEL_LAYOUT_INVALID
571      } Elm_Input_Panel_Layout;
572
573    typedef enum
574      {
575         ELM_AUTOCAPITAL_TYPE_NONE,
576         ELM_AUTOCAPITAL_TYPE_WORD,
577         ELM_AUTOCAPITAL_TYPE_SENTENCE,
578         ELM_AUTOCAPITAL_TYPE_ALLCHARACTER,
579      } Elm_Autocapital_Type;
580
581    /**
582     * @typedef Elm_Object_Item
583     * An Elementary Object item handle.
584     * @ingroup General
585     */
586    typedef struct _Elm_Object_Item Elm_Object_Item;
587
588
589    /**
590     * Called back when a widget's tooltip is activated and needs content.
591     * @param data user-data given to elm_object_tooltip_content_cb_set()
592     * @param obj owner widget.
593     * @param tooltip The tooltip object (affix content to this!)
594     */
595    typedef Evas_Object *(*Elm_Tooltip_Content_Cb) (void *data, Evas_Object *obj, Evas_Object *tooltip);
596
597    /**
598     * Called back when a widget's item tooltip is activated and needs content.
599     * @param data user-data given to elm_object_tooltip_content_cb_set()
600     * @param obj owner widget.
601     * @param tooltip The tooltip object (affix content to this!)
602     * @param item context dependent item. As an example, if tooltip was
603     *        set on Elm_List_Item, then it is of this type.
604     */
605    typedef Evas_Object *(*Elm_Tooltip_Item_Content_Cb) (void *data, Evas_Object *obj, Evas_Object *tooltip, void *item);
606
607    typedef Eina_Bool (*Elm_Event_Cb) (void *data, Evas_Object *obj, Evas_Object *src, Evas_Callback_Type type, void *event_info); /**< Function prototype definition for callbacks on input events happening on Elementary widgets. @a data will receive the user data pointer passed to elm_object_event_callback_add(). @a src will be a pointer to the widget on which the input event took place. @a type will get the type of this event and @a event_info, the struct with details on this event. */
608
609 #ifndef ELM_LIB_QUICKLAUNCH
610 #define ELM_MAIN() int main(int argc, char **argv) {elm_init(argc, argv); return elm_main(argc, argv);} /**< macro to be used after the elm_main() function */
611 #else
612 #define ELM_MAIN() int main(int argc, char **argv) {return elm_quicklaunch_fallback(argc, argv);} /**< macro to be used after the elm_main() function */
613 #endif
614
615 /**************************************************************************/
616    /* General calls */
617
618    /**
619     * Initialize Elementary
620     *
621     * @param[in] argc System's argument count value
622     * @param[in] argv System's pointer to array of argument strings
623     * @return The init counter value.
624     *
625     * This function initializes Elementary and increments a counter of
626     * the number of calls to it. It returns the new counter's value.
627     *
628     * @warning This call is exported only for use by the @c ELM_MAIN()
629     * macro. There is no need to use this if you use this macro (which
630     * is highly advisable). An elm_main() should contain the entry
631     * point code for your application, having the same prototype as
632     * elm_init(), and @b not being static (putting the @c EAPI symbol
633     * in front of its type declaration is advisable). The @c
634     * ELM_MAIN() call should be placed just after it.
635     *
636     * Example:
637     * @dontinclude bg_example_01.c
638     * @skip static void
639     * @until ELM_MAIN
640     *
641     * See the full @ref bg_example_01_c "example".
642     *
643     * @see elm_shutdown().
644     * @ingroup General
645     */
646    EAPI int          elm_init(int argc, char **argv);
647
648    /**
649     * Shut down Elementary
650     *
651     * @return The init counter value.
652     *
653     * This should be called at the end of your application, just
654     * before it ceases to do any more processing. This will clean up
655     * any permanent resources your application may have allocated via
656     * Elementary that would otherwise persist.
657     *
658     * @see elm_init() for an example
659     *
660     * @ingroup General
661     */
662    EAPI int          elm_shutdown(void);
663
664    /**
665     * Run Elementary's main loop
666     *
667     * This call should be issued just after all initialization is
668     * completed. This function will not return until elm_exit() is
669     * called. It will keep looping, running the main
670     * (event/processing) loop for Elementary.
671     *
672     * @see elm_init() for an example
673     *
674     * @ingroup General
675     */
676    EAPI void         elm_run(void);
677
678    /**
679     * Exit Elementary's main loop
680     *
681     * If this call is issued, it will flag the main loop to cease
682     * processing and return back to its parent function (usually your
683     * elm_main() function).
684     *
685     * @see elm_init() for an example. There, just after a request to
686     * close the window comes, the main loop will be left.
687     *
688     * @note By using the appropriate #ELM_POLICY_QUIT on your Elementary
689     * applications, you'll be able to get this function called automatically for you.
690     *
691     * @ingroup General
692     */
693    EAPI void         elm_exit(void);
694
695    /**
696     * Provide information in order to make Elementary determine the @b
697     * run time location of the software in question, so other data files
698     * such as images, sound files, executable utilities, libraries,
699     * modules and locale files can be found.
700     *
701     * @param mainfunc This is your application's main function name,
702     *        whose binary's location is to be found. Providing @c NULL
703     *        will make Elementary not to use it
704     * @param dom This will be used as the application's "domain", in the
705     *        form of a prefix to any environment variables that may
706     *        override prefix detection and the directory name, inside the
707     *        standard share or data directories, where the software's
708     *        data files will be looked for.
709     * @param checkfile This is an (optional) magic file's path to check
710     *        for existence (and it must be located in the data directory,
711     *        under the share directory provided above). Its presence will
712     *        help determine the prefix found was correct. Pass @c NULL if
713     *        the check is not to be done.
714     *
715     * This function allows one to re-locate the application somewhere
716     * else after compilation, if the developer wishes for easier
717     * distribution of pre-compiled binaries.
718     *
719     * The prefix system is designed to locate where the given software is
720     * installed (under a common path prefix) at run time and then report
721     * specific locations of this prefix and common directories inside
722     * this prefix like the binary, library, data and locale directories,
723     * through the @c elm_app_*_get() family of functions.
724     *
725     * Call elm_app_info_set() early on before you change working
726     * directory or anything about @c argv[0], so it gets accurate
727     * information.
728     *
729     * It will then try and trace back which file @p mainfunc comes from,
730     * if provided, to determine the application's prefix directory.
731     *
732     * The @p dom parameter provides a string prefix to prepend before
733     * environment variables, allowing a fallback to @b specific
734     * environment variables to locate the software. You would most
735     * probably provide a lowercase string there, because it will also
736     * serve as directory domain, explained next. For environment
737     * variables purposes, this string is made uppercase. For example if
738     * @c "myapp" is provided as the prefix, then the program would expect
739     * @c "MYAPP_PREFIX" as a master environment variable to specify the
740     * exact install prefix for the software, or more specific environment
741     * variables like @c "MYAPP_BIN_DIR", @c "MYAPP_LIB_DIR", @c
742     * "MYAPP_DATA_DIR" and @c "MYAPP_LOCALE_DIR", which could be set by
743     * the user or scripts before launching. If not provided (@c NULL),
744     * environment variables will not be used to override compiled-in
745     * defaults or auto detections.
746     *
747     * The @p dom string also provides a subdirectory inside the system
748     * shared data directory for data files. For example, if the system
749     * directory is @c /usr/local/share, then this directory name is
750     * appended, creating @c /usr/local/share/myapp, if it @p was @c
751     * "myapp". It is expected that the application installs data files in
752     * this directory.
753     *
754     * The @p checkfile is a file name or path of something inside the
755     * share or data directory to be used to test that the prefix
756     * detection worked. For example, your app will install a wallpaper
757     * image as @c /usr/local/share/myapp/images/wallpaper.jpg and so to
758     * check that this worked, provide @c "images/wallpaper.jpg" as the @p
759     * checkfile string.
760     *
761     * @see elm_app_compile_bin_dir_set()
762     * @see elm_app_compile_lib_dir_set()
763     * @see elm_app_compile_data_dir_set()
764     * @see elm_app_compile_locale_set()
765     * @see elm_app_prefix_dir_get()
766     * @see elm_app_bin_dir_get()
767     * @see elm_app_lib_dir_get()
768     * @see elm_app_data_dir_get()
769     * @see elm_app_locale_dir_get()
770     */
771    EAPI void         elm_app_info_set(void *mainfunc, const char *dom, const char *checkfile);
772
773    /**
774     * Provide information on the @b fallback application's binaries
775     * directory, in scenarios where they get overriden by
776     * elm_app_info_set().
777     *
778     * @param dir The path to the default binaries directory (compile time
779     * one)
780     *
781     * @note Elementary will as well use this path to determine actual
782     * names of binaries' directory paths, maybe changing it to be @c
783     * something/local/bin instead of @c something/bin, only, for
784     * example.
785     *
786     * @warning You should call this function @b before
787     * elm_app_info_set().
788     */
789    EAPI void         elm_app_compile_bin_dir_set(const char *dir);
790
791    /**
792     * Provide information on the @b fallback application's libraries
793     * directory, on scenarios where they get overriden by
794     * elm_app_info_set().
795     *
796     * @param dir The path to the default libraries directory (compile
797     * time one)
798     *
799     * @note Elementary will as well use this path to determine actual
800     * names of libraries' directory paths, maybe changing it to be @c
801     * something/lib32 or @c something/lib64 instead of @c something/lib,
802     * only, for example.
803     *
804     * @warning You should call this function @b before
805     * elm_app_info_set().
806     */
807    EAPI void         elm_app_compile_lib_dir_set(const char *dir);
808
809    /**
810     * Provide information on the @b fallback application's data
811     * directory, on scenarios where they get overriden by
812     * elm_app_info_set().
813     *
814     * @param dir The path to the default data directory (compile time
815     * one)
816     *
817     * @note Elementary will as well use this path to determine actual
818     * names of data directory paths, maybe changing it to be @c
819     * something/local/share instead of @c something/share, only, for
820     * example.
821     *
822     * @warning You should call this function @b before
823     * elm_app_info_set().
824     */
825    EAPI void         elm_app_compile_data_dir_set(const char *dir);
826
827    /**
828     * Provide information on the @b fallback application's locale
829     * directory, on scenarios where they get overriden by
830     * elm_app_info_set().
831     *
832     * @param dir The path to the default locale directory (compile time
833     * one)
834     *
835     * @warning You should call this function @b before
836     * elm_app_info_set().
837     */
838    EAPI void         elm_app_compile_locale_set(const char *dir);
839
840    /**
841     * Retrieve the application's run time prefix directory, as set by
842     * elm_app_info_set() and the way (environment) the application was
843     * run from.
844     *
845     * @return The directory prefix the application is actually using.
846     */
847    EAPI const char  *elm_app_prefix_dir_get(void);
848
849    /**
850     * Retrieve the application's run time binaries prefix directory, as
851     * set by elm_app_info_set() and the way (environment) the application
852     * was run from.
853     *
854     * @return The binaries directory prefix the application is actually
855     * using.
856     */
857    EAPI const char  *elm_app_bin_dir_get(void);
858
859    /**
860     * Retrieve the application's run time libraries prefix directory, as
861     * set by elm_app_info_set() and the way (environment) the application
862     * was run from.
863     *
864     * @return The libraries directory prefix the application is actually
865     * using.
866     */
867    EAPI const char  *elm_app_lib_dir_get(void);
868
869    /**
870     * Retrieve the application's run time data prefix directory, as
871     * set by elm_app_info_set() and the way (environment) the application
872     * was run from.
873     *
874     * @return The data directory prefix the application is actually
875     * using.
876     */
877    EAPI const char  *elm_app_data_dir_get(void);
878
879    /**
880     * Retrieve the application's run time locale prefix directory, as
881     * set by elm_app_info_set() and the way (environment) the application
882     * was run from.
883     *
884     * @return The locale directory prefix the application is actually
885     * using.
886     */
887    EAPI const char  *elm_app_locale_dir_get(void);
888
889    EAPI void         elm_quicklaunch_mode_set(Eina_Bool ql_on);
890    EAPI Eina_Bool    elm_quicklaunch_mode_get(void);
891    EAPI int          elm_quicklaunch_init(int argc, char **argv);
892    EAPI int          elm_quicklaunch_sub_init(int argc, char **argv);
893    EAPI int          elm_quicklaunch_sub_shutdown(void);
894    EAPI int          elm_quicklaunch_shutdown(void);
895    EAPI void         elm_quicklaunch_seed(void);
896    EAPI Eina_Bool    elm_quicklaunch_prepare(int argc, char **argv);
897    EAPI Eina_Bool    elm_quicklaunch_fork(int argc, char **argv, char *cwd, void (postfork_func) (void *data), void *postfork_data);
898    EAPI void         elm_quicklaunch_cleanup(void);
899    EAPI int          elm_quicklaunch_fallback(int argc, char **argv);
900    EAPI char        *elm_quicklaunch_exe_path_get(const char *exe);
901
902    EAPI Eina_Bool    elm_need_efreet(void);
903    EAPI Eina_Bool    elm_need_e_dbus(void);
904
905    /**
906     * This must be called before any other function that deals with
907     * elm_thumb objects or ethumb_client instances.
908     *
909     * @ingroup Thumb
910     */
911    EAPI Eina_Bool    elm_need_ethumb(void);
912
913    /**
914     * This must be called before any other function that deals with
915     * elm_web objects or ewk_view instances.
916     *
917     * @ingroup Web
918     */
919    EAPI Eina_Bool    elm_need_web(void);
920
921    /**
922     * Set a new policy's value (for a given policy group/identifier).
923     *
924     * @param policy policy identifier, as in @ref Elm_Policy.
925     * @param value policy value, which depends on the identifier
926     *
927     * @return @c EINA_TRUE on success or @c EINA_FALSE, on error.
928     *
929     * Elementary policies define applications' behavior,
930     * somehow. These behaviors are divided in policy groups (see
931     * #Elm_Policy enumeration). This call will emit the Ecore event
932     * #ELM_EVENT_POLICY_CHANGED, which can be hooked at with
933     * handlers. An #Elm_Event_Policy_Changed struct will be passed,
934     * then.
935     *
936     * @note Currently, we have only one policy identifier/group
937     * (#ELM_POLICY_QUIT), which has two possible values.
938     *
939     * @ingroup General
940     */
941    EAPI Eina_Bool    elm_policy_set(unsigned int policy, int value);
942
943    /**
944     * Gets the policy value for given policy identifier.
945     *
946     * @param policy policy identifier, as in #Elm_Policy.
947     * @return The currently set policy value, for that
948     * identifier. Will be @c 0 if @p policy passed is invalid.
949     *
950     * @ingroup General
951     */
952    EAPI int          elm_policy_get(unsigned int policy);
953
954    /**
955     * Change the language of the current application
956     *
957     * The @p lang passed must be the full name of the locale to use, for
958     * example "en_US.utf8" or "es_ES@euro".
959     *
960     * Changing language with this function will make Elementary run through
961     * all its widgets, translating strings set with
962     * elm_object_domain_translatable_text_part_set(). This way, an entire
963     * UI can have its language changed without having to restart the program.
964     *
965     * For more complex cases, like having formatted strings that need
966     * translation, widgets will also emit a "language,changed" signal that
967     * the user can listen to to manually translate the text.
968     *
969     * @param lang Language to set, must be the full name of the locale
970     *
971     * @ingroup General
972     */
973    EAPI void         elm_language_set(const char *lang);
974
975    /**
976     * Set a label of an object
977     *
978     * @param obj The Elementary object
979     * @param part The text part name to set (NULL for the default label)
980     * @param label The new text of the label
981     *
982     * @note Elementary objects may have many labels (e.g. Action Slider)
983     * @deprecated Use elm_object_part_text_set() instead.
984     * @ingroup General
985     */
986    EINA_DEPRECATED EAPI void elm_object_text_part_set(Evas_Object *obj, const char *part, const char *label);
987
988    /**
989     * Set a label of an object
990     *
991     * @param obj The Elementary object
992     * @param part The text part name to set (NULL for the default label)
993     * @param label The new text of the label
994     *
995     * @note Elementary objects may have many labels (e.g. Action Slider)
996     *
997     * @ingroup General
998     */
999    EAPI void elm_object_part_text_set(Evas_Object *obj, const char *part, const char *label);
1000
1001 #define elm_object_text_set(obj, label) elm_object_part_text_set((obj), NULL, (label))
1002
1003    /**
1004     * Get a label of an object
1005     *
1006     * @param obj The Elementary object
1007     * @param part The text part name to get (NULL for the default label)
1008     * @return text of the label or NULL for any error
1009     *
1010     * @note Elementary objects may have many labels (e.g. Action Slider)
1011     * @deprecated Use elm_object_part_text_get() instead.
1012     * @ingroup General
1013     */
1014    EINA_DEPRECATED EAPI const char  *elm_object_text_part_get(const Evas_Object *obj, const char *part);
1015
1016    /**
1017     * Get a label of an object
1018     *
1019     * @param obj The Elementary object
1020     * @param part The text part name to get (NULL for the default label)
1021     * @return text of the label or NULL for any error
1022     *
1023     * @note Elementary objects may have many labels (e.g. Action Slider)
1024     *
1025     * @ingroup General
1026     */
1027    EAPI const char  *elm_object_part_text_get(const Evas_Object *obj, const char *part);
1028
1029 #define elm_object_text_get(obj) elm_object_part_text_get((obj), NULL)
1030
1031    /**
1032     * Set the text for an objects' part, marking it as translatable.
1033     *
1034     * The string to set as @p text must be the original one. Do not pass the
1035     * return of @c gettext() here. Elementary will translate the string
1036     * internally and set it on the object using elm_object_part_text_set(),
1037     * also storing the original string so that it can be automatically
1038     * translated when the language is changed with elm_language_set().
1039     *
1040     * The @p domain will be stored along to find the translation in the
1041     * correct catalog. It can be NULL, in which case it will use whatever
1042     * domain was set by the application with @c textdomain(). This is useful
1043     * in case you are building a library on top of Elementary that will have
1044     * its own translatable strings, that should not be mixed with those of
1045     * programs using the library.
1046     *
1047     * @param obj The object containing the text part
1048     * @param part The name of the part to set
1049     * @param domain The translation domain to use
1050     * @param text The original, non-translated text to set
1051     *
1052     * @ingroup General
1053     */
1054    EAPI void         elm_object_domain_translatable_text_part_set(Evas_Object *obj, const char *part, const char *domain, const char *text);
1055
1056 #define elm_object_domain_translatable_text_set(obj, domain, text) elm_object_domain_translatable_text_part_set((obj), NULL, (domain), (text))
1057
1058 #define elm_object_translatable_text_set(obj, text) elm_object_domain_translatable_text_part_set((obj), NULL, NULL, (text))
1059
1060    /**
1061     * Gets the original string set as translatable for an object
1062     *
1063     * When setting translated strings, the function elm_object_part_text_get()
1064     * will return the translation returned by @c gettext(). To get the
1065     * original string use this function.
1066     *
1067     * @param obj The object
1068     * @param part The name of the part that was set
1069     *
1070     * @return The original, untranslated string
1071     *
1072     * @ingroup General
1073     */
1074    EAPI const char  *elm_object_translatable_text_part_get(const Evas_Object *obj, const char *part);
1075
1076 #define elm_object_translatable_text_get(obj) elm_object_translatable_text_part_get((obj), NULL)
1077
1078    /**
1079     * Set a content of an object
1080     *
1081     * @param obj The Elementary object
1082     * @param part The content part name to set (NULL for the default content)
1083     * @param content The new content of the object
1084     *
1085     * @note Elementary objects may have many contents
1086     * @deprecated Use elm_object_part_content_set instead.
1087     * @ingroup General
1088     */
1089    EINA_DEPRECATED EAPI void elm_object_content_part_set(Evas_Object *obj, const char *part, Evas_Object *content);
1090
1091    /**
1092     * Set a content of an object
1093     *
1094     * @param obj The Elementary object
1095     * @param part The content part name to set (NULL for the default content)
1096     * @param content The new content of the object
1097     *
1098     * @note Elementary objects may have many contents
1099     *
1100     * @ingroup General
1101     */
1102    EAPI void elm_object_part_content_set(Evas_Object *obj, const char *part, Evas_Object *content);
1103
1104 #define elm_object_content_set(obj, content) elm_object_part_content_set((obj), NULL, (content))
1105
1106    /**
1107     * Get a content of an object
1108     *
1109     * @param obj The Elementary object
1110     * @param item The content part name to get (NULL for the default content)
1111     * @return content of the object or NULL for any error
1112     *
1113     * @note Elementary objects may have many contents
1114     * @deprecated Use elm_object_part_content_get instead.
1115     * @ingroup General
1116     */
1117    EINA_DEPRECATED EAPI Evas_Object *elm_object_content_part_get(const Evas_Object *obj, const char *part);
1118
1119    /**
1120     * Get a content of an object
1121     *
1122     * @param obj The Elementary object
1123     * @param item The content part name to get (NULL for the default content)
1124     * @return content of the object or NULL for any error
1125     *
1126     * @note Elementary objects may have many contents
1127     *
1128     * @ingroup General
1129     */
1130    EAPI Evas_Object *elm_object_part_content_get(const Evas_Object *obj, const char *part);
1131
1132 #define elm_object_content_get(obj) elm_object_part_content_get((obj), NULL)
1133
1134    /**
1135     * Unset a content of an object
1136     *
1137     * @param obj The Elementary object
1138     * @param item The content part name to unset (NULL for the default content)
1139     *
1140     * @note Elementary objects may have many contents
1141     * @deprecated Use elm_object_part_content_unset instead.
1142     * @ingroup General
1143     */
1144    EINA_DEPRECATED EAPI Evas_Object *elm_object_content_part_unset(Evas_Object *obj, const char *part);
1145
1146    /**
1147     * Unset a content of an object
1148     *
1149     * @param obj The Elementary object
1150     * @param item The content part name to unset (NULL for the default content)
1151     *
1152     * @note Elementary objects may have many contents
1153     *
1154     * @ingroup General
1155     */
1156    EAPI Evas_Object *elm_object_part_content_unset(Evas_Object *obj, const char *part);
1157
1158 #define elm_object_content_unset(obj) elm_object_part_content_unset((obj), NULL)
1159
1160    /**
1161     * Set the text to read out when in accessibility mode
1162     *
1163     * @param obj The object which is to be described
1164     * @param txt The text that describes the widget to people with poor or no vision
1165     *
1166     * @ingroup General
1167     */
1168    EAPI void elm_object_access_info_set(Evas_Object *obj, const char *txt);
1169
1170    /**
1171     * Get the widget object's handle which contains a given item
1172     *
1173     * @param item The Elementary object item
1174     * @return The widget object
1175     *
1176     * @note This returns the widget object itself that an item belongs to.
1177     *
1178     * @ingroup General
1179     */
1180    EAPI Evas_Object *elm_object_item_object_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
1181
1182    /**
1183     * Set a content of an object item
1184     *
1185     * @param it The Elementary object item
1186     * @param part The content part name to set (NULL for the default content)
1187     * @param content The new content of the object item
1188     *
1189     * @note Elementary object items may have many contents
1190     * @deprecated Use elm_object_item_part_content_set instead.
1191     * @ingroup General
1192     */
1193    EINA_DEPRECATED EAPI void elm_object_item_content_part_set(Elm_Object_Item *it, const char *part, Evas_Object *content);
1194
1195    /**
1196     * Set a content of an object item
1197     *
1198     * @param it The Elementary object item
1199     * @param part The content part name to set (NULL for the default content)
1200     * @param content The new content of the object item
1201     *
1202     * @note Elementary object items may have many contents
1203     *
1204     * @ingroup General
1205     */
1206    EAPI void elm_object_item_part_content_set(Elm_Object_Item *it, const char *part, Evas_Object *content);
1207
1208 #define elm_object_item_content_set(it, content) elm_object_item_part_content_set((it), NULL, (content))
1209
1210    /**
1211     * Get a content of an object item
1212     *
1213     * @param it The Elementary object item
1214     * @param part The content part name to unset (NULL for the default content)
1215     * @return content of the object item or NULL for any error
1216     *
1217     * @note Elementary object items may have many contents
1218     * @deprecated Use elm_object_item_part_content_get instead.
1219     * @ingroup General
1220     */
1221    EAPI Evas_Object *elm_object_item_content_part_get(const Elm_Object_Item *it, const char *part);
1222
1223    /**
1224     * Get a content of an object item
1225     *
1226     * @param it The Elementary object item
1227     * @param part The content part name to unset (NULL for the default content)
1228     * @return content of the object item or NULL for any error
1229     *
1230     * @note Elementary object items may have many contents
1231     *
1232     * @ingroup General
1233     */
1234    EAPI Evas_Object *elm_object_item_part_content_get(const Elm_Object_Item *it, const char *part);
1235
1236 #define elm_object_item_content_get(it) elm_object_item_part_content_get((it), NULL)
1237
1238    /**
1239     * Unset a content of an object item
1240     *
1241     * @param it The Elementary object item
1242     * @param part The content part name to unset (NULL for the default content)
1243     *
1244     * @note Elementary object items may have many contents
1245     * @deprecated Use elm_object_item_part_content_unset instead.
1246     * @ingroup General
1247     */
1248    EINA_DEPRECATED EAPI Evas_Object *elm_object_item_content_part_unset(Elm_Object_Item *it, const char *part);
1249
1250    /**
1251     * Unset a content of an object item
1252     *
1253     * @param it The Elementary object item
1254     * @param part The content part name to unset (NULL for the default content)
1255     *
1256     * @note Elementary object items may have many contents
1257     *
1258     * @ingroup General
1259     */
1260    EAPI Evas_Object *elm_object_item_part_content_unset(Elm_Object_Item *it, const char *part);
1261
1262 #define elm_object_item_content_unset(it) elm_object_item_part_content_unset((it), NULL)
1263
1264    /**
1265     * Set a label of an object item
1266     *
1267     * @param it The Elementary object item
1268     * @param part The text part name to set (NULL for the default label)
1269     * @param label The new text of the label
1270     *
1271     * @note Elementary object items may have many labels
1272     * @deprecated Use elm_object_item_part_text_set instead.
1273     * @ingroup General
1274     */
1275    WILL_DEPRECATE  EAPI void elm_object_item_text_part_set(Elm_Object_Item *it, const char *part, const char *label);
1276
1277    /**
1278     * Set a label of an object item
1279     *
1280     * @param it The Elementary object item
1281     * @param part The text part name to set (NULL for the default label)
1282     * @param label The new text of the label
1283     *
1284     * @note Elementary object items may have many labels
1285     *
1286     * @ingroup General
1287     */
1288    EAPI void elm_object_item_part_text_set(Elm_Object_Item *it, const char *part, const char *label);
1289
1290 #define elm_object_item_text_set(it, label) elm_object_item_part_text_set((it), NULL, (label))
1291
1292    /**
1293     * Get a label of an object item
1294     *
1295     * @param it The Elementary object item
1296     * @param part The text part name to get (NULL for the default label)
1297     * @return text of the label or NULL for any error
1298     *
1299     * @note Elementary object items may have many labels
1300     * @deprecated Use elm_object_item_part_text_get instead.
1301     * @ingroup General
1302     */
1303    WILL_DEPRECATE  EAPI const char *elm_object_item_text_part_get(const Elm_Object_Item *it, const char *part);
1304    /**
1305     * Get a label of an object item
1306     *
1307     * @param it The Elementary object item
1308     * @param part The text part name to get (NULL for the default label)
1309     * @return text of the label or NULL for any error
1310     *
1311     * @note Elementary object items may have many labels
1312     *
1313     * @ingroup General
1314     */
1315    EAPI const char *elm_object_item_part_text_get(const Elm_Object_Item *it, const char *part);
1316
1317    /**
1318     * Set the text to read out when in accessibility mode
1319     *
1320     * @param obj The object which is to be described
1321     * @param txt The text that describes the widget to people with poor or no vision
1322     *
1323     * @ingroup General
1324     */
1325    EAPI void elm_object_access_info_set(Evas_Object *obj, const char *txt);
1326
1327    /**
1328     * Set the text to read out when in accessibility mode
1329     *
1330     * @param it The object item which is to be described
1331     * @param txt The text that describes the widget to people with poor or no vision
1332     *
1333     * @ingroup General
1334     */
1335    EAPI void elm_object_item_access_info_set(Elm_Object_Item *it, const char *txt);
1336
1337 #define elm_object_item_text_get(it) elm_object_item_part_text_get((it), NULL)
1338
1339    /**
1340     * Set the text to read out when in accessibility mode
1341     *
1342     * @param it The object item which is to be described
1343     * @param txt The text that describes the widget to people with poor or no vision
1344     *
1345     * @ingroup General
1346     */
1347    EAPI void elm_object_item_access_info_set(Elm_Object_Item *it, const char *txt);
1348
1349    /**
1350     * Get the data associated with an object item
1351     * @param it The Elementary object item
1352     * @return The data associated with @p it
1353     *
1354     * @ingroup General
1355     */
1356    EAPI void *elm_object_item_data_get(const Elm_Object_Item *it);
1357
1358    /**
1359     * Set the data associated with an object item
1360     * @param it The Elementary object item
1361     * @param data The data to be associated with @p it
1362     *
1363     * @ingroup General
1364     */
1365    EAPI void elm_object_item_data_set(Elm_Object_Item *it, void *data);
1366
1367    /**
1368     * Send a signal to the edje object of the widget item.
1369     *
1370     * This function sends a signal to the edje object of the obj item. An
1371     * edje program can respond to a signal by specifying matching
1372     * 'signal' and 'source' fields.
1373     *
1374     * @param it The Elementary object item
1375     * @param emission The signal's name.
1376     * @param source The signal's source.
1377     * @ingroup General
1378     */
1379    EAPI void elm_object_item_signal_emit(Elm_Object_Item *it, const char *emission, const char *source) EINA_ARG_NONNULL(1);
1380
1381    /**
1382     * Set the disabled state of an widget item.
1383     *
1384     * @param obj The Elementary object item
1385     * @param disabled The state to put in in: @c EINA_TRUE for
1386     *        disabled, @c EINA_FALSE for enabled
1387     *
1388     * Elementary object item can be @b disabled, in which state they won't
1389     * receive input and, in general, will be themed differently from
1390     * their normal state, usually greyed out. Useful for contexts
1391     * where you don't want your users to interact with some of the
1392     * parts of you interface.
1393     *
1394     * This sets the state for the widget item, either disabling it or
1395     * enabling it back.
1396     *
1397     * @ingroup Styles
1398     */
1399    EAPI void elm_object_item_disabled_set(Elm_Object_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
1400
1401    /**
1402     * Get the disabled state of an widget item.
1403     *
1404     * @param obj The Elementary object
1405     * @return @c EINA_TRUE, if the widget item is disabled, @c EINA_FALSE
1406     *            if it's enabled (or on errors)
1407     *
1408     * This gets the state of the widget, which might be enabled or disabled.
1409     *
1410     * @ingroup Styles
1411     */
1412    EAPI Eina_Bool    elm_object_item_disabled_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
1413
1414    /**
1415     * @}
1416     */
1417
1418    /**
1419     * @defgroup Caches Caches
1420     *
1421     * These are functions which let one fine-tune some cache values for
1422     * Elementary applications, thus allowing for performance adjustments.
1423     *
1424     * @{
1425     */
1426
1427    /**
1428     * @brief Flush all caches.
1429     *
1430     * Frees all data that was in cache and is not currently being used to reduce
1431     * memory usage. This frees Edje's, Evas' and Eet's cache. This is equivalent
1432     * to calling all of the following functions:
1433     * @li edje_file_cache_flush()
1434     * @li edje_collection_cache_flush()
1435     * @li eet_clearcache()
1436     * @li evas_image_cache_flush()
1437     * @li evas_font_cache_flush()
1438     * @li evas_render_dump()
1439     * @note Evas caches are flushed for every canvas associated with a window.
1440     *
1441     * @ingroup Caches
1442     */
1443    EAPI void         elm_all_flush(void);
1444
1445    /**
1446     * Get the configured cache flush interval time
1447     *
1448     * This gets the globally configured cache flush interval time, in
1449     * ticks
1450     *
1451     * @return The cache flush interval time
1452     * @ingroup Caches
1453     *
1454     * @see elm_all_flush()
1455     */
1456    EAPI int          elm_cache_flush_interval_get(void);
1457
1458    /**
1459     * Set the configured cache flush interval time
1460     *
1461     * This sets the globally configured cache flush interval time, in ticks
1462     *
1463     * @param size The cache flush interval time
1464     * @ingroup Caches
1465     *
1466     * @see elm_all_flush()
1467     */
1468    EAPI void         elm_cache_flush_interval_set(int size);
1469
1470    /**
1471     * Set the configured cache flush interval time for all applications on the
1472     * display
1473     *
1474     * This sets the globally configured cache flush interval time -- in ticks
1475     * -- for all applications on the display.
1476     *
1477     * @param size The cache flush interval time
1478     * @ingroup Caches
1479     */
1480    EAPI void         elm_cache_flush_interval_all_set(int size);
1481
1482    /**
1483     * Get the configured cache flush enabled state
1484     *
1485     * This gets the globally configured cache flush state - if it is enabled
1486     * or not. When cache flushing is enabled, elementary will regularly
1487     * (see elm_cache_flush_interval_get() ) flush caches and dump data out of
1488     * memory and allow usage to re-seed caches and data in memory where it
1489     * can do so. An idle application will thus minimise its memory usage as
1490     * data will be freed from memory and not be re-loaded as it is idle and
1491     * not rendering or doing anything graphically right now.
1492     *
1493     * @return The cache flush state
1494     * @ingroup Caches
1495     *
1496     * @see elm_all_flush()
1497     */
1498    EAPI Eina_Bool    elm_cache_flush_enabled_get(void);
1499
1500    /**
1501     * Set the configured cache flush enabled state
1502     *
1503     * This sets the globally configured cache flush enabled state.
1504     *
1505     * @param size The cache flush enabled state
1506     * @ingroup Caches
1507     *
1508     * @see elm_all_flush()
1509     */
1510    EAPI void         elm_cache_flush_enabled_set(Eina_Bool enabled);
1511
1512    /**
1513     * Set the configured cache flush enabled state for all applications on the
1514     * display
1515     *
1516     * This sets the globally configured cache flush enabled state for all
1517     * applications on the display.
1518     *
1519     * @param size The cache flush enabled state
1520     * @ingroup Caches
1521     */
1522    EAPI void         elm_cache_flush_enabled_all_set(Eina_Bool enabled);
1523
1524    /**
1525     * Get the configured font cache size
1526     *
1527     * This gets the globally configured font cache size, in bytes.
1528     *
1529     * @return The font cache size
1530     * @ingroup Caches
1531     */
1532    EAPI int          elm_font_cache_get(void);
1533
1534    /**
1535     * Set the configured font cache size
1536     *
1537     * This sets the globally configured font cache size, in bytes
1538     *
1539     * @param size The font cache size
1540     * @ingroup Caches
1541     */
1542    EAPI void         elm_font_cache_set(int size);
1543
1544    /**
1545     * Set the configured font cache size for all applications on the
1546     * display
1547     *
1548     * This sets the globally configured font cache size -- in bytes
1549     * -- for all applications on the display.
1550     *
1551     * @param size The font cache size
1552     * @ingroup Caches
1553     */
1554    EAPI void         elm_font_cache_all_set(int size);
1555
1556    /**
1557     * Get the configured image cache size
1558     *
1559     * This gets the globally configured image cache size, in bytes
1560     *
1561     * @return The image cache size
1562     * @ingroup Caches
1563     */
1564    EAPI int          elm_image_cache_get(void);
1565
1566    /**
1567     * Set the configured image cache size
1568     *
1569     * This sets the globally configured image cache size, in bytes
1570     *
1571     * @param size The image cache size
1572     * @ingroup Caches
1573     */
1574    EAPI void         elm_image_cache_set(int size);
1575
1576    /**
1577     * Set the configured image cache size for all applications on the
1578     * display
1579     *
1580     * This sets the globally configured image cache size -- in bytes
1581     * -- for all applications on the display.
1582     *
1583     * @param size The image cache size
1584     * @ingroup Caches
1585     */
1586    EAPI void         elm_image_cache_all_set(int size);
1587
1588    /**
1589     * Get the configured edje file cache size.
1590     *
1591     * This gets the globally configured edje file cache size, in number
1592     * of files.
1593     *
1594     * @return The edje file cache size
1595     * @ingroup Caches
1596     */
1597    EAPI int          elm_edje_file_cache_get(void);
1598
1599    /**
1600     * Set the configured edje file cache size
1601     *
1602     * This sets the globally configured edje file cache size, in number
1603     * of files.
1604     *
1605     * @param size The edje file cache size
1606     * @ingroup Caches
1607     */
1608    EAPI void         elm_edje_file_cache_set(int size);
1609
1610    /**
1611     * Set the configured edje file cache size for all applications on the
1612     * display
1613     *
1614     * This sets the globally configured edje file cache size -- in number
1615     * of files -- for all applications on the display.
1616     *
1617     * @param size The edje file cache size
1618     * @ingroup Caches
1619     */
1620    EAPI void         elm_edje_file_cache_all_set(int size);
1621
1622    /**
1623     * Get the configured edje collections (groups) cache size.
1624     *
1625     * This gets the globally configured edje collections cache size, in
1626     * number of collections.
1627     *
1628     * @return The edje collections cache size
1629     * @ingroup Caches
1630     */
1631    EAPI int          elm_edje_collection_cache_get(void);
1632
1633    /**
1634     * Set the configured edje collections (groups) cache size
1635     *
1636     * This sets the globally configured edje collections cache size, in
1637     * number of collections.
1638     *
1639     * @param size The edje collections cache size
1640     * @ingroup Caches
1641     */
1642    EAPI void         elm_edje_collection_cache_set(int size);
1643
1644    /**
1645     * Set the configured edje collections (groups) cache size for all
1646     * applications on the display
1647     *
1648     * This sets the globally configured edje collections cache size -- in
1649     * number of collections -- for all applications on the display.
1650     *
1651     * @param size The edje collections cache size
1652     * @ingroup Caches
1653     */
1654    EAPI void         elm_edje_collection_cache_all_set(int size);
1655
1656    /**
1657     * @}
1658     */
1659
1660    /**
1661     * @defgroup Scaling Widget Scaling
1662     *
1663     * Different widgets can be scaled independently. These functions
1664     * allow you to manipulate this scaling on a per-widget basis. The
1665     * object and all its children get their scaling factors multiplied
1666     * by the scale factor set. This is multiplicative, in that if a
1667     * child also has a scale size set it is in turn multiplied by its
1668     * parent's scale size. @c 1.0 means “don't scale”, @c 2.0 is
1669     * double size, @c 0.5 is half, etc.
1670     *
1671     * @ref general_functions_example_page "This" example contemplates
1672     * some of these functions.
1673     */
1674
1675    /**
1676     * Get the global scaling factor
1677     *
1678     * This gets the globally configured scaling factor that is applied to all
1679     * objects.
1680     *
1681     * @return The scaling factor
1682     * @ingroup Scaling
1683     */
1684    EAPI double       elm_scale_get(void);
1685
1686    /**
1687     * Set the global scaling factor
1688     *
1689     * This sets the globally configured scaling factor that is applied to all
1690     * objects.
1691     *
1692     * @param scale The scaling factor to set
1693     * @ingroup Scaling
1694     */
1695    EAPI void         elm_scale_set(double scale);
1696
1697    /**
1698     * Set the global scaling factor for all applications on the display
1699     *
1700     * This sets the globally configured scaling factor that is applied to all
1701     * objects for all applications.
1702     * @param scale The scaling factor to set
1703     * @ingroup Scaling
1704     */
1705    EAPI void         elm_scale_all_set(double scale);
1706
1707    /**
1708     * Set the scaling factor for a given Elementary object
1709     *
1710     * @param obj The Elementary to operate on
1711     * @param scale Scale factor (from @c 0.0 up, with @c 1.0 meaning
1712     * no scaling)
1713     *
1714     * @ingroup Scaling
1715     */
1716    EAPI void         elm_object_scale_set(Evas_Object *obj, double scale) EINA_ARG_NONNULL(1);
1717
1718    /**
1719     * Get the scaling factor for a given Elementary object
1720     *
1721     * @param obj The object
1722     * @return The scaling factor set by elm_object_scale_set()
1723     *
1724     * @ingroup Scaling
1725     */
1726    EAPI double       elm_object_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1727
1728    /**
1729     * @defgroup Password_last_show Password last input show
1730     *
1731     * Last show feature of password mode enables user to view
1732     * the last input entered for few seconds before masking it.
1733     * These functions allow to set this feature in password mode
1734     * of entry widget and also allow to manipulate the duration
1735     * for which the input has to be visible.
1736     *
1737     * @{
1738     */
1739
1740    /**
1741     * Get show last setting of password mode.
1742     *
1743     * This gets the show last input setting of password mode which might be
1744     * enabled or disabled.
1745     *
1746     * @return @c EINA_TRUE, if the last input show setting is enabled, @c EINA_FALSE
1747     *            if it's disabled.
1748     * @ingroup Password_last_show
1749     */
1750    EAPI Eina_Bool elm_password_show_last_get(void);
1751
1752    /**
1753     * Set show last setting in password mode.
1754     *
1755     * This enables or disables show last setting of password mode.
1756     *
1757     * @param password_show_last If EINA_TRUE enable's last input show in password mode.
1758     * @see elm_password_show_last_timeout_set()
1759     * @ingroup Password_last_show
1760     */
1761    EAPI void elm_password_show_last_set(Eina_Bool password_show_last);
1762
1763    /**
1764     * Get's the timeout value in last show password mode.
1765     *
1766     * This gets the time out value for which the last input entered in password
1767     * mode will be visible.
1768     *
1769     * @return The timeout value of last show password mode.
1770     * @ingroup Password_last_show
1771     */
1772    EAPI double elm_password_show_last_timeout_get(void);
1773
1774    /**
1775     * Set's the timeout value in last show password mode.
1776     *
1777     * This sets the time out value for which the last input entered in password
1778     * mode will be visible.
1779     *
1780     * @param password_show_last_timeout The timeout value.
1781     * @see elm_password_show_last_set()
1782     * @ingroup Password_last_show
1783     */
1784    EAPI void elm_password_show_last_timeout_set(double password_show_last_timeout);
1785
1786    /**
1787     * @}
1788     */
1789
1790    /**
1791     * @defgroup UI-Mirroring Selective Widget mirroring
1792     *
1793     * These functions allow you to set ui-mirroring on specific
1794     * widgets or the whole interface. Widgets can be in one of two
1795     * modes, automatic and manual.  Automatic means they'll be changed
1796     * according to the system mirroring mode and manual means only
1797     * explicit changes will matter. You are not supposed to change
1798     * mirroring state of a widget set to automatic, will mostly work,
1799     * but the behavior is not really defined.
1800     *
1801     * @{
1802     */
1803
1804    EAPI Eina_Bool    elm_mirrored_get(void);
1805    EAPI void         elm_mirrored_set(Eina_Bool mirrored);
1806
1807    /**
1808     * Get the system mirrored mode. This determines the default mirrored mode
1809     * of widgets.
1810     *
1811     * @return EINA_TRUE if mirrored is set, EINA_FALSE otherwise
1812     */
1813    EAPI Eina_Bool    elm_object_mirrored_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1814
1815    /**
1816     * Set the system mirrored mode. This determines the default mirrored mode
1817     * of widgets.
1818     *
1819     * @param mirrored EINA_TRUE to set mirrored mode, EINA_FALSE to unset it.
1820     */
1821    EAPI void         elm_object_mirrored_set(Evas_Object *obj, Eina_Bool mirrored) EINA_ARG_NONNULL(1);
1822
1823    /**
1824     * Returns the widget's mirrored mode setting.
1825     *
1826     * @param obj The widget.
1827     * @return mirrored mode setting of the object.
1828     *
1829     **/
1830    EAPI Eina_Bool    elm_object_mirrored_automatic_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1831
1832    /**
1833     * Sets the widget's mirrored mode setting.
1834     * When widget in automatic mode, it follows the system mirrored mode set by
1835     * elm_mirrored_set().
1836     * @param obj The widget.
1837     * @param automatic EINA_TRUE for auto mirrored mode. EINA_FALSE for manual.
1838     */
1839    EAPI void         elm_object_mirrored_automatic_set(Evas_Object *obj, Eina_Bool automatic) EINA_ARG_NONNULL(1);
1840
1841    /**
1842     * @}
1843     */
1844
1845    /**
1846     * Set the style to use by a widget
1847     *
1848     * Sets the style name that will define the appearance of a widget. Styles
1849     * vary from widget to widget and may also be defined by other themes
1850     * by means of extensions and overlays.
1851     *
1852     * @param obj The Elementary widget to style
1853     * @param style The style name to use
1854     *
1855     * @see elm_theme_extension_add()
1856     * @see elm_theme_extension_del()
1857     * @see elm_theme_overlay_add()
1858     * @see elm_theme_overlay_del()
1859     *
1860     * @ingroup Styles
1861     */
1862    EAPI void         elm_object_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
1863    /**
1864     * Get the style used by the widget
1865     *
1866     * This gets the style being used for that widget. Note that the string
1867     * pointer is only valid as longas the object is valid and the style doesn't
1868     * change.
1869     *
1870     * @param obj The Elementary widget to query for its style
1871     * @return The style name used
1872     *
1873     * @see elm_object_style_set()
1874     *
1875     * @ingroup Styles
1876     */
1877    EAPI const char  *elm_object_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1878
1879    /**
1880     * @defgroup Styles Styles
1881     *
1882     * Widgets can have different styles of look. These generic API's
1883     * set styles of widgets, if they support them (and if the theme(s)
1884     * do).
1885     *
1886     * @ref general_functions_example_page "This" example contemplates
1887     * some of these functions.
1888     */
1889
1890    /**
1891     * Set the disabled state of an Elementary object.
1892     *
1893     * @param obj The Elementary object to operate on
1894     * @param disabled The state to put in in: @c EINA_TRUE for
1895     *        disabled, @c EINA_FALSE for enabled
1896     *
1897     * Elementary objects can be @b disabled, in which state they won't
1898     * receive input and, in general, will be themed differently from
1899     * their normal state, usually greyed out. Useful for contexts
1900     * where you don't want your users to interact with some of the
1901     * parts of you interface.
1902     *
1903     * This sets the state for the widget, either disabling it or
1904     * enabling it back.
1905     *
1906     * @ingroup Styles
1907     */
1908    EAPI void         elm_object_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
1909
1910    /**
1911     * Get the disabled state of an Elementary object.
1912     *
1913     * @param obj The Elementary object to operate on
1914     * @return @c EINA_TRUE, if the widget is disabled, @c EINA_FALSE
1915     *            if it's enabled (or on errors)
1916     *
1917     * This gets the state of the widget, which might be enabled or disabled.
1918     *
1919     * @ingroup Styles
1920     */
1921    EAPI Eina_Bool    elm_object_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1922
1923    /**
1924     * @defgroup WidgetNavigation Widget Tree Navigation.
1925     *
1926     * How to check if an Evas Object is an Elementary widget? How to
1927     * get the first elementary widget that is parent of the given
1928     * object?  These are all covered in widget tree navigation.
1929     *
1930     * @ref general_functions_example_page "This" example contemplates
1931     * some of these functions.
1932     */
1933
1934    /**
1935     * Check if the given Evas Object is an Elementary widget.
1936     *
1937     * @param obj the object to query.
1938     * @return @c EINA_TRUE if it is an elementary widget variant,
1939     *         @c EINA_FALSE otherwise
1940     * @ingroup WidgetNavigation
1941     */
1942    EAPI Eina_Bool    elm_object_widget_check(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1943
1944    /**
1945     * Get the first parent of the given object that is an Elementary
1946     * widget.
1947     *
1948     * @param obj the Elementary object to query parent from.
1949     * @return the parent object that is an Elementary widget, or @c
1950     *         NULL, if it was not found.
1951     *
1952     * Use this to query for an object's parent widget.
1953     *
1954     * @note Most of Elementary users wouldn't be mixing non-Elementary
1955     * smart objects in the objects tree of an application, as this is
1956     * an advanced usage of Elementary with Evas. So, except for the
1957     * application's window, which is the root of that tree, all other
1958     * objects would have valid Elementary widget parents.
1959     *
1960     * @ingroup WidgetNavigation
1961     */
1962    EAPI Evas_Object *elm_object_parent_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1963
1964    /**
1965     * Get the top level parent of an Elementary widget.
1966     *
1967     * @param obj The object to query.
1968     * @return The top level Elementary widget, or @c NULL if parent cannot be
1969     * found.
1970     * @ingroup WidgetNavigation
1971     */
1972    EAPI Evas_Object *elm_object_top_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1973
1974    /**
1975     * Get the string that represents this Elementary widget.
1976     *
1977     * @note Elementary is weird and exposes itself as a single
1978     *       Evas_Object_Smart_Class of type "elm_widget", so
1979     *       evas_object_type_get() always return that, making debug and
1980     *       language bindings hard. This function tries to mitigate this
1981     *       problem, but the solution is to change Elementary to use
1982     *       proper inheritance.
1983     *
1984     * @param obj the object to query.
1985     * @return Elementary widget name, or @c NULL if not a valid widget.
1986     * @ingroup WidgetNavigation
1987     */
1988    EAPI const char  *elm_object_widget_type_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1989
1990    /**
1991     * @defgroup Config Elementary Config
1992     *
1993     * Elementary configuration is formed by a set options bounded to a
1994     * given @ref Profile profile, like @ref Theme theme, @ref Fingers
1995     * "finger size", etc. These are functions with which one syncronizes
1996     * changes made to those values to the configuration storing files, de
1997     * facto. You most probably don't want to use the functions in this
1998     * group unlees you're writing an elementary configuration manager.
1999     *
2000     * @{
2001     */
2002
2003    /**
2004     * Save back Elementary's configuration, so that it will persist on
2005     * future sessions.
2006     *
2007     * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
2008     * @ingroup Config
2009     *
2010     * This function will take effect -- thus, do I/O -- immediately. Use
2011     * it when you want to apply all configuration changes at once. The
2012     * current configuration set will get saved onto the current profile
2013     * configuration file.
2014     *
2015     */
2016    EAPI Eina_Bool    elm_config_save(void);
2017
2018    /**
2019     * Reload Elementary's configuration, bounded to current selected
2020     * profile.
2021     *
2022     * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
2023     * @ingroup Config
2024     *
2025     * Useful when you want to force reloading of configuration values for
2026     * a profile. If one removes user custom configuration directories,
2027     * for example, it will force a reload with system values instead.
2028     *
2029     */
2030    EAPI void         elm_config_reload(void);
2031
2032    /**
2033     * @}
2034     */
2035
2036    /**
2037     * @defgroup Profile Elementary Profile
2038     *
2039     * Profiles are pre-set options that affect the whole look-and-feel of
2040     * Elementary-based applications. There are, for example, profiles
2041     * aimed at desktop computer applications and others aimed at mobile,
2042     * touchscreen-based ones. You most probably don't want to use the
2043     * functions in this group unlees you're writing an elementary
2044     * configuration manager.
2045     *
2046     * @{
2047     */
2048
2049    /**
2050     * Get Elementary's profile in use.
2051     *
2052     * This gets the global profile that is applied to all Elementary
2053     * applications.
2054     *
2055     * @return The profile's name
2056     * @ingroup Profile
2057     */
2058    EAPI const char  *elm_profile_current_get(void);
2059
2060    /**
2061     * Get an Elementary's profile directory path in the filesystem. One
2062     * may want to fetch a system profile's dir or an user one (fetched
2063     * inside $HOME).
2064     *
2065     * @param profile The profile's name
2066     * @param is_user Whether to lookup for an user profile (@c EINA_TRUE)
2067     *                or a system one (@c EINA_FALSE)
2068     * @return The profile's directory path.
2069     * @ingroup Profile
2070     *
2071     * @note You must free it with elm_profile_dir_free().
2072     */
2073    EAPI const char  *elm_profile_dir_get(const char *profile, Eina_Bool is_user);
2074
2075    /**
2076     * Free an Elementary's profile directory path, as returned by
2077     * elm_profile_dir_get().
2078     *
2079     * @param p_dir The profile's path
2080     * @ingroup Profile
2081     *
2082     */
2083    EAPI void         elm_profile_dir_free(const char *p_dir);
2084
2085    /**
2086     * Get Elementary's list of available profiles.
2087     *
2088     * @return The profiles list. List node data are the profile name
2089     *         strings.
2090     * @ingroup Profile
2091     *
2092     * @note One must free this list, after usage, with the function
2093     *       elm_profile_list_free().
2094     */
2095    EAPI Eina_List   *elm_profile_list_get(void);
2096
2097    /**
2098     * Free Elementary's list of available profiles.
2099     *
2100     * @param l The profiles list, as returned by elm_profile_list_get().
2101     * @ingroup Profile
2102     *
2103     */
2104    EAPI void         elm_profile_list_free(Eina_List *l);
2105
2106    /**
2107     * Set Elementary's profile.
2108     *
2109     * This sets the global profile that is applied to Elementary
2110     * applications. Just the process the call comes from will be
2111     * affected.
2112     *
2113     * @param profile The profile's name
2114     * @ingroup Profile
2115     *
2116     */
2117    EAPI void         elm_profile_set(const char *profile);
2118
2119    /**
2120     * Set Elementary's profile.
2121     *
2122     * This sets the global profile that is applied to all Elementary
2123     * applications. All running Elementary windows will be affected.
2124     *
2125     * @param profile The profile's name
2126     * @ingroup Profile
2127     *
2128     */
2129    EAPI void         elm_profile_all_set(const char *profile);
2130
2131    /**
2132     * @}
2133     */
2134
2135    /**
2136     * @defgroup Engine Elementary Engine
2137     *
2138     * These are functions setting and querying which rendering engine
2139     * Elementary will use for drawing its windows' pixels.
2140     *
2141     * The following are the available engines:
2142     * @li "software_x11"
2143     * @li "fb"
2144     * @li "directfb"
2145     * @li "software_16_x11"
2146     * @li "software_8_x11"
2147     * @li "xrender_x11"
2148     * @li "opengl_x11"
2149     * @li "software_gdi"
2150     * @li "software_16_wince_gdi"
2151     * @li "sdl"
2152     * @li "software_16_sdl"
2153     * @li "opengl_sdl"
2154     * @li "buffer"
2155     * @li "ews"
2156     * @li "opengl_cocoa"
2157     * @li "psl1ght"
2158     *
2159     * @{
2160     */
2161
2162    /**
2163     * @brief Get Elementary's rendering engine in use.
2164     *
2165     * @return The rendering engine's name
2166     * @note there's no need to free the returned string, here.
2167     *
2168     * This gets the global rendering engine that is applied to all Elementary
2169     * applications.
2170     *
2171     * @see elm_engine_set()
2172     */
2173    EAPI const char  *elm_engine_current_get(void);
2174
2175    /**
2176     * @brief Set Elementary's rendering engine for use.
2177     *
2178     * @param engine The rendering engine's name
2179     *
2180     * This sets global rendering engine that is applied to all Elementary
2181     * applications. Note that it will take effect only to Elementary windows
2182     * created after this is called.
2183     *
2184     * @see elm_win_add()
2185     */
2186    EAPI void         elm_engine_set(const char *engine);
2187
2188    /**
2189     * @}
2190     */
2191
2192    /**
2193     * @defgroup Fonts Elementary Fonts
2194     *
2195     * These are functions dealing with font rendering, selection and the
2196     * like for Elementary applications. One might fetch which system
2197     * fonts are there to use and set custom fonts for individual classes
2198     * of UI items containing text (text classes).
2199     *
2200     * @{
2201     */
2202
2203   typedef struct _Elm_Text_Class
2204     {
2205        const char *name;
2206        const char *desc;
2207     } Elm_Text_Class;
2208
2209   typedef struct _Elm_Font_Overlay
2210     {
2211        const char     *text_class;
2212        const char     *font;
2213        Evas_Font_Size  size;
2214     } Elm_Font_Overlay;
2215
2216   typedef struct _Elm_Font_Properties
2217     {
2218        const char *name;
2219        Eina_List  *styles;
2220     } Elm_Font_Properties;
2221
2222    /**
2223     * Get Elementary's list of supported text classes.
2224     *
2225     * @return The text classes list, with @c Elm_Text_Class blobs as data.
2226     * @ingroup Fonts
2227     *
2228     * Release the list with elm_text_classes_list_free().
2229     */
2230    EAPI const Eina_List     *elm_text_classes_list_get(void);
2231
2232    /**
2233     * Free Elementary's list of supported text classes.
2234     *
2235     * @ingroup Fonts
2236     *
2237     * @see elm_text_classes_list_get().
2238     */
2239    EAPI void                 elm_text_classes_list_free(const Eina_List *list);
2240
2241    /**
2242     * Get Elementary's list of font overlays, set with
2243     * elm_font_overlay_set().
2244     *
2245     * @return The font overlays list, with @c Elm_Font_Overlay blobs as
2246     * data.
2247     *
2248     * @ingroup Fonts
2249     *
2250     * For each text class, one can set a <b>font overlay</b> for it,
2251     * overriding the default font properties for that class coming from
2252     * the theme in use. There is no need to free this list.
2253     *
2254     * @see elm_font_overlay_set() and elm_font_overlay_unset().
2255     */
2256    EAPI const Eina_List     *elm_font_overlay_list_get(void);
2257
2258    /**
2259     * Set a font overlay for a given Elementary text class.
2260     *
2261     * @param text_class Text class name
2262     * @param font Font name and style string
2263     * @param size Font size
2264     *
2265     * @ingroup Fonts
2266     *
2267     * @p font has to be in the format returned by
2268     * elm_font_fontconfig_name_get(). @see elm_font_overlay_list_get()
2269     * and elm_font_overlay_unset().
2270     */
2271    EAPI void                 elm_font_overlay_set(const char *text_class, const char *font, Evas_Font_Size size);
2272
2273    /**
2274     * Unset a font overlay for a given Elementary text class.
2275     *
2276     * @param text_class Text class name
2277     *
2278     * @ingroup Fonts
2279     *
2280     * This will bring back text elements belonging to text class
2281     * @p text_class back to their default font settings.
2282     */
2283    EAPI void                 elm_font_overlay_unset(const char *text_class);
2284
2285    /**
2286     * Apply the changes made with elm_font_overlay_set() and
2287     * elm_font_overlay_unset() on the current Elementary window.
2288     *
2289     * @ingroup Fonts
2290     *
2291     * This applies all font overlays set to all objects in the UI.
2292     */
2293    EAPI void                 elm_font_overlay_apply(void);
2294
2295    /**
2296     * Apply the changes made with elm_font_overlay_set() and
2297     * elm_font_overlay_unset() on all Elementary application windows.
2298     *
2299     * @ingroup Fonts
2300     *
2301     * This applies all font overlays set to all objects in the UI.
2302     */
2303    EAPI void                 elm_font_overlay_all_apply(void);
2304
2305    /**
2306     * Translate a font (family) name string in fontconfig's font names
2307     * syntax into an @c Elm_Font_Properties struct.
2308     *
2309     * @param font The font name and styles string
2310     * @return the font properties struct
2311     *
2312     * @ingroup Fonts
2313     *
2314     * @note The reverse translation can be achived with
2315     * elm_font_fontconfig_name_get(), for one style only (single font
2316     * instance, not family).
2317     */
2318    EAPI Elm_Font_Properties *elm_font_properties_get(const char *font) EINA_ARG_NONNULL(1);
2319
2320    /**
2321     * Free font properties return by elm_font_properties_get().
2322     *
2323     * @param efp the font properties struct
2324     *
2325     * @ingroup Fonts
2326     */
2327    EAPI void                 elm_font_properties_free(Elm_Font_Properties *efp) EINA_ARG_NONNULL(1);
2328
2329    /**
2330     * Translate a font name, bound to a style, into fontconfig's font names
2331     * syntax.
2332     *
2333     * @param name The font (family) name
2334     * @param style The given style (may be @c NULL)
2335     *
2336     * @return the font name and style string
2337     *
2338     * @ingroup Fonts
2339     *
2340     * @note The reverse translation can be achived with
2341     * elm_font_properties_get(), for one style only (single font
2342     * instance, not family).
2343     */
2344    EAPI const char          *elm_font_fontconfig_name_get(const char *name, const char *style) EINA_ARG_NONNULL(1);
2345
2346    /**
2347     * Free the font string return by elm_font_fontconfig_name_get().
2348     *
2349     * @param efp the font properties struct
2350     *
2351     * @ingroup Fonts
2352     */
2353    EAPI void                 elm_font_fontconfig_name_free(const char *name) EINA_ARG_NONNULL(1);
2354
2355    /**
2356     * Create a font hash table of available system fonts.
2357     *
2358     * One must call it with @p list being the return value of
2359     * evas_font_available_list(). The hash will be indexed by font
2360     * (family) names, being its values @c Elm_Font_Properties blobs.
2361     *
2362     * @param list The list of available system fonts, as returned by
2363     * evas_font_available_list().
2364     * @return the font hash.
2365     *
2366     * @ingroup Fonts
2367     *
2368     * @note The user is supposed to get it populated at least with 3
2369     * default font families (Sans, Serif, Monospace), which should be
2370     * present on most systems.
2371     */
2372    EAPI Eina_Hash           *elm_font_available_hash_add(Eina_List *list);
2373
2374    /**
2375     * Free the hash return by elm_font_available_hash_add().
2376     *
2377     * @param hash the hash to be freed.
2378     *
2379     * @ingroup Fonts
2380     */
2381    EAPI void                 elm_font_available_hash_del(Eina_Hash *hash);
2382
2383    /**
2384     * @}
2385     */
2386
2387    /**
2388     * @defgroup Fingers Fingers
2389     *
2390     * Elementary is designed to be finger-friendly for touchscreens,
2391     * and so in addition to scaling for display resolution, it can
2392     * also scale based on finger "resolution" (or size). You can then
2393     * customize the granularity of the areas meant to receive clicks
2394     * on touchscreens.
2395     *
2396     * Different profiles may have pre-set values for finger sizes.
2397     *
2398     * @ref general_functions_example_page "This" example contemplates
2399     * some of these functions.
2400     *
2401     * @{
2402     */
2403
2404    /**
2405     * Get the configured "finger size"
2406     *
2407     * @return The finger size
2408     *
2409     * This gets the globally configured finger size, <b>in pixels</b>
2410     *
2411     * @ingroup Fingers
2412     */
2413    EAPI Evas_Coord       elm_finger_size_get(void);
2414
2415    /**
2416     * Set the configured finger size
2417     *
2418     * This sets the globally configured finger size in pixels
2419     *
2420     * @param size The finger size
2421     * @ingroup Fingers
2422     */
2423    EAPI void             elm_finger_size_set(Evas_Coord size);
2424
2425    /**
2426     * Set the configured finger size for all applications on the display
2427     *
2428     * This sets the globally configured finger size in pixels for all
2429     * applications on the display
2430     *
2431     * @param size The finger size
2432     * @ingroup Fingers
2433     */
2434    EAPI void             elm_finger_size_all_set(Evas_Coord size);
2435
2436    /**
2437     * @}
2438     */
2439
2440    /**
2441     * @defgroup Focus Focus
2442     *
2443     * An Elementary application has, at all times, one (and only one)
2444     * @b focused object. This is what determines where the input
2445     * events go to within the application's window. Also, focused
2446     * objects can be decorated differently, in order to signal to the
2447     * user where the input is, at a given moment.
2448     *
2449     * Elementary applications also have the concept of <b>focus
2450     * chain</b>: one can cycle through all the windows' focusable
2451     * objects by input (tab key) or programmatically. The default
2452     * focus chain for an application is the one define by the order in
2453     * which the widgets where added in code. One will cycle through
2454     * top level widgets, and, for each one containg sub-objects, cycle
2455     * through them all, before returning to the level
2456     * above. Elementary also allows one to set @b custom focus chains
2457     * for their applications.
2458     *
2459     * Besides the focused decoration a widget may exhibit, when it
2460     * gets focus, Elementary has a @b global focus highlight object
2461     * that can be enabled for a window. If one chooses to do so, this
2462     * extra highlight effect will surround the current focused object,
2463     * too.
2464     *
2465     * @note Some Elementary widgets are @b unfocusable, after
2466     * creation, by their very nature: they are not meant to be
2467     * interacted with input events, but are there just for visual
2468     * purposes.
2469     *
2470     * @ref general_functions_example_page "This" example contemplates
2471     * some of these functions.
2472     */
2473
2474    /**
2475     * Get the enable status of the focus highlight
2476     *
2477     * This gets whether the highlight on focused objects is enabled or not
2478     * @ingroup Focus
2479     */
2480    EAPI Eina_Bool        elm_focus_highlight_enabled_get(void);
2481
2482    /**
2483     * Set the enable status of the focus highlight
2484     *
2485     * Set whether to show or not the highlight on focused objects
2486     * @param enable Enable highlight if EINA_TRUE, disable otherwise
2487     * @ingroup Focus
2488     */
2489    EAPI void             elm_focus_highlight_enabled_set(Eina_Bool enable);
2490
2491    /**
2492     * Get the enable status of the highlight animation
2493     *
2494     * Get whether the focus highlight, if enabled, will animate its switch from
2495     * one object to the next
2496     * @ingroup Focus
2497     */
2498    EAPI Eina_Bool        elm_focus_highlight_animate_get(void);
2499
2500    /**
2501     * Set the enable status of the highlight animation
2502     *
2503     * Set whether the focus highlight, if enabled, will animate its switch from
2504     * one object to the next
2505     * @param animate Enable animation if EINA_TRUE, disable otherwise
2506     * @ingroup Focus
2507     */
2508    EAPI void             elm_focus_highlight_animate_set(Eina_Bool animate);
2509
2510    /**
2511     * Get the whether an Elementary object has the focus or not.
2512     *
2513     * @param obj The Elementary object to get the information from
2514     * @return @c EINA_TRUE, if the object is focused, @c EINA_FALSE if
2515     *            not (and on errors).
2516     *
2517     * @see elm_object_focus_set()
2518     *
2519     * @ingroup Focus
2520     */
2521    EAPI Eina_Bool        elm_object_focus_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2522
2523    /**
2524     * Set/unset focus to a given Elementary object.
2525     *
2526     * @param obj The Elementary object to operate on.
2527     * @param enable @c EINA_TRUE Set focus to a given object,
2528     *               @c EINA_FALSE Unset focus to a given object.
2529     *
2530     * @note When you set focus to this object, if it can handle focus, will
2531     * take the focus away from the one who had it previously and will, for
2532     * now on, be the one receiving input events. Unsetting focus will remove
2533     * the focus from @p obj, passing it back to the previous element in the
2534     * focus chain list.
2535     *
2536     * @see elm_object_focus_get(), elm_object_focus_custom_chain_get()
2537     *
2538     * @ingroup Focus
2539     */
2540    EAPI void             elm_object_focus_set(Evas_Object *obj, Eina_Bool focus) EINA_ARG_NONNULL(1);
2541
2542    /**
2543     * Make a given Elementary object the focused one.
2544     *
2545     * @param obj The Elementary object to make focused.
2546     *
2547     * @note This object, if it can handle focus, will take the focus
2548     * away from the one who had it previously and will, for now on, be
2549     * the one receiving input events.
2550     *
2551     * @see elm_object_focus_get()
2552     * @deprecated use elm_object_focus_set() instead.
2553     *
2554     * @ingroup Focus
2555     */
2556    WILL_DEPRECATE  EAPI void             elm_object_focus(Evas_Object *obj) EINA_ARG_NONNULL(1);
2557
2558    /**
2559     * Remove the focus from an Elementary object
2560     *
2561     * @param obj The Elementary to take focus from
2562     *
2563     * This removes the focus from @p obj, passing it back to the
2564     * previous element in the focus chain list.
2565     *
2566     * @see elm_object_focus() and elm_object_focus_custom_chain_get()
2567     * @deprecated use elm_object_focus_set() instead.
2568     *
2569     * @ingroup Focus
2570     */
2571    WILL_DEPRECATE  EAPI void             elm_object_unfocus(Evas_Object *obj) EINA_ARG_NONNULL(1);
2572
2573    /**
2574     * Set the ability for an Element object to be focused
2575     *
2576     * @param obj The Elementary object to operate on
2577     * @param enable @c EINA_TRUE if the object can be focused, @c
2578     *        EINA_FALSE if not (and on errors)
2579     *
2580     * This sets whether the object @p obj is able to take focus or
2581     * not. Unfocusable objects do nothing when programmatically
2582     * focused, being the nearest focusable parent object the one
2583     * really getting focus. Also, when they receive mouse input, they
2584     * will get the event, but not take away the focus from where it
2585     * was previously.
2586     *
2587     * @ingroup Focus
2588     */
2589    EAPI void             elm_object_focus_allow_set(Evas_Object *obj, Eina_Bool enable) EINA_ARG_NONNULL(1);
2590
2591    /**
2592     * Get whether an Elementary object is focusable or not
2593     *
2594     * @param obj The Elementary object to operate on
2595     * @return @c EINA_TRUE if the object is allowed to be focused, @c
2596     *             EINA_FALSE if not (and on errors)
2597     *
2598     * @note Objects which are meant to be interacted with by input
2599     * events are created able to be focused, by default. All the
2600     * others are not.
2601     *
2602     * @ingroup Focus
2603     */
2604    EAPI Eina_Bool        elm_object_focus_allow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2605
2606    /**
2607     * Set custom focus chain.
2608     *
2609     * This function overwrites any previous custom focus chain within
2610     * the list of objects. The previous list will be deleted and this list
2611     * will be managed by elementary. After it is set, don't modify it.
2612     *
2613     * @note On focus cycle, only will be evaluated children of this container.
2614     *
2615     * @param obj The container object
2616     * @param objs Chain of objects to pass focus
2617     * @ingroup Focus
2618     */
2619    EAPI void             elm_object_focus_custom_chain_set(Evas_Object *obj, Eina_List *objs) EINA_ARG_NONNULL(1);
2620
2621    /**
2622     * Unset a custom focus chain on a given Elementary widget
2623     *
2624     * @param obj The container object to remove focus chain from
2625     *
2626     * Any focus chain previously set on @p obj (for its child objects)
2627     * is removed entirely after this call.
2628     *
2629     * @ingroup Focus
2630     */
2631    EAPI void             elm_object_focus_custom_chain_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2632
2633    /**
2634     * Get custom focus chain
2635     *
2636     * @param obj The container object
2637     * @ingroup Focus
2638     */
2639    EAPI const Eina_List *elm_object_focus_custom_chain_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2640
2641    /**
2642     * Append object to custom focus chain.
2643     *
2644     * @note If relative_child equal to NULL or not in custom chain, the object
2645     * will be added in end.
2646     *
2647     * @note On focus cycle, only will be evaluated children of this container.
2648     *
2649     * @param obj The container object
2650     * @param child The child to be added in custom chain
2651     * @param relative_child The relative object to position the child
2652     * @ingroup Focus
2653     */
2654    EAPI void             elm_object_focus_custom_chain_append(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
2655
2656    /**
2657     * Prepend object to custom focus chain.
2658     *
2659     * @note If relative_child equal to NULL or not in custom chain, the object
2660     * will be added in begin.
2661     *
2662     * @note On focus cycle, only will be evaluated children of this container.
2663     *
2664     * @param obj The container object
2665     * @param child The child to be added in custom chain
2666     * @param relative_child The relative object to position the child
2667     * @ingroup Focus
2668     */
2669    EAPI void             elm_object_focus_custom_chain_prepend(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
2670
2671    /**
2672     * Give focus to next object in object tree.
2673     *
2674     * Give focus to next object in focus chain of one object sub-tree.
2675     * If the last object of chain already have focus, the focus will go to the
2676     * first object of chain.
2677     *
2678     * @param obj The object root of sub-tree
2679     * @param dir Direction to cycle the focus
2680     *
2681     * @ingroup Focus
2682     */
2683    EAPI void             elm_object_focus_cycle(Evas_Object *obj, Elm_Focus_Direction dir) EINA_ARG_NONNULL(1);
2684
2685    /**
2686     * Give focus to near object in one direction.
2687     *
2688     * Give focus to near object in direction of one object.
2689     * If none focusable object in given direction, the focus will not change.
2690     *
2691     * @param obj The reference object
2692     * @param x Horizontal component of direction to focus
2693     * @param y Vertical component of direction to focus
2694     *
2695     * @ingroup Focus
2696     */
2697    EAPI void             elm_object_focus_direction_go(Evas_Object *obj, int x, int y) EINA_ARG_NONNULL(1);
2698
2699    /**
2700     * Make the elementary object and its children to be unfocusable
2701     * (or focusable).
2702     *
2703     * @param obj The Elementary object to operate on
2704     * @param tree_unfocusable @c EINA_TRUE for unfocusable,
2705     *        @c EINA_FALSE for focusable.
2706     *
2707     * This sets whether the object @p obj and its children objects
2708     * are able to take focus or not. If the tree is set as unfocusable,
2709     * newest focused object which is not in this tree will get focus.
2710     * This API can be helpful for an object to be deleted.
2711     * When an object will be deleted soon, it and its children may not
2712     * want to get focus (by focus reverting or by other focus controls).
2713     * Then, just use this API before deleting.
2714     *
2715     * @see elm_object_tree_unfocusable_get()
2716     *
2717     * @ingroup Focus
2718     */
2719    EAPI void             elm_object_tree_unfocusable_set(Evas_Object *obj, Eina_Bool tree_unfocusable) EINA_ARG_NONNULL(1);
2720
2721    /**
2722     * Get whether an Elementary object and its children are unfocusable or not.
2723     *
2724     * @param obj The Elementary object to get the information from
2725     * @return @c EINA_TRUE, if the tree is unfocussable,
2726     *         @c EINA_FALSE if not (and on errors).
2727     *
2728     * @see elm_object_tree_unfocusable_set()
2729     *
2730     * @ingroup Focus
2731     */
2732    EAPI Eina_Bool        elm_object_tree_unfocusable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2733
2734    /**
2735     * @defgroup Scrolling Scrolling
2736     *
2737     * These are functions setting how scrollable views in Elementary
2738     * widgets should behave on user interaction.
2739     *
2740     * @{
2741     */
2742
2743    /**
2744     * Get whether scrollers should bounce when they reach their
2745     * viewport's edge during a scroll.
2746     *
2747     * @return the thumb scroll bouncing state
2748     *
2749     * This is the default behavior for touch screens, in general.
2750     * @ingroup Scrolling
2751     */
2752    EAPI Eina_Bool        elm_scroll_bounce_enabled_get(void);
2753
2754    /**
2755     * Set whether scrollers should bounce when they reach their
2756     * viewport's edge during a scroll.
2757     *
2758     * @param enabled the thumb scroll bouncing state
2759     *
2760     * @see elm_thumbscroll_bounce_enabled_get()
2761     * @ingroup Scrolling
2762     */
2763    EAPI void             elm_scroll_bounce_enabled_set(Eina_Bool enabled);
2764
2765    /**
2766     * Set whether scrollers should bounce when they reach their
2767     * viewport's edge during a scroll, for all Elementary application
2768     * windows.
2769     *
2770     * @param enabled the thumb scroll bouncing state
2771     *
2772     * @see elm_thumbscroll_bounce_enabled_get()
2773     * @ingroup Scrolling
2774     */
2775    EAPI void             elm_scroll_bounce_enabled_all_set(Eina_Bool enabled);
2776
2777    /**
2778     * Get the amount of inertia a scroller will impose at bounce
2779     * animations.
2780     *
2781     * @return the thumb scroll bounce friction
2782     *
2783     * @ingroup Scrolling
2784     */
2785    EAPI double           elm_scroll_bounce_friction_get(void);
2786
2787    /**
2788     * Set the amount of inertia a scroller will impose at bounce
2789     * animations.
2790     *
2791     * @param friction the thumb scroll bounce friction
2792     *
2793     * @see elm_thumbscroll_bounce_friction_get()
2794     * @ingroup Scrolling
2795     */
2796    EAPI void             elm_scroll_bounce_friction_set(double friction);
2797
2798    /**
2799     * Set the amount of inertia a scroller will impose at bounce
2800     * animations, for all Elementary application windows.
2801     *
2802     * @param friction the thumb scroll bounce friction
2803     *
2804     * @see elm_thumbscroll_bounce_friction_get()
2805     * @ingroup Scrolling
2806     */
2807    EAPI void             elm_scroll_bounce_friction_all_set(double friction);
2808
2809    /**
2810     * Get the amount of inertia a <b>paged</b> scroller will impose at
2811     * page fitting animations.
2812     *
2813     * @return the page scroll friction
2814     *
2815     * @ingroup Scrolling
2816     */
2817    EAPI double           elm_scroll_page_scroll_friction_get(void);
2818
2819    /**
2820     * Set the amount of inertia a <b>paged</b> scroller will impose at
2821     * page fitting animations.
2822     *
2823     * @param friction the page scroll friction
2824     *
2825     * @see elm_thumbscroll_page_scroll_friction_get()
2826     * @ingroup Scrolling
2827     */
2828    EAPI void             elm_scroll_page_scroll_friction_set(double friction);
2829
2830    /**
2831     * Set the amount of inertia a <b>paged</b> scroller will impose at
2832     * page fitting animations, for all Elementary application windows.
2833     *
2834     * @param friction the page scroll friction
2835     *
2836     * @see elm_thumbscroll_page_scroll_friction_get()
2837     * @ingroup Scrolling
2838     */
2839    EAPI void             elm_scroll_page_scroll_friction_all_set(double friction);
2840
2841    /**
2842     * Get the amount of inertia a scroller will impose at region bring
2843     * animations.
2844     *
2845     * @return the bring in scroll friction
2846     *
2847     * @ingroup Scrolling
2848     */
2849    EAPI double           elm_scroll_bring_in_scroll_friction_get(void);
2850
2851    /**
2852     * Set the amount of inertia a scroller will impose at region bring
2853     * animations.
2854     *
2855     * @param friction the bring in scroll friction
2856     *
2857     * @see elm_thumbscroll_bring_in_scroll_friction_get()
2858     * @ingroup Scrolling
2859     */
2860    EAPI void             elm_scroll_bring_in_scroll_friction_set(double friction);
2861
2862    /**
2863     * Set the amount of inertia a scroller will impose at region bring
2864     * animations, for all Elementary application windows.
2865     *
2866     * @param friction the bring in scroll friction
2867     *
2868     * @see elm_thumbscroll_bring_in_scroll_friction_get()
2869     * @ingroup Scrolling
2870     */
2871    EAPI void             elm_scroll_bring_in_scroll_friction_all_set(double friction);
2872
2873    /**
2874     * Get the amount of inertia scrollers will impose at animations
2875     * triggered by Elementary widgets' zooming API.
2876     *
2877     * @return the zoom friction
2878     *
2879     * @ingroup Scrolling
2880     */
2881    EAPI double           elm_scroll_zoom_friction_get(void);
2882
2883    /**
2884     * Set the amount of inertia scrollers will impose at animations
2885     * triggered by Elementary widgets' zooming API.
2886     *
2887     * @param friction the zoom friction
2888     *
2889     * @see elm_thumbscroll_zoom_friction_get()
2890     * @ingroup Scrolling
2891     */
2892    EAPI void             elm_scroll_zoom_friction_set(double friction);
2893
2894    /**
2895     * Set the amount of inertia scrollers will impose at animations
2896     * triggered by Elementary widgets' zooming API, for all Elementary
2897     * application windows.
2898     *
2899     * @param friction the zoom friction
2900     *
2901     * @see elm_thumbscroll_zoom_friction_get()
2902     * @ingroup Scrolling
2903     */
2904    EAPI void             elm_scroll_zoom_friction_all_set(double friction);
2905
2906    /**
2907     * Get whether scrollers should be draggable from any point in their
2908     * views.
2909     *
2910     * @return the thumb scroll state
2911     *
2912     * @note This is the default behavior for touch screens, in general.
2913     * @note All other functions namespaced with "thumbscroll" will only
2914     *       have effect if this mode is enabled.
2915     *
2916     * @ingroup Scrolling
2917     */
2918    EAPI Eina_Bool        elm_scroll_thumbscroll_enabled_get(void);
2919
2920    /**
2921     * Set whether scrollers should be draggable from any point in their
2922     * views.
2923     *
2924     * @param enabled the thumb scroll state
2925     *
2926     * @see elm_thumbscroll_enabled_get()
2927     * @ingroup Scrolling
2928     */
2929    EAPI void             elm_scroll_thumbscroll_enabled_set(Eina_Bool enabled);
2930
2931    /**
2932     * Set whether scrollers should be draggable from any point in their
2933     * views, for all Elementary application windows.
2934     *
2935     * @param enabled the thumb scroll state
2936     *
2937     * @see elm_thumbscroll_enabled_get()
2938     * @ingroup Scrolling
2939     */
2940    EAPI void             elm_scroll_thumbscroll_enabled_all_set(Eina_Bool enabled);
2941
2942    /**
2943     * Get the number of pixels one should travel while dragging a
2944     * scroller's view to actually trigger scrolling.
2945     *
2946     * @return the thumb scroll threshould
2947     *
2948     * One would use higher values for touch screens, in general, because
2949     * of their inherent imprecision.
2950     * @ingroup Scrolling
2951     */
2952    EAPI unsigned int     elm_scroll_thumbscroll_threshold_get(void);
2953
2954    /**
2955     * Set the number of pixels one should travel while dragging a
2956     * scroller's view to actually trigger scrolling.
2957     *
2958     * @param threshold the thumb scroll threshould
2959     *
2960     * @see elm_thumbscroll_threshould_get()
2961     * @ingroup Scrolling
2962     */
2963    EAPI void             elm_scroll_thumbscroll_threshold_set(unsigned int threshold);
2964
2965    /**
2966     * Set the number of pixels one should travel while dragging a
2967     * scroller's view to actually trigger scrolling, for all Elementary
2968     * application windows.
2969     *
2970     * @param threshold the thumb scroll threshould
2971     *
2972     * @see elm_thumbscroll_threshould_get()
2973     * @ingroup Scrolling
2974     */
2975    EAPI void             elm_scroll_thumbscroll_threshold_all_set(unsigned int threshold);
2976
2977    /**
2978     * Get the minimum speed of mouse cursor movement which will trigger
2979     * list self scrolling animation after a mouse up event
2980     * (pixels/second).
2981     *
2982     * @return the thumb scroll momentum threshould
2983     *
2984     * @ingroup Scrolling
2985     */
2986    EAPI double           elm_scroll_thumbscroll_momentum_threshold_get(void);
2987
2988    /**
2989     * Set the minimum speed of mouse cursor movement which will trigger
2990     * list self scrolling animation after a mouse up event
2991     * (pixels/second).
2992     *
2993     * @param threshold the thumb scroll momentum threshould
2994     *
2995     * @see elm_thumbscroll_momentum_threshould_get()
2996     * @ingroup Scrolling
2997     */
2998    EAPI void             elm_scroll_thumbscroll_momentum_threshold_set(double threshold);
2999
3000    /**
3001     * Set the minimum speed of mouse cursor movement which will trigger
3002     * list self scrolling animation after a mouse up event
3003     * (pixels/second), for all Elementary application windows.
3004     *
3005     * @param threshold the thumb scroll momentum threshould
3006     *
3007     * @see elm_thumbscroll_momentum_threshould_get()
3008     * @ingroup Scrolling
3009     */
3010    EAPI void             elm_scroll_thumbscroll_momentum_threshold_all_set(double threshold);
3011
3012    /**
3013     * Get the amount of inertia a scroller will impose at self scrolling
3014     * animations.
3015     *
3016     * @return the thumb scroll friction
3017     *
3018     * @ingroup Scrolling
3019     */
3020    EAPI double           elm_scroll_thumbscroll_friction_get(void);
3021
3022    /**
3023     * Set the amount of inertia a scroller will impose at self scrolling
3024     * animations.
3025     *
3026     * @param friction the thumb scroll friction
3027     *
3028     * @see elm_thumbscroll_friction_get()
3029     * @ingroup Scrolling
3030     */
3031    EAPI void             elm_scroll_thumbscroll_friction_set(double friction);
3032
3033    /**
3034     * Set the amount of inertia a scroller will impose at self scrolling
3035     * animations, for all Elementary application windows.
3036     *
3037     * @param friction the thumb scroll friction
3038     *
3039     * @see elm_thumbscroll_friction_get()
3040     * @ingroup Scrolling
3041     */
3042    EAPI void             elm_scroll_thumbscroll_friction_all_set(double friction);
3043
3044    /**
3045     * Get the amount of lag between your actual mouse cursor dragging
3046     * movement and a scroller's view movement itself, while pushing it
3047     * into bounce state manually.
3048     *
3049     * @return the thumb scroll border friction
3050     *
3051     * @ingroup Scrolling
3052     */
3053    EAPI double           elm_scroll_thumbscroll_border_friction_get(void);
3054
3055    /**
3056     * Set the amount of lag between your actual mouse cursor dragging
3057     * movement and a scroller's view movement itself, while pushing it
3058     * into bounce state manually.
3059     *
3060     * @param friction the thumb scroll border friction. @c 0.0 for
3061     *        perfect synchrony between two movements, @c 1.0 for maximum
3062     *        lag.
3063     *
3064     * @see elm_thumbscroll_border_friction_get()
3065     * @note parameter value will get bound to 0.0 - 1.0 interval, always
3066     *
3067     * @ingroup Scrolling
3068     */
3069    EAPI void             elm_scroll_thumbscroll_border_friction_set(double friction);
3070
3071    /**
3072     * Set the amount of lag between your actual mouse cursor dragging
3073     * movement and a scroller's view movement itself, while pushing it
3074     * into bounce state manually, for all Elementary application windows.
3075     *
3076     * @param friction the thumb scroll border friction. @c 0.0 for
3077     *        perfect synchrony between two movements, @c 1.0 for maximum
3078     *        lag.
3079     *
3080     * @see elm_thumbscroll_border_friction_get()
3081     * @note parameter value will get bound to 0.0 - 1.0 interval, always
3082     *
3083     * @ingroup Scrolling
3084     */
3085    EAPI void             elm_scroll_thumbscroll_border_friction_all_set(double friction);
3086
3087    /**
3088     * Get the sensitivity amount which is be multiplied by the length of
3089     * mouse dragging.
3090     *
3091     * @return the thumb scroll sensitivity friction
3092     *
3093     * @ingroup Scrolling
3094     */
3095    EAPI double           elm_scroll_thumbscroll_sensitivity_friction_get(void);
3096
3097    /**
3098     * Set the sensitivity amount which is be multiplied by the length of
3099     * mouse dragging.
3100     *
3101     * @param friction the thumb scroll sensitivity friction. @c 0.1 for
3102     *        minimun sensitivity, @c 1.0 for maximum sensitivity. 0.25
3103     *        is proper.
3104     *
3105     * @see elm_thumbscroll_sensitivity_friction_get()
3106     * @note parameter value will get bound to 0.1 - 1.0 interval, always
3107     *
3108     * @ingroup Scrolling
3109     */
3110    EAPI void             elm_scroll_thumbscroll_sensitivity_friction_set(double friction);
3111
3112    /**
3113     * Set the sensitivity amount which is be multiplied by the length of
3114     * mouse dragging, for all Elementary application windows.
3115     *
3116     * @param friction the thumb scroll sensitivity friction. @c 0.1 for
3117     *        minimun sensitivity, @c 1.0 for maximum sensitivity. 0.25
3118     *        is proper.
3119     *
3120     * @see elm_thumbscroll_sensitivity_friction_get()
3121     * @note parameter value will get bound to 0.1 - 1.0 interval, always
3122     *
3123     * @ingroup Scrolling
3124     */
3125    EAPI void             elm_scroll_thumbscroll_sensitivity_friction_all_set(double friction);
3126
3127    /**
3128     * @}
3129     */
3130
3131    /**
3132     * @defgroup Scrollhints Scrollhints
3133     *
3134     * Objects when inside a scroller can scroll, but this may not always be
3135     * desirable in certain situations. This allows an object to hint to itself
3136     * and parents to "not scroll" in one of 2 ways. If any child object of a
3137     * scroller has pushed a scroll freeze or hold then it affects all parent
3138     * scrollers until all children have released them.
3139     *
3140     * 1. To hold on scrolling. This means just flicking and dragging may no
3141     * longer scroll, but pressing/dragging near an edge of the scroller will
3142     * still scroll. This is automatically used by the entry object when
3143     * selecting text.
3144     *
3145     * 2. To totally freeze scrolling. This means it stops. until
3146     * popped/released.
3147     *
3148     * @{
3149     */
3150
3151    /**
3152     * Push the scroll hold by 1
3153     *
3154     * This increments the scroll hold count by one. If it is more than 0 it will
3155     * take effect on the parents of the indicated object.
3156     *
3157     * @param obj The object
3158     * @ingroup Scrollhints
3159     */
3160    EAPI void             elm_object_scroll_hold_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
3161
3162    /**
3163     * Pop the scroll hold by 1
3164     *
3165     * This decrements the scroll hold count by one. If it is more than 0 it will
3166     * take effect on the parents of the indicated object.
3167     *
3168     * @param obj The object
3169     * @ingroup Scrollhints
3170     */
3171    EAPI void             elm_object_scroll_hold_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
3172
3173    /**
3174     * Push the scroll freeze by 1
3175     *
3176     * This increments the scroll freeze count by one. If it is more
3177     * than 0 it will take effect on the parents of the indicated
3178     * object.
3179     *
3180     * @param obj The object
3181     * @ingroup Scrollhints
3182     */
3183    EAPI void             elm_object_scroll_freeze_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
3184
3185    /**
3186     * Pop the scroll freeze by 1
3187     *
3188     * This decrements the scroll freeze count by one. If it is more
3189     * than 0 it will take effect on the parents of the indicated
3190     * object.
3191     *
3192     * @param obj The object
3193     * @ingroup Scrollhints
3194     */
3195    EAPI void             elm_object_scroll_freeze_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
3196
3197    /**
3198     * Lock the scrolling of the given widget (and thus all parents)
3199     *
3200     * This locks the given object from scrolling in the X axis (and implicitly
3201     * also locks all parent scrollers too from doing the same).
3202     *
3203     * @param obj The object
3204     * @param lock The lock state (1 == locked, 0 == unlocked)
3205     * @ingroup Scrollhints
3206     */
3207    EAPI void             elm_object_scroll_lock_x_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
3208
3209    /**
3210     * Lock the scrolling of the given widget (and thus all parents)
3211     *
3212     * This locks the given object from scrolling in the Y axis (and implicitly
3213     * also locks all parent scrollers too from doing the same).
3214     *
3215     * @param obj The object
3216     * @param lock The lock state (1 == locked, 0 == unlocked)
3217     * @ingroup Scrollhints
3218     */
3219    EAPI void             elm_object_scroll_lock_y_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
3220
3221    /**
3222     * Get the scrolling lock of the given widget
3223     *
3224     * This gets the lock for X axis scrolling.
3225     *
3226     * @param obj The object
3227     * @ingroup Scrollhints
3228     */
3229    EAPI Eina_Bool        elm_object_scroll_lock_x_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3230
3231    /**
3232     * Get the scrolling lock of the given widget
3233     *
3234     * This gets the lock for X axis scrolling.
3235     *
3236     * @param obj The object
3237     * @ingroup Scrollhints
3238     */
3239    EAPI Eina_Bool        elm_object_scroll_lock_y_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3240
3241    /**
3242     * @}
3243     */
3244
3245    /**
3246     * Send a signal to the widget edje object.
3247     *
3248     * This function sends a signal to the edje object of the obj. An
3249     * edje program can respond to a signal by specifying matching
3250     * 'signal' and 'source' fields.
3251     *
3252     * @param obj The object
3253     * @param emission The signal's name.
3254     * @param source The signal's source.
3255     * @ingroup General
3256     */
3257    EAPI void             elm_object_signal_emit(Evas_Object *obj, const char *emission, const char *source) EINA_ARG_NONNULL(1);
3258
3259    /**
3260     * Add a callback for a signal emitted by widget edje object.
3261     *
3262     * This function connects a callback function to a signal emitted by the
3263     * edje object of the obj.
3264     * Globs can occur in either the emission or source name.
3265     *
3266     * @param obj The object
3267     * @param emission The signal's name.
3268     * @param source The signal's source.
3269     * @param func The callback function to be executed when the signal is
3270     * emitted.
3271     * @param data A pointer to data to pass in to the callback function.
3272     * @ingroup General
3273     */
3274    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);
3275
3276    /**
3277     * Remove a signal-triggered callback from a widget edje object.
3278     *
3279     * This function removes a callback, previoulsy attached to a
3280     * signal emitted by the edje object of the obj.  The parameters
3281     * emission, source and func must match exactly those passed to a
3282     * previous call to elm_object_signal_callback_add(). The data
3283     * pointer that was passed to this call will be returned.
3284     *
3285     * @param obj The object
3286     * @param emission The signal's name.
3287     * @param source The signal's source.
3288     * @param func The callback function to be executed when the signal is
3289     * emitted.
3290     * @return The data pointer
3291     * @ingroup General
3292     */
3293    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);
3294
3295    /**
3296     * Add a callback for input events (key up, key down, mouse wheel)
3297     * on a given Elementary widget
3298     *
3299     * @param obj The widget to add an event callback on
3300     * @param func The callback function to be executed when the event
3301     * happens
3302     * @param data Data to pass in to @p func
3303     *
3304     * Every widget in an Elementary interface set to receive focus,
3305     * with elm_object_focus_allow_set(), will propagate @b all of its
3306     * key up, key down and mouse wheel input events up to its parent
3307     * object, and so on. All of the focusable ones in this chain which
3308     * had an event callback set, with this call, will be able to treat
3309     * those events. There are two ways of making the propagation of
3310     * these event upwards in the tree of widgets to @b cease:
3311     * - Just return @c EINA_TRUE on @p func. @c EINA_FALSE will mean
3312     *   the event was @b not processed, so the propagation will go on.
3313     * - The @c event_info pointer passed to @p func will contain the
3314     *   event's structure and, if you OR its @c event_flags inner
3315     *   value to @c EVAS_EVENT_FLAG_ON_HOLD, you're telling Elementary
3316     *   one has already handled it, thus killing the event's
3317     *   propagation, too.
3318     *
3319     * @note Your event callback will be issued on those events taking
3320     * place only if no other child widget of @obj has consumed the
3321     * event already.
3322     *
3323     * @note Not to be confused with @c
3324     * evas_object_event_callback_add(), which will add event callbacks
3325     * per type on general Evas objects (no event propagation
3326     * infrastructure taken in account).
3327     *
3328     * @note Not to be confused with @c
3329     * elm_object_signal_callback_add(), which will add callbacks to @b
3330     * signals coming from a widget's theme, not input events.
3331     *
3332     * @note Not to be confused with @c
3333     * edje_object_signal_callback_add(), which does the same as
3334     * elm_object_signal_callback_add(), but directly on an Edje
3335     * object.
3336     *
3337     * @note Not to be confused with @c
3338     * evas_object_smart_callback_add(), which adds callbacks to smart
3339     * objects' <b>smart events</b>, and not input events.
3340     *
3341     * @see elm_object_event_callback_del()
3342     *
3343     * @ingroup General
3344     */
3345    EAPI void             elm_object_event_callback_add(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
3346
3347    /**
3348     * Remove an event callback from a widget.
3349     *
3350     * This function removes a callback, previoulsy attached to event emission
3351     * by the @p obj.
3352     * The parameters func and data must match exactly those passed to
3353     * a previous call to elm_object_event_callback_add(). The data pointer that
3354     * was passed to this call will be returned.
3355     *
3356     * @param obj The object
3357     * @param func The callback function to be executed when the event is
3358     * emitted.
3359     * @param data Data to pass in to the callback function.
3360     * @return The data pointer
3361     * @ingroup General
3362     */
3363    EAPI void            *elm_object_event_callback_del(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
3364
3365    /**
3366     * Adjust size of an element for finger usage.
3367     *
3368     * @param times_w How many fingers should fit horizontally
3369     * @param w Pointer to the width size to adjust
3370     * @param times_h How many fingers should fit vertically
3371     * @param h Pointer to the height size to adjust
3372     *
3373     * This takes width and height sizes (in pixels) as input and a
3374     * size multiple (which is how many fingers you want to place
3375     * within the area, being "finger" the size set by
3376     * elm_finger_size_set()), and adjusts the size to be large enough
3377     * to accommodate the resulting size -- if it doesn't already
3378     * accommodate it. On return the @p w and @p h sizes pointed to by
3379     * these parameters will be modified, on those conditions.
3380     *
3381     * @note This is kind of a low level Elementary call, most useful
3382     * on size evaluation times for widgets. An external user wouldn't
3383     * be calling, most of the time.
3384     *
3385     * @ingroup Fingers
3386     */
3387    EAPI void             elm_coords_finger_size_adjust(int times_w, Evas_Coord *w, int times_h, Evas_Coord *h);
3388
3389    /**
3390     * Get the duration for occuring long press event.
3391     *
3392     * @return Timeout for long press event
3393     * @ingroup Longpress
3394     */
3395    EAPI double           elm_longpress_timeout_get(void);
3396
3397    /**
3398     * Set the duration for occuring long press event.
3399     *
3400     * @param lonpress_timeout Timeout for long press event
3401     * @ingroup Longpress
3402     */
3403    EAPI void             elm_longpress_timeout_set(double longpress_timeout);
3404
3405    /**
3406     * @defgroup Debug Debug
3407     * don't use it unless you are sure
3408     *
3409     * @{
3410     */
3411
3412    /**
3413     * Print Tree object hierarchy in stdout
3414     *
3415     * @param obj The root object
3416     * @ingroup Debug
3417     */
3418    EAPI void             elm_object_tree_dump(const Evas_Object *top);
3419    EAPI void             elm_object_tree_dot_dump(const Evas_Object *top, const char *file);
3420
3421    EAPI void             elm_autocapitalization_allow_all_set(Eina_Bool autocap);
3422    EAPI void             elm_autoperiod_allow_all_set(Eina_Bool autoperiod);
3423    /**
3424     * Print Elm Objects tree hierarchy in file as dot(graphviz) syntax.
3425     *
3426     * @param obj The root object
3427     * @param file The path of output file
3428     * @ingroup Debug
3429     */
3430    EAPI void             elm_object_tree_dot_dump(const Evas_Object *top, const char *file);
3431
3432    /**
3433     * @}
3434     */
3435
3436    /**
3437     * @defgroup Theme Theme
3438     *
3439     * Elementary uses Edje to theme its widgets, naturally. But for the most
3440     * part this is hidden behind a simpler interface that lets the user set
3441     * extensions and choose the style of widgets in a much easier way.
3442     *
3443     * Instead of thinking in terms of paths to Edje files and their groups
3444     * each time you want to change the appearance of a widget, Elementary
3445     * works so you can add any theme file with extensions or replace the
3446     * main theme at one point in the application, and then just set the style
3447     * of widgets with elm_object_style_set() and related functions. Elementary
3448     * will then look in its list of themes for a matching group and apply it,
3449     * and when the theme changes midway through the application, all widgets
3450     * will be updated accordingly.
3451     *
3452     * There are three concepts you need to know to understand how Elementary
3453     * theming works: default theme, extensions and overlays.
3454     *
3455     * Default theme, obviously enough, is the one that provides the default
3456     * look of all widgets. End users can change the theme used by Elementary
3457     * by setting the @c ELM_THEME environment variable before running an
3458     * application, or globally for all programs using the @c elementary_config
3459     * utility. Applications can change the default theme using elm_theme_set(),
3460     * but this can go against the user wishes, so it's not an adviced practice.
3461     *
3462     * Ideally, applications should find everything they need in the already
3463     * provided theme, but there may be occasions when that's not enough and
3464     * custom styles are required to correctly express the idea. For this
3465     * cases, Elementary has extensions.
3466     *
3467     * Extensions allow the application developer to write styles of its own
3468     * to apply to some widgets. This requires knowledge of how each widget
3469     * is themed, as extensions will always replace the entire group used by
3470     * the widget, so important signals and parts need to be there for the
3471     * object to behave properly (see documentation of Edje for details).
3472     * Once the theme for the extension is done, the application needs to add
3473     * it to the list of themes Elementary will look into, using
3474     * elm_theme_extension_add(), and set the style of the desired widgets as
3475     * he would normally with elm_object_style_set().
3476     *
3477     * Overlays, on the other hand, can replace the look of all widgets by
3478     * overriding the default style. Like extensions, it's up to the application
3479     * developer to write the theme for the widgets it wants, the difference
3480     * being that when looking for the theme, Elementary will check first the
3481     * list of overlays, then the set theme and lastly the list of extensions,
3482     * so with overlays it's possible to replace the default view and every
3483     * widget will be affected. This is very much alike to setting the whole
3484     * theme for the application and will probably clash with the end user
3485     * options, not to mention the risk of ending up with not matching styles
3486     * across the program. Unless there's a very special reason to use them,
3487     * overlays should be avoided for the resons exposed before.
3488     *
3489     * All these theme lists are handled by ::Elm_Theme instances. Elementary
3490     * keeps one default internally and every function that receives one of
3491     * these can be called with NULL to refer to this default (except for
3492     * elm_theme_free()). It's possible to create a new instance of a
3493     * ::Elm_Theme to set other theme for a specific widget (and all of its
3494     * children), but this is as discouraged, if not even more so, than using
3495     * overlays. Don't use this unless you really know what you are doing.
3496     *
3497     * But to be less negative about things, you can look at the following
3498     * examples:
3499     * @li @ref theme_example_01 "Using extensions"
3500     * @li @ref theme_example_02 "Using overlays"
3501     *
3502     * @{
3503     */
3504    /**
3505     * @typedef Elm_Theme
3506     *
3507     * Opaque handler for the list of themes Elementary looks for when
3508     * rendering widgets.
3509     *
3510     * Stay out of this unless you really know what you are doing. For most
3511     * cases, sticking to the default is all a developer needs.
3512     */
3513    typedef struct _Elm_Theme Elm_Theme;
3514
3515    /**
3516     * Create a new specific theme
3517     *
3518     * This creates an empty specific theme that only uses the default theme. A
3519     * specific theme has its own private set of extensions and overlays too
3520     * (which are empty by default). Specific themes do not fall back to themes
3521     * of parent objects. They are not intended for this use. Use styles, overlays
3522     * and extensions when needed, but avoid specific themes unless there is no
3523     * other way (example: you want to have a preview of a new theme you are
3524     * selecting in a "theme selector" window. The preview is inside a scroller
3525     * and should display what the theme you selected will look like, but not
3526     * actually apply it yet. The child of the scroller will have a specific
3527     * theme set to show this preview before the user decides to apply it to all
3528     * applications).
3529     */
3530    EAPI Elm_Theme       *elm_theme_new(void);
3531    /**
3532     * Free a specific theme
3533     *
3534     * @param th The theme to free
3535     *
3536     * This frees a theme created with elm_theme_new().
3537     */
3538    EAPI void             elm_theme_free(Elm_Theme *th);
3539    /**
3540     * Copy the theme fom the source to the destination theme
3541     *
3542     * @param th The source theme to copy from
3543     * @param thdst The destination theme to copy data to
3544     *
3545     * This makes a one-time static copy of all the theme config, extensions
3546     * and overlays from @p th to @p thdst. If @p th references a theme, then
3547     * @p thdst is also set to reference it, with all the theme settings,
3548     * overlays and extensions that @p th had.
3549     */
3550    EAPI void             elm_theme_copy(Elm_Theme *th, Elm_Theme *thdst);
3551    /**
3552     * Tell the source theme to reference the ref theme
3553     *
3554     * @param th The theme that will do the referencing
3555     * @param thref The theme that is the reference source
3556     *
3557     * This clears @p th to be empty and then sets it to refer to @p thref
3558     * so @p th acts as an override to @p thref, but where its overrides
3559     * don't apply, it will fall through to @p thref for configuration.
3560     */
3561    EAPI void             elm_theme_ref_set(Elm_Theme *th, Elm_Theme *thref);
3562    /**
3563     * Return the theme referred to
3564     *
3565     * @param th The theme to get the reference from
3566     * @return The referenced theme handle
3567     *
3568     * This gets the theme set as the reference theme by elm_theme_ref_set().
3569     * If no theme is set as a reference, NULL is returned.
3570     */
3571    EAPI Elm_Theme       *elm_theme_ref_get(Elm_Theme *th);
3572    /**
3573     * Return the default theme
3574     *
3575     * @return The default theme handle
3576     *
3577     * This returns the internal default theme setup handle that all widgets
3578     * use implicitly unless a specific theme is set. This is also often use
3579     * as a shorthand of NULL.
3580     */
3581    EAPI Elm_Theme       *elm_theme_default_get(void);
3582    /**
3583     * Prepends a theme overlay to the list of overlays
3584     *
3585     * @param th The theme to add to, or if NULL, the default theme
3586     * @param item The Edje file path to be used
3587     *
3588     * Use this if your application needs to provide some custom overlay theme
3589     * (An Edje file that replaces some default styles of widgets) where adding
3590     * new styles, or changing system theme configuration is not possible. Do
3591     * NOT use this instead of a proper system theme configuration. Use proper
3592     * configuration files, profiles, environment variables etc. to set a theme
3593     * so that the theme can be altered by simple confiugration by a user. Using
3594     * this call to achieve that effect is abusing the API and will create lots
3595     * of trouble.
3596     *
3597     * @see elm_theme_extension_add()
3598     */
3599    EAPI void             elm_theme_overlay_add(Elm_Theme *th, const char *item);
3600    /**
3601     * Delete a theme overlay from the list of overlays
3602     *
3603     * @param th The theme to delete from, or if NULL, the default theme
3604     * @param item The name of the theme overlay
3605     *
3606     * @see elm_theme_overlay_add()
3607     */
3608    EAPI void             elm_theme_overlay_del(Elm_Theme *th, const char *item);
3609    /**
3610     * Appends a theme extension to the list of extensions.
3611     *
3612     * @param th The theme to add to, or if NULL, the default theme
3613     * @param item The Edje file path to be used
3614     *
3615     * This is intended when an application needs more styles of widgets or new
3616     * widget themes that the default does not provide (or may not provide). The
3617     * application has "extended" usage by coming up with new custom style names
3618     * for widgets for specific uses, but as these are not "standard", they are
3619     * not guaranteed to be provided by a default theme. This means the
3620     * application is required to provide these extra elements itself in specific
3621     * Edje files. This call adds one of those Edje files to the theme search
3622     * path to be search after the default theme. The use of this call is
3623     * encouraged when default styles do not meet the needs of the application.
3624     * Use this call instead of elm_theme_overlay_add() for almost all cases.
3625     *
3626     * @see elm_object_style_set()
3627     */
3628    EAPI void             elm_theme_extension_add(Elm_Theme *th, const char *item);
3629    /**
3630     * Deletes a theme extension from the list of extensions.
3631     *
3632     * @param th The theme to delete from, or if NULL, the default theme
3633     * @param item The name of the theme extension
3634     *
3635     * @see elm_theme_extension_add()
3636     */
3637    EAPI void             elm_theme_extension_del(Elm_Theme *th, const char *item);
3638    /**
3639     * Set the theme search order for the given theme
3640     *
3641     * @param th The theme to set the search order, or if NULL, the default theme
3642     * @param theme Theme search string
3643     *
3644     * This sets the search string for the theme in path-notation from first
3645     * theme to search, to last, delimited by the : character. Example:
3646     *
3647     * "shiny:/path/to/file.edj:default"
3648     *
3649     * See the ELM_THEME environment variable for more information.
3650     *
3651     * @see elm_theme_get()
3652     * @see elm_theme_list_get()
3653     */
3654    EAPI void             elm_theme_set(Elm_Theme *th, const char *theme);
3655    /**
3656     * Return the theme search order
3657     *
3658     * @param th The theme to get the search order, or if NULL, the default theme
3659     * @return The internal search order path
3660     *
3661     * This function returns a colon separated string of theme elements as
3662     * returned by elm_theme_list_get().
3663     *
3664     * @see elm_theme_set()
3665     * @see elm_theme_list_get()
3666     */
3667    EAPI const char      *elm_theme_get(Elm_Theme *th);
3668    /**
3669     * Return a list of theme elements to be used in a theme.
3670     *
3671     * @param th Theme to get the list of theme elements from.
3672     * @return The internal list of theme elements
3673     *
3674     * This returns the internal list of theme elements (will only be valid as
3675     * long as the theme is not modified by elm_theme_set() or theme is not
3676     * freed by elm_theme_free(). This is a list of strings which must not be
3677     * altered as they are also internal. If @p th is NULL, then the default
3678     * theme element list is returned.
3679     *
3680     * A theme element can consist of a full or relative path to a .edj file,
3681     * or a name, without extension, for a theme to be searched in the known
3682     * theme paths for Elemementary.
3683     *
3684     * @see elm_theme_set()
3685     * @see elm_theme_get()
3686     */
3687    EAPI const Eina_List *elm_theme_list_get(const Elm_Theme *th);
3688    /**
3689     * Return the full patrh for a theme element
3690     *
3691     * @param f The theme element name
3692     * @param in_search_path Pointer to a boolean to indicate if item is in the search path or not
3693     * @return The full path to the file found.
3694     *
3695     * This returns a string you should free with free() on success, NULL on
3696     * failure. This will search for the given theme element, and if it is a
3697     * full or relative path element or a simple searchable name. The returned
3698     * path is the full path to the file, if searched, and the file exists, or it
3699     * is simply the full path given in the element or a resolved path if
3700     * relative to home. The @p in_search_path boolean pointed to is set to
3701     * EINA_TRUE if the file was a searchable file andis in the search path,
3702     * and EINA_FALSE otherwise.
3703     */
3704    EAPI char            *elm_theme_list_item_path_get(const char *f, Eina_Bool *in_search_path);
3705    /**
3706     * Flush the current theme.
3707     *
3708     * @param th Theme to flush
3709     *
3710     * This flushes caches that let elementary know where to find theme elements
3711     * in the given theme. If @p th is NULL, then the default theme is flushed.
3712     * Call this function if source theme data has changed in such a way as to
3713     * make any caches Elementary kept invalid.
3714     */
3715    EAPI void             elm_theme_flush(Elm_Theme *th);
3716    /**
3717     * This flushes all themes (default and specific ones).
3718     *
3719     * This will flush all themes in the current application context, by calling
3720     * elm_theme_flush() on each of them.
3721     */
3722    EAPI void             elm_theme_full_flush(void);
3723    /**
3724     * Set the theme for all elementary using applications on the current display
3725     *
3726     * @param theme The name of the theme to use. Format same as the ELM_THEME
3727     * environment variable.
3728     */
3729    EAPI void             elm_theme_all_set(const char *theme);
3730    /**
3731     * Return a list of theme elements in the theme search path
3732     *
3733     * @return A list of strings that are the theme element names.
3734     *
3735     * This lists all available theme files in the standard Elementary search path
3736     * for theme elements, and returns them in alphabetical order as theme
3737     * element names in a list of strings. Free this with
3738     * elm_theme_name_available_list_free() when you are done with the list.
3739     */
3740    EAPI Eina_List       *elm_theme_name_available_list_new(void);
3741    /**
3742     * Free the list returned by elm_theme_name_available_list_new()
3743     *
3744     * This frees the list of themes returned by
3745     * elm_theme_name_available_list_new(). Once freed the list should no longer
3746     * be used. a new list mys be created.
3747     */
3748    EAPI void             elm_theme_name_available_list_free(Eina_List *list);
3749    /**
3750     * Set a specific theme to be used for this object and its children
3751     *
3752     * @param obj The object to set the theme on
3753     * @param th The theme to set
3754     *
3755     * This sets a specific theme that will be used for the given object and any
3756     * child objects it has. If @p th is NULL then the theme to be used is
3757     * cleared and the object will inherit its theme from its parent (which
3758     * ultimately will use the default theme if no specific themes are set).
3759     *
3760     * Use special themes with great care as this will annoy users and make
3761     * configuration difficult. Avoid any custom themes at all if it can be
3762     * helped.
3763     */
3764    EAPI void             elm_object_theme_set(Evas_Object *obj, Elm_Theme *th) EINA_ARG_NONNULL(1);
3765    /**
3766     * Get the specific theme to be used
3767     *
3768     * @param obj The object to get the specific theme from
3769     * @return The specifc theme set.
3770     *
3771     * This will return a specific theme set, or NULL if no specific theme is
3772     * set on that object. It will not return inherited themes from parents, only
3773     * the specific theme set for that specific object. See elm_object_theme_set()
3774     * for more information.
3775     */
3776    EAPI Elm_Theme       *elm_object_theme_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3777
3778    /**
3779     * Get a data item from a theme
3780     *
3781     * @param th The theme, or NULL for default theme
3782     * @param key The data key to search with
3783     * @return The data value, or NULL on failure
3784     *
3785     * This function is used to return data items from edc in @p th, an overlay, or an extension.
3786     * It works the same way as edje_file_data_get() except that the return is stringshared.
3787     */
3788    EAPI const char      *elm_theme_data_get(Elm_Theme *th, const char *key) EINA_ARG_NONNULL(2);
3789    /**
3790     * @}
3791     */
3792
3793    /* win */
3794    /** @defgroup Win Win
3795     *
3796     * @image html img/widget/win/preview-00.png
3797     * @image latex img/widget/win/preview-00.eps
3798     *
3799     * The window class of Elementary.  Contains functions to manipulate
3800     * windows. The Evas engine used to render the window contents is specified
3801     * in the system or user elementary config files (whichever is found last),
3802     * and can be overridden with the ELM_ENGINE environment variable for
3803     * testing.  Engines that may be supported (depending on Evas and Ecore-Evas
3804     * compilation setup and modules actually installed at runtime) are (listed
3805     * in order of best supported and most likely to be complete and work to
3806     * lowest quality).
3807     *
3808     * @li "x11", "x", "software-x11", "software_x11" (Software rendering in X11)
3809     * @li "gl", "opengl", "opengl-x11", "opengl_x11" (OpenGL or OpenGL-ES2
3810     * rendering in X11)
3811     * @li "shot:..." (Virtual screenshot renderer - renders to output file and
3812     * exits)
3813     * @li "fb", "software-fb", "software_fb" (Linux framebuffer direct software
3814     * rendering)
3815     * @li "sdl", "software-sdl", "software_sdl" (SDL software rendering to SDL
3816     * buffer)
3817     * @li "gl-sdl", "gl_sdl", "opengl-sdl", "opengl_sdl" (OpenGL or OpenGL-ES2
3818     * rendering using SDL as the buffer)
3819     * @li "gdi", "software-gdi", "software_gdi" (Windows WIN32 rendering via
3820     * GDI with software)
3821     * @li "dfb", "directfb" (Rendering to a DirectFB window)
3822     * @li "x11-8", "x8", "software-8-x11", "software_8_x11" (Rendering in
3823     * grayscale using dedicated 8bit software engine in X11)
3824     * @li "x11-16", "x16", "software-16-x11", "software_16_x11" (Rendering in
3825     * X11 using 16bit software engine)
3826     * @li "wince-gdi", "software-16-wince-gdi", "software_16_wince_gdi"
3827     * (Windows CE rendering via GDI with 16bit software renderer)
3828     * @li "sdl-16", "software-16-sdl", "software_16_sdl" (Rendering to SDL
3829     * buffer with 16bit software renderer)
3830     * @li "ews" (rendering to EWS - Ecore + Evas Single Process Windowing System)
3831     * @li "gl-cocoa", "gl_cocoa", "opengl-cocoa", "opengl_cocoa" (OpenGL rendering in Cocoa)
3832     * @li "psl1ght" (PS3 rendering using PSL1GHT)
3833     *
3834     * All engines use a simple string to select the engine to render, EXCEPT
3835     * the "shot" engine. This actually encodes the output of the virtual
3836     * screenshot and how long to delay in the engine string. The engine string
3837     * is encoded in the following way:
3838     *
3839     *   "shot:[delay=XX][:][repeat=DDD][:][file=XX]"
3840     *
3841     * Where options are separated by a ":" char if more than one option is
3842     * given, with delay, if provided being the first option and file the last
3843     * (order is important). The delay specifies how long to wait after the
3844     * window is shown before doing the virtual "in memory" rendering and then
3845     * save the output to the file specified by the file option (and then exit).
3846     * If no delay is given, the default is 0.5 seconds. If no file is given the
3847     * default output file is "out.png". Repeat option is for continous
3848     * capturing screenshots. Repeat range is from 1 to 999 and filename is
3849     * fixed to "out001.png" Some examples of using the shot engine:
3850     *
3851     *   ELM_ENGINE="shot:delay=1.0:repeat=5:file=elm_test.png" elementary_test
3852     *   ELM_ENGINE="shot:delay=1.0:file=elm_test.png" elementary_test
3853     *   ELM_ENGINE="shot:file=elm_test2.png" elementary_test
3854     *   ELM_ENGINE="shot:delay=2.0" elementary_test
3855     *   ELM_ENGINE="shot:" elementary_test
3856     *
3857     * Signals that you can add callbacks for are:
3858     *
3859     * @li "delete,request": the user requested to close the window. See
3860     * elm_win_autodel_set().
3861     * @li "focus,in": window got focus
3862     * @li "focus,out": window lost focus
3863     * @li "moved": window that holds the canvas was moved
3864     *
3865     * Examples:
3866     * @li @ref win_example_01
3867     *
3868     * @{
3869     */
3870    /**
3871     * Defines the types of window that can be created
3872     *
3873     * These are hints set on the window so that a running Window Manager knows
3874     * how the window should be handled and/or what kind of decorations it
3875     * should have.
3876     *
3877     * Currently, only the X11 backed engines use them.
3878     */
3879    typedef enum _Elm_Win_Type
3880      {
3881         ELM_WIN_BASIC, /**< A normal window. Indicates a normal, top-level
3882                          window. Almost every window will be created with this
3883                          type. */
3884         ELM_WIN_DIALOG_BASIC, /**< Used for simple dialog windows/ */
3885         ELM_WIN_DESKTOP, /**< For special desktop windows, like a background
3886                            window holding desktop icons. */
3887         ELM_WIN_DOCK, /**< The window is used as a dock or panel. Usually would
3888                         be kept on top of any other window by the Window
3889                         Manager. */
3890         ELM_WIN_TOOLBAR, /**< The window is used to hold a floating toolbar, or
3891                            similar. */
3892         ELM_WIN_MENU, /**< Similar to #ELM_WIN_TOOLBAR. */
3893         ELM_WIN_UTILITY, /**< A persistent utility window, like a toolbox or
3894                            pallete. */
3895         ELM_WIN_SPLASH, /**< Splash window for a starting up application. */
3896         ELM_WIN_DROPDOWN_MENU, /**< The window is a dropdown menu, as when an
3897                                  entry in a menubar is clicked. Typically used
3898                                  with elm_win_override_set(). This hint exists
3899                                  for completion only, as the EFL way of
3900                                  implementing a menu would not normally use a
3901                                  separate window for its contents. */
3902         ELM_WIN_POPUP_MENU, /**< Like #ELM_WIN_DROPDOWN_MENU, but for the menu
3903                               triggered by right-clicking an object. */
3904         ELM_WIN_TOOLTIP, /**< The window is a tooltip. A short piece of
3905                            explanatory text that typically appear after the
3906                            mouse cursor hovers over an object for a while.
3907                            Typically used with elm_win_override_set() and also
3908                            not very commonly used in the EFL. */
3909         ELM_WIN_NOTIFICATION, /**< A notification window, like a warning about
3910                                 battery life or a new E-Mail received. */
3911         ELM_WIN_COMBO, /**< A window holding the contents of a combo box. Not
3912                          usually used in the EFL. */
3913         ELM_WIN_DND, /**< Used to indicate the window is a representation of an
3914                        object being dragged across different windows, or even
3915                        applications. Typically used with
3916                        elm_win_override_set(). */
3917         ELM_WIN_INLINED_IMAGE, /**< The window is rendered onto an image
3918                                  buffer. No actual window is created for this
3919                                  type, instead the window and all of its
3920                                  contents will be rendered to an image buffer.
3921                                  This allows to have children window inside a
3922                                  parent one just like any other object would
3923                                  be, and do other things like applying @c
3924                                  Evas_Map effects to it. This is the only type
3925                                  of window that requires the @c parent
3926                                  parameter of elm_win_add() to be a valid @c
3927                                  Evas_Object. */
3928      } Elm_Win_Type;
3929
3930    /**
3931     * The differents layouts that can be requested for the virtual keyboard.
3932     *
3933     * When the application window is being managed by Illume, it may request
3934     * any of the following layouts for the virtual keyboard.
3935     */
3936    typedef enum _Elm_Win_Keyboard_Mode
3937      {
3938         ELM_WIN_KEYBOARD_UNKNOWN, /**< Unknown keyboard state */
3939         ELM_WIN_KEYBOARD_OFF, /**< Request to deactivate the keyboard */
3940         ELM_WIN_KEYBOARD_ON, /**< Enable keyboard with default layout */
3941         ELM_WIN_KEYBOARD_ALPHA, /**< Alpha (a-z) keyboard layout */
3942         ELM_WIN_KEYBOARD_NUMERIC, /**< Numeric keyboard layout */
3943         ELM_WIN_KEYBOARD_PIN, /**< PIN keyboard layout */
3944         ELM_WIN_KEYBOARD_PHONE_NUMBER, /**< Phone keyboard layout */
3945         ELM_WIN_KEYBOARD_HEX, /**< Hexadecimal numeric keyboard layout */
3946         ELM_WIN_KEYBOARD_TERMINAL, /**< Full (QUERTY) keyboard layout */
3947         ELM_WIN_KEYBOARD_PASSWORD, /**< Password keyboard layout */
3948         ELM_WIN_KEYBOARD_IP, /**< IP keyboard layout */
3949         ELM_WIN_KEYBOARD_HOST, /**< Host keyboard layout */
3950         ELM_WIN_KEYBOARD_FILE, /**< File keyboard layout */
3951         ELM_WIN_KEYBOARD_URL, /**< URL keyboard layout */
3952         ELM_WIN_KEYBOARD_KEYPAD, /**< Keypad layout */
3953         ELM_WIN_KEYBOARD_J2ME /**< J2ME keyboard layout */
3954      } Elm_Win_Keyboard_Mode;
3955
3956    /**
3957     * Available commands that can be sent to the Illume manager.
3958     *
3959     * When running under an Illume session, a window may send commands to the
3960     * Illume manager to perform different actions.
3961     */
3962    typedef enum _Elm_Illume_Command
3963      {
3964         ELM_ILLUME_COMMAND_FOCUS_BACK, /**< Reverts focus to the previous
3965                                          window */
3966         ELM_ILLUME_COMMAND_FOCUS_FORWARD, /**< Sends focus to the next window\
3967                                             in the list */
3968         ELM_ILLUME_COMMAND_FOCUS_HOME, /**< Hides all windows to show the Home
3969                                          screen */
3970         ELM_ILLUME_COMMAND_CLOSE /**< Closes the currently active window */
3971      } Elm_Illume_Command;
3972
3973    /**
3974     * Adds a window object. If this is the first window created, pass NULL as
3975     * @p parent.
3976     *
3977     * @param parent Parent object to add the window to, or NULL
3978     * @param name The name of the window
3979     * @param type The window type, one of #Elm_Win_Type.
3980     *
3981     * The @p parent paramter can be @c NULL for every window @p type except
3982     * #ELM_WIN_INLINED_IMAGE, which needs a parent to retrieve the canvas on
3983     * which the image object will be created.
3984     *
3985     * @return The created object, or NULL on failure
3986     */
3987    EAPI Evas_Object *elm_win_add(Evas_Object *parent, const char *name, Elm_Win_Type type);
3988    /**
3989     * Adds a window object with standard setup
3990     *
3991     * @param name The name of the window
3992     * @param title The title for the window
3993     *
3994     * This creates a window like elm_win_add() but also puts in a standard
3995     * background with elm_bg_add(), as well as setting the window title to
3996     * @p title. The window type created is of type ELM_WIN_BASIC, with NULL
3997     * as the parent widget.
3998     * 
3999     * @return The created object, or NULL on failure
4000     *
4001     * @see elm_win_add()
4002     */
4003    EAPI Evas_Object *elm_win_util_standard_add(const char *name, const char *title);
4004    /**
4005     * Add @p subobj as a resize object of window @p obj.
4006     *
4007     *
4008     * Setting an object as a resize object of the window means that the
4009     * @p subobj child's size and position will be controlled by the window
4010     * directly. That is, the object will be resized to match the window size
4011     * and should never be moved or resized manually by the developer.
4012     *
4013     * In addition, resize objects of the window control what the minimum size
4014     * of it will be, as well as whether it can or not be resized by the user.
4015     *
4016     * For the end user to be able to resize a window by dragging the handles
4017     * or borders provided by the Window Manager, or using any other similar
4018     * mechanism, all of the resize objects in the window should have their
4019     * evas_object_size_hint_weight_set() set to EVAS_HINT_EXPAND.
4020     *
4021     * @param obj The window object
4022     * @param subobj The resize object to add
4023     */
4024    EAPI void         elm_win_resize_object_add(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
4025    /**
4026     * Delete @p subobj as a resize object of window @p obj.
4027     *
4028     * This function removes the object @p subobj from the resize objects of
4029     * the window @p obj. It will not delete the object itself, which will be
4030     * left unmanaged and should be deleted by the developer, manually handled
4031     * or set as child of some other container.
4032     *
4033     * @param obj The window object
4034     * @param subobj The resize object to add
4035     */
4036    EAPI void         elm_win_resize_object_del(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
4037    /**
4038     * Set the title of the window
4039     *
4040     * @param obj The window object
4041     * @param title The title to set
4042     */
4043    EAPI void         elm_win_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
4044    /**
4045     * Get the title of the window
4046     *
4047     * The returned string is an internal one and should not be freed or
4048     * modified. It will also be rendered invalid if a new title is set or if
4049     * the window is destroyed.
4050     *
4051     * @param obj The window object
4052     * @return The title
4053     */
4054    EAPI const char  *elm_win_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4055    /**
4056     * Set the window's autodel state.
4057     *
4058     * When closing the window in any way outside of the program control, like
4059     * pressing the X button in the titlebar or using a command from the
4060     * Window Manager, a "delete,request" signal is emitted to indicate that
4061     * this event occurred and the developer can take any action, which may
4062     * include, or not, destroying the window object.
4063     *
4064     * When the @p autodel parameter is set, the window will be automatically
4065     * destroyed when this event occurs, after the signal is emitted.
4066     * If @p autodel is @c EINA_FALSE, then the window will not be destroyed
4067     * and is up to the program to do so when it's required.
4068     *
4069     * @param obj The window object
4070     * @param autodel If true, the window will automatically delete itself when
4071     * closed
4072     */
4073    EAPI void         elm_win_autodel_set(Evas_Object *obj, Eina_Bool autodel) EINA_ARG_NONNULL(1);
4074    /**
4075     * Get the window's autodel state.
4076     *
4077     * @param obj The window object
4078     * @return If the window will automatically delete itself when closed
4079     *
4080     * @see elm_win_autodel_set()
4081     */
4082    EAPI Eina_Bool    elm_win_autodel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4083    /**
4084     * Activate a window object.
4085     *
4086     * This function sends a request to the Window Manager to activate the
4087     * window pointed by @p obj. If honored by the WM, the window will receive
4088     * the keyboard focus.
4089     *
4090     * @note This is just a request that a Window Manager may ignore, so calling
4091     * this function does not ensure in any way that the window will be the
4092     * active one after it.
4093     *
4094     * @param obj The window object
4095     */
4096    EAPI void         elm_win_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
4097    /**
4098     * Lower a window object.
4099     *
4100     * Places the window pointed by @p obj at the bottom of the stack, so that
4101     * no other window is covered by it.
4102     *
4103     * If elm_win_override_set() is not set, the Window Manager may ignore this
4104     * request.
4105     *
4106     * @param obj The window object
4107     */
4108    EAPI void         elm_win_lower(Evas_Object *obj) EINA_ARG_NONNULL(1);
4109    /**
4110     * Raise a window object.
4111     *
4112     * Places the window pointed by @p obj at the top of the stack, so that it's
4113     * not covered by any other window.
4114     *
4115     * If elm_win_override_set() is not set, the Window Manager may ignore this
4116     * request.
4117     *
4118     * @param obj The window object
4119     */
4120    EAPI void         elm_win_raise(Evas_Object *obj) EINA_ARG_NONNULL(1);
4121    /**
4122     * Set the borderless state of a window.
4123     *
4124     * This function requests the Window Manager to not draw any decoration
4125     * around the window.
4126     *
4127     * @param obj The window object
4128     * @param borderless If true, the window is borderless
4129     */
4130    EAPI void         elm_win_borderless_set(Evas_Object *obj, Eina_Bool borderless) EINA_ARG_NONNULL(1);
4131    /**
4132     * Get the borderless state of a window.
4133     *
4134     * @param obj The window object
4135     * @return If true, the window is borderless
4136     */
4137    EAPI Eina_Bool    elm_win_borderless_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4138    /**
4139     * Set the shaped state of a window.
4140     *
4141     * Shaped windows, when supported, will render the parts of the window that
4142     * has no content, transparent.
4143     *
4144     * If @p shaped is EINA_FALSE, then it is strongly adviced to have some
4145     * background object or cover the entire window in any other way, or the
4146     * parts of the canvas that have no data will show framebuffer artifacts.
4147     *
4148     * @param obj The window object
4149     * @param shaped If true, the window is shaped
4150     *
4151     * @see elm_win_alpha_set()
4152     */
4153    EAPI void         elm_win_shaped_set(Evas_Object *obj, Eina_Bool shaped) EINA_ARG_NONNULL(1);
4154    /**
4155     * Get the shaped state of a window.
4156     *
4157     * @param obj The window object
4158     * @return If true, the window is shaped
4159     *
4160     * @see elm_win_shaped_set()
4161     */
4162    EAPI Eina_Bool    elm_win_shaped_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4163    /**
4164     * Set the alpha channel state of a window.
4165     *
4166     * If @p alpha is EINA_TRUE, the alpha channel of the canvas will be enabled
4167     * possibly making parts of the window completely or partially transparent.
4168     * This is also subject to the underlying system supporting it, like for
4169     * example, running under a compositing manager. If no compositing is
4170     * available, enabling this option will instead fallback to using shaped
4171     * windows, with elm_win_shaped_set().
4172     *
4173     * @param obj The window object
4174     * @param alpha If true, the window has an alpha channel
4175     *
4176     * @see elm_win_alpha_set()
4177     */
4178    EAPI void         elm_win_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
4179    /**
4180     * Get the transparency state of a window.
4181     *
4182     * @param obj The window object
4183     * @return If true, the window is transparent
4184     *
4185     * @see elm_win_transparent_set()
4186     */
4187    EAPI Eina_Bool    elm_win_transparent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4188    /**
4189     * Set the transparency state of a window.
4190     *
4191     * Use elm_win_alpha_set() instead.
4192     *
4193     * @param obj The window object
4194     * @param transparent If true, the window is transparent
4195     *
4196     * @see elm_win_alpha_set()
4197     */
4198    EAPI void         elm_win_transparent_set(Evas_Object *obj, Eina_Bool transparent) EINA_ARG_NONNULL(1);
4199    /**
4200     * Get the alpha channel state of a window.
4201     *
4202     * @param obj The window object
4203     * @return If true, the window has an alpha channel
4204     */
4205    EAPI Eina_Bool    elm_win_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4206    /**
4207     * Set the override state of a window.
4208     *
4209     * A window with @p override set to EINA_TRUE will not be managed by the
4210     * Window Manager. This means that no decorations of any kind will be shown
4211     * for it, moving and resizing must be handled by the application, as well
4212     * as the window visibility.
4213     *
4214     * This should not be used for normal windows, and even for not so normal
4215     * ones, it should only be used when there's a good reason and with a lot
4216     * of care. Mishandling override windows may result situations that
4217     * disrupt the normal workflow of the end user.
4218     *
4219     * @param obj The window object
4220     * @param override If true, the window is overridden
4221     */
4222    EAPI void         elm_win_override_set(Evas_Object *obj, Eina_Bool override) EINA_ARG_NONNULL(1);
4223    /**
4224     * Get the override state of a window.
4225     *
4226     * @param obj The window object
4227     * @return If true, the window is overridden
4228     *
4229     * @see elm_win_override_set()
4230     */
4231    EAPI Eina_Bool    elm_win_override_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4232    /**
4233     * Set the fullscreen state of a window.
4234     *
4235     * @param obj The window object
4236     * @param fullscreen If true, the window is fullscreen
4237     */
4238    EAPI void         elm_win_fullscreen_set(Evas_Object *obj, Eina_Bool fullscreen) EINA_ARG_NONNULL(1);
4239    /**
4240     * Get the fullscreen state of a window.
4241     *
4242     * @param obj The window object
4243     * @return If true, the window is fullscreen
4244     */
4245    EAPI Eina_Bool    elm_win_fullscreen_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4246    /**
4247     * Set the maximized state of a window.
4248     *
4249     * @param obj The window object
4250     * @param maximized If true, the window is maximized
4251     */
4252    EAPI void         elm_win_maximized_set(Evas_Object *obj, Eina_Bool maximized) EINA_ARG_NONNULL(1);
4253    /**
4254     * Get the maximized state of a window.
4255     *
4256     * @param obj The window object
4257     * @return If true, the window is maximized
4258     */
4259    EAPI Eina_Bool    elm_win_maximized_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4260    /**
4261     * Set the iconified state of a window.
4262     *
4263     * @param obj The window object
4264     * @param iconified If true, the window is iconified
4265     */
4266    EAPI void         elm_win_iconified_set(Evas_Object *obj, Eina_Bool iconified) EINA_ARG_NONNULL(1);
4267    /**
4268     * Get the iconified state of a window.
4269     *
4270     * @param obj The window object
4271     * @return If true, the window is iconified
4272     */
4273    EAPI Eina_Bool    elm_win_iconified_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4274    /**
4275     * Set the layer of the window.
4276     *
4277     * What this means exactly will depend on the underlying engine used.
4278     *
4279     * In the case of X11 backed engines, the value in @p layer has the
4280     * following meanings:
4281     * @li < 3: The window will be placed below all others.
4282     * @li > 5: The window will be placed above all others.
4283     * @li other: The window will be placed in the default layer.
4284     *
4285     * @param obj The window object
4286     * @param layer The layer of the window
4287     */
4288    EAPI void         elm_win_layer_set(Evas_Object *obj, int layer) EINA_ARG_NONNULL(1);
4289    /**
4290     * Get the layer of the window.
4291     *
4292     * @param obj The window object
4293     * @return The layer of the window
4294     *
4295     * @see elm_win_layer_set()
4296     */
4297    EAPI int          elm_win_layer_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4298    /**
4299     * Set the rotation of the window.
4300     *
4301     * Most engines only work with multiples of 90.
4302     *
4303     * This function is used to set the orientation of the window @p obj to
4304     * match that of the screen. The window itself will be resized to adjust
4305     * to the new geometry of its contents. If you want to keep the window size,
4306     * see elm_win_rotation_with_resize_set().
4307     *
4308     * @param obj The window object
4309     * @param rotation The rotation of the window, in degrees (0-360),
4310     * counter-clockwise.
4311     */
4312    EAPI void         elm_win_rotation_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
4313    /**
4314     * Rotates the window and resizes it.
4315     *
4316     * Like elm_win_rotation_set(), but it also resizes the window's contents so
4317     * that they fit inside the current window geometry.
4318     *
4319     * @param obj The window object
4320     * @param layer The rotation of the window in degrees (0-360),
4321     * counter-clockwise.
4322     */
4323    EAPI void         elm_win_rotation_with_resize_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
4324    /**
4325     * Get the rotation of the window.
4326     *
4327     * @param obj The window object
4328     * @return The rotation of the window in degrees (0-360)
4329     *
4330     * @see elm_win_rotation_set()
4331     * @see elm_win_rotation_with_resize_set()
4332     */
4333    EAPI int          elm_win_rotation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4334    /**
4335     * Set the sticky state of the window.
4336     *
4337     * Hints the Window Manager that the window in @p obj should be left fixed
4338     * at its position even when the virtual desktop it's on moves or changes.
4339     *
4340     * @param obj The window object
4341     * @param sticky If true, the window's sticky state is enabled
4342     */
4343    EAPI void         elm_win_sticky_set(Evas_Object *obj, Eina_Bool sticky) EINA_ARG_NONNULL(1);
4344    /**
4345     * Get the sticky state of the window.
4346     *
4347     * @param obj The window object
4348     * @return If true, the window's sticky state is enabled
4349     *
4350     * @see elm_win_sticky_set()
4351     */
4352    EAPI Eina_Bool    elm_win_sticky_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4353    /**
4354     * Set if this window is an illume conformant window
4355     *
4356     * @param obj The window object
4357     * @param conformant The conformant flag (1 = conformant, 0 = non-conformant)
4358     */
4359    EAPI void         elm_win_conformant_set(Evas_Object *obj, Eina_Bool conformant) EINA_ARG_NONNULL(1);
4360    /**
4361     * Get if this window is an illume conformant window
4362     *
4363     * @param obj The window object
4364     * @return A boolean if this window is illume conformant or not
4365     */
4366    EAPI Eina_Bool    elm_win_conformant_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4367    /**
4368     * Set a window to be an illume quickpanel window
4369     *
4370     * By default window objects are not quickpanel windows.
4371     *
4372     * @param obj The window object
4373     * @param quickpanel The quickpanel flag (1 = quickpanel, 0 = normal window)
4374     */
4375    EAPI void         elm_win_quickpanel_set(Evas_Object *obj, Eina_Bool quickpanel) EINA_ARG_NONNULL(1);
4376    /**
4377     * Get if this window is a quickpanel or not
4378     *
4379     * @param obj The window object
4380     * @return A boolean if this window is a quickpanel or not
4381     */
4382    EAPI Eina_Bool    elm_win_quickpanel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4383    /**
4384     * Set the major priority of a quickpanel window
4385     *
4386     * @param obj The window object
4387     * @param priority The major priority for this quickpanel
4388     */
4389    EAPI void         elm_win_quickpanel_priority_major_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
4390    /**
4391     * Get the major priority of a quickpanel window
4392     *
4393     * @param obj The window object
4394     * @return The major priority of this quickpanel
4395     */
4396    EAPI int          elm_win_quickpanel_priority_major_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4397    /**
4398     * Set the minor priority of a quickpanel window
4399     *
4400     * @param obj The window object
4401     * @param priority The minor priority for this quickpanel
4402     */
4403    EAPI void         elm_win_quickpanel_priority_minor_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
4404    /**
4405     * Get the minor priority of a quickpanel window
4406     *
4407     * @param obj The window object
4408     * @return The minor priority of this quickpanel
4409     */
4410    EAPI int          elm_win_quickpanel_priority_minor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4411    /**
4412     * Set which zone this quickpanel should appear in
4413     *
4414     * @param obj The window object
4415     * @param zone The requested zone for this quickpanel
4416     */
4417    EAPI void         elm_win_quickpanel_zone_set(Evas_Object *obj, int zone) EINA_ARG_NONNULL(1);
4418    /**
4419     * Get which zone this quickpanel should appear in
4420     *
4421     * @param obj The window object
4422     * @return The requested zone for this quickpanel
4423     */
4424    EAPI int          elm_win_quickpanel_zone_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4425    /**
4426     * Set the window to be skipped by keyboard focus
4427     *
4428     * This sets the window to be skipped by normal keyboard input. This means
4429     * a window manager will be asked to not focus this window as well as omit
4430     * it from things like the taskbar, pager, "alt-tab" list etc. etc.
4431     *
4432     * Call this and enable it on a window BEFORE you show it for the first time,
4433     * otherwise it may have no effect.
4434     *
4435     * Use this for windows that have only output information or might only be
4436     * interacted with by the mouse or fingers, and never for typing input.
4437     * Be careful that this may have side-effects like making the window
4438     * non-accessible in some cases unless the window is specially handled. Use
4439     * this with care.
4440     *
4441     * @param obj The window object
4442     * @param skip The skip flag state (EINA_TRUE if it is to be skipped)
4443     */
4444    EAPI void         elm_win_prop_focus_skip_set(Evas_Object *obj, Eina_Bool skip) EINA_ARG_NONNULL(1);
4445    /**
4446     * Send a command to the windowing environment
4447     *
4448     * This is intended to work in touchscreen or small screen device
4449     * environments where there is a more simplistic window management policy in
4450     * place. This uses the window object indicated to select which part of the
4451     * environment to control (the part that this window lives in), and provides
4452     * a command and an optional parameter structure (use NULL for this if not
4453     * needed).
4454     *
4455     * @param obj The window object that lives in the environment to control
4456     * @param command The command to send
4457     * @param params Optional parameters for the command
4458     */
4459    EAPI void         elm_win_illume_command_send(Evas_Object *obj, Elm_Illume_Command command, void *params) EINA_ARG_NONNULL(1);
4460    /**
4461     * Get the inlined image object handle
4462     *
4463     * When you create a window with elm_win_add() of type ELM_WIN_INLINED_IMAGE,
4464     * then the window is in fact an evas image object inlined in the parent
4465     * canvas. You can get this object (be careful to not manipulate it as it
4466     * is under control of elementary), and use it to do things like get pixel
4467     * data, save the image to a file, etc.
4468     *
4469     * @param obj The window object to get the inlined image from
4470     * @return The inlined image object, or NULL if none exists
4471     */
4472    EAPI Evas_Object *elm_win_inlined_image_object_get(Evas_Object *obj);
4473    /**
4474     * Determine whether a window has focus
4475     * @param obj The window to query
4476     * @return EINA_TRUE if the window exists and has focus, else EINA_FALSE
4477     */
4478    EAPI Eina_Bool    elm_win_focus_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4479    /**
4480     * Get screen geometry details for the screen that a window is on
4481     * @param obj The window to query
4482     * @param x where to return the horizontal offset value. May be NULL.
4483     * @param y  where to return the vertical offset value. May be NULL.
4484     * @param w  where to return the width value. May be NULL.
4485     * @param h  where to return the height value. May be NULL.
4486     */
4487    EAPI void         elm_win_screen_size_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
4488    /**
4489     * Set the enabled status for the focus highlight in a window
4490     *
4491     * This function will enable or disable the focus highlight only for the
4492     * given window, regardless of the global setting for it
4493     *
4494     * @param obj The window where to enable the highlight
4495     * @param enabled The enabled value for the highlight
4496     */
4497    EAPI void         elm_win_focus_highlight_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
4498    /**
4499     * Get the enabled value of the focus highlight for this window
4500     *
4501     * @param obj The window in which to check if the focus highlight is enabled
4502     *
4503     * @return EINA_TRUE if enabled, EINA_FALSE otherwise
4504     */
4505    EAPI Eina_Bool    elm_win_focus_highlight_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4506    /**
4507     * Set the style for the focus highlight on this window
4508     *
4509     * Sets the style to use for theming the highlight of focused objects on
4510     * the given window. If @p style is NULL, the default will be used.
4511     *
4512     * @param obj The window where to set the style
4513     * @param style The style to set
4514     */
4515    EAPI void         elm_win_focus_highlight_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
4516    /**
4517     * Get the style set for the focus highlight object
4518     *
4519     * Gets the style set for this windows highilght object, or NULL if none
4520     * is set.
4521     *
4522     * @param obj The window to retrieve the highlights style from
4523     *
4524     * @return The style set or NULL if none was. Default is used in that case.
4525     */
4526    EAPI const char  *elm_win_focus_highlight_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4527    EAPI void         elm_win_indicator_state_set(Evas_Object *obj, int show_state);
4528    EAPI int          elm_win_indicator_state_get(Evas_Object *obj);
4529    /*...
4530     * ecore_x_icccm_hints_set -> accepts_focus (add to ecore_evas)
4531     * ecore_x_icccm_hints_set -> window_group (add to ecore_evas)
4532     * ecore_x_icccm_size_pos_hints_set -> request_pos (add to ecore_evas)
4533     * ecore_x_icccm_client_leader_set -> l (add to ecore_evas)
4534     * ecore_x_icccm_window_role_set -> role (add to ecore_evas)
4535     * ecore_x_icccm_transient_for_set -> forwin (add to ecore_evas)
4536     * ecore_x_netwm_window_type_set -> type (add to ecore_evas)
4537     *
4538     * (add to ecore_x) set netwm argb icon! (add to ecore_evas)
4539     * (blank mouse, private mouse obj, defaultmouse)
4540     *
4541     */
4542    /**
4543     * Sets the keyboard mode of the window.
4544     *
4545     * @param obj The window object
4546     * @param mode The mode to set, one of #Elm_Win_Keyboard_Mode
4547     */
4548    EAPI void                  elm_win_keyboard_mode_set(Evas_Object *obj, Elm_Win_Keyboard_Mode mode) EINA_ARG_NONNULL(1);
4549    /**
4550     * Gets the keyboard mode of the window.
4551     *
4552     * @param obj The window object
4553     * @return The mode, one of #Elm_Win_Keyboard_Mode
4554     */
4555    EAPI Elm_Win_Keyboard_Mode elm_win_keyboard_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4556    /**
4557     * Sets whether the window is a keyboard.
4558     *
4559     * @param obj The window object
4560     * @param is_keyboard If true, the window is a virtual keyboard
4561     */
4562    EAPI void                  elm_win_keyboard_win_set(Evas_Object *obj, Eina_Bool is_keyboard) EINA_ARG_NONNULL(1);
4563    /**
4564     * Gets whether the window is a keyboard.
4565     *
4566     * @param obj The window object
4567     * @return If the window is a virtual keyboard
4568     */
4569    EAPI Eina_Bool             elm_win_keyboard_win_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4570
4571    /**
4572     * Get the screen position of a window.
4573     *
4574     * @param obj The window object
4575     * @param x The int to store the x coordinate to
4576     * @param y The int to store the y coordinate to
4577     */
4578    EAPI void                  elm_win_screen_position_get(const Evas_Object *obj, int *x, int *y) EINA_ARG_NONNULL(1);
4579    /**
4580     * @}
4581     */
4582
4583    /**
4584     * @defgroup Inwin Inwin
4585     *
4586     * @image html img/widget/inwin/preview-00.png
4587     * @image latex img/widget/inwin/preview-00.eps
4588     * @image html img/widget/inwin/preview-01.png
4589     * @image latex img/widget/inwin/preview-01.eps
4590     * @image html img/widget/inwin/preview-02.png
4591     * @image latex img/widget/inwin/preview-02.eps
4592     *
4593     * An inwin is a window inside a window that is useful for a quick popup.
4594     * It does not hover.
4595     *
4596     * It works by creating an object that will occupy the entire window, so it
4597     * must be created using an @ref Win "elm_win" as parent only. The inwin
4598     * object can be hidden or restacked below every other object if it's
4599     * needed to show what's behind it without destroying it. If this is done,
4600     * the elm_win_inwin_activate() function can be used to bring it back to
4601     * full visibility again.
4602     *
4603     * There are three styles available in the default theme. These are:
4604     * @li default: The inwin is sized to take over most of the window it's
4605     * placed in.
4606     * @li minimal: The size of the inwin will be the minimum necessary to show
4607     * its contents.
4608     * @li minimal_vertical: Horizontally, the inwin takes as much space as
4609     * possible, but it's sized vertically the most it needs to fit its\
4610     * contents.
4611     *
4612     * Some examples of Inwin can be found in the following:
4613     * @li @ref inwin_example_01
4614     *
4615     * @{
4616     */
4617    /**
4618     * Adds an inwin to the current window
4619     *
4620     * The @p obj used as parent @b MUST be an @ref Win "Elementary Window".
4621     * Never call this function with anything other than the top-most window
4622     * as its parameter, unless you are fond of undefined behavior.
4623     *
4624     * After creating the object, the widget will set itself as resize object
4625     * for the window with elm_win_resize_object_add(), so when shown it will
4626     * appear to cover almost the entire window (how much of it depends on its
4627     * content and the style used). It must not be added into other container
4628     * objects and it needs not be moved or resized manually.
4629     *
4630     * @param parent The parent object
4631     * @return The new object or NULL if it cannot be created
4632     */
4633    EAPI Evas_Object          *elm_win_inwin_add(Evas_Object *obj) EINA_ARG_NONNULL(1);
4634    /**
4635     * Activates an inwin object, ensuring its visibility
4636     *
4637     * This function will make sure that the inwin @p obj is completely visible
4638     * by calling evas_object_show() and evas_object_raise() on it, to bring it
4639     * to the front. It also sets the keyboard focus to it, which will be passed
4640     * onto its content.
4641     *
4642     * The object's theme will also receive the signal "elm,action,show" with
4643     * source "elm".
4644     *
4645     * @param obj The inwin to activate
4646     */
4647    EAPI void                  elm_win_inwin_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
4648    /**
4649     * Set the content of an inwin object.
4650     *
4651     * Once the content object is set, a previously set one will be deleted.
4652     * If you want to keep that old content object, use the
4653     * elm_win_inwin_content_unset() function.
4654     *
4655     * @param obj The inwin object
4656     * @param content The object to set as content
4657     */
4658    EAPI void                  elm_win_inwin_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
4659    /**
4660     * Get the content of an inwin object.
4661     *
4662     * Return the content object which is set for this widget.
4663     *
4664     * The returned object is valid as long as the inwin is still alive and no
4665     * other content is set on it. Deleting the object will notify the inwin
4666     * about it and this one will be left empty.
4667     *
4668     * If you need to remove an inwin's content to be reused somewhere else,
4669     * see elm_win_inwin_content_unset().
4670     *
4671     * @param obj The inwin object
4672     * @return The content that is being used
4673     */
4674    EAPI Evas_Object          *elm_win_inwin_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4675    /**
4676     * Unset the content of an inwin object.
4677     *
4678     * Unparent and return the content object which was set for this widget.
4679     *
4680     * @param obj The inwin object
4681     * @return The content that was being used
4682     */
4683    EAPI Evas_Object          *elm_win_inwin_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4684    /**
4685     * @}
4686     */
4687    /* X specific calls - won't work on non-x engines (return 0) */
4688
4689    /**
4690     * Get the Ecore_X_Window of an Evas_Object
4691     *
4692     * @param obj The object
4693     *
4694     * @return The Ecore_X_Window of @p obj
4695     *
4696     * @ingroup Win
4697     */
4698    EAPI Ecore_X_Window elm_win_xwindow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4699
4700    /* smart callbacks called:
4701     * "delete,request" - the user requested to delete the window
4702     * "focus,in" - window got focus
4703     * "focus,out" - window lost focus
4704     * "moved" - window that holds the canvas was moved
4705     */
4706
4707    /**
4708     * @defgroup Bg Bg
4709     *
4710     * @image html img/widget/bg/preview-00.png
4711     * @image latex img/widget/bg/preview-00.eps
4712     *
4713     * @brief Background object, used for setting a solid color, image or Edje
4714     * group as background to a window or any container object.
4715     *
4716     * The bg object is used for setting a solid background to a window or
4717     * packing into any container object. It works just like an image, but has
4718     * some properties useful to a background, like setting it to tiled,
4719     * centered, scaled or stretched.
4720     * 
4721     * Default contents parts of the bg widget that you can use for are:
4722     * @li "overlay" - overlay of the bg
4723     *
4724     * Here is some sample code using it:
4725     * @li @ref bg_01_example_page
4726     * @li @ref bg_02_example_page
4727     * @li @ref bg_03_example_page
4728     */
4729
4730    /* bg */
4731    typedef enum _Elm_Bg_Option
4732      {
4733         ELM_BG_OPTION_CENTER,  /**< center the background */
4734         ELM_BG_OPTION_SCALE,   /**< scale the background retaining aspect ratio */
4735         ELM_BG_OPTION_STRETCH, /**< stretch the background to fill */
4736         ELM_BG_OPTION_TILE     /**< tile background at its original size */
4737      } Elm_Bg_Option;
4738
4739    /**
4740     * Add a new background to the parent
4741     *
4742     * @param parent The parent object
4743     * @return The new object or NULL if it cannot be created
4744     *
4745     * @ingroup Bg
4746     */
4747    EAPI Evas_Object  *elm_bg_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4748
4749    /**
4750     * Set the file (image or edje) used for the background
4751     *
4752     * @param obj The bg object
4753     * @param file The file path
4754     * @param group Optional key (group in Edje) within the file
4755     *
4756     * This sets the image file used in the background object. The image (or edje)
4757     * will be stretched (retaining aspect if its an image file) to completely fill
4758     * the bg object. This may mean some parts are not visible.
4759     *
4760     * @note  Once the image of @p obj is set, a previously set one will be deleted,
4761     * even if @p file is NULL.
4762     *
4763     * @ingroup Bg
4764     */
4765    EAPI void          elm_bg_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
4766
4767    /**
4768     * Get the file (image or edje) used for the background
4769     *
4770     * @param obj The bg object
4771     * @param file The file path
4772     * @param group Optional key (group in Edje) within the file
4773     *
4774     * @ingroup Bg
4775     */
4776    EAPI void          elm_bg_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4777
4778    /**
4779     * Set the option used for the background image
4780     *
4781     * @param obj The bg object
4782     * @param option The desired background option (TILE, SCALE)
4783     *
4784     * This sets the option used for manipulating the display of the background
4785     * image. The image can be tiled or scaled.
4786     *
4787     * @ingroup Bg
4788     */
4789    EAPI void          elm_bg_option_set(Evas_Object *obj, Elm_Bg_Option option) EINA_ARG_NONNULL(1);
4790
4791    /**
4792     * Get the option used for the background image
4793     *
4794     * @param obj The bg object
4795     * @return The desired background option (CENTER, SCALE, STRETCH or TILE)
4796     *
4797     * @ingroup Bg
4798     */
4799    EAPI Elm_Bg_Option elm_bg_option_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4800    /**
4801     * Set the option used for the background color
4802     *
4803     * @param obj The bg object
4804     * @param r
4805     * @param g
4806     * @param b
4807     *
4808     * This sets the color used for the background rectangle. Its range goes
4809     * from 0 to 255.
4810     *
4811     * @ingroup Bg
4812     */
4813    EAPI void          elm_bg_color_set(Evas_Object *obj, int r, int g, int b) EINA_ARG_NONNULL(1);
4814    /**
4815     * Get the option used for the background color
4816     *
4817     * @param obj The bg object
4818     * @param r
4819     * @param g
4820     * @param b
4821     *
4822     * @ingroup Bg
4823     */
4824    EAPI void          elm_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b) EINA_ARG_NONNULL(1);
4825
4826    /**
4827     * Set the overlay object used for the background object.
4828     *
4829     * @param obj The bg object
4830     * @param overlay The overlay object
4831     *
4832     * This provides a way for elm_bg to have an 'overlay' that will be on top
4833     * of the bg. Once the over object is set, a previously set one will be
4834     * deleted, even if you set the new one to NULL. If you want to keep that
4835     * old content object, use the elm_bg_overlay_unset() function.
4836     *
4837     * @deprecated use elm_object_part_content_set() instead
4838     *
4839     * @ingroup Bg
4840     */
4841
4842    WILL_DEPRECATE  EAPI void          elm_bg_overlay_set(Evas_Object *obj, Evas_Object *overlay) EINA_ARG_NONNULL(1);
4843
4844    /**
4845     * Get the overlay object used for the background object.
4846     *
4847     * @param obj The bg object
4848     * @return The content that is being used
4849     *
4850     * Return the content object which is set for this widget
4851     *
4852     * @deprecated use elm_object_part_content_get() instead
4853     *
4854     * @ingroup Bg
4855     */
4856    EINA_DEPRECATED EAPI Evas_Object  *elm_bg_overlay_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4857
4858    /**
4859     * Get the overlay object used for the background object.
4860     *
4861     * @param obj The bg object
4862     * @return The content that was being used
4863     *
4864     * Unparent and return the overlay object which was set for this widget
4865     *
4866     * @deprecated use elm_object_part_content_unset() instead
4867     *
4868     * @ingroup Bg
4869     */
4870    WILL_DEPRECATE  EAPI Evas_Object  *elm_bg_overlay_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4871
4872    /**
4873     * Set the size of the pixmap representation of the image.
4874     *
4875     * This option just makes sense if an image is going to be set in the bg.
4876     *
4877     * @param obj The bg object
4878     * @param w The new width of the image pixmap representation.
4879     * @param h The new height of the image pixmap representation.
4880     *
4881     * This function sets a new size for pixmap representation of the given bg
4882     * image. It allows the image to be loaded already in the specified size,
4883     * reducing the memory usage and load time when loading a big image with load
4884     * size set to a smaller size.
4885     *
4886     * NOTE: this is just a hint, the real size of the pixmap may differ
4887     * depending on the type of image being loaded, being bigger than requested.
4888     *
4889     * @ingroup Bg
4890     */
4891    EAPI void          elm_bg_load_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
4892    /* smart callbacks called:
4893     */
4894
4895    /**
4896     * @defgroup Icon Icon
4897     *
4898     * @image html img/widget/icon/preview-00.png
4899     * @image latex img/widget/icon/preview-00.eps
4900     *
4901     * An object that provides standard icon images (delete, edit, arrows, etc.)
4902     * or a custom file (PNG, JPG, EDJE, etc.) used for an icon.
4903     *
4904     * The icon image requested can be in the elementary theme, or in the
4905     * freedesktop.org paths. It's possible to set the order of preference from
4906     * where the image will be used.
4907     *
4908     * This API is very similar to @ref Image, but with ready to use images.
4909     *
4910     * Default images provided by the theme are described below.
4911     *
4912     * The first list contains icons that were first intended to be used in
4913     * toolbars, but can be used in many other places too:
4914     * @li home
4915     * @li close
4916     * @li apps
4917     * @li arrow_up
4918     * @li arrow_down
4919     * @li arrow_left
4920     * @li arrow_right
4921     * @li chat
4922     * @li clock
4923     * @li delete
4924     * @li edit
4925     * @li refresh
4926     * @li folder
4927     * @li file
4928     *
4929     * Now some icons that were designed to be used in menus (but again, you can
4930     * use them anywhere else):
4931     * @li menu/home
4932     * @li menu/close
4933     * @li menu/apps
4934     * @li menu/arrow_up
4935     * @li menu/arrow_down
4936     * @li menu/arrow_left
4937     * @li menu/arrow_right
4938     * @li menu/chat
4939     * @li menu/clock
4940     * @li menu/delete
4941     * @li menu/edit
4942     * @li menu/refresh
4943     * @li menu/folder
4944     * @li menu/file
4945     *
4946     * And here we have some media player specific icons:
4947     * @li media_player/forward
4948     * @li media_player/info
4949     * @li media_player/next
4950     * @li media_player/pause
4951     * @li media_player/play
4952     * @li media_player/prev
4953     * @li media_player/rewind
4954     * @li media_player/stop
4955     *
4956     * Signals that you can add callbacks for are:
4957     *
4958     * "clicked" - This is called when a user has clicked the icon
4959     *
4960     * An example of usage for this API follows:
4961     * @li @ref tutorial_icon
4962     */
4963
4964    /**
4965     * @addtogroup Icon
4966     * @{
4967     */
4968
4969    typedef enum _Elm_Icon_Type
4970      {
4971         ELM_ICON_NONE,
4972         ELM_ICON_FILE,
4973         ELM_ICON_STANDARD
4974      } Elm_Icon_Type;
4975    /**
4976     * @enum _Elm_Icon_Lookup_Order
4977     * @typedef Elm_Icon_Lookup_Order
4978     *
4979     * Lookup order used by elm_icon_standard_set(). Should look for icons in the
4980     * theme, FDO paths, or both?
4981     *
4982     * @ingroup Icon
4983     */
4984    typedef enum _Elm_Icon_Lookup_Order
4985      {
4986         ELM_ICON_LOOKUP_FDO_THEME, /**< icon look up order: freedesktop, theme */
4987         ELM_ICON_LOOKUP_THEME_FDO, /**< icon look up order: theme, freedesktop */
4988         ELM_ICON_LOOKUP_FDO,       /**< icon look up order: freedesktop */
4989         ELM_ICON_LOOKUP_THEME      /**< icon look up order: theme */
4990      } Elm_Icon_Lookup_Order;
4991
4992    /**
4993     * Add a new icon object to the parent.
4994     *
4995     * @param parent The parent object
4996     * @return The new object or NULL if it cannot be created
4997     *
4998     * @see elm_icon_file_set()
4999     *
5000     * @ingroup Icon
5001     */
5002    EAPI Evas_Object          *elm_icon_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5003    /**
5004     * Set the file that will be used as icon.
5005     *
5006     * @param obj The icon object
5007     * @param file The path to file that will be used as icon image
5008     * @param group The group that the icon belongs to an edje file
5009     *
5010     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
5011     *
5012     * @note The icon image set by this function can be changed by
5013     * elm_icon_standard_set().
5014     *
5015     * @see elm_icon_file_get()
5016     *
5017     * @ingroup Icon
5018     */
5019    EAPI Eina_Bool             elm_icon_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
5020    /**
5021     * Set a location in memory to be used as an icon
5022     *
5023     * @param obj The icon object
5024     * @param img The binary data that will be used as an image
5025     * @param size The size of binary data @p img
5026     * @param format Optional format of @p img to pass to the image loader
5027     * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
5028     *
5029     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
5030     *
5031     * @note The icon image set by this function can be changed by
5032     * elm_icon_standard_set().
5033     *
5034     * @ingroup Icon
5035     */
5036    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);
5037    /**
5038     * Get the file that will be used as icon.
5039     *
5040     * @param obj The icon object
5041     * @param file The path to file that will be used as the icon image
5042     * @param group The group that the icon belongs to, in edje file
5043     *
5044     * @see elm_icon_file_set()
5045     *
5046     * @ingroup Icon
5047     */
5048    EAPI void                  elm_icon_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
5049    EAPI void                  elm_icon_thumb_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
5050    /**
5051     * Set the icon by icon standards names.
5052     *
5053     * @param obj The icon object
5054     * @param name The icon name
5055     *
5056     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
5057     *
5058     * For example, freedesktop.org defines standard icon names such as "home",
5059     * "network", etc. There can be different icon sets to match those icon
5060     * keys. The @p name given as parameter is one of these "keys", and will be
5061     * used to look in the freedesktop.org paths and elementary theme. One can
5062     * change the lookup order with elm_icon_order_lookup_set().
5063     *
5064     * If name is not found in any of the expected locations and it is the
5065     * absolute path of an image file, this image will be used.
5066     *
5067     * @note The icon image set by this function can be changed by
5068     * elm_icon_file_set().
5069     *
5070     * @see elm_icon_standard_get()
5071     * @see elm_icon_file_set()
5072     *
5073     * @ingroup Icon
5074     */
5075    EAPI Eina_Bool             elm_icon_standard_set(Evas_Object *obj, const char *name) EINA_ARG_NONNULL(1);
5076    /**
5077     * Get the icon name set by icon standard names.
5078     *
5079     * @param obj The icon object
5080     * @return The icon name
5081     *
5082     * If the icon image was set using elm_icon_file_set() instead of
5083     * elm_icon_standard_set(), then this function will return @c NULL.
5084     *
5085     * @see elm_icon_standard_set()
5086     *
5087     * @ingroup Icon
5088     */
5089    EAPI const char           *elm_icon_standard_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5090    /**
5091     * Set the smooth scaling for an icon object.
5092     *
5093     * @param obj The icon object
5094     * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
5095     * otherwise. Default is @c EINA_TRUE.
5096     *
5097     * Set the scaling algorithm to be used when scaling the icon image. Smooth
5098     * scaling provides a better resulting image, but is slower.
5099     *
5100     * The smooth scaling should be disabled when making animations that change
5101     * the icon size, since they will be faster. Animations that don't require
5102     * resizing of the icon can keep the smooth scaling enabled (even if the icon
5103     * is already scaled, since the scaled icon image will be cached).
5104     *
5105     * @see elm_icon_smooth_get()
5106     *
5107     * @ingroup Icon
5108     */
5109    EAPI void                  elm_icon_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
5110    /**
5111     * Get whether smooth scaling is enabled for an icon object.
5112     *
5113     * @param obj The icon object
5114     * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
5115     *
5116     * @see elm_icon_smooth_set()
5117     *
5118     * @ingroup Icon
5119     */
5120    EAPI Eina_Bool             elm_icon_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5121    /**
5122     * Disable scaling of this object.
5123     *
5124     * @param obj The icon object.
5125     * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
5126     * otherwise. Default is @c EINA_FALSE.
5127     *
5128     * This function disables scaling of the icon object through the function
5129     * elm_object_scale_set(). However, this does not affect the object
5130     * size/resize in any way. For that effect, take a look at
5131     * elm_icon_scale_set().
5132     *
5133     * @see elm_icon_no_scale_get()
5134     * @see elm_icon_scale_set()
5135     * @see elm_object_scale_set()
5136     *
5137     * @ingroup Icon
5138     */
5139    EAPI void                  elm_icon_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
5140    /**
5141     * Get whether scaling is disabled on the object.
5142     *
5143     * @param obj The icon object
5144     * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
5145     *
5146     * @see elm_icon_no_scale_set()
5147     *
5148     * @ingroup Icon
5149     */
5150    EAPI Eina_Bool             elm_icon_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5151    /**
5152     * Set if the object is (up/down) resizable.
5153     *
5154     * @param obj The icon object
5155     * @param scale_up A bool to set if the object is resizable up. Default is
5156     * @c EINA_TRUE.
5157     * @param scale_down A bool to set if the object is resizable down. Default
5158     * is @c EINA_TRUE.
5159     *
5160     * This function limits the icon object resize ability. If @p scale_up is set to
5161     * @c EINA_FALSE, the object can't have its height or width resized to a value
5162     * higher than the original icon size. Same is valid for @p scale_down.
5163     *
5164     * @see elm_icon_scale_get()
5165     *
5166     * @ingroup Icon
5167     */
5168    EAPI void                  elm_icon_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
5169    /**
5170     * Get if the object is (up/down) resizable.
5171     *
5172     * @param obj The icon object
5173     * @param scale_up A bool to set if the object is resizable up
5174     * @param scale_down A bool to set if the object is resizable down
5175     *
5176     * @see elm_icon_scale_set()
5177     *
5178     * @ingroup Icon
5179     */
5180    EAPI void                  elm_icon_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
5181    /**
5182     * Get the object's image size
5183     *
5184     * @param obj The icon object
5185     * @param w A pointer to store the width in
5186     * @param h A pointer to store the height in
5187     *
5188     * @ingroup Icon
5189     */
5190    EAPI void                  elm_icon_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
5191    /**
5192     * Set if the icon fill the entire object area.
5193     *
5194     * @param obj The icon object
5195     * @param fill_outside @c EINA_TRUE if the object is filled outside,
5196     * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5197     *
5198     * When the icon object is resized to a different aspect ratio from the
5199     * original icon image, the icon image will still keep its aspect. This flag
5200     * tells how the image should fill the object's area. They are: keep the
5201     * entire icon inside the limits of height and width of the object (@p
5202     * fill_outside is @c EINA_FALSE) or let the extra width or height go outside
5203     * of the object, and the icon will fill the entire object (@p fill_outside
5204     * is @c EINA_TRUE).
5205     *
5206     * @note Unlike @ref Image, there's no option in icon to set the aspect ratio
5207     * retain property to false. Thus, the icon image will always keep its
5208     * original aspect ratio.
5209     *
5210     * @see elm_icon_fill_outside_get()
5211     * @see elm_image_fill_outside_set()
5212     *
5213     * @ingroup Icon
5214     */
5215    EAPI void                  elm_icon_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
5216    /**
5217     * Get if the object is filled outside.
5218     *
5219     * @param obj The icon object
5220     * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
5221     *
5222     * @see elm_icon_fill_outside_set()
5223     *
5224     * @ingroup Icon
5225     */
5226    EAPI Eina_Bool             elm_icon_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5227    /**
5228     * Set the prescale size for the icon.
5229     *
5230     * @param obj The icon object
5231     * @param size The prescale size. This value is used for both width and
5232     * height.
5233     *
5234     * This function sets a new size for pixmap representation of the given
5235     * icon. It allows the icon to be loaded already in the specified size,
5236     * reducing the memory usage and load time when loading a big icon with load
5237     * size set to a smaller size.
5238     *
5239     * It's equivalent to the elm_bg_load_size_set() function for bg.
5240     *
5241     * @note this is just a hint, the real size of the pixmap may differ
5242     * depending on the type of icon being loaded, being bigger than requested.
5243     *
5244     * @see elm_icon_prescale_get()
5245     * @see elm_bg_load_size_set()
5246     *
5247     * @ingroup Icon
5248     */
5249    EAPI void                  elm_icon_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
5250    /**
5251     * Get the prescale size for the icon.
5252     *
5253     * @param obj The icon object
5254     * @return The prescale size
5255     *
5256     * @see elm_icon_prescale_set()
5257     *
5258     * @ingroup Icon
5259     */
5260    EAPI int                   elm_icon_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5261    /**
5262     * Gets the image object of the icon. DO NOT MODIFY THIS.
5263     *
5264     * @param obj The icon object
5265     * @return The internal icon object
5266     *
5267     * @ingroup Icon
5268     */
5269    EAPI Evas_Object          *elm_icon_object_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
5270    /**
5271     * Sets the icon lookup order used by elm_icon_standard_set().
5272     *
5273     * @param obj The icon object
5274     * @param order The icon lookup order (can be one of
5275     * ELM_ICON_LOOKUP_FDO_THEME, ELM_ICON_LOOKUP_THEME_FDO, ELM_ICON_LOOKUP_FDO
5276     * or ELM_ICON_LOOKUP_THEME)
5277     *
5278     * @see elm_icon_order_lookup_get()
5279     * @see Elm_Icon_Lookup_Order
5280     *
5281     * @ingroup Icon
5282     */
5283    EAPI void                  elm_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
5284    /**
5285     * Gets the icon lookup order.
5286     *
5287     * @param obj The icon object
5288     * @return The icon lookup order
5289     *
5290     * @see elm_icon_order_lookup_set()
5291     * @see Elm_Icon_Lookup_Order
5292     *
5293     * @ingroup Icon
5294     */
5295    EAPI Elm_Icon_Lookup_Order elm_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5296    /**
5297     * Enable or disable preloading of the icon
5298     *
5299     * @param obj The icon object
5300     * @param disable If EINA_TRUE, preloading will be disabled
5301     * @ingroup Icon
5302     */
5303    EAPI void                  elm_icon_preload_set(Evas_Object *obj, Eina_Bool disable) EINA_ARG_NONNULL(1);
5304    /**
5305     * Get if the icon supports animation or not.
5306     *
5307     * @param obj The icon object
5308     * @return @c EINA_TRUE if the icon supports animation,
5309     *         @c EINA_FALSE otherwise.
5310     *
5311     * Return if this elm icon's image can be animated. Currently Evas only
5312     * supports gif animation. If the return value is EINA_FALSE, other
5313     * elm_icon_animated_XXX APIs won't work.
5314     * @ingroup Icon
5315     */
5316    EAPI Eina_Bool           elm_icon_animated_available_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5317    /**
5318     * Set animation mode of the icon.
5319     *
5320     * @param obj The icon object
5321     * @param anim @c EINA_TRUE if the object do animation job,
5322     * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5323     *
5324     * Since the default animation mode is set to EINA_FALSE, 
5325     * the icon is shown without animation.
5326     * This might be desirable when the application developer wants to show
5327     * a snapshot of the animated icon.
5328     * Set it to EINA_TRUE when the icon needs to be animated.
5329     * @ingroup Icon
5330     */
5331    EAPI void                elm_icon_animated_set(Evas_Object *obj, Eina_Bool animated) EINA_ARG_NONNULL(1);
5332    /**
5333     * Get animation mode of the icon.
5334     *
5335     * @param obj The icon object
5336     * @return The animation mode of the icon object
5337     * @see elm_icon_animated_set
5338     * @ingroup Icon
5339     */
5340    EAPI Eina_Bool           elm_icon_animated_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5341    /**
5342     * Set animation play mode of the icon.
5343     *
5344     * @param obj The icon object
5345     * @param play @c EINA_TRUE the object play animation images,
5346     * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5347     *
5348     * To play elm icon's animation, set play to EINA_TURE.
5349     * For example, you make gif player using this set/get API and click event.
5350     *
5351     * 1. Click event occurs
5352     * 2. Check play flag using elm_icon_animaged_play_get
5353     * 3. If elm icon was playing, set play to EINA_FALSE.
5354     *    Then animation will be stopped and vice versa
5355     * @ingroup Icon
5356     */
5357    EAPI void                elm_icon_animated_play_set(Evas_Object *obj, Eina_Bool play) EINA_ARG_NONNULL(1);
5358    /**
5359     * Get animation play mode of the icon.
5360     *
5361     * @param obj The icon object
5362     * @return The play mode of the icon object
5363     *
5364     * @see elm_icon_animated_play_get
5365     * @ingroup Icon
5366     */
5367    EAPI Eina_Bool           elm_icon_animated_play_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5368
5369    /**
5370     * @}
5371     */
5372
5373    /**
5374     * @defgroup Image Image
5375     *
5376     * @image html img/widget/image/preview-00.png
5377     * @image latex img/widget/image/preview-00.eps
5378
5379     *
5380     * An object that allows one to load an image file to it. It can be used
5381     * anywhere like any other elementary widget.
5382     *
5383     * This widget provides most of the functionality provided from @ref Bg or @ref
5384     * Icon, but with a slightly different API (use the one that fits better your
5385     * needs).
5386     *
5387     * The features not provided by those two other image widgets are:
5388     * @li allowing to get the basic @c Evas_Object with elm_image_object_get();
5389     * @li change the object orientation with elm_image_orient_set();
5390     * @li and turning the image editable with elm_image_editable_set().
5391     *
5392     * Signals that you can add callbacks for are:
5393     *
5394     * @li @c "clicked" - This is called when a user has clicked the image
5395     *
5396     * An example of usage for this API follows:
5397     * @li @ref tutorial_image
5398     */
5399
5400    /**
5401     * @addtogroup Image
5402     * @{
5403     */
5404
5405    /**
5406     * @enum _Elm_Image_Orient
5407     * @typedef Elm_Image_Orient
5408     *
5409     * Possible orientation options for elm_image_orient_set().
5410     *
5411     * @image html elm_image_orient_set.png
5412     * @image latex elm_image_orient_set.eps width=\textwidth
5413     *
5414     * @ingroup Image
5415     */
5416    typedef enum _Elm_Image_Orient
5417      {
5418         ELM_IMAGE_ORIENT_NONE, /**< no orientation change */
5419         ELM_IMAGE_ROTATE_90_CW, /**< rotate 90 degrees clockwise */
5420         ELM_IMAGE_ROTATE_180_CW, /**< rotate 180 degrees clockwise */
5421         ELM_IMAGE_ROTATE_90_CCW, /**< rotate 90 degrees counter-clockwise (i.e. 270 degrees clockwise) */
5422         ELM_IMAGE_FLIP_HORIZONTAL, /**< flip image horizontally */
5423         ELM_IMAGE_FLIP_VERTICAL, /**< flip image vertically */
5424         ELM_IMAGE_FLIP_TRANSPOSE, /**< flip the image along the y = (side - x) line*/
5425         ELM_IMAGE_FLIP_TRANSVERSE /**< flip the image along the y = x line */
5426      } Elm_Image_Orient;
5427
5428    /**
5429     * Add a new image to the parent.
5430     *
5431     * @param parent The parent object
5432     * @return The new object or NULL if it cannot be created
5433     *
5434     * @see elm_image_file_set()
5435     *
5436     * @ingroup Image
5437     */
5438    EAPI Evas_Object     *elm_image_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5439    /**
5440     * Set the file that will be used as image.
5441     *
5442     * @param obj The image object
5443     * @param file The path to file that will be used as image
5444     * @param group The group that the image belongs in edje file (if it's an
5445     * edje image)
5446     *
5447     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
5448     *
5449     * @see elm_image_file_get()
5450     *
5451     * @ingroup Image
5452     */
5453    EAPI Eina_Bool        elm_image_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
5454    /**
5455     * Get the file that will be used as image.
5456     *
5457     * @param obj The image object
5458     * @param file The path to file
5459     * @param group The group that the image belongs in edje file
5460     *
5461     * @see elm_image_file_set()
5462     *
5463     * @ingroup Image
5464     */
5465    EAPI void             elm_image_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
5466    /**
5467     * Set the smooth effect for an image.
5468     *
5469     * @param obj The image object
5470     * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
5471     * otherwise. Default is @c EINA_TRUE.
5472     *
5473     * Set the scaling algorithm to be used when scaling the image. Smooth
5474     * scaling provides a better resulting image, but is slower.
5475     *
5476     * The smooth scaling should be disabled when making animations that change
5477     * the image size, since it will be faster. Animations that don't require
5478     * resizing of the image can keep the smooth scaling enabled (even if the
5479     * image is already scaled, since the scaled image will be cached).
5480     *
5481     * @see elm_image_smooth_get()
5482     *
5483     * @ingroup Image
5484     */
5485    EAPI void             elm_image_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
5486    /**
5487     * Get the smooth effect for an image.
5488     *
5489     * @param obj The image object
5490     * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
5491     *
5492     * @see elm_image_smooth_get()
5493     *
5494     * @ingroup Image
5495     */
5496    EAPI Eina_Bool        elm_image_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5497
5498    /**
5499     * Gets the current size of the image.
5500     *
5501     * @param obj The image object.
5502     * @param w Pointer to store width, or NULL.
5503     * @param h Pointer to store height, or NULL.
5504     *
5505     * This is the real size of the image, not the size of the object.
5506     *
5507     * On error, neither w or h will be written.
5508     *
5509     * @ingroup Image
5510     */
5511    EAPI void             elm_image_object_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
5512    /**
5513     * Disable scaling of this object.
5514     *
5515     * @param obj The image object.
5516     * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
5517     * otherwise. Default is @c EINA_FALSE.
5518     *
5519     * This function disables scaling of the elm_image widget through the
5520     * function elm_object_scale_set(). However, this does not affect the widget
5521     * size/resize in any way. For that effect, take a look at
5522     * elm_image_scale_set().
5523     *
5524     * @see elm_image_no_scale_get()
5525     * @see elm_image_scale_set()
5526     * @see elm_object_scale_set()
5527     *
5528     * @ingroup Image
5529     */
5530    EAPI void             elm_image_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
5531    /**
5532     * Get whether scaling is disabled on the object.
5533     *
5534     * @param obj The image object
5535     * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
5536     *
5537     * @see elm_image_no_scale_set()
5538     *
5539     * @ingroup Image
5540     */
5541    EAPI Eina_Bool        elm_image_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5542    /**
5543     * Set if the object is (up/down) resizable.
5544     *
5545     * @param obj The image object
5546     * @param scale_up A bool to set if the object is resizable up. Default is
5547     * @c EINA_TRUE.
5548     * @param scale_down A bool to set if the object is resizable down. Default
5549     * is @c EINA_TRUE.
5550     *
5551     * This function limits the image resize ability. If @p scale_up is set to
5552     * @c EINA_FALSE, the object can't have its height or width resized to a value
5553     * higher than the original image size. Same is valid for @p scale_down.
5554     *
5555     * @see elm_image_scale_get()
5556     *
5557     * @ingroup Image
5558     */
5559    EAPI void             elm_image_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
5560    /**
5561     * Get if the object is (up/down) resizable.
5562     *
5563     * @param obj The image object
5564     * @param scale_up A bool to set if the object is resizable up
5565     * @param scale_down A bool to set if the object is resizable down
5566     *
5567     * @see elm_image_scale_set()
5568     *
5569     * @ingroup Image
5570     */
5571    EAPI void             elm_image_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
5572    /**
5573     * Set if the image fills the entire object area, when keeping the aspect ratio.
5574     *
5575     * @param obj The image object
5576     * @param fill_outside @c EINA_TRUE if the object is filled outside,
5577     * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5578     *
5579     * When the image should keep its aspect ratio even if resized to another
5580     * aspect ratio, there are two possibilities to resize it: keep the entire
5581     * image inside the limits of height and width of the object (@p fill_outside
5582     * is @c EINA_FALSE) or let the extra width or height go outside of the object,
5583     * and the image will fill the entire object (@p fill_outside is @c EINA_TRUE).
5584     *
5585     * @note This option will have no effect if
5586     * elm_image_aspect_ratio_retained_set() is set to @c EINA_FALSE.
5587     *
5588     * @see elm_image_fill_outside_get()
5589     * @see elm_image_aspect_ratio_retained_set()
5590     *
5591     * @ingroup Image
5592     */
5593    EAPI void             elm_image_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
5594    /**
5595     * Get if the object is filled outside
5596     *
5597     * @param obj The image object
5598     * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
5599     *
5600     * @see elm_image_fill_outside_set()
5601     *
5602     * @ingroup Image
5603     */
5604    EAPI Eina_Bool        elm_image_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5605    /**
5606     * Set the prescale size for the image
5607     *
5608     * @param obj The image object
5609     * @param size The prescale size. This value is used for both width and
5610     * height.
5611     *
5612     * This function sets a new size for pixmap representation of the given
5613     * image. It allows the image to be loaded already in the specified size,
5614     * reducing the memory usage and load time when loading a big image with load
5615     * size set to a smaller size.
5616     *
5617     * It's equivalent to the elm_bg_load_size_set() function for bg.
5618     *
5619     * @note this is just a hint, the real size of the pixmap may differ
5620     * depending on the type of image being loaded, being bigger than requested.
5621     *
5622     * @see elm_image_prescale_get()
5623     * @see elm_bg_load_size_set()
5624     *
5625     * @ingroup Image
5626     */
5627    EAPI void             elm_image_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
5628    /**
5629     * Get the prescale size for the image
5630     *
5631     * @param obj The image object
5632     * @return The prescale size
5633     *
5634     * @see elm_image_prescale_set()
5635     *
5636     * @ingroup Image
5637     */
5638    EAPI int              elm_image_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5639    /**
5640     * Set the image orientation.
5641     *
5642     * @param obj The image object
5643     * @param orient The image orientation @ref Elm_Image_Orient
5644     *  Default is #ELM_IMAGE_ORIENT_NONE.
5645     *
5646     * This function allows to rotate or flip the given image.
5647     *
5648     * @see elm_image_orient_get()
5649     * @see @ref Elm_Image_Orient
5650     *
5651     * @ingroup Image
5652     */
5653    EAPI void             elm_image_orient_set(Evas_Object *obj, Elm_Image_Orient orient) EINA_ARG_NONNULL(1);
5654    /**
5655     * Get the image orientation.
5656     *
5657     * @param obj The image object
5658     * @return The image orientation @ref Elm_Image_Orient
5659     *
5660     * @see elm_image_orient_set()
5661     * @see @ref Elm_Image_Orient
5662     *
5663     * @ingroup Image
5664     */
5665    EAPI Elm_Image_Orient elm_image_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5666    /**
5667     * Make the image 'editable'.
5668     *
5669     * @param obj Image object.
5670     * @param set Turn on or off editability. Default is @c EINA_FALSE.
5671     *
5672     * This means the image is a valid drag target for drag and drop, and can be
5673     * cut or pasted too.
5674     *
5675     * @ingroup Image
5676     */
5677    EAPI void             elm_image_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
5678    /**
5679     * Check if the image 'editable'.
5680     *
5681     * @param obj Image object.
5682     * @return Editability.
5683     *
5684     * A return value of EINA_TRUE means the image is a valid drag target
5685     * for drag and drop, and can be cut or pasted too.
5686     *
5687     * @ingroup Image
5688     */
5689    EAPI Eina_Bool        elm_image_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5690    /**
5691     * Get the basic Evas_Image object from this object (widget).
5692     *
5693     * @param obj The image object to get the inlined image from
5694     * @return The inlined image object, or NULL if none exists
5695     *
5696     * This function allows one to get the underlying @c Evas_Object of type
5697     * Image from this elementary widget. It can be useful to do things like get
5698     * the pixel data, save the image to a file, etc.
5699     *
5700     * @note Be careful to not manipulate it, as it is under control of
5701     * elementary.
5702     *
5703     * @ingroup Image
5704     */
5705    EAPI Evas_Object     *elm_image_object_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5706    /**
5707     * Set whether the original aspect ratio of the image should be kept on resize.
5708     *
5709     * @param obj The image object.
5710     * @param retained @c EINA_TRUE if the image should retain the aspect,
5711     * @c EINA_FALSE otherwise.
5712     *
5713     * The original aspect ratio (width / height) of the image is usually
5714     * distorted to match the object's size. Enabling this option will retain
5715     * this original aspect, and the way that the image is fit into the object's
5716     * area depends on the option set by elm_image_fill_outside_set().
5717     *
5718     * @see elm_image_aspect_ratio_retained_get()
5719     * @see elm_image_fill_outside_set()
5720     *
5721     * @ingroup Image
5722     */
5723    EAPI void             elm_image_aspect_ratio_retained_set(Evas_Object *obj, Eina_Bool retained) EINA_ARG_NONNULL(1);
5724    /**
5725     * Get if the object retains the original aspect ratio.
5726     *
5727     * @param obj The image object.
5728     * @return @c EINA_TRUE if the object keeps the original aspect, @c EINA_FALSE
5729     * otherwise.
5730     *
5731     * @ingroup Image
5732     */
5733    EAPI Eina_Bool        elm_image_aspect_ratio_retained_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5734
5735    /**
5736     * @}
5737     */
5738
5739    /* glview */
5740    typedef void (*Elm_GLView_Func_Cb)(Evas_Object *obj);
5741
5742    /* old API compatibility */
5743    typedef Elm_GLView_Func_Cb Elm_GLView_Func;
5744
5745    typedef enum _Elm_GLView_Mode
5746      {
5747         ELM_GLVIEW_ALPHA   = 1,
5748         ELM_GLVIEW_DEPTH   = 2,
5749         ELM_GLVIEW_STENCIL = 4
5750      } Elm_GLView_Mode;
5751
5752    /**
5753     * Defines a policy for the glview resizing.
5754     *
5755     * @note Default is ELM_GLVIEW_RESIZE_POLICY_RECREATE
5756     */
5757    typedef enum _Elm_GLView_Resize_Policy
5758      {
5759         ELM_GLVIEW_RESIZE_POLICY_RECREATE = 1,      /**< Resize the internal surface along with the image */
5760         ELM_GLVIEW_RESIZE_POLICY_SCALE    = 2       /**< Only reize the internal image and not the surface */
5761      } Elm_GLView_Resize_Policy;
5762
5763    typedef enum _Elm_GLView_Render_Policy
5764      {
5765         ELM_GLVIEW_RENDER_POLICY_ON_DEMAND = 1,     /**< Render only when there is a need for redrawing */
5766         ELM_GLVIEW_RENDER_POLICY_ALWAYS    = 2      /**< Render always even when it is not visible */
5767      } Elm_GLView_Render_Policy;
5768
5769    /**
5770     * @defgroup GLView
5771     *
5772     * A simple GLView widget that allows GL rendering.
5773     *
5774     * Signals that you can add callbacks for are:
5775     *
5776     * @{
5777     */
5778
5779    /**
5780     * Add a new glview to the parent
5781     *
5782     * @param parent The parent object
5783     * @return The new object or NULL if it cannot be created
5784     *
5785     * @ingroup GLView
5786     */
5787    EAPI Evas_Object     *elm_glview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5788
5789    /**
5790     * Sets the size of the glview
5791     *
5792     * @param obj The glview object
5793     * @param width width of the glview object
5794     * @param height height of the glview object
5795     *
5796     * @ingroup GLView
5797     */
5798    EAPI void             elm_glview_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
5799
5800    /**
5801     * Gets the size of the glview.
5802     *
5803     * @param obj The glview object
5804     * @param width width of the glview object
5805     * @param height height of the glview object
5806     *
5807     * Note that this function returns the actual image size of the
5808     * glview.  This means that when the scale policy is set to
5809     * ELM_GLVIEW_RESIZE_POLICY_SCALE, it'll return the non-scaled
5810     * size.
5811     *
5812     * @ingroup GLView
5813     */
5814    EAPI void             elm_glview_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
5815
5816    /**
5817     * Gets the gl api struct for gl rendering
5818     *
5819     * @param obj The glview object
5820     * @return The api object or NULL if it cannot be created
5821     *
5822     * @ingroup GLView
5823     */
5824    EAPI Evas_GL_API     *elm_glview_gl_api_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5825
5826    /**
5827     * Set the mode of the GLView. Supports Three simple modes.
5828     *
5829     * @param obj The glview object
5830     * @param mode The mode Options OR'ed enabling Alpha, Depth, Stencil.
5831     * @return True if set properly.
5832     *
5833     * @ingroup GLView
5834     */
5835    EAPI Eina_Bool        elm_glview_mode_set(Evas_Object *obj, Elm_GLView_Mode mode) EINA_ARG_NONNULL(1);
5836
5837    /**
5838     * Set the resize policy for the glview object.
5839     *
5840     * @param obj The glview object.
5841     * @param policy The scaling policy.
5842     *
5843     * By default, the resize policy is set to
5844     * ELM_GLVIEW_RESIZE_POLICY_RECREATE.  When resize is called it
5845     * destroys the previous surface and recreates the newly specified
5846     * size. If the policy is set to ELM_GLVIEW_RESIZE_POLICY_SCALE,
5847     * however, glview only scales the image object and not the underlying
5848     * GL Surface.
5849     *
5850     * @ingroup GLView
5851     */
5852    EAPI Eina_Bool        elm_glview_resize_policy_set(Evas_Object *obj, Elm_GLView_Resize_Policy policy) EINA_ARG_NONNULL(1);
5853
5854    /**
5855     * Set the render policy for the glview object.
5856     *
5857     * @param obj The glview object.
5858     * @param policy The render policy.
5859     *
5860     * By default, the render policy is set to
5861     * ELM_GLVIEW_RENDER_POLICY_ON_DEMAND.  This policy is set such
5862     * that during the render loop, glview is only redrawn if it needs
5863     * to be redrawn. (i.e. When it is visible) If the policy is set to
5864     * ELM_GLVIEWW_RENDER_POLICY_ALWAYS, it redraws regardless of
5865     * whether it is visible/need redrawing or not.
5866     *
5867     * @ingroup GLView
5868     */
5869    EAPI Eina_Bool        elm_glview_render_policy_set(Evas_Object *obj, Elm_GLView_Render_Policy policy) EINA_ARG_NONNULL(1);
5870
5871    /**
5872     * Set the init function that runs once in the main loop.
5873     *
5874     * @param obj The glview object.
5875     * @param func The init function to be registered.
5876     *
5877     * The registered init function gets called once during the render loop.
5878     *
5879     * @ingroup GLView
5880     */
5881    EAPI void             elm_glview_init_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5882
5883    /**
5884     * Set the render function that runs in the main loop.
5885     *
5886     * @param obj The glview object.
5887     * @param func The delete function to be registered.
5888     *
5889     * The registered del function gets called when GLView object is deleted.
5890     *
5891     * @ingroup GLView
5892     */
5893    EAPI void             elm_glview_del_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5894
5895    /**
5896     * Set the resize function that gets called when resize happens.
5897     *
5898     * @param obj The glview object.
5899     * @param func The resize function to be registered.
5900     *
5901     * @ingroup GLView
5902     */
5903    EAPI void             elm_glview_resize_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5904
5905    /**
5906     * Set the render function that runs in the main loop.
5907     *
5908     * @param obj The glview object.
5909     * @param func The render function to be registered.
5910     *
5911     * @ingroup GLView
5912     */
5913    EAPI void             elm_glview_render_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5914
5915    /**
5916     * Notifies that there has been changes in the GLView.
5917     *
5918     * @param obj The glview object.
5919     *
5920     * @ingroup GLView
5921     */
5922    EAPI void             elm_glview_changed_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
5923
5924    /**
5925     * @}
5926     */
5927
5928    /* box */
5929    /**
5930     * @defgroup Box Box
5931     *
5932     * @image html img/widget/box/preview-00.png
5933     * @image latex img/widget/box/preview-00.eps width=\textwidth
5934     *
5935     * @image html img/box.png
5936     * @image latex img/box.eps width=\textwidth
5937     *
5938     * A box arranges objects in a linear fashion, governed by a layout function
5939     * that defines the details of this arrangement.
5940     *
5941     * By default, the box will use an internal function to set the layout to
5942     * a single row, either vertical or horizontal. This layout is affected
5943     * by a number of parameters, such as the homogeneous flag set by
5944     * elm_box_homogeneous_set(), the values given by elm_box_padding_set() and
5945     * elm_box_align_set() and the hints set to each object in the box.
5946     *
5947     * For this default layout, it's possible to change the orientation with
5948     * elm_box_horizontal_set(). The box will start in the vertical orientation,
5949     * placing its elements ordered from top to bottom. When horizontal is set,
5950     * the order will go from left to right. If the box is set to be
5951     * homogeneous, every object in it will be assigned the same space, that
5952     * of the largest object. Padding can be used to set some spacing between
5953     * the cell given to each object. The alignment of the box, set with
5954     * elm_box_align_set(), determines how the bounding box of all the elements
5955     * will be placed within the space given to the box widget itself.
5956     *
5957     * The size hints of each object also affect how they are placed and sized
5958     * within the box. evas_object_size_hint_min_set() will give the minimum
5959     * size the object can have, and the box will use it as the basis for all
5960     * latter calculations. Elementary widgets set their own minimum size as
5961     * needed, so there's rarely any need to use it manually.
5962     *
5963     * evas_object_size_hint_weight_set(), when not in homogeneous mode, is
5964     * used to tell whether the object will be allocated the minimum size it
5965     * needs or if the space given to it should be expanded. It's important
5966     * to realize that expanding the size given to the object is not the same
5967     * thing as resizing the object. It could very well end being a small
5968     * widget floating in a much larger empty space. If not set, the weight
5969     * for objects will normally be 0.0 for both axis, meaning the widget will
5970     * not be expanded. To take as much space possible, set the weight to
5971     * EVAS_HINT_EXPAND (defined to 1.0) for the desired axis to expand.
5972     *
5973     * Besides how much space each object is allocated, it's possible to control
5974     * how the widget will be placed within that space using
5975     * evas_object_size_hint_align_set(). By default, this value will be 0.5
5976     * for both axis, meaning the object will be centered, but any value from
5977     * 0.0 (left or top, for the @c x and @c y axis, respectively) to 1.0
5978     * (right or bottom) can be used. The special value EVAS_HINT_FILL, which
5979     * is -1.0, means the object will be resized to fill the entire space it
5980     * was allocated.
5981     *
5982     * In addition, customized functions to define the layout can be set, which
5983     * allow the application developer to organize the objects within the box
5984     * in any number of ways.
5985     *
5986     * The special elm_box_layout_transition() function can be used
5987     * to switch from one layout to another, animating the motion of the
5988     * children of the box.
5989     *
5990     * @note Objects should not be added to box objects using _add() calls.
5991     *
5992     * Some examples on how to use boxes follow:
5993     * @li @ref box_example_01
5994     * @li @ref box_example_02
5995     *
5996     * @{
5997     */
5998    /**
5999     * @typedef Elm_Box_Transition
6000     *
6001     * Opaque handler containing the parameters to perform an animated
6002     * transition of the layout the box uses.
6003     *
6004     * @see elm_box_transition_new()
6005     * @see elm_box_layout_set()
6006     * @see elm_box_layout_transition()
6007     */
6008    typedef struct _Elm_Box_Transition Elm_Box_Transition;
6009
6010    /**
6011     * Add a new box to the parent
6012     *
6013     * By default, the box will be in vertical mode and non-homogeneous.
6014     *
6015     * @param parent The parent object
6016     * @return The new object or NULL if it cannot be created
6017     */
6018    EAPI Evas_Object        *elm_box_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6019    /**
6020     * Set the horizontal orientation
6021     *
6022     * By default, box object arranges their contents vertically from top to
6023     * bottom.
6024     * By calling this function with @p horizontal as EINA_TRUE, the box will
6025     * become horizontal, arranging contents from left to right.
6026     *
6027     * @note This flag is ignored if a custom layout function is set.
6028     *
6029     * @param obj The box object
6030     * @param horizontal The horizontal flag (EINA_TRUE = horizontal,
6031     * EINA_FALSE = vertical)
6032     */
6033    EAPI void                elm_box_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
6034    /**
6035     * Get the horizontal orientation
6036     *
6037     * @param obj The box object
6038     * @return EINA_TRUE if the box is set to horizontal mode, EINA_FALSE otherwise
6039     */
6040    EAPI Eina_Bool           elm_box_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6041    /**
6042     * Set the box to arrange its children homogeneously
6043     *
6044     * If enabled, homogeneous layout makes all items the same size, according
6045     * to the size of the largest of its children.
6046     *
6047     * @note This flag is ignored if a custom layout function is set.
6048     *
6049     * @param obj The box object
6050     * @param homogeneous The homogeneous flag
6051     */
6052    EAPI void                elm_box_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
6053    /**
6054     * Get whether the box is using homogeneous mode or not
6055     *
6056     * @param obj The box object
6057     * @return EINA_TRUE if it's homogeneous, EINA_FALSE otherwise
6058     */
6059    EAPI Eina_Bool           elm_box_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6060    EINA_DEPRECATED EAPI void elm_box_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
6061    EINA_DEPRECATED EAPI Eina_Bool elm_box_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6062    /**
6063     * Add an object to the beginning of the pack list
6064     *
6065     * Pack @p subobj into the box @p obj, placing it first in the list of
6066     * children objects. The actual position the object will get on screen
6067     * depends on the layout used. If no custom layout is set, it will be at
6068     * the top or left, depending if the box is vertical or horizontal,
6069     * respectively.
6070     *
6071     * @param obj The box object
6072     * @param subobj The object to add to the box
6073     *
6074     * @see elm_box_pack_end()
6075     * @see elm_box_pack_before()
6076     * @see elm_box_pack_after()
6077     * @see elm_box_unpack()
6078     * @see elm_box_unpack_all()
6079     * @see elm_box_clear()
6080     */
6081    EAPI void                elm_box_pack_start(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
6082    /**
6083     * Add an object at the end of the pack list
6084     *
6085     * Pack @p subobj into the box @p obj, placing it last in the list of
6086     * children objects. The actual position the object will get on screen
6087     * depends on the layout used. If no custom layout is set, it will be at
6088     * the bottom or right, depending if the box is vertical or horizontal,
6089     * respectively.
6090     *
6091     * @param obj The box object
6092     * @param subobj The object to add to the box
6093     *
6094     * @see elm_box_pack_start()
6095     * @see elm_box_pack_before()
6096     * @see elm_box_pack_after()
6097     * @see elm_box_unpack()
6098     * @see elm_box_unpack_all()
6099     * @see elm_box_clear()
6100     */
6101    EAPI void                elm_box_pack_end(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
6102    /**
6103     * Adds an object to the box before the indicated object
6104     *
6105     * This will add the @p subobj to the box indicated before the object
6106     * indicated with @p before. If @p before is not already in the box, results
6107     * are undefined. Before means either to the left of the indicated object or
6108     * above it depending on orientation.
6109     *
6110     * @param obj The box object
6111     * @param subobj The object to add to the box
6112     * @param before The object before which to add it
6113     *
6114     * @see elm_box_pack_start()
6115     * @see elm_box_pack_end()
6116     * @see elm_box_pack_after()
6117     * @see elm_box_unpack()
6118     * @see elm_box_unpack_all()
6119     * @see elm_box_clear()
6120     */
6121    EAPI void                elm_box_pack_before(Evas_Object *obj, Evas_Object *subobj, Evas_Object *before) EINA_ARG_NONNULL(1);
6122    /**
6123     * Adds an object to the box after the indicated object
6124     *
6125     * This will add the @p subobj to the box indicated after the object
6126     * indicated with @p after. If @p after is not already in the box, results
6127     * are undefined. After means either to the right of the indicated object or
6128     * below it depending on orientation.
6129     *
6130     * @param obj The box object
6131     * @param subobj The object to add to the box
6132     * @param after The object after which to add it
6133     *
6134     * @see elm_box_pack_start()
6135     * @see elm_box_pack_end()
6136     * @see elm_box_pack_before()
6137     * @see elm_box_unpack()
6138     * @see elm_box_unpack_all()
6139     * @see elm_box_clear()
6140     */
6141    EAPI void                elm_box_pack_after(Evas_Object *obj, Evas_Object *subobj, Evas_Object *after) EINA_ARG_NONNULL(1);
6142    /**
6143     * Clear the box of all children
6144     *
6145     * Remove all the elements contained by the box, deleting the respective
6146     * objects.
6147     *
6148     * @param obj The box object
6149     *
6150     * @see elm_box_unpack()
6151     * @see elm_box_unpack_all()
6152     */
6153    EAPI void                elm_box_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
6154    /**
6155     * Unpack a box item
6156     *
6157     * Remove the object given by @p subobj from the box @p obj without
6158     * deleting it.
6159     *
6160     * @param obj The box object
6161     *
6162     * @see elm_box_unpack_all()
6163     * @see elm_box_clear()
6164     */
6165    EAPI void                elm_box_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
6166    /**
6167     * Remove all items from the box, without deleting them
6168     *
6169     * Clear the box from all children, but don't delete the respective objects.
6170     * If no other references of the box children exist, the objects will never
6171     * be deleted, and thus the application will leak the memory. Make sure
6172     * when using this function that you hold a reference to all the objects
6173     * in the box @p obj.
6174     *
6175     * @param obj The box object
6176     *
6177     * @see elm_box_clear()
6178     * @see elm_box_unpack()
6179     */
6180    EAPI void                elm_box_unpack_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
6181    /**
6182     * Retrieve a list of the objects packed into the box
6183     *
6184     * Returns a new @c Eina_List with a pointer to @c Evas_Object in its nodes.
6185     * The order of the list corresponds to the packing order the box uses.
6186     *
6187     * You must free this list with eina_list_free() once you are done with it.
6188     *
6189     * @param obj The box object
6190     */
6191    EAPI const Eina_List    *elm_box_children_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6192    /**
6193     * Set the space (padding) between the box's elements.
6194     *
6195     * Extra space in pixels that will be added between a box child and its
6196     * neighbors after its containing cell has been calculated. This padding
6197     * is set for all elements in the box, besides any possible padding that
6198     * individual elements may have through their size hints.
6199     *
6200     * @param obj The box object
6201     * @param horizontal The horizontal space between elements
6202     * @param vertical The vertical space between elements
6203     */
6204    EAPI void                elm_box_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
6205    /**
6206     * Get the space (padding) between the box's elements.
6207     *
6208     * @param obj The box object
6209     * @param horizontal The horizontal space between elements
6210     * @param vertical The vertical space between elements
6211     *
6212     * @see elm_box_padding_set()
6213     */
6214    EAPI void                elm_box_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
6215    /**
6216     * Set the alignment of the whole bouding box of contents.
6217     *
6218     * Sets how the bounding box containing all the elements of the box, after
6219     * their sizes and position has been calculated, will be aligned within
6220     * the space given for the whole box widget.
6221     *
6222     * @param obj The box object
6223     * @param horizontal The horizontal alignment of elements
6224     * @param vertical The vertical alignment of elements
6225     */
6226    EAPI void                elm_box_align_set(Evas_Object *obj, double horizontal, double vertical) EINA_ARG_NONNULL(1);
6227    /**
6228     * Get the alignment of the whole bouding box of contents.
6229     *
6230     * @param obj The box object
6231     * @param horizontal The horizontal alignment of elements
6232     * @param vertical The vertical alignment of elements
6233     *
6234     * @see elm_box_align_set()
6235     */
6236    EAPI void                elm_box_align_get(const Evas_Object *obj, double *horizontal, double *vertical) EINA_ARG_NONNULL(1);
6237
6238    /**
6239     * Force the box to recalculate its children packing.
6240     *
6241     * If any children was added or removed, box will not calculate the
6242     * values immediately rather leaving it to the next main loop
6243     * iteration. While this is great as it would save lots of
6244     * recalculation, whenever you need to get the position of a just
6245     * added item you must force recalculate before doing so.
6246     *
6247     * @param obj The box object.
6248     */
6249    EAPI void                 elm_box_recalculate(Evas_Object *obj);
6250
6251    /**
6252     * Set the layout defining function to be used by the box
6253     *
6254     * Whenever anything changes that requires the box in @p obj to recalculate
6255     * the size and position of its elements, the function @p cb will be called
6256     * to determine what the layout of the children will be.
6257     *
6258     * Once a custom function is set, everything about the children layout
6259     * is defined by it. The flags set by elm_box_horizontal_set() and
6260     * elm_box_homogeneous_set() no longer have any meaning, and the values
6261     * given by elm_box_padding_set() and elm_box_align_set() are up to this
6262     * layout function to decide if they are used and how. These last two
6263     * will be found in the @c priv parameter, of type @c Evas_Object_Box_Data,
6264     * passed to @p cb. The @c Evas_Object the function receives is not the
6265     * Elementary widget, but the internal Evas Box it uses, so none of the
6266     * functions described here can be used on it.
6267     *
6268     * Any of the layout functions in @c Evas can be used here, as well as the
6269     * special elm_box_layout_transition().
6270     *
6271     * The final @p data argument received by @p cb is the same @p data passed
6272     * here, and the @p free_data function will be called to free it
6273     * whenever the box is destroyed or another layout function is set.
6274     *
6275     * Setting @p cb to NULL will revert back to the default layout function.
6276     *
6277     * @param obj The box object
6278     * @param cb The callback function used for layout
6279     * @param data Data that will be passed to layout function
6280     * @param free_data Function called to free @p data
6281     *
6282     * @see elm_box_layout_transition()
6283     */
6284    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);
6285    /**
6286     * Special layout function that animates the transition from one layout to another
6287     *
6288     * Normally, when switching the layout function for a box, this will be
6289     * reflected immediately on screen on the next render, but it's also
6290     * possible to do this through an animated transition.
6291     *
6292     * This is done by creating an ::Elm_Box_Transition and setting the box
6293     * layout to this function.
6294     *
6295     * For example:
6296     * @code
6297     * Elm_Box_Transition *t = elm_box_transition_new(1.0,
6298     *                            evas_object_box_layout_vertical, // start
6299     *                            NULL, // data for initial layout
6300     *                            NULL, // free function for initial data
6301     *                            evas_object_box_layout_horizontal, // end
6302     *                            NULL, // data for final layout
6303     *                            NULL, // free function for final data
6304     *                            anim_end, // will be called when animation ends
6305     *                            NULL); // data for anim_end function\
6306     * elm_box_layout_set(box, elm_box_layout_transition, t,
6307     *                    elm_box_transition_free);
6308     * @endcode
6309     *
6310     * @note This function can only be used with elm_box_layout_set(). Calling
6311     * it directly will not have the expected results.
6312     *
6313     * @see elm_box_transition_new
6314     * @see elm_box_transition_free
6315     * @see elm_box_layout_set
6316     */
6317    EAPI void                elm_box_layout_transition(Evas_Object *obj, Evas_Object_Box_Data *priv, void *data);
6318    /**
6319     * Create a new ::Elm_Box_Transition to animate the switch of layouts
6320     *
6321     * If you want to animate the change from one layout to another, you need
6322     * to set the layout function of the box to elm_box_layout_transition(),
6323     * passing as user data to it an instance of ::Elm_Box_Transition with the
6324     * necessary information to perform this animation. The free function to
6325     * set for the layout is elm_box_transition_free().
6326     *
6327     * The parameters to create an ::Elm_Box_Transition sum up to how long
6328     * will it be, in seconds, a layout function to describe the initial point,
6329     * another for the final position of the children and one function to be
6330     * called when the whole animation ends. This last function is useful to
6331     * set the definitive layout for the box, usually the same as the end
6332     * layout for the animation, but could be used to start another transition.
6333     *
6334     * @param start_layout The layout function that will be used to start the animation
6335     * @param start_layout_data The data to be passed the @p start_layout function
6336     * @param start_layout_free_data Function to free @p start_layout_data
6337     * @param end_layout The layout function that will be used to end the animation
6338     * @param end_layout_free_data The data to be passed the @p end_layout function
6339     * @param end_layout_free_data Function to free @p end_layout_data
6340     * @param transition_end_cb Callback function called when animation ends
6341     * @param transition_end_data Data to be passed to @p transition_end_cb
6342     * @return An instance of ::Elm_Box_Transition
6343     *
6344     * @see elm_box_transition_new
6345     * @see elm_box_layout_transition
6346     */
6347    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);
6348    /**
6349     * Free a Elm_Box_Transition instance created with elm_box_transition_new().
6350     *
6351     * This function is mostly useful as the @c free_data parameter in
6352     * elm_box_layout_set() when elm_box_layout_transition().
6353     *
6354     * @param data The Elm_Box_Transition instance to be freed.
6355     *
6356     * @see elm_box_transition_new
6357     * @see elm_box_layout_transition
6358     */
6359    EAPI void                elm_box_transition_free(void *data);
6360    /**
6361     * @}
6362     */
6363
6364    /* button */
6365    /**
6366     * @defgroup Button Button
6367     *
6368     * @image html img/widget/button/preview-00.png
6369     * @image latex img/widget/button/preview-00.eps
6370     * @image html img/widget/button/preview-01.png
6371     * @image latex img/widget/button/preview-01.eps
6372     * @image html img/widget/button/preview-02.png
6373     * @image latex img/widget/button/preview-02.eps
6374     *
6375     * This is a push-button. Press it and run some function. It can contain
6376     * a simple label and icon object and it also has an autorepeat feature.
6377     *
6378     * This widgets emits the following signals:
6379     * @li "clicked": the user clicked the button (press/release).
6380     * @li "repeated": the user pressed the button without releasing it.
6381     * @li "pressed": button was pressed.
6382     * @li "unpressed": button was released after being pressed.
6383     * In all three cases, the @c event parameter of the callback will be
6384     * @c NULL.
6385     *
6386     * Also, defined in the default theme, the button has the following styles
6387     * available:
6388     * @li default: a normal button.
6389     * @li anchor: Like default, but the button fades away when the mouse is not
6390     * over it, leaving only the text or icon.
6391     * @li hoversel_vertical: Internally used by @ref Hoversel to give a
6392     * continuous look across its options.
6393     * @li hoversel_vertical_entry: Another internal for @ref Hoversel.
6394     *
6395     * Default contents parts of the button widget that you can use for are:
6396     * @li "icon" - A icon of the button
6397     *
6398     * Default text parts of the button widget that you can use for are:
6399     * @li "default" - Label of the button
6400     *
6401     * Follow through a complete example @ref button_example_01 "here".
6402     * @{
6403     */
6404
6405    typedef enum
6406      {
6407         UIControlStateDefault,
6408         UIControlStateHighlighted,
6409         UIControlStateDisabled,
6410         UIControlStateFocused,
6411         UIControlStateReserved
6412      } UIControlState;
6413
6414    /**
6415     * Add a new button to the parent's canvas
6416     *
6417     * @param parent The parent object
6418     * @return The new object or NULL if it cannot be created
6419     */
6420    EAPI Evas_Object *elm_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6421    /**
6422     * Set the label used in the button
6423     *
6424     * The passed @p label can be NULL to clean any existing text in it and
6425     * leave the button as an icon only object.
6426     *
6427     * @param obj The button object
6428     * @param label The text will be written on the button
6429     * @deprecated use elm_object_text_set() instead.
6430     */
6431    EINA_DEPRECATED EAPI void         elm_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6432    /**
6433     * Get the label set for the button
6434     *
6435     * The string returned is an internal pointer and should not be freed or
6436     * altered. It will also become invalid when the button is destroyed.
6437     * The string returned, if not NULL, is a stringshare, so if you need to
6438     * keep it around even after the button is destroyed, you can use
6439     * eina_stringshare_ref().
6440     *
6441     * @param obj The button object
6442     * @return The text set to the label, or NULL if nothing is set
6443     * @deprecated use elm_object_text_set() instead.
6444     */
6445    EINA_DEPRECATED EAPI const char  *elm_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6446    /**
6447     * Set the icon used for the button
6448     *
6449     * Setting a new icon will delete any other that was previously set, making
6450     * any reference to them invalid. If you need to maintain the previous
6451     * object alive, unset it first with elm_button_icon_unset().
6452     *
6453     * @param obj The button object
6454     * @param icon The icon object for the button
6455     * @deprecated use elm_object_part_content_set() instead.
6456     */
6457    WILL_DEPRECATE  EAPI void         elm_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6458    /**
6459     * Get the icon used for the button
6460     *
6461     * Return the icon object which is set for this widget. If the button is
6462     * destroyed or another icon is set, the returned object will be deleted
6463     * and any reference to it will be invalid.
6464     *
6465     * @param obj The button object
6466     * @return The icon object that is being used
6467     *
6468     * @deprecated use elm_object_part_content_get() instead
6469     */
6470    WILL_DEPRECATE  EAPI Evas_Object *elm_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6471    /**
6472     * Remove the icon set without deleting it and return the object
6473     *
6474     * This function drops the reference the button holds of the icon object
6475     * and returns this last object. It is used in case you want to remove any
6476     * icon, or set another one, without deleting the actual object. The button
6477     * will be left without an icon set.
6478     *
6479     * @param obj The button object
6480     * @return The icon object that was being used
6481     * @deprecated use elm_object_part_content_unset() instead.
6482     */
6483    WILL_DEPRECATE  EAPI Evas_Object *elm_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6484    /**
6485     * Turn on/off the autorepeat event generated when the button is kept pressed
6486     *
6487     * When off, no autorepeat is performed and buttons emit a normal @c clicked
6488     * signal when they are clicked.
6489     *
6490     * When on, keeping a button pressed will continuously emit a @c repeated
6491     * signal until the button is released. The time it takes until it starts
6492     * emitting the signal is given by
6493     * elm_button_autorepeat_initial_timeout_set(), and the time between each
6494     * new emission by elm_button_autorepeat_gap_timeout_set().
6495     *
6496     * @param obj The button object
6497     * @param on  A bool to turn on/off the event
6498     */
6499    EAPI void         elm_button_autorepeat_set(Evas_Object *obj, Eina_Bool on) EINA_ARG_NONNULL(1);
6500    /**
6501     * Get whether the autorepeat feature is enabled
6502     *
6503     * @param obj The button object
6504     * @return EINA_TRUE if autorepeat is on, EINA_FALSE otherwise
6505     *
6506     * @see elm_button_autorepeat_set()
6507     */
6508    EAPI Eina_Bool    elm_button_autorepeat_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6509    /**
6510     * Set the initial timeout before the autorepeat event is generated
6511     *
6512     * Sets the timeout, in seconds, since the button is pressed until the
6513     * first @c repeated signal is emitted. If @p t is 0.0 or less, there
6514     * won't be any delay and the even will be fired the moment the button is
6515     * pressed.
6516     *
6517     * @param obj The button object
6518     * @param t   Timeout in seconds
6519     *
6520     * @see elm_button_autorepeat_set()
6521     * @see elm_button_autorepeat_gap_timeout_set()
6522     */
6523    EAPI void         elm_button_autorepeat_initial_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
6524    /**
6525     * Get the initial timeout before the autorepeat event is generated
6526     *
6527     * @param obj The button object
6528     * @return Timeout in seconds
6529     *
6530     * @see elm_button_autorepeat_initial_timeout_set()
6531     */
6532    EAPI double       elm_button_autorepeat_initial_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6533    /**
6534     * Set the interval between each generated autorepeat event
6535     *
6536     * After the first @c repeated event is fired, all subsequent ones will
6537     * follow after a delay of @p t seconds for each.
6538     *
6539     * @param obj The button object
6540     * @param t   Interval in seconds
6541     *
6542     * @see elm_button_autorepeat_initial_timeout_set()
6543     */
6544    EAPI void         elm_button_autorepeat_gap_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
6545    /**
6546     * Get the interval between each generated autorepeat event
6547     *
6548     * @param obj The button object
6549     * @return Interval in seconds
6550     */
6551    EAPI double       elm_button_autorepeat_gap_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6552    /**
6553     * @}
6554     */
6555
6556    /**
6557     * @defgroup File_Selector_Button File Selector Button
6558     *
6559     * @image html img/widget/fileselector_button/preview-00.png
6560     * @image latex img/widget/fileselector_button/preview-00.eps
6561     * @image html img/widget/fileselector_button/preview-01.png
6562     * @image latex img/widget/fileselector_button/preview-01.eps
6563     * @image html img/widget/fileselector_button/preview-02.png
6564     * @image latex img/widget/fileselector_button/preview-02.eps
6565     *
6566     * This is a button that, when clicked, creates an Elementary
6567     * window (or inner window) <b> with a @ref Fileselector "file
6568     * selector widget" within</b>. When a file is chosen, the (inner)
6569     * window is closed and the button emits a signal having the
6570     * selected file as it's @c event_info.
6571     *
6572     * This widget encapsulates operations on its internal file
6573     * selector on its own API. There is less control over its file
6574     * selector than that one would have instatiating one directly.
6575     *
6576     * The following styles are available for this button:
6577     * @li @c "default"
6578     * @li @c "anchor"
6579     * @li @c "hoversel_vertical"
6580     * @li @c "hoversel_vertical_entry"
6581     *
6582     * Smart callbacks one can register to:
6583     * - @c "file,chosen" - the user has selected a path, whose string
6584     *   pointer comes as the @c event_info data (a stringshared
6585     *   string)
6586     *
6587     * Here is an example on its usage:
6588     * @li @ref fileselector_button_example
6589     *
6590     * @see @ref File_Selector_Entry for a similar widget.
6591     * @{
6592     */
6593
6594    /**
6595     * Add a new file selector button widget to the given parent
6596     * Elementary (container) object
6597     *
6598     * @param parent The parent object
6599     * @return a new file selector button widget handle or @c NULL, on
6600     * errors
6601     */
6602    EAPI Evas_Object *elm_fileselector_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6603
6604    /**
6605     * Set the label for a given file selector button widget
6606     *
6607     * @param obj The file selector button widget
6608     * @param label The text label to be displayed on @p obj
6609     *
6610     * @deprecated use elm_object_text_set() instead.
6611     */
6612    EINA_DEPRECATED EAPI void         elm_fileselector_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6613
6614    /**
6615     * Get the label set for a given file selector button widget
6616     *
6617     * @param obj The file selector button widget
6618     * @return The button label
6619     *
6620     * @deprecated use elm_object_text_set() instead.
6621     */
6622    EINA_DEPRECATED EAPI const char  *elm_fileselector_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6623
6624    /**
6625     * Set the icon on a given file selector button widget
6626     *
6627     * @param obj The file selector button widget
6628     * @param icon The icon object for the button
6629     *
6630     * Once the icon object is set, a previously set one will be
6631     * deleted. If you want to keep the latter, use the
6632     * elm_fileselector_button_icon_unset() function.
6633     *
6634     * @see elm_fileselector_button_icon_get()
6635     */
6636    EAPI void         elm_fileselector_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6637
6638    /**
6639     * Get the icon set for a given file selector button widget
6640     *
6641     * @param obj The file selector button widget
6642     * @return The icon object currently set on @p obj or @c NULL, if
6643     * none is
6644     *
6645     * @see elm_fileselector_button_icon_set()
6646     */
6647    EAPI Evas_Object *elm_fileselector_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6648
6649    /**
6650     * Unset the icon used in a given file selector button widget
6651     *
6652     * @param obj The file selector button widget
6653     * @return The icon object that was being used on @p obj or @c
6654     * NULL, on errors
6655     *
6656     * Unparent and return the icon object which was set for this
6657     * widget.
6658     *
6659     * @see elm_fileselector_button_icon_set()
6660     */
6661    EAPI Evas_Object *elm_fileselector_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6662
6663    /**
6664     * Set the title for a given file selector button widget's window
6665     *
6666     * @param obj The file selector button widget
6667     * @param title The title string
6668     *
6669     * This will change the window's title, when the file selector pops
6670     * out after a click on the button. Those windows have the default
6671     * (unlocalized) value of @c "Select a file" as titles.
6672     *
6673     * @note It will only take any effect if the file selector
6674     * button widget is @b not under "inwin mode".
6675     *
6676     * @see elm_fileselector_button_window_title_get()
6677     */
6678    EAPI void         elm_fileselector_button_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6679
6680    /**
6681     * Get the title set for a given file selector button widget's
6682     * window
6683     *
6684     * @param obj The file selector button widget
6685     * @return Title of the file selector button's window
6686     *
6687     * @see elm_fileselector_button_window_title_get() for more details
6688     */
6689    EAPI const char  *elm_fileselector_button_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6690
6691    /**
6692     * Set the size of a given file selector button widget's window,
6693     * holding the file selector itself.
6694     *
6695     * @param obj The file selector button widget
6696     * @param width The window's width
6697     * @param height The window's height
6698     *
6699     * @note it will only take any effect if the file selector button
6700     * widget is @b not under "inwin mode". The default size for the
6701     * window (when applicable) is 400x400 pixels.
6702     *
6703     * @see elm_fileselector_button_window_size_get()
6704     */
6705    EAPI void         elm_fileselector_button_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6706
6707    /**
6708     * Get the size of a given file selector button widget's window,
6709     * holding the file selector itself.
6710     *
6711     * @param obj The file selector button widget
6712     * @param width Pointer into which to store the width value
6713     * @param height Pointer into which to store the height value
6714     *
6715     * @note Use @c NULL pointers on the size values you're not
6716     * interested in: they'll be ignored by the function.
6717     *
6718     * @see elm_fileselector_button_window_size_set(), for more details
6719     */
6720    EAPI void         elm_fileselector_button_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6721
6722    /**
6723     * Set the initial file system path for a given file selector
6724     * button widget
6725     *
6726     * @param obj The file selector button widget
6727     * @param path The path string
6728     *
6729     * It must be a <b>directory</b> path, which will have the contents
6730     * displayed initially in the file selector's view, when invoked
6731     * from @p obj. The default initial path is the @c "HOME"
6732     * environment variable's value.
6733     *
6734     * @see elm_fileselector_button_path_get()
6735     */
6736    EAPI void         elm_fileselector_button_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6737
6738    /**
6739     * Get the initial file system path set for a given file selector
6740     * button widget
6741     *
6742     * @param obj The file selector button widget
6743     * @return path The path string
6744     *
6745     * @see elm_fileselector_button_path_set() for more details
6746     */
6747    EAPI const char  *elm_fileselector_button_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6748
6749    /**
6750     * Enable/disable a tree view in the given file selector button
6751     * widget's internal file selector
6752     *
6753     * @param obj The file selector button widget
6754     * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
6755     * disable
6756     *
6757     * This has the same effect as elm_fileselector_expandable_set(),
6758     * but now applied to a file selector button's internal file
6759     * selector.
6760     *
6761     * @note There's no way to put a file selector button's internal
6762     * file selector in "grid mode", as one may do with "pure" file
6763     * selectors.
6764     *
6765     * @see elm_fileselector_expandable_get()
6766     */
6767    EAPI void         elm_fileselector_button_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6768
6769    /**
6770     * Get whether tree view is enabled for the given file selector
6771     * button widget's internal file selector
6772     *
6773     * @param obj The file selector button widget
6774     * @return @c EINA_TRUE if @p obj widget's internal file selector
6775     * is in tree view, @c EINA_FALSE otherwise (and or errors)
6776     *
6777     * @see elm_fileselector_expandable_set() for more details
6778     */
6779    EAPI Eina_Bool    elm_fileselector_button_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6780
6781    /**
6782     * Set whether a given file selector button widget's internal file
6783     * selector is to display folders only or the directory contents,
6784     * as well.
6785     *
6786     * @param obj The file selector button widget
6787     * @param only @c EINA_TRUE to make @p obj widget's internal file
6788     * selector only display directories, @c EINA_FALSE to make files
6789     * to be displayed in it too
6790     *
6791     * This has the same effect as elm_fileselector_folder_only_set(),
6792     * but now applied to a file selector button's internal file
6793     * selector.
6794     *
6795     * @see elm_fileselector_folder_only_get()
6796     */
6797    EAPI void         elm_fileselector_button_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6798
6799    /**
6800     * Get whether a given file selector button widget's internal file
6801     * selector is displaying folders only or the directory contents,
6802     * as well.
6803     *
6804     * @param obj The file selector button widget
6805     * @return @c EINA_TRUE if @p obj widget's internal file
6806     * selector is only displaying directories, @c EINA_FALSE if files
6807     * are being displayed in it too (and on errors)
6808     *
6809     * @see elm_fileselector_button_folder_only_set() for more details
6810     */
6811    EAPI Eina_Bool    elm_fileselector_button_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6812
6813    /**
6814     * Enable/disable the file name entry box where the user can type
6815     * in a name for a file, in a given file selector button widget's
6816     * internal file selector.
6817     *
6818     * @param obj The file selector button widget
6819     * @param is_save @c EINA_TRUE to make @p obj widget's internal
6820     * file selector a "saving dialog", @c EINA_FALSE otherwise
6821     *
6822     * This has the same effect as elm_fileselector_is_save_set(),
6823     * but now applied to a file selector button's internal file
6824     * selector.
6825     *
6826     * @see elm_fileselector_is_save_get()
6827     */
6828    EAPI void         elm_fileselector_button_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6829
6830    /**
6831     * Get whether the given file selector button widget's internal
6832     * file selector is in "saving dialog" mode
6833     *
6834     * @param obj The file selector button widget
6835     * @return @c EINA_TRUE, if @p obj widget's internal file selector
6836     * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
6837     * errors)
6838     *
6839     * @see elm_fileselector_button_is_save_set() for more details
6840     */
6841    EAPI Eina_Bool    elm_fileselector_button_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6842
6843    /**
6844     * Set whether a given file selector button widget's internal file
6845     * selector will raise an Elementary "inner window", instead of a
6846     * dedicated Elementary window. By default, it won't.
6847     *
6848     * @param obj The file selector button widget
6849     * @param value @c EINA_TRUE to make it use an inner window, @c
6850     * EINA_TRUE to make it use a dedicated window
6851     *
6852     * @see elm_win_inwin_add() for more information on inner windows
6853     * @see elm_fileselector_button_inwin_mode_get()
6854     */
6855    EAPI void         elm_fileselector_button_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6856
6857    /**
6858     * Get whether a given file selector button widget's internal file
6859     * selector will raise an Elementary "inner window", instead of a
6860     * dedicated Elementary window.
6861     *
6862     * @param obj The file selector button widget
6863     * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
6864     * if it will use a dedicated window
6865     *
6866     * @see elm_fileselector_button_inwin_mode_set() for more details
6867     */
6868    EAPI Eina_Bool    elm_fileselector_button_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6869
6870    /**
6871     * @}
6872     */
6873
6874     /**
6875     * @defgroup File_Selector_Entry File Selector Entry
6876     *
6877     * @image html img/widget/fileselector_entry/preview-00.png
6878     * @image latex img/widget/fileselector_entry/preview-00.eps
6879     *
6880     * This is an entry made to be filled with or display a <b>file
6881     * system path string</b>. Besides the entry itself, the widget has
6882     * a @ref File_Selector_Button "file selector button" on its side,
6883     * which will raise an internal @ref Fileselector "file selector widget",
6884     * when clicked, for path selection aided by file system
6885     * navigation.
6886     *
6887     * This file selector may appear in an Elementary window or in an
6888     * inner window. When a file is chosen from it, the (inner) window
6889     * is closed and the selected file's path string is exposed both as
6890     * an smart event and as the new text on the entry.
6891     *
6892     * This widget encapsulates operations on its internal file
6893     * selector on its own API. There is less control over its file
6894     * selector than that one would have instatiating one directly.
6895     *
6896     * Smart callbacks one can register to:
6897     * - @c "changed" - The text within the entry was changed
6898     * - @c "activated" - The entry has had editing finished and
6899     *   changes are to be "committed"
6900     * - @c "press" - The entry has been clicked
6901     * - @c "longpressed" - The entry has been clicked (and held) for a
6902     *   couple seconds
6903     * - @c "clicked" - The entry has been clicked
6904     * - @c "clicked,double" - The entry has been double clicked
6905     * - @c "focused" - The entry has received focus
6906     * - @c "unfocused" - The entry has lost focus
6907     * - @c "selection,paste" - A paste action has occurred on the
6908     *   entry
6909     * - @c "selection,copy" - A copy action has occurred on the entry
6910     * - @c "selection,cut" - A cut action has occurred on the entry
6911     * - @c "unpressed" - The file selector entry's button was released
6912     *   after being pressed.
6913     * - @c "file,chosen" - The user has selected a path via the file
6914     *   selector entry's internal file selector, whose string pointer
6915     *   comes as the @c event_info data (a stringshared string)
6916     *
6917     * Here is an example on its usage:
6918     * @li @ref fileselector_entry_example
6919     *
6920     * @see @ref File_Selector_Button for a similar widget.
6921     * @{
6922     */
6923
6924    /**
6925     * Add a new file selector entry widget to the given parent
6926     * Elementary (container) object
6927     *
6928     * @param parent The parent object
6929     * @return a new file selector entry widget handle or @c NULL, on
6930     * errors
6931     */
6932    EAPI Evas_Object *elm_fileselector_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6933
6934    /**
6935     * Set the label for a given file selector entry widget's button
6936     *
6937     * @param obj The file selector entry widget
6938     * @param label The text label to be displayed on @p obj widget's
6939     * button
6940     *
6941     * @deprecated use elm_object_text_set() instead.
6942     */
6943    EINA_DEPRECATED EAPI void         elm_fileselector_entry_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6944
6945    /**
6946     * Get the label set for a given file selector entry widget's button
6947     *
6948     * @param obj The file selector entry widget
6949     * @return The widget button's label
6950     *
6951     * @deprecated use elm_object_text_set() instead.
6952     */
6953    EINA_DEPRECATED EAPI const char  *elm_fileselector_entry_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6954
6955    /**
6956     * Set the icon on a given file selector entry widget's button
6957     *
6958     * @param obj The file selector entry widget
6959     * @param icon The icon object for the entry's button
6960     *
6961     * Once the icon object is set, a previously set one will be
6962     * deleted. If you want to keep the latter, use the
6963     * elm_fileselector_entry_button_icon_unset() function.
6964     *
6965     * @see elm_fileselector_entry_button_icon_get()
6966     */
6967    EAPI void         elm_fileselector_entry_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6968
6969    /**
6970     * Get the icon set for a given file selector entry widget's button
6971     *
6972     * @param obj The file selector entry widget
6973     * @return The icon object currently set on @p obj widget's button
6974     * or @c NULL, if none is
6975     *
6976     * @see elm_fileselector_entry_button_icon_set()
6977     */
6978    EAPI Evas_Object *elm_fileselector_entry_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6979
6980    /**
6981     * Unset the icon used in a given file selector entry widget's
6982     * button
6983     *
6984     * @param obj The file selector entry widget
6985     * @return The icon object that was being used on @p obj widget's
6986     * button or @c NULL, on errors
6987     *
6988     * Unparent and return the icon object which was set for this
6989     * widget's button.
6990     *
6991     * @see elm_fileselector_entry_button_icon_set()
6992     */
6993    EAPI Evas_Object *elm_fileselector_entry_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6994
6995    /**
6996     * Set the title for a given file selector entry widget's window
6997     *
6998     * @param obj The file selector entry widget
6999     * @param title The title string
7000     *
7001     * This will change the window's title, when the file selector pops
7002     * out after a click on the entry's button. Those windows have the
7003     * default (unlocalized) value of @c "Select a file" as titles.
7004     *
7005     * @note It will only take any effect if the file selector
7006     * entry widget is @b not under "inwin mode".
7007     *
7008     * @see elm_fileselector_entry_window_title_get()
7009     */
7010    EAPI void         elm_fileselector_entry_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
7011
7012    /**
7013     * Get the title set for a given file selector entry widget's
7014     * window
7015     *
7016     * @param obj The file selector entry widget
7017     * @return Title of the file selector entry's window
7018     *
7019     * @see elm_fileselector_entry_window_title_get() for more details
7020     */
7021    EAPI const char  *elm_fileselector_entry_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7022
7023    /**
7024     * Set the size of a given file selector entry widget's window,
7025     * holding the file selector itself.
7026     *
7027     * @param obj The file selector entry widget
7028     * @param width The window's width
7029     * @param height The window's height
7030     *
7031     * @note it will only take any effect if the file selector entry
7032     * widget is @b not under "inwin mode". The default size for the
7033     * window (when applicable) is 400x400 pixels.
7034     *
7035     * @see elm_fileselector_entry_window_size_get()
7036     */
7037    EAPI void         elm_fileselector_entry_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
7038
7039    /**
7040     * Get the size of a given file selector entry widget's window,
7041     * holding the file selector itself.
7042     *
7043     * @param obj The file selector entry widget
7044     * @param width Pointer into which to store the width value
7045     * @param height Pointer into which to store the height value
7046     *
7047     * @note Use @c NULL pointers on the size values you're not
7048     * interested in: they'll be ignored by the function.
7049     *
7050     * @see elm_fileselector_entry_window_size_set(), for more details
7051     */
7052    EAPI void         elm_fileselector_entry_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
7053
7054    /**
7055     * Set the initial file system path and the entry's path string for
7056     * a given file selector entry widget
7057     *
7058     * @param obj The file selector entry widget
7059     * @param path The path string
7060     *
7061     * It must be a <b>directory</b> path, which will have the contents
7062     * displayed initially in the file selector's view, when invoked
7063     * from @p obj. The default initial path is the @c "HOME"
7064     * environment variable's value.
7065     *
7066     * @see elm_fileselector_entry_path_get()
7067     */
7068    EAPI void         elm_fileselector_entry_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
7069
7070    /**
7071     * Get the entry's path string for a given file selector entry
7072     * widget
7073     *
7074     * @param obj The file selector entry widget
7075     * @return path The path string
7076     *
7077     * @see elm_fileselector_entry_path_set() for more details
7078     */
7079    EAPI const char  *elm_fileselector_entry_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7080
7081    /**
7082     * Enable/disable a tree view in the given file selector entry
7083     * widget's internal file selector
7084     *
7085     * @param obj The file selector entry widget
7086     * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
7087     * disable
7088     *
7089     * This has the same effect as elm_fileselector_expandable_set(),
7090     * but now applied to a file selector entry's internal file
7091     * selector.
7092     *
7093     * @note There's no way to put a file selector entry's internal
7094     * file selector in "grid mode", as one may do with "pure" file
7095     * selectors.
7096     *
7097     * @see elm_fileselector_expandable_get()
7098     */
7099    EAPI void         elm_fileselector_entry_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
7100
7101    /**
7102     * Get whether tree view is enabled for the given file selector
7103     * entry widget's internal file selector
7104     *
7105     * @param obj The file selector entry widget
7106     * @return @c EINA_TRUE if @p obj widget's internal file selector
7107     * is in tree view, @c EINA_FALSE otherwise (and or errors)
7108     *
7109     * @see elm_fileselector_expandable_set() for more details
7110     */
7111    EAPI Eina_Bool    elm_fileselector_entry_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7112
7113    /**
7114     * Set whether a given file selector entry widget's internal file
7115     * selector is to display folders only or the directory contents,
7116     * as well.
7117     *
7118     * @param obj The file selector entry widget
7119     * @param only @c EINA_TRUE to make @p obj widget's internal file
7120     * selector only display directories, @c EINA_FALSE to make files
7121     * to be displayed in it too
7122     *
7123     * This has the same effect as elm_fileselector_folder_only_set(),
7124     * but now applied to a file selector entry's internal file
7125     * selector.
7126     *
7127     * @see elm_fileselector_folder_only_get()
7128     */
7129    EAPI void         elm_fileselector_entry_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
7130
7131    /**
7132     * Get whether a given file selector entry widget's internal file
7133     * selector is displaying folders only or the directory contents,
7134     * as well.
7135     *
7136     * @param obj The file selector entry widget
7137     * @return @c EINA_TRUE if @p obj widget's internal file
7138     * selector is only displaying directories, @c EINA_FALSE if files
7139     * are being displayed in it too (and on errors)
7140     *
7141     * @see elm_fileselector_entry_folder_only_set() for more details
7142     */
7143    EAPI Eina_Bool    elm_fileselector_entry_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7144
7145    /**
7146     * Enable/disable the file name entry box where the user can type
7147     * in a name for a file, in a given file selector entry widget's
7148     * internal file selector.
7149     *
7150     * @param obj The file selector entry widget
7151     * @param is_save @c EINA_TRUE to make @p obj widget's internal
7152     * file selector a "saving dialog", @c EINA_FALSE otherwise
7153     *
7154     * This has the same effect as elm_fileselector_is_save_set(),
7155     * but now applied to a file selector entry's internal file
7156     * selector.
7157     *
7158     * @see elm_fileselector_is_save_get()
7159     */
7160    EAPI void         elm_fileselector_entry_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
7161
7162    /**
7163     * Get whether the given file selector entry widget's internal
7164     * file selector is in "saving dialog" mode
7165     *
7166     * @param obj The file selector entry widget
7167     * @return @c EINA_TRUE, if @p obj widget's internal file selector
7168     * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
7169     * errors)
7170     *
7171     * @see elm_fileselector_entry_is_save_set() for more details
7172     */
7173    EAPI Eina_Bool    elm_fileselector_entry_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7174
7175    /**
7176     * Set whether a given file selector entry widget's internal file
7177     * selector will raise an Elementary "inner window", instead of a
7178     * dedicated Elementary window. By default, it won't.
7179     *
7180     * @param obj The file selector entry widget
7181     * @param value @c EINA_TRUE to make it use an inner window, @c
7182     * EINA_TRUE to make it use a dedicated window
7183     *
7184     * @see elm_win_inwin_add() for more information on inner windows
7185     * @see elm_fileselector_entry_inwin_mode_get()
7186     */
7187    EAPI void         elm_fileselector_entry_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
7188
7189    /**
7190     * Get whether a given file selector entry widget's internal file
7191     * selector will raise an Elementary "inner window", instead of a
7192     * dedicated Elementary window.
7193     *
7194     * @param obj The file selector entry widget
7195     * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
7196     * if it will use a dedicated window
7197     *
7198     * @see elm_fileselector_entry_inwin_mode_set() for more details
7199     */
7200    EAPI Eina_Bool    elm_fileselector_entry_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7201
7202    /**
7203     * Set the initial file system path for a given file selector entry
7204     * widget
7205     *
7206     * @param obj The file selector entry widget
7207     * @param path The path string
7208     *
7209     * It must be a <b>directory</b> path, which will have the contents
7210     * displayed initially in the file selector's view, when invoked
7211     * from @p obj. The default initial path is the @c "HOME"
7212     * environment variable's value.
7213     *
7214     * @see elm_fileselector_entry_path_get()
7215     */
7216    EAPI void         elm_fileselector_entry_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
7217
7218    /**
7219     * Get the parent directory's path to the latest file selection on
7220     * a given filer selector entry widget
7221     *
7222     * @param obj The file selector object
7223     * @return The (full) path of the directory of the last selection
7224     * on @p obj widget, a @b stringshared string
7225     *
7226     * @see elm_fileselector_entry_path_set()
7227     */
7228    EAPI const char  *elm_fileselector_entry_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7229
7230    /**
7231     * @}
7232     */
7233
7234    /**
7235     * @defgroup Scroller Scroller
7236     *
7237     * A scroller holds a single object and "scrolls it around". This means that
7238     * it allows the user to use a scrollbar (or a finger) to drag the viewable
7239     * region around, allowing to move through a much larger object that is
7240     * contained in the scroller. The scroller will always have a small minimum
7241     * size by default as it won't be limited by the contents of the scroller.
7242     *
7243     * Signals that you can add callbacks for are:
7244     * @li "edge,left" - the left edge of the content has been reached
7245     * @li "edge,right" - the right edge of the content has been reached
7246     * @li "edge,top" - the top edge of the content has been reached
7247     * @li "edge,bottom" - the bottom edge of the content has been reached
7248     * @li "scroll" - the content has been scrolled (moved)
7249     * @li "scroll,anim,start" - scrolling animation has started
7250     * @li "scroll,anim,stop" - scrolling animation has stopped
7251     * @li "scroll,drag,start" - dragging the contents around has started
7252     * @li "scroll,drag,stop" - dragging the contents around has stopped
7253     * @note The "scroll,anim,*" and "scroll,drag,*" signals are only emitted by
7254     * user intervetion.
7255     *
7256     * @note When Elemementary is in embedded mode the scrollbars will not be
7257     * dragable, they appear merely as indicators of how much has been scrolled.
7258     * @note When Elementary is in desktop mode the thumbscroll(a.k.a.
7259     * fingerscroll) won't work.
7260     *
7261     * Default contents parts of the scroller widget that you can use for are:
7262     * @li "default" - A content of the scroller
7263     *
7264     * In @ref tutorial_scroller you'll find an example of how to use most of
7265     * this API.
7266     * @{
7267     */
7268    /**
7269     * @brief Type that controls when scrollbars should appear.
7270     *
7271     * @see elm_scroller_policy_set()
7272     */
7273    typedef enum _Elm_Scroller_Policy
7274      {
7275         ELM_SCROLLER_POLICY_AUTO = 0, /**< Show scrollbars as needed */
7276         ELM_SCROLLER_POLICY_ON, /**< Always show scrollbars */
7277         ELM_SCROLLER_POLICY_OFF, /**< Never show scrollbars */
7278         ELM_SCROLLER_POLICY_LAST
7279      } Elm_Scroller_Policy;
7280    /**
7281     * @brief Add a new scroller to the parent
7282     *
7283     * @param parent The parent object
7284     * @return The new object or NULL if it cannot be created
7285     */
7286    EAPI Evas_Object *elm_scroller_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7287    /**
7288     * @brief Set the content of the scroller widget (the object to be scrolled around).
7289     *
7290     * @param obj The scroller object
7291     * @param content The new content object
7292     *
7293     * Once the content object is set, a previously set one will be deleted.
7294     * If you want to keep that old content object, use the
7295     * elm_scroller_content_unset() function.
7296     * @deprecated use elm_object_content_set() instead
7297     */
7298    WILL_DEPRECATE  EAPI void elm_scroller_content_set(Evas_Object *obj, Evas_Object *child) EINA_ARG_NONNULL(1);
7299    /**
7300     * @brief Get the content of the scroller widget
7301     *
7302     * @param obj The slider object
7303     * @return The content that is being used
7304     *
7305     * Return the content object which is set for this widget
7306     *
7307     * @see elm_scroller_content_set()
7308     * @deprecated use elm_object_content_get() instead.
7309     */
7310    WILL_DEPRECATE  EAPI Evas_Object *elm_scroller_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7311    /**
7312     * @brief Unset the content of the scroller widget
7313     *
7314     * @param obj The slider object
7315     * @return The content that was being used
7316     *
7317     * Unparent and return the content object which was set for this widget
7318     *
7319     * @see elm_scroller_content_set()
7320     * @deprecated use elm_object_content_unset() instead.
7321     */
7322    WILL_DEPRECATE  EAPI Evas_Object *elm_scroller_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7323    /**
7324     * @brief Set custom theme elements for the scroller
7325     *
7326     * @param obj The scroller object
7327     * @param widget The widget name to use (default is "scroller")
7328     * @param base The base name to use (default is "base")
7329     */
7330    EAPI void         elm_scroller_custom_widget_base_theme_set(Evas_Object *obj, const char *widget, const char *base) EINA_ARG_NONNULL(1, 2, 3);
7331    /**
7332     * @brief Make the scroller minimum size limited to the minimum size of the content
7333     *
7334     * @param obj The scroller object
7335     * @param w Enable limiting minimum size horizontally
7336     * @param h Enable limiting minimum size vertically
7337     *
7338     * By default the scroller will be as small as its design allows,
7339     * irrespective of its content. This will make the scroller minimum size the
7340     * right size horizontally and/or vertically to perfectly fit its content in
7341     * that direction.
7342     */
7343    EAPI void         elm_scroller_content_min_limit(Evas_Object *obj, Eina_Bool w, Eina_Bool h) EINA_ARG_NONNULL(1);
7344    /**
7345     * @brief Show a specific virtual region within the scroller content object
7346     *
7347     * @param obj The scroller object
7348     * @param x X coordinate of the region
7349     * @param y Y coordinate of the region
7350     * @param w Width of the region
7351     * @param h Height of the region
7352     *
7353     * This will ensure all (or part if it does not fit) of the designated
7354     * region in the virtual content object (0, 0 starting at the top-left of the
7355     * virtual content object) is shown within the scroller.
7356     */
7357    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);
7358    /**
7359     * @brief Set the scrollbar visibility policy
7360     *
7361     * @param obj The scroller object
7362     * @param policy_h Horizontal scrollbar policy
7363     * @param policy_v Vertical scrollbar policy
7364     *
7365     * This sets the scrollbar visibility policy for the given scroller.
7366     * ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it is
7367     * needed, and otherwise kept hidden. ELM_SCROLLER_POLICY_ON turns it on all
7368     * the time, and ELM_SCROLLER_POLICY_OFF always keeps it off. This applies
7369     * respectively for the horizontal and vertical scrollbars.
7370     */
7371    EAPI void         elm_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
7372    /**
7373     * @brief Gets scrollbar visibility policy
7374     *
7375     * @param obj The scroller object
7376     * @param policy_h Horizontal scrollbar policy
7377     * @param policy_v Vertical scrollbar policy
7378     *
7379     * @see elm_scroller_policy_set()
7380     */
7381    EAPI void         elm_scroller_policy_get(const Evas_Object *obj, Elm_Scroller_Policy *policy_h, Elm_Scroller_Policy *policy_v) EINA_ARG_NONNULL(1);
7382    /**
7383     * @brief Get the currently visible content region
7384     *
7385     * @param obj The scroller object
7386     * @param x X coordinate of the region
7387     * @param y Y coordinate of the region
7388     * @param w Width of the region
7389     * @param h Height of the region
7390     *
7391     * This gets the current region in the content object that is visible through
7392     * the scroller. The region co-ordinates are returned in the @p x, @p y, @p
7393     * w, @p h values pointed to.
7394     *
7395     * @note All coordinates are relative to the content.
7396     *
7397     * @see elm_scroller_region_show()
7398     */
7399    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);
7400    /**
7401     * @brief Get the size of the content object
7402     *
7403     * @param obj The scroller object
7404     * @param w Width of the content object.
7405     * @param h Height of the content object.
7406     *
7407     * This gets the size of the content object of the scroller.
7408     */
7409    EAPI void         elm_scroller_child_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
7410    /**
7411     * @brief Set bouncing behavior
7412     *
7413     * @param obj The scroller object
7414     * @param h_bounce Allow bounce horizontally
7415     * @param v_bounce Allow bounce vertically
7416     *
7417     * When scrolling, the scroller may "bounce" when reaching an edge of the
7418     * content object. This is a visual way to indicate the end has been reached.
7419     * This is enabled by default for both axis. This API will set if it is enabled
7420     * for the given axis with the boolean parameters for each axis.
7421     */
7422    EAPI void         elm_scroller_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
7423    /**
7424     * @brief Get the bounce behaviour
7425     *
7426     * @param obj The Scroller object
7427     * @param h_bounce Will the scroller bounce horizontally or not
7428     * @param v_bounce Will the scroller bounce vertically or not
7429     *
7430     * @see elm_scroller_bounce_set()
7431     */
7432    EAPI void         elm_scroller_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
7433    /**
7434     * @brief Set scroll page size relative to viewport size.
7435     *
7436     * @param obj The scroller object
7437     * @param h_pagerel The horizontal page relative size
7438     * @param v_pagerel The vertical page relative size
7439     *
7440     * The scroller is capable of limiting scrolling by the user to "pages". That
7441     * is to jump by and only show a "whole page" at a time as if the continuous
7442     * area of the scroller content is split into page sized pieces. This sets
7443     * the size of a page relative to the viewport of the scroller. 1.0 is "1
7444     * viewport" is size (horizontally or vertically). 0.0 turns it off in that
7445     * axis. This is mutually exclusive with page size
7446     * (see elm_scroller_page_size_set()  for more information). Likewise 0.5
7447     * is "half a viewport". Sane usable values are normally between 0.0 and 1.0
7448     * including 1.0. If you only want 1 axis to be page "limited", use 0.0 for
7449     * the other axis.
7450     */
7451    EAPI void         elm_scroller_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
7452    /**
7453     * @brief Set scroll page size.
7454     *
7455     * @param obj The scroller object
7456     * @param h_pagesize The horizontal page size
7457     * @param v_pagesize The vertical page size
7458     *
7459     * This sets the page size to an absolute fixed value, with 0 turning it off
7460     * for that axis.
7461     *
7462     * @see elm_scroller_page_relative_set()
7463     */
7464    EAPI void         elm_scroller_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
7465    /**
7466     * @brief Get scroll current page number.
7467     *
7468     * @param obj The scroller object
7469     * @param h_pagenumber The horizontal page number
7470     * @param v_pagenumber The vertical page number
7471     *
7472     * The page number starts from 0. 0 is the first page.
7473     * Current page means the page which meets the top-left of the viewport.
7474     * If there are two or more pages in the viewport, it returns the number of the page
7475     * which meets the top-left of the viewport.
7476     *
7477     * @see elm_scroller_last_page_get()
7478     * @see elm_scroller_page_show()
7479     * @see elm_scroller_page_brint_in()
7480     */
7481    EAPI void         elm_scroller_current_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
7482    /**
7483     * @brief Get scroll last page number.
7484     *
7485     * @param obj The scroller object
7486     * @param h_pagenumber The horizontal page number
7487     * @param v_pagenumber The vertical page number
7488     *
7489     * The page number starts from 0. 0 is the first page.
7490     * This returns the last page number among the pages.
7491     *
7492     * @see elm_scroller_current_page_get()
7493     * @see elm_scroller_page_show()
7494     * @see elm_scroller_page_brint_in()
7495     */
7496    EAPI void         elm_scroller_last_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
7497    /**
7498     * Show a specific virtual region within the scroller content object by page number.
7499     *
7500     * @param obj The scroller object
7501     * @param h_pagenumber The horizontal page number
7502     * @param v_pagenumber The vertical page number
7503     *
7504     * 0, 0 of the indicated page is located at the top-left of the viewport.
7505     * This will jump to the page directly without animation.
7506     *
7507     * Example of usage:
7508     *
7509     * @code
7510     * sc = elm_scroller_add(win);
7511     * elm_scroller_content_set(sc, content);
7512     * elm_scroller_page_relative_set(sc, 1, 0);
7513     * elm_scroller_current_page_get(sc, &h_page, &v_page);
7514     * elm_scroller_page_show(sc, h_page + 1, v_page);
7515     * @endcode
7516     *
7517     * @see elm_scroller_page_bring_in()
7518     */
7519    EAPI void         elm_scroller_page_show(Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
7520    /**
7521     * Show a specific virtual region within the scroller content object by page number.
7522     *
7523     * @param obj The scroller object
7524     * @param h_pagenumber The horizontal page number
7525     * @param v_pagenumber The vertical page number
7526     *
7527     * 0, 0 of the indicated page is located at the top-left of the viewport.
7528     * This will slide to the page with animation.
7529     *
7530     * Example of usage:
7531     *
7532     * @code
7533     * sc = elm_scroller_add(win);
7534     * elm_scroller_content_set(sc, content);
7535     * elm_scroller_page_relative_set(sc, 1, 0);
7536     * elm_scroller_last_page_get(sc, &h_page, &v_page);
7537     * elm_scroller_page_bring_in(sc, h_page, v_page);
7538     * @endcode
7539     *
7540     * @see elm_scroller_page_show()
7541     */
7542    EAPI void         elm_scroller_page_bring_in(Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
7543    /**
7544     * @brief Show a specific virtual region within the scroller content object.
7545     *
7546     * @param obj The scroller object
7547     * @param x X coordinate of the region
7548     * @param y Y coordinate of the region
7549     * @param w Width of the region
7550     * @param h Height of the region
7551     *
7552     * This will ensure all (or part if it does not fit) of the designated
7553     * region in the virtual content object (0, 0 starting at the top-left of the
7554     * virtual content object) is shown within the scroller. Unlike
7555     * elm_scroller_region_show(), this allow the scroller to "smoothly slide"
7556     * to this location (if configuration in general calls for transitions). It
7557     * may not jump immediately to the new location and make take a while and
7558     * show other content along the way.
7559     *
7560     * @see elm_scroller_region_show()
7561     */
7562    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);
7563    /**
7564     * @brief Set event propagation on a scroller
7565     *
7566     * @param obj The scroller object
7567     * @param propagation If propagation is enabled or not
7568     *
7569     * This enables or disabled event propagation from the scroller content to
7570     * the scroller and its parent. By default event propagation is disabled.
7571     */
7572    EAPI void         elm_scroller_propagate_events_set(Evas_Object *obj, Eina_Bool propagation) EINA_ARG_NONNULL(1);
7573    /**
7574     * @brief Get event propagation for a scroller
7575     *
7576     * @param obj The scroller object
7577     * @return The propagation state
7578     *
7579     * This gets the event propagation for a scroller.
7580     *
7581     * @see elm_scroller_propagate_events_set()
7582     */
7583    EAPI Eina_Bool    elm_scroller_propagate_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7584    /**
7585     * @brief Set scrolling gravity on a scroller
7586     *
7587     * @param obj The scroller object
7588     * @param x The scrolling horizontal gravity
7589     * @param y The scrolling vertical gravity
7590     *
7591     * The gravity, defines how the scroller will adjust its view
7592     * when the size of the scroller contents increase.
7593     *
7594     * The scroller will adjust the view to glue itself as follows.
7595     *
7596     *  x=0.0, for showing the left most region of the content.
7597     *  x=1.0, for showing the right most region of the content.
7598     *  y=0.0, for showing the bottom most region of the content.
7599     *  y=1.0, for showing the top most region of the content.
7600     *
7601     * Default values for x and y are 0.0
7602     */
7603    EAPI void         elm_scroller_gravity_set(Evas_Object *obj, double x, double y) EINA_ARG_NONNULL(1);
7604    /**
7605     * @brief Get scrolling gravity values for a scroller
7606     *
7607     * @param obj The scroller object
7608     * @param x The scrolling horizontal gravity
7609     * @param y The scrolling vertical gravity
7610     *
7611     * This gets gravity values for a scroller.
7612     *
7613     * @see elm_scroller_gravity_set()
7614     *
7615     */
7616    EAPI void         elm_scroller_gravity_get(const Evas_Object *obj, double *x, double *y) EINA_ARG_NONNULL(1);
7617    /**
7618     * @}
7619     */
7620
7621    /**
7622     * @defgroup Label Label
7623     *
7624     * @image html img/widget/label/preview-00.png
7625     * @image latex img/widget/label/preview-00.eps
7626     *
7627     * @brief Widget to display text, with simple html-like markup.
7628     *
7629     * The Label widget @b doesn't allow text to overflow its boundaries, if the
7630     * text doesn't fit the geometry of the label it will be ellipsized or be
7631     * cut. Elementary provides several styles for this widget:
7632     * @li default - No animation
7633     * @li marker - Centers the text in the label and make it bold by default
7634     * @li slide_long - The entire text appears from the right of the screen and
7635     * slides until it disappears in the left of the screen(reappering on the
7636     * right again).
7637     * @li slide_short - The text appears in the left of the label and slides to
7638     * the right to show the overflow. When all of the text has been shown the
7639     * position is reset.
7640     * @li slide_bounce - The text appears in the left of the label and slides to
7641     * the right to show the overflow. When all of the text has been shown the
7642     * animation reverses, moving the text to the left.
7643     *
7644     * Custom themes can of course invent new markup tags and style them any way
7645     * they like.
7646     *
7647     * The following signals may be emitted by the label widget:
7648     * @li "language,changed": The program's language changed.
7649     *
7650     * See @ref tutorial_label for a demonstration of how to use a label widget.
7651     * @{
7652     */
7653    /**
7654     * @brief Add a new label to the parent
7655     *
7656     * @param parent The parent object
7657     * @return The new object or NULL if it cannot be created
7658     */
7659    EAPI Evas_Object *elm_label_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7660    /**
7661     * @brief Set the label on the label object
7662     *
7663     * @param obj The label object
7664     * @param label The label will be used on the label object
7665     * @deprecated See elm_object_text_set()
7666     */
7667    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 */
7668    /**
7669     * @brief Get the label used on the label object
7670     *
7671     * @param obj The label object
7672     * @return The string inside the label
7673     * @deprecated See elm_object_text_get()
7674     */
7675    EINA_DEPRECATED EAPI const char *elm_label_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1); /* deprecated, use elm_object_text_get instead */
7676    /**
7677     * @brief Set the wrapping behavior of the label
7678     *
7679     * @param obj The label object
7680     * @param wrap To wrap text or not
7681     *
7682     * By default no wrapping is done. Possible values for @p wrap are:
7683     * @li ELM_WRAP_NONE - No wrapping
7684     * @li ELM_WRAP_CHAR - wrap between characters
7685     * @li ELM_WRAP_WORD - wrap between words
7686     * @li ELM_WRAP_MIXED - Word wrap, and if that fails, char wrap
7687     */
7688    EAPI void         elm_label_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
7689    /**
7690     * @brief Get the wrapping behavior of the label
7691     *
7692     * @param obj The label object
7693     * @return Wrap type
7694     *
7695     * @see elm_label_line_wrap_set()
7696     */
7697    EAPI Elm_Wrap_Type elm_label_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7698    /**
7699     * @brief Set wrap width of the label
7700     *
7701     * @param obj The label object
7702     * @param w The wrap width in pixels at a minimum where words need to wrap
7703     *
7704     * This function sets the maximum width size hint of the label.
7705     *
7706     * @warning This is only relevant if the label is inside a container.
7707     */
7708    EAPI void         elm_label_wrap_width_set(Evas_Object *obj, Evas_Coord w) EINA_ARG_NONNULL(1);
7709    /**
7710     * @brief Get wrap width of the label
7711     *
7712     * @param obj The label object
7713     * @return The wrap width in pixels at a minimum where words need to wrap
7714     *
7715     * @see elm_label_wrap_width_set()
7716     */
7717    EAPI Evas_Coord   elm_label_wrap_width_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7718    /**
7719     * @brief Set wrap height of the label
7720     *
7721     * @param obj The label object
7722     * @param h The wrap height in pixels at a minimum where words need to wrap
7723     *
7724     * This function sets the maximum height size hint of the label.
7725     *
7726     * @warning This is only relevant if the label is inside a container.
7727     */
7728    EAPI void         elm_label_wrap_height_set(Evas_Object *obj, Evas_Coord h) EINA_ARG_NONNULL(1);
7729    /**
7730     * @brief get wrap width of the label
7731     *
7732     * @param obj The label object
7733     * @return The wrap height in pixels at a minimum where words need to wrap
7734     */
7735    EAPI Evas_Coord   elm_label_wrap_height_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7736    /**
7737     * @brief Set the font size on the label object.
7738     *
7739     * @param obj The label object
7740     * @param size font size
7741     *
7742     * @warning NEVER use this. It is for hyper-special cases only. use styles
7743     * instead. e.g. "default", "marker", "slide_long" etc.
7744     */
7745    EAPI void         elm_label_fontsize_set(Evas_Object *obj, int fontsize) EINA_ARG_NONNULL(1);
7746    /**
7747     * @brief Set the text color on the label object
7748     *
7749     * @param obj The label object
7750     * @param r Red property background color of The label object
7751     * @param g Green property background color of The label object
7752     * @param b Blue property background color of The label object
7753     * @param a Alpha property background color of The label object
7754     *
7755     * @warning NEVER use this. It is for hyper-special cases only. use styles
7756     * instead. e.g. "default", "marker", "slide_long" etc.
7757     */
7758    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);
7759    /**
7760     * @brief Set the text align on the label object
7761     *
7762     * @param obj The label object
7763     * @param align align mode ("left", "center", "right")
7764     *
7765     * @warning NEVER use this. It is for hyper-special cases only. use styles
7766     * instead. e.g. "default", "marker", "slide_long" etc.
7767     */
7768    EAPI void         elm_label_text_align_set(Evas_Object *obj, const char *alignmode) EINA_ARG_NONNULL(1);
7769    /**
7770     * @brief Set background color of the label
7771     *
7772     * @param obj The label object
7773     * @param r Red property background color of The label object
7774     * @param g Green property background color of The label object
7775     * @param b Blue property background color of The label object
7776     * @param a Alpha property background alpha of The label object
7777     *
7778     * @warning NEVER use this. It is for hyper-special cases only. use styles
7779     * instead. e.g. "default", "marker", "slide_long" etc.
7780     */
7781    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);
7782    /**
7783     * @brief Set the ellipsis behavior of the label
7784     *
7785     * @param obj The label object
7786     * @param ellipsis To ellipsis text or not
7787     *
7788     * If set to true and the text doesn't fit in the label an ellipsis("...")
7789     * will be shown at the end of the widget.
7790     *
7791     * @warning This doesn't work with slide(elm_label_slide_set()) or if the
7792     * choosen wrap method was ELM_WRAP_WORD.
7793     */
7794    EAPI void         elm_label_ellipsis_set(Evas_Object *obj, Eina_Bool ellipsis) EINA_ARG_NONNULL(1);
7795    /**
7796     * @brief Set the text slide of the label
7797     *
7798     * @param obj The label object
7799     * @param slide To start slide or stop
7800     *
7801     * If set to true, the text of the label will slide/scroll through the length of
7802     * label.
7803     *
7804     * @warning This only works with the themes "slide_short", "slide_long" and
7805     * "slide_bounce".
7806     */
7807    EAPI void         elm_label_slide_set(Evas_Object *obj, Eina_Bool slide) EINA_ARG_NONNULL(1);
7808    /**
7809     * @brief Get the text slide mode of the label
7810     *
7811     * @param obj The label object
7812     * @return slide slide mode value
7813     *
7814     * @see elm_label_slide_set()
7815     */
7816    EAPI Eina_Bool    elm_label_slide_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7817    /**
7818     * @brief Set the slide duration(speed) of the label
7819     *
7820     * @param obj The label object
7821     * @return The duration in seconds in moving text from slide begin position
7822     * to slide end position
7823     */
7824    EAPI void         elm_label_slide_duration_set(Evas_Object *obj, double duration) EINA_ARG_NONNULL(1);
7825    /**
7826     * @brief Get the slide duration(speed) of the label
7827     *
7828     * @param obj The label object
7829     * @return The duration time in moving text from slide begin position to slide end position
7830     *
7831     * @see elm_label_slide_duration_set()
7832     */
7833    EAPI double       elm_label_slide_duration_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7834    /**
7835     * @}
7836     */
7837
7838    /**
7839     * @defgroup Frame Frame
7840     *
7841     * @image html img/widget/frame/preview-00.png
7842     * @image latex img/widget/frame/preview-00.eps
7843     *
7844     * @brief Frame is a widget that holds some content and has a title.
7845     *
7846     * The default look is a frame with a title, but Frame supports multple
7847     * styles:
7848     * @li default
7849     * @li pad_small
7850     * @li pad_medium
7851     * @li pad_large
7852     * @li pad_huge
7853     * @li outdent_top
7854     * @li outdent_bottom
7855     *
7856     * Of all this styles only default shows the title. Frame emits no signals.
7857     *
7858     * Default contents parts of the frame widget that you can use for are:
7859     * @li "default" - A content of the frame
7860     *
7861     * Default text parts of the frame widget that you can use for are:
7862     * @li "elm.text" - Label of the frame
7863     *
7864     * For a detailed example see the @ref tutorial_frame.
7865     *
7866     * @{
7867     */
7868    /**
7869     * @brief Add a new frame to the parent
7870     *
7871     * @param parent The parent object
7872     * @return The new object or NULL if it cannot be created
7873     */
7874    EAPI Evas_Object *elm_frame_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7875    /**
7876     * @brief Set the frame label
7877     *
7878     * @param obj The frame object
7879     * @param label The label of this frame object
7880     *
7881     * @deprecated use elm_object_text_set() instead.
7882     */
7883    EINA_DEPRECATED EAPI void         elm_frame_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7884    /**
7885     * @brief Get the frame label
7886     *
7887     * @param obj The frame object
7888     *
7889     * @return The label of this frame objet or NULL if unable to get frame
7890     *
7891     * @deprecated use elm_object_text_get() instead.
7892     */
7893    EINA_DEPRECATED EAPI const char  *elm_frame_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7894    /**
7895     * @brief Set the content of the frame widget
7896     *
7897     * Once the content object is set, a previously set one will be deleted.
7898     * If you want to keep that old content object, use the
7899     * elm_frame_content_unset() function.
7900     *
7901     * @param obj The frame object
7902     * @param content The content will be filled in this frame object
7903     *
7904     * @deprecated use elm_object_content_set() instead.
7905     */
7906    WILL_DEPRECATE  EAPI void         elm_frame_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
7907    /**
7908     * @brief Get the content of the frame widget
7909     *
7910     * Return the content object which is set for this widget
7911     *
7912     * @param obj The frame object
7913     * @return The content that is being used
7914     *
7915     * @deprecated use elm_object_content_get() instead.
7916     */
7917    WILL_DEPRECATE  EAPI Evas_Object *elm_frame_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7918    /**
7919     * @brief Unset the content of the frame widget
7920     *
7921     * Unparent and return the content object which was set for this widget
7922     *
7923     * @param obj The frame object
7924     * @return The content that was being used
7925     *
7926     * @deprecated use elm_object_content_unset() instead.
7927     */
7928    WILL_DEPRECATE  EAPI Evas_Object *elm_frame_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7929    /**
7930     * @}
7931     */
7932
7933    /**
7934     * @defgroup Table Table
7935     *
7936     * A container widget to arrange other widgets in a table where items can
7937     * also span multiple columns or rows - even overlap (and then be raised or
7938     * lowered accordingly to adjust stacking if they do overlap).
7939     *
7940     * For a Table widget the row/column count is not fixed.
7941     * The table widget adjusts itself when subobjects are added to it dynamically.
7942     *
7943     * The followin are examples of how to use a table:
7944     * @li @ref tutorial_table_01
7945     * @li @ref tutorial_table_02
7946     *
7947     * @{
7948     */
7949    /**
7950     * @brief Add a new table to the parent
7951     *
7952     * @param parent The parent object
7953     * @return The new object or NULL if it cannot be created
7954     */
7955    EAPI Evas_Object *elm_table_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7956    /**
7957     * @brief Set the homogeneous layout in the table
7958     *
7959     * @param obj The layout object
7960     * @param homogeneous A boolean to set if the layout is homogeneous in the
7961     * table (EINA_TRUE = homogeneous,  EINA_FALSE = no homogeneous)
7962     */
7963    EAPI void         elm_table_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
7964    /**
7965     * @brief Get the current table homogeneous mode.
7966     *
7967     * @param obj The table object
7968     * @return A boolean to indicating if the layout is homogeneous in the table
7969     * (EINA_TRUE = homogeneous,  EINA_FALSE = no homogeneous)
7970     */
7971    EAPI Eina_Bool    elm_table_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7972    /**
7973     * @warning <b>Use elm_table_homogeneous_set() instead</b>
7974     */
7975    EINA_DEPRECATED EAPI void elm_table_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
7976    /**
7977     * @warning <b>Use elm_table_homogeneous_get() instead</b>
7978     */
7979    EINA_DEPRECATED EAPI Eina_Bool elm_table_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7980    /**
7981     * @brief Set padding between cells.
7982     *
7983     * @param obj The layout object.
7984     * @param horizontal set the horizontal padding.
7985     * @param vertical set the vertical padding.
7986     *
7987     * Default value is 0.
7988     */
7989    EAPI void         elm_table_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
7990    /**
7991     * @brief Get padding between cells.
7992     *
7993     * @param obj The layout object.
7994     * @param horizontal set the horizontal padding.
7995     * @param vertical set the vertical padding.
7996     */
7997    EAPI void         elm_table_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
7998    /**
7999     * @brief Add a subobject on the table with the coordinates passed
8000     *
8001     * @param obj The table object
8002     * @param subobj The subobject to be added to the table
8003     * @param x Row number
8004     * @param y Column number
8005     * @param w rowspan
8006     * @param h colspan
8007     *
8008     * @note All positioning inside the table is relative to rows and columns, so
8009     * a value of 0 for x and y, means the top left cell of the table, and a
8010     * value of 1 for w and h means @p subobj only takes that 1 cell.
8011     */
8012    EAPI void         elm_table_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
8013    /**
8014     * @brief Remove child from table.
8015     *
8016     * @param obj The table object
8017     * @param subobj The subobject
8018     */
8019    EAPI void         elm_table_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
8020    /**
8021     * @brief Faster way to remove all child objects from a table object.
8022     *
8023     * @param obj The table object
8024     * @param clear If true, will delete children, else just remove from table.
8025     */
8026    EAPI void         elm_table_clear(Evas_Object *obj, Eina_Bool clear) EINA_ARG_NONNULL(1);
8027    /**
8028     * @brief Set the packing location of an existing child of the table
8029     *
8030     * @param subobj The subobject to be modified in the table
8031     * @param x Row number
8032     * @param y Column number
8033     * @param w rowspan
8034     * @param h colspan
8035     *
8036     * Modifies the position of an object already in the table.
8037     *
8038     * @note All positioning inside the table is relative to rows and columns, so
8039     * a value of 0 for x and y, means the top left cell of the table, and a
8040     * value of 1 for w and h means @p subobj only takes that 1 cell.
8041     */
8042    EAPI void         elm_table_pack_set(Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
8043    /**
8044     * @brief Get the packing location of an existing child of the table
8045     *
8046     * @param subobj The subobject to be modified in the table
8047     * @param x Row number
8048     * @param y Column number
8049     * @param w rowspan
8050     * @param h colspan
8051     *
8052     * @see elm_table_pack_set()
8053     */
8054    EAPI void         elm_table_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
8055    /**
8056     * @}
8057     */
8058
8059    /**
8060     * @defgroup Gengrid Gengrid (Generic grid)
8061     *
8062     * This widget aims to position objects in a grid layout while
8063     * actually creating and rendering only the visible ones, using the
8064     * same idea as the @ref Genlist "genlist": the user defines a @b
8065     * class for each item, specifying functions that will be called at
8066     * object creation, deletion, etc. When those items are selected by
8067     * the user, a callback function is issued. Users may interact with
8068     * a gengrid via the mouse (by clicking on items to select them and
8069     * clicking on the grid's viewport and swiping to pan the whole
8070     * view) or via the keyboard, navigating through item with the
8071     * arrow keys.
8072     *
8073     * @section Gengrid_Layouts Gengrid layouts
8074     *
8075     * Gengrid may layout its items in one of two possible layouts:
8076     * - horizontal or
8077     * - vertical.
8078     *
8079     * When in "horizontal mode", items will be placed in @b columns,
8080     * from top to bottom and, when the space for a column is filled,
8081     * another one is started on the right, thus expanding the grid
8082     * horizontally, making for horizontal scrolling. When in "vertical
8083     * mode" , though, items will be placed in @b rows, from left to
8084     * right and, when the space for a row is filled, another one is
8085     * started below, thus expanding the grid vertically (and making
8086     * for vertical scrolling).
8087     *
8088     * @section Gengrid_Items Gengrid items
8089     *
8090     * An item in a gengrid can have 0 or more text labels (they can be
8091     * regular text or textblock Evas objects - that's up to the style
8092     * to determine), 0 or more icons (which are simply objects
8093     * swallowed into the gengrid item's theming Edje object) and 0 or
8094     * more <b>boolean states</b>, which have the behavior left to the
8095     * user to define. The Edje part names for each of these properties
8096     * will be looked up, in the theme file for the gengrid, under the
8097     * Edje (string) data items named @c "labels", @c "icons" and @c
8098     * "states", respectively. For each of those properties, if more
8099     * than one part is provided, they must have names listed separated
8100     * by spaces in the data fields. For the default gengrid item
8101     * theme, we have @b one label part (@c "elm.text"), @b two icon
8102     * parts (@c "elm.swalllow.icon" and @c "elm.swallow.end") and @b
8103     * no state parts.
8104     *
8105     * A gengrid item may be at one of several styles. Elementary
8106     * provides one by default - "default", but this can be extended by
8107     * system or application custom themes/overlays/extensions (see
8108     * @ref Theme "themes" for more details).
8109     *
8110     * @section Gengrid_Item_Class Gengrid item classes
8111     *
8112     * In order to have the ability to add and delete items on the fly,
8113     * gengrid implements a class (callback) system where the
8114     * application provides a structure with information about that
8115     * type of item (gengrid may contain multiple different items with
8116     * different classes, states and styles). Gengrid will call the
8117     * functions in this struct (methods) when an item is "realized"
8118     * (i.e., created dynamically, while the user is scrolling the
8119     * grid). All objects will simply be deleted when no longer needed
8120     * with evas_object_del(). The #Elm_GenGrid_Item_Class structure
8121     * contains the following members:
8122     * - @c item_style - This is a constant string and simply defines
8123     * the name of the item style. It @b must be specified and the
8124     * default should be @c "default".
8125     * - @c func.label_get - This function is called when an item
8126     * object is actually created. The @c data parameter will point to
8127     * the same data passed to elm_gengrid_item_append() and related
8128     * item creation functions. The @c obj parameter is the gengrid
8129     * object itself, while the @c part one is the name string of one
8130     * of the existing text parts in the Edje group implementing the
8131     * item's theme. This function @b must return a strdup'()ed string,
8132     * as the caller will free() it when done. See
8133     * #Elm_Gengrid_Item_Label_Get_Cb.
8134     * - @c func.content_get - This function is called when an item object
8135     * is actually created. The @c data parameter will point to the
8136     * same data passed to elm_gengrid_item_append() and related item
8137     * creation functions. The @c obj parameter is the gengrid object
8138     * itself, while the @c part one is the name string of one of the
8139     * existing (content) swallow parts in the Edje group implementing the
8140     * item's theme. It must return @c NULL, when no content is desired,
8141     * or a valid object handle, otherwise. The object will be deleted
8142     * by the gengrid on its deletion or when the item is "unrealized".
8143     * See #Elm_Gengrid_Item_Content_Get_Cb.
8144     * - @c func.state_get - This function is called when an item
8145     * object is actually created. The @c data parameter will point to
8146     * the same data passed to elm_gengrid_item_append() and related
8147     * item creation functions. The @c obj parameter is the gengrid
8148     * object itself, while the @c part one is the name string of one
8149     * of the state parts in the Edje group implementing the item's
8150     * theme. Return @c EINA_FALSE for false/off or @c EINA_TRUE for
8151     * true/on. Gengrids will emit a signal to its theming Edje object
8152     * with @c "elm,state,XXX,active" and @c "elm" as "emission" and
8153     * "source" arguments, respectively, when the state is true (the
8154     * default is false), where @c XXX is the name of the (state) part.
8155     * See #Elm_Gengrid_Item_State_Get_Cb.
8156     * - @c func.del - This is called when elm_gengrid_item_del() is
8157     * called on an item or elm_gengrid_clear() is called on the
8158     * gengrid. This is intended for use when gengrid items are
8159     * deleted, so any data attached to the item (e.g. its data
8160     * parameter on creation) can be deleted. See #Elm_Gengrid_Item_Del_Cb.
8161     *
8162     * @section Gengrid_Usage_Hints Usage hints
8163     *
8164     * If the user wants to have multiple items selected at the same
8165     * time, elm_gengrid_multi_select_set() will permit it. If the
8166     * gengrid is single-selection only (the default), then
8167     * elm_gengrid_select_item_get() will return the selected item or
8168     * @c NULL, if none is selected. If the gengrid is under
8169     * multi-selection, then elm_gengrid_selected_items_get() will
8170     * return a list (that is only valid as long as no items are
8171     * modified (added, deleted, selected or unselected) of child items
8172     * on a gengrid.
8173     *
8174     * If an item changes (internal (boolean) state, label or content 
8175     * changes), then use elm_gengrid_item_update() to have gengrid
8176     * update the item with the new state. A gengrid will re-"realize"
8177     * the item, thus calling the functions in the
8178     * #Elm_Gengrid_Item_Class set for that item.
8179     *
8180     * To programmatically (un)select an item, use
8181     * elm_gengrid_item_selected_set(). To get its selected state use
8182     * elm_gengrid_item_selected_get(). To make an item disabled
8183     * (unable to be selected and appear differently) use
8184     * elm_gengrid_item_disabled_set() to set this and
8185     * elm_gengrid_item_disabled_get() to get the disabled state.
8186     *
8187     * Grid cells will only have their selection smart callbacks called
8188     * when firstly getting selected. Any further clicks will do
8189     * nothing, unless you enable the "always select mode", with
8190     * elm_gengrid_always_select_mode_set(), thus making every click to
8191     * issue selection callbacks. elm_gengrid_no_select_mode_set() will
8192     * turn off the ability to select items entirely in the widget and
8193     * they will neither appear selected nor call the selection smart
8194     * callbacks.
8195     *
8196     * Remember that you can create new styles and add your own theme
8197     * augmentation per application with elm_theme_extension_add(). If
8198     * you absolutely must have a specific style that overrides any
8199     * theme the user or system sets up you can use
8200     * elm_theme_overlay_add() to add such a file.
8201     *
8202     * @section Gengrid_Smart_Events Gengrid smart events
8203     *
8204     * Smart events that you can add callbacks for are:
8205     * - @c "activated" - The user has double-clicked or pressed
8206     *   (enter|return|spacebar) on an item. The @c event_info parameter
8207     *   is the gengrid item that was activated.
8208     * - @c "clicked,double" - The user has double-clicked an item.
8209     *   The @c event_info parameter is the gengrid item that was double-clicked.
8210     * - @c "longpressed" - This is called when the item is pressed for a certain
8211     *   amount of time. By default it's 1 second.
8212     * - @c "selected" - The user has made an item selected. The
8213     *   @c event_info parameter is the gengrid item that was selected.
8214     * - @c "unselected" - The user has made an item unselected. The
8215     *   @c event_info parameter is the gengrid item that was unselected.
8216     * - @c "realized" - This is called when the item in the gengrid
8217     *   has its implementing Evas object instantiated, de facto. @c
8218     *   event_info is the gengrid item that was created. The object
8219     *   may be deleted at any time, so it is highly advised to the
8220     *   caller @b not to use the object pointer returned from
8221     *   elm_gengrid_item_object_get(), because it may point to freed
8222     *   objects.
8223     * - @c "unrealized" - This is called when the implementing Evas
8224     *   object for this item is deleted. @c event_info is the gengrid
8225     *   item that was deleted.
8226     * - @c "changed" - Called when an item is added, removed, resized
8227     *   or moved and when the gengrid is resized or gets "horizontal"
8228     *   property changes.
8229     * - @c "scroll,anim,start" - This is called when scrolling animation has
8230     *   started.
8231     * - @c "scroll,anim,stop" - This is called when scrolling animation has
8232     *   stopped.
8233     * - @c "drag,start,up" - Called when the item in the gengrid has
8234     *   been dragged (not scrolled) up.
8235     * - @c "drag,start,down" - Called when the item in the gengrid has
8236     *   been dragged (not scrolled) down.
8237     * - @c "drag,start,left" - Called when the item in the gengrid has
8238     *   been dragged (not scrolled) left.
8239     * - @c "drag,start,right" - Called when the item in the gengrid has
8240     *   been dragged (not scrolled) right.
8241     * - @c "drag,stop" - Called when the item in the gengrid has
8242     *   stopped being dragged.
8243     * - @c "drag" - Called when the item in the gengrid is being
8244     *   dragged.
8245     * - @c "scroll" - called when the content has been scrolled
8246     *   (moved).
8247     * - @c "scroll,drag,start" - called when dragging the content has
8248     *   started.
8249     * - @c "scroll,drag,stop" - called when dragging the content has
8250     *   stopped.
8251     * - @c "edge,top" - This is called when the gengrid is scrolled until
8252     *   the top edge.
8253     * - @c "edge,bottom" - This is called when the gengrid is scrolled
8254     *   until the bottom edge.
8255     * - @c "edge,left" - This is called when the gengrid is scrolled
8256     *   until the left edge.
8257     * - @c "edge,right" - This is called when the gengrid is scrolled
8258     *   until the right edge.
8259     *
8260     * List of gengrid examples:
8261     * @li @ref gengrid_example
8262     */
8263
8264    /**
8265     * @addtogroup Gengrid
8266     * @{
8267     */
8268
8269    typedef struct _Elm_Gengrid_Item_Class Elm_Gengrid_Item_Class; /**< Gengrid item class definition structs */
8270    typedef struct _Elm_Gengrid_Item Elm_Gengrid_Item; /**< Gengrid item handles */
8271    typedef struct _Elm_Gengrid_Item_Class_Func Elm_Gengrid_Item_Class_Func; /**< Class functions for gengrid item classes. */
8272    /**
8273     * Label fetching class function for Elm_Gen_Item_Class.
8274     * @param data The data passed in the item creation function
8275     * @param obj The base widget object
8276     * @param part The part name of the swallow
8277     * @return The allocated (NOT stringshared) string to set as the label
8278     */
8279    typedef char        *(*Elm_Gengrid_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part);
8280    /**
8281     * Content (swallowed object) fetching class function for Elm_Gen_Item_Class.
8282     * @param data The data passed in the item creation function
8283     * @param obj The base widget object
8284     * @param part The part name of the swallow
8285     * @return The content object to swallow
8286     */
8287    typedef Evas_Object *(*Elm_Gengrid_Item_Content_Get_Cb)  (void *data, Evas_Object *obj, const char *part);
8288    /**
8289     * State fetching class function for Elm_Gen_Item_Class.
8290     * @param data The data passed in the item creation function
8291     * @param obj The base widget object
8292     * @param part The part name of the swallow
8293     * @return The hell if I know
8294     */
8295    typedef Eina_Bool    (*Elm_Gengrid_Item_State_Get_Cb) (void *data, Evas_Object *obj, const char *part);
8296    /**
8297     * Deletion class function for Elm_Gen_Item_Class.
8298     * @param data The data passed in the item creation function
8299     * @param obj The base widget object
8300     */
8301    typedef void         (*Elm_Gengrid_Item_Del_Cb)      (void *data, Evas_Object *obj);
8302
8303    /* temporary compatibility code */
8304    typedef Elm_Gengrid_Item_Label_Get_Cb GridItemLabelGetFunc EINA_DEPRECATED;
8305    typedef Elm_Gengrid_Item_Content_Get_Cb GridItemIconGetFunc EINA_DEPRECATED;
8306    typedef Elm_Gengrid_Item_State_Get_Cb GridItemStateGetFunc EINA_DEPRECATED;
8307    typedef Elm_Gengrid_Item_Del_Cb GridItemDelFunc EINA_DEPRECATED;
8308
8309    /**
8310     * @struct _Elm_Gengrid_Item_Class
8311     *
8312     * Gengrid item class definition. See @ref Gengrid_Item_Class for
8313     * field details.
8314     */
8315    struct _Elm_Gengrid_Item_Class
8316      {
8317         const char             *item_style;
8318         struct _Elm_Gengrid_Item_Class_Func
8319           {
8320              Elm_Gengrid_Item_Label_Get_Cb label_get;
8321              union { /* temporary compatibility code */
8322                Elm_Gengrid_Item_Content_Get_Cb icon_get EINA_DEPRECATED;
8323                Elm_Gengrid_Item_Content_Get_Cb content_get;
8324              };
8325              Elm_Gengrid_Item_State_Get_Cb state_get;
8326              Elm_Gengrid_Item_Del_Cb       del;
8327           } func;
8328      }; /**< #Elm_Gengrid_Item_Class member definitions */
8329    /**
8330     * Add a new gengrid widget to the given parent Elementary
8331     * (container) object
8332     *
8333     * @param parent The parent object
8334     * @return a new gengrid widget handle or @c NULL, on errors
8335     *
8336     * This function inserts a new gengrid widget on the canvas.
8337     *
8338     * @see elm_gengrid_item_size_set()
8339     * @see elm_gengrid_group_item_size_set()
8340     * @see elm_gengrid_horizontal_set()
8341     * @see elm_gengrid_item_append()
8342     * @see elm_gengrid_item_del()
8343     * @see elm_gengrid_clear()
8344     *
8345     * @ingroup Gengrid
8346     */
8347    EAPI Evas_Object       *elm_gengrid_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8348
8349    /**
8350     * Set the size for the items of a given gengrid widget
8351     *
8352     * @param obj The gengrid object.
8353     * @param w The items' width.
8354     * @param h The items' height;
8355     *
8356     * A gengrid, after creation, has still no information on the size
8357     * to give to each of its cells. So, you most probably will end up
8358     * with squares one @ref Fingers "finger" wide, the default
8359     * size. Use this function to force a custom size for you items,
8360     * making them as big as you wish.
8361     *
8362     * @see elm_gengrid_item_size_get()
8363     *
8364     * @ingroup Gengrid
8365     */
8366    EAPI void               elm_gengrid_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
8367
8368    /**
8369     * Get the size set for the items of a given gengrid widget
8370     *
8371     * @param obj The gengrid object.
8372     * @param w Pointer to a variable where to store the items' width.
8373     * @param h Pointer to a variable where to store the items' height.
8374     *
8375     * @note Use @c NULL pointers on the size values you're not
8376     * interested in: they'll be ignored by the function.
8377     *
8378     * @see elm_gengrid_item_size_get() for more details
8379     *
8380     * @ingroup Gengrid
8381     */
8382    EAPI void               elm_gengrid_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
8383
8384    /**
8385     * Set the items grid's alignment within a given gengrid widget
8386     *
8387     * @param obj The gengrid object.
8388     * @param align_x Alignment in the horizontal axis (0 <= align_x <= 1).
8389     * @param align_y Alignment in the vertical axis (0 <= align_y <= 1).
8390     *
8391     * This sets the alignment of the whole grid of items of a gengrid
8392     * within its given viewport. By default, those values are both
8393     * 0.5, meaning that the gengrid will have its items grid placed
8394     * exactly in the middle of its viewport.
8395     *
8396     * @note If given alignment values are out of the cited ranges,
8397     * they'll be changed to the nearest boundary values on the valid
8398     * ranges.
8399     *
8400     * @see elm_gengrid_align_get()
8401     *
8402     * @ingroup Gengrid
8403     */
8404    EAPI void               elm_gengrid_align_set(Evas_Object *obj, double align_x, double align_y) EINA_ARG_NONNULL(1);
8405
8406    /**
8407     * Get the items grid's alignment values within a given gengrid
8408     * widget
8409     *
8410     * @param obj The gengrid object.
8411     * @param align_x Pointer to a variable where to store the
8412     * horizontal alignment.
8413     * @param align_y Pointer to a variable where to store the vertical
8414     * alignment.
8415     *
8416     * @note Use @c NULL pointers on the alignment values you're not
8417     * interested in: they'll be ignored by the function.
8418     *
8419     * @see elm_gengrid_align_set() for more details
8420     *
8421     * @ingroup Gengrid
8422     */
8423    EAPI void               elm_gengrid_align_get(const Evas_Object *obj, double *align_x, double *align_y) EINA_ARG_NONNULL(1);
8424
8425    /**
8426     * Set whether a given gengrid widget is or not able have items
8427     * @b reordered
8428     *
8429     * @param obj The gengrid object
8430     * @param reorder_mode Use @c EINA_TRUE to turn reoderding on,
8431     * @c EINA_FALSE to turn it off
8432     *
8433     * If a gengrid is set to allow reordering, a click held for more
8434     * than 0.5 over a given item will highlight it specially,
8435     * signalling the gengrid has entered the reordering state. From
8436     * that time on, the user will be able to, while still holding the
8437     * mouse button down, move the item freely in the gengrid's
8438     * viewport, replacing to said item to the locations it goes to.
8439     * The replacements will be animated and, whenever the user
8440     * releases the mouse button, the item being replaced gets a new
8441     * definitive place in the grid.
8442     *
8443     * @see elm_gengrid_reorder_mode_get()
8444     *
8445     * @ingroup Gengrid
8446     */
8447    EAPI void               elm_gengrid_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
8448
8449    /**
8450     * Get whether a given gengrid widget is or not able have items
8451     * @b reordered
8452     *
8453     * @param obj The gengrid object
8454     * @return @c EINA_TRUE, if reoderding is on, @c EINA_FALSE if it's
8455     * off
8456     *
8457     * @see elm_gengrid_reorder_mode_set() for more details
8458     *
8459     * @ingroup Gengrid
8460     */
8461    EAPI Eina_Bool          elm_gengrid_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8462
8463    /**
8464     * Append a new item in a given gengrid widget.
8465     *
8466     * @param obj The gengrid object.
8467     * @param gic The item class for the item.
8468     * @param data The item data.
8469     * @param func Convenience function called when the item is
8470     * selected.
8471     * @param func_data Data to be passed to @p func.
8472     * @return A handle to the item added or @c NULL, on errors.
8473     *
8474     * This adds an item to the beginning of the gengrid.
8475     *
8476     * @see elm_gengrid_item_prepend()
8477     * @see elm_gengrid_item_insert_before()
8478     * @see elm_gengrid_item_insert_after()
8479     * @see elm_gengrid_item_del()
8480     *
8481     * @ingroup Gengrid
8482     */
8483    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);
8484
8485    /**
8486     * Prepend a new item in a given gengrid widget.
8487     *
8488     * @param obj The gengrid object.
8489     * @param gic The item class for the item.
8490     * @param data The item data.
8491     * @param func Convenience function called when the item is
8492     * selected.
8493     * @param func_data Data to be passed to @p func.
8494     * @return A handle to the item added or @c NULL, on errors.
8495     *
8496     * This adds an item to the end of the gengrid.
8497     *
8498     * @see elm_gengrid_item_append()
8499     * @see elm_gengrid_item_insert_before()
8500     * @see elm_gengrid_item_insert_after()
8501     * @see elm_gengrid_item_del()
8502     *
8503     * @ingroup Gengrid
8504     */
8505    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);
8506
8507    /**
8508     * Insert an item before another in a gengrid widget
8509     *
8510     * @param obj The gengrid object.
8511     * @param gic The item class for the item.
8512     * @param data The item data.
8513     * @param relative The item to place this new one before.
8514     * @param func Convenience function called when the item is
8515     * selected.
8516     * @param func_data Data to be passed to @p func.
8517     * @return A handle to the item added or @c NULL, on errors.
8518     *
8519     * This inserts an item before another in the gengrid.
8520     *
8521     * @see elm_gengrid_item_append()
8522     * @see elm_gengrid_item_prepend()
8523     * @see elm_gengrid_item_insert_after()
8524     * @see elm_gengrid_item_del()
8525     *
8526     * @ingroup Gengrid
8527     */
8528    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);
8529
8530    /**
8531     * Insert an item after another in a gengrid widget
8532     *
8533     * @param obj The gengrid object.
8534     * @param gic The item class for the item.
8535     * @param data The item data.
8536     * @param relative The item to place this new one after.
8537     * @param func Convenience function called when the item is
8538     * selected.
8539     * @param func_data Data to be passed to @p func.
8540     * @return A handle to the item added or @c NULL, on errors.
8541     *
8542     * This inserts an item after another in the gengrid.
8543     *
8544     * @see elm_gengrid_item_append()
8545     * @see elm_gengrid_item_prepend()
8546     * @see elm_gengrid_item_insert_after()
8547     * @see elm_gengrid_item_del()
8548     *
8549     * @ingroup Gengrid
8550     */
8551    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);
8552
8553    /**
8554     * Insert an item in a gengrid widget using a user-defined sort function.
8555     *
8556     * @param obj The gengrid object.
8557     * @param gic The item class for the item.
8558     * @param data The item data.
8559     * @param comp User defined comparison function that defines the sort order based on
8560     * Elm_Gen_Item and its data param.
8561     * @param func Convenience function called when the item is selected.
8562     * @param func_data Data to be passed to @p func.
8563     * @return A handle to the item added or @c NULL, on errors.
8564     *
8565     * This inserts an item in the gengrid based on user defined comparison function.
8566     *
8567     * @see elm_gengrid_item_append()
8568     * @see elm_gengrid_item_prepend()
8569     * @see elm_gengrid_item_insert_after()
8570     * @see elm_gengrid_item_del()
8571     * @see elm_gengrid_item_direct_sorted_insert()
8572     *
8573     * @ingroup Gengrid
8574     */
8575    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);
8576
8577    /**
8578     * Insert an item in a gengrid widget using a user-defined sort function.
8579     *
8580     * @param obj The gengrid object.
8581     * @param gic The item class for the item.
8582     * @param data The item data.
8583     * @param comp User defined comparison function that defines the sort order based on
8584     * Elm_Gen_Item.
8585     * @param func Convenience function called when the item is selected.
8586     * @param func_data Data to be passed to @p func.
8587     * @return A handle to the item added or @c NULL, on errors.
8588     *
8589     * This inserts an item in the gengrid based on user defined comparison function.
8590     *
8591     * @see elm_gengrid_item_append()
8592     * @see elm_gengrid_item_prepend()
8593     * @see elm_gengrid_item_insert_after()
8594     * @see elm_gengrid_item_del()
8595     * @see elm_gengrid_item_sorted_insert()
8596     *
8597     * @ingroup Gengrid
8598     */
8599    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);
8600
8601    /**
8602     * Set whether items on a given gengrid widget are to get their
8603     * selection callbacks issued for @b every subsequent selection
8604     * click on them or just for the first click.
8605     *
8606     * @param obj The gengrid object
8607     * @param always_select @c EINA_TRUE to make items "always
8608     * selected", @c EINA_FALSE, otherwise
8609     *
8610     * By default, grid items will only call their selection callback
8611     * function when firstly getting selected, any subsequent further
8612     * clicks will do nothing. With this call, you make those
8613     * subsequent clicks also to issue the selection callbacks.
8614     *
8615     * @note <b>Double clicks</b> will @b always be reported on items.
8616     *
8617     * @see elm_gengrid_always_select_mode_get()
8618     *
8619     * @ingroup Gengrid
8620     */
8621    WILL_DEPRECATE  EAPI void               elm_gengrid_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
8622
8623    /**
8624     * Get whether items on a given gengrid widget have their selection
8625     * callbacks issued for @b every subsequent selection click on them
8626     * or just for the first click.
8627     *
8628     * @param obj The gengrid object.
8629     * @return @c EINA_TRUE if the gengrid items are "always selected",
8630     * @c EINA_FALSE, otherwise
8631     *
8632     * @see elm_gengrid_always_select_mode_set() for more details
8633     *
8634     * @ingroup Gengrid
8635     */
8636    WILL_DEPRECATE  EAPI Eina_Bool          elm_gengrid_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8637
8638    /**
8639     * Set whether items on a given gengrid widget can be selected or not.
8640     *
8641     * @param obj The gengrid object
8642     * @param no_select @c EINA_TRUE to make items selectable,
8643     * @c EINA_FALSE otherwise
8644     *
8645     * This will make items in @p obj selectable or not. In the latter
8646     * case, any user interaction on the gengrid items will neither make
8647     * them appear selected nor them call their selection callback
8648     * functions.
8649     *
8650     * @see elm_gengrid_no_select_mode_get()
8651     *
8652     * @ingroup Gengrid
8653     */
8654    WILL_DEPRECATE  EAPI void               elm_gengrid_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
8655
8656    /**
8657     * Get whether items on a given gengrid widget can be selected or
8658     * not.
8659     *
8660     * @param obj The gengrid object
8661     * @return @c EINA_TRUE, if items are selectable, @c EINA_FALSE
8662     * otherwise
8663     *
8664     * @see elm_gengrid_no_select_mode_set() for more details
8665     *
8666     * @ingroup Gengrid
8667     */
8668    WILL_DEPRECATE  EAPI Eina_Bool          elm_gengrid_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8669
8670    /**
8671     * Enable or disable multi-selection in a given gengrid widget
8672     *
8673     * @param obj The gengrid object.
8674     * @param multi @c EINA_TRUE, to enable multi-selection,
8675     * @c EINA_FALSE to disable it.
8676     *
8677     * Multi-selection is the ability to have @b more than one
8678     * item selected, on a given gengrid, simultaneously. When it is
8679     * enabled, a sequence of clicks on different items will make them
8680     * all selected, progressively. A click on an already selected item
8681     * will unselect it. If interacting via the keyboard,
8682     * multi-selection is enabled while holding the "Shift" key.
8683     *
8684     * @note By default, multi-selection is @b disabled on gengrids
8685     *
8686     * @see elm_gengrid_multi_select_get()
8687     *
8688     * @ingroup Gengrid
8689     */
8690    EAPI void               elm_gengrid_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
8691
8692    /**
8693     * Get whether multi-selection is enabled or disabled for a given
8694     * gengrid widget
8695     *
8696     * @param obj The gengrid object.
8697     * @return @c EINA_TRUE, if multi-selection is enabled, @c
8698     * EINA_FALSE otherwise
8699     *
8700     * @see elm_gengrid_multi_select_set() for more details
8701     *
8702     * @ingroup Gengrid
8703     */
8704    EAPI Eina_Bool          elm_gengrid_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8705
8706    /**
8707     * Enable or disable bouncing effect for a given gengrid widget
8708     *
8709     * @param obj The gengrid object
8710     * @param h_bounce @c EINA_TRUE, to enable @b horizontal bouncing,
8711     * @c EINA_FALSE to disable it
8712     * @param v_bounce @c EINA_TRUE, to enable @b vertical bouncing,
8713     * @c EINA_FALSE to disable it
8714     *
8715     * The bouncing effect occurs whenever one reaches the gengrid's
8716     * edge's while panning it -- it will scroll past its limits a
8717     * little bit and return to the edge again, in a animated for,
8718     * automatically.
8719     *
8720     * @note By default, gengrids have bouncing enabled on both axis
8721     *
8722     * @see elm_gengrid_bounce_get()
8723     *
8724     * @ingroup Gengrid
8725     */
8726    WILL_DEPRECATE  EAPI void               elm_gengrid_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
8727
8728    /**
8729     * Get whether bouncing effects are enabled or disabled, for a
8730     * given gengrid widget, on each axis
8731     *
8732     * @param obj The gengrid object
8733     * @param h_bounce Pointer to a variable where to store the
8734     * horizontal bouncing flag.
8735     * @param v_bounce Pointer to a variable where to store the
8736     * vertical bouncing flag.
8737     *
8738     * @see elm_gengrid_bounce_set() for more details
8739     *
8740     * @ingroup Gengrid
8741     */
8742    WILL_DEPRECATE  EAPI void               elm_gengrid_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
8743
8744    /**
8745     * Set a given gengrid widget's scrolling page size, relative to
8746     * its viewport size.
8747     *
8748     * @param obj The gengrid object
8749     * @param h_pagerel The horizontal page (relative) size
8750     * @param v_pagerel The vertical page (relative) size
8751     *
8752     * The gengrid's scroller is capable of binding scrolling by the
8753     * user to "pages". It means that, while scrolling and, specially
8754     * after releasing the mouse button, the grid will @b snap to the
8755     * nearest displaying page's area. When page sizes are set, the
8756     * grid's continuous content area is split into (equal) page sized
8757     * pieces.
8758     *
8759     * This function sets the size of a page <b>relatively to the
8760     * viewport dimensions</b> of the gengrid, for each axis. A value
8761     * @c 1.0 means "the exact viewport's size", in that axis, while @c
8762     * 0.0 turns paging off in that axis. Likewise, @c 0.5 means "half
8763     * a viewport". Sane usable values are, than, between @c 0.0 and @c
8764     * 1.0. Values beyond those will make it behave behave
8765     * inconsistently. If you only want one axis to snap to pages, use
8766     * the value @c 0.0 for the other one.
8767     *
8768     * There is a function setting page size values in @b absolute
8769     * values, too -- elm_gengrid_page_size_set(). Naturally, its use
8770     * is mutually exclusive to this one.
8771     *
8772     * @see elm_gengrid_page_relative_get()
8773     *
8774     * @ingroup Gengrid
8775     */
8776    WILL_DEPRECATE  EAPI void               elm_gengrid_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
8777
8778    /**
8779     * Get a given gengrid widget's scrolling page size, relative to
8780     * its viewport size.
8781     *
8782     * @param obj The gengrid object
8783     * @param h_pagerel Pointer to a variable where to store the
8784     * horizontal page (relative) size
8785     * @param v_pagerel Pointer to a variable where to store the
8786     * vertical page (relative) size
8787     *
8788     * @see elm_gengrid_page_relative_set() for more details
8789     *
8790     * @ingroup Gengrid
8791     */
8792    WILL_DEPRECATE  EAPI void               elm_gengrid_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel) EINA_ARG_NONNULL(1);
8793
8794    /**
8795     * Set a given gengrid widget's scrolling page size
8796     *
8797     * @param obj The gengrid object
8798     * @param h_pagerel The horizontal page size, in pixels
8799     * @param v_pagerel The vertical page size, in pixels
8800     *
8801     * The gengrid's scroller is capable of binding scrolling by the
8802     * user to "pages". It means that, while scrolling and, specially
8803     * after releasing the mouse button, the grid will @b snap to the
8804     * nearest displaying page's area. When page sizes are set, the
8805     * grid's continuous content area is split into (equal) page sized
8806     * pieces.
8807     *
8808     * This function sets the size of a page of the gengrid, in pixels,
8809     * for each axis. Sane usable values are, between @c 0 and the
8810     * dimensions of @p obj, for each axis. Values beyond those will
8811     * make it behave behave inconsistently. If you only want one axis
8812     * to snap to pages, use the value @c 0 for the other one.
8813     *
8814     * There is a function setting page size values in @b relative
8815     * values, too -- elm_gengrid_page_relative_set(). Naturally, its
8816     * use is mutually exclusive to this one.
8817     *
8818     * @ingroup Gengrid
8819     */
8820    EAPI void               elm_gengrid_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
8821
8822    /**
8823     * Set the direction in which a given gengrid widget will expand while
8824     * placing its items.
8825     *
8826     * @param obj The gengrid object.
8827     * @param setting @c EINA_TRUE to make the gengrid expand
8828     * horizontally, @c EINA_FALSE to expand vertically.
8829     *
8830     * When in "horizontal mode" (@c EINA_TRUE), items will be placed
8831     * in @b columns, from top to bottom and, when the space for a
8832     * column is filled, another one is started on the right, thus
8833     * expanding the grid horizontally. When in "vertical mode"
8834     * (@c EINA_FALSE), though, items will be placed in @b rows, from left
8835     * to right and, when the space for a row is filled, another one is
8836     * started below, thus expanding the grid vertically.
8837     *
8838     * @see elm_gengrid_horizontal_get()
8839     *
8840     * @ingroup Gengrid
8841     */
8842    EAPI void               elm_gengrid_horizontal_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
8843
8844    /**
8845     * Get for what direction a given gengrid widget will expand while
8846     * placing its items.
8847     *
8848     * @param obj The gengrid object.
8849     * @return @c EINA_TRUE, if @p obj is set to expand horizontally,
8850     * @c EINA_FALSE if it's set to expand vertically.
8851     *
8852     * @see elm_gengrid_horizontal_set() for more detais
8853     *
8854     * @ingroup Gengrid
8855     */
8856    EAPI Eina_Bool          elm_gengrid_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8857
8858    /**
8859     * Get the first item in a given gengrid widget
8860     *
8861     * @param obj The gengrid object
8862     * @return The first item's handle or @c NULL, if there are no
8863     * items in @p obj (and on errors)
8864     *
8865     * This returns the first item in the @p obj's internal list of
8866     * items.
8867     *
8868     * @see elm_gengrid_last_item_get()
8869     *
8870     * @ingroup Gengrid
8871     */
8872    WILL_DEPRECATE EAPI Elm_Gengrid_Item  *elm_gengrid_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8873
8874    /**
8875     * Get the last item in a given gengrid widget
8876     *
8877     * @param obj The gengrid object
8878     * @return The last item's handle or @c NULL, if there are no
8879     * items in @p obj (and on errors)
8880     *
8881     * This returns the last item in the @p obj's internal list of
8882     * items.
8883     *
8884     * @see elm_gengrid_first_item_get()
8885     *
8886     * @ingroup Gengrid
8887     */
8888    WILL_DEPRECATE EAPI Elm_Gengrid_Item  *elm_gengrid_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8889
8890    /**
8891     * Get the @b next item in a gengrid widget's internal list of items,
8892     * given a handle to one of those items.
8893     *
8894     * @param item The gengrid item to fetch next from
8895     * @return The item after @p item, or @c NULL if there's none (and
8896     * on errors)
8897     *
8898     * This returns the item placed after the @p item, on the container
8899     * gengrid.
8900     *
8901     * @see elm_gengrid_item_prev_get()
8902     *
8903     * @ingroup Gengrid
8904     */
8905    WILL_DEPRECATE EAPI Elm_Gengrid_Item  *elm_gengrid_item_next_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8906
8907    /**
8908     * Get the @b previous item in a gengrid widget's internal list of items,
8909     * given a handle to one of those items.
8910     *
8911     * @param item The gengrid item to fetch previous from
8912     * @return The item before @p item, or @c NULL if there's none (and
8913     * on errors)
8914     *
8915     * This returns the item placed before the @p item, on the container
8916     * gengrid.
8917     *
8918     * @see elm_gengrid_item_next_get()
8919     *
8920     * @ingroup Gengrid
8921     */
8922    WILL_DEPRECATE EAPI Elm_Gengrid_Item  *elm_gengrid_item_prev_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8923
8924    /**
8925     * Get the gengrid object's handle which contains a given gengrid
8926     * item
8927     *
8928     * @param item The item to fetch the container from
8929     * @return The gengrid (parent) object
8930     *
8931     * This returns the gengrid object itself that an item belongs to.
8932     *
8933     * @ingroup Gengrid
8934     */
8935    WILL_DEPRECATE EAPI Evas_Object       *elm_gengrid_item_gengrid_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8936
8937    /**
8938     * Remove a gengrid item from its parent, deleting it.
8939     *
8940     * @param item The item to be removed.
8941     * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
8942     *
8943     * @see elm_gengrid_clear(), to remove all items in a gengrid at
8944     * once.
8945     *
8946     * @ingroup Gengrid
8947     */
8948    EAPI void               elm_gengrid_item_del(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8949
8950    /**
8951     * Update the contents of a given gengrid item
8952     *
8953     * @param item The gengrid item
8954     *
8955     * This updates an item by calling all the item class functions
8956     * again to get the contents, labels and states. Use this when the
8957     * original item data has changed and you want the changes to be
8958     * reflected.
8959     *
8960     * @ingroup Gengrid
8961     */
8962    EAPI void               elm_gengrid_item_update(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8963
8964    /**
8965     * Get the Gengrid Item class for the given Gengrid Item.
8966     *
8967     * @param item The gengrid item
8968     *
8969     * This returns the Gengrid_Item_Class for the given item. It can be used to examine
8970     * the function pointers and item_style.
8971     *
8972     * @ingroup Gengrid
8973     */
8974    EAPI const Elm_Gengrid_Item_Class *elm_gengrid_item_item_class_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8975
8976    /**
8977     * Get the Gengrid Item class for the given Gengrid Item.
8978     *
8979     * This sets the Gengrid_Item_Class for the given item. It can be used to examine
8980     * the function pointers and item_style.
8981     *
8982     * @param item The gengrid item
8983     * @param gic The gengrid item class describing the function pointers and the item style.
8984     *
8985     * @ingroup Gengrid
8986     */
8987    EAPI void               elm_gengrid_item_item_class_set(Elm_Gengrid_Item *item, const Elm_Gengrid_Item_Class *gic) EINA_ARG_NONNULL(1, 2);
8988
8989    /**
8990     * Return the data associated to a given gengrid item
8991     *
8992     * @param item The gengrid item.
8993     * @return the data associated with this item.
8994     *
8995     * This returns the @c data value passed on the
8996     * elm_gengrid_item_append() and related item addition calls.
8997     *
8998     * @see elm_gengrid_item_append()
8999     * @see elm_gengrid_item_data_set()
9000     *
9001     * @ingroup Gengrid
9002     */
9003    EAPI void              *elm_gengrid_item_data_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9004
9005    /**
9006     * Set the data associated with a given gengrid item
9007     *
9008     * @param item The gengrid item
9009     * @param data The data pointer to set on it
9010     *
9011     * This @b overrides the @c data value passed on the
9012     * elm_gengrid_item_append() and related item addition calls. This
9013     * function @b won't call elm_gengrid_item_update() automatically,
9014     * so you'd issue it afterwards if you want to have the item
9015     * updated to reflect the new data.
9016     *
9017     * @see elm_gengrid_item_data_get()
9018     * @see elm_gengrid_item_update()
9019     *
9020     * @ingroup Gengrid
9021     */
9022    EAPI void               elm_gengrid_item_data_set(Elm_Gengrid_Item *item, const void *data) EINA_ARG_NONNULL(1);
9023
9024    /**
9025     * Get a given gengrid item's position, relative to the whole
9026     * gengrid's grid area.
9027     *
9028     * @param item The Gengrid item.
9029     * @param x Pointer to variable to store the item's <b>row number</b>.
9030     * @param y Pointer to variable to store the item's <b>column number</b>.
9031     *
9032     * This returns the "logical" position of the item within the
9033     * gengrid. For example, @c (0, 1) would stand for first row,
9034     * second column.
9035     *
9036     * @ingroup Gengrid
9037     */
9038    EAPI void               elm_gengrid_item_pos_get(const Elm_Gengrid_Item *item, unsigned int *x, unsigned int *y) EINA_ARG_NONNULL(1);
9039
9040    /**
9041     * Set whether a given gengrid item is selected or not
9042     *
9043     * @param item The gengrid item
9044     * @param selected Use @c EINA_TRUE, to make it selected, @c
9045     * EINA_FALSE to make it unselected
9046     *
9047     * This sets the selected state of an item. If multi-selection is
9048     * not enabled on the containing gengrid and @p selected is @c
9049     * EINA_TRUE, any other previously selected items will get
9050     * unselected in favor of this new one.
9051     *
9052     * @see elm_gengrid_item_selected_get()
9053     *
9054     * @ingroup Gengrid
9055     */
9056    WILL_DEPRECATE EAPI void elm_gengrid_item_selected_set(Elm_Gengrid_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
9057
9058    /**
9059     * Get whether a given gengrid item is selected or not
9060     *
9061     * @param item The gengrid item
9062     * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
9063     *
9064     * This API returns EINA_TRUE for all the items selected in multi-select mode as well.
9065     *
9066     * @see elm_gengrid_item_selected_set() for more details
9067     *
9068     * @ingroup Gengrid
9069     */
9070    WILL_DEPRECATE EAPI Eina_Bool elm_gengrid_item_selected_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9071
9072    /**
9073     * Get the real Evas object created to implement the view of a
9074     * given gengrid item
9075     *
9076     * @param item The gengrid item.
9077     * @return the Evas object implementing this item's view.
9078     *
9079     * This returns the actual Evas object used to implement the
9080     * specified gengrid item's view. This may be @c NULL, as it may
9081     * not have been created or may have been deleted, at any time, by
9082     * the gengrid. <b>Do not modify this object</b> (move, resize,
9083     * show, hide, etc.), as the gengrid is controlling it. This
9084     * function is for querying, emitting custom signals or hooking
9085     * lower level callbacks for events on that object. Do not delete
9086     * this object under any circumstances.
9087     *
9088     * @see elm_gengrid_item_data_get()
9089     *
9090     * @ingroup Gengrid
9091     */
9092    EAPI const Evas_Object *elm_gengrid_item_object_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9093
9094    /**
9095     * Show the portion of a gengrid's internal grid containing a given
9096     * item, @b immediately.
9097     *
9098     * @param item The item to display
9099     *
9100     * This causes gengrid to @b redraw its viewport's contents to the
9101     * region contining the given @p item item, if it is not fully
9102     * visible.
9103     *
9104     * @see elm_gengrid_item_bring_in()
9105     *
9106     * @ingroup Gengrid
9107     */
9108    EAPI void               elm_gengrid_item_show(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9109
9110    /**
9111     * Animatedly bring in, to the visible area of a gengrid, a given
9112     * item on it.
9113     *
9114     * @param item The gengrid item to display
9115     *
9116     * This causes gengrid to jump to the given @p item and show
9117     * it (by scrolling), if it is not fully visible. This will use
9118     * animation to do so and take a period of time to complete.
9119     *
9120     * @see elm_gengrid_item_show()
9121     *
9122     * @ingroup Gengrid
9123     */
9124    EAPI void               elm_gengrid_item_bring_in(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9125
9126    /**
9127     * Set whether a given gengrid item is disabled or not.
9128     *
9129     * @param item The gengrid item
9130     * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
9131     * to enable it back.
9132     *
9133     * A disabled item cannot be selected or unselected. It will also
9134     * change its appearance, to signal the user it's disabled.
9135     *
9136     * @see elm_gengrid_item_disabled_get()
9137     *
9138     * @ingroup Gengrid
9139     */
9140    EAPI void               elm_gengrid_item_disabled_set(Elm_Gengrid_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
9141
9142    /**
9143     * Get whether a given gengrid item is disabled or not.
9144     *
9145     * @param item The gengrid item
9146     * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
9147     * (and on errors).
9148     *
9149     * @see elm_gengrid_item_disabled_set() for more details
9150     *
9151     * @ingroup Gengrid
9152     */
9153    EAPI Eina_Bool          elm_gengrid_item_disabled_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9154
9155    /**
9156     * Set the text to be shown in a given gengrid item's tooltips.
9157     *
9158     * @param item The gengrid item
9159     * @param text The text to set in the content
9160     *
9161     * This call will setup the text to be used as tooltip to that item
9162     * (analogous to elm_object_tooltip_text_set(), but being item
9163     * tooltips with higher precedence than object tooltips). It can
9164     * have only one tooltip at a time, so any previous tooltip data
9165     * will get removed.
9166     *
9167     * @ingroup Gengrid
9168     */
9169    EAPI void               elm_gengrid_item_tooltip_text_set(Elm_Gengrid_Item *item, const char *text) EINA_ARG_NONNULL(1);
9170
9171    /**
9172     * Set the content to be shown in a given gengrid item's tooltip
9173     *
9174     * @param item The gengrid item.
9175     * @param func The function returning the tooltip contents.
9176     * @param data What to provide to @a func as callback data/context.
9177     * @param del_cb Called when data is not needed anymore, either when
9178     *        another callback replaces @p func, the tooltip is unset with
9179     *        elm_gengrid_item_tooltip_unset() or the owner @p item
9180     *        dies. This callback receives as its first parameter the
9181     *        given @p data, being @c event_info the item handle.
9182     *
9183     * This call will setup the tooltip's contents to @p item
9184     * (analogous to elm_object_tooltip_content_cb_set(), but being
9185     * item tooltips with higher precedence than object tooltips). It
9186     * can have only one tooltip at a time, so any previous tooltip
9187     * content will get removed. @p func (with @p data) will be called
9188     * every time Elementary needs to show the tooltip and it should
9189     * return a valid Evas object, which will be fully managed by the
9190     * tooltip system, getting deleted when the tooltip is gone.
9191     *
9192     * @ingroup Gengrid
9193     */
9194    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);
9195
9196    /**
9197     * Unset a tooltip from a given gengrid item
9198     *
9199     * @param item gengrid item to remove a previously set tooltip from.
9200     *
9201     * This call removes any tooltip set on @p item. The callback
9202     * provided as @c del_cb to
9203     * elm_gengrid_item_tooltip_content_cb_set() will be called to
9204     * notify it is not used anymore (and have resources cleaned, if
9205     * need be).
9206     *
9207     * @see elm_gengrid_item_tooltip_content_cb_set()
9208     *
9209     * @ingroup Gengrid
9210     */
9211    EAPI void               elm_gengrid_item_tooltip_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9212
9213    /**
9214     * Set a different @b style for a given gengrid item's tooltip.
9215     *
9216     * @param item gengrid item with tooltip set
9217     * @param style the <b>theme style</b> to use on tooltips (e.g. @c
9218     * "default", @c "transparent", etc)
9219     *
9220     * Tooltips can have <b>alternate styles</b> to be displayed on,
9221     * which are defined by the theme set on Elementary. This function
9222     * works analogously as elm_object_tooltip_style_set(), but here
9223     * applied only to gengrid item objects. The default style for
9224     * tooltips is @c "default".
9225     *
9226     * @note before you set a style you should define a tooltip with
9227     *       elm_gengrid_item_tooltip_content_cb_set() or
9228     *       elm_gengrid_item_tooltip_text_set()
9229     *
9230     * @see elm_gengrid_item_tooltip_style_get()
9231     *
9232     * @ingroup Gengrid
9233     */
9234    EAPI void               elm_gengrid_item_tooltip_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
9235
9236    /**
9237     * Get the style set a given gengrid item's tooltip.
9238     *
9239     * @param item gengrid item with tooltip already set on.
9240     * @return style the theme style in use, which defaults to
9241     *         "default". If the object does not have a tooltip set,
9242     *         then @c NULL is returned.
9243     *
9244     * @see elm_gengrid_item_tooltip_style_set() for more details
9245     *
9246     * @ingroup Gengrid
9247     */
9248    EAPI const char        *elm_gengrid_item_tooltip_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9249    /**
9250     * @brief Disable size restrictions on an object's tooltip
9251     * @param item The tooltip's anchor object
9252     * @param disable If EINA_TRUE, size restrictions are disabled
9253     * @return EINA_FALSE on failure, EINA_TRUE on success
9254     *
9255     * This function allows a tooltip to expand beyond its parant window's canvas.
9256     * It will instead be limited only by the size of the display.
9257     */
9258    EAPI Eina_Bool          elm_gengrid_item_tooltip_size_restrict_disable(Elm_Gengrid_Item *item, Eina_Bool disable);
9259    /**
9260     * @brief Retrieve size restriction state of an object's tooltip
9261     * @param item The tooltip's anchor object
9262     * @return If EINA_TRUE, size restrictions are disabled
9263     *
9264     * This function returns whether a tooltip is allowed to expand beyond
9265     * its parant window's canvas.
9266     * It will instead be limited only by the size of the display.
9267     */
9268    EAPI Eina_Bool          elm_gengrid_item_tooltip_size_restrict_disabled_get(const Elm_Gengrid_Item *item);
9269    /**
9270     * Set the type of mouse pointer/cursor decoration to be shown,
9271     * when the mouse pointer is over the given gengrid widget item
9272     *
9273     * @param item gengrid item to customize cursor on
9274     * @param cursor the cursor type's name
9275     *
9276     * This function works analogously as elm_object_cursor_set(), but
9277     * here the cursor's changing area is restricted to the item's
9278     * area, and not the whole widget's. Note that that item cursors
9279     * have precedence over widget cursors, so that a mouse over @p
9280     * item will always show cursor @p type.
9281     *
9282     * If this function is called twice for an object, a previously set
9283     * cursor will be unset on the second call.
9284     *
9285     * @see elm_object_cursor_set()
9286     * @see elm_gengrid_item_cursor_get()
9287     * @see elm_gengrid_item_cursor_unset()
9288     *
9289     * @ingroup Gengrid
9290     */
9291    EAPI void               elm_gengrid_item_cursor_set(Elm_Gengrid_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
9292
9293    /**
9294     * Get the type of mouse pointer/cursor decoration set to be shown,
9295     * when the mouse pointer is over the given gengrid widget item
9296     *
9297     * @param item gengrid item with custom cursor set
9298     * @return the cursor type's name or @c NULL, if no custom cursors
9299     * were set to @p item (and on errors)
9300     *
9301     * @see elm_object_cursor_get()
9302     * @see elm_gengrid_item_cursor_set() for more details
9303     * @see elm_gengrid_item_cursor_unset()
9304     *
9305     * @ingroup Gengrid
9306     */
9307    EAPI const char        *elm_gengrid_item_cursor_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9308
9309    /**
9310     * Unset any custom mouse pointer/cursor decoration set to be
9311     * shown, when the mouse pointer is over the given gengrid widget
9312     * item, thus making it show the @b default cursor again.
9313     *
9314     * @param item a gengrid item
9315     *
9316     * Use this call to undo any custom settings on this item's cursor
9317     * decoration, bringing it back to defaults (no custom style set).
9318     *
9319     * @see elm_object_cursor_unset()
9320     * @see elm_gengrid_item_cursor_set() for more details
9321     *
9322     * @ingroup Gengrid
9323     */
9324    EAPI void               elm_gengrid_item_cursor_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9325
9326    /**
9327     * Set a different @b style for a given custom cursor set for a
9328     * gengrid item.
9329     *
9330     * @param item gengrid item with custom cursor set
9331     * @param style the <b>theme style</b> to use (e.g. @c "default",
9332     * @c "transparent", etc)
9333     *
9334     * This function only makes sense when one is using custom mouse
9335     * cursor decorations <b>defined in a theme file</b> , which can
9336     * have, given a cursor name/type, <b>alternate styles</b> on
9337     * it. It works analogously as elm_object_cursor_style_set(), but
9338     * here applied only to gengrid item objects.
9339     *
9340     * @warning Before you set a cursor style you should have defined a
9341     *       custom cursor previously on the item, with
9342     *       elm_gengrid_item_cursor_set()
9343     *
9344     * @see elm_gengrid_item_cursor_engine_only_set()
9345     * @see elm_gengrid_item_cursor_style_get()
9346     *
9347     * @ingroup Gengrid
9348     */
9349    EAPI void               elm_gengrid_item_cursor_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
9350
9351    /**
9352     * Get the current @b style set for a given gengrid item's custom
9353     * cursor
9354     *
9355     * @param item gengrid item with custom cursor set.
9356     * @return style the cursor style in use. If the object does not
9357     *         have a cursor set, then @c NULL is returned.
9358     *
9359     * @see elm_gengrid_item_cursor_style_set() for more details
9360     *
9361     * @ingroup Gengrid
9362     */
9363    EAPI const char        *elm_gengrid_item_cursor_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9364
9365    /**
9366     * Set if the (custom) cursor for a given gengrid item should be
9367     * searched in its theme, also, or should only rely on the
9368     * rendering engine.
9369     *
9370     * @param item item with custom (custom) cursor already set on
9371     * @param engine_only Use @c EINA_TRUE to have cursors looked for
9372     * only on those provided by the rendering engine, @c EINA_FALSE to
9373     * have them searched on the widget's theme, as well.
9374     *
9375     * @note This call is of use only if you've set a custom cursor
9376     * for gengrid items, with elm_gengrid_item_cursor_set().
9377     *
9378     * @note By default, cursors will only be looked for between those
9379     * provided by the rendering engine.
9380     *
9381     * @ingroup Gengrid
9382     */
9383    EAPI void               elm_gengrid_item_cursor_engine_only_set(Elm_Gengrid_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
9384
9385    /**
9386     * Get if the (custom) cursor for a given gengrid item is being
9387     * searched in its theme, also, or is only relying on the rendering
9388     * engine.
9389     *
9390     * @param item a gengrid item
9391     * @return @c EINA_TRUE, if cursors are being looked for only on
9392     * those provided by the rendering engine, @c EINA_FALSE if they
9393     * are being searched on the widget's theme, as well.
9394     *
9395     * @see elm_gengrid_item_cursor_engine_only_set(), for more details
9396     *
9397     * @ingroup Gengrid
9398     */
9399    EAPI Eina_Bool          elm_gengrid_item_cursor_engine_only_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9400
9401    /**
9402     * Remove all items from a given gengrid widget
9403     *
9404     * @param obj The gengrid object.
9405     *
9406     * This removes (and deletes) all items in @p obj, leaving it
9407     * empty.
9408     *
9409     * @see elm_gengrid_item_del(), to remove just one item.
9410     *
9411     * @ingroup Gengrid
9412     */
9413    WILL_DEPRECATE EAPI void elm_gengrid_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
9414
9415    /**
9416     * Get the selected item in a given gengrid widget
9417     *
9418     * @param obj The gengrid object.
9419     * @return The selected item's handleor @c NULL, if none is
9420     * selected at the moment (and on errors)
9421     *
9422     * This returns the selected item in @p obj. If multi selection is
9423     * enabled on @p obj (@see elm_gengrid_multi_select_set()), only
9424     * the first item in the list is selected, which might not be very
9425     * useful. For that case, see elm_gengrid_selected_items_get().
9426     *
9427     * @ingroup Gengrid
9428     */
9429    EAPI Elm_Gengrid_Item  *elm_gengrid_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9430
9431    /**
9432     * Get <b>a list</b> of selected items in a given gengrid
9433     *
9434     * @param obj The gengrid object.
9435     * @return The list of selected items or @c NULL, if none is
9436     * selected at the moment (and on errors)
9437     *
9438     * This returns a list of the selected items, in the order that
9439     * they appear in the grid. This list is only valid as long as no
9440     * more items are selected or unselected (or unselected implictly
9441     * by deletion). The list contains #Elm_Gengrid_Item pointers as
9442     * data, naturally.
9443     *
9444     * @see elm_gengrid_selected_item_get()
9445     *
9446     * @ingroup Gengrid
9447     */
9448    EAPI const Eina_List   *elm_gengrid_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9449
9450    /**
9451     * @}
9452     */
9453
9454    /**
9455     * @defgroup Clock Clock
9456     *
9457     * @image html img/widget/clock/preview-00.png
9458     * @image latex img/widget/clock/preview-00.eps
9459     *
9460     * This is a @b digital clock widget. In its default theme, it has a
9461     * vintage "flipping numbers clock" appearance, which will animate
9462     * sheets of individual algarisms individually as time goes by.
9463     *
9464     * A newly created clock will fetch system's time (already
9465     * considering local time adjustments) to start with, and will tick
9466     * accondingly. It may or may not show seconds.
9467     *
9468     * Clocks have an @b edition mode. When in it, the sheets will
9469     * display extra arrow indications on the top and bottom and the
9470     * user may click on them to raise or lower the time values. After
9471     * it's told to exit edition mode, it will keep ticking with that
9472     * new time set (it keeps the difference from local time).
9473     *
9474     * Also, when under edition mode, user clicks on the cited arrows
9475     * which are @b held for some time will make the clock to flip the
9476     * sheet, thus editing the time, continuosly and automatically for
9477     * the user. The interval between sheet flips will keep growing in
9478     * time, so that it helps the user to reach a time which is distant
9479     * from the one set.
9480     *
9481     * The time display is, by default, in military mode (24h), but an
9482     * am/pm indicator may be optionally shown, too, when it will
9483     * switch to 12h.
9484     *
9485     * Smart callbacks one can register to:
9486     * - "changed" - the clock's user changed the time
9487     *
9488     * Here is an example on its usage:
9489     * @li @ref clock_example
9490     */
9491
9492    /**
9493     * @addtogroup Clock
9494     * @{
9495     */
9496
9497    /**
9498     * Identifiers for which clock digits should be editable, when a
9499     * clock widget is in edition mode. Values may be ORed together to
9500     * make a mask, naturally.
9501     *
9502     * @see elm_clock_edit_set()
9503     * @see elm_clock_digit_edit_set()
9504     */
9505    typedef enum _Elm_Clock_Digedit
9506      {
9507         ELM_CLOCK_NONE         = 0, /**< Default value. Means that all digits are editable, when in edition mode. */
9508         ELM_CLOCK_HOUR_DECIMAL = 1 << 0, /**< Decimal algarism of hours value should be editable */
9509         ELM_CLOCK_HOUR_UNIT    = 1 << 1, /**< Unit algarism of hours value should be editable */
9510         ELM_CLOCK_MIN_DECIMAL  = 1 << 2, /**< Decimal algarism of minutes value should be editable */
9511         ELM_CLOCK_MIN_UNIT     = 1 << 3, /**< Unit algarism of minutes value should be editable */
9512         ELM_CLOCK_SEC_DECIMAL  = 1 << 4, /**< Decimal algarism of seconds value should be editable */
9513         ELM_CLOCK_SEC_UNIT     = 1 << 5, /**< Unit algarism of seconds value should be editable */
9514         ELM_CLOCK_ALL          = (1 << 6) - 1 /**< All digits should be editable */
9515      } Elm_Clock_Digedit;
9516
9517    /**
9518     * Add a new clock widget to the given parent Elementary
9519     * (container) object
9520     *
9521     * @param parent The parent object
9522     * @return a new clock widget handle or @c NULL, on errors
9523     *
9524     * This function inserts a new clock widget on the canvas.
9525     *
9526     * @ingroup Clock
9527     */
9528    EAPI Evas_Object      *elm_clock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9529
9530    /**
9531     * Set a clock widget's time, programmatically
9532     *
9533     * @param obj The clock widget object
9534     * @param hrs The hours to set
9535     * @param min The minutes to set
9536     * @param sec The secondes to set
9537     *
9538     * This function updates the time that is showed by the clock
9539     * widget.
9540     *
9541     *  Values @b must be set within the following ranges:
9542     * - 0 - 23, for hours
9543     * - 0 - 59, for minutes
9544     * - 0 - 59, for seconds,
9545     *
9546     * even if the clock is not in "military" mode.
9547     *
9548     * @warning The behavior for values set out of those ranges is @b
9549     * undefined.
9550     *
9551     * @ingroup Clock
9552     */
9553    EAPI void              elm_clock_time_set(Evas_Object *obj, int hrs, int min, int sec) EINA_ARG_NONNULL(1);
9554
9555    /**
9556     * Get a clock widget's time values
9557     *
9558     * @param obj The clock object
9559     * @param[out] hrs Pointer to the variable to get the hours value
9560     * @param[out] min Pointer to the variable to get the minutes value
9561     * @param[out] sec Pointer to the variable to get the seconds value
9562     *
9563     * This function gets the time set for @p obj, returning
9564     * it on the variables passed as the arguments to function
9565     *
9566     * @note Use @c NULL pointers on the time values you're not
9567     * interested in: they'll be ignored by the function.
9568     *
9569     * @ingroup Clock
9570     */
9571    EAPI void              elm_clock_time_get(const Evas_Object *obj, int *hrs, int *min, int *sec) EINA_ARG_NONNULL(1);
9572
9573    /**
9574     * Set whether a given clock widget is under <b>edition mode</b> or
9575     * under (default) displaying-only mode.
9576     *
9577     * @param obj The clock object
9578     * @param edit @c EINA_TRUE to put it in edition, @c EINA_FALSE to
9579     * put it back to "displaying only" mode
9580     *
9581     * This function makes a clock's time to be editable or not <b>by
9582     * user interaction</b>. When in edition mode, clocks @b stop
9583     * ticking, until one brings them back to canonical mode. The
9584     * elm_clock_digit_edit_set() function will influence which digits
9585     * of the clock will be editable. By default, all of them will be
9586     * (#ELM_CLOCK_NONE).
9587     *
9588     * @note am/pm sheets, if being shown, will @b always be editable
9589     * under edition mode.
9590     *
9591     * @see elm_clock_edit_get()
9592     *
9593     * @ingroup Clock
9594     */
9595    EAPI void              elm_clock_edit_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
9596
9597    /**
9598     * Retrieve whether a given clock widget is under <b>edition
9599     * mode</b> or under (default) displaying-only mode.
9600     *
9601     * @param obj The clock object
9602     * @param edit @c EINA_TRUE, if it's in edition mode, @c EINA_FALSE
9603     * otherwise
9604     *
9605     * This function retrieves whether the clock's time can be edited
9606     * or not by user interaction.
9607     *
9608     * @see elm_clock_edit_set() for more details
9609     *
9610     * @ingroup Clock
9611     */
9612    EAPI Eina_Bool         elm_clock_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9613
9614    /**
9615     * Set what digits of the given clock widget should be editable
9616     * when in edition mode.
9617     *
9618     * @param obj The clock object
9619     * @param digedit Bit mask indicating the digits to be editable
9620     * (values in #Elm_Clock_Digedit).
9621     *
9622     * If the @p digedit param is #ELM_CLOCK_NONE, editing will be
9623     * disabled on @p obj (same effect as elm_clock_edit_set(), with @c
9624     * EINA_FALSE).
9625     *
9626     * @see elm_clock_digit_edit_get()
9627     *
9628     * @ingroup Clock
9629     */
9630    EAPI void              elm_clock_digit_edit_set(Evas_Object *obj, Elm_Clock_Digedit digedit) EINA_ARG_NONNULL(1);
9631
9632    /**
9633     * Retrieve what digits of the given clock widget should be
9634     * editable when in edition mode.
9635     *
9636     * @param obj The clock object
9637     * @return Bit mask indicating the digits to be editable
9638     * (values in #Elm_Clock_Digedit).
9639     *
9640     * @see elm_clock_digit_edit_set() for more details
9641     *
9642     * @ingroup Clock
9643     */
9644    EAPI Elm_Clock_Digedit elm_clock_digit_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9645
9646    /**
9647     * Set if the given clock widget must show hours in military or
9648     * am/pm mode
9649     *
9650     * @param obj The clock object
9651     * @param am_pm @c EINA_TRUE to put it in am/pm mode, @c EINA_FALSE
9652     * to military mode
9653     *
9654     * This function sets if the clock must show hours in military or
9655     * am/pm mode. In some countries like Brazil the military mode
9656     * (00-24h-format) is used, in opposition to the USA, where the
9657     * am/pm mode is more commonly used.
9658     *
9659     * @see elm_clock_show_am_pm_get()
9660     *
9661     * @ingroup Clock
9662     */
9663    EAPI void              elm_clock_show_am_pm_set(Evas_Object *obj, Eina_Bool am_pm) EINA_ARG_NONNULL(1);
9664
9665    /**
9666     * Get if the given clock widget shows hours in military or am/pm
9667     * mode
9668     *
9669     * @param obj The clock object
9670     * @return @c EINA_TRUE, if in am/pm mode, @c EINA_FALSE if in
9671     * military
9672     *
9673     * This function gets if the clock shows hours in military or am/pm
9674     * mode.
9675     *
9676     * @see elm_clock_show_am_pm_set() for more details
9677     *
9678     * @ingroup Clock
9679     */
9680    EAPI Eina_Bool         elm_clock_show_am_pm_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9681
9682    /**
9683     * Set if the given clock widget must show time with seconds or not
9684     *
9685     * @param obj The clock object
9686     * @param seconds @c EINA_TRUE to show seconds, @c EINA_FALSE otherwise
9687     *
9688     * This function sets if the given clock must show or not elapsed
9689     * seconds. By default, they are @b not shown.
9690     *
9691     * @see elm_clock_show_seconds_get()
9692     *
9693     * @ingroup Clock
9694     */
9695    EAPI void              elm_clock_show_seconds_set(Evas_Object *obj, Eina_Bool seconds) EINA_ARG_NONNULL(1);
9696
9697    /**
9698     * Get whether the given clock widget is showing time with seconds
9699     * or not
9700     *
9701     * @param obj The clock object
9702     * @return @c EINA_TRUE if it's showing seconds, @c EINA_FALSE otherwise
9703     *
9704     * This function gets whether @p obj is showing or not the elapsed
9705     * seconds.
9706     *
9707     * @see elm_clock_show_seconds_set()
9708     *
9709     * @ingroup Clock
9710     */
9711    EAPI Eina_Bool         elm_clock_show_seconds_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9712
9713    /**
9714     * Set the interval on time updates for an user mouse button hold
9715     * on clock widgets' time edition.
9716     *
9717     * @param obj The clock object
9718     * @param interval The (first) interval value in seconds
9719     *
9720     * This interval value is @b decreased while the user holds the
9721     * mouse pointer either incrementing or decrementing a given the
9722     * clock digit's value.
9723     *
9724     * This helps the user to get to a given time distant from the
9725     * current one easier/faster, as it will start to flip quicker and
9726     * quicker on mouse button holds.
9727     *
9728     * The calculation for the next flip interval value, starting from
9729     * the one set with this call, is the previous interval divided by
9730     * 1.05, so it decreases a little bit.
9731     *
9732     * The default starting interval value for automatic flips is
9733     * @b 0.85 seconds.
9734     *
9735     * @see elm_clock_interval_get()
9736     *
9737     * @ingroup Clock
9738     */
9739    EAPI void              elm_clock_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
9740
9741    /**
9742     * Get the interval on time updates for an user mouse button hold
9743     * on clock widgets' time edition.
9744     *
9745     * @param obj The clock object
9746     * @return The (first) interval value, in seconds, set on it
9747     *
9748     * @see elm_clock_interval_set() for more details
9749     *
9750     * @ingroup Clock
9751     */
9752    EAPI double            elm_clock_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9753
9754    /**
9755     * @}
9756     */
9757
9758    /**
9759     * @defgroup Layout Layout
9760     *
9761     * @image html img/widget/layout/preview-00.png
9762     * @image latex img/widget/layout/preview-00.eps width=\textwidth
9763     *
9764     * @image html img/layout-predefined.png
9765     * @image latex img/layout-predefined.eps width=\textwidth
9766     *
9767     * This is a container widget that takes a standard Edje design file and
9768     * wraps it very thinly in a widget.
9769     *
9770     * An Edje design (theme) file has a very wide range of possibilities to
9771     * describe the behavior of elements added to the Layout. Check out the Edje
9772     * documentation and the EDC reference to get more information about what can
9773     * be done with Edje.
9774     *
9775     * Just like @ref List, @ref Box, and other container widgets, any
9776     * object added to the Layout will become its child, meaning that it will be
9777     * deleted if the Layout is deleted, move if the Layout is moved, and so on.
9778     *
9779     * The Layout widget can contain as many Contents, Boxes or Tables as
9780     * described in its theme file. For instance, objects can be added to
9781     * different Tables by specifying the respective Table part names. The same
9782     * is valid for Content and Box.
9783     *
9784     * The objects added as child of the Layout will behave as described in the
9785     * part description where they were added. There are 3 possible types of
9786     * parts where a child can be added:
9787     *
9788     * @section secContent Content (SWALLOW part)
9789     *
9790     * Only one object can be added to the @c SWALLOW part (but you still can
9791     * have many @c SWALLOW parts and one object on each of them). Use the @c
9792     * elm_object_content_set/get/unset functions to set, retrieve and unset 
9793     * objects as content of the @c SWALLOW. After being set to this part, the 
9794     * object size, position, visibility, clipping and other description 
9795     * properties will be totally controlled by the description of the given part
9796     * (inside the Edje theme file).
9797     *
9798     * One can use @c evas_object_size_hint_* functions on the child to have some
9799     * kind of control over its behavior, but the resulting behavior will still
9800     * depend heavily on the @c SWALLOW part description.
9801     *
9802     * The Edje theme also can change the part description, based on signals or
9803     * scripts running inside the theme. This change can also be animated. All of
9804     * this will affect the child object set as content accordingly. The object
9805     * size will be changed if the part size is changed, it will animate move if
9806     * the part is moving, and so on.
9807     *
9808     * The following picture demonstrates a Layout widget with a child object
9809     * added to its @c SWALLOW:
9810     *
9811     * @image html layout_swallow.png
9812     * @image latex layout_swallow.eps width=\textwidth
9813     *
9814     * @section secBox Box (BOX part)
9815     *
9816     * An Edje @c BOX part is very similar to the Elementary @ref Box widget. It
9817     * allows one to add objects to the box and have them distributed along its
9818     * area, accordingly to the specified @a layout property (now by @a layout we
9819     * mean the chosen layouting design of the Box, not the Layout widget
9820     * itself).
9821     *
9822     * A similar effect for having a box with its position, size and other things
9823     * controlled by the Layout theme would be to create an Elementary @ref Box
9824     * widget and add it as a Content in the @c SWALLOW part.
9825     *
9826     * The main difference of using the Layout Box is that its behavior, the box
9827     * properties like layouting format, padding, align, etc. will be all
9828     * controlled by the theme. This means, for example, that a signal could be
9829     * sent to the Layout theme (with elm_object_signal_emit()) and the theme
9830     * handled the signal by changing the box padding, or align, or both. Using
9831     * the Elementary @ref Box widget is not necessarily harder or easier, it
9832     * just depends on the circunstances and requirements.
9833     *
9834     * The Layout Box can be used through the @c elm_layout_box_* set of
9835     * functions.
9836     *
9837     * The following picture demonstrates a Layout widget with many child objects
9838     * added to its @c BOX part:
9839     *
9840     * @image html layout_box.png
9841     * @image latex layout_box.eps width=\textwidth
9842     *
9843     * @section secTable Table (TABLE part)
9844     *
9845     * Just like the @ref secBox, the Layout Table is very similar to the
9846     * Elementary @ref Table widget. It allows one to add objects to the Table
9847     * specifying the row and column where the object should be added, and any
9848     * column or row span if necessary.
9849     *
9850     * Again, we could have this design by adding a @ref Table widget to the @c
9851     * SWALLOW part using elm_object_part_content_set(). The same difference happens
9852     * here when choosing to use the Layout Table (a @c TABLE part) instead of
9853     * the @ref Table plus @c SWALLOW part. It's just a matter of convenience.
9854     *
9855     * The Layout Table can be used through the @c elm_layout_table_* set of
9856     * functions.
9857     *
9858     * The following picture demonstrates a Layout widget with many child objects
9859     * added to its @c TABLE part:
9860     *
9861     * @image html layout_table.png
9862     * @image latex layout_table.eps width=\textwidth
9863     *
9864     * @section secPredef Predefined Layouts
9865     *
9866     * Another interesting thing about the Layout widget is that it offers some
9867     * predefined themes that come with the default Elementary theme. These
9868     * themes can be set by the call elm_layout_theme_set(), and provide some
9869     * basic functionality depending on the theme used.
9870     *
9871     * Most of them already send some signals, some already provide a toolbar or
9872     * back and next buttons.
9873     *
9874     * These are available predefined theme layouts. All of them have class = @c
9875     * layout, group = @c application, and style = one of the following options:
9876     *
9877     * @li @c toolbar-content - application with toolbar and main content area
9878     * @li @c toolbar-content-back - application with toolbar and main content
9879     * area with a back button and title area
9880     * @li @c toolbar-content-back-next - application with toolbar and main
9881     * content area with a back and next buttons and title area
9882     * @li @c content-back - application with a main content area with a back
9883     * button and title area
9884     * @li @c content-back-next - application with a main content area with a
9885     * back and next buttons and title area
9886     * @li @c toolbar-vbox - application with toolbar and main content area as a
9887     * vertical box
9888     * @li @c toolbar-table - application with toolbar and main content area as a
9889     * table
9890     *
9891     * @section secExamples Examples
9892     *
9893     * Some examples of the Layout widget can be found here:
9894     * @li @ref layout_example_01
9895     * @li @ref layout_example_02
9896     * @li @ref layout_example_03
9897     * @li @ref layout_example_edc
9898     *
9899     */
9900
9901    /**
9902     * Add a new layout to the parent
9903     *
9904     * @param parent The parent object
9905     * @return The new object or NULL if it cannot be created
9906     *
9907     * @see elm_layout_file_set()
9908     * @see elm_layout_theme_set()
9909     *
9910     * @ingroup Layout
9911     */
9912    EAPI Evas_Object       *elm_layout_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9913    /**
9914     * Set the file that will be used as layout
9915     *
9916     * @param obj The layout object
9917     * @param file The path to file (edj) that will be used as layout
9918     * @param group The group that the layout belongs in edje file
9919     *
9920     * @return (1 = success, 0 = error)
9921     *
9922     * @ingroup Layout
9923     */
9924    EAPI Eina_Bool          elm_layout_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
9925    /**
9926     * Set the edje group from the elementary theme that will be used as layout
9927     *
9928     * @param obj The layout object
9929     * @param clas the clas of the group
9930     * @param group the group
9931     * @param style the style to used
9932     *
9933     * @return (1 = success, 0 = error)
9934     *
9935     * @ingroup Layout
9936     */
9937    EAPI Eina_Bool          elm_layout_theme_set(Evas_Object *obj, const char *clas, const char *group, const char *style) EINA_ARG_NONNULL(1);
9938    /**
9939     * Set the layout content.
9940     *
9941     * @param obj The layout object
9942     * @param swallow The swallow part name in the edje file
9943     * @param content The child that will be added in this layout object
9944     *
9945     * Once the content object is set, a previously set one will be deleted.
9946     * If you want to keep that old content object, use the
9947     * elm_object_part_content_unset() function.
9948     *
9949     * @note In an Edje theme, the part used as a content container is called @c
9950     * SWALLOW. This is why the parameter name is called @p swallow, but it is
9951     * expected to be a part name just like the second parameter of
9952     * elm_layout_box_append().
9953     *
9954     * @see elm_layout_box_append()
9955     * @see elm_object_part_content_get()
9956     * @see elm_object_part_content_unset()
9957     * @see @ref secBox
9958     * @deprecated use elm_object_part_content_set() instead
9959     *
9960     * @ingroup Layout
9961     */
9962    WILL_DEPRECATE EAPI void               elm_layout_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
9963    /**
9964     * Get the child object in the given content part.
9965     *
9966     * @param obj The layout object
9967     * @param swallow The SWALLOW part to get its content
9968     *
9969     * @return The swallowed object or NULL if none or an error occurred
9970     *
9971     * @deprecated use elm_object_part_content_get() instead
9972     *
9973     * @ingroup Layout
9974     */
9975    WILL_DEPRECATE EAPI Evas_Object       *elm_layout_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
9976    /**
9977     * Unset the layout content.
9978     *
9979     * @param obj The layout object
9980     * @param swallow The swallow part name in the edje file
9981     * @return The content that was being used
9982     *
9983     * Unparent and return the content object which was set for this part.
9984     *
9985     * @deprecated use elm_object_part_content_unset() instead
9986     *
9987     * @ingroup Layout
9988     */
9989    WILL_DEPRECATE EAPI Evas_Object       *elm_layout_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
9990    /**
9991     * Set the text of the given part
9992     *
9993     * @param obj The layout object
9994     * @param part The TEXT part where to set the text
9995     * @param text The text to set
9996     *
9997     * @ingroup Layout
9998     * @deprecated use elm_object_part_text_set() instead.
9999     */
10000    EINA_DEPRECATED EAPI void               elm_layout_text_set(Evas_Object *obj, const char *part, const char *text) EINA_ARG_NONNULL(1);
10001    /**
10002     * Get the text set in the given part
10003     *
10004     * @param obj The layout object
10005     * @param part The TEXT part to retrieve the text off
10006     *
10007     * @return The text set in @p part
10008     *
10009     * @ingroup Layout
10010     * @deprecated use elm_object_part_text_get() instead.
10011     */
10012    EINA_DEPRECATED EAPI const char        *elm_layout_text_get(const Evas_Object *obj, const char *part) EINA_ARG_NONNULL(1);
10013    /**
10014     * Append child to layout box part.
10015     *
10016     * @param obj the layout object
10017     * @param part the box part to which the object will be appended.
10018     * @param child the child object to append to box.
10019     *
10020     * Once the object is appended, it will become child of the layout. Its
10021     * lifetime will be bound to the layout, whenever the layout dies the child
10022     * will be deleted automatically. One should use elm_layout_box_remove() to
10023     * make this layout forget about the object.
10024     *
10025     * @see elm_layout_box_prepend()
10026     * @see elm_layout_box_insert_before()
10027     * @see elm_layout_box_insert_at()
10028     * @see elm_layout_box_remove()
10029     *
10030     * @ingroup Layout
10031     */
10032    EAPI void               elm_layout_box_append(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
10033    /**
10034     * Prepend child to layout box part.
10035     *
10036     * @param obj the layout object
10037     * @param part the box part to prepend.
10038     * @param child the child object to prepend to box.
10039     *
10040     * Once the object is prepended, it will become child of the layout. Its
10041     * lifetime will be bound to the layout, whenever the layout dies the child
10042     * will be deleted automatically. One should use elm_layout_box_remove() to
10043     * make this layout forget about the object.
10044     *
10045     * @see elm_layout_box_append()
10046     * @see elm_layout_box_insert_before()
10047     * @see elm_layout_box_insert_at()
10048     * @see elm_layout_box_remove()
10049     *
10050     * @ingroup Layout
10051     */
10052    EAPI void               elm_layout_box_prepend(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
10053    /**
10054     * Insert child to layout box part before a reference object.
10055     *
10056     * @param obj the layout object
10057     * @param part the box part to insert.
10058     * @param child the child object to insert into box.
10059     * @param reference another reference object to insert before in box.
10060     *
10061     * Once the object is inserted, it will become child of the layout. Its
10062     * lifetime will be bound to the layout, whenever the layout dies the child
10063     * will be deleted automatically. One should use elm_layout_box_remove() to
10064     * make this layout forget about the object.
10065     *
10066     * @see elm_layout_box_append()
10067     * @see elm_layout_box_prepend()
10068     * @see elm_layout_box_insert_before()
10069     * @see elm_layout_box_remove()
10070     *
10071     * @ingroup Layout
10072     */
10073    EAPI void               elm_layout_box_insert_before(Evas_Object *obj, const char *part, Evas_Object *child, const Evas_Object *reference) EINA_ARG_NONNULL(1);
10074    /**
10075     * Insert child to layout box part at a given position.
10076     *
10077     * @param obj the layout object
10078     * @param part the box part to insert.
10079     * @param child the child object to insert into box.
10080     * @param pos the numeric position >=0 to insert the child.
10081     *
10082     * Once the object is inserted, it will become child of the layout. Its
10083     * lifetime will be bound to the layout, whenever the layout dies the child
10084     * will be deleted automatically. One should use elm_layout_box_remove() to
10085     * make this layout forget about the object.
10086     *
10087     * @see elm_layout_box_append()
10088     * @see elm_layout_box_prepend()
10089     * @see elm_layout_box_insert_before()
10090     * @see elm_layout_box_remove()
10091     *
10092     * @ingroup Layout
10093     */
10094    EAPI void               elm_layout_box_insert_at(Evas_Object *obj, const char *part, Evas_Object *child, unsigned int pos) EINA_ARG_NONNULL(1);
10095    /**
10096     * Remove a child of the given part box.
10097     *
10098     * @param obj The layout object
10099     * @param part The box part name to remove child.
10100     * @param child The object to remove from box.
10101     * @return The object that was being used, or NULL if not found.
10102     *
10103     * The object will be removed from the box part and its lifetime will
10104     * not be handled by the layout anymore. This is equivalent to
10105     * elm_object_part_content_unset() for box.
10106     *
10107     * @see elm_layout_box_append()
10108     * @see elm_layout_box_remove_all()
10109     *
10110     * @ingroup Layout
10111     */
10112    EAPI Evas_Object       *elm_layout_box_remove(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1, 2, 3);
10113    /**
10114     * Remove all children of the given part box.
10115     *
10116     * @param obj The layout object
10117     * @param part The box part name to remove child.
10118     * @param clear If EINA_TRUE, then all objects will be deleted as
10119     *        well, otherwise they will just be removed and will be
10120     *        dangling on the canvas.
10121     *
10122     * The objects will be removed from the box part and their lifetime will
10123     * not be handled by the layout anymore. This is equivalent to
10124     * elm_layout_box_remove() for all box children.
10125     *
10126     * @see elm_layout_box_append()
10127     * @see elm_layout_box_remove()
10128     *
10129     * @ingroup Layout
10130     */
10131    EAPI void               elm_layout_box_remove_all(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
10132    /**
10133     * Insert child to layout table part.
10134     *
10135     * @param obj the layout object
10136     * @param part the box part to pack child.
10137     * @param child_obj the child object to pack into table.
10138     * @param col the column to which the child should be added. (>= 0)
10139     * @param row the row to which the child should be added. (>= 0)
10140     * @param colspan how many columns should be used to store this object. (>=
10141     *        1)
10142     * @param rowspan how many rows should be used to store this object. (>= 1)
10143     *
10144     * Once the object is inserted, it will become child of the table. Its
10145     * lifetime will be bound to the layout, and whenever the layout dies the
10146     * child will be deleted automatically. One should use
10147     * elm_layout_table_remove() to make this layout forget about the object.
10148     *
10149     * If @p colspan or @p rowspan are bigger than 1, that object will occupy
10150     * more space than a single cell. For instance, the following code:
10151     * @code
10152     * elm_layout_table_pack(layout, "table_part", child, 0, 1, 3, 1);
10153     * @endcode
10154     *
10155     * Would result in an object being added like the following picture:
10156     *
10157     * @image html layout_colspan.png
10158     * @image latex layout_colspan.eps width=\textwidth
10159     *
10160     * @see elm_layout_table_unpack()
10161     * @see elm_layout_table_clear()
10162     *
10163     * @ingroup Layout
10164     */
10165    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);
10166    /**
10167     * Unpack (remove) a child of the given part table.
10168     *
10169     * @param obj The layout object
10170     * @param part The table part name to remove child.
10171     * @param child_obj The object to remove from table.
10172     * @return The object that was being used, or NULL if not found.
10173     *
10174     * The object will be unpacked from the table part and its lifetime
10175     * will not be handled by the layout anymore. This is equivalent to
10176     * elm_object_part_content_unset() for table.
10177     *
10178     * @see elm_layout_table_pack()
10179     * @see elm_layout_table_clear()
10180     *
10181     * @ingroup Layout
10182     */
10183    EAPI Evas_Object       *elm_layout_table_unpack(Evas_Object *obj, const char *part, Evas_Object *child_obj) EINA_ARG_NONNULL(1, 2, 3);
10184    /**
10185     * Remove all the child objects of the given part table.
10186     *
10187     * @param obj The layout object
10188     * @param part The table part name to remove child.
10189     * @param clear If EINA_TRUE, then all objects will be deleted as
10190     *        well, otherwise they will just be removed and will be
10191     *        dangling on the canvas.
10192     *
10193     * The objects will be removed from the table part and their lifetime will
10194     * not be handled by the layout anymore. This is equivalent to
10195     * elm_layout_table_unpack() for all table children.
10196     *
10197     * @see elm_layout_table_pack()
10198     * @see elm_layout_table_unpack()
10199     *
10200     * @ingroup Layout
10201     */
10202    EAPI void               elm_layout_table_clear(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
10203    /**
10204     * Get the edje layout
10205     *
10206     * @param obj The layout object
10207     *
10208     * @return A Evas_Object with the edje layout settings loaded
10209     * with function elm_layout_file_set
10210     *
10211     * This returns the edje object. It is not expected to be used to then
10212     * swallow objects via edje_object_part_swallow() for example. Use
10213     * elm_object_part_content_set() instead so child object handling and sizing is
10214     * done properly.
10215     *
10216     * @note This function should only be used if you really need to call some
10217     * low level Edje function on this edje object. All the common stuff (setting
10218     * text, emitting signals, hooking callbacks to signals, etc.) can be done
10219     * with proper elementary functions.
10220     *
10221     * @see elm_object_signal_callback_add()
10222     * @see elm_object_signal_emit()
10223     * @see elm_object_part_text_set()
10224     * @see elm_object_part_content_set()
10225     * @see elm_layout_box_append()
10226     * @see elm_layout_table_pack()
10227     * @see elm_layout_data_get()
10228     *
10229     * @ingroup Layout
10230     */
10231    EAPI Evas_Object       *elm_layout_edje_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10232    /**
10233     * Get the edje data from the given layout
10234     *
10235     * @param obj The layout object
10236     * @param key The data key
10237     *
10238     * @return The edje data string
10239     *
10240     * This function fetches data specified inside the edje theme of this layout.
10241     * This function return NULL if data is not found.
10242     *
10243     * In EDC this comes from a data block within the group block that @p
10244     * obj was loaded from. E.g.
10245     *
10246     * @code
10247     * collections {
10248     *   group {
10249     *     name: "a_group";
10250     *     data {
10251     *       item: "key1" "value1";
10252     *       item: "key2" "value2";
10253     *     }
10254     *   }
10255     * }
10256     * @endcode
10257     *
10258     * @ingroup Layout
10259     */
10260    EAPI const char        *elm_layout_data_get(const Evas_Object *obj, const char *key) EINA_ARG_NONNULL(1, 2);
10261    /**
10262     * Eval sizing
10263     *
10264     * @param obj The layout object
10265     *
10266     * Manually forces a sizing re-evaluation. This is useful when the minimum
10267     * size required by the edje theme of this layout has changed. The change on
10268     * the minimum size required by the edje theme is not immediately reported to
10269     * the elementary layout, so one needs to call this function in order to tell
10270     * the widget (layout) that it needs to reevaluate its own size.
10271     *
10272     * The minimum size of the theme is calculated based on minimum size of
10273     * parts, the size of elements inside containers like box and table, etc. All
10274     * of this can change due to state changes, and that's when this function
10275     * should be called.
10276     *
10277     * Also note that a standard signal of "size,eval" "elm" emitted from the
10278     * edje object will cause this to happen too.
10279     *
10280     * @ingroup Layout
10281     */
10282    EAPI void               elm_layout_sizing_eval(Evas_Object *obj) EINA_ARG_NONNULL(1);
10283
10284    /**
10285     * Sets a specific cursor for an edje part.
10286     *
10287     * @param obj The layout object.
10288     * @param part_name a part from loaded edje group.
10289     * @param cursor cursor name to use, see Elementary_Cursor.h
10290     *
10291     * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10292     *         part not exists or it has "mouse_events: 0".
10293     *
10294     * @ingroup Layout
10295     */
10296    EAPI Eina_Bool          elm_layout_part_cursor_set(Evas_Object *obj, const char *part_name, const char *cursor) EINA_ARG_NONNULL(1, 2);
10297
10298    /**
10299     * Get the cursor to be shown when mouse is over an edje part
10300     *
10301     * @param obj The layout object.
10302     * @param part_name a part from loaded edje group.
10303     * @return the cursor name.
10304     *
10305     * @ingroup Layout
10306     */
10307    EAPI const char        *elm_layout_part_cursor_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10308
10309    /**
10310     * Unsets a cursor previously set with elm_layout_part_cursor_set().
10311     *
10312     * @param obj The layout object.
10313     * @param part_name a part from loaded edje group, that had a cursor set
10314     *        with elm_layout_part_cursor_set().
10315     *
10316     * @ingroup Layout
10317     */
10318    EAPI void               elm_layout_part_cursor_unset(Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10319
10320    /**
10321     * Sets a specific cursor style for an edje part.
10322     *
10323     * @param obj The layout object.
10324     * @param part_name a part from loaded edje group.
10325     * @param style the theme style to use (default, transparent, ...)
10326     *
10327     * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10328     *         part not exists or it did not had a cursor set.
10329     *
10330     * @ingroup Layout
10331     */
10332    EAPI Eina_Bool          elm_layout_part_cursor_style_set(Evas_Object *obj, const char *part_name, const char *style) EINA_ARG_NONNULL(1, 2);
10333
10334    /**
10335     * Gets a specific cursor style for an edje part.
10336     *
10337     * @param obj The layout object.
10338     * @param part_name a part from loaded edje group.
10339     *
10340     * @return the theme style in use, defaults to "default". If the
10341     *         object does not have a cursor set, then NULL is returned.
10342     *
10343     * @ingroup Layout
10344     */
10345    EAPI const char        *elm_layout_part_cursor_style_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10346
10347    /**
10348     * Sets if the cursor set should be searched on the theme or should use
10349     * the provided by the engine, only.
10350     *
10351     * @note before you set if should look on theme you should define a
10352     * cursor with elm_layout_part_cursor_set(). By default it will only
10353     * look for cursors provided by the engine.
10354     *
10355     * @param obj The layout object.
10356     * @param part_name a part from loaded edje group.
10357     * @param engine_only if cursors should be just provided by the engine (EINA_TRUE)
10358     *        or should also search on widget's theme as well (EINA_FALSE)
10359     *
10360     * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10361     *         part not exists or it did not had a cursor set.
10362     *
10363     * @ingroup Layout
10364     */
10365    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);
10366
10367    /**
10368     * Gets a specific cursor engine_only for an edje part.
10369     *
10370     * @param obj The layout object.
10371     * @param part_name a part from loaded edje group.
10372     *
10373     * @return whenever the cursor is just provided by engine or also from theme.
10374     *
10375     * @ingroup Layout
10376     */
10377    EAPI Eina_Bool          elm_layout_part_cursor_engine_only_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10378
10379 /**
10380  * @def elm_layout_icon_set
10381  * Convenience macro to set the icon object in a layout that follows the
10382  * Elementary naming convention for its parts.
10383  *
10384  * @ingroup Layout
10385  */
10386 #define elm_layout_icon_set(_ly, _obj) \
10387   do { \
10388     const char *sig; \
10389     elm_object_part_content_set((_ly), "elm.swallow.icon", (_obj)); \
10390     if ((_obj)) sig = "elm,state,icon,visible"; \
10391     else sig = "elm,state,icon,hidden"; \
10392     elm_object_signal_emit((_ly), sig, "elm"); \
10393   } while (0)
10394
10395 /**
10396  * @def elm_layout_icon_get
10397  * Convienience macro to get the icon object from a layout that follows the
10398  * Elementary naming convention for its parts.
10399  *
10400  * @ingroup Layout
10401  */
10402 #define elm_layout_icon_get(_ly) \
10403   elm_object_part_content_get((_ly), "elm.swallow.icon")
10404
10405 /**
10406  * @def elm_layout_end_set
10407  * Convienience macro to set the end object in a layout that follows the
10408  * Elementary naming convention for its parts.
10409  *
10410  * @ingroup Layout
10411  */
10412 #define elm_layout_end_set(_ly, _obj) \
10413   do { \
10414     const char *sig; \
10415     elm_object_part_content_set((_ly), "elm.swallow.end", (_obj)); \
10416     if ((_obj)) sig = "elm,state,end,visible"; \
10417     else sig = "elm,state,end,hidden"; \
10418     elm_object_signal_emit((_ly), sig, "elm"); \
10419   } while (0)
10420
10421 /**
10422  * @def elm_layout_end_get
10423  * Convienience macro to get the end object in a layout that follows the
10424  * Elementary naming convention for its parts.
10425  *
10426  * @ingroup Layout
10427  */
10428 #define elm_layout_end_get(_ly) \
10429   elm_object_part_content_get((_ly), "elm.swallow.end")
10430
10431 /**
10432  * @def elm_layout_label_set
10433  * Convienience macro to set the label in a layout that follows the
10434  * Elementary naming convention for its parts.
10435  *
10436  * @ingroup Layout
10437  * @deprecated use elm_object_text_set() instead.
10438  */
10439 #define elm_layout_label_set(_ly, _txt) \
10440   elm_layout_text_set((_ly), "elm.text", (_txt))
10441
10442 /**
10443  * @def elm_layout_label_get
10444  * Convenience macro to get the label in a layout that follows the
10445  * Elementary naming convention for its parts.
10446  *
10447  * @ingroup Layout
10448  * @deprecated use elm_object_text_set() instead.
10449  */
10450 #define elm_layout_label_get(_ly) \
10451   elm_layout_text_get((_ly), "elm.text")
10452
10453    /* smart callbacks called:
10454     * "theme,changed" - when elm theme is changed.
10455     */
10456
10457    /**
10458     * @defgroup Notify Notify
10459     *
10460     * @image html img/widget/notify/preview-00.png
10461     * @image latex img/widget/notify/preview-00.eps
10462     *
10463     * Display a container in a particular region of the parent(top, bottom,
10464     * etc).  A timeout can be set to automatically hide the notify. This is so
10465     * that, after an evas_object_show() on a notify object, if a timeout was set
10466     * on it, it will @b automatically get hidden after that time.
10467     *
10468     * Signals that you can add callbacks for are:
10469     * @li "timeout" - when timeout happens on notify and it's hidden
10470     * @li "block,clicked" - when a click outside of the notify happens
10471     *
10472     * Default contents parts of the notify widget that you can use for are:
10473     * @li "default" - A content of the notify
10474     *
10475     * @ref tutorial_notify show usage of the API.
10476     *
10477     * @{
10478     */
10479    /**
10480     * @brief Possible orient values for notify.
10481     *
10482     * This values should be used in conjunction to elm_notify_orient_set() to
10483     * set the position in which the notify should appear(relative to its parent)
10484     * and in conjunction with elm_notify_orient_get() to know where the notify
10485     * is appearing.
10486     */
10487    typedef enum _Elm_Notify_Orient
10488      {
10489         ELM_NOTIFY_ORIENT_TOP, /**< Notify should appear in the top of parent, default */
10490         ELM_NOTIFY_ORIENT_CENTER, /**< Notify should appear in the center of parent */
10491         ELM_NOTIFY_ORIENT_BOTTOM, /**< Notify should appear in the bottom of parent */
10492         ELM_NOTIFY_ORIENT_LEFT, /**< Notify should appear in the left of parent */
10493         ELM_NOTIFY_ORIENT_RIGHT, /**< Notify should appear in the right of parent */
10494         ELM_NOTIFY_ORIENT_TOP_LEFT, /**< Notify should appear in the top left of parent */
10495         ELM_NOTIFY_ORIENT_TOP_RIGHT, /**< Notify should appear in the top right of parent */
10496         ELM_NOTIFY_ORIENT_BOTTOM_LEFT, /**< Notify should appear in the bottom left of parent */
10497         ELM_NOTIFY_ORIENT_BOTTOM_RIGHT, /**< Notify should appear in the bottom right of parent */
10498         ELM_NOTIFY_ORIENT_LAST /**< Sentinel value, @b don't use */
10499      } Elm_Notify_Orient;
10500    /**
10501     * @brief Add a new notify to the parent
10502     *
10503     * @param parent The parent object
10504     * @return The new object or NULL if it cannot be created
10505     */
10506    EAPI Evas_Object      *elm_notify_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10507    /**
10508     * @brief Set the content of the notify widget
10509     *
10510     * @param obj The notify object
10511     * @param content The content will be filled in this notify object
10512     *
10513     * Once the content object is set, a previously set one will be deleted. If
10514     * you want to keep that old content object, use the
10515     * elm_notify_content_unset() function.
10516     *
10517     * @deprecated use elm_object_content_set() instead
10518     *
10519     */
10520    WILL_DEPRECATE  EAPI void              elm_notify_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
10521    /**
10522     * @brief Unset the content of the notify widget
10523     *
10524     * @param obj The notify object
10525     * @return The content that was being used
10526     *
10527     * Unparent and return the content object which was set for this widget
10528     *
10529     * @see elm_notify_content_set()
10530     * @deprecated use elm_object_content_unset() instead
10531     *
10532     */
10533    WILL_DEPRECATE  EAPI Evas_Object      *elm_notify_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
10534    /**
10535     * @brief Return the content of the notify widget
10536     *
10537     * @param obj The notify object
10538     * @return The content that is being used
10539     *
10540     * @see elm_notify_content_set()
10541     * @deprecated use elm_object_content_get() instead
10542     *
10543     */
10544    WILL_DEPRECATE  EAPI Evas_Object      *elm_notify_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10545    /**
10546     * @brief Set the notify parent
10547     *
10548     * @param obj The notify object
10549     * @param content The new parent
10550     *
10551     * Once the parent object is set, a previously set one will be disconnected
10552     * and replaced.
10553     */
10554    EAPI void              elm_notify_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10555    /**
10556     * @brief Get the notify parent
10557     *
10558     * @param obj The notify object
10559     * @return The parent
10560     *
10561     * @see elm_notify_parent_set()
10562     */
10563    EAPI Evas_Object      *elm_notify_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10564    /**
10565     * @brief Set the orientation
10566     *
10567     * @param obj The notify object
10568     * @param orient The new orientation
10569     *
10570     * Sets the position in which the notify will appear in its parent.
10571     *
10572     * @see @ref Elm_Notify_Orient for possible values.
10573     */
10574    EAPI void              elm_notify_orient_set(Evas_Object *obj, Elm_Notify_Orient orient) EINA_ARG_NONNULL(1);
10575    /**
10576     * @brief Return the orientation
10577     * @param obj The notify object
10578     * @return The orientation of the notification
10579     *
10580     * @see elm_notify_orient_set()
10581     * @see Elm_Notify_Orient
10582     */
10583    EAPI Elm_Notify_Orient elm_notify_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10584    /**
10585     * @brief Set the time interval after which the notify window is going to be
10586     * hidden.
10587     *
10588     * @param obj The notify object
10589     * @param time The timeout in seconds
10590     *
10591     * This function sets a timeout and starts the timer controlling when the
10592     * notify is hidden. Since calling evas_object_show() on a notify restarts
10593     * the timer controlling when the notify is hidden, setting this before the
10594     * notify is shown will in effect mean starting the timer when the notify is
10595     * shown.
10596     *
10597     * @note Set a value <= 0.0 to disable a running timer.
10598     *
10599     * @note If the value > 0.0 and the notify is previously visible, the
10600     * timer will be started with this value, canceling any running timer.
10601     */
10602    EAPI void              elm_notify_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
10603    /**
10604     * @brief Return the timeout value (in seconds)
10605     * @param obj the notify object
10606     *
10607     * @see elm_notify_timeout_set()
10608     */
10609    EAPI double            elm_notify_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10610    /**
10611     * @brief Sets whether events should be passed to by a click outside
10612     * its area.
10613     *
10614     * @param obj The notify object
10615     * @param repeats EINA_TRUE Events are repeats, else no
10616     *
10617     * When true if the user clicks outside the window the events will be caught
10618     * by the others widgets, else the events are blocked.
10619     *
10620     * @note The default value is EINA_TRUE.
10621     */
10622    EAPI void              elm_notify_repeat_events_set(Evas_Object *obj, Eina_Bool repeat) EINA_ARG_NONNULL(1);
10623    /**
10624     * @brief Return true if events are repeat below the notify object
10625     * @param obj the notify object
10626     *
10627     * @see elm_notify_repeat_events_set()
10628     */
10629    EAPI Eina_Bool         elm_notify_repeat_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10630    /**
10631     * @}
10632     */
10633
10634    /**
10635     * @defgroup Hover Hover
10636     *
10637     * @image html img/widget/hover/preview-00.png
10638     * @image latex img/widget/hover/preview-00.eps
10639     *
10640     * A Hover object will hover over its @p parent object at the @p target
10641     * location. Anything in the background will be given a darker coloring to
10642     * indicate that the hover object is on top (at the default theme). When the
10643     * hover is clicked it is dismissed(hidden), if the contents of the hover are
10644     * clicked that @b doesn't cause the hover to be dismissed.
10645     *
10646     * A Hover object has two parents. One parent that owns it during creation
10647     * and the other parent being the one over which the hover object spans.
10648     *
10649     *
10650     * @note The hover object will take up the entire space of @p target
10651     * object.
10652     *
10653     * Elementary has the following styles for the hover widget:
10654     * @li default
10655     * @li popout
10656     * @li menu
10657     * @li hoversel_vertical
10658     *
10659     * The following are the available position for content:
10660     * @li left
10661     * @li top-left
10662     * @li top
10663     * @li top-right
10664     * @li right
10665     * @li bottom-right
10666     * @li bottom
10667     * @li bottom-left
10668     * @li middle
10669     * @li smart
10670     *
10671     * Signals that you can add callbacks for are:
10672     * @li "clicked" - the user clicked the empty space in the hover to dismiss
10673     * @li "smart,changed" - a content object placed under the "smart"
10674     *                   policy was replaced to a new slot direction.
10675     *
10676     * See @ref tutorial_hover for more information.
10677     *
10678     * @{
10679     */
10680    typedef enum _Elm_Hover_Axis
10681      {
10682         ELM_HOVER_AXIS_NONE, /**< ELM_HOVER_AXIS_NONE -- no prefered orientation */
10683         ELM_HOVER_AXIS_HORIZONTAL, /**< ELM_HOVER_AXIS_HORIZONTAL -- horizontal */
10684         ELM_HOVER_AXIS_VERTICAL, /**< ELM_HOVER_AXIS_VERTICAL -- vertical */
10685         ELM_HOVER_AXIS_BOTH /**< ELM_HOVER_AXIS_BOTH -- both */
10686      } Elm_Hover_Axis;
10687    /**
10688     * @brief Adds a hover object to @p parent
10689     *
10690     * @param parent The parent object
10691     * @return The hover object or NULL if one could not be created
10692     */
10693    EAPI Evas_Object *elm_hover_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10694    /**
10695     * @brief Sets the target object for the hover.
10696     *
10697     * @param obj The hover object
10698     * @param target The object to center the hover onto.
10699     *
10700     * This function will cause the hover to be centered on the target object.
10701     */
10702    EAPI void         elm_hover_target_set(Evas_Object *obj, Evas_Object *target) EINA_ARG_NONNULL(1);
10703    /**
10704     * @brief Gets the target object for the hover.
10705     *
10706     * @param obj The hover object
10707     * @return The target object for the hover.
10708     *
10709     * @see elm_hover_target_set()
10710     */
10711    EAPI Evas_Object *elm_hover_target_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10712    /**
10713     * @brief Sets the parent object for the hover.
10714     *
10715     * @param obj The hover object
10716     * @param parent The object to locate the hover over.
10717     *
10718     * This function will cause the hover to take up the entire space that the
10719     * parent object fills.
10720     */
10721    EAPI void         elm_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10722    /**
10723     * @brief Gets the parent object for the hover.
10724     *
10725     * @param obj The hover object
10726     * @return The parent object to locate the hover over.
10727     *
10728     * @see elm_hover_parent_set()
10729     */
10730    EAPI Evas_Object *elm_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10731    /**
10732     * @brief Sets the content of the hover object and the direction in which it
10733     * will pop out.
10734     *
10735     * @param obj The hover object
10736     * @param swallow The direction that the object will be displayed
10737     * at. Accepted values are "left", "top-left", "top", "top-right",
10738     * "right", "bottom-right", "bottom", "bottom-left", "middle" and
10739     * "smart".
10740     * @param content The content to place at @p swallow
10741     *
10742     * Once the content object is set for a given direction, a previously
10743     * set one (on the same direction) will be deleted. If you want to
10744     * keep that old content object, use the elm_hover_content_unset()
10745     * function.
10746     *
10747     * All directions may have contents at the same time, except for
10748     * "smart". This is a special placement hint and its use case
10749     * independs of the calculations coming from
10750     * elm_hover_best_content_location_get(). Its use is for cases when
10751     * one desires only one hover content, but with a dynamic special
10752     * placement within the hover area. The content's geometry, whenever
10753     * it changes, will be used to decide on a best location, not
10754     * extrapolating the hover's parent object view to show it in (still
10755     * being the hover's target determinant of its medium part -- move and
10756     * resize it to simulate finger sizes, for example). If one of the
10757     * directions other than "smart" are used, a previously content set
10758     * using it will be deleted, and vice-versa.
10759     */
10760    EAPI void         elm_hover_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
10761    /**
10762     * @brief Get the content of the hover object, in a given direction.
10763     *
10764     * Return the content object which was set for this widget in the
10765     * @p swallow direction.
10766     *
10767     * @param obj The hover object
10768     * @param swallow The direction that the object was display at.
10769     * @return The content that was being used
10770     *
10771     * @see elm_hover_content_set()
10772     */
10773    EAPI Evas_Object *elm_hover_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10774    /**
10775     * @brief Unset the content of the hover object, in a given direction.
10776     *
10777     * Unparent and return the content object set at @p swallow direction.
10778     *
10779     * @param obj The hover object
10780     * @param swallow The direction that the object was display at.
10781     * @return The content that was being used.
10782     *
10783     * @see elm_hover_content_set()
10784     */
10785    EAPI Evas_Object *elm_hover_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10786    /**
10787     * @brief Returns the best swallow location for content in the hover.
10788     *
10789     * @param obj The hover object
10790     * @param pref_axis The preferred orientation axis for the hover object to use
10791     * @return The edje location to place content into the hover or @c
10792     *         NULL, on errors.
10793     *
10794     * Best is defined here as the location at which there is the most available
10795     * space.
10796     *
10797     * @p pref_axis may be one of
10798     * - @c ELM_HOVER_AXIS_NONE -- no prefered orientation
10799     * - @c ELM_HOVER_AXIS_HORIZONTAL -- horizontal
10800     * - @c ELM_HOVER_AXIS_VERTICAL -- vertical
10801     * - @c ELM_HOVER_AXIS_BOTH -- both
10802     *
10803     * If ELM_HOVER_AXIS_HORIZONTAL is choosen the returned position will
10804     * nescessarily be along the horizontal axis("left" or "right"). If
10805     * ELM_HOVER_AXIS_VERTICAL is choosen the returned position will nescessarily
10806     * be along the vertical axis("top" or "bottom"). Chossing
10807     * ELM_HOVER_AXIS_BOTH or ELM_HOVER_AXIS_NONE has the same effect and the
10808     * returned position may be in either axis.
10809     *
10810     * @see elm_hover_content_set()
10811     */
10812    EAPI const char  *elm_hover_best_content_location_get(const Evas_Object *obj, Elm_Hover_Axis pref_axis) EINA_ARG_NONNULL(1);
10813    /**
10814     * @}
10815     */
10816
10817    /* entry */
10818    /**
10819     * @defgroup Entry Entry
10820     *
10821     * @image html img/widget/entry/preview-00.png
10822     * @image latex img/widget/entry/preview-00.eps width=\textwidth
10823     * @image html img/widget/entry/preview-01.png
10824     * @image latex img/widget/entry/preview-01.eps width=\textwidth
10825     * @image html img/widget/entry/preview-02.png
10826     * @image latex img/widget/entry/preview-02.eps width=\textwidth
10827     * @image html img/widget/entry/preview-03.png
10828     * @image latex img/widget/entry/preview-03.eps width=\textwidth
10829     *
10830     * An entry is a convenience widget which shows a box that the user can
10831     * enter text into. Entries by default don't scroll, so they grow to
10832     * accomodate the entire text, resizing the parent window as needed. This
10833     * can be changed with the elm_entry_scrollable_set() function.
10834     *
10835     * They can also be single line or multi line (the default) and when set
10836     * to multi line mode they support text wrapping in any of the modes
10837     * indicated by #Elm_Wrap_Type.
10838     *
10839     * Other features include password mode, filtering of inserted text with
10840     * elm_entry_text_filter_append() and related functions, inline "items" and
10841     * formatted markup text.
10842     *
10843     * @section entry-markup Formatted text
10844     *
10845     * The markup tags supported by the Entry are defined by the theme, but
10846     * even when writing new themes or extensions it's a good idea to stick to
10847     * a sane default, to maintain coherency and avoid application breakages.
10848     * Currently defined by the default theme are the following tags:
10849     * @li \<br\>: Inserts a line break.
10850     * @li \<ps\>: Inserts a paragraph separator. This is preferred over line
10851     * breaks.
10852     * @li \<tab\>: Inserts a tab.
10853     * @li \<em\>...\</em\>: Emphasis. Sets the @em oblique style for the
10854     * enclosed text.
10855     * @li \<b\>...\</b\>: Sets the @b bold style for the enclosed text.
10856     * @li \<link\>...\</link\>: Underlines the enclosed text.
10857     * @li \<hilight\>...\</hilight\>: Hilights the enclosed text.
10858     *
10859     * @section entry-special Special markups
10860     *
10861     * Besides those used to format text, entries support two special markup
10862     * tags used to insert clickable portions of text or items inlined within
10863     * the text.
10864     *
10865     * @subsection entry-anchors Anchors
10866     *
10867     * Anchors are similar to HTML anchors. Text can be surrounded by \<a\> and
10868     * \</a\> tags and an event will be generated when this text is clicked,
10869     * like this:
10870     *
10871     * @code
10872     * This text is outside <a href=anc-01>but this one is an anchor</a>
10873     * @endcode
10874     *
10875     * The @c href attribute in the opening tag gives the name that will be
10876     * used to identify the anchor and it can be any valid utf8 string.
10877     *
10878     * When an anchor is clicked, an @c "anchor,clicked" signal is emitted with
10879     * an #Elm_Entry_Anchor_Info in the @c event_info parameter for the
10880     * callback function. The same applies for "anchor,in" (mouse in), "anchor,out"
10881     * (mouse out), "anchor,down" (mouse down), and "anchor,up" (mouse up) events on
10882     * an anchor.
10883     *
10884     * @subsection entry-items Items
10885     *
10886     * Inlined in the text, any other @c Evas_Object can be inserted by using
10887     * \<item\> tags this way:
10888     *
10889     * @code
10890     * <item size=16x16 vsize=full href=emoticon/haha></item>
10891     * @endcode
10892     *
10893     * Just like with anchors, the @c href identifies each item, but these need,
10894     * in addition, to indicate their size, which is done using any one of
10895     * @c size, @c absize or @c relsize attributes. These attributes take their
10896     * value in the WxH format, where W is the width and H the height of the
10897     * item.
10898     *
10899     * @li absize: Absolute pixel size for the item. Whatever value is set will
10900     * be the item's size regardless of any scale value the object may have
10901     * been set to. The final line height will be adjusted to fit larger items.
10902     * @li size: Similar to @c absize, but it's adjusted to the scale value set
10903     * for the object.
10904     * @li relsize: Size is adjusted for the item to fit within the current
10905     * line height.
10906     *
10907     * Besides their size, items are specificed a @c vsize value that affects
10908     * how their final size and position are calculated. The possible values
10909     * are:
10910     * @li ascent: Item will be placed within the line's baseline and its
10911     * ascent. That is, the height between the line where all characters are
10912     * positioned and the highest point in the line. For @c size and @c absize
10913     * items, the descent value will be added to the total line height to make
10914     * them fit. @c relsize items will be adjusted to fit within this space.
10915     * @li full: Items will be placed between the descent and ascent, or the
10916     * lowest point in the line and its highest.
10917     *
10918     * The next image shows different configurations of items and how
10919     * the previously mentioned options affect their sizes. In all cases,
10920     * the green line indicates the ascent, blue for the baseline and red for
10921     * the descent.
10922     *
10923     * @image html entry_item.png
10924     * @image latex entry_item.eps width=\textwidth
10925     *
10926     * And another one to show how size differs from absize. In the first one,
10927     * the scale value is set to 1.0, while the second one is using one of 2.0.
10928     *
10929     * @image html entry_item_scale.png
10930     * @image latex entry_item_scale.eps width=\textwidth
10931     *
10932     * After the size for an item is calculated, the entry will request an
10933     * object to place in its space. For this, the functions set with
10934     * elm_entry_item_provider_append() and related functions will be called
10935     * in order until one of them returns a @c non-NULL value. If no providers
10936     * are available, or all of them return @c NULL, then the entry falls back
10937     * to one of the internal defaults, provided the name matches with one of
10938     * them.
10939     *
10940     * All of the following are currently supported:
10941     *
10942     * - emoticon/angry
10943     * - emoticon/angry-shout
10944     * - emoticon/crazy-laugh
10945     * - emoticon/evil-laugh
10946     * - emoticon/evil
10947     * - emoticon/goggle-smile
10948     * - emoticon/grumpy
10949     * - emoticon/grumpy-smile
10950     * - emoticon/guilty
10951     * - emoticon/guilty-smile
10952     * - emoticon/haha
10953     * - emoticon/half-smile
10954     * - emoticon/happy-panting
10955     * - emoticon/happy
10956     * - emoticon/indifferent
10957     * - emoticon/kiss
10958     * - emoticon/knowing-grin
10959     * - emoticon/laugh
10960     * - emoticon/little-bit-sorry
10961     * - emoticon/love-lots
10962     * - emoticon/love
10963     * - emoticon/minimal-smile
10964     * - emoticon/not-happy
10965     * - emoticon/not-impressed
10966     * - emoticon/omg
10967     * - emoticon/opensmile
10968     * - emoticon/smile
10969     * - emoticon/sorry
10970     * - emoticon/squint-laugh
10971     * - emoticon/surprised
10972     * - emoticon/suspicious
10973     * - emoticon/tongue-dangling
10974     * - emoticon/tongue-poke
10975     * - emoticon/uh
10976     * - emoticon/unhappy
10977     * - emoticon/very-sorry
10978     * - emoticon/what
10979     * - emoticon/wink
10980     * - emoticon/worried
10981     * - emoticon/wtf
10982     *
10983     * Alternatively, an item may reference an image by its path, using
10984     * the URI form @c file:///path/to/an/image.png and the entry will then
10985     * use that image for the item.
10986     *
10987     * @section entry-files Loading and saving files
10988     *
10989     * Entries have convinience functions to load text from a file and save
10990     * changes back to it after a short delay. The automatic saving is enabled
10991     * by default, but can be disabled with elm_entry_autosave_set() and files
10992     * can be loaded directly as plain text or have any markup in them
10993     * recognized. See elm_entry_file_set() for more details.
10994     *
10995     * @section entry-signals Emitted signals
10996     *
10997     * This widget emits the following signals:
10998     *
10999     * @li "changed": The text within the entry was changed.
11000     * @li "changed,user": The text within the entry was changed because of user interaction.
11001     * @li "activated": The enter key was pressed on a single line entry.
11002     * @li "press": A mouse button has been pressed on the entry.
11003     * @li "longpressed": A mouse button has been pressed and held for a couple
11004     * seconds.
11005     * @li "clicked": The entry has been clicked (mouse press and release).
11006     * @li "clicked,double": The entry has been double clicked.
11007     * @li "clicked,triple": The entry has been triple clicked.
11008     * @li "focused": The entry has received focus.
11009     * @li "unfocused": The entry has lost focus.
11010     * @li "selection,paste": A paste of the clipboard contents was requested.
11011     * @li "selection,copy": A copy of the selected text into the clipboard was
11012     * requested.
11013     * @li "selection,cut": A cut of the selected text into the clipboard was
11014     * requested.
11015     * @li "selection,start": A selection has begun and no previous selection
11016     * existed.
11017     * @li "selection,changed": The current selection has changed.
11018     * @li "selection,cleared": The current selection has been cleared.
11019     * @li "cursor,changed": The cursor has changed position.
11020     * @li "anchor,clicked": An anchor has been clicked. The event_info
11021     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11022     * @li "anchor,in": Mouse cursor has moved into an anchor. The event_info
11023     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11024     * @li "anchor,out": Mouse cursor has moved out of an anchor. The event_info
11025     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11026     * @li "anchor,up": Mouse button has been unpressed on an anchor. The event_info
11027     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11028     * @li "anchor,down": Mouse button has been pressed on an anchor. The event_info
11029     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11030     * @li "preedit,changed": The preedit string has changed.
11031     * @li "language,changed": Program language changed.
11032     *
11033     * @section entry-examples
11034     *
11035     * An overview of the Entry API can be seen in @ref entry_example_01
11036     *
11037     * @{
11038     */
11039    /**
11040     * @typedef Elm_Entry_Anchor_Info
11041     *
11042     * The info sent in the callback for the "anchor,clicked" signals emitted
11043     * by entries.
11044     */
11045    typedef struct _Elm_Entry_Anchor_Info Elm_Entry_Anchor_Info;
11046    /**
11047     * @struct _Elm_Entry_Anchor_Info
11048     *
11049     * The info sent in the callback for the "anchor,clicked" signals emitted
11050     * by entries.
11051     */
11052    struct _Elm_Entry_Anchor_Info
11053      {
11054         const char *name; /**< The name of the anchor, as stated in its href */
11055         int         button; /**< The mouse button used to click on it */
11056         Evas_Coord  x, /**< Anchor geometry, relative to canvas */
11057                     y, /**< Anchor geometry, relative to canvas */
11058                     w, /**< Anchor geometry, relative to canvas */
11059                     h; /**< Anchor geometry, relative to canvas */
11060      };
11061    /**
11062     * @typedef Elm_Entry_Filter_Cb
11063     * This callback type is used by entry filters to modify text.
11064     * @param data The data specified as the last param when adding the filter
11065     * @param entry The entry object
11066     * @param text A pointer to the location of the text being filtered. This data can be modified,
11067     * but any additional allocations must be managed by the user.
11068     * @see elm_entry_text_filter_append
11069     * @see elm_entry_text_filter_prepend
11070     */
11071    typedef void (*Elm_Entry_Filter_Cb)(void *data, Evas_Object *entry, char **text);
11072
11073    /**
11074     * This adds an entry to @p parent object.
11075     *
11076     * By default, entries are:
11077     * @li not scrolled
11078     * @li multi-line
11079     * @li word wrapped
11080     * @li autosave is enabled
11081     *
11082     * @param parent The parent object
11083     * @return The new object or NULL if it cannot be created
11084     */
11085    EAPI Evas_Object *elm_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11086    /**
11087     * Sets the entry to single line mode.
11088     *
11089     * In single line mode, entries don't ever wrap when the text reaches the
11090     * edge, and instead they keep growing horizontally. Pressing the @c Enter
11091     * key will generate an @c "activate" event instead of adding a new line.
11092     *
11093     * When @p single_line is @c EINA_FALSE, line wrapping takes effect again
11094     * and pressing enter will break the text into a different line
11095     * without generating any events.
11096     *
11097     * @param obj The entry object
11098     * @param single_line If true, the text in the entry
11099     * will be on a single line.
11100     */
11101    EAPI void         elm_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
11102    /**
11103     * Gets whether the entry is set to be single line.
11104     *
11105     * @param obj The entry object
11106     * @return single_line If true, the text in the entry is set to display
11107     * on a single line.
11108     *
11109     * @see elm_entry_single_line_set()
11110     */
11111    EAPI Eina_Bool    elm_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11112    /**
11113     * Sets the entry to password mode.
11114     *
11115     * In password mode, entries are implicitly single line and the display of
11116     * any text in them is replaced with asterisks (*).
11117     *
11118     * @param obj The entry object
11119     * @param password If true, password mode is enabled.
11120     */
11121    EAPI void         elm_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
11122    /**
11123     * Gets whether the entry is set to password mode.
11124     *
11125     * @param obj The entry object
11126     * @return If true, the entry is set to display all characters
11127     * as asterisks (*).
11128     *
11129     * @see elm_entry_password_set()
11130     */
11131    EAPI Eina_Bool    elm_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11132    /**
11133     * This sets the text displayed within the entry to @p entry.
11134     *
11135     * @param obj The entry object
11136     * @param entry The text to be displayed
11137     *
11138     * @deprecated Use elm_object_text_set() instead.
11139     * @note Using this function bypasses text filters
11140     */
11141    EAPI void         elm_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
11142    /**
11143     * This returns the text currently shown in object @p entry.
11144     * See also elm_entry_entry_set().
11145     *
11146     * @param obj The entry object
11147     * @return The currently displayed text or NULL on failure
11148     *
11149     * @deprecated Use elm_object_text_get() instead.
11150     */
11151    EAPI const char  *elm_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11152    /**
11153     * Appends @p entry to the text of the entry.
11154     *
11155     * Adds the text in @p entry to the end of any text already present in the
11156     * widget.
11157     *
11158     * The appended text is subject to any filters set for the widget.
11159     *
11160     * @param obj The entry object
11161     * @param entry The text to be displayed
11162     *
11163     * @see elm_entry_text_filter_append()
11164     */
11165    EAPI void         elm_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
11166    /**
11167     * Gets whether the entry is empty.
11168     *
11169     * Empty means no text at all. If there are any markup tags, like an item
11170     * tag for which no provider finds anything, and no text is displayed, this
11171     * function still returns EINA_FALSE.
11172     *
11173     * @param obj The entry object
11174     * @return EINA_TRUE if the entry is empty, EINA_FALSE otherwise.
11175     */
11176    EAPI Eina_Bool    elm_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11177    /**
11178     * Gets any selected text within the entry.
11179     *
11180     * If there's any selected text in the entry, this function returns it as
11181     * a string in markup format. NULL is returned if no selection exists or
11182     * if an error occurred.
11183     *
11184     * The returned value points to an internal string and should not be freed
11185     * or modified in any way. If the @p entry object is deleted or its
11186     * contents are changed, the returned pointer should be considered invalid.
11187     *
11188     * @param obj The entry object
11189     * @return The selected text within the entry or NULL on failure
11190     */
11191    EAPI const char  *elm_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11192    /**
11193     * Returns the actual textblock object of the entry.
11194     *
11195     * This function exposes the internal textblock object that actually
11196     * contains and draws the text. This should be used for low-level
11197     * manipulations that are otherwise not possible.
11198     *
11199     * Changing the textblock directly from here will not notify edje/elm to
11200     * recalculate the textblock size automatically, so any modifications
11201     * done to the textblock returned by this function should be followed by
11202     * a call to elm_entry_calc_force().
11203     *
11204     * The return value is marked as const as an additional warning.
11205     * One should not use the returned object with any of the generic evas
11206     * functions (geometry_get/resize/move and etc), but only with the textblock
11207     * functions; The former will either not work at all, or break the correct
11208     * functionality.
11209     *
11210     * IMPORTANT: Many functions may change (i.e delete and create a new one)
11211     * the internal textblock object. Do NOT cache the returned object, and try
11212     * not to mix calls on this object with regular elm_entry calls (which may
11213     * change the internal textblock object). This applies to all cursors
11214     * returned from textblock calls, and all the other derivative values.
11215     *
11216     * @param obj The entry object
11217     * @return The textblock object.
11218     */
11219    EAPI const Evas_Object *elm_entry_textblock_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11220    /**
11221     * Forces calculation of the entry size and text layouting.
11222     *
11223     * This should be used after modifying the textblock object directly. See
11224     * elm_entry_textblock_get() for more information.
11225     *
11226     * @param obj The entry object
11227     *
11228     * @see elm_entry_textblock_get()
11229     */
11230    EAPI void elm_entry_calc_force(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11231    /**
11232     * Inserts the given text into the entry at the current cursor position.
11233     *
11234     * This inserts text at the cursor position as if it was typed
11235     * by the user (note that this also allows markup which a user
11236     * can't just "type" as it would be converted to escaped text, so this
11237     * call can be used to insert things like emoticon items or bold push/pop
11238     * tags, other font and color change tags etc.)
11239     *
11240     * If any selection exists, it will be replaced by the inserted text.
11241     *
11242     * The inserted text is subject to any filters set for the widget.
11243     *
11244     * @param obj The entry object
11245     * @param entry The text to insert
11246     *
11247     * @see elm_entry_text_filter_append()
11248     */
11249    EAPI void         elm_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
11250    /**
11251     * Set the line wrap type to use on multi-line entries.
11252     *
11253     * Sets the wrap type used by the entry to any of the specified in
11254     * #Elm_Wrap_Type. This tells how the text will be implicitly cut into a new
11255     * line (without inserting a line break or paragraph separator) when it
11256     * reaches the far edge of the widget.
11257     *
11258     * Note that this only makes sense for multi-line entries. A widget set
11259     * to be single line will never wrap.
11260     *
11261     * @param obj The entry object
11262     * @param wrap The wrap mode to use. See #Elm_Wrap_Type for details on them
11263     */
11264    EAPI void         elm_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
11265    EINA_DEPRECATED EAPI void         elm_entry_line_char_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
11266    /**
11267     * Gets the wrap mode the entry was set to use.
11268     *
11269     * @param obj The entry object
11270     * @return Wrap type
11271     *
11272     * @see also elm_entry_line_wrap_set()
11273     */
11274    EAPI Elm_Wrap_Type elm_entry_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11275    /**
11276     * Sets if the entry is to be editable or not.
11277     *
11278     * By default, entries are editable and when focused, any text input by the
11279     * user will be inserted at the current cursor position. But calling this
11280     * function with @p editable as EINA_FALSE will prevent the user from
11281     * inputting text into the entry.
11282     *
11283     * The only way to change the text of a non-editable entry is to use
11284     * elm_object_text_set(), elm_entry_entry_insert() and other related
11285     * functions.
11286     *
11287     * @param obj The entry object
11288     * @param editable If EINA_TRUE, user input will be inserted in the entry,
11289     * if not, the entry is read-only and no user input is allowed.
11290     */
11291    EAPI void         elm_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
11292    /**
11293     * Gets whether the entry is editable or not.
11294     *
11295     * @param obj The entry object
11296     * @return If true, the entry is editable by the user.
11297     * If false, it is not editable by the user
11298     *
11299     * @see elm_entry_editable_set()
11300     */
11301    EAPI Eina_Bool    elm_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11302    /**
11303     * This drops any existing text selection within the entry.
11304     *
11305     * @param obj The entry object
11306     */
11307    EAPI void         elm_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
11308    /**
11309     * This selects all text within the entry.
11310     *
11311     * @param obj The entry object
11312     */
11313    EAPI void         elm_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
11314    /**
11315     * This moves the cursor one place to the right within the entry.
11316     *
11317     * @param obj The entry object
11318     * @return EINA_TRUE upon success, EINA_FALSE upon failure
11319     */
11320    EAPI Eina_Bool    elm_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
11321    /**
11322     * This moves the cursor one place to the left within the entry.
11323     *
11324     * @param obj The entry object
11325     * @return EINA_TRUE upon success, EINA_FALSE upon failure
11326     */
11327    EAPI Eina_Bool    elm_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
11328    /**
11329     * This moves the cursor one line up within the entry.
11330     *
11331     * @param obj The entry object
11332     * @return EINA_TRUE upon success, EINA_FALSE upon failure
11333     */
11334    EAPI Eina_Bool    elm_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
11335    /**
11336     * This moves the cursor one line down within the entry.
11337     *
11338     * @param obj The entry object
11339     * @return EINA_TRUE upon success, EINA_FALSE upon failure
11340     */
11341    EAPI Eina_Bool    elm_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
11342    /**
11343     * This moves the cursor to the beginning of the entry.
11344     *
11345     * @param obj The entry object
11346     */
11347    EAPI void         elm_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11348    /**
11349     * This moves the cursor to the end of the entry.
11350     *
11351     * @param obj The entry object
11352     */
11353    EAPI void         elm_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11354    /**
11355     * This moves the cursor to the beginning of the current line.
11356     *
11357     * @param obj The entry object
11358     */
11359    EAPI void         elm_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11360    /**
11361     * This moves the cursor to the end of the current line.
11362     *
11363     * @param obj The entry object
11364     */
11365    EAPI void         elm_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11366    /**
11367     * This begins a selection within the entry as though
11368     * the user were holding down the mouse button to make a selection.
11369     *
11370     * @param obj The entry object
11371     */
11372    EAPI void         elm_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
11373    /**
11374     * This ends a selection within the entry as though
11375     * the user had just released the mouse button while making a selection.
11376     *
11377     * @param obj The entry object
11378     */
11379    EAPI void         elm_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
11380    /**
11381     * Gets whether a format node exists at the current cursor position.
11382     *
11383     * A format node is anything that defines how the text is rendered. It can
11384     * be a visible format node, such as a line break or a paragraph separator,
11385     * or an invisible one, such as bold begin or end tag.
11386     * This function returns whether any format node exists at the current
11387     * cursor position.
11388     *
11389     * @param obj The entry object
11390     * @return EINA_TRUE if the current cursor position contains a format node,
11391     * EINA_FALSE otherwise.
11392     *
11393     * @see elm_entry_cursor_is_visible_format_get()
11394     */
11395    EAPI Eina_Bool    elm_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11396    /**
11397     * Gets if the current cursor position holds a visible format node.
11398     *
11399     * @param obj The entry object
11400     * @return EINA_TRUE if the current cursor is a visible format, EINA_FALSE
11401     * if it's an invisible one or no format exists.
11402     *
11403     * @see elm_entry_cursor_is_format_get()
11404     */
11405    EAPI Eina_Bool    elm_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11406    /**
11407     * Gets the character pointed by the cursor at its current position.
11408     *
11409     * This function returns a string with the utf8 character stored at the
11410     * current cursor position.
11411     * Only the text is returned, any format that may exist will not be part
11412     * of the return value.
11413     *
11414     * @param obj The entry object
11415     * @return The text pointed by the cursors.
11416     */
11417    EAPI const char  *elm_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11418    /**
11419     * This function returns the geometry of the cursor.
11420     *
11421     * It's useful if you want to draw something on the cursor (or where it is),
11422     * or for example in the case of scrolled entry where you want to show the
11423     * cursor.
11424     *
11425     * @param obj The entry object
11426     * @param x returned geometry
11427     * @param y returned geometry
11428     * @param w returned geometry
11429     * @param h returned geometry
11430     * @return EINA_TRUE upon success, EINA_FALSE upon failure
11431     */
11432    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);
11433    /**
11434     * Sets the cursor position in the entry to the given value
11435     *
11436     * The value in @p pos is the index of the character position within the
11437     * contents of the string as returned by elm_entry_cursor_pos_get().
11438     *
11439     * @param obj The entry object
11440     * @param pos The position of the cursor
11441     */
11442    EAPI void         elm_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
11443    /**
11444     * Retrieves the current position of the cursor in the entry
11445     *
11446     * @param obj The entry object
11447     * @return The cursor position
11448     */
11449    EAPI int          elm_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11450    /**
11451     * This executes a "cut" action on the selected text in the entry.
11452     *
11453     * @param obj The entry object
11454     */
11455    EAPI void         elm_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
11456    /**
11457     * This executes a "copy" action on the selected text in the entry.
11458     *
11459     * @param obj The entry object
11460     */
11461    EAPI void         elm_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
11462    /**
11463     * This executes a "paste" action in the entry.
11464     *
11465     * @param obj The entry object
11466     */
11467    EAPI void         elm_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
11468    /**
11469     * This clears and frees the items in a entry's contextual (longpress)
11470     * menu.
11471     *
11472     * @param obj The entry object
11473     *
11474     * @see elm_entry_context_menu_item_add()
11475     */
11476    EAPI void         elm_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
11477    /**
11478     * This adds an item to the entry's contextual menu.
11479     *
11480     * A longpress on an entry will make the contextual menu show up, if this
11481     * hasn't been disabled with elm_entry_context_menu_disabled_set().
11482     * By default, this menu provides a few options like enabling selection mode,
11483     * which is useful on embedded devices that need to be explicit about it,
11484     * and when a selection exists it also shows the copy and cut actions.
11485     *
11486     * With this function, developers can add other options to this menu to
11487     * perform any action they deem necessary.
11488     *
11489     * @param obj The entry object
11490     * @param label The item's text label
11491     * @param icon_file The item's icon file
11492     * @param icon_type The item's icon type
11493     * @param func The callback to execute when the item is clicked
11494     * @param data The data to associate with the item for related functions
11495     */
11496    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);
11497    /**
11498     * This disables the entry's contextual (longpress) menu.
11499     *
11500     * @param obj The entry object
11501     * @param disabled If true, the menu is disabled
11502     */
11503    EAPI void         elm_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
11504    /**
11505     * This returns whether the entry's contextual (longpress) menu is
11506     * disabled.
11507     *
11508     * @param obj The entry object
11509     * @return If true, the menu is disabled
11510     */
11511    EAPI Eina_Bool    elm_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11512    /**
11513     * This appends a custom item provider to the list for that entry
11514     *
11515     * This appends the given callback. The list is walked from beginning to end
11516     * with each function called given the item href string in the text. If the
11517     * function returns an object handle other than NULL (it should create an
11518     * object to do this), then this object is used to replace that item. If
11519     * not the next provider is called until one provides an item object, or the
11520     * default provider in entry does.
11521     *
11522     * @param obj The entry object
11523     * @param func The function called to provide the item object
11524     * @param data The data passed to @p func
11525     *
11526     * @see @ref entry-items
11527     */
11528    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);
11529    /**
11530     * This prepends a custom item provider to the list for that entry
11531     *
11532     * This prepends the given callback. See elm_entry_item_provider_append() for
11533     * more information
11534     *
11535     * @param obj The entry object
11536     * @param func The function called to provide the item object
11537     * @param data The data passed to @p func
11538     */
11539    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);
11540    /**
11541     * This removes a custom item provider to the list for that entry
11542     *
11543     * This removes the given callback. See elm_entry_item_provider_append() for
11544     * more information
11545     *
11546     * @param obj The entry object
11547     * @param func The function called to provide the item object
11548     * @param data The data passed to @p func
11549     */
11550    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);
11551    /**
11552     * Append a filter function for text inserted in the entry
11553     *
11554     * Append the given callback to the list. This functions will be called
11555     * whenever any text is inserted into the entry, with the text to be inserted
11556     * as a parameter. The callback function is free to alter the text in any way
11557     * it wants, but it must remember to free the given pointer and update it.
11558     * If the new text is to be discarded, the function can free it and set its
11559     * text parameter to NULL. This will also prevent any following filters from
11560     * being called.
11561     *
11562     * @param obj The entry object
11563     * @param func The function to use as text filter
11564     * @param data User data to pass to @p func
11565     */
11566    EAPI void         elm_entry_text_filter_append(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11567    /**
11568     * Prepend a filter function for text insdrted in the entry
11569     *
11570     * Prepend the given callback to the list. See elm_entry_text_filter_append()
11571     * for more information
11572     *
11573     * @param obj The entry object
11574     * @param func The function to use as text filter
11575     * @param data User data to pass to @p func
11576     */
11577    EAPI void         elm_entry_text_filter_prepend(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11578    /**
11579     * Remove a filter from the list
11580     *
11581     * Removes the given callback from the filter list. See
11582     * elm_entry_text_filter_append() for more information.
11583     *
11584     * @param obj The entry object
11585     * @param func The filter function to remove
11586     * @param data The user data passed when adding the function
11587     */
11588    EAPI void         elm_entry_text_filter_remove(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11589    /**
11590     * This converts a markup (HTML-like) string into UTF-8.
11591     *
11592     * The returned string is a malloc'ed buffer and it should be freed when
11593     * not needed anymore.
11594     *
11595     * @param s The string (in markup) to be converted
11596     * @return The converted string (in UTF-8). It should be freed.
11597     */
11598    EAPI char        *elm_entry_markup_to_utf8(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
11599    /**
11600     * This converts a UTF-8 string into markup (HTML-like).
11601     *
11602     * The returned string is a malloc'ed buffer and it should be freed when
11603     * not needed anymore.
11604     *
11605     * @param s The string (in UTF-8) to be converted
11606     * @return The converted string (in markup). It should be freed.
11607     */
11608    EAPI char        *elm_entry_utf8_to_markup(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
11609    /**
11610     * This sets the file (and implicitly loads it) for the text to display and
11611     * then edit. All changes are written back to the file after a short delay if
11612     * the entry object is set to autosave (which is the default).
11613     *
11614     * If the entry had any other file set previously, any changes made to it
11615     * will be saved if the autosave feature is enabled, otherwise, the file
11616     * will be silently discarded and any non-saved changes will be lost.
11617     *
11618     * @param obj The entry object
11619     * @param file The path to the file to load and save
11620     * @param format The file format
11621     */
11622    EAPI void         elm_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
11623    /**
11624     * Gets the file being edited by the entry.
11625     *
11626     * This function can be used to retrieve any file set on the entry for
11627     * edition, along with the format used to load and save it.
11628     *
11629     * @param obj The entry object
11630     * @param file The path to the file to load and save
11631     * @param format The file format
11632     */
11633    EAPI void         elm_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
11634    /**
11635     * This function writes any changes made to the file set with
11636     * elm_entry_file_set()
11637     *
11638     * @param obj The entry object
11639     */
11640    EAPI void         elm_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
11641    /**
11642     * This sets the entry object to 'autosave' the loaded text file or not.
11643     *
11644     * @param obj The entry object
11645     * @param autosave Autosave the loaded file or not
11646     *
11647     * @see elm_entry_file_set()
11648     */
11649    EAPI void         elm_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
11650    /**
11651     * This gets the entry object's 'autosave' status.
11652     *
11653     * @param obj The entry object
11654     * @return Autosave the loaded file or not
11655     *
11656     * @see elm_entry_file_set()
11657     */
11658    EAPI Eina_Bool    elm_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11659
11660    /**
11661     * @enum _Elm_CNP_Mode
11662     * @typedef Elm_CNP_Mode
11663     * Enum of entry's copy & paste policy.
11664     *
11665     * @see elm_entry_cnp_mode_set()
11666     * @see elm_entry_cnp_mode_get()
11667     */
11668    typedef enum _Elm_CNP_Mode {
11669       ELM_CNP_MODE_MARKUP = 0,       /**< copy & paste text with markup tag */
11670       ELM_CNP_MODE_NO_IMAGE = 1,     /**< copy & paste text without item(image) tag */
11671       ELM_CNP_MODE_PLAINTEXT = 2     /**< copy & paste text without markup tag */
11672    } Elm_CNP_Mode;
11673
11674    /**
11675     * Control pasting of text and images for the widget.
11676     *
11677     * Normally the entry allows both text and images to be pasted.
11678     * By setting textonly to be ELM_CNP_MODE_NO_IMAGE, this prevents images from being copy or past.
11679     * By setting textonly to be ELM_CNP_MODE_PLAINTEXT, this remove all tags in text .
11680     *
11681     * @note this only changes the behaviour of text.
11682     *
11683     * @param obj The entry object
11684     * @param mode One of #Elm_CNP_Mode: #ELM_CNP_MODE_MARKUP,
11685     * #ELM_CNP_MODE_NO_IMAGE, #ELM_CNP_MODE_PLAINTEXT.
11686     */
11687    EAPI void         elm_entry_cnp_mode_set(Evas_Object *obj, Elm_CNP_Mode cnp_mode) EINA_ARG_NONNULL(1);
11688    /**
11689     * Getting elm_entry text paste/drop mode.
11690     *
11691     * Normally the entry allows both text and images to be pasted.
11692     * This gets the copy & paste mode of the entry.
11693     *
11694     * @param obj The entry object
11695     * @return mode One of #Elm_CNP_Mode: #ELM_CNP_MODE_MARKUP,
11696     * #ELM_CNP_MODE_NO_IMAGE, #ELM_CNP_MODE_PLAINTEXT.
11697     */
11698    EAPI Elm_CNP_Mode elm_entry_cnp_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11699
11700    /**
11701     * Control pasting of text and images for the widget.
11702     *
11703     * Normally the entry allows both text and images to be pasted.  By setting
11704     * textonly to be true, this prevents images from being pasted.
11705     *
11706     * Note this only changes the behaviour of text.
11707     *
11708     * @param obj The entry object
11709     * @param textonly paste mode - EINA_TRUE is text only, EINA_FALSE is
11710     * text+image+other.
11711     */
11712    EAPI void         elm_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
11713    /**
11714     * Getting elm_entry text paste/drop mode.
11715     *
11716     * In textonly mode, only text may be pasted or dropped into the widget.
11717     *
11718     * @param obj The entry object
11719     * @return If the widget only accepts text from pastes.
11720     */
11721    EAPI Eina_Bool    elm_entry_cnp_textonly_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11722    /**
11723     * Enable or disable scrolling in entry
11724     *
11725     * Normally the entry is not scrollable unless you enable it with this call.
11726     *
11727     * @param obj The entry object
11728     * @param scroll EINA_TRUE if it is to be scrollable, EINA_FALSE otherwise
11729     */
11730    EAPI void         elm_entry_scrollable_set(Evas_Object *obj, Eina_Bool scroll);
11731    /**
11732     * Get the scrollable state of the entry
11733     *
11734     * Normally the entry is not scrollable. This gets the scrollable state
11735     * of the entry. See elm_entry_scrollable_set() for more information.
11736     *
11737     * @param obj The entry object
11738     * @return The scrollable state
11739     */
11740    EAPI Eina_Bool    elm_entry_scrollable_get(const Evas_Object *obj);
11741    /**
11742     * This sets a widget to be displayed to the left of a scrolled entry.
11743     *
11744     * @param obj The scrolled entry object
11745     * @param icon The widget to display on the left side of the scrolled
11746     * entry.
11747     *
11748     * @note A previously set widget will be destroyed.
11749     * @note If the object being set does not have minimum size hints set,
11750     * it won't get properly displayed.
11751     *
11752     * @see elm_entry_end_set()
11753     */
11754    EAPI void         elm_entry_icon_set(Evas_Object *obj, Evas_Object *icon);
11755    /**
11756     * Gets the leftmost widget of the scrolled entry. This object is
11757     * owned by the scrolled entry and should not be modified.
11758     *
11759     * @param obj The scrolled entry object
11760     * @return the left widget inside the scroller
11761     */
11762    EAPI Evas_Object *elm_entry_icon_get(const Evas_Object *obj);
11763    /**
11764     * Unset the leftmost widget of the scrolled entry, unparenting and
11765     * returning it.
11766     *
11767     * @param obj The scrolled entry object
11768     * @return the previously set icon sub-object of this entry, on
11769     * success.
11770     *
11771     * @see elm_entry_icon_set()
11772     */
11773    EAPI Evas_Object *elm_entry_icon_unset(Evas_Object *obj);
11774    /**
11775     * Sets the visibility of the left-side widget of the scrolled entry,
11776     * set by elm_entry_icon_set().
11777     *
11778     * @param obj The scrolled entry object
11779     * @param setting EINA_TRUE if the object should be displayed,
11780     * EINA_FALSE if not.
11781     */
11782    EAPI void         elm_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting);
11783    /**
11784     * This sets a widget to be displayed to the end of a scrolled entry.
11785     *
11786     * @param obj The scrolled entry object
11787     * @param end The widget to display on the right side of the scrolled
11788     * entry.
11789     *
11790     * @note A previously set widget will be destroyed.
11791     * @note If the object being set does not have minimum size hints set,
11792     * it won't get properly displayed.
11793     *
11794     * @see elm_entry_icon_set
11795     */
11796    EAPI void         elm_entry_end_set(Evas_Object *obj, Evas_Object *end);
11797    /**
11798     * Gets the endmost widget of the scrolled entry. This object is owned
11799     * by the scrolled entry and should not be modified.
11800     *
11801     * @param obj The scrolled entry object
11802     * @return the right widget inside the scroller
11803     */
11804    EAPI Evas_Object *elm_entry_end_get(const Evas_Object *obj);
11805    /**
11806     * Unset the endmost widget of the scrolled entry, unparenting and
11807     * returning it.
11808     *
11809     * @param obj The scrolled entry object
11810     * @return the previously set icon sub-object of this entry, on
11811     * success.
11812     *
11813     * @see elm_entry_icon_set()
11814     */
11815    EAPI Evas_Object *elm_entry_end_unset(Evas_Object *obj);
11816    /**
11817     * Sets the visibility of the end widget of the scrolled entry, set by
11818     * elm_entry_end_set().
11819     *
11820     * @param obj The scrolled entry object
11821     * @param setting EINA_TRUE if the object should be displayed,
11822     * EINA_FALSE if not.
11823     */
11824    EAPI void         elm_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting);
11825    /**
11826     * This sets the scrolled entry's scrollbar policy (ie. enabling/disabling
11827     * them).
11828     *
11829     * Setting an entry to single-line mode with elm_entry_single_line_set()
11830     * will automatically disable the display of scrollbars when the entry
11831     * moves inside its scroller.
11832     *
11833     * @param obj The scrolled entry object
11834     * @param h The horizontal scrollbar policy to apply
11835     * @param v The vertical scrollbar policy to apply
11836     */
11837    EAPI void         elm_entry_scrollbar_policy_set(Evas_Object *obj, Elm_Scroller_Policy h, Elm_Scroller_Policy v);
11838    /**
11839     * This enables/disables bouncing within the entry.
11840     *
11841     * This function sets whether the entry will bounce when scrolling reaches
11842     * the end of the contained entry.
11843     *
11844     * @param obj The scrolled entry object
11845     * @param h The horizontal bounce state
11846     * @param v The vertical bounce state
11847     */
11848    EAPI void         elm_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
11849    /**
11850     * Get the bounce mode
11851     *
11852     * @param obj The Entry object
11853     * @param h_bounce Allow bounce horizontally
11854     * @param v_bounce Allow bounce vertically
11855     */
11856    EAPI void         elm_entry_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
11857
11858    /* pre-made filters for entries */
11859    /**
11860     * @typedef Elm_Entry_Filter_Limit_Size
11861     *
11862     * Data for the elm_entry_filter_limit_size() entry filter.
11863     */
11864    typedef struct _Elm_Entry_Filter_Limit_Size Elm_Entry_Filter_Limit_Size;
11865    /**
11866     * @struct _Elm_Entry_Filter_Limit_Size
11867     *
11868     * Data for the elm_entry_filter_limit_size() entry filter.
11869     */
11870    struct _Elm_Entry_Filter_Limit_Size
11871      {
11872         int max_char_count; /**< The maximum number of characters allowed. */
11873         int max_byte_count; /**< The maximum number of bytes allowed*/
11874      };
11875    /**
11876     * Filter inserted text based on user defined character and byte limits
11877     *
11878     * Add this filter to an entry to limit the characters that it will accept
11879     * based the the contents of the provided #Elm_Entry_Filter_Limit_Size.
11880     * The funtion works on the UTF-8 representation of the string, converting
11881     * it from the set markup, thus not accounting for any format in it.
11882     *
11883     * The user must create an #Elm_Entry_Filter_Limit_Size structure and pass
11884     * it as data when setting the filter. In it, it's possible to set limits
11885     * by character count or bytes (any of them is disabled if 0), and both can
11886     * be set at the same time. In that case, it first checks for characters,
11887     * then bytes.
11888     *
11889     * The function will cut the inserted text in order to allow only the first
11890     * number of characters that are still allowed. The cut is made in
11891     * characters, even when limiting by bytes, in order to always contain
11892     * valid ones and avoid half unicode characters making it in.
11893     *
11894     * This filter, like any others, does not apply when setting the entry text
11895     * directly with elm_object_text_set() (or the deprecated
11896     * elm_entry_entry_set()).
11897     */
11898    EAPI void         elm_entry_filter_limit_size(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 2, 3);
11899    /**
11900     * @typedef Elm_Entry_Filter_Accept_Set
11901     *
11902     * Data for the elm_entry_filter_accept_set() entry filter.
11903     */
11904    typedef struct _Elm_Entry_Filter_Accept_Set Elm_Entry_Filter_Accept_Set;
11905    /**
11906     * @struct _Elm_Entry_Filter_Accept_Set
11907     *
11908     * Data for the elm_entry_filter_accept_set() entry filter.
11909     */
11910    struct _Elm_Entry_Filter_Accept_Set
11911      {
11912         const char *accepted; /**< Set of characters accepted in the entry. */
11913         const char *rejected; /**< Set of characters rejected from the entry. */
11914      };
11915    /**
11916     * Filter inserted text based on accepted or rejected sets of characters
11917     *
11918     * Add this filter to an entry to restrict the set of accepted characters
11919     * based on the sets in the provided #Elm_Entry_Filter_Accept_Set.
11920     * This structure contains both accepted and rejected sets, but they are
11921     * mutually exclusive.
11922     *
11923     * The @c accepted set takes preference, so if it is set, the filter will
11924     * only work based on the accepted characters, ignoring anything in the
11925     * @c rejected value. If @c accepted is @c NULL, then @c rejected is used.
11926     *
11927     * In both cases, the function filters by matching utf8 characters to the
11928     * raw markup text, so it can be used to remove formatting tags.
11929     *
11930     * This filter, like any others, does not apply when setting the entry text
11931     * directly with elm_object_text_set() (or the deprecated
11932     * elm_entry_entry_set()).
11933     */
11934    EAPI void         elm_entry_filter_accept_set(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 3);
11935    /**
11936     * Set the input panel layout of the entry
11937     *
11938     * @param obj The entry object
11939     * @param layout layout type
11940     */
11941    EAPI void elm_entry_input_panel_layout_set(Evas_Object *obj, Elm_Input_Panel_Layout layout) EINA_ARG_NONNULL(1);
11942    /**
11943     * Get the input panel layout of the entry
11944     *
11945     * @param obj The entry object
11946     * @return layout type
11947     *
11948     * @see elm_entry_input_panel_layout_set
11949     */
11950    EAPI Elm_Input_Panel_Layout elm_entry_input_panel_layout_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
11951    /**
11952     * Set the autocapitalization type on the immodule.
11953     *
11954     * @param obj The entry object
11955     * @param autocapital_type The type of autocapitalization
11956     */
11957    EAPI void         elm_entry_autocapital_type_set(Evas_Object *obj, Elm_Autocapital_Type autocapital_type) EINA_ARG_NONNULL(1);
11958    /**
11959     * Retrieve the autocapitalization type on the immodule.
11960     *
11961     * @param obj The entry object
11962     * @return autocapitalization type
11963     */
11964    EAPI Elm_Autocapital_Type elm_entry_autocapital_type_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
11965    /**
11966     * Sets the attribute to show the input panel automatically.
11967     *
11968     * @param obj The entry object
11969     * @param enabled If true, the input panel is appeared when entry is clicked or has a focus
11970     */
11971    EAPI void elm_entry_input_panel_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
11972    /**
11973     * Retrieve the attribute to show the input panel automatically.
11974     *
11975     * @param obj The entry object
11976     * @return EINA_TRUE if input panel will be appeared when the entry is clicked or has a focus, EINA_FALSE otherwise
11977     */
11978    EAPI Eina_Bool elm_entry_input_panel_enabled_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
11979
11980    EAPI void         elm_entry_background_color_set(Evas_Object *obj, unsigned int r, unsigned int g, unsigned int b, unsigned int a);
11981    EAPI void         elm_entry_autocapitalization_set(Evas_Object *obj, Eina_Bool autocap);
11982    EAPI void         elm_entry_autoperiod_set(Evas_Object *obj, Eina_Bool autoperiod);
11983    EAPI void         elm_entry_autoenable_returnkey_set(Evas_Object *obj, Eina_Bool on);
11984    EAPI Ecore_IMF_Context *elm_entry_imf_context_get(Evas_Object *obj);
11985    EAPI void         elm_entry_matchlist_set(Evas_Object *obj, Eina_List *match_list, Eina_Bool case_sensitive);
11986    EAPI void         elm_entry_magnifier_type_set(Evas_Object *obj, int type) EINA_ARG_NONNULL(1);
11987
11988    /**
11989     * @}
11990     */
11991
11992    /* composite widgets - these basically put together basic widgets above
11993     * in convenient packages that do more than basic stuff */
11994
11995    /* anchorview */
11996    /**
11997     * @defgroup Anchorview Anchorview
11998     *
11999     * @image html img/widget/anchorview/preview-00.png
12000     * @image latex img/widget/anchorview/preview-00.eps
12001     *
12002     * Anchorview is for displaying text that contains markup with anchors
12003     * like <c>\<a href=1234\>something\</\></c> in it.
12004     *
12005     * Besides being styled differently, the anchorview widget provides the
12006     * necessary functionality so that clicking on these anchors brings up a
12007     * popup with user defined content such as "call", "add to contacts" or
12008     * "open web page". This popup is provided using the @ref Hover widget.
12009     *
12010     * This widget is very similar to @ref Anchorblock, so refer to that
12011     * widget for an example. The only difference Anchorview has is that the
12012     * widget is already provided with scrolling functionality, so if the
12013     * text set to it is too large to fit in the given space, it will scroll,
12014     * whereas the @ref Anchorblock widget will keep growing to ensure all the
12015     * text can be displayed.
12016     *
12017     * This widget emits the following signals:
12018     * @li "anchor,clicked": will be called when an anchor is clicked. The
12019     * @p event_info parameter on the callback will be a pointer of type
12020     * ::Elm_Entry_Anchorview_Info.
12021     *
12022     * See @ref Anchorblock for an example on how to use both of them.
12023     *
12024     * @see Anchorblock
12025     * @see Entry
12026     * @see Hover
12027     *
12028     * @{
12029     */
12030    /**
12031     * @typedef Elm_Entry_Anchorview_Info
12032     *
12033     * The info sent in the callback for "anchor,clicked" signals emitted by
12034     * the Anchorview widget.
12035     */
12036    typedef struct _Elm_Entry_Anchorview_Info Elm_Entry_Anchorview_Info;
12037    /**
12038     * @struct _Elm_Entry_Anchorview_Info
12039     *
12040     * The info sent in the callback for "anchor,clicked" signals emitted by
12041     * the Anchorview widget.
12042     */
12043    struct _Elm_Entry_Anchorview_Info
12044      {
12045         const char     *name; /**< Name of the anchor, as indicated in its href
12046                                    attribute */
12047         int             button; /**< The mouse button used to click on it */
12048         Evas_Object    *hover; /**< The hover object to use for the popup */
12049         struct {
12050              Evas_Coord    x, y, w, h;
12051         } anchor, /**< Geometry selection of text used as anchor */
12052           hover_parent; /**< Geometry of the object used as parent by the
12053                              hover */
12054         Eina_Bool       hover_left : 1; /**< Hint indicating if there's space
12055                                              for content on the left side of
12056                                              the hover. Before calling the
12057                                              callback, the widget will make the
12058                                              necessary calculations to check
12059                                              which sides are fit to be set with
12060                                              content, based on the position the
12061                                              hover is activated and its distance
12062                                              to the edges of its parent object
12063                                              */
12064         Eina_Bool       hover_right : 1; /**< Hint indicating content fits on
12065                                               the right side of the hover.
12066                                               See @ref hover_left */
12067         Eina_Bool       hover_top : 1; /**< Hint indicating content fits on top
12068                                             of the hover. See @ref hover_left */
12069         Eina_Bool       hover_bottom : 1; /**< Hint indicating content fits
12070                                                below the hover. See @ref
12071                                                hover_left */
12072      };
12073    /**
12074     * Add a new Anchorview object
12075     *
12076     * @param parent The parent object
12077     * @return The new object or NULL if it cannot be created
12078     */
12079    EAPI Evas_Object *elm_anchorview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12080    /**
12081     * Set the text to show in the anchorview
12082     *
12083     * Sets the text of the anchorview to @p text. This text can include markup
12084     * format tags, including <c>\<a href=anchorname\></c> to begin a segment of
12085     * text that will be specially styled and react to click events, ended with
12086     * either of \</a\> or \</\>. When clicked, the anchor will emit an
12087     * "anchor,clicked" signal that you can attach a callback to with
12088     * evas_object_smart_callback_add(). The name of the anchor given in the
12089     * event info struct will be the one set in the href attribute, in this
12090     * case, anchorname.
12091     *
12092     * Other markup can be used to style the text in different ways, but it's
12093     * up to the style defined in the theme which tags do what.
12094     * @deprecated use elm_object_text_set() instead.
12095     */
12096    EINA_DEPRECATED EAPI void         elm_anchorview_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
12097    /**
12098     * Get the markup text set for the anchorview
12099     *
12100     * Retrieves the text set on the anchorview, with markup tags included.
12101     *
12102     * @param obj The anchorview object
12103     * @return The markup text set or @c NULL if nothing was set or an error
12104     * occurred
12105     * @deprecated use elm_object_text_set() instead.
12106     */
12107    EINA_DEPRECATED EAPI const char  *elm_anchorview_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12108    /**
12109     * Set the parent of the hover popup
12110     *
12111     * Sets the parent object to use by the hover created by the anchorview
12112     * when an anchor is clicked. See @ref Hover for more details on this.
12113     * If no parent is set, the same anchorview object will be used.
12114     *
12115     * @param obj The anchorview object
12116     * @param parent The object to use as parent for the hover
12117     */
12118    EAPI void         elm_anchorview_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
12119    /**
12120     * Get the parent of the hover popup
12121     *
12122     * Get the object used as parent for the hover created by the anchorview
12123     * widget. See @ref Hover for more details on this.
12124     *
12125     * @param obj The anchorview object
12126     * @return The object used as parent for the hover, NULL if none is set.
12127     */
12128    EAPI Evas_Object *elm_anchorview_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12129    /**
12130     * Set the style that the hover should use
12131     *
12132     * When creating the popup hover, anchorview will request that it's
12133     * themed according to @p style.
12134     *
12135     * @param obj The anchorview object
12136     * @param style The style to use for the underlying hover
12137     *
12138     * @see elm_object_style_set()
12139     */
12140    EAPI void         elm_anchorview_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
12141    /**
12142     * Get the style that the hover should use
12143     *
12144     * Get the style the hover created by anchorview will use.
12145     *
12146     * @param obj The anchorview object
12147     * @return The style to use by the hover. NULL means the default is used.
12148     *
12149     * @see elm_object_style_set()
12150     */
12151    EAPI const char  *elm_anchorview_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12152    /**
12153     * Ends the hover popup in the anchorview
12154     *
12155     * When an anchor is clicked, the anchorview widget will create a hover
12156     * object to use as a popup with user provided content. This function
12157     * terminates this popup, returning the anchorview to its normal state.
12158     *
12159     * @param obj The anchorview object
12160     */
12161    EAPI void         elm_anchorview_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
12162    /**
12163     * Set bouncing behaviour when the scrolled content reaches an edge
12164     *
12165     * Tell the internal scroller object whether it should bounce or not
12166     * when it reaches the respective edges for each axis.
12167     *
12168     * @param obj The anchorview object
12169     * @param h_bounce Whether to bounce or not in the horizontal axis
12170     * @param v_bounce Whether to bounce or not in the vertical axis
12171     *
12172     * @see elm_scroller_bounce_set()
12173     */
12174    EAPI void         elm_anchorview_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
12175    /**
12176     * Get the set bouncing behaviour of the internal scroller
12177     *
12178     * Get whether the internal scroller should bounce when the edge of each
12179     * axis is reached scrolling.
12180     *
12181     * @param obj The anchorview object
12182     * @param h_bounce Pointer where to store the bounce state of the horizontal
12183     *                 axis
12184     * @param v_bounce Pointer where to store the bounce state of the vertical
12185     *                 axis
12186     *
12187     * @see elm_scroller_bounce_get()
12188     */
12189    EAPI void         elm_anchorview_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
12190    /**
12191     * Appends a custom item provider to the given anchorview
12192     *
12193     * Appends the given function to the list of items providers. This list is
12194     * called, one function at a time, with the given @p data pointer, the
12195     * anchorview object and, in the @p item parameter, the item name as
12196     * referenced in its href string. Following functions in the list will be
12197     * called in order until one of them returns something different to NULL,
12198     * which should be an Evas_Object which will be used in place of the item
12199     * element.
12200     *
12201     * Items in the markup text take the form \<item relsize=16x16 vsize=full
12202     * href=item/name\>\</item\>
12203     *
12204     * @param obj The anchorview object
12205     * @param func The function to add to the list of providers
12206     * @param data User data that will be passed to the callback function
12207     *
12208     * @see elm_entry_item_provider_append()
12209     */
12210    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);
12211    /**
12212     * Prepend a custom item provider to the given anchorview
12213     *
12214     * Like elm_anchorview_item_provider_append(), but it adds the function
12215     * @p func to the beginning of the list, instead of the end.
12216     *
12217     * @param obj The anchorview object
12218     * @param func The function to add to the list of providers
12219     * @param data User data that will be passed to the callback function
12220     */
12221    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);
12222    /**
12223     * Remove a custom item provider from the list of the given anchorview
12224     *
12225     * Removes the function and data pairing that matches @p func and @p data.
12226     * That is, unless the same function and same user data are given, the
12227     * function will not be removed from the list. This allows us to add the
12228     * same callback several times, with different @p data pointers and be
12229     * able to remove them later without conflicts.
12230     *
12231     * @param obj The anchorview object
12232     * @param func The function to remove from the list
12233     * @param data The data matching the function to remove from the list
12234     */
12235    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);
12236    /**
12237     * @}
12238     */
12239
12240    /* anchorblock */
12241    /**
12242     * @defgroup Anchorblock Anchorblock
12243     *
12244     * @image html img/widget/anchorblock/preview-00.png
12245     * @image latex img/widget/anchorblock/preview-00.eps
12246     *
12247     * Anchorblock is for displaying text that contains markup with anchors
12248     * like <c>\<a href=1234\>something\</\></c> in it.
12249     *
12250     * Besides being styled differently, the anchorblock widget provides the
12251     * necessary functionality so that clicking on these anchors brings up a
12252     * popup with user defined content such as "call", "add to contacts" or
12253     * "open web page". This popup is provided using the @ref Hover widget.
12254     *
12255     * This widget emits the following signals:
12256     * @li "anchor,clicked": will be called when an anchor is clicked. The
12257     * @p event_info parameter on the callback will be a pointer of type
12258     * ::Elm_Entry_Anchorblock_Info.
12259     *
12260     * @see Anchorview
12261     * @see Entry
12262     * @see Hover
12263     *
12264     * Since examples are usually better than plain words, we might as well
12265     * try @ref tutorial_anchorblock_example "one".
12266     */
12267    /**
12268     * @addtogroup Anchorblock
12269     * @{
12270     */
12271    /**
12272     * @typedef Elm_Entry_Anchorblock_Info
12273     *
12274     * The info sent in the callback for "anchor,clicked" signals emitted by
12275     * the Anchorblock widget.
12276     */
12277    typedef struct _Elm_Entry_Anchorblock_Info Elm_Entry_Anchorblock_Info;
12278    /**
12279     * @struct _Elm_Entry_Anchorblock_Info
12280     *
12281     * The info sent in the callback for "anchor,clicked" signals emitted by
12282     * the Anchorblock widget.
12283     */
12284    struct _Elm_Entry_Anchorblock_Info
12285      {
12286         const char     *name; /**< Name of the anchor, as indicated in its href
12287                                    attribute */
12288         int             button; /**< The mouse button used to click on it */
12289         Evas_Object    *hover; /**< The hover object to use for the popup */
12290         struct {
12291              Evas_Coord    x, y, w, h;
12292         } anchor, /**< Geometry selection of text used as anchor */
12293           hover_parent; /**< Geometry of the object used as parent by the
12294                              hover */
12295         Eina_Bool       hover_left : 1; /**< Hint indicating if there's space
12296                                              for content on the left side of
12297                                              the hover. Before calling the
12298                                              callback, the widget will make the
12299                                              necessary calculations to check
12300                                              which sides are fit to be set with
12301                                              content, based on the position the
12302                                              hover is activated and its distance
12303                                              to the edges of its parent object
12304                                              */
12305         Eina_Bool       hover_right : 1; /**< Hint indicating content fits on
12306                                               the right side of the hover.
12307                                               See @ref hover_left */
12308         Eina_Bool       hover_top : 1; /**< Hint indicating content fits on top
12309                                             of the hover. See @ref hover_left */
12310         Eina_Bool       hover_bottom : 1; /**< Hint indicating content fits
12311                                                below the hover. See @ref
12312                                                hover_left */
12313      };
12314    /**
12315     * Add a new Anchorblock object
12316     *
12317     * @param parent The parent object
12318     * @return The new object or NULL if it cannot be created
12319     */
12320    EAPI Evas_Object *elm_anchorblock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12321    /**
12322     * Set the text to show in the anchorblock
12323     *
12324     * Sets the text of the anchorblock to @p text. This text can include markup
12325     * format tags, including <c>\<a href=anchorname\></a></c> to begin a segment
12326     * of text that will be specially styled and react to click events, ended
12327     * with either of \</a\> or \</\>. When clicked, the anchor will emit an
12328     * "anchor,clicked" signal that you can attach a callback to with
12329     * evas_object_smart_callback_add(). The name of the anchor given in the
12330     * event info struct will be the one set in the href attribute, in this
12331     * case, anchorname.
12332     *
12333     * Other markup can be used to style the text in different ways, but it's
12334     * up to the style defined in the theme which tags do what.
12335     * @deprecated use elm_object_text_set() instead.
12336     */
12337    EINA_DEPRECATED EAPI void         elm_anchorblock_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
12338    /**
12339     * Get the markup text set for the anchorblock
12340     *
12341     * Retrieves the text set on the anchorblock, with markup tags included.
12342     *
12343     * @param obj The anchorblock object
12344     * @return The markup text set or @c NULL if nothing was set or an error
12345     * occurred
12346     * @deprecated use elm_object_text_set() instead.
12347     */
12348    EINA_DEPRECATED EAPI const char  *elm_anchorblock_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12349    /**
12350     * Set the parent of the hover popup
12351     *
12352     * Sets the parent object to use by the hover created by the anchorblock
12353     * when an anchor is clicked. See @ref Hover for more details on this.
12354     *
12355     * @param obj The anchorblock object
12356     * @param parent The object to use as parent for the hover
12357     */
12358    EAPI void         elm_anchorblock_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
12359    /**
12360     * Get the parent of the hover popup
12361     *
12362     * Get the object used as parent for the hover created by the anchorblock
12363     * widget. See @ref Hover for more details on this.
12364     * If no parent is set, the same anchorblock object will be used.
12365     *
12366     * @param obj The anchorblock object
12367     * @return The object used as parent for the hover, NULL if none is set.
12368     */
12369    EAPI Evas_Object *elm_anchorblock_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12370    /**
12371     * Set the style that the hover should use
12372     *
12373     * When creating the popup hover, anchorblock will request that it's
12374     * themed according to @p style.
12375     *
12376     * @param obj The anchorblock object
12377     * @param style The style to use for the underlying hover
12378     *
12379     * @see elm_object_style_set()
12380     */
12381    EAPI void         elm_anchorblock_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
12382    /**
12383     * Get the style that the hover should use
12384     *
12385     * Get the style, the hover created by anchorblock will use.
12386     *
12387     * @param obj The anchorblock object
12388     * @return The style to use by the hover. NULL means the default is used.
12389     *
12390     * @see elm_object_style_set()
12391     */
12392    EAPI const char  *elm_anchorblock_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12393    /**
12394     * Ends the hover popup in the anchorblock
12395     *
12396     * When an anchor is clicked, the anchorblock widget will create a hover
12397     * object to use as a popup with user provided content. This function
12398     * terminates this popup, returning the anchorblock to its normal state.
12399     *
12400     * @param obj The anchorblock object
12401     */
12402    EAPI void         elm_anchorblock_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
12403    /**
12404     * Appends a custom item provider to the given anchorblock
12405     *
12406     * Appends the given function to the list of items providers. This list is
12407     * called, one function at a time, with the given @p data pointer, the
12408     * anchorblock object and, in the @p item parameter, the item name as
12409     * referenced in its href string. Following functions in the list will be
12410     * called in order until one of them returns something different to NULL,
12411     * which should be an Evas_Object which will be used in place of the item
12412     * element.
12413     *
12414     * Items in the markup text take the form \<item relsize=16x16 vsize=full
12415     * href=item/name\>\</item\>
12416     *
12417     * @param obj The anchorblock object
12418     * @param func The function to add to the list of providers
12419     * @param data User data that will be passed to the callback function
12420     *
12421     * @see elm_entry_item_provider_append()
12422     */
12423    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);
12424    /**
12425     * Prepend a custom item provider to the given anchorblock
12426     *
12427     * Like elm_anchorblock_item_provider_append(), but it adds the function
12428     * @p func to the beginning of the list, instead of the end.
12429     *
12430     * @param obj The anchorblock object
12431     * @param func The function to add to the list of providers
12432     * @param data User data that will be passed to the callback function
12433     */
12434    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);
12435    /**
12436     * Remove a custom item provider from the list of the given anchorblock
12437     *
12438     * Removes the function and data pairing that matches @p func and @p data.
12439     * That is, unless the same function and same user data are given, the
12440     * function will not be removed from the list. This allows us to add the
12441     * same callback several times, with different @p data pointers and be
12442     * able to remove them later without conflicts.
12443     *
12444     * @param obj The anchorblock object
12445     * @param func The function to remove from the list
12446     * @param data The data matching the function to remove from the list
12447     */
12448    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);
12449    /**
12450     * @}
12451     */
12452
12453    /**
12454     * @defgroup Bubble Bubble
12455     *
12456     * @image html img/widget/bubble/preview-00.png
12457     * @image latex img/widget/bubble/preview-00.eps
12458     * @image html img/widget/bubble/preview-01.png
12459     * @image latex img/widget/bubble/preview-01.eps
12460     * @image html img/widget/bubble/preview-02.png
12461     * @image latex img/widget/bubble/preview-02.eps
12462     *
12463     * @brief The Bubble is a widget to show text similar to how speech is
12464     * represented in comics.
12465     *
12466     * The bubble widget contains 5 important visual elements:
12467     * @li The frame is a rectangle with rounded edjes and an "arrow".
12468     * @li The @p icon is an image to which the frame's arrow points to.
12469     * @li The @p label is a text which appears to the right of the icon if the
12470     * corner is "top_left" or "bottom_left" and is right aligned to the frame
12471     * otherwise.
12472     * @li The @p info is a text which appears to the right of the label. Info's
12473     * font is of a ligther color than label.
12474     * @li The @p content is an evas object that is shown inside the frame.
12475     *
12476     * The position of the arrow, icon, label and info depends on which corner is
12477     * selected. The four available corners are:
12478     * @li "top_left" - Default
12479     * @li "top_right"
12480     * @li "bottom_left"
12481     * @li "bottom_right"
12482     *
12483     * Signals that you can add callbacks for are:
12484     * @li "clicked" - This is called when a user has clicked the bubble.
12485     *
12486     * Default contents parts of the bubble that you can use for are:
12487     * @li "default" - A content of the bubble
12488     * @li "icon" - An icon of the bubble
12489     *
12490     * Default text parts of the button widget that you can use for are:
12491     * @li NULL - Label of the bubble
12492     * 
12493          * For an example of using a buble see @ref bubble_01_example_page "this".
12494     *
12495     * @{
12496     */
12497
12498    /**
12499     * Add a new bubble to the parent
12500     *
12501     * @param parent The parent object
12502     * @return The new object or NULL if it cannot be created
12503     *
12504     * This function adds a text bubble to the given parent evas object.
12505     */
12506    EAPI Evas_Object *elm_bubble_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12507    /**
12508     * Set the label of the bubble
12509     *
12510     * @param obj The bubble object
12511     * @param label The string to set in the label
12512     *
12513     * This function sets the title of the bubble. Where this appears depends on
12514     * the selected corner.
12515     * @deprecated use elm_object_text_set() instead.
12516     */
12517    EINA_DEPRECATED EAPI void         elm_bubble_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
12518    /**
12519     * Get the label of the bubble
12520     *
12521     * @param obj The bubble object
12522     * @return The string of set in the label
12523     *
12524     * This function gets the title of the bubble.
12525     * @deprecated use elm_object_text_get() instead.
12526     */
12527    EINA_DEPRECATED EAPI const char  *elm_bubble_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12528    /**
12529     * Set the info of the bubble
12530     *
12531     * @param obj The bubble object
12532     * @param info The given info about the bubble
12533     *
12534     * This function sets the info of the bubble. Where this appears depends on
12535     * the selected corner.
12536     * @deprecated use elm_object_part_text_set() instead. (with "info" as the parameter).
12537     */
12538    EINA_DEPRECATED EAPI void         elm_bubble_info_set(Evas_Object *obj, const char *info) EINA_ARG_NONNULL(1);
12539    /**
12540     * Get the info of the bubble
12541     *
12542     * @param obj The bubble object
12543     *
12544     * @return The "info" string of the bubble
12545     *
12546     * This function gets the info text.
12547     * @deprecated use elm_object_part_text_get() instead. (with "info" as the parameter).
12548     */
12549    EINA_DEPRECATED EAPI const char  *elm_bubble_info_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12550    /**
12551     * Set the content to be shown in the bubble
12552     *
12553     * Once the content object is set, a previously set one will be deleted.
12554     * If you want to keep the old content object, use the
12555     * elm_bubble_content_unset() function.
12556     *
12557     * @param obj The bubble object
12558     * @param content The given content of the bubble
12559     *
12560     * This function sets the content shown on the middle of the bubble.
12561     * 
12562     * @deprecated use elm_object_content_set() instead
12563     *
12564     */
12565    WILL_DEPRECATE  EAPI void         elm_bubble_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
12566    /**
12567     * Get the content shown in the bubble
12568     *
12569     * Return the content object which is set for this widget.
12570     *
12571     * @param obj The bubble object
12572     * @return The content that is being used
12573     *
12574     * @deprecated use elm_object_content_get() instead
12575     *
12576     */
12577    WILL_DEPRECATE  EAPI Evas_Object *elm_bubble_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12578    /**
12579     * Unset the content shown in the bubble
12580     *
12581     * Unparent and return the content object which was set for this widget.
12582     *
12583     * @param obj The bubble object
12584     * @return The content that was being used
12585     *
12586     * @deprecated use elm_object_content_unset() instead
12587     *
12588     */
12589    WILL_DEPRECATE  EAPI Evas_Object *elm_bubble_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12590    /**
12591     * Set the icon of the bubble
12592     *
12593     * Once the icon object is set, a previously set one will be deleted.
12594     * If you want to keep the old content object, use the
12595     * elm_icon_content_unset() function.
12596     *
12597     * @param obj The bubble object
12598     * @param icon The given icon for the bubble
12599     *
12600     * @deprecated use elm_object_part_content_set() instead
12601     *
12602     */
12603    EINA_DEPRECATED EAPI void         elm_bubble_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
12604    /**
12605     * Get the icon of the bubble
12606     *
12607     * @param obj The bubble object
12608     * @return The icon for the bubble
12609     *
12610     * This function gets the icon shown on the top left of bubble.
12611     *
12612     * @deprecated use elm_object_part_content_get() instead
12613     *
12614     */
12615    EINA_DEPRECATED EAPI Evas_Object *elm_bubble_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12616    /**
12617     * Unset the icon of the bubble
12618     *
12619     * Unparent and return the icon object which was set for this widget.
12620     *
12621     * @param obj The bubble object
12622     * @return The icon that was being used
12623     *
12624     * @deprecated use elm_object_part_content_unset() instead
12625     *
12626     */
12627    EINA_DEPRECATED EAPI Evas_Object *elm_bubble_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12628    /**
12629     * Set the corner of the bubble
12630     *
12631     * @param obj The bubble object.
12632     * @param corner The given corner for the bubble.
12633     *
12634     * This function sets the corner of the bubble. The corner will be used to
12635     * determine where the arrow in the frame points to and where label, icon and
12636     * info are shown.
12637     *
12638     * Possible values for corner are:
12639     * @li "top_left" - Default
12640     * @li "top_right"
12641     * @li "bottom_left"
12642     * @li "bottom_right"
12643     */
12644    EAPI void         elm_bubble_corner_set(Evas_Object *obj, const char *corner) EINA_ARG_NONNULL(1, 2);
12645    /**
12646     * Get the corner of the bubble
12647     *
12648     * @param obj The bubble object.
12649     * @return The given corner for the bubble.
12650     *
12651     * This function gets the selected corner of the bubble.
12652     */
12653    EAPI const char  *elm_bubble_corner_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12654
12655    /**
12656     * @}
12657     */
12658
12659    /**
12660     * @defgroup Photo Photo
12661     *
12662     * For displaying the photo of a person (contact). Simple, yet
12663     * with a very specific purpose.
12664     *
12665     * Signals that you can add callbacks for are:
12666     *
12667     * "clicked" - This is called when a user has clicked the photo
12668     * "drag,start" - Someone started dragging the image out of the object
12669     * "drag,end" - Dragged item was dropped (somewhere)
12670     *
12671     * @{
12672     */
12673
12674    /**
12675     * Add a new photo to the parent
12676     *
12677     * @param parent The parent object
12678     * @return The new object or NULL if it cannot be created
12679     *
12680     * @ingroup Photo
12681     */
12682    EAPI Evas_Object *elm_photo_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12683
12684    /**
12685     * Set the file that will be used as photo
12686     *
12687     * @param obj The photo object
12688     * @param file The path to file that will be used as photo
12689     *
12690     * @return (1 = success, 0 = error)
12691     *
12692     * @ingroup Photo
12693     */
12694    EAPI Eina_Bool    elm_photo_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
12695
12696     /**
12697     * Set the file that will be used as thumbnail in the photo.
12698     *
12699     * @param obj The photo object.
12700     * @param file The path to file that will be used as thumb.
12701     * @param group The key used in case of an EET file.
12702     *
12703     * @ingroup Photo
12704     */
12705    EAPI void         elm_photo_thumb_set(const Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
12706
12707    /**
12708     * Set the size that will be used on the photo
12709     *
12710     * @param obj The photo object
12711     * @param size The size that the photo will be
12712     *
12713     * @ingroup Photo
12714     */
12715    EAPI void         elm_photo_size_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
12716
12717    /**
12718     * Set if the photo should be completely visible or not.
12719     *
12720     * @param obj The photo object
12721     * @param fill if true the photo will be completely visible
12722     *
12723     * @ingroup Photo
12724     */
12725    EAPI void         elm_photo_fill_inside_set(Evas_Object *obj, Eina_Bool fill) EINA_ARG_NONNULL(1);
12726
12727    /**
12728     * Set editability of the photo.
12729     *
12730     * An editable photo can be dragged to or from, and can be cut or
12731     * pasted too.  Note that pasting an image or dropping an item on
12732     * the image will delete the existing content.
12733     *
12734     * @param obj The photo object.
12735     * @param set To set of clear editablity.
12736     */
12737    EAPI void         elm_photo_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
12738
12739    /**
12740     * @}
12741     */
12742
12743    /* gesture layer */
12744    /**
12745     * @defgroup Elm_Gesture_Layer Gesture Layer
12746     * Gesture Layer Usage:
12747     *
12748     * Use Gesture Layer to detect gestures.
12749     * The advantage is that you don't have to implement
12750     * gesture detection, just set callbacks of gesture state.
12751     * By using gesture layer we make standard interface.
12752     *
12753     * In order to use Gesture Layer you start with @ref elm_gesture_layer_add
12754     * with a parent object parameter.
12755     * Next 'activate' gesture layer with a @ref elm_gesture_layer_attach
12756     * call. Usually with same object as target (2nd parameter).
12757     *
12758     * Now you need to tell gesture layer what gestures you follow.
12759     * This is done with @ref elm_gesture_layer_cb_set call.
12760     * By setting the callback you actually saying to gesture layer:
12761     * I would like to know when the gesture @ref Elm_Gesture_Types
12762     * switches to state @ref Elm_Gesture_State.
12763     *
12764     * Next, you need to implement the actual action that follows the input
12765     * in your callback.
12766     *
12767     * Note that if you like to stop being reported about a gesture, just set
12768     * all callbacks referring this gesture to NULL.
12769     * (again with @ref elm_gesture_layer_cb_set)
12770     *
12771     * The information reported by gesture layer to your callback is depending
12772     * on @ref Elm_Gesture_Types:
12773     * @ref Elm_Gesture_Taps_Info is the info reported for tap gestures:
12774     * @ref ELM_GESTURE_N_TAPS, @ref ELM_GESTURE_N_LONG_TAPS,
12775     * @ref ELM_GESTURE_N_DOUBLE_TAPS, @ref ELM_GESTURE_N_TRIPLE_TAPS.
12776     *
12777     * @ref Elm_Gesture_Momentum_Info is info reported for momentum gestures:
12778     * @ref ELM_GESTURE_MOMENTUM.
12779     *
12780     * @ref Elm_Gesture_Line_Info is the info reported for line gestures:
12781     * (this also contains @ref Elm_Gesture_Momentum_Info internal structure)
12782     * @ref ELM_GESTURE_N_LINES, @ref ELM_GESTURE_N_FLICKS.
12783     * Note that we consider a flick as a line-gesture that should be completed
12784     * in flick-time-limit as defined in @ref Config.
12785     *
12786     * @ref Elm_Gesture_Zoom_Info is the info reported for @ref ELM_GESTURE_ZOOM gesture.
12787     *
12788     * @ref Elm_Gesture_Rotate_Info is the info reported for @ref ELM_GESTURE_ROTATE gesture.
12789     *
12790     *
12791     * Gesture Layer Tweaks:
12792     *
12793     * Note that line, flick, gestures can start without the need to remove fingers from surface.
12794     * When user fingers rests on same-spot gesture is ended and starts again when fingers moved.
12795     *
12796     * Setting glayer_continues_enable to false in @ref Config will change this behavior
12797     * so gesture starts when user touches (a *DOWN event) touch-surface
12798     * and ends when no fingers touches surface (a *UP event).
12799     */
12800
12801    /**
12802     * @enum _Elm_Gesture_Types
12803     * Enum of supported gesture types.
12804     * @ingroup Elm_Gesture_Layer
12805     */
12806    enum _Elm_Gesture_Types
12807      {
12808         ELM_GESTURE_FIRST = 0,
12809
12810         ELM_GESTURE_N_TAPS, /**< N fingers single taps */
12811         ELM_GESTURE_N_LONG_TAPS, /**< N fingers single long-taps */
12812         ELM_GESTURE_N_DOUBLE_TAPS, /**< N fingers double-single taps */
12813         ELM_GESTURE_N_TRIPLE_TAPS, /**< N fingers triple-single taps */
12814
12815         ELM_GESTURE_MOMENTUM, /**< Reports momentum in the dircetion of move */
12816
12817         ELM_GESTURE_N_LINES, /**< N fingers line gesture */
12818         ELM_GESTURE_N_FLICKS, /**< N fingers flick gesture */
12819
12820         ELM_GESTURE_ZOOM, /**< Zoom */
12821         ELM_GESTURE_ROTATE, /**< Rotate */
12822
12823         ELM_GESTURE_LAST
12824      };
12825
12826    /**
12827     * @typedef Elm_Gesture_Types
12828     * gesture types enum
12829     * @ingroup Elm_Gesture_Layer
12830     */
12831    typedef enum _Elm_Gesture_Types Elm_Gesture_Types;
12832
12833    /**
12834     * @enum _Elm_Gesture_State
12835     * Enum of gesture states.
12836     * @ingroup Elm_Gesture_Layer
12837     */
12838    enum _Elm_Gesture_State
12839      {
12840         ELM_GESTURE_STATE_UNDEFINED = -1, /**< Gesture not STARTed */
12841         ELM_GESTURE_STATE_START,          /**< Gesture STARTed     */
12842         ELM_GESTURE_STATE_MOVE,           /**< Gesture is ongoing  */
12843         ELM_GESTURE_STATE_END,            /**< Gesture completed   */
12844         ELM_GESTURE_STATE_ABORT    /**< Onging gesture was ABORTed */
12845      };
12846
12847    /**
12848     * @typedef Elm_Gesture_State
12849     * gesture states enum
12850     * @ingroup Elm_Gesture_Layer
12851     */
12852    typedef enum _Elm_Gesture_State Elm_Gesture_State;
12853
12854    /**
12855     * @struct _Elm_Gesture_Taps_Info
12856     * Struct holds taps info for user
12857     * @ingroup Elm_Gesture_Layer
12858     */
12859    struct _Elm_Gesture_Taps_Info
12860      {
12861         Evas_Coord x, y;         /**< Holds center point between fingers */
12862         unsigned int n;          /**< Number of fingers tapped           */
12863         unsigned int timestamp;  /**< event timestamp       */
12864      };
12865
12866    /**
12867     * @typedef Elm_Gesture_Taps_Info
12868     * holds taps info for user
12869     * @ingroup Elm_Gesture_Layer
12870     */
12871    typedef struct _Elm_Gesture_Taps_Info Elm_Gesture_Taps_Info;
12872
12873    /**
12874     * @struct _Elm_Gesture_Momentum_Info
12875     * Struct holds momentum info for user
12876     * x1 and y1 are not necessarily in sync
12877     * x1 holds x value of x direction starting point
12878     * and same holds for y1.
12879     * This is noticeable when doing V-shape movement
12880     * @ingroup Elm_Gesture_Layer
12881     */
12882    struct _Elm_Gesture_Momentum_Info
12883      {  /* Report line ends, timestamps, and momentum computed        */
12884         Evas_Coord x1; /**< Final-swipe direction starting point on X */
12885         Evas_Coord y1; /**< Final-swipe direction starting point on Y */
12886         Evas_Coord x2; /**< Final-swipe direction ending point on X   */
12887         Evas_Coord y2; /**< Final-swipe direction ending point on Y   */
12888
12889         unsigned int tx; /**< Timestamp of start of final x-swipe */
12890         unsigned int ty; /**< Timestamp of start of final y-swipe */
12891
12892         Evas_Coord mx; /**< Momentum on X */
12893         Evas_Coord my; /**< Momentum on Y */
12894
12895         unsigned int n;  /**< Number of fingers */
12896      };
12897
12898    /**
12899     * @typedef Elm_Gesture_Momentum_Info
12900     * holds momentum info for user
12901     * @ingroup Elm_Gesture_Layer
12902     */
12903     typedef struct _Elm_Gesture_Momentum_Info Elm_Gesture_Momentum_Info;
12904
12905    /**
12906     * @struct _Elm_Gesture_Line_Info
12907     * Struct holds line info for user
12908     * @ingroup Elm_Gesture_Layer
12909     */
12910    struct _Elm_Gesture_Line_Info
12911      {  /* Report line ends, timestamps, and momentum computed      */
12912         Elm_Gesture_Momentum_Info momentum; /**< Line momentum info */
12913         double angle;              /**< Angle (direction) of lines  */
12914      };
12915
12916    /**
12917     * @typedef Elm_Gesture_Line_Info
12918     * Holds line info for user
12919     * @ingroup Elm_Gesture_Layer
12920     */
12921     typedef struct  _Elm_Gesture_Line_Info Elm_Gesture_Line_Info;
12922
12923    /**
12924     * @struct _Elm_Gesture_Zoom_Info
12925     * Struct holds zoom info for user
12926     * @ingroup Elm_Gesture_Layer
12927     */
12928    struct _Elm_Gesture_Zoom_Info
12929      {
12930         Evas_Coord x, y;       /**< Holds zoom center point reported to user  */
12931         Evas_Coord radius; /**< Holds radius between fingers reported to user */
12932         double zoom;            /**< Zoom value: 1.0 means no zoom             */
12933         double momentum;        /**< Zoom momentum: zoom growth per second (NOT YET SUPPORTED) */
12934      };
12935
12936    /**
12937     * @typedef Elm_Gesture_Zoom_Info
12938     * Holds zoom info for user
12939     * @ingroup Elm_Gesture_Layer
12940     */
12941    typedef struct _Elm_Gesture_Zoom_Info Elm_Gesture_Zoom_Info;
12942
12943    /**
12944     * @struct _Elm_Gesture_Rotate_Info
12945     * Struct holds rotation info for user
12946     * @ingroup Elm_Gesture_Layer
12947     */
12948    struct _Elm_Gesture_Rotate_Info
12949      {
12950         Evas_Coord x, y;   /**< Holds zoom center point reported to user      */
12951         Evas_Coord radius; /**< Holds radius between fingers reported to user */
12952         double base_angle; /**< Holds start-angle */
12953         double angle;      /**< Rotation value: 0.0 means no rotation         */
12954         double momentum;   /**< Rotation momentum: rotation done per second (NOT YET SUPPORTED) */
12955      };
12956
12957    /**
12958     * @typedef Elm_Gesture_Rotate_Info
12959     * Holds rotation info for user
12960     * @ingroup Elm_Gesture_Layer
12961     */
12962    typedef struct _Elm_Gesture_Rotate_Info Elm_Gesture_Rotate_Info;
12963
12964    /**
12965     * @typedef Elm_Gesture_Event_Cb
12966     * User callback used to stream gesture info from gesture layer
12967     * @param data user data
12968     * @param event_info gesture report info
12969     * Returns a flag field to be applied on the causing event.
12970     * You should probably return EVAS_EVENT_FLAG_ON_HOLD if your widget acted
12971     * upon the event, in an irreversible way.
12972     *
12973     * @ingroup Elm_Gesture_Layer
12974     */
12975    typedef Evas_Event_Flags (*Elm_Gesture_Event_Cb) (void *data, void *event_info);
12976
12977    /**
12978     * Use function to set callbacks to be notified about
12979     * change of state of gesture.
12980     * When a user registers a callback with this function
12981     * this means this gesture has to be tested.
12982     *
12983     * When ALL callbacks for a gesture are set to NULL
12984     * it means user isn't interested in gesture-state
12985     * and it will not be tested.
12986     *
12987     * @param obj Pointer to gesture-layer.
12988     * @param idx The gesture you would like to track its state.
12989     * @param cb callback function pointer.
12990     * @param cb_type what event this callback tracks: START, MOVE, END, ABORT.
12991     * @param data user info to be sent to callback (usually, Smart Data)
12992     *
12993     * @ingroup Elm_Gesture_Layer
12994     */
12995    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);
12996
12997    /**
12998     * Call this function to get repeat-events settings.
12999     *
13000     * @param obj Pointer to gesture-layer.
13001     *
13002     * @return repeat events settings.
13003     * @see elm_gesture_layer_hold_events_set()
13004     * @ingroup Elm_Gesture_Layer
13005     */
13006    EAPI Eina_Bool elm_gesture_layer_hold_events_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
13007
13008    /**
13009     * This function called in order to make gesture-layer repeat events.
13010     * Set this of you like to get the raw events only if gestures were not detected.
13011     * Clear this if you like gesture layer to fwd events as testing gestures.
13012     *
13013     * @param obj Pointer to gesture-layer.
13014     * @param r Repeat: TRUE/FALSE
13015     *
13016     * @ingroup Elm_Gesture_Layer
13017     */
13018    EAPI void elm_gesture_layer_hold_events_set(Evas_Object *obj, Eina_Bool r) EINA_ARG_NONNULL(1);
13019
13020    /**
13021     * This function sets step-value for zoom action.
13022     * Set step to any positive value.
13023     * Cancel step setting by setting to 0.0
13024     *
13025     * @param obj Pointer to gesture-layer.
13026     * @param s new zoom step value.
13027     *
13028     * @ingroup Elm_Gesture_Layer
13029     */
13030    EAPI void elm_gesture_layer_zoom_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
13031
13032    /**
13033     * This function sets step-value for rotate action.
13034     * Set step to any positive value.
13035     * Cancel step setting by setting to 0.0
13036     *
13037     * @param obj Pointer to gesture-layer.
13038     * @param s new roatate step value.
13039     *
13040     * @ingroup Elm_Gesture_Layer
13041     */
13042    EAPI void elm_gesture_layer_rotate_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
13043
13044    /**
13045     * This function called to attach gesture-layer to an Evas_Object.
13046     * @param obj Pointer to gesture-layer.
13047     * @param t Pointer to underlying object (AKA Target)
13048     *
13049     * @return TRUE, FALSE on success, failure.
13050     *
13051     * @ingroup Elm_Gesture_Layer
13052     */
13053    EAPI Eina_Bool elm_gesture_layer_attach(Evas_Object *obj, Evas_Object *t) EINA_ARG_NONNULL(1, 2);
13054
13055    /**
13056     * Call this function to construct a new gesture-layer object.
13057     * This does not activate the gesture layer. You have to
13058     * call elm_gesture_layer_attach in order to 'activate' gesture-layer.
13059     *
13060     * @param parent the parent object.
13061     *
13062     * @return Pointer to new gesture-layer object.
13063     *
13064     * @ingroup Elm_Gesture_Layer
13065     */
13066    EAPI Evas_Object *elm_gesture_layer_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13067
13068    /**
13069     * @defgroup Thumb Thumb
13070     *
13071     * @image html img/widget/thumb/preview-00.png
13072     * @image latex img/widget/thumb/preview-00.eps
13073     *
13074     * A thumb object is used for displaying the thumbnail of an image or video.
13075     * You must have compiled Elementary with Ethumb_Client support and the DBus
13076     * service must be present and auto-activated in order to have thumbnails to
13077     * be generated.
13078     *
13079     * Once the thumbnail object becomes visible, it will check if there is a
13080     * previously generated thumbnail image for the file set on it. If not, it
13081     * will start generating this thumbnail.
13082     *
13083     * Different config settings will cause different thumbnails to be generated
13084     * even on the same file.
13085     *
13086     * Generated thumbnails are stored under @c $HOME/.thumbnails/. Check the
13087     * Ethumb documentation to change this path, and to see other configuration
13088     * options.
13089     *
13090     * Signals that you can add callbacks for are:
13091     *
13092     * - "clicked" - This is called when a user has clicked the thumb without dragging
13093     *             around.
13094     * - "clicked,double" - This is called when a user has double-clicked the thumb.
13095     * - "press" - This is called when a user has pressed down the thumb.
13096     * - "generate,start" - The thumbnail generation started.
13097     * - "generate,stop" - The generation process stopped.
13098     * - "generate,error" - The generation failed.
13099     * - "load,error" - The thumbnail image loading failed.
13100     *
13101     * available styles:
13102     * - default
13103     * - noframe
13104     *
13105     * An example of use of thumbnail:
13106     *
13107     * - @ref thumb_example_01
13108     */
13109
13110    /**
13111     * @addtogroup Thumb
13112     * @{
13113     */
13114
13115    /**
13116     * @enum _Elm_Thumb_Animation_Setting
13117     * @typedef Elm_Thumb_Animation_Setting
13118     *
13119     * Used to set if a video thumbnail is animating or not.
13120     *
13121     * @ingroup Thumb
13122     */
13123    typedef enum _Elm_Thumb_Animation_Setting
13124      {
13125         ELM_THUMB_ANIMATION_START = 0, /**< Play animation once */
13126         ELM_THUMB_ANIMATION_LOOP,      /**< Keep playing animation until stop is requested */
13127         ELM_THUMB_ANIMATION_STOP,      /**< Stop playing the animation */
13128         ELM_THUMB_ANIMATION_LAST
13129      } Elm_Thumb_Animation_Setting;
13130
13131    /**
13132     * Add a new thumb object to the parent.
13133     *
13134     * @param parent The parent object.
13135     * @return The new object or NULL if it cannot be created.
13136     *
13137     * @see elm_thumb_file_set()
13138     * @see elm_thumb_ethumb_client_get()
13139     *
13140     * @ingroup Thumb
13141     */
13142    EAPI Evas_Object                 *elm_thumb_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13143    /**
13144     * Reload thumbnail if it was generated before.
13145     *
13146     * @param obj The thumb object to reload
13147     *
13148     * This is useful if the ethumb client configuration changed, like its
13149     * size, aspect or any other property one set in the handle returned
13150     * by elm_thumb_ethumb_client_get().
13151     *
13152     * If the options didn't change, the thumbnail won't be generated again, but
13153     * the old one will still be used.
13154     *
13155     * @see elm_thumb_file_set()
13156     *
13157     * @ingroup Thumb
13158     */
13159    EAPI void                         elm_thumb_reload(Evas_Object *obj) EINA_ARG_NONNULL(1);
13160    /**
13161     * Set the file that will be used as thumbnail.
13162     *
13163     * @param obj The thumb object.
13164     * @param file The path to file that will be used as thumb.
13165     * @param key The key used in case of an EET file.
13166     *
13167     * The file can be an image or a video (in that case, acceptable extensions are:
13168     * avi, mp4, ogv, mov, mpg and wmv). To start the video animation, use the
13169     * function elm_thumb_animate().
13170     *
13171     * @see elm_thumb_file_get()
13172     * @see elm_thumb_reload()
13173     * @see elm_thumb_animate()
13174     *
13175     * @ingroup Thumb
13176     */
13177    EAPI void                         elm_thumb_file_set(Evas_Object *obj, const char *file, const char *key) EINA_ARG_NONNULL(1);
13178    /**
13179     * Get the image or video path and key used to generate the thumbnail.
13180     *
13181     * @param obj The thumb object.
13182     * @param file Pointer to filename.
13183     * @param key Pointer to key.
13184     *
13185     * @see elm_thumb_file_set()
13186     * @see elm_thumb_path_get()
13187     *
13188     * @ingroup Thumb
13189     */
13190    EAPI void                         elm_thumb_file_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
13191    /**
13192     * Get the path and key to the image or video generated by ethumb.
13193     *
13194     * One just need to make sure that the thumbnail was generated before getting
13195     * its path; otherwise, the path will be NULL. One way to do that is by asking
13196     * for the path when/after the "generate,stop" smart callback is called.
13197     *
13198     * @param obj The thumb object.
13199     * @param file Pointer to thumb path.
13200     * @param key Pointer to thumb key.
13201     *
13202     * @see elm_thumb_file_get()
13203     *
13204     * @ingroup Thumb
13205     */
13206    EAPI void                         elm_thumb_path_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
13207    /**
13208     * Set the animation state for the thumb object. If its content is an animated
13209     * video, you may start/stop the animation or tell it to play continuously and
13210     * looping.
13211     *
13212     * @param obj The thumb object.
13213     * @param setting The animation setting.
13214     *
13215     * @see elm_thumb_file_set()
13216     *
13217     * @ingroup Thumb
13218     */
13219    EAPI void                         elm_thumb_animate_set(Evas_Object *obj, Elm_Thumb_Animation_Setting s) EINA_ARG_NONNULL(1);
13220    /**
13221     * Get the animation state for the thumb object.
13222     *
13223     * @param obj The thumb object.
13224     * @return getting The animation setting or @c ELM_THUMB_ANIMATION_LAST,
13225     * on errors.
13226     *
13227     * @see elm_thumb_animate_set()
13228     *
13229     * @ingroup Thumb
13230     */
13231    EAPI Elm_Thumb_Animation_Setting  elm_thumb_animate_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13232    /**
13233     * Get the ethumb_client handle so custom configuration can be made.
13234     *
13235     * @return Ethumb_Client instance or NULL.
13236     *
13237     * This must be called before the objects are created to be sure no object is
13238     * visible and no generation started.
13239     *
13240     * Example of usage:
13241     *
13242     * @code
13243     * #include <Elementary.h>
13244     * #ifndef ELM_LIB_QUICKLAUNCH
13245     * EAPI_MAIN int
13246     * elm_main(int argc, char **argv)
13247     * {
13248     *    Ethumb_Client *client;
13249     *
13250     *    elm_need_ethumb();
13251     *
13252     *    // ... your code
13253     *
13254     *    client = elm_thumb_ethumb_client_get();
13255     *    if (!client)
13256     *      {
13257     *         ERR("could not get ethumb_client");
13258     *         return 1;
13259     *      }
13260     *    ethumb_client_size_set(client, 100, 100);
13261     *    ethumb_client_crop_align_set(client, 0.5, 0.5);
13262     *    // ... your code
13263     *
13264     *    // Create elm_thumb objects here
13265     *
13266     *    elm_run();
13267     *    elm_shutdown();
13268     *    return 0;
13269     * }
13270     * #endif
13271     * ELM_MAIN()
13272     * @endcode
13273     *
13274     * @note There's only one client handle for Ethumb, so once a configuration
13275     * change is done to it, any other request for thumbnails (for any thumbnail
13276     * object) will use that configuration. Thus, this configuration is global.
13277     *
13278     * @ingroup Thumb
13279     */
13280    EAPI void                        *elm_thumb_ethumb_client_get(void);
13281    /**
13282     * Get the ethumb_client connection state.
13283     *
13284     * @return EINA_TRUE if the client is connected to the server or EINA_FALSE
13285     * otherwise.
13286     */
13287    EAPI Eina_Bool                    elm_thumb_ethumb_client_connected(void);
13288    /**
13289     * Make the thumbnail 'editable'.
13290     *
13291     * @param obj Thumb object.
13292     * @param set Turn on or off editability. Default is @c EINA_FALSE.
13293     *
13294     * This means the thumbnail is a valid drag target for drag and drop, and can be
13295     * cut or pasted too.
13296     *
13297     * @see elm_thumb_editable_get()
13298     *
13299     * @ingroup Thumb
13300     */
13301    EAPI Eina_Bool                    elm_thumb_editable_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
13302    EAPI Eina_Bool                    elm_thumb_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13303    /**
13304     * Make the thumbnail 'editable'.
13305     *
13306     * @param obj Thumb object.
13307     * @return Editability.
13308     *
13309     * This means the thumbnail is a valid drag target for drag and drop, and can be
13310     * cut or pasted too.
13311     *
13312     * @see elm_thumb_editable_set()
13313     *
13314     * @ingroup Thumb
13315     */
13316    EAPI Eina_Bool                    elm_thumb_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13317
13318    /**
13319     * @}
13320     */
13321
13322    /**
13323     * @defgroup Web Web
13324     *
13325     * @image html img/widget/web/preview-00.png
13326     * @image latex img/widget/web/preview-00.eps
13327     *
13328     * A web object is used for displaying web pages (HTML/CSS/JS)
13329     * using WebKit-EFL. You must have compiled Elementary with
13330     * ewebkit support.
13331     *
13332     * Signals that you can add callbacks for are:
13333     * @li "download,request": A file download has been requested. Event info is
13334     * a pointer to a Elm_Web_Download
13335     * @li "editorclient,contents,changed": Editor client's contents changed
13336     * @li "editorclient,selection,changed": Editor client's selection changed
13337     * @li "frame,created": A new frame was created. Event info is an
13338     * Evas_Object which can be handled with WebKit's ewk_frame API
13339     * @li "icon,received": An icon was received by the main frame
13340     * @li "inputmethod,changed": Input method changed. Event info is an
13341     * Eina_Bool indicating whether it's enabled or not
13342     * @li "js,windowobject,clear": JS window object has been cleared
13343     * @li "link,hover,in": Mouse cursor is hovering over a link. Event info
13344     * is a char *link[2], where the first string contains the URL the link
13345     * points to, and the second one the title of the link
13346     * @li "link,hover,out": Mouse cursor left the link
13347     * @li "load,document,finished": Loading of a document finished. Event info
13348     * is the frame that finished loading
13349     * @li "load,error": Load failed. Event info is a pointer to
13350     * Elm_Web_Frame_Load_Error
13351     * @li "load,finished": Load finished. Event info is NULL on success, on
13352     * error it's a pointer to Elm_Web_Frame_Load_Error
13353     * @li "load,newwindow,show": A new window was created and is ready to be
13354     * shown
13355     * @li "load,progress": Overall load progress. Event info is a pointer to
13356     * a double containing a value between 0.0 and 1.0
13357     * @li "load,provisional": Started provisional load
13358     * @li "load,started": Loading of a document started
13359     * @li "menubar,visible,get": Queries if the menubar is visible. Event info
13360     * is a pointer to Eina_Bool where the callback should set EINA_TRUE if
13361     * the menubar is visible, or EINA_FALSE in case it's not
13362     * @li "menubar,visible,set": Informs menubar visibility. Event info is
13363     * an Eina_Bool indicating the visibility
13364     * @li "popup,created": A dropdown widget was activated, requesting its
13365     * popup menu to be created. Event info is a pointer to Elm_Web_Menu
13366     * @li "popup,willdelete": The web object is ready to destroy the popup
13367     * object created. Event info is a pointer to Elm_Web_Menu
13368     * @li "ready": Page is fully loaded
13369     * @li "scrollbars,visible,get": Queries visibility of scrollbars. Event
13370     * info is a pointer to Eina_Bool where the visibility state should be set
13371     * @li "scrollbars,visible,set": Informs scrollbars visibility. Event info
13372     * is an Eina_Bool with the visibility state set
13373     * @li "statusbar,text,set": Text of the statusbar changed. Even info is
13374     * a string with the new text
13375     * @li "statusbar,visible,get": Queries visibility of the status bar.
13376     * Event info is a pointer to Eina_Bool where the visibility state should be
13377     * set.
13378     * @li "statusbar,visible,set": Informs statusbar visibility. Event info is
13379     * an Eina_Bool with the visibility value
13380     * @li "title,changed": Title of the main frame changed. Event info is a
13381     * string with the new title
13382     * @li "toolbars,visible,get": Queries visibility of toolbars. Event info
13383     * is a pointer to Eina_Bool where the visibility state should be set
13384     * @li "toolbars,visible,set": Informs the visibility of toolbars. Event
13385     * info is an Eina_Bool with the visibility state
13386     * @li "tooltip,text,set": Show and set text of a tooltip. Event info is
13387     * a string with the text to show
13388     * @li "uri,changed": URI of the main frame changed. Event info is a string
13389     * with the new URI
13390     * @li "view,resized": The web object internal's view changed sized
13391     * @li "windows,close,request": A JavaScript request to close the current
13392     * window was requested
13393     * @li "zoom,animated,end": Animated zoom finished
13394     *
13395     * available styles:
13396     * - default
13397     *
13398     * An example of use of web:
13399     *
13400     * - @ref web_example_01 TBD
13401     */
13402
13403    /**
13404     * @addtogroup Web
13405     * @{
13406     */
13407
13408    /**
13409     * Structure used to report load errors.
13410     *
13411     * Load errors are reported as signal by elm_web. All the strings are
13412     * temporary references and should @b not be used after the signal
13413     * callback returns. If it's required, make copies with strdup() or
13414     * eina_stringshare_add() (they are not even guaranteed to be
13415     * stringshared, so must use eina_stringshare_add() and not
13416     * eina_stringshare_ref()).
13417     */
13418    typedef struct _Elm_Web_Frame_Load_Error Elm_Web_Frame_Load_Error;
13419    /**
13420     * Structure used to report load errors.
13421     *
13422     * Load errors are reported as signal by elm_web. All the strings are
13423     * temporary references and should @b not be used after the signal
13424     * callback returns. If it's required, make copies with strdup() or
13425     * eina_stringshare_add() (they are not even guaranteed to be
13426     * stringshared, so must use eina_stringshare_add() and not
13427     * eina_stringshare_ref()).
13428     */
13429    struct _Elm_Web_Frame_Load_Error
13430      {
13431         int code; /**< Numeric error code */
13432         Eina_Bool is_cancellation; /**< Error produced by cancelling a request */
13433         const char *domain; /**< Error domain name */
13434         const char *description; /**< Error description (already localized) */
13435         const char *failing_url; /**< The URL that failed to load */
13436         Evas_Object *frame; /**< Frame object that produced the error */
13437      };
13438
13439    /**
13440     * The possibles types that the items in a menu can be
13441     */
13442    typedef enum _Elm_Web_Menu_Item_Type
13443      {
13444         ELM_WEB_MENU_SEPARATOR,
13445         ELM_WEB_MENU_GROUP,
13446         ELM_WEB_MENU_OPTION
13447      } Elm_Web_Menu_Item_Type;
13448
13449    /**
13450     * Structure describing the items in a menu
13451     */
13452    typedef struct _Elm_Web_Menu_Item Elm_Web_Menu_Item;
13453    /**
13454     * Structure describing the items in a menu
13455     */
13456    struct _Elm_Web_Menu_Item
13457      {
13458         const char *text; /**< The text for the item */
13459         Elm_Web_Menu_Item_Type type; /**< The type of the item */
13460      };
13461
13462    /**
13463     * Structure describing the menu of a popup
13464     *
13465     * This structure will be passed as the @c event_info for the "popup,create"
13466     * signal, which is emitted when a dropdown menu is opened. Users wanting
13467     * to handle these popups by themselves should listen to this signal and
13468     * set the @c handled property of the struct to @c EINA_TRUE. Leaving this
13469     * property as @c EINA_FALSE means that the user will not handle the popup
13470     * and the default implementation will be used.
13471     *
13472     * When the popup is ready to be dismissed, a "popup,willdelete" signal
13473     * will be emitted to notify the user that it can destroy any objects and
13474     * free all data related to it.
13475     *
13476     * @see elm_web_popup_selected_set()
13477     * @see elm_web_popup_destroy()
13478     */
13479    typedef struct _Elm_Web_Menu Elm_Web_Menu;
13480    /**
13481     * Structure describing the menu of a popup
13482     *
13483     * This structure will be passed as the @c event_info for the "popup,create"
13484     * signal, which is emitted when a dropdown menu is opened. Users wanting
13485     * to handle these popups by themselves should listen to this signal and
13486     * set the @c handled property of the struct to @c EINA_TRUE. Leaving this
13487     * property as @c EINA_FALSE means that the user will not handle the popup
13488     * and the default implementation will be used.
13489     *
13490     * When the popup is ready to be dismissed, a "popup,willdelete" signal
13491     * will be emitted to notify the user that it can destroy any objects and
13492     * free all data related to it.
13493     *
13494     * @see elm_web_popup_selected_set()
13495     * @see elm_web_popup_destroy()
13496     */
13497    struct _Elm_Web_Menu
13498      {
13499         Eina_List *items; /**< List of #Elm_Web_Menu_Item */
13500         int x; /**< The X position of the popup, relative to the elm_web object */
13501         int y; /**< The Y position of the popup, relative to the elm_web object */
13502         int width; /**< Width of the popup menu */
13503         int height; /**< Height of the popup menu */
13504
13505         Eina_Bool handled : 1; /**< Set to @c EINA_TRUE by the user to indicate that the popup has been handled and the default implementation should be ignored. Leave as @c EINA_FALSE otherwise. */
13506      };
13507
13508    typedef struct _Elm_Web_Download Elm_Web_Download;
13509    struct _Elm_Web_Download
13510      {
13511         const char *url;
13512      };
13513
13514    /**
13515     * Types of zoom available.
13516     */
13517    typedef enum _Elm_Web_Zoom_Mode
13518      {
13519         ELM_WEB_ZOOM_MODE_MANUAL = 0, /**< Zoom controlled normally by elm_web_zoom_set */
13520         ELM_WEB_ZOOM_MODE_AUTO_FIT, /**< Zoom until content fits in web object */
13521         ELM_WEB_ZOOM_MODE_AUTO_FILL, /**< Zoom until content fills web object */
13522         ELM_WEB_ZOOM_MODE_LAST
13523      } Elm_Web_Zoom_Mode;
13524    /**
13525     * Opaque handler containing the features (such as statusbar, menubar, etc)
13526     * that are to be set on a newly requested window.
13527     */
13528    typedef struct _Elm_Web_Window_Features Elm_Web_Window_Features;
13529    /**
13530     * Callback type for the create_window hook.
13531     *
13532     * The function parameters are:
13533     * @li @p data User data pointer set when setting the hook function
13534     * @li @p obj The elm_web object requesting the new window
13535     * @li @p js Set to @c EINA_TRUE if the request was originated from
13536     * JavaScript. @c EINA_FALSE otherwise.
13537     * @li @p window_features A pointer of #Elm_Web_Window_Features indicating
13538     * the features requested for the new window.
13539     *
13540     * The returned value of the function should be the @c elm_web widget where
13541     * the request will be loaded. That is, if a new window or tab is created,
13542     * the elm_web widget in it should be returned, and @b NOT the window
13543     * object.
13544     * Returning @c NULL should cancel the request.
13545     *
13546     * @see elm_web_window_create_hook_set()
13547     */
13548    typedef Evas_Object *(*Elm_Web_Window_Open)(void *data, Evas_Object *obj, Eina_Bool js, const Elm_Web_Window_Features *window_features);
13549    /**
13550     * Callback type for the JS alert hook.
13551     *
13552     * The function parameters are:
13553     * @li @p data User data pointer set when setting the hook function
13554     * @li @p obj The elm_web object requesting the new window
13555     * @li @p message The message to show in the alert dialog
13556     *
13557     * The function should return the object representing the alert dialog.
13558     * Elm_Web will run a second main loop to handle the dialog and normal
13559     * flow of the application will be restored when the object is deleted, so
13560     * the user should handle the popup properly in order to delete the object
13561     * when the action is finished.
13562     * If the function returns @c NULL the popup will be ignored.
13563     *
13564     * @see elm_web_dialog_alert_hook_set()
13565     */
13566    typedef Evas_Object *(*Elm_Web_Dialog_Alert)(void *data, Evas_Object *obj, const char *message);
13567    /**
13568     * Callback type for the JS confirm hook.
13569     *
13570     * The function parameters are:
13571     * @li @p data User data pointer set when setting the hook function
13572     * @li @p obj The elm_web object requesting the new window
13573     * @li @p message The message to show in the confirm dialog
13574     * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13575     * the user selected @c Ok, @c EINA_FALSE otherwise.
13576     *
13577     * The function should return the object representing the confirm dialog.
13578     * Elm_Web will run a second main loop to handle the dialog and normal
13579     * flow of the application will be restored when the object is deleted, so
13580     * the user should handle the popup properly in order to delete the object
13581     * when the action is finished.
13582     * If the function returns @c NULL the popup will be ignored.
13583     *
13584     * @see elm_web_dialog_confirm_hook_set()
13585     */
13586    typedef Evas_Object *(*Elm_Web_Dialog_Confirm)(void *data, Evas_Object *obj, const char *message, Eina_Bool *ret);
13587    /**
13588     * Callback type for the JS prompt hook.
13589     *
13590     * The function parameters are:
13591     * @li @p data User data pointer set when setting the hook function
13592     * @li @p obj The elm_web object requesting the new window
13593     * @li @p message The message to show in the prompt dialog
13594     * @li @p def_value The default value to present the user in the entry
13595     * @li @p value Pointer where to store the value given by the user. Must
13596     * be a malloc'ed string or @c NULL if the user cancelled the popup.
13597     * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13598     * the user selected @c Ok, @c EINA_FALSE otherwise.
13599     *
13600     * The function should return the object representing the prompt dialog.
13601     * Elm_Web will run a second main loop to handle the dialog and normal
13602     * flow of the application will be restored when the object is deleted, so
13603     * the user should handle the popup properly in order to delete the object
13604     * when the action is finished.
13605     * If the function returns @c NULL the popup will be ignored.
13606     *
13607     * @see elm_web_dialog_prompt_hook_set()
13608     */
13609    typedef Evas_Object *(*Elm_Web_Dialog_Prompt)(void *data, Evas_Object *obj, const char *message, const char *def_value, char **value, Eina_Bool *ret);
13610    /**
13611     * Callback type for the JS file selector hook.
13612     *
13613     * The function parameters are:
13614     * @li @p data User data pointer set when setting the hook function
13615     * @li @p obj The elm_web object requesting the new window
13616     * @li @p allows_multiple @c EINA_TRUE if multiple files can be selected.
13617     * @li @p accept_types Mime types accepted
13618     * @li @p selected Pointer where to store the list of malloc'ed strings
13619     * containing the path to each file selected. Must be @c NULL if the file
13620     * dialog is cancelled
13621     * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13622     * the user selected @c Ok, @c EINA_FALSE otherwise.
13623     *
13624     * The function should return the object representing the file selector
13625     * dialog.
13626     * Elm_Web will run a second main loop to handle the dialog and normal
13627     * flow of the application will be restored when the object is deleted, so
13628     * the user should handle the popup properly in order to delete the object
13629     * when the action is finished.
13630     * If the function returns @c NULL the popup will be ignored.
13631     *
13632     * @see elm_web_dialog_file selector_hook_set()
13633     */
13634    typedef Evas_Object *(*Elm_Web_Dialog_File_Selector)(void *data, Evas_Object *obj, Eina_Bool allows_multiple, Eina_List *accept_types, Eina_List **selected, Eina_Bool *ret);
13635    /**
13636     * Callback type for the JS console message hook.
13637     *
13638     * When a console message is added from JavaScript, any set function to the
13639     * console message hook will be called for the user to handle. There is no
13640     * default implementation of this hook.
13641     *
13642     * The function parameters are:
13643     * @li @p data User data pointer set when setting the hook function
13644     * @li @p obj The elm_web object that originated the message
13645     * @li @p message The message sent
13646     * @li @p line_number The line number
13647     * @li @p source_id Source id
13648     *
13649     * @see elm_web_console_message_hook_set()
13650     */
13651    typedef void (*Elm_Web_Console_Message)(void *data, Evas_Object *obj, const char *message, unsigned int line_number, const char *source_id);
13652    /**
13653     * Add a new web object to the parent.
13654     *
13655     * @param parent The parent object.
13656     * @return The new object or NULL if it cannot be created.
13657     *
13658     * @see elm_web_uri_set()
13659     * @see elm_web_webkit_view_get()
13660     */
13661    EAPI Evas_Object                 *elm_web_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13662
13663    /**
13664     * Get internal ewk_view object from web object.
13665     *
13666     * Elementary may not provide some low level features of EWebKit,
13667     * instead of cluttering the API with proxy methods we opted to
13668     * return the internal reference. Be careful using it as it may
13669     * interfere with elm_web behavior.
13670     *
13671     * @param obj The web object.
13672     * @return The internal ewk_view object or NULL if it does not
13673     *         exist. (Failure to create or Elementary compiled without
13674     *         ewebkit)
13675     *
13676     * @see elm_web_add()
13677     */
13678    EAPI Evas_Object                 *elm_web_webkit_view_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13679
13680    /**
13681     * Sets the function to call when a new window is requested
13682     *
13683     * This hook will be called when a request to create a new window is
13684     * issued from the web page loaded.
13685     * There is no default implementation for this feature, so leaving this
13686     * unset or passing @c NULL in @p func will prevent new windows from
13687     * opening.
13688     *
13689     * @param obj The web object where to set the hook function
13690     * @param func The hook function to be called when a window is requested
13691     * @param data User data
13692     */
13693    EAPI void                         elm_web_window_create_hook_set(Evas_Object *obj, Elm_Web_Window_Open func, void *data);
13694    /**
13695     * Sets the function to call when an alert dialog
13696     *
13697     * This hook will be called when a JavaScript alert dialog is requested.
13698     * If no function is set or @c NULL is passed in @p func, the default
13699     * implementation will take place.
13700     *
13701     * @param obj The web object where to set the hook function
13702     * @param func The callback function to be used
13703     * @param data User data
13704     *
13705     * @see elm_web_inwin_mode_set()
13706     */
13707    EAPI void                         elm_web_dialog_alert_hook_set(Evas_Object *obj, Elm_Web_Dialog_Alert func, void *data);
13708    /**
13709     * Sets the function to call when an confirm dialog
13710     *
13711     * This hook will be called when a JavaScript confirm dialog is requested.
13712     * If no function is set or @c NULL is passed in @p func, the default
13713     * implementation will take place.
13714     *
13715     * @param obj The web object where to set the hook function
13716     * @param func The callback function to be used
13717     * @param data User data
13718     *
13719     * @see elm_web_inwin_mode_set()
13720     */
13721    EAPI void                         elm_web_dialog_confirm_hook_set(Evas_Object *obj, Elm_Web_Dialog_Confirm func, void *data);
13722    /**
13723     * Sets the function to call when an prompt dialog
13724     *
13725     * This hook will be called when a JavaScript prompt dialog is requested.
13726     * If no function is set or @c NULL is passed in @p func, the default
13727     * implementation will take place.
13728     *
13729     * @param obj The web object where to set the hook function
13730     * @param func The callback function to be used
13731     * @param data User data
13732     *
13733     * @see elm_web_inwin_mode_set()
13734     */
13735    EAPI void                         elm_web_dialog_prompt_hook_set(Evas_Object *obj, Elm_Web_Dialog_Prompt func, void *data);
13736    /**
13737     * Sets the function to call when an file selector dialog
13738     *
13739     * This hook will be called when a JavaScript file selector dialog is
13740     * requested.
13741     * If no function is set or @c NULL is passed in @p func, the default
13742     * implementation will take place.
13743     *
13744     * @param obj The web object where to set the hook function
13745     * @param func The callback function to be used
13746     * @param data User data
13747     *
13748     * @see elm_web_inwin_mode_set()
13749     */
13750    EAPI void                         elm_web_dialog_file_selector_hook_set(Evas_Object *obj, Elm_Web_Dialog_File_Selector func, void *data);
13751    /**
13752     * Sets the function to call when a console message is emitted from JS
13753     *
13754     * This hook will be called when a console message is emitted from
13755     * JavaScript. There is no default implementation for this feature.
13756     *
13757     * @param obj The web object where to set the hook function
13758     * @param func The callback function to be used
13759     * @param data User data
13760     */
13761    EAPI void                         elm_web_console_message_hook_set(Evas_Object *obj, Elm_Web_Console_Message func, void *data);
13762    /**
13763     * Gets the status of the tab propagation
13764     *
13765     * @param obj The web object to query
13766     * @return EINA_TRUE if tab propagation is enabled, EINA_FALSE otherwise
13767     *
13768     * @see elm_web_tab_propagate_set()
13769     */
13770    EAPI Eina_Bool                    elm_web_tab_propagate_get(const Evas_Object *obj);
13771    /**
13772     * Sets whether to use tab propagation
13773     *
13774     * If tab propagation is enabled, whenever the user presses the Tab key,
13775     * Elementary will handle it and switch focus to the next widget.
13776     * The default value is disabled, where WebKit will handle the Tab key to
13777     * cycle focus though its internal objects, jumping to the next widget
13778     * only when that cycle ends.
13779     *
13780     * @param obj The web object
13781     * @param propagate Whether to propagate Tab keys to Elementary or not
13782     */
13783    EAPI void                         elm_web_tab_propagate_set(Evas_Object *obj, Eina_Bool propagate);
13784    /**
13785     * Sets the URI for the web object
13786     *
13787     * It must be a full URI, with resource included, in the form
13788     * http://www.enlightenment.org or file:///tmp/something.html
13789     *
13790     * @param obj The web object
13791     * @param uri The URI to set
13792     * @return EINA_TRUE if the URI could be, EINA_FALSE if an error occurred
13793     */
13794    EAPI Eina_Bool                    elm_web_uri_set(Evas_Object *obj, const char *uri);
13795    /**
13796     * Gets the current URI for the object
13797     *
13798     * The returned string must not be freed and is guaranteed to be
13799     * stringshared.
13800     *
13801     * @param obj The web object
13802     * @return A stringshared internal string with the current URI, or NULL on
13803     * failure
13804     */
13805    EAPI const char                  *elm_web_uri_get(const Evas_Object *obj);
13806    /**
13807     * Gets the current title
13808     *
13809     * The returned string must not be freed and is guaranteed to be
13810     * stringshared.
13811     *
13812     * @param obj The web object
13813     * @return A stringshared internal string with the current title, or NULL on
13814     * failure
13815     */
13816    EAPI const char                  *elm_web_title_get(const Evas_Object *obj);
13817    /**
13818     * Sets the background color to be used by the web object
13819     *
13820     * This is the color that will be used by default when the loaded page
13821     * does not set it's own. Color values are pre-multiplied.
13822     *
13823     * @param obj The web object
13824     * @param r Red component
13825     * @param g Green component
13826     * @param b Blue component
13827     * @param a Alpha component
13828     */
13829    EAPI void                         elm_web_bg_color_set(Evas_Object *obj, int r, int g, int b, int a);
13830    /**
13831     * Gets the background color to be used by the web object
13832     *
13833     * This is the color that will be used by default when the loaded page
13834     * does not set it's own. Color values are pre-multiplied.
13835     *
13836     * @param obj The web object
13837     * @param r Red component
13838     * @param g Green component
13839     * @param b Blue component
13840     * @param a Alpha component
13841     */
13842    EAPI void                         elm_web_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b, int *a);
13843    /**
13844     * Gets a copy of the currently selected text
13845     *
13846     * The string returned must be freed by the user when it's done with it.
13847     *
13848     * @param obj The web object
13849     * @return A newly allocated string, or NULL if nothing is selected or an
13850     * error occurred
13851     */
13852    EAPI char                        *elm_view_selection_get(const Evas_Object *obj);
13853    /**
13854     * Tells the web object which index in the currently open popup was selected
13855     *
13856     * When the user handles the popup creation from the "popup,created" signal,
13857     * it needs to tell the web object which item was selected by calling this
13858     * function with the index corresponding to the item.
13859     *
13860     * @param obj The web object
13861     * @param index The index selected
13862     *
13863     * @see elm_web_popup_destroy()
13864     */
13865    EAPI void                         elm_web_popup_selected_set(Evas_Object *obj, int index);
13866    /**
13867     * Dismisses an open dropdown popup
13868     *
13869     * When the popup from a dropdown widget is to be dismissed, either after
13870     * selecting an option or to cancel it, this function must be called, which
13871     * will later emit an "popup,willdelete" signal to notify the user that
13872     * any memory and objects related to this popup can be freed.
13873     *
13874     * @param obj The web object
13875     * @return EINA_TRUE if the menu was successfully destroyed, or EINA_FALSE
13876     * if there was no menu to destroy
13877     */
13878    EAPI Eina_Bool                    elm_web_popup_destroy(Evas_Object *obj);
13879    /**
13880     * Searches the given string in a document.
13881     *
13882     * @param obj The web object where to search the text
13883     * @param string String to search
13884     * @param case_sensitive If search should be case sensitive or not
13885     * @param forward If search is from cursor and on or backwards
13886     * @param wrap If search should wrap at the end
13887     *
13888     * @return @c EINA_TRUE if the given string was found, @c EINA_FALSE if not
13889     * or failure
13890     */
13891    EAPI Eina_Bool                    elm_web_text_search(const Evas_Object *obj, const char *string, Eina_Bool case_sensitive, Eina_Bool forward, Eina_Bool wrap);
13892    /**
13893     * Marks matches of the given string in a document.
13894     *
13895     * @param obj The web object where to search text
13896     * @param string String to match
13897     * @param case_sensitive If match should be case sensitive or not
13898     * @param highlight If matches should be highlighted
13899     * @param limit Maximum amount of matches, or zero to unlimited
13900     *
13901     * @return number of matched @a string
13902     */
13903    EAPI unsigned int                 elm_web_text_matches_mark(Evas_Object *obj, const char *string, Eina_Bool case_sensitive, Eina_Bool highlight, unsigned int limit);
13904    /**
13905     * Clears all marked matches in the document
13906     *
13907     * @param obj The web object
13908     *
13909     * @return EINA_TRUE on success, EINA_FALSE otherwise
13910     */
13911    EAPI Eina_Bool                    elm_web_text_matches_unmark_all(Evas_Object *obj);
13912    /**
13913     * Sets whether to highlight the matched marks
13914     *
13915     * If enabled, marks set with elm_web_text_matches_mark() will be
13916     * highlighted.
13917     *
13918     * @param obj The web object
13919     * @param highlight Whether to highlight the marks or not
13920     *
13921     * @return EINA_TRUE on success, EINA_FALSE otherwise
13922     */
13923    EAPI Eina_Bool                    elm_web_text_matches_highlight_set(Evas_Object *obj, Eina_Bool highlight);
13924    /**
13925     * Gets whether highlighting marks is enabled
13926     *
13927     * @param The web object
13928     *
13929     * @return EINA_TRUE is marks are set to be highlighted, EINA_FALSE
13930     * otherwise
13931     */
13932    EAPI Eina_Bool                    elm_web_text_matches_highlight_get(const Evas_Object *obj);
13933    /**
13934     * Gets the overall loading progress of the page
13935     *
13936     * Returns the estimated loading progress of the page, with a value between
13937     * 0.0 and 1.0. This is an estimated progress accounting for all the frames
13938     * included in the page.
13939     *
13940     * @param The web object
13941     *
13942     * @return A value between 0.0 and 1.0 indicating the progress, or -1.0 on
13943     * failure
13944     */
13945    EAPI double                       elm_web_load_progress_get(const Evas_Object *obj);
13946    /**
13947     * Stops loading the current page
13948     *
13949     * Cancels the loading of the current page in the web object. This will
13950     * cause a "load,error" signal to be emitted, with the is_cancellation
13951     * flag set to EINA_TRUE.
13952     *
13953     * @param obj The web object
13954     *
13955     * @return EINA_TRUE if the cancel was successful, EINA_FALSE otherwise
13956     */
13957    EAPI Eina_Bool                    elm_web_stop(Evas_Object *obj);
13958    /**
13959     * Requests a reload of the current document in the object
13960     *
13961     * @param obj The web object
13962     *
13963     * @return EINA_TRUE on success, EINA_FALSE otherwise
13964     */
13965    EAPI Eina_Bool                    elm_web_reload(Evas_Object *obj);
13966    /**
13967     * Requests a reload of the current document, avoiding any existing caches
13968     *
13969     * @param obj The web object
13970     *
13971     * @return EINA_TRUE on success, EINA_FALSE otherwise
13972     */
13973    EAPI Eina_Bool                    elm_web_reload_full(Evas_Object *obj);
13974    /**
13975     * Goes back one step in the browsing history
13976     *
13977     * This is equivalent to calling elm_web_object_navigate(obj, -1);
13978     *
13979     * @param obj The web object
13980     *
13981     * @return EINA_TRUE on success, EINA_FALSE otherwise
13982     *
13983     * @see elm_web_history_enable_set()
13984     * @see elm_web_back_possible()
13985     * @see elm_web_forward()
13986     * @see elm_web_navigate()
13987     */
13988    EAPI Eina_Bool                    elm_web_back(Evas_Object *obj);
13989    /**
13990     * Goes forward one step in the browsing history
13991     *
13992     * This is equivalent to calling elm_web_object_navigate(obj, 1);
13993     *
13994     * @param obj The web object
13995     *
13996     * @return EINA_TRUE on success, EINA_FALSE otherwise
13997     *
13998     * @see elm_web_history_enable_set()
13999     * @see elm_web_forward_possible()
14000     * @see elm_web_back()
14001     * @see elm_web_navigate()
14002     */
14003    EAPI Eina_Bool                    elm_web_forward(Evas_Object *obj);
14004    /**
14005     * Jumps the given number of steps in the browsing history
14006     *
14007     * The @p steps value can be a negative integer to back in history, or a
14008     * positive to move forward.
14009     *
14010     * @param obj The web object
14011     * @param steps The number of steps to jump
14012     *
14013     * @return EINA_TRUE on success, EINA_FALSE on error or if not enough
14014     * history exists to jump the given number of steps
14015     *
14016     * @see elm_web_history_enable_set()
14017     * @see elm_web_navigate_possible()
14018     * @see elm_web_back()
14019     * @see elm_web_forward()
14020     */
14021    EAPI Eina_Bool                    elm_web_navigate(Evas_Object *obj, int steps);
14022    /**
14023     * Queries whether it's possible to go back in history
14024     *
14025     * @param obj The web object
14026     *
14027     * @return EINA_TRUE if it's possible to back in history, EINA_FALSE
14028     * otherwise
14029     */
14030    EAPI Eina_Bool                    elm_web_back_possible(Evas_Object *obj);
14031    /**
14032     * Queries whether it's possible to go forward in history
14033     *
14034     * @param obj The web object
14035     *
14036     * @return EINA_TRUE if it's possible to forward in history, EINA_FALSE
14037     * otherwise
14038     */
14039    EAPI Eina_Bool                    elm_web_forward_possible(Evas_Object *obj);
14040    /**
14041     * Queries whether it's possible to jump the given number of steps
14042     *
14043     * The @p steps value can be a negative integer to back in history, or a
14044     * positive to move forward.
14045     *
14046     * @param obj The web object
14047     * @param steps The number of steps to check for
14048     *
14049     * @return EINA_TRUE if enough history exists to perform the given jump,
14050     * EINA_FALSE otherwise
14051     */
14052    EAPI Eina_Bool                    elm_web_navigate_possible(Evas_Object *obj, int steps);
14053    /**
14054     * Gets whether browsing history is enabled for the given object
14055     *
14056     * @param obj The web object
14057     *
14058     * @return EINA_TRUE if history is enabled, EINA_FALSE otherwise
14059     */
14060    EAPI Eina_Bool                    elm_web_history_enable_get(const Evas_Object *obj);
14061    /**
14062     * Enables or disables the browsing history
14063     *
14064     * @param obj The web object
14065     * @param enable Whether to enable or disable the browsing history
14066     */
14067    EAPI void                         elm_web_history_enable_set(Evas_Object *obj, Eina_Bool enable);
14068    /**
14069     * Sets the zoom level of the web object
14070     *
14071     * Zoom level matches the Webkit API, so 1.0 means normal zoom, with higher
14072     * values meaning zoom in and lower meaning zoom out. This function will
14073     * only affect the zoom level if the mode set with elm_web_zoom_mode_set()
14074     * is ::ELM_WEB_ZOOM_MODE_MANUAL.
14075     *
14076     * @param obj The web object
14077     * @param zoom The zoom level to set
14078     */
14079    EAPI void                         elm_web_zoom_set(Evas_Object *obj, double zoom);
14080    /**
14081     * Gets the current zoom level set on the web object
14082     *
14083     * Note that this is the zoom level set on the web object and not that
14084     * of the underlying Webkit one. In the ::ELM_WEB_ZOOM_MODE_MANUAL mode,
14085     * the two zoom levels should match, but for the other two modes the
14086     * Webkit zoom is calculated internally to match the chosen mode without
14087     * changing the zoom level set for the web object.
14088     *
14089     * @param obj The web object
14090     *
14091     * @return The zoom level set on the object
14092     */
14093    EAPI double                       elm_web_zoom_get(const Evas_Object *obj);
14094    /**
14095     * Sets the zoom mode to use
14096     *
14097     * The modes can be any of those defined in ::Elm_Web_Zoom_Mode, except
14098     * ::ELM_WEB_ZOOM_MODE_LAST. The default is ::ELM_WEB_ZOOM_MODE_MANUAL.
14099     *
14100     * ::ELM_WEB_ZOOM_MODE_MANUAL means the zoom level will be controlled
14101     * with the elm_web_zoom_set() function.
14102     * ::ELM_WEB_ZOOM_MODE_AUTO_FIT will calculate the needed zoom level to
14103     * make sure the entirety of the web object's contents are shown.
14104     * ::ELM_WEB_ZOOM_MODE_AUTO_FILL will calculate the needed zoom level to
14105     * fit the contents in the web object's size, without leaving any space
14106     * unused.
14107     *
14108     * @param obj The web object
14109     * @param mode The mode to set
14110     */
14111    EAPI void                         elm_web_zoom_mode_set(Evas_Object *obj, Elm_Web_Zoom_Mode mode);
14112    /**
14113     * Gets the currently set zoom mode
14114     *
14115     * @param obj The web object
14116     *
14117     * @return The current zoom mode set for the object, or
14118     * ::ELM_WEB_ZOOM_MODE_LAST on error
14119     */
14120    EAPI Elm_Web_Zoom_Mode            elm_web_zoom_mode_get(const Evas_Object *obj);
14121    /**
14122     * Shows the given region in the web object
14123     *
14124     * @param obj The web object
14125     * @param x The x coordinate of the region to show
14126     * @param y The y coordinate of the region to show
14127     * @param w The width of the region to show
14128     * @param h The height of the region to show
14129     */
14130    EAPI void                         elm_web_region_show(Evas_Object *obj, int x, int y, int w, int h);
14131    /**
14132     * Brings in the region to the visible area
14133     *
14134     * Like elm_web_region_show(), but it animates the scrolling of the object
14135     * to show the area
14136     *
14137     * @param obj The web object
14138     * @param x The x coordinate of the region to show
14139     * @param y The y coordinate of the region to show
14140     * @param w The width of the region to show
14141     * @param h The height of the region to show
14142     */
14143    EAPI void                         elm_web_region_bring_in(Evas_Object *obj, int x, int y, int w, int h);
14144    /**
14145     * Sets the default dialogs to use an Inwin instead of a normal window
14146     *
14147     * If set, then the default implementation for the JavaScript dialogs and
14148     * file selector will be opened in an Inwin. Otherwise they will use a
14149     * normal separated window.
14150     *
14151     * @param obj The web object
14152     * @param value EINA_TRUE to use Inwin, EINA_FALSE to use a normal window
14153     */
14154    EAPI void                         elm_web_inwin_mode_set(Evas_Object *obj, Eina_Bool value);
14155    /**
14156     * Gets whether Inwin mode is set for the current object
14157     *
14158     * @param obj The web object
14159     *
14160     * @return EINA_TRUE if Inwin mode is set, EINA_FALSE otherwise
14161     */
14162    EAPI Eina_Bool                    elm_web_inwin_mode_get(const Evas_Object *obj);
14163
14164    EAPI void                         elm_web_window_features_ref(Elm_Web_Window_Features *wf);
14165    EAPI void                         elm_web_window_features_unref(Elm_Web_Window_Features *wf);
14166    EAPI void                         elm_web_window_features_bool_property_get(const Elm_Web_Window_Features *wf, Eina_Bool *toolbar_visible, Eina_Bool *statusbar_visible, Eina_Bool *scrollbars_visible, Eina_Bool *menubar_visible, Eina_Bool *locationbar_visble, Eina_Bool *fullscreen);
14167    EAPI void                         elm_web_window_features_int_property_get(const Elm_Web_Window_Features *wf, int *x, int *y, int *w, int *h);
14168
14169    /**
14170     * @}
14171     */
14172
14173    /**
14174     * @defgroup Hoversel Hoversel
14175     *
14176     * @image html img/widget/hoversel/preview-00.png
14177     * @image latex img/widget/hoversel/preview-00.eps
14178     *
14179     * A hoversel is a button that pops up a list of items (automatically
14180     * choosing the direction to display) that have a label and, optionally, an
14181     * icon to select from. It is a convenience widget to avoid the need to do
14182     * all the piecing together yourself. It is intended for a small number of
14183     * items in the hoversel menu (no more than 8), though is capable of many
14184     * more.
14185     *
14186     * Signals that you can add callbacks for are:
14187     * "clicked" - the user clicked the hoversel button and popped up the sel
14188     * "selected" - an item in the hoversel list is selected. event_info is the item
14189     * "dismissed" - the hover is dismissed
14190     *
14191     * See @ref tutorial_hoversel for an example.
14192     * @{
14193     */
14194    typedef struct _Elm_Hoversel_Item Elm_Hoversel_Item; /**< Item of Elm_Hoversel. Sub-type of Elm_Widget_Item */
14195    /**
14196     * @brief Add a new Hoversel object
14197     *
14198     * @param parent The parent object
14199     * @return The new object or NULL if it cannot be created
14200     */
14201    EAPI Evas_Object       *elm_hoversel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14202    /**
14203     * @brief This sets the hoversel to expand horizontally.
14204     *
14205     * @param obj The hoversel object
14206     * @param horizontal If true, the hover will expand horizontally to the
14207     * right.
14208     *
14209     * @note The initial button will display horizontally regardless of this
14210     * setting.
14211     */
14212    EAPI void               elm_hoversel_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
14213    /**
14214     * @brief This returns whether the hoversel is set to expand horizontally.
14215     *
14216     * @param obj The hoversel object
14217     * @return If true, the hover will expand horizontally to the right.
14218     *
14219     * @see elm_hoversel_horizontal_set()
14220     */
14221    EAPI Eina_Bool          elm_hoversel_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14222    /**
14223     * @brief Set the Hover parent
14224     *
14225     * @param obj The hoversel object
14226     * @param parent The parent to use
14227     *
14228     * Sets the hover parent object, the area that will be darkened when the
14229     * hoversel is clicked. Should probably be the window that the hoversel is
14230     * in. See @ref Hover objects for more information.
14231     */
14232    EAPI void               elm_hoversel_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
14233    /**
14234     * @brief Get the Hover parent
14235     *
14236     * @param obj The hoversel object
14237     * @return The used parent
14238     *
14239     * Gets the hover parent object.
14240     *
14241     * @see elm_hoversel_hover_parent_set()
14242     */
14243    EAPI Evas_Object       *elm_hoversel_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14244    /**
14245     * @brief Set the hoversel button label
14246     *
14247     * @param obj The hoversel object
14248     * @param label The label text.
14249     *
14250     * This sets the label of the button that is always visible (before it is
14251     * clicked and expanded).
14252     *
14253     * @deprecated elm_object_text_set()
14254     */
14255    EINA_DEPRECATED EAPI void               elm_hoversel_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
14256    /**
14257     * @brief Get the hoversel button label
14258     *
14259     * @param obj The hoversel object
14260     * @return The label text.
14261     *
14262     * @deprecated elm_object_text_get()
14263     */
14264    EINA_DEPRECATED EAPI const char        *elm_hoversel_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14265    /**
14266     * @brief Set the icon of the hoversel button
14267     *
14268     * @param obj The hoversel object
14269     * @param icon The icon object
14270     *
14271     * Sets the icon of the button that is always visible (before it is clicked
14272     * and expanded).  Once the icon object is set, a previously set one will be
14273     * deleted, if you want to keep that old content object, use the
14274     * elm_hoversel_icon_unset() function.
14275     *
14276     * @see elm_object_content_set() for the button widget
14277     */
14278    EAPI void               elm_hoversel_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
14279    /**
14280     * @brief Get the icon of the hoversel button
14281     *
14282     * @param obj The hoversel object
14283     * @return The icon object
14284     *
14285     * Get the icon of the button that is always visible (before it is clicked
14286     * and expanded). Also see elm_object_content_get() for the button widget.
14287     *
14288     * @see elm_hoversel_icon_set()
14289     */
14290    EAPI Evas_Object       *elm_hoversel_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14291    /**
14292     * @brief Get and unparent the icon of the hoversel button
14293     *
14294     * @param obj The hoversel object
14295     * @return The icon object that was being used
14296     *
14297     * Unparent and return the icon of the button that is always visible
14298     * (before it is clicked and expanded).
14299     *
14300     * @see elm_hoversel_icon_set()
14301     * @see elm_object_content_unset() for the button widget
14302     */
14303    EAPI Evas_Object       *elm_hoversel_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
14304    /**
14305     * @brief This triggers the hoversel popup from code, the same as if the user
14306     * had clicked the button.
14307     *
14308     * @param obj The hoversel object
14309     */
14310    EAPI void               elm_hoversel_hover_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
14311    /**
14312     * @brief This dismisses the hoversel popup as if the user had clicked
14313     * outside the hover.
14314     *
14315     * @param obj The hoversel object
14316     */
14317    EAPI void               elm_hoversel_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
14318    /**
14319     * @brief Returns whether the hoversel is expanded.
14320     *
14321     * @param obj The hoversel object
14322     * @return  This will return EINA_TRUE if the hoversel is expanded or
14323     * EINA_FALSE if it is not expanded.
14324     */
14325    EAPI Eina_Bool          elm_hoversel_expanded_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14326    /**
14327     * @brief This will remove all the children items from the hoversel.
14328     *
14329     * @param obj The hoversel object
14330     *
14331     * @warning Should @b not be called while the hoversel is active; use
14332     * elm_hoversel_expanded_get() to check first.
14333     *
14334     * @see elm_hoversel_item_del_cb_set()
14335     * @see elm_hoversel_item_del()
14336     */
14337    EAPI void               elm_hoversel_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
14338    /**
14339     * @brief Get the list of items within the given hoversel.
14340     *
14341     * @param obj The hoversel object
14342     * @return Returns a list of Elm_Hoversel_Item*
14343     *
14344     * @see elm_hoversel_item_add()
14345     */
14346    EAPI const Eina_List   *elm_hoversel_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14347    /**
14348     * @brief Add an item to the hoversel button
14349     *
14350     * @param obj The hoversel object
14351     * @param label The text label to use for the item (NULL if not desired)
14352     * @param icon_file An image file path on disk to use for the icon or standard
14353     * icon name (NULL if not desired)
14354     * @param icon_type The icon type if relevant
14355     * @param func Convenience function to call when this item is selected
14356     * @param data Data to pass to item-related functions
14357     * @return A handle to the item added.
14358     *
14359     * This adds an item to the hoversel to show when it is clicked. Note: if you
14360     * need to use an icon from an edje file then use
14361     * elm_hoversel_item_icon_set() right after the this function, and set
14362     * icon_file to NULL here.
14363     *
14364     * For more information on what @p icon_file and @p icon_type are see the
14365     * @ref Icon "icon documentation".
14366     */
14367    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);
14368    /**
14369     * @brief Delete an item from the hoversel
14370     *
14371     * @param item The item to delete
14372     *
14373     * This deletes the item from the hoversel (should not be called while the
14374     * hoversel is active; use elm_hoversel_expanded_get() to check first).
14375     *
14376     * @see elm_hoversel_item_add()
14377     * @see elm_hoversel_item_del_cb_set()
14378     */
14379    EAPI void               elm_hoversel_item_del(Elm_Hoversel_Item *item) EINA_ARG_NONNULL(1);
14380    /**
14381     * @brief Set the function to be called when an item from the hoversel is
14382     * freed.
14383     *
14384     * @param item The item to set the callback on
14385     * @param func The function called
14386     *
14387     * That function will receive these parameters:
14388     * @li void *item_data
14389     * @li Evas_Object *the_item_object
14390     * @li Elm_Hoversel_Item *the_object_struct
14391     *
14392     * @see elm_hoversel_item_add()
14393     */
14394    EAPI void               elm_hoversel_item_del_cb_set(Elm_Hoversel_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
14395    /**
14396     * @brief This returns the data pointer supplied with elm_hoversel_item_add()
14397     * that will be passed to associated function callbacks.
14398     *
14399     * @param item The item to get the data from
14400     * @return The data pointer set with elm_hoversel_item_add()
14401     *
14402     * @see elm_hoversel_item_add()
14403     */
14404    EAPI void              *elm_hoversel_item_data_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
14405    /**
14406     * @brief This returns the label text of the given hoversel item.
14407     *
14408     * @param item The item to get the label
14409     * @return The label text of the hoversel item
14410     *
14411     * @see elm_hoversel_item_add()
14412     */
14413    EAPI const char        *elm_hoversel_item_label_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
14414    /**
14415     * @brief This sets the icon for the given hoversel item.
14416     *
14417     * @param item The item to set the icon
14418     * @param icon_file An image file path on disk to use for the icon or standard
14419     * icon name
14420     * @param icon_group The edje group to use if @p icon_file is an edje file. Set this
14421     * to NULL if the icon is not an edje file
14422     * @param icon_type The icon type
14423     *
14424     * The icon can be loaded from the standard set, from an image file, or from
14425     * an edje file.
14426     *
14427     * @see elm_hoversel_item_add()
14428     */
14429    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);
14430    /**
14431     * @brief Get the icon object of the hoversel item
14432     *
14433     * @param item The item to get the icon from
14434     * @param icon_file The image file path on disk used for the icon or standard
14435     * icon name
14436     * @param icon_group The edje group used if @p icon_file is an edje file. NULL
14437     * if the icon is not an edje file
14438     * @param icon_type The icon type
14439     *
14440     * @see elm_hoversel_item_icon_set()
14441     * @see elm_hoversel_item_add()
14442     */
14443    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);
14444    /**
14445     * @}
14446     */
14447
14448    /**
14449     * @defgroup Toolbar Toolbar
14450     * @ingroup Elementary
14451     *
14452     * @image html img/widget/toolbar/preview-00.png
14453     * @image latex img/widget/toolbar/preview-00.eps width=\textwidth
14454     *
14455     * @image html img/toolbar.png
14456     * @image latex img/toolbar.eps width=\textwidth
14457     *
14458     * A toolbar is a widget that displays a list of items inside
14459     * a box. It can be scrollable, show a menu with items that don't fit
14460     * to toolbar size or even crop them.
14461     *
14462     * Only one item can be selected at a time.
14463     *
14464     * Items can have multiple states, or show menus when selected by the user.
14465     *
14466     * Smart callbacks one can listen to:
14467     * - "clicked" - when the user clicks on a toolbar item and becomes selected.
14468     * - "language,changed" - when the program language changes
14469     *
14470     * Available styles for it:
14471     * - @c "default"
14472     * - @c "transparent" - no background or shadow, just show the content
14473     *
14474     * List of examples:
14475     * @li @ref toolbar_example_01
14476     * @li @ref toolbar_example_02
14477     * @li @ref toolbar_example_03
14478     */
14479
14480    /**
14481     * @addtogroup Toolbar
14482     * @{
14483     */
14484
14485    /**
14486     * @enum _Elm_Toolbar_Shrink_Mode
14487     * @typedef Elm_Toolbar_Shrink_Mode
14488     *
14489     * Set toolbar's items display behavior, it can be scrollabel,
14490     * show a menu with exceeding items, or simply hide them.
14491     *
14492     * @note Default value is #ELM_TOOLBAR_SHRINK_MENU. It reads value
14493     * from elm config.
14494     *
14495     * Values <b> don't </b> work as bitmask, only one can be choosen.
14496     *
14497     * @see elm_toolbar_mode_shrink_set()
14498     * @see elm_toolbar_mode_shrink_get()
14499     *
14500     * @ingroup Toolbar
14501     */
14502    typedef enum _Elm_Toolbar_Shrink_Mode
14503      {
14504         ELM_TOOLBAR_SHRINK_NONE,   /**< Set toolbar minimun size to fit all the items. */
14505         ELM_TOOLBAR_SHRINK_HIDE,   /**< Hide exceeding items. */
14506         ELM_TOOLBAR_SHRINK_SCROLL, /**< Allow accessing exceeding items through a scroller. */
14507         ELM_TOOLBAR_SHRINK_MENU,   /**< Inserts a button to pop up a menu with exceeding items. */
14508         ELM_TOOLBAR_SHRINK_LAST    /**< Indicates error if returned by elm_toolbar_shrink_mode_get() */
14509      } Elm_Toolbar_Shrink_Mode;
14510
14511    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(). */
14512
14513    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(). */
14514
14515    /**
14516     * Add a new toolbar widget to the given parent Elementary
14517     * (container) object.
14518     *
14519     * @param parent The parent object.
14520     * @return a new toolbar widget handle or @c NULL, on errors.
14521     *
14522     * This function inserts a new toolbar widget on the canvas.
14523     *
14524     * @ingroup Toolbar
14525     */
14526    EAPI Evas_Object            *elm_toolbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14527
14528    /**
14529     * Set the icon size, in pixels, to be used by toolbar items.
14530     *
14531     * @param obj The toolbar object
14532     * @param icon_size The icon size in pixels
14533     *
14534     * @note Default value is @c 32. It reads value from elm config.
14535     *
14536     * @see elm_toolbar_icon_size_get()
14537     *
14538     * @ingroup Toolbar
14539     */
14540    EAPI void                    elm_toolbar_icon_size_set(Evas_Object *obj, int icon_size) EINA_ARG_NONNULL(1);
14541
14542    /**
14543     * Get the icon size, in pixels, to be used by toolbar items.
14544     *
14545     * @param obj The toolbar object.
14546     * @return The icon size in pixels.
14547     *
14548     * @see elm_toolbar_icon_size_set() for details.
14549     *
14550     * @ingroup Toolbar
14551     */
14552    EAPI int                     elm_toolbar_icon_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14553
14554    /**
14555     * Sets icon lookup order, for toolbar items' icons.
14556     *
14557     * @param obj The toolbar object.
14558     * @param order The icon lookup order.
14559     *
14560     * Icons added before calling this function will not be affected.
14561     * The default lookup order is #ELM_ICON_LOOKUP_THEME_FDO.
14562     *
14563     * @see elm_toolbar_icon_order_lookup_get()
14564     *
14565     * @ingroup Toolbar
14566     */
14567    EAPI void                    elm_toolbar_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
14568
14569    /**
14570     * Gets the icon lookup order.
14571     *
14572     * @param obj The toolbar object.
14573     * @return The icon lookup order.
14574     *
14575     * @see elm_toolbar_icon_order_lookup_set() for details.
14576     *
14577     * @ingroup Toolbar
14578     */
14579    EAPI Elm_Icon_Lookup_Order   elm_toolbar_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14580
14581    /**
14582     * Set whether the toolbar should always have an item selected.
14583     *
14584     * @param obj The toolbar object.
14585     * @param wrap @c EINA_TRUE to enable always-select mode or @c EINA_FALSE to
14586     * disable it.
14587     *
14588     * This will cause the toolbar to always have an item selected, and clicking
14589     * the selected item will not cause a selected event to be emitted. Enabling this mode
14590     * will immediately select the first toolbar item.
14591     *
14592     * Always-selected is disabled by default.
14593     *
14594     * @see elm_toolbar_always_select_mode_get().
14595     *
14596     * @ingroup Toolbar
14597     */
14598    EAPI void                    elm_toolbar_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
14599
14600    /**
14601     * Get whether the toolbar should always have an item selected.
14602     *
14603     * @param obj The toolbar object.
14604     * @return @c EINA_TRUE means an item will always be selected, @c EINA_FALSE indicates
14605     * that it is possible to have no items selected. If @p obj is @c NULL, @c EINA_FALSE is returned.
14606     *
14607     * @see elm_toolbar_always_select_mode_set() for details.
14608     *
14609     * @ingroup Toolbar
14610     */
14611    EAPI Eina_Bool               elm_toolbar_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14612
14613    /**
14614     * Set whether the toolbar items' should be selected by the user or not.
14615     *
14616     * @param obj The toolbar object.
14617     * @param wrap @c EINA_TRUE to disable selection or @c EINA_FALSE to
14618     * enable it.
14619     *
14620     * This will turn off the ability to select items entirely and they will
14621     * neither appear selected nor emit selected signals. The clicked
14622     * callback function will still be called.
14623     *
14624     * Selection is enabled by default.
14625     *
14626     * @see elm_toolbar_no_select_mode_get().
14627     *
14628     * @ingroup Toolbar
14629     */
14630    EAPI void                    elm_toolbar_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
14631
14632    /**
14633     * Set whether the toolbar items' should be selected by the user or not.
14634     *
14635     * @param obj The toolbar object.
14636     * @return @c EINA_TRUE means items can be selected. @c EINA_FALSE indicates
14637     * they can't. If @p obj is @c NULL, @c EINA_FALSE is returned.
14638     *
14639     * @see elm_toolbar_no_select_mode_set() for details.
14640     *
14641     * @ingroup Toolbar
14642     */
14643    EAPI Eina_Bool               elm_toolbar_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14644
14645    /**
14646     * Append item to the toolbar.
14647     *
14648     * @param obj The toolbar object.
14649     * @param icon A string with icon name or the absolute path of an image file.
14650     * @param label The label of the item.
14651     * @param func The function to call when the item is clicked.
14652     * @param data The data to associate with the item for related callbacks.
14653     * @return The created item or @c NULL upon failure.
14654     *
14655     * A new item will be created and appended to the toolbar, i.e., will
14656     * be set as @b last item.
14657     *
14658     * Items created with this method can be deleted with
14659     * elm_toolbar_item_del().
14660     *
14661     * Associated @p data can be properly freed when item is deleted if a
14662     * callback function is set with elm_toolbar_item_del_cb_set().
14663     *
14664     * If a function is passed as argument, it will be called everytime this item
14665     * is selected, i.e., the user clicks over an unselected item.
14666     * If such function isn't needed, just passing
14667     * @c NULL as @p func is enough. The same should be done for @p data.
14668     *
14669     * Toolbar will load icon image from fdo or current theme.
14670     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14671     * If an absolute path is provided it will load it direct from a file.
14672     *
14673     * @see elm_toolbar_item_icon_set()
14674     * @see elm_toolbar_item_del()
14675     * @see elm_toolbar_item_del_cb_set()
14676     *
14677     * @ingroup Toolbar
14678     */
14679    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);
14680
14681    /**
14682     * Prepend item to the toolbar.
14683     *
14684     * @param obj The toolbar object.
14685     * @param icon A string with icon name or the absolute path of an image file.
14686     * @param label The label of the item.
14687     * @param func The function to call when the item is clicked.
14688     * @param data The data to associate with the item for related callbacks.
14689     * @return The created item or @c NULL upon failure.
14690     *
14691     * A new item will be created and prepended to the toolbar, i.e., will
14692     * be set as @b first item.
14693     *
14694     * Items created with this method can be deleted with
14695     * elm_toolbar_item_del().
14696     *
14697     * Associated @p data can be properly freed when item is deleted if a
14698     * callback function is set with elm_toolbar_item_del_cb_set().
14699     *
14700     * If a function is passed as argument, it will be called everytime this item
14701     * is selected, i.e., the user clicks over an unselected item.
14702     * If such function isn't needed, just passing
14703     * @c NULL as @p func is enough. The same should be done for @p data.
14704     *
14705     * Toolbar will load icon image from fdo or current theme.
14706     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14707     * If an absolute path is provided it will load it direct from a file.
14708     *
14709     * @see elm_toolbar_item_icon_set()
14710     * @see elm_toolbar_item_del()
14711     * @see elm_toolbar_item_del_cb_set()
14712     *
14713     * @ingroup Toolbar
14714     */
14715    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);
14716
14717    /**
14718     * Insert a new item into the toolbar object before item @p before.
14719     *
14720     * @param obj The toolbar object.
14721     * @param before The toolbar item to insert before.
14722     * @param icon A string with icon name or the absolute path of an image file.
14723     * @param label The label of the item.
14724     * @param func The function to call when the item is clicked.
14725     * @param data The data to associate with the item for related callbacks.
14726     * @return The created item or @c NULL upon failure.
14727     *
14728     * A new item will be created and added to the toolbar. Its position in
14729     * this toolbar will be just before item @p before.
14730     *
14731     * Items created with this method can be deleted with
14732     * elm_toolbar_item_del().
14733     *
14734     * Associated @p data can be properly freed when item is deleted if a
14735     * callback function is set with elm_toolbar_item_del_cb_set().
14736     *
14737     * If a function is passed as argument, it will be called everytime this item
14738     * is selected, i.e., the user clicks over an unselected item.
14739     * If such function isn't needed, just passing
14740     * @c NULL as @p func is enough. The same should be done for @p data.
14741     *
14742     * Toolbar will load icon image from fdo or current theme.
14743     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14744     * If an absolute path is provided it will load it direct from a file.
14745     *
14746     * @see elm_toolbar_item_icon_set()
14747     * @see elm_toolbar_item_del()
14748     * @see elm_toolbar_item_del_cb_set()
14749     *
14750     * @ingroup Toolbar
14751     */
14752    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);
14753
14754    /**
14755     * Insert a new item into the toolbar object after item @p after.
14756     *
14757     * @param obj The toolbar object.
14758     * @param after The toolbar item to insert after.
14759     * @param icon A string with icon name or the absolute path of an image file.
14760     * @param label The label of the item.
14761     * @param func The function to call when the item is clicked.
14762     * @param data The data to associate with the item for related callbacks.
14763     * @return The created item or @c NULL upon failure.
14764     *
14765     * A new item will be created and added to the toolbar. Its position in
14766     * this toolbar will be just after item @p after.
14767     *
14768     * Items created with this method can be deleted with
14769     * elm_toolbar_item_del().
14770     *
14771     * Associated @p data can be properly freed when item is deleted if a
14772     * callback function is set with elm_toolbar_item_del_cb_set().
14773     *
14774     * If a function is passed as argument, it will be called everytime this item
14775     * is selected, i.e., the user clicks over an unselected item.
14776     * If such function isn't needed, just passing
14777     * @c NULL as @p func is enough. The same should be done for @p data.
14778     *
14779     * Toolbar will load icon image from fdo or current theme.
14780     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14781     * If an absolute path is provided it will load it direct from a file.
14782     *
14783     * @see elm_toolbar_item_icon_set()
14784     * @see elm_toolbar_item_del()
14785     * @see elm_toolbar_item_del_cb_set()
14786     *
14787     * @ingroup Toolbar
14788     */
14789    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);
14790
14791    /**
14792     * Get the first item in the given toolbar widget's list of
14793     * items.
14794     *
14795     * @param obj The toolbar object
14796     * @return The first item or @c NULL, if it has no items (and on
14797     * errors)
14798     *
14799     * @see elm_toolbar_item_append()
14800     * @see elm_toolbar_last_item_get()
14801     *
14802     * @ingroup Toolbar
14803     */
14804    EAPI Elm_Toolbar_Item       *elm_toolbar_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14805
14806    /**
14807     * Get the last item in the given toolbar widget's list of
14808     * items.
14809     *
14810     * @param obj The toolbar object
14811     * @return The last item or @c NULL, if it has no items (and on
14812     * errors)
14813     *
14814     * @see elm_toolbar_item_prepend()
14815     * @see elm_toolbar_first_item_get()
14816     *
14817     * @ingroup Toolbar
14818     */
14819    EAPI Elm_Toolbar_Item       *elm_toolbar_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14820
14821    /**
14822     * Get the item after @p item in toolbar.
14823     *
14824     * @param item The toolbar item.
14825     * @return The item after @p item, or @c NULL if none or on failure.
14826     *
14827     * @note If it is the last item, @c NULL will be returned.
14828     *
14829     * @see elm_toolbar_item_append()
14830     *
14831     * @ingroup Toolbar
14832     */
14833    EAPI Elm_Toolbar_Item       *elm_toolbar_item_next_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14834
14835    /**
14836     * Get the item before @p item in toolbar.
14837     *
14838     * @param item The toolbar item.
14839     * @return The item before @p item, or @c NULL if none or on failure.
14840     *
14841     * @note If it is the first item, @c NULL will be returned.
14842     *
14843     * @see elm_toolbar_item_prepend()
14844     *
14845     * @ingroup Toolbar
14846     */
14847    EAPI Elm_Toolbar_Item       *elm_toolbar_item_prev_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14848
14849    /**
14850     * Get the toolbar object from an item.
14851     *
14852     * @param item The item.
14853     * @return The toolbar object.
14854     *
14855     * This returns the toolbar object itself that an item belongs to.
14856     *
14857     * @ingroup Toolbar
14858     */
14859    EAPI Evas_Object            *elm_toolbar_item_toolbar_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14860
14861    /**
14862     * Set the priority of a toolbar item.
14863     *
14864     * @param item The toolbar item.
14865     * @param priority The item priority. The default is zero.
14866     *
14867     * This is used only when the toolbar shrink mode is set to
14868     * #ELM_TOOLBAR_SHRINK_MENU or #ELM_TOOLBAR_SHRINK_HIDE.
14869     * When space is less than required, items with low priority
14870     * will be removed from the toolbar and added to a dynamically-created menu,
14871     * while items with higher priority will remain on the toolbar,
14872     * with the same order they were added.
14873     *
14874     * @see elm_toolbar_item_priority_get()
14875     *
14876     * @ingroup Toolbar
14877     */
14878    EAPI void                    elm_toolbar_item_priority_set(Elm_Toolbar_Item *item, int priority) EINA_ARG_NONNULL(1);
14879
14880    /**
14881     * Get the priority of a toolbar item.
14882     *
14883     * @param item The toolbar item.
14884     * @return The @p item priority, or @c 0 on failure.
14885     *
14886     * @see elm_toolbar_item_priority_set() for details.
14887     *
14888     * @ingroup Toolbar
14889     */
14890    EAPI int                     elm_toolbar_item_priority_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14891
14892    /**
14893     * Get the label of item.
14894     *
14895     * @param item The item of toolbar.
14896     * @return The label of item.
14897     *
14898     * The return value is a pointer to the label associated to @p item when
14899     * it was created, with function elm_toolbar_item_append() or similar,
14900     * or later,
14901     * with function elm_toolbar_item_label_set. If no label
14902     * was passed as argument, it will return @c NULL.
14903     *
14904     * @see elm_toolbar_item_label_set() for more details.
14905     * @see elm_toolbar_item_append()
14906     *
14907     * @ingroup Toolbar
14908     */
14909    EAPI const char             *elm_toolbar_item_label_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14910
14911    /**
14912     * Set the label of item.
14913     *
14914     * @param item The item of toolbar.
14915     * @param text The label of item.
14916     *
14917     * The label to be displayed by the item.
14918     * Label will be placed at icons bottom (if set).
14919     *
14920     * If a label was passed as argument on item creation, with function
14921     * elm_toolbar_item_append() or similar, it will be already
14922     * displayed by the item.
14923     *
14924     * @see elm_toolbar_item_label_get()
14925     * @see elm_toolbar_item_append()
14926     *
14927     * @ingroup Toolbar
14928     */
14929    EAPI void                    elm_toolbar_item_label_set(Elm_Toolbar_Item *item, const char *label) EINA_ARG_NONNULL(1);
14930
14931    /**
14932     * Return the data associated with a given toolbar widget item.
14933     *
14934     * @param item The toolbar widget item handle.
14935     * @return The data associated with @p item.
14936     *
14937     * @see elm_toolbar_item_data_set()
14938     *
14939     * @ingroup Toolbar
14940     */
14941    EAPI void                   *elm_toolbar_item_data_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14942
14943    /**
14944     * Set the data associated with a given toolbar widget item.
14945     *
14946     * @param item The toolbar widget item handle.
14947     * @param data The new data pointer to set to @p item.
14948     *
14949     * This sets new item data on @p item.
14950     *
14951     * @warning The old data pointer won't be touched by this function, so
14952     * the user had better to free that old data himself/herself.
14953     *
14954     * @ingroup Toolbar
14955     */
14956    EAPI void                    elm_toolbar_item_data_set(Elm_Toolbar_Item *item, const void *data) EINA_ARG_NONNULL(1);
14957
14958    /**
14959     * Returns a pointer to a toolbar item by its label.
14960     *
14961     * @param obj The toolbar object.
14962     * @param label The label of the item to find.
14963     *
14964     * @return The pointer to the toolbar item matching @p label or @c NULL
14965     * on failure.
14966     *
14967     * @ingroup Toolbar
14968     */
14969    EAPI Elm_Toolbar_Item       *elm_toolbar_item_find_by_label(const Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
14970
14971    /*
14972     * Get whether the @p item is selected or not.
14973     *
14974     * @param item The toolbar item.
14975     * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
14976     * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
14977     *
14978     * @see elm_toolbar_selected_item_set() for details.
14979     * @see elm_toolbar_item_selected_get()
14980     *
14981     * @ingroup Toolbar
14982     */
14983    EAPI Eina_Bool               elm_toolbar_item_selected_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14984
14985    /**
14986     * Set the selected state of an item.
14987     *
14988     * @param item The toolbar item
14989     * @param selected The selected state
14990     *
14991     * This sets the selected state of the given item @p it.
14992     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
14993     *
14994     * If a new item is selected the previosly selected will be unselected.
14995     * Previoulsy selected item can be get with function
14996     * elm_toolbar_selected_item_get().
14997     *
14998     * Selected items will be highlighted.
14999     *
15000     * @see elm_toolbar_item_selected_get()
15001     * @see elm_toolbar_selected_item_get()
15002     *
15003     * @ingroup Toolbar
15004     */
15005    EAPI void                    elm_toolbar_item_selected_set(Elm_Toolbar_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
15006
15007    /**
15008     * Get the selected item.
15009     *
15010     * @param obj The toolbar object.
15011     * @return The selected toolbar item.
15012     *
15013     * The selected item can be unselected with function
15014     * elm_toolbar_item_selected_set().
15015     *
15016     * The selected item always will be highlighted on toolbar.
15017     *
15018     * @see elm_toolbar_selected_items_get()
15019     *
15020     * @ingroup Toolbar
15021     */
15022    EAPI Elm_Toolbar_Item       *elm_toolbar_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15023
15024    /**
15025     * Set the icon associated with @p item.
15026     *
15027     * @param obj The parent of this item.
15028     * @param item The toolbar item.
15029     * @param icon A string with icon name or the absolute path of an image file.
15030     *
15031     * Toolbar will load icon image from fdo or current theme.
15032     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
15033     * If an absolute path is provided it will load it direct from a file.
15034     *
15035     * @see elm_toolbar_icon_order_lookup_set()
15036     * @see elm_toolbar_icon_order_lookup_get()
15037     *
15038     * @ingroup Toolbar
15039     */
15040    EAPI void                    elm_toolbar_item_icon_set(Elm_Toolbar_Item *item, const char *icon) EINA_ARG_NONNULL(1);
15041
15042    /**
15043     * Get the string used to set the icon of @p item.
15044     *
15045     * @param item The toolbar item.
15046     * @return The string associated with the icon object.
15047     *
15048     * @see elm_toolbar_item_icon_set() for details.
15049     *
15050     * @ingroup Toolbar
15051     */
15052    EAPI const char             *elm_toolbar_item_icon_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15053
15054    /**
15055     * Get the object of @p item.
15056     *
15057     * @param item The toolbar item.
15058     * @return The object
15059     *
15060     * @ingroup Toolbar
15061     */
15062    EAPI Evas_Object            *elm_toolbar_item_object_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15063
15064    /**
15065     * Get the icon object of @p item.
15066     *
15067     * @param item The toolbar item.
15068     * @return The icon object
15069     *
15070     * @see elm_toolbar_item_icon_set() or elm_toolbar_item_icon_memfile_set() for details.
15071     *
15072     * @ingroup Toolbar
15073     */
15074    EAPI Evas_Object            *elm_toolbar_item_icon_object_get(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15075
15076    /**
15077     * Set the icon associated with @p item to an image in a binary buffer.
15078     *
15079     * @param item The toolbar item.
15080     * @param img The binary data that will be used as an image
15081     * @param size The size of binary data @p img
15082     * @param format Optional format of @p img to pass to the image loader
15083     * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
15084     *
15085     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
15086     *
15087     * @note The icon image set by this function can be changed by
15088     * elm_toolbar_item_icon_set().
15089     * 
15090     * @ingroup Toolbar
15091     */
15092    EAPI Eina_Bool elm_toolbar_item_icon_memfile_set(Elm_Toolbar_Item *item, const void *img, size_t size, const char *format, const char *key) EINA_ARG_NONNULL(1);
15093
15094    /**
15095     * Delete them item from the toolbar.
15096     *
15097     * @param item The item of toolbar to be deleted.
15098     *
15099     * @see elm_toolbar_item_append()
15100     * @see elm_toolbar_item_del_cb_set()
15101     *
15102     * @ingroup Toolbar
15103     */
15104    EAPI void                    elm_toolbar_item_del(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15105
15106    /**
15107     * Set the function called when a toolbar item is freed.
15108     *
15109     * @param item The item to set the callback on.
15110     * @param func The function called.
15111     *
15112     * If there is a @p func, then it will be called prior item's memory release.
15113     * That will be called with the following arguments:
15114     * @li item's data;
15115     * @li item's Evas object;
15116     * @li item itself;
15117     *
15118     * This way, a data associated to a toolbar item could be properly freed.
15119     *
15120     * @ingroup Toolbar
15121     */
15122    EAPI void                    elm_toolbar_item_del_cb_set(Elm_Toolbar_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
15123
15124    /**
15125     * Get a value whether toolbar item is disabled or not.
15126     *
15127     * @param item The item.
15128     * @return The disabled state.
15129     *
15130     * @see elm_toolbar_item_disabled_set() for more details.
15131     *
15132     * @ingroup Toolbar
15133     */
15134    EAPI Eina_Bool               elm_toolbar_item_disabled_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15135
15136    /**
15137     * Sets the disabled/enabled state of a toolbar item.
15138     *
15139     * @param item The item.
15140     * @param disabled The disabled state.
15141     *
15142     * A disabled item cannot be selected or unselected. It will also
15143     * change its appearance (generally greyed out). This sets the
15144     * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
15145     * enabled).
15146     *
15147     * @ingroup Toolbar
15148     */
15149    EAPI void                    elm_toolbar_item_disabled_set(Elm_Toolbar_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
15150
15151    /**
15152     * Set or unset item as a separator.
15153     *
15154     * @param item The toolbar item.
15155     * @param setting @c EINA_TRUE to set item @p item as separator or
15156     * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
15157     *
15158     * Items aren't set as separator by default.
15159     *
15160     * If set as separator it will display separator theme, so won't display
15161     * icons or label.
15162     *
15163     * @see elm_toolbar_item_separator_get()
15164     *
15165     * @ingroup Toolbar
15166     */
15167    EAPI void                    elm_toolbar_item_separator_set(Elm_Toolbar_Item *item, Eina_Bool separator) EINA_ARG_NONNULL(1);
15168
15169    /**
15170     * Get a value whether item is a separator or not.
15171     *
15172     * @param item The toolbar item.
15173     * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
15174     * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
15175     *
15176     * @see elm_toolbar_item_separator_set() for details.
15177     *
15178     * @ingroup Toolbar
15179     */
15180    EAPI Eina_Bool               elm_toolbar_item_separator_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15181
15182    /**
15183     * Set the shrink state of toolbar @p obj.
15184     *
15185     * @param obj The toolbar object.
15186     * @param shrink_mode Toolbar's items display behavior.
15187     *
15188     * The toolbar won't scroll if #ELM_TOOLBAR_SHRINK_NONE,
15189     * but will enforce a minimun size so all the items will fit, won't scroll
15190     * and won't show the items that don't fit if #ELM_TOOLBAR_SHRINK_HIDE,
15191     * will scroll if #ELM_TOOLBAR_SHRINK_SCROLL, and will create a button to
15192     * pop up excess elements with #ELM_TOOLBAR_SHRINK_MENU.
15193     *
15194     * @ingroup Toolbar
15195     */
15196    EAPI void                    elm_toolbar_mode_shrink_set(Evas_Object *obj, Elm_Toolbar_Shrink_Mode shrink_mode) EINA_ARG_NONNULL(1);
15197
15198    /**
15199     * Get the shrink mode of toolbar @p obj.
15200     *
15201     * @param obj The toolbar object.
15202     * @return Toolbar's items display behavior.
15203     *
15204     * @see elm_toolbar_mode_shrink_set() for details.
15205     *
15206     * @ingroup Toolbar
15207     */
15208    EAPI Elm_Toolbar_Shrink_Mode elm_toolbar_mode_shrink_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15209
15210    /**
15211     * Enable/disable homogenous mode.
15212     *
15213     * @param obj The toolbar object
15214     * @param homogeneous Assume the items within the toolbar are of the
15215     * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
15216     *
15217     * This will enable the homogeneous mode where items are of the same size.
15218     * @see elm_toolbar_homogeneous_get()
15219     *
15220     * @ingroup Toolbar
15221     */
15222    EAPI void                    elm_toolbar_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
15223
15224    /**
15225     * Get whether the homogenous mode is enabled.
15226     *
15227     * @param obj The toolbar object.
15228     * @return Assume the items within the toolbar are of the same height
15229     * and width (EINA_TRUE = on, EINA_FALSE = off).
15230     *
15231     * @see elm_toolbar_homogeneous_set()
15232     *
15233     * @ingroup Toolbar
15234     */
15235    EAPI Eina_Bool               elm_toolbar_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15236
15237    /**
15238     * Enable/disable homogenous mode.
15239     *
15240     * @param obj The toolbar object
15241     * @param homogeneous Assume the items within the toolbar are of the
15242     * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
15243     *
15244     * This will enable the homogeneous mode where items are of the same size.
15245     * @see elm_toolbar_homogeneous_get()
15246     *
15247     * @deprecated use elm_toolbar_homogeneous_set() instead.
15248     *
15249     * @ingroup Toolbar
15250     */
15251    EINA_DEPRECATED EAPI void    elm_toolbar_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
15252
15253    /**
15254     * Get whether the homogenous mode is enabled.
15255     *
15256     * @param obj The toolbar object.
15257     * @return Assume the items within the toolbar are of the same height
15258     * and width (EINA_TRUE = on, EINA_FALSE = off).
15259     *
15260     * @see elm_toolbar_homogeneous_set()
15261     * @deprecated use elm_toolbar_homogeneous_get() instead.
15262     *
15263     * @ingroup Toolbar
15264     */
15265    EINA_DEPRECATED EAPI Eina_Bool elm_toolbar_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15266
15267    /**
15268     * Set the parent object of the toolbar items' menus.
15269     *
15270     * @param obj The toolbar object.
15271     * @param parent The parent of the menu objects.
15272     *
15273     * Each item can be set as item menu, with elm_toolbar_item_menu_set().
15274     *
15275     * For more details about setting the parent for toolbar menus, see
15276     * elm_menu_parent_set().
15277     *
15278     * @see elm_menu_parent_set() for details.
15279     * @see elm_toolbar_item_menu_set() for details.
15280     *
15281     * @ingroup Toolbar
15282     */
15283    EAPI void                    elm_toolbar_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
15284
15285    /**
15286     * Get the parent object of the toolbar items' menus.
15287     *
15288     * @param obj The toolbar object.
15289     * @return The parent of the menu objects.
15290     *
15291     * @see elm_toolbar_menu_parent_set() for details.
15292     *
15293     * @ingroup Toolbar
15294     */
15295    EAPI Evas_Object            *elm_toolbar_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15296
15297    /**
15298     * Set the alignment of the items.
15299     *
15300     * @param obj The toolbar object.
15301     * @param align The new alignment, a float between <tt> 0.0 </tt>
15302     * and <tt> 1.0 </tt>.
15303     *
15304     * Alignment of toolbar items, from <tt> 0.0 </tt> to indicates to align
15305     * left, to <tt> 1.0 </tt>, to align to right. <tt> 0.5 </tt> centralize
15306     * items.
15307     *
15308     * Centered items by default.
15309     *
15310     * @see elm_toolbar_align_get()
15311     *
15312     * @ingroup Toolbar
15313     */
15314    EAPI void                    elm_toolbar_align_set(Evas_Object *obj, double align) EINA_ARG_NONNULL(1);
15315
15316    /**
15317     * Get the alignment of the items.
15318     *
15319     * @param obj The toolbar object.
15320     * @return toolbar items alignment, a float between <tt> 0.0 </tt> and
15321     * <tt> 1.0 </tt>.
15322     *
15323     * @see elm_toolbar_align_set() for details.
15324     *
15325     * @ingroup Toolbar
15326     */
15327    EAPI double                  elm_toolbar_align_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15328
15329    /**
15330     * Set whether the toolbar item opens a menu.
15331     *
15332     * @param item The toolbar item.
15333     * @param menu If @c EINA_TRUE, @p item will opens a menu when selected.
15334     *
15335     * A toolbar item can be set to be a menu, using this function.
15336     *
15337     * Once it is set to be a menu, it can be manipulated through the
15338     * menu-like function elm_toolbar_menu_parent_set() and the other
15339     * elm_menu functions, using the Evas_Object @c menu returned by
15340     * elm_toolbar_item_menu_get().
15341     *
15342     * So, items to be displayed in this item's menu should be added with
15343     * elm_menu_item_add().
15344     *
15345     * The following code exemplifies the most basic usage:
15346     * @code
15347     * tb = elm_toolbar_add(win)
15348     * item = elm_toolbar_item_append(tb, "refresh", "Menu", NULL, NULL);
15349     * elm_toolbar_item_menu_set(item, EINA_TRUE);
15350     * elm_toolbar_menu_parent_set(tb, win);
15351     * menu = elm_toolbar_item_menu_get(item);
15352     * elm_menu_item_add(menu, NULL, "edit-cut", "Cut", NULL, NULL);
15353     * menu_item = elm_menu_item_add(menu, NULL, "edit-copy", "Copy", NULL,
15354     * NULL);
15355     * @endcode
15356     *
15357     * @see elm_toolbar_item_menu_get()
15358     *
15359     * @ingroup Toolbar
15360     */
15361    EAPI void                    elm_toolbar_item_menu_set(Elm_Toolbar_Item *item, Eina_Bool menu) EINA_ARG_NONNULL(1);
15362
15363    /**
15364     * Get toolbar item's menu.
15365     *
15366     * @param item The toolbar item.
15367     * @return Item's menu object or @c NULL on failure.
15368     *
15369     * If @p item wasn't set as menu item with elm_toolbar_item_menu_set(),
15370     * this function will set it.
15371     *
15372     * @see elm_toolbar_item_menu_set() for details.
15373     *
15374     * @ingroup Toolbar
15375     */
15376    EAPI Evas_Object            *elm_toolbar_item_menu_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15377
15378    /**
15379     * Add a new state to @p item.
15380     *
15381     * @param item The item.
15382     * @param icon A string with icon name or the absolute path of an image file.
15383     * @param label The label of the new state.
15384     * @param func The function to call when the item is clicked when this
15385     * state is selected.
15386     * @param data The data to associate with the state.
15387     * @return The toolbar item state, or @c NULL upon failure.
15388     *
15389     * Toolbar will load icon image from fdo or current theme.
15390     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
15391     * If an absolute path is provided it will load it direct from a file.
15392     *
15393     * States created with this function can be removed with
15394     * elm_toolbar_item_state_del().
15395     *
15396     * @see elm_toolbar_item_state_del()
15397     * @see elm_toolbar_item_state_sel()
15398     * @see elm_toolbar_item_state_get()
15399     *
15400     * @ingroup Toolbar
15401     */
15402    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);
15403
15404    /**
15405     * Delete a previoulsy added state to @p item.
15406     *
15407     * @param item The toolbar item.
15408     * @param state The state to be deleted.
15409     * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
15410     *
15411     * @see elm_toolbar_item_state_add()
15412     */
15413    EAPI Eina_Bool               elm_toolbar_item_state_del(Elm_Toolbar_Item *item, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
15414
15415    /**
15416     * Set @p state as the current state of @p it.
15417     *
15418     * @param it The item.
15419     * @param state The state to use.
15420     * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
15421     *
15422     * If @p state is @c NULL, it won't select any state and the default item's
15423     * icon and label will be used. It's the same behaviour than
15424     * elm_toolbar_item_state_unser().
15425     *
15426     * @see elm_toolbar_item_state_unset()
15427     *
15428     * @ingroup Toolbar
15429     */
15430    EAPI Eina_Bool               elm_toolbar_item_state_set(Elm_Toolbar_Item *it, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
15431
15432    /**
15433     * Unset the state of @p it.
15434     *
15435     * @param it The item.
15436     *
15437     * The default icon and label from this item will be displayed.
15438     *
15439     * @see elm_toolbar_item_state_set() for more details.
15440     *
15441     * @ingroup Toolbar
15442     */
15443    EAPI void                    elm_toolbar_item_state_unset(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15444
15445    /**
15446     * Get the current state of @p it.
15447     *
15448     * @param item The item.
15449     * @return The selected state or @c NULL if none is selected or on failure.
15450     *
15451     * @see elm_toolbar_item_state_set() for details.
15452     * @see elm_toolbar_item_state_unset()
15453     * @see elm_toolbar_item_state_add()
15454     *
15455     * @ingroup Toolbar
15456     */
15457    EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_get(const Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15458
15459    /**
15460     * Get the state after selected state in toolbar's @p item.
15461     *
15462     * @param it The toolbar item to change state.
15463     * @return The state after current state, or @c NULL on failure.
15464     *
15465     * If last state is selected, this function will return first state.
15466     *
15467     * @see elm_toolbar_item_state_set()
15468     * @see elm_toolbar_item_state_add()
15469     *
15470     * @ingroup Toolbar
15471     */
15472    EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_next(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15473
15474    /**
15475     * Get the state before selected state in toolbar's @p item.
15476     *
15477     * @param it The toolbar item to change state.
15478     * @return The state before current state, or @c NULL on failure.
15479     *
15480     * If first state is selected, this function will return last state.
15481     *
15482     * @see elm_toolbar_item_state_set()
15483     * @see elm_toolbar_item_state_add()
15484     *
15485     * @ingroup Toolbar
15486     */
15487    EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_prev(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15488
15489    /**
15490     * Set the text to be shown in a given toolbar item's tooltips.
15491     *
15492     * @param item Target item.
15493     * @param text The text to set in the content.
15494     *
15495     * Setup the text as tooltip to object. The item can have only one tooltip,
15496     * so any previous tooltip data - set with this function or
15497     * elm_toolbar_item_tooltip_content_cb_set() - is removed.
15498     *
15499     * @see elm_object_tooltip_text_set() for more details.
15500     *
15501     * @ingroup Toolbar
15502     */
15503    EAPI void             elm_toolbar_item_tooltip_text_set(Elm_Toolbar_Item *item, const char *text) EINA_ARG_NONNULL(1);
15504
15505    /**
15506     * Set the content to be shown in the tooltip item.
15507     *
15508     * Setup the tooltip to item. The item can have only one tooltip,
15509     * so any previous tooltip data is removed. @p func(with @p data) will
15510     * be called every time that need show the tooltip and it should
15511     * return a valid Evas_Object. This object is then managed fully by
15512     * tooltip system and is deleted when the tooltip is gone.
15513     *
15514     * @param item the toolbar item being attached a tooltip.
15515     * @param func the function used to create the tooltip contents.
15516     * @param data what to provide to @a func as callback data/context.
15517     * @param del_cb called when data is not needed anymore, either when
15518     *        another callback replaces @a func, the tooltip is unset with
15519     *        elm_toolbar_item_tooltip_unset() or the owner @a item
15520     *        dies. This callback receives as the first parameter the
15521     *        given @a data, and @c event_info is the item.
15522     *
15523     * @see elm_object_tooltip_content_cb_set() for more details.
15524     *
15525     * @ingroup Toolbar
15526     */
15527    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);
15528
15529    /**
15530     * Unset tooltip from item.
15531     *
15532     * @param item toolbar item to remove previously set tooltip.
15533     *
15534     * Remove tooltip from item. The callback provided as del_cb to
15535     * elm_toolbar_item_tooltip_content_cb_set() will be called to notify
15536     * it is not used anymore.
15537     *
15538     * @see elm_object_tooltip_unset() for more details.
15539     * @see elm_toolbar_item_tooltip_content_cb_set()
15540     *
15541     * @ingroup Toolbar
15542     */
15543    EAPI void             elm_toolbar_item_tooltip_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15544
15545    /**
15546     * Sets a different style for this item tooltip.
15547     *
15548     * @note before you set a style you should define a tooltip with
15549     *       elm_toolbar_item_tooltip_content_cb_set() or
15550     *       elm_toolbar_item_tooltip_text_set()
15551     *
15552     * @param item toolbar item with tooltip already set.
15553     * @param style the theme style to use (default, transparent, ...)
15554     *
15555     * @see elm_object_tooltip_style_set() for more details.
15556     *
15557     * @ingroup Toolbar
15558     */
15559    EAPI void             elm_toolbar_item_tooltip_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
15560
15561    /**
15562     * Get the style for this item tooltip.
15563     *
15564     * @param item toolbar item with tooltip already set.
15565     * @return style the theme style in use, defaults to "default". If the
15566     *         object does not have a tooltip set, then NULL is returned.
15567     *
15568     * @see elm_object_tooltip_style_get() for more details.
15569     * @see elm_toolbar_item_tooltip_style_set()
15570     *
15571     * @ingroup Toolbar
15572     */
15573    EAPI const char      *elm_toolbar_item_tooltip_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15574
15575    /**
15576     * Set the type of mouse pointer/cursor decoration to be shown,
15577     * when the mouse pointer is over the given toolbar widget item
15578     *
15579     * @param item toolbar item to customize cursor on
15580     * @param cursor the cursor type's name
15581     *
15582     * This function works analogously as elm_object_cursor_set(), but
15583     * here the cursor's changing area is restricted to the item's
15584     * area, and not the whole widget's. Note that that item cursors
15585     * have precedence over widget cursors, so that a mouse over an
15586     * item with custom cursor set will always show @b that cursor.
15587     *
15588     * If this function is called twice for an object, a previously set
15589     * cursor will be unset on the second call.
15590     *
15591     * @see elm_object_cursor_set()
15592     * @see elm_toolbar_item_cursor_get()
15593     * @see elm_toolbar_item_cursor_unset()
15594     *
15595     * @ingroup Toolbar
15596     */
15597    EAPI void             elm_toolbar_item_cursor_set(Elm_Toolbar_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
15598
15599    /*
15600     * Get the type of mouse pointer/cursor decoration set to be shown,
15601     * when the mouse pointer is over the given toolbar widget item
15602     *
15603     * @param item toolbar item with custom cursor set
15604     * @return the cursor type's name or @c NULL, if no custom cursors
15605     * were set to @p item (and on errors)
15606     *
15607     * @see elm_object_cursor_get()
15608     * @see elm_toolbar_item_cursor_set()
15609     * @see elm_toolbar_item_cursor_unset()
15610     *
15611     * @ingroup Toolbar
15612     */
15613    EAPI const char      *elm_toolbar_item_cursor_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15614
15615    /**
15616     * Unset any custom mouse pointer/cursor decoration set to be
15617     * shown, when the mouse pointer is over the given toolbar widget
15618     * item, thus making it show the @b default cursor again.
15619     *
15620     * @param item a toolbar item
15621     *
15622     * Use this call to undo any custom settings on this item's cursor
15623     * decoration, bringing it back to defaults (no custom style set).
15624     *
15625     * @see elm_object_cursor_unset()
15626     * @see elm_toolbar_item_cursor_set()
15627     *
15628     * @ingroup Toolbar
15629     */
15630    EAPI void             elm_toolbar_item_cursor_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15631
15632    /**
15633     * Set a different @b style for a given custom cursor set for a
15634     * toolbar item.
15635     *
15636     * @param item toolbar item with custom cursor set
15637     * @param style the <b>theme style</b> to use (e.g. @c "default",
15638     * @c "transparent", etc)
15639     *
15640     * This function only makes sense when one is using custom mouse
15641     * cursor decorations <b>defined in a theme file</b>, which can have,
15642     * given a cursor name/type, <b>alternate styles</b> on it. It
15643     * works analogously as elm_object_cursor_style_set(), but here
15644     * applyed only to toolbar item objects.
15645     *
15646     * @warning Before you set a cursor style you should have definen a
15647     *       custom cursor previously on the item, with
15648     *       elm_toolbar_item_cursor_set()
15649     *
15650     * @see elm_toolbar_item_cursor_engine_only_set()
15651     * @see elm_toolbar_item_cursor_style_get()
15652     *
15653     * @ingroup Toolbar
15654     */
15655    EAPI void             elm_toolbar_item_cursor_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
15656
15657    /**
15658     * Get the current @b style set for a given toolbar item's custom
15659     * cursor
15660     *
15661     * @param item toolbar item with custom cursor set.
15662     * @return style the cursor style in use. If the object does not
15663     *         have a cursor set, then @c NULL is returned.
15664     *
15665     * @see elm_toolbar_item_cursor_style_set() for more details
15666     *
15667     * @ingroup Toolbar
15668     */
15669    EAPI const char      *elm_toolbar_item_cursor_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15670
15671    /**
15672     * Set if the (custom)cursor for a given toolbar item should be
15673     * searched in its theme, also, or should only rely on the
15674     * rendering engine.
15675     *
15676     * @param item item with custom (custom) cursor already set on
15677     * @param engine_only Use @c EINA_TRUE to have cursors looked for
15678     * only on those provided by the rendering engine, @c EINA_FALSE to
15679     * have them searched on the widget's theme, as well.
15680     *
15681     * @note This call is of use only if you've set a custom cursor
15682     * for toolbar items, with elm_toolbar_item_cursor_set().
15683     *
15684     * @note By default, cursors will only be looked for between those
15685     * provided by the rendering engine.
15686     *
15687     * @ingroup Toolbar
15688     */
15689    EAPI void             elm_toolbar_item_cursor_engine_only_set(Elm_Toolbar_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
15690
15691    /**
15692     * Get if the (custom) cursor for a given toolbar item is being
15693     * searched in its theme, also, or is only relying on the rendering
15694     * engine.
15695     *
15696     * @param item a toolbar item
15697     * @return @c EINA_TRUE, if cursors are being looked for only on
15698     * those provided by the rendering engine, @c EINA_FALSE if they
15699     * are being searched on the widget's theme, as well.
15700     *
15701     * @see elm_toolbar_item_cursor_engine_only_set(), for more details
15702     *
15703     * @ingroup Toolbar
15704     */
15705    EAPI Eina_Bool        elm_toolbar_item_cursor_engine_only_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15706
15707    /**
15708     * Change a toolbar's orientation
15709     * @param obj The toolbar object
15710     * @param vertical If @c EINA_TRUE, the toolbar is vertical
15711     * By default, a toolbar will be horizontal. Use this function to create a vertical toolbar.
15712     * @ingroup Toolbar
15713     * @deprecated use elm_toolbar_horizontal_set() instead.
15714     */
15715    EINA_DEPRECATED EAPI void             elm_toolbar_orientation_set(Evas_Object *obj, Eina_Bool vertical) EINA_ARG_NONNULL(1);
15716
15717    /**
15718     * Change a toolbar's orientation
15719     * @param obj The toolbar object
15720     * @param horizontal If @c EINA_TRUE, the toolbar is horizontal
15721     * By default, a toolbar will be horizontal. Use this function to create a vertical toolbar.
15722     * @ingroup Toolbar
15723     */
15724    EAPI void             elm_toolbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
15725
15726    /**
15727     * Get a toolbar's orientation
15728     * @param obj The toolbar object
15729     * @return If @c EINA_TRUE, the toolbar is vertical
15730     * By default, a toolbar will be horizontal. Use this function to determine whether a toolbar is vertical.
15731     * @ingroup Toolbar
15732     * @deprecated use elm_toolbar_horizontal_get() instead.
15733     */
15734    EINA_DEPRECATED EAPI Eina_Bool        elm_toolbar_orientation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15735
15736    /**
15737     * Get a toolbar's orientation
15738     * @param obj The toolbar object
15739     * @return If @c EINA_TRUE, the toolbar is horizontal
15740     * By default, a toolbar will be horizontal. Use this function to determine whether a toolbar is vertical.
15741     * @ingroup Toolbar
15742     */
15743    EAPI Eina_Bool elm_toolbar_horizontal_get(const Evas_Object *obj);
15744    /**
15745     * @}
15746     */
15747
15748    /**
15749     * @defgroup Tooltips Tooltips
15750     *
15751     * The Tooltip is an (internal, for now) smart object used to show a
15752     * content in a frame on mouse hover of objects(or widgets), with
15753     * tips/information about them.
15754     *
15755     * @{
15756     */
15757
15758    EAPI double       elm_tooltip_delay_get(void);
15759    EAPI Eina_Bool    elm_tooltip_delay_set(double delay);
15760    EAPI void         elm_object_tooltip_show(Evas_Object *obj) EINA_ARG_NONNULL(1);
15761    EAPI void         elm_object_tooltip_hide(Evas_Object *obj) EINA_ARG_NONNULL(1);
15762    EAPI void         elm_object_tooltip_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1, 2);
15763    EAPI void         elm_object_tooltip_domain_translatable_text_set(Evas_Object *obj, const char *domain, const char *text) EINA_ARG_NONNULL(1, 3);
15764 #define elm_object_tooltip_translatable_text_set(obj, text) elm_object_tooltip_domain_translatable_text_set((obj), NULL, (text))
15765    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);
15766    EAPI void         elm_object_tooltip_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15767    EAPI void         elm_object_tooltip_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
15768    EAPI const char  *elm_object_tooltip_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15769    EAPI Eina_Bool    elm_tooltip_size_restrict_disable(Evas_Object *obj, Eina_Bool disable) EINA_ARG_NONNULL(1);
15770    EAPI Eina_Bool    elm_tooltip_size_restrict_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15771
15772    /**
15773     * @}
15774     */
15775
15776    /**
15777     * @defgroup Cursors Cursors
15778     *
15779     * The Elementary cursor is an internal smart object used to
15780     * customize the mouse cursor displayed over objects (or
15781     * widgets). In the most common scenario, the cursor decoration
15782     * comes from the graphical @b engine Elementary is running
15783     * on. Those engines may provide different decorations for cursors,
15784     * and Elementary provides functions to choose them (think of X11
15785     * cursors, as an example).
15786     *
15787     * There's also the possibility of, besides using engine provided
15788     * cursors, also use ones coming from Edje theming files. Both
15789     * globally and per widget, Elementary makes it possible for one to
15790     * make the cursors lookup to be held on engines only or on
15791     * Elementary's theme file, too. To set cursor's hot spot,
15792     * two data items should be added to cursor's theme: "hot_x" and
15793     * "hot_y", that are the offset from upper-left corner of the cursor
15794     * (coordinates 0,0).
15795     *
15796     * @{
15797     */
15798
15799    /**
15800     * Set the cursor to be shown when mouse is over the object
15801     *
15802     * Set the cursor that will be displayed when mouse is over the
15803     * object. The object can have only one cursor set to it, so if
15804     * this function is called twice for an object, the previous set
15805     * will be unset.
15806     * If using X cursors, a definition of all the valid cursor names
15807     * is listed on Elementary_Cursors.h. If an invalid name is set
15808     * the default cursor will be used.
15809     *
15810     * @param obj the object being set a cursor.
15811     * @param cursor the cursor name to be used.
15812     *
15813     * @ingroup Cursors
15814     */
15815    EAPI void         elm_object_cursor_set(Evas_Object *obj, const char *cursor) EINA_ARG_NONNULL(1);
15816
15817    /**
15818     * Get the cursor to be shown when mouse is over the object
15819     *
15820     * @param obj an object with cursor already set.
15821     * @return the cursor name.
15822     *
15823     * @ingroup Cursors
15824     */
15825    EAPI const char  *elm_object_cursor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15826
15827    /**
15828     * Unset cursor for object
15829     *
15830     * Unset cursor for object, and set the cursor to default if the mouse
15831     * was over this object.
15832     *
15833     * @param obj Target object
15834     * @see elm_object_cursor_set()
15835     *
15836     * @ingroup Cursors
15837     */
15838    EAPI void         elm_object_cursor_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15839
15840    /**
15841     * Sets a different style for this object cursor.
15842     *
15843     * @note before you set a style you should define a cursor with
15844     *       elm_object_cursor_set()
15845     *
15846     * @param obj an object with cursor already set.
15847     * @param style the theme style to use (default, transparent, ...)
15848     *
15849     * @ingroup Cursors
15850     */
15851    EAPI void         elm_object_cursor_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
15852
15853    /**
15854     * Get the style for this object cursor.
15855     *
15856     * @param obj an object with cursor already set.
15857     * @return style the theme style in use, defaults to "default". If the
15858     *         object does not have a cursor set, then NULL is returned.
15859     *
15860     * @ingroup Cursors
15861     */
15862    EAPI const char  *elm_object_cursor_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15863
15864    /**
15865     * Set if the cursor set should be searched on the theme or should use
15866     * the provided by the engine, only.
15867     *
15868     * @note before you set if should look on theme you should define a cursor
15869     * with elm_object_cursor_set(). By default it will only look for cursors
15870     * provided by the engine.
15871     *
15872     * @param obj an object with cursor already set.
15873     * @param engine_only boolean to define it cursors should be looked only
15874     * between the provided by the engine or searched on widget's theme as well.
15875     *
15876     * @ingroup Cursors
15877     */
15878    EAPI void         elm_object_cursor_engine_only_set(Evas_Object *obj, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
15879
15880    /**
15881     * Get the cursor engine only usage for this object cursor.
15882     *
15883     * @param obj an object with cursor already set.
15884     * @return engine_only boolean to define it cursors should be
15885     * looked only between the provided by the engine or searched on
15886     * widget's theme as well. If the object does not have a cursor
15887     * set, then EINA_FALSE is returned.
15888     *
15889     * @ingroup Cursors
15890     */
15891    EAPI Eina_Bool    elm_object_cursor_engine_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15892
15893    /**
15894     * Get the configured cursor engine only usage
15895     *
15896     * This gets the globally configured exclusive usage of engine cursors.
15897     *
15898     * @return 1 if only engine cursors should be used
15899     * @ingroup Cursors
15900     */
15901    EAPI int          elm_cursor_engine_only_get(void);
15902
15903    /**
15904     * Set the configured cursor engine only usage
15905     *
15906     * This sets the globally configured exclusive usage of engine cursors.
15907     * It won't affect cursors set before changing this value.
15908     *
15909     * @param engine_only If 1 only engine cursors will be enabled, if 0 will
15910     * look for them on theme before.
15911     * @return EINA_TRUE if value is valid and setted (0 or 1)
15912     * @ingroup Cursors
15913     */
15914    EAPI Eina_Bool    elm_cursor_engine_only_set(int engine_only);
15915
15916    /**
15917     * @}
15918     */
15919
15920    /**
15921     * @defgroup Menu Menu
15922     *
15923     * @image html img/widget/menu/preview-00.png
15924     * @image latex img/widget/menu/preview-00.eps
15925     *
15926     * A menu is a list of items displayed above its parent. When the menu is
15927     * showing its parent is darkened. Each item can have a sub-menu. The menu
15928     * object can be used to display a menu on a right click event, in a toolbar,
15929     * anywhere.
15930     *
15931     * Signals that you can add callbacks for are:
15932     * @li "clicked" - the user clicked the empty space in the menu to dismiss.
15933     *             event_info is NULL.
15934     *
15935     * @see @ref tutorial_menu
15936     * @{
15937     */
15938    typedef struct _Elm_Menu_Item Elm_Menu_Item; /**< Item of Elm_Menu. Sub-type of Elm_Widget_Item */
15939    /**
15940     * @brief Add a new menu to the parent
15941     *
15942     * @param parent The parent object.
15943     * @return The new object or NULL if it cannot be created.
15944     */
15945    EAPI Evas_Object       *elm_menu_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
15946    /**
15947     * @brief Set the parent for the given menu widget
15948     *
15949     * @param obj The menu object.
15950     * @param parent The new parent.
15951     */
15952    EAPI void               elm_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
15953    /**
15954     * @brief Get the parent for the given menu widget
15955     *
15956     * @param obj The menu object.
15957     * @return The parent.
15958     *
15959     * @see elm_menu_parent_set()
15960     */
15961    EAPI Evas_Object       *elm_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15962    /**
15963     * @brief Move the menu to a new position
15964     *
15965     * @param obj The menu object.
15966     * @param x The new position.
15967     * @param y The new position.
15968     *
15969     * Sets the top-left position of the menu to (@p x,@p y).
15970     *
15971     * @note @p x and @p y coordinates are relative to parent.
15972     */
15973    EAPI void               elm_menu_move(Evas_Object *obj, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
15974    /**
15975     * @brief Close a opened menu
15976     *
15977     * @param obj the menu object
15978     * @return void
15979     *
15980     * Hides the menu and all it's sub-menus.
15981     */
15982    EAPI void               elm_menu_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
15983    /**
15984     * @brief Returns a list of @p item's items.
15985     *
15986     * @param obj The menu object
15987     * @return An Eina_List* of @p item's items
15988     */
15989    EAPI const Eina_List   *elm_menu_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15990    /**
15991     * @brief Get the Evas_Object of an Elm_Menu_Item
15992     *
15993     * @param item The menu item object.
15994     * @return The edje object containing the swallowed content
15995     *
15996     * @warning Don't manipulate this object!
15997     */
15998    EAPI Evas_Object       *elm_menu_item_object_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
15999    /**
16000     * @brief Add an item at the end of the given menu widget
16001     *
16002     * @param obj The menu object.
16003     * @param parent The parent menu item (optional)
16004     * @param icon A icon display on the item. The icon will be destryed by the menu.
16005     * @param label The label of the item.
16006     * @param func Function called when the user select the item.
16007     * @param data Data sent by the callback.
16008     * @return Returns the new item.
16009     */
16010    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);
16011    /**
16012     * @brief Add an object swallowed in an item at the end of the given menu
16013     * widget
16014     *
16015     * @param obj The menu object.
16016     * @param parent The parent menu item (optional)
16017     * @param subobj The object to swallow
16018     * @param func Function called when the user select the item.
16019     * @param data Data sent by the callback.
16020     * @return Returns the new item.
16021     *
16022     * Add an evas object as an item to the menu.
16023     */
16024    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);
16025    /**
16026     * @brief Set the label of a menu item
16027     *
16028     * @param item The menu item object.
16029     * @param label The label to set for @p item
16030     *
16031     * @warning Don't use this funcion on items created with
16032     * elm_menu_item_add_object() or elm_menu_item_separator_add().
16033     */
16034    EAPI void               elm_menu_item_label_set(Elm_Menu_Item *item, const char *label) EINA_ARG_NONNULL(1);
16035    /**
16036     * @brief Get the label of a menu item
16037     *
16038     * @param item The menu item object.
16039     * @return The label of @p item
16040     */
16041    EAPI const char        *elm_menu_item_label_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
16042    /**
16043     * @brief Set the icon of a menu item to the standard icon with name @p icon
16044     *
16045     * @param item The menu item object.
16046     * @param icon The icon object to set for the content of @p item
16047     *
16048     * Once this icon is set, any previously set icon will be deleted.
16049     */
16050    EAPI void               elm_menu_item_object_icon_name_set(Elm_Menu_Item *item, const char *icon) EINA_ARG_NONNULL(1, 2);
16051    /**
16052     * @brief Get the string representation from the icon of a menu item
16053     *
16054     * @param item The menu item object.
16055     * @return The string representation of @p item's icon or NULL
16056     *
16057     * @see elm_menu_item_object_icon_name_set()
16058     */
16059    EAPI const char        *elm_menu_item_object_icon_name_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
16060    /**
16061     * @brief Set the content object of a menu item
16062     *
16063     * @param item The menu item object
16064     * @param The content object or NULL
16065     * @return EINA_TRUE on success, else EINA_FALSE
16066     *
16067     * Use this function to change the object swallowed by a menu item, deleting
16068     * any previously swallowed object.
16069     */
16070    EAPI Eina_Bool          elm_menu_item_object_content_set(Elm_Menu_Item *item, Evas_Object *obj) EINA_ARG_NONNULL(1);
16071    /**
16072     * @brief Get the content object of a menu item
16073     *
16074     * @param item The menu item object
16075     * @return The content object or NULL
16076     * @note If @p item was added with elm_menu_item_add_object, this
16077     * function will return the object passed, else it will return the
16078     * icon object.
16079     *
16080     * @see elm_menu_item_object_content_set()
16081     */
16082    EAPI Evas_Object *elm_menu_item_object_content_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
16083    /**
16084     * @brief Set the selected state of @p item.
16085     *
16086     * @param item The menu item object.
16087     * @param selected The selected/unselected state of the item
16088     */
16089    EAPI void               elm_menu_item_selected_set(Elm_Menu_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
16090    /**
16091     * @brief Get the selected state of @p item.
16092     *
16093     * @param item The menu item object.
16094     * @return The selected/unselected state of the item
16095     *
16096     * @see elm_menu_item_selected_set()
16097     */
16098    EAPI Eina_Bool          elm_menu_item_selected_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
16099    /**
16100     * @brief Set the disabled state of @p item.
16101     *
16102     * @param item The menu item object.
16103     * @param disabled The enabled/disabled state of the item
16104     */
16105    EAPI void               elm_menu_item_disabled_set(Elm_Menu_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
16106    /**
16107     * @brief Get the disabled state of @p item.
16108     *
16109     * @param item The menu item object.
16110     * @return The enabled/disabled state of the item
16111     *
16112     * @see elm_menu_item_disabled_set()
16113     */
16114    EAPI Eina_Bool          elm_menu_item_disabled_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
16115    /**
16116     * @brief Add a separator item to menu @p obj under @p parent.
16117     *
16118     * @param obj The menu object
16119     * @param parent The item to add the separator under
16120     * @return The created item or NULL on failure
16121     *
16122     * This is item is a @ref Separator.
16123     */
16124    EAPI Elm_Menu_Item     *elm_menu_item_separator_add(Evas_Object *obj, Elm_Menu_Item *parent) EINA_ARG_NONNULL(1);
16125    /**
16126     * @brief Returns whether @p item is a separator.
16127     *
16128     * @param item The item to check
16129     * @return If true, @p item is a separator
16130     *
16131     * @see elm_menu_item_separator_add()
16132     */
16133    EAPI Eina_Bool          elm_menu_item_is_separator(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
16134    /**
16135     * @brief Deletes an item from the menu.
16136     *
16137     * @param item The item to delete.
16138     *
16139     * @see elm_menu_item_add()
16140     */
16141    EAPI void               elm_menu_item_del(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
16142    /**
16143     * @brief Set the function called when a menu item is deleted.
16144     *
16145     * @param item The item to set the callback on
16146     * @param func The function called
16147     *
16148     * @see elm_menu_item_add()
16149     * @see elm_menu_item_del()
16150     */
16151    EAPI void               elm_menu_item_del_cb_set(Elm_Menu_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
16152    /**
16153     * @brief Returns the data associated with menu item @p item.
16154     *
16155     * @param item The item
16156     * @return The data associated with @p item or NULL if none was set.
16157     *
16158     * This is the data set with elm_menu_add() or elm_menu_item_data_set().
16159     */
16160    EAPI void              *elm_menu_item_data_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
16161    /**
16162     * @brief Sets the data to be associated with menu item @p item.
16163     *
16164     * @param item The item
16165     * @param data The data to be associated with @p item
16166     */
16167    EAPI void               elm_menu_item_data_set(Elm_Menu_Item *item, const void *data) EINA_ARG_NONNULL(1);
16168    /**
16169     * @brief Returns a list of @p item's subitems.
16170     *
16171     * @param item The item
16172     * @return An Eina_List* of @p item's subitems
16173     *
16174     * @see elm_menu_add()
16175     */
16176    EAPI const Eina_List   *elm_menu_item_subitems_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
16177    /**
16178     * @brief Get the position of a menu item
16179     *
16180     * @param item The menu item
16181     * @return The item's index
16182     *
16183     * This function returns the index position of a menu item in a menu.
16184     * For a sub-menu, this number is relative to the first item in the sub-menu.
16185     *
16186     * @note Index values begin with 0
16187     */
16188    EAPI unsigned int       elm_menu_item_index_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
16189    /**
16190     * @brief @brief Return a menu item's owner menu
16191     *
16192     * @param item The menu item
16193     * @return The menu object owning @p item, or NULL on failure
16194     *
16195     * Use this function to get the menu object owning an item.
16196     */
16197    EAPI Evas_Object       *elm_menu_item_menu_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
16198    /**
16199     * @brief Get the selected item in the menu
16200     *
16201     * @param obj The menu object
16202     * @return The selected item, or NULL if none
16203     *
16204     * @see elm_menu_item_selected_get()
16205     * @see elm_menu_item_selected_set()
16206     */
16207    EAPI Elm_Menu_Item *elm_menu_selected_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
16208    /**
16209     * @brief Get the last item in the menu
16210     *
16211     * @param obj The menu object
16212     * @return The last item, or NULL if none
16213     */
16214    EAPI Elm_Menu_Item *elm_menu_last_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
16215    /**
16216     * @brief Get the first item in the menu
16217     *
16218     * @param obj The menu object
16219     * @return The first item, or NULL if none
16220     */
16221    EAPI Elm_Menu_Item *elm_menu_first_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
16222    /**
16223     * @brief Get the next item in the menu.
16224     *
16225     * @param item The menu item object.
16226     * @return The item after it, or NULL if none
16227     */
16228    EAPI Elm_Menu_Item *elm_menu_item_next_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
16229    /**
16230     * @brief Get the previous item in the menu.
16231     *
16232     * @param item The menu item object.
16233     * @return The item before it, or NULL if none
16234     */
16235    EAPI Elm_Menu_Item *elm_menu_item_prev_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
16236    /**
16237     * @}
16238     */
16239
16240    /**
16241     * @defgroup List List
16242     * @ingroup Elementary
16243     *
16244     * @image html img/widget/list/preview-00.png
16245     * @image latex img/widget/list/preview-00.eps width=\textwidth
16246     *
16247     * @image html img/list.png
16248     * @image latex img/list.eps width=\textwidth
16249     *
16250     * A list widget is a container whose children are displayed vertically or
16251     * horizontally, in order, and can be selected.
16252     * The list can accept only one or multiple items selection. Also has many
16253     * modes of items displaying.
16254     *
16255     * A list is a very simple type of list widget.  For more robust
16256     * lists, @ref Genlist should probably be used.
16257     *
16258     * Smart callbacks one can listen to:
16259     * - @c "activated" - The user has double-clicked or pressed
16260     *   (enter|return|spacebar) on an item. The @c event_info parameter
16261     *   is the item that was activated.
16262     * - @c "clicked,double" - The user has double-clicked an item.
16263     *   The @c event_info parameter is the item that was double-clicked.
16264     * - "selected" - when the user selected an item
16265     * - "unselected" - when the user unselected an item
16266     * - "longpressed" - an item in the list is long-pressed
16267     * - "edge,top" - the list is scrolled until the top edge
16268     * - "edge,bottom" - the list is scrolled until the bottom edge
16269     * - "edge,left" - the list is scrolled until the left edge
16270     * - "edge,right" - the list is scrolled until the right edge
16271     * - "language,changed" - the program's language changed
16272     *
16273     * Available styles for it:
16274     * - @c "default"
16275     *
16276     * List of examples:
16277     * @li @ref list_example_01
16278     * @li @ref list_example_02
16279     * @li @ref list_example_03
16280     */
16281
16282    /**
16283     * @addtogroup List
16284     * @{
16285     */
16286
16287    /**
16288     * @enum _Elm_List_Mode
16289     * @typedef Elm_List_Mode
16290     *
16291     * Set list's resize behavior, transverse axis scroll and
16292     * items cropping. See each mode's description for more details.
16293     *
16294     * @note Default value is #ELM_LIST_SCROLL.
16295     *
16296     * Values <b> don't </b> work as bitmask, only one can be choosen.
16297     *
16298     * @see elm_list_mode_set()
16299     * @see elm_list_mode_get()
16300     *
16301     * @ingroup List
16302     */
16303    typedef enum _Elm_List_Mode
16304      {
16305         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. */
16306         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). */
16307         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. */
16308         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. */
16309         ELM_LIST_LAST /**< Indicates error if returned by elm_list_mode_get() */
16310      } Elm_List_Mode;
16311
16312    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().  */
16313
16314    /**
16315     * Add a new list widget to the given parent Elementary
16316     * (container) object.
16317     *
16318     * @param parent The parent object.
16319     * @return a new list widget handle or @c NULL, on errors.
16320     *
16321     * This function inserts a new list widget on the canvas.
16322     *
16323     * @ingroup List
16324     */
16325    EAPI Evas_Object     *elm_list_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16326
16327    /**
16328     * Starts the list.
16329     *
16330     * @param obj The list object
16331     *
16332     * @note Call before running show() on the list object.
16333     * @warning If not called, it won't display the list properly.
16334     *
16335     * @code
16336     * li = elm_list_add(win);
16337     * elm_list_item_append(li, "First", NULL, NULL, NULL, NULL);
16338     * elm_list_item_append(li, "Second", NULL, NULL, NULL, NULL);
16339     * elm_list_go(li);
16340     * evas_object_show(li);
16341     * @endcode
16342     *
16343     * @ingroup List
16344     */
16345    EAPI void             elm_list_go(Evas_Object *obj) EINA_ARG_NONNULL(1);
16346
16347    /**
16348     * Enable or disable multiple items selection on the list object.
16349     *
16350     * @param obj The list object
16351     * @param multi @c EINA_TRUE to enable multi selection or @c EINA_FALSE to
16352     * disable it.
16353     *
16354     * Disabled by default. If disabled, the user can select a single item of
16355     * the list each time. Selected items are highlighted on list.
16356     * If enabled, many items can be selected.
16357     *
16358     * If a selected item is selected again, it will be unselected.
16359     *
16360     * @see elm_list_multi_select_get()
16361     *
16362     * @ingroup List
16363     */
16364    EAPI void             elm_list_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
16365
16366    /**
16367     * Get a value whether multiple items selection is enabled or not.
16368     *
16369     * @see elm_list_multi_select_set() for details.
16370     *
16371     * @param obj The list object.
16372     * @return @c EINA_TRUE means multiple items selection is enabled.
16373     * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
16374     * @c EINA_FALSE is returned.
16375     *
16376     * @ingroup List
16377     */
16378    EAPI Eina_Bool        elm_list_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16379
16380    /**
16381     * Set which mode to use for the list object.
16382     *
16383     * @param obj The list object
16384     * @param mode One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
16385     * #ELM_LIST_LIMIT or #ELM_LIST_EXPAND.
16386     *
16387     * Set list's resize behavior, transverse axis scroll and
16388     * items cropping. See each mode's description for more details.
16389     *
16390     * @note Default value is #ELM_LIST_SCROLL.
16391     *
16392     * Only one can be set, if a previous one was set, it will be changed
16393     * by the new mode set. Bitmask won't work as well.
16394     *
16395     * @see elm_list_mode_get()
16396     *
16397     * @ingroup List
16398     */
16399    EAPI void             elm_list_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
16400
16401    /**
16402     * Get the mode the list is at.
16403     *
16404     * @param obj The list object
16405     * @return One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
16406     * #ELM_LIST_LIMIT, #ELM_LIST_EXPAND or #ELM_LIST_LAST on errors.
16407     *
16408     * @note see elm_list_mode_set() for more information.
16409     *
16410     * @ingroup List
16411     */
16412    EAPI Elm_List_Mode    elm_list_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16413
16414    /**
16415     * Enable or disable horizontal mode on the list object.
16416     *
16417     * @param obj The list object.
16418     * @param horizontal @c EINA_TRUE to enable horizontal or @c EINA_FALSE to
16419     * disable it, i.e., to enable vertical mode.
16420     *
16421     * @note Vertical mode is set by default.
16422     *
16423     * On horizontal mode items are displayed on list from left to right,
16424     * instead of from top to bottom. Also, the list will scroll horizontally.
16425     * Each item will presents left icon on top and right icon, or end, at
16426     * the bottom.
16427     *
16428     * @see elm_list_horizontal_get()
16429     *
16430     * @ingroup List
16431     */
16432    EAPI void             elm_list_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
16433
16434    /**
16435     * Get a value whether horizontal mode is enabled or not.
16436     *
16437     * @param obj The list object.
16438     * @return @c EINA_TRUE means horizontal mode selection is enabled.
16439     * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
16440     * @c EINA_FALSE is returned.
16441     *
16442     * @see elm_list_horizontal_set() for details.
16443     *
16444     * @ingroup List
16445     */
16446    EAPI Eina_Bool        elm_list_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16447
16448    /**
16449     * Enable or disable always select mode on the list object.
16450     *
16451     * @param obj The list object
16452     * @param always_select @c EINA_TRUE to enable always select mode or
16453     * @c EINA_FALSE to disable it.
16454     *
16455     * @note Always select mode is disabled by default.
16456     *
16457     * Default behavior of list items is to only call its callback function
16458     * the first time it's pressed, i.e., when it is selected. If a selected
16459     * item is pressed again, and multi-select is disabled, it won't call
16460     * this function (if multi-select is enabled it will unselect the item).
16461     *
16462     * If always select is enabled, it will call the callback function
16463     * everytime a item is pressed, so it will call when the item is selected,
16464     * and again when a selected item is pressed.
16465     *
16466     * @see elm_list_always_select_mode_get()
16467     * @see elm_list_multi_select_set()
16468     *
16469     * @ingroup List
16470     */
16471    EAPI void             elm_list_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
16472
16473    /**
16474     * Get a value whether always select mode is enabled or not, meaning that
16475     * an item will always call its callback function, even if already selected.
16476     *
16477     * @param obj The list object
16478     * @return @c EINA_TRUE means horizontal mode selection is enabled.
16479     * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
16480     * @c EINA_FALSE is returned.
16481     *
16482     * @see elm_list_always_select_mode_set() for details.
16483     *
16484     * @ingroup List
16485     */
16486    EAPI Eina_Bool        elm_list_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16487
16488    /**
16489     * Set bouncing behaviour when the scrolled content reaches an edge.
16490     *
16491     * Tell the internal scroller object whether it should bounce or not
16492     * when it reaches the respective edges for each axis.
16493     *
16494     * @param obj The list object
16495     * @param h_bounce Whether to bounce or not in the horizontal axis.
16496     * @param v_bounce Whether to bounce or not in the vertical axis.
16497     *
16498     * @see elm_scroller_bounce_set()
16499     *
16500     * @ingroup List
16501     */
16502    EAPI void             elm_list_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
16503
16504    /**
16505     * Get the bouncing behaviour of the internal scroller.
16506     *
16507     * Get whether the internal scroller should bounce when the edge of each
16508     * axis is reached scrolling.
16509     *
16510     * @param obj The list object.
16511     * @param h_bounce Pointer where to store the bounce state of the horizontal
16512     * axis.
16513     * @param v_bounce Pointer where to store the bounce state of the vertical
16514     * axis.
16515     *
16516     * @see elm_scroller_bounce_get()
16517     * @see elm_list_bounce_set()
16518     *
16519     * @ingroup List
16520     */
16521    EAPI void             elm_list_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
16522
16523    /**
16524     * Set the scrollbar policy.
16525     *
16526     * @param obj The list object
16527     * @param policy_h Horizontal scrollbar policy.
16528     * @param policy_v Vertical scrollbar policy.
16529     *
16530     * This sets the scrollbar visibility policy for the given scroller.
16531     * #ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it
16532     * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
16533     * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
16534     * This applies respectively for the horizontal and vertical scrollbars.
16535     *
16536     * The both are disabled by default, i.e., are set to
16537     * #ELM_SCROLLER_POLICY_OFF.
16538     *
16539     * @ingroup List
16540     */
16541    EAPI void             elm_list_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
16542
16543    /**
16544     * Get the scrollbar policy.
16545     *
16546     * @see elm_list_scroller_policy_get() for details.
16547     *
16548     * @param obj The list object.
16549     * @param policy_h Pointer where to store horizontal scrollbar policy.
16550     * @param policy_v Pointer where to store vertical scrollbar policy.
16551     *
16552     * @ingroup List
16553     */
16554    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);
16555
16556    /**
16557     * Append a new item to the list object.
16558     *
16559     * @param obj The list object.
16560     * @param label The label of the list item.
16561     * @param icon The icon object to use for the left side of the item. An
16562     * icon can be any Evas object, but usually it is an icon created
16563     * with elm_icon_add().
16564     * @param end The icon object to use for the right side of the item. An
16565     * icon can be any Evas object.
16566     * @param func The function to call when the item is clicked.
16567     * @param data The data to associate with the item for related callbacks.
16568     *
16569     * @return The created item or @c NULL upon failure.
16570     *
16571     * A new item will be created and appended to the list, i.e., will
16572     * be set as @b last item.
16573     *
16574     * Items created with this method can be deleted with
16575     * elm_list_item_del().
16576     *
16577     * Associated @p data can be properly freed when item is deleted if a
16578     * callback function is set with elm_list_item_del_cb_set().
16579     *
16580     * If a function is passed as argument, it will be called everytime this item
16581     * is selected, i.e., the user clicks over an unselected item.
16582     * If always select is enabled it will call this function every time
16583     * user clicks over an item (already selected or not).
16584     * If such function isn't needed, just passing
16585     * @c NULL as @p func is enough. The same should be done for @p data.
16586     *
16587     * Simple example (with no function callback or data associated):
16588     * @code
16589     * li = elm_list_add(win);
16590     * ic = elm_icon_add(win);
16591     * elm_icon_file_set(ic, "path/to/image", NULL);
16592     * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
16593     * elm_list_item_append(li, "label", ic, NULL, NULL, NULL);
16594     * elm_list_go(li);
16595     * evas_object_show(li);
16596     * @endcode
16597     *
16598     * @see elm_list_always_select_mode_set()
16599     * @see elm_list_item_del()
16600     * @see elm_list_item_del_cb_set()
16601     * @see elm_list_clear()
16602     * @see elm_icon_add()
16603     *
16604     * @ingroup List
16605     */
16606    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);
16607
16608    /**
16609     * Prepend a new item to the list object.
16610     *
16611     * @param obj The list object.
16612     * @param label The label of the list item.
16613     * @param icon The icon object to use for the left side of the item. An
16614     * icon can be any Evas object, but usually it is an icon created
16615     * with elm_icon_add().
16616     * @param end The icon object to use for the right side of the item. An
16617     * icon can be any Evas object.
16618     * @param func The function to call when the item is clicked.
16619     * @param data The data to associate with the item for related callbacks.
16620     *
16621     * @return The created item or @c NULL upon failure.
16622     *
16623     * A new item will be created and prepended to the list, i.e., will
16624     * be set as @b first item.
16625     *
16626     * Items created with this method can be deleted with
16627     * elm_list_item_del().
16628     *
16629     * Associated @p data can be properly freed when item is deleted if a
16630     * callback function is set with elm_list_item_del_cb_set().
16631     *
16632     * If a function is passed as argument, it will be called everytime this item
16633     * is selected, i.e., the user clicks over an unselected item.
16634     * If always select is enabled it will call this function every time
16635     * user clicks over an item (already selected or not).
16636     * If such function isn't needed, just passing
16637     * @c NULL as @p func is enough. The same should be done for @p data.
16638     *
16639     * @see elm_list_item_append() for a simple code example.
16640     * @see elm_list_always_select_mode_set()
16641     * @see elm_list_item_del()
16642     * @see elm_list_item_del_cb_set()
16643     * @see elm_list_clear()
16644     * @see elm_icon_add()
16645     *
16646     * @ingroup List
16647     */
16648    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);
16649
16650    /**
16651     * Insert a new item into the list object before item @p before.
16652     *
16653     * @param obj The list object.
16654     * @param before The list item to insert before.
16655     * @param label The label of the list item.
16656     * @param icon The icon object to use for the left side of the item. An
16657     * icon can be any Evas object, but usually it is an icon created
16658     * with elm_icon_add().
16659     * @param end The icon object to use for the right side of the item. An
16660     * icon can be any Evas object.
16661     * @param func The function to call when the item is clicked.
16662     * @param data The data to associate with the item for related callbacks.
16663     *
16664     * @return The created item or @c NULL upon failure.
16665     *
16666     * A new item will be created and added to the list. Its position in
16667     * this list will be just before item @p before.
16668     *
16669     * Items created with this method can be deleted with
16670     * elm_list_item_del().
16671     *
16672     * Associated @p data can be properly freed when item is deleted if a
16673     * callback function is set with elm_list_item_del_cb_set().
16674     *
16675     * If a function is passed as argument, it will be called everytime this item
16676     * is selected, i.e., the user clicks over an unselected item.
16677     * If always select is enabled it will call this function every time
16678     * user clicks over an item (already selected or not).
16679     * If such function isn't needed, just passing
16680     * @c NULL as @p func is enough. The same should be done for @p data.
16681     *
16682     * @see elm_list_item_append() for a simple code example.
16683     * @see elm_list_always_select_mode_set()
16684     * @see elm_list_item_del()
16685     * @see elm_list_item_del_cb_set()
16686     * @see elm_list_clear()
16687     * @see elm_icon_add()
16688     *
16689     * @ingroup List
16690     */
16691    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);
16692
16693    /**
16694     * Insert a new item into the list object after item @p after.
16695     *
16696     * @param obj The list object.
16697     * @param after The list item to insert after.
16698     * @param label The label of the list item.
16699     * @param icon The icon object to use for the left side of the item. An
16700     * icon can be any Evas object, but usually it is an icon created
16701     * with elm_icon_add().
16702     * @param end The icon object to use for the right side of the item. An
16703     * icon can be any Evas object.
16704     * @param func The function to call when the item is clicked.
16705     * @param data The data to associate with the item for related callbacks.
16706     *
16707     * @return The created item or @c NULL upon failure.
16708     *
16709     * A new item will be created and added to the list. Its position in
16710     * this list will be just after item @p after.
16711     *
16712     * Items created with this method can be deleted with
16713     * elm_list_item_del().
16714     *
16715     * Associated @p data can be properly freed when item is deleted if a
16716     * callback function is set with elm_list_item_del_cb_set().
16717     *
16718     * If a function is passed as argument, it will be called everytime this item
16719     * is selected, i.e., the user clicks over an unselected item.
16720     * If always select is enabled it will call this function every time
16721     * user clicks over an item (already selected or not).
16722     * If such function isn't needed, just passing
16723     * @c NULL as @p func is enough. The same should be done for @p data.
16724     *
16725     * @see elm_list_item_append() for a simple code example.
16726     * @see elm_list_always_select_mode_set()
16727     * @see elm_list_item_del()
16728     * @see elm_list_item_del_cb_set()
16729     * @see elm_list_clear()
16730     * @see elm_icon_add()
16731     *
16732     * @ingroup List
16733     */
16734    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);
16735
16736    /**
16737     * Insert a new item into the sorted list object.
16738     *
16739     * @param obj The list object.
16740     * @param label The label of the list item.
16741     * @param icon The icon object to use for the left side of the item. An
16742     * icon can be any Evas object, but usually it is an icon created
16743     * with elm_icon_add().
16744     * @param end The icon object to use for the right side of the item. An
16745     * icon can be any Evas object.
16746     * @param func The function to call when the item is clicked.
16747     * @param data The data to associate with the item for related callbacks.
16748     * @param cmp_func The comparing function to be used to sort list
16749     * items <b>by #Elm_List_Item item handles</b>. This function will
16750     * receive two items and compare them, returning a non-negative integer
16751     * if the second item should be place after the first, or negative value
16752     * if should be placed before.
16753     *
16754     * @return The created item or @c NULL upon failure.
16755     *
16756     * @note This function inserts values into a list object assuming it was
16757     * sorted and the result will be sorted.
16758     *
16759     * A new item will be created and added to the list. Its position in
16760     * this list will be found comparing the new item with previously inserted
16761     * items using function @p cmp_func.
16762     *
16763     * Items created with this method can be deleted with
16764     * elm_list_item_del().
16765     *
16766     * Associated @p data can be properly freed when item is deleted if a
16767     * callback function is set with elm_list_item_del_cb_set().
16768     *
16769     * If a function is passed as argument, it will be called everytime this item
16770     * is selected, i.e., the user clicks over an unselected item.
16771     * If always select is enabled it will call this function every time
16772     * user clicks over an item (already selected or not).
16773     * If such function isn't needed, just passing
16774     * @c NULL as @p func is enough. The same should be done for @p data.
16775     *
16776     * @see elm_list_item_append() for a simple code example.
16777     * @see elm_list_always_select_mode_set()
16778     * @see elm_list_item_del()
16779     * @see elm_list_item_del_cb_set()
16780     * @see elm_list_clear()
16781     * @see elm_icon_add()
16782     *
16783     * @ingroup List
16784     */
16785    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);
16786
16787    /**
16788     * Remove all list's items.
16789     *
16790     * @param obj The list object
16791     *
16792     * @see elm_list_item_del()
16793     * @see elm_list_item_append()
16794     *
16795     * @ingroup List
16796     */
16797    EAPI void             elm_list_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
16798
16799    /**
16800     * Get a list of all the list items.
16801     *
16802     * @param obj The list object
16803     * @return An @c Eina_List of list items, #Elm_List_Item,
16804     * or @c NULL on failure.
16805     *
16806     * @see elm_list_item_append()
16807     * @see elm_list_item_del()
16808     * @see elm_list_clear()
16809     *
16810     * @ingroup List
16811     */
16812    EAPI const Eina_List *elm_list_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16813
16814    /**
16815     * Get the selected item.
16816     *
16817     * @param obj The list object.
16818     * @return The selected list item.
16819     *
16820     * The selected item can be unselected with function
16821     * elm_list_item_selected_set().
16822     *
16823     * The selected item always will be highlighted on list.
16824     *
16825     * @see elm_list_selected_items_get()
16826     *
16827     * @ingroup List
16828     */
16829    EAPI Elm_List_Item   *elm_list_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16830
16831    /**
16832     * Return a list of the currently selected list items.
16833     *
16834     * @param obj The list object.
16835     * @return An @c Eina_List of list items, #Elm_List_Item,
16836     * or @c NULL on failure.
16837     *
16838     * Multiple items can be selected if multi select is enabled. It can be
16839     * done with elm_list_multi_select_set().
16840     *
16841     * @see elm_list_selected_item_get()
16842     * @see elm_list_multi_select_set()
16843     *
16844     * @ingroup List
16845     */
16846    EAPI const Eina_List *elm_list_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16847
16848    /**
16849     * Set the selected state of an item.
16850     *
16851     * @param item The list item
16852     * @param selected The selected state
16853     *
16854     * This sets the selected state of the given item @p it.
16855     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
16856     *
16857     * If a new item is selected the previosly selected will be unselected,
16858     * unless multiple selection is enabled with elm_list_multi_select_set().
16859     * Previoulsy selected item can be get with function
16860     * elm_list_selected_item_get().
16861     *
16862     * Selected items will be highlighted.
16863     *
16864     * @see elm_list_item_selected_get()
16865     * @see elm_list_selected_item_get()
16866     * @see elm_list_multi_select_set()
16867     *
16868     * @ingroup List
16869     */
16870    EAPI void             elm_list_item_selected_set(Elm_List_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
16871
16872    /*
16873     * Get whether the @p item is selected or not.
16874     *
16875     * @param item The list item.
16876     * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
16877     * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
16878     *
16879     * @see elm_list_selected_item_set() for details.
16880     * @see elm_list_item_selected_get()
16881     *
16882     * @ingroup List
16883     */
16884    EAPI Eina_Bool        elm_list_item_selected_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16885
16886    /**
16887     * Set or unset item as a separator.
16888     *
16889     * @param it The list item.
16890     * @param setting @c EINA_TRUE to set item @p it as separator or
16891     * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
16892     *
16893     * Items aren't set as separator by default.
16894     *
16895     * If set as separator it will display separator theme, so won't display
16896     * icons or label.
16897     *
16898     * @see elm_list_item_separator_get()
16899     *
16900     * @ingroup List
16901     */
16902    EAPI void             elm_list_item_separator_set(Elm_List_Item *it, Eina_Bool setting) EINA_ARG_NONNULL(1);
16903
16904    /**
16905     * Get a value whether item is a separator or not.
16906     *
16907     * @see elm_list_item_separator_set() for details.
16908     *
16909     * @param it The list item.
16910     * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
16911     * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
16912     *
16913     * @ingroup List
16914     */
16915    EAPI Eina_Bool        elm_list_item_separator_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
16916
16917    /**
16918     * Show @p item in the list view.
16919     *
16920     * @param item The list item to be shown.
16921     *
16922     * It won't animate list until item is visible. If such behavior is wanted,
16923     * use elm_list_bring_in() intead.
16924     *
16925     * @ingroup List
16926     */
16927    EAPI void             elm_list_item_show(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16928
16929    /**
16930     * Bring in the given item to list view.
16931     *
16932     * @param item The item.
16933     *
16934     * This causes list to jump to the given item @p item and show it
16935     * (by scrolling), if it is not fully visible.
16936     *
16937     * This may use animation to do so and take a period of time.
16938     *
16939     * If animation isn't wanted, elm_list_item_show() can be used.
16940     *
16941     * @ingroup List
16942     */
16943    EAPI void             elm_list_item_bring_in(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16944
16945    /**
16946     * Delete them item from the list.
16947     *
16948     * @param item The item of list to be deleted.
16949     *
16950     * If deleting all list items is required, elm_list_clear()
16951     * should be used instead of getting items list and deleting each one.
16952     *
16953     * @see elm_list_clear()
16954     * @see elm_list_item_append()
16955     * @see elm_list_item_del_cb_set()
16956     *
16957     * @ingroup List
16958     */
16959    EAPI void             elm_list_item_del(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16960
16961    /**
16962     * Set the function called when a list item is freed.
16963     *
16964     * @param item The item to set the callback on
16965     * @param func The function called
16966     *
16967     * If there is a @p func, then it will be called prior item's memory release.
16968     * That will be called with the following arguments:
16969     * @li item's data;
16970     * @li item's Evas object;
16971     * @li item itself;
16972     *
16973     * This way, a data associated to a list item could be properly freed.
16974     *
16975     * @ingroup List
16976     */
16977    EAPI void             elm_list_item_del_cb_set(Elm_List_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
16978
16979    /**
16980     * Get the data associated to the item.
16981     *
16982     * @param item The list item
16983     * @return The data associated to @p item
16984     *
16985     * The return value is a pointer to data associated to @p item when it was
16986     * created, with function elm_list_item_append() or similar. If no data
16987     * was passed as argument, it will return @c NULL.
16988     *
16989     * @see elm_list_item_append()
16990     *
16991     * @ingroup List
16992     */
16993    EAPI void            *elm_list_item_data_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16994
16995    /**
16996     * Get the left side icon associated to the item.
16997     *
16998     * @param item The list item
16999     * @return The left side icon associated to @p item
17000     *
17001     * The return value is a pointer to the icon associated to @p item when
17002     * it was
17003     * created, with function elm_list_item_append() or similar, or later
17004     * with function elm_list_item_icon_set(). If no icon
17005     * was passed as argument, it will return @c NULL.
17006     *
17007     * @see elm_list_item_append()
17008     * @see elm_list_item_icon_set()
17009     *
17010     * @ingroup List
17011     */
17012    EAPI Evas_Object     *elm_list_item_icon_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17013
17014    /**
17015     * Set the left side icon associated to the item.
17016     *
17017     * @param item The list item
17018     * @param icon The left side icon object to associate with @p item
17019     *
17020     * The icon object to use at left side of the item. An
17021     * icon can be any Evas object, but usually it is an icon created
17022     * with elm_icon_add().
17023     *
17024     * Once the icon object is set, a previously set one will be deleted.
17025     * @warning Setting the same icon for two items will cause the icon to
17026     * dissapear from the first item.
17027     *
17028     * If an icon was passed as argument on item creation, with function
17029     * elm_list_item_append() or similar, it will be already
17030     * associated to the item.
17031     *
17032     * @see elm_list_item_append()
17033     * @see elm_list_item_icon_get()
17034     *
17035     * @ingroup List
17036     */
17037    EAPI void             elm_list_item_icon_set(Elm_List_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
17038
17039    /**
17040     * Get the right side icon associated to the item.
17041     *
17042     * @param item The list item
17043     * @return The right side icon associated to @p item
17044     *
17045     * The return value is a pointer to the icon associated to @p item when
17046     * it was
17047     * created, with function elm_list_item_append() or similar, or later
17048     * with function elm_list_item_icon_set(). If no icon
17049     * was passed as argument, it will return @c NULL.
17050     *
17051     * @see elm_list_item_append()
17052     * @see elm_list_item_icon_set()
17053     *
17054     * @ingroup List
17055     */
17056    EAPI Evas_Object     *elm_list_item_end_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17057
17058    /**
17059     * Set the right side icon associated to the item.
17060     *
17061     * @param item The list item
17062     * @param end The right side icon object to associate with @p item
17063     *
17064     * The icon object to use at right side of the item. An
17065     * icon can be any Evas object, but usually it is an icon created
17066     * with elm_icon_add().
17067     *
17068     * Once the icon object is set, a previously set one will be deleted.
17069     * @warning Setting the same icon for two items will cause the icon to
17070     * dissapear from the first item.
17071     *
17072     * If an icon was passed as argument on item creation, with function
17073     * elm_list_item_append() or similar, it will be already
17074     * associated to the item.
17075     *
17076     * @see elm_list_item_append()
17077     * @see elm_list_item_end_get()
17078     *
17079     * @ingroup List
17080     */
17081    EAPI void             elm_list_item_end_set(Elm_List_Item *item, Evas_Object *end) EINA_ARG_NONNULL(1);
17082
17083    /**
17084     * Gets the base object of the item.
17085     *
17086     * @param item The list item
17087     * @return The base object associated with @p item
17088     *
17089     * Base object is the @c Evas_Object that represents that item.
17090     *
17091     * @ingroup List
17092     */
17093    EAPI Evas_Object     *elm_list_item_object_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17094    EINA_DEPRECATED EAPI Evas_Object     *elm_list_item_base_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17095
17096    /**
17097     * Get the label of item.
17098     *
17099     * @param item The item of list.
17100     * @return The label of item.
17101     *
17102     * The return value is a pointer to the label associated to @p item when
17103     * it was created, with function elm_list_item_append(), or later
17104     * with function elm_list_item_label_set. If no label
17105     * was passed as argument, it will return @c NULL.
17106     *
17107     * @see elm_list_item_label_set() for more details.
17108     * @see elm_list_item_append()
17109     *
17110     * @ingroup List
17111     */
17112    EAPI const char      *elm_list_item_label_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17113
17114    /**
17115     * Set the label of item.
17116     *
17117     * @param item The item of list.
17118     * @param text The label of item.
17119     *
17120     * The label to be displayed by the item.
17121     * Label will be placed between left and right side icons (if set).
17122     *
17123     * If a label was passed as argument on item creation, with function
17124     * elm_list_item_append() or similar, it will be already
17125     * displayed by the item.
17126     *
17127     * @see elm_list_item_label_get()
17128     * @see elm_list_item_append()
17129     *
17130     * @ingroup List
17131     */
17132    EAPI void             elm_list_item_label_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
17133
17134
17135    /**
17136     * Get the item before @p it in list.
17137     *
17138     * @param it The list item.
17139     * @return The item before @p it, or @c NULL if none or on failure.
17140     *
17141     * @note If it is the first item, @c NULL will be returned.
17142     *
17143     * @see elm_list_item_append()
17144     * @see elm_list_items_get()
17145     *
17146     * @ingroup List
17147     */
17148    EAPI Elm_List_Item   *elm_list_item_prev(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
17149
17150    /**
17151     * Get the item after @p it in list.
17152     *
17153     * @param it The list item.
17154     * @return The item after @p it, or @c NULL if none or on failure.
17155     *
17156     * @note If it is the last item, @c NULL will be returned.
17157     *
17158     * @see elm_list_item_append()
17159     * @see elm_list_items_get()
17160     *
17161     * @ingroup List
17162     */
17163    EAPI Elm_List_Item   *elm_list_item_next(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
17164
17165    /**
17166     * Sets the disabled/enabled state of a list item.
17167     *
17168     * @param it The item.
17169     * @param disabled The disabled state.
17170     *
17171     * A disabled item cannot be selected or unselected. It will also
17172     * change its appearance (generally greyed out). This sets the
17173     * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
17174     * enabled).
17175     *
17176     * @ingroup List
17177     */
17178    EAPI void             elm_list_item_disabled_set(Elm_List_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
17179
17180    /**
17181     * Get a value whether list item is disabled or not.
17182     *
17183     * @param it The item.
17184     * @return The disabled state.
17185     *
17186     * @see elm_list_item_disabled_set() for more details.
17187     *
17188     * @ingroup List
17189     */
17190    EAPI Eina_Bool        elm_list_item_disabled_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
17191
17192    /**
17193     * Set the text to be shown in a given list item's tooltips.
17194     *
17195     * @param item Target item.
17196     * @param text The text to set in the content.
17197     *
17198     * Setup the text as tooltip to object. The item can have only one tooltip,
17199     * so any previous tooltip data - set with this function or
17200     * elm_list_item_tooltip_content_cb_set() - is removed.
17201     *
17202     * @see elm_object_tooltip_text_set() for more details.
17203     *
17204     * @ingroup List
17205     */
17206    EAPI void             elm_list_item_tooltip_text_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
17207
17208
17209    /**
17210     * @brief Disable size restrictions on an object's tooltip
17211     * @param item The tooltip's anchor object
17212     * @param disable If EINA_TRUE, size restrictions are disabled
17213     * @return EINA_FALSE on failure, EINA_TRUE on success
17214     *
17215     * This function allows a tooltip to expand beyond its parant window's canvas.
17216     * It will instead be limited only by the size of the display.
17217     */
17218    EAPI Eina_Bool        elm_list_item_tooltip_size_restrict_disable(Elm_List_Item *item, Eina_Bool disable) EINA_ARG_NONNULL(1);
17219    /**
17220     * @brief Retrieve size restriction state of an object's tooltip
17221     * @param obj The tooltip's anchor object
17222     * @return If EINA_TRUE, size restrictions are disabled
17223     *
17224     * This function returns whether a tooltip is allowed to expand beyond
17225     * its parant window's canvas.
17226     * It will instead be limited only by the size of the display.
17227     */
17228    EAPI Eina_Bool        elm_list_item_tooltip_size_restrict_disabled_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17229
17230    /**
17231     * Set the content to be shown in the tooltip item.
17232     *
17233     * Setup the tooltip to item. The item can have only one tooltip,
17234     * so any previous tooltip data is removed. @p func(with @p data) will
17235     * be called every time that need show the tooltip and it should
17236     * return a valid Evas_Object. This object is then managed fully by
17237     * tooltip system and is deleted when the tooltip is gone.
17238     *
17239     * @param item the list item being attached a tooltip.
17240     * @param func the function used to create the tooltip contents.
17241     * @param data what to provide to @a func as callback data/context.
17242     * @param del_cb called when data is not needed anymore, either when
17243     *        another callback replaces @a func, the tooltip is unset with
17244     *        elm_list_item_tooltip_unset() or the owner @a item
17245     *        dies. This callback receives as the first parameter the
17246     *        given @a data, and @c event_info is the item.
17247     *
17248     * @see elm_object_tooltip_content_cb_set() for more details.
17249     *
17250     * @ingroup List
17251     */
17252    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);
17253
17254    /**
17255     * Unset tooltip from item.
17256     *
17257     * @param item list item to remove previously set tooltip.
17258     *
17259     * Remove tooltip from item. The callback provided as del_cb to
17260     * elm_list_item_tooltip_content_cb_set() will be called to notify
17261     * it is not used anymore.
17262     *
17263     * @see elm_object_tooltip_unset() for more details.
17264     * @see elm_list_item_tooltip_content_cb_set()
17265     *
17266     * @ingroup List
17267     */
17268    EAPI void             elm_list_item_tooltip_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
17269
17270    /**
17271     * Sets a different style for this item tooltip.
17272     *
17273     * @note before you set a style you should define a tooltip with
17274     *       elm_list_item_tooltip_content_cb_set() or
17275     *       elm_list_item_tooltip_text_set()
17276     *
17277     * @param item list item with tooltip already set.
17278     * @param style the theme style to use (default, transparent, ...)
17279     *
17280     * @see elm_object_tooltip_style_set() for more details.
17281     *
17282     * @ingroup List
17283     */
17284    EAPI void             elm_list_item_tooltip_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
17285
17286    /**
17287     * Get the style for this item tooltip.
17288     *
17289     * @param item list item with tooltip already set.
17290     * @return style the theme style in use, defaults to "default". If the
17291     *         object does not have a tooltip set, then NULL is returned.
17292     *
17293     * @see elm_object_tooltip_style_get() for more details.
17294     * @see elm_list_item_tooltip_style_set()
17295     *
17296     * @ingroup List
17297     */
17298    EAPI const char      *elm_list_item_tooltip_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17299
17300    /**
17301     * Set the type of mouse pointer/cursor decoration to be shown,
17302     * when the mouse pointer is over the given list widget item
17303     *
17304     * @param item list item to customize cursor on
17305     * @param cursor the cursor type's name
17306     *
17307     * This function works analogously as elm_object_cursor_set(), but
17308     * here the cursor's changing area is restricted to the item's
17309     * area, and not the whole widget's. Note that that item cursors
17310     * have precedence over widget cursors, so that a mouse over an
17311     * item with custom cursor set will always show @b that cursor.
17312     *
17313     * If this function is called twice for an object, a previously set
17314     * cursor will be unset on the second call.
17315     *
17316     * @see elm_object_cursor_set()
17317     * @see elm_list_item_cursor_get()
17318     * @see elm_list_item_cursor_unset()
17319     *
17320     * @ingroup List
17321     */
17322    EAPI void             elm_list_item_cursor_set(Elm_List_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
17323
17324    /*
17325     * Get the type of mouse pointer/cursor decoration set to be shown,
17326     * when the mouse pointer is over the given list widget item
17327     *
17328     * @param item list item with custom cursor set
17329     * @return the cursor type's name or @c NULL, if no custom cursors
17330     * were set to @p item (and on errors)
17331     *
17332     * @see elm_object_cursor_get()
17333     * @see elm_list_item_cursor_set()
17334     * @see elm_list_item_cursor_unset()
17335     *
17336     * @ingroup List
17337     */
17338    EAPI const char      *elm_list_item_cursor_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17339
17340    /**
17341     * Unset any custom mouse pointer/cursor decoration set to be
17342     * shown, when the mouse pointer is over the given list widget
17343     * item, thus making it show the @b default cursor again.
17344     *
17345     * @param item a list item
17346     *
17347     * Use this call to undo any custom settings on this item's cursor
17348     * decoration, bringing it back to defaults (no custom style set).
17349     *
17350     * @see elm_object_cursor_unset()
17351     * @see elm_list_item_cursor_set()
17352     *
17353     * @ingroup List
17354     */
17355    EAPI void             elm_list_item_cursor_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
17356
17357    /**
17358     * Set a different @b style for a given custom cursor set for a
17359     * list item.
17360     *
17361     * @param item list item with custom cursor set
17362     * @param style the <b>theme style</b> to use (e.g. @c "default",
17363     * @c "transparent", etc)
17364     *
17365     * This function only makes sense when one is using custom mouse
17366     * cursor decorations <b>defined in a theme file</b>, which can have,
17367     * given a cursor name/type, <b>alternate styles</b> on it. It
17368     * works analogously as elm_object_cursor_style_set(), but here
17369     * applyed only to list item objects.
17370     *
17371     * @warning Before you set a cursor style you should have definen a
17372     *       custom cursor previously on the item, with
17373     *       elm_list_item_cursor_set()
17374     *
17375     * @see elm_list_item_cursor_engine_only_set()
17376     * @see elm_list_item_cursor_style_get()
17377     *
17378     * @ingroup List
17379     */
17380    EAPI void             elm_list_item_cursor_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
17381
17382    /**
17383     * Get the current @b style set for a given list item's custom
17384     * cursor
17385     *
17386     * @param item list item with custom cursor set.
17387     * @return style the cursor style in use. If the object does not
17388     *         have a cursor set, then @c NULL is returned.
17389     *
17390     * @see elm_list_item_cursor_style_set() for more details
17391     *
17392     * @ingroup List
17393     */
17394    EAPI const char      *elm_list_item_cursor_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17395
17396    /**
17397     * Set if the (custom)cursor for a given list item should be
17398     * searched in its theme, also, or should only rely on the
17399     * rendering engine.
17400     *
17401     * @param item item with custom (custom) cursor already set on
17402     * @param engine_only Use @c EINA_TRUE to have cursors looked for
17403     * only on those provided by the rendering engine, @c EINA_FALSE to
17404     * have them searched on the widget's theme, as well.
17405     *
17406     * @note This call is of use only if you've set a custom cursor
17407     * for list items, with elm_list_item_cursor_set().
17408     *
17409     * @note By default, cursors will only be looked for between those
17410     * provided by the rendering engine.
17411     *
17412     * @ingroup List
17413     */
17414    EAPI void             elm_list_item_cursor_engine_only_set(Elm_List_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
17415
17416    /**
17417     * Get if the (custom) cursor for a given list item is being
17418     * searched in its theme, also, or is only relying on the rendering
17419     * engine.
17420     *
17421     * @param item a list item
17422     * @return @c EINA_TRUE, if cursors are being looked for only on
17423     * those provided by the rendering engine, @c EINA_FALSE if they
17424     * are being searched on the widget's theme, as well.
17425     *
17426     * @see elm_list_item_cursor_engine_only_set(), for more details
17427     *
17428     * @ingroup List
17429     */
17430    EAPI Eina_Bool        elm_list_item_cursor_engine_only_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17431
17432    /**
17433     * @}
17434     */
17435
17436    /**
17437     * @defgroup Slider Slider
17438     * @ingroup Elementary
17439     *
17440     * @image html img/widget/slider/preview-00.png
17441     * @image latex img/widget/slider/preview-00.eps width=\textwidth
17442     *
17443     * The slider adds a dragable “slider” widget for selecting the value of
17444     * something within a range.
17445     *
17446     * A slider can be horizontal or vertical. It can contain an Icon and has a
17447     * primary label as well as a units label (that is formatted with floating
17448     * point values and thus accepts a printf-style format string, like
17449     * “%1.2f units”. There is also an indicator string that may be somewhere
17450     * else (like on the slider itself) that also accepts a format string like
17451     * units. Label, Icon Unit and Indicator strings/objects are optional.
17452     *
17453     * A slider may be inverted which means values invert, with high vales being
17454     * on the left or top and low values on the right or bottom (as opposed to
17455     * normally being low on the left or top and high on the bottom and right).
17456     *
17457     * The slider should have its minimum and maximum values set by the
17458     * application with  elm_slider_min_max_set() and value should also be set by
17459     * the application before use with  elm_slider_value_set(). The span of the
17460     * slider is its length (horizontally or vertically). This will be scaled by
17461     * the object or applications scaling factor. At any point code can query the
17462     * slider for its value with elm_slider_value_get().
17463     *
17464     * Smart callbacks one can listen to:
17465     * - "changed" - Whenever the slider value is changed by the user.
17466     * - "slider,drag,start" - dragging the slider indicator around has started.
17467     * - "slider,drag,stop" - dragging the slider indicator around has stopped.
17468     * - "delay,changed" - A short time after the value is changed by the user.
17469     * This will be called only when the user stops dragging for
17470     * a very short period or when they release their
17471     * finger/mouse, so it avoids possibly expensive reactions to
17472     * the value change.
17473     *
17474     * Available styles for it:
17475     * - @c "default"
17476     *
17477     * Default contents parts of the slider widget that you can use for are:
17478     * @li "icon" - A icon of the slider
17479     * @li "end" - A end part content of the slider
17480     * 
17481     * Default text parts of the silder widget that you can use for are:
17482     * @li "default" - Label of the silder
17483     * Here is an example on its usage:
17484     * @li @ref slider_example
17485     */
17486
17487    /**
17488     * @addtogroup Slider
17489     * @{
17490     */
17491
17492    /**
17493     * Add a new slider widget to the given parent Elementary
17494     * (container) object.
17495     *
17496     * @param parent The parent object.
17497     * @return a new slider widget handle or @c NULL, on errors.
17498     *
17499     * This function inserts a new slider widget on the canvas.
17500     *
17501     * @ingroup Slider
17502     */
17503    EAPI Evas_Object       *elm_slider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17504
17505    /**
17506     * Set the label of a given slider widget
17507     *
17508     * @param obj The progress bar object
17509     * @param label The text label string, in UTF-8
17510     *
17511     * @ingroup Slider
17512     * @deprecated use elm_object_text_set() instead.
17513     */
17514    EINA_DEPRECATED EAPI void               elm_slider_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
17515
17516    /**
17517     * Get the label of a given slider widget
17518     *
17519     * @param obj The progressbar object
17520     * @return The text label string, in UTF-8
17521     *
17522     * @ingroup Slider
17523     * @deprecated use elm_object_text_get() instead.
17524     */
17525    WILL_DEPRECATE  EAPI const char        *elm_slider_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17526
17527    /**
17528     * Set the icon object of the slider object.
17529     *
17530     * @param obj The slider object.
17531     * @param icon The icon object.
17532     *
17533     * On horizontal mode, icon is placed at left, and on vertical mode,
17534     * placed at top.
17535     *
17536     * @note Once the icon object is set, a previously set one will be deleted.
17537     * If you want to keep that old content object, use the
17538     * elm_slider_icon_unset() function.
17539     *
17540     * @warning If the object being set does not have minimum size hints set,
17541     * it won't get properly displayed.
17542     *
17543     * @ingroup Slider
17544     * @deprecated use elm_object_part_content_set() instead.
17545     */
17546    WILL_DEPRECATE  EAPI void               elm_slider_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
17547
17548    /**
17549     * Unset an icon set on a given slider widget.
17550     *
17551     * @param obj The slider object.
17552     * @return The icon object that was being used, if any was set, or
17553     * @c NULL, otherwise (and on errors).
17554     *
17555     * On horizontal mode, icon is placed at left, and on vertical mode,
17556     * placed at top.
17557     *
17558     * This call will unparent and return the icon object which was set
17559     * for this widget, previously, on success.
17560     *
17561     * @see elm_slider_icon_set() for more details
17562     * @see elm_slider_icon_get()
17563     * @deprecated use elm_object_part_content_unset() instead.
17564     *
17565     * @ingroup Slider
17566     */
17567    WILL_DEPRECATE  EAPI Evas_Object       *elm_slider_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
17568
17569    /**
17570     * Retrieve the icon object set for a given slider widget.
17571     *
17572     * @param obj The slider object.
17573     * @return The icon object's handle, if @p obj had one set, or @c NULL,
17574     * otherwise (and on errors).
17575     *
17576     * On horizontal mode, icon is placed at left, and on vertical mode,
17577     * placed at top.
17578     *
17579     * @see elm_slider_icon_set() for more details
17580     * @see elm_slider_icon_unset()
17581     *
17582     * @deprecated use elm_object_part_content_get() instead.
17583     *
17584     * @ingroup Slider
17585     */
17586    WILL_DEPRECATE  EAPI Evas_Object       *elm_slider_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17587
17588    /**
17589     * Set the end object of the slider object.
17590     *
17591     * @param obj The slider object.
17592     * @param end The end object.
17593     *
17594     * On horizontal mode, end is placed at left, and on vertical mode,
17595     * placed at bottom.
17596     *
17597     * @note Once the icon object is set, a previously set one will be deleted.
17598     * If you want to keep that old content object, use the
17599     * elm_slider_end_unset() function.
17600     *
17601     * @warning If the object being set does not have minimum size hints set,
17602     * it won't get properly displayed.
17603     *
17604     * @deprecated use elm_object_part_content_set() instead.
17605     *
17606     * @ingroup Slider
17607     */
17608    WILL_DEPRECATE  EAPI void               elm_slider_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1);
17609
17610    /**
17611     * Unset an end object set on a given slider widget.
17612     *
17613     * @param obj The slider object.
17614     * @return The end object that was being used, if any was set, or
17615     * @c NULL, otherwise (and on errors).
17616     *
17617     * On horizontal mode, end is placed at left, and on vertical mode,
17618     * placed at bottom.
17619     *
17620     * This call will unparent and return the icon object which was set
17621     * for this widget, previously, on success.
17622     *
17623     * @see elm_slider_end_set() for more details.
17624     * @see elm_slider_end_get()
17625     *
17626     * @deprecated use elm_object_part_content_unset() instead
17627     * instead.
17628     *
17629     * @ingroup Slider
17630     */
17631    WILL_DEPRECATE  EAPI Evas_Object       *elm_slider_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
17632
17633    /**
17634     * Retrieve the end object set for a given slider widget.
17635     *
17636     * @param obj The slider object.
17637     * @return The end object's handle, if @p obj had one set, or @c NULL,
17638     * otherwise (and on errors).
17639     *
17640     * On horizontal mode, icon is placed at right, and on vertical mode,
17641     * placed at bottom.
17642     *
17643     * @see elm_slider_end_set() for more details.
17644     * @see elm_slider_end_unset()
17645     *
17646     *
17647     * @deprecated use elm_object_part_content_get() instead 
17648     * instead.
17649     *
17650     * @ingroup Slider
17651     */
17652    WILL_DEPRECATE  EAPI Evas_Object       *elm_slider_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17653
17654    /**
17655     * Set the (exact) length of the bar region of a given slider widget.
17656     *
17657     * @param obj The slider object.
17658     * @param size The length of the slider's bar region.
17659     *
17660     * This sets the minimum width (when in horizontal mode) or height
17661     * (when in vertical mode) of the actual bar area of the slider
17662     * @p obj. This in turn affects the object's minimum size. Use
17663     * this when you're not setting other size hints expanding on the
17664     * given direction (like weight and alignment hints) and you would
17665     * like it to have a specific size.
17666     *
17667     * @note Icon, end, label, indicator and unit text around @p obj
17668     * will require their
17669     * own space, which will make @p obj to require more the @p size,
17670     * actually.
17671     *
17672     * @see elm_slider_span_size_get()
17673     *
17674     * @ingroup Slider
17675     */
17676    EAPI void               elm_slider_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
17677
17678    /**
17679     * Get the length set for the bar region of a given slider widget
17680     *
17681     * @param obj The slider object.
17682     * @return The length of the slider's bar region.
17683     *
17684     * If that size was not set previously, with
17685     * elm_slider_span_size_set(), this call will return @c 0.
17686     *
17687     * @ingroup Slider
17688     */
17689    EAPI Evas_Coord         elm_slider_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17690
17691    /**
17692     * Set the format string for the unit label.
17693     *
17694     * @param obj The slider object.
17695     * @param format The format string for the unit display.
17696     *
17697     * Unit label is displayed all the time, if set, after slider's bar.
17698     * In horizontal mode, at right and in vertical mode, at bottom.
17699     *
17700     * If @c NULL, unit label won't be visible. If not it sets the format
17701     * string for the label text. To the label text is provided a floating point
17702     * value, so the label text can display up to 1 floating point value.
17703     * Note that this is optional.
17704     *
17705     * Use a format string such as "%1.2f meters" for example, and it will
17706     * display values like: "3.14 meters" for a value equal to 3.14159.
17707     *
17708     * Default is unit label disabled.
17709     *
17710     * @see elm_slider_indicator_format_get()
17711     *
17712     * @ingroup Slider
17713     */
17714    EAPI void               elm_slider_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
17715
17716    /**
17717     * Get the unit label format of the slider.
17718     *
17719     * @param obj The slider object.
17720     * @return The unit label format string in UTF-8.
17721     *
17722     * Unit label is displayed all the time, if set, after slider's bar.
17723     * In horizontal mode, at right and in vertical mode, at bottom.
17724     *
17725     * @see elm_slider_unit_format_set() for more
17726     * information on how this works.
17727     *
17728     * @ingroup Slider
17729     */
17730    EAPI const char        *elm_slider_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17731
17732    /**
17733     * Set the format string for the indicator label.
17734     *
17735     * @param obj The slider object.
17736     * @param indicator The format string for the indicator display.
17737     *
17738     * The slider may display its value somewhere else then unit label,
17739     * for example, above the slider knob that is dragged around. This function
17740     * sets the format string used for this.
17741     *
17742     * If @c NULL, indicator label won't be visible. If not it sets the format
17743     * string for the label text. To the label text is provided a floating point
17744     * value, so the label text can display up to 1 floating point value.
17745     * Note that this is optional.
17746     *
17747     * Use a format string such as "%1.2f meters" for example, and it will
17748     * display values like: "3.14 meters" for a value equal to 3.14159.
17749     *
17750     * Default is indicator label disabled.
17751     *
17752     * @see elm_slider_indicator_format_get()
17753     *
17754     * @ingroup Slider
17755     */
17756    EAPI void               elm_slider_indicator_format_set(Evas_Object *obj, const char *indicator) EINA_ARG_NONNULL(1);
17757
17758    /**
17759     * Get the indicator label format of the slider.
17760     *
17761     * @param obj The slider object.
17762     * @return The indicator label format string in UTF-8.
17763     *
17764     * The slider may display its value somewhere else then unit label,
17765     * for example, above the slider knob that is dragged around. This function
17766     * gets the format string used for this.
17767     *
17768     * @see elm_slider_indicator_format_set() for more
17769     * information on how this works.
17770     *
17771     * @ingroup Slider
17772     */
17773    EAPI const char        *elm_slider_indicator_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17774
17775    /**
17776     * Set the format function pointer for the indicator label
17777     *
17778     * @param obj The slider object.
17779     * @param func The indicator format function.
17780     * @param free_func The freeing function for the format string.
17781     *
17782     * Set the callback function to format the indicator string.
17783     *
17784     * @see elm_slider_indicator_format_set() for more info on how this works.
17785     *
17786     * @ingroup Slider
17787     */
17788   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);
17789
17790   /**
17791    * Set the format function pointer for the units label
17792    *
17793    * @param obj The slider object.
17794    * @param func The units format function.
17795    * @param free_func The freeing function for the format string.
17796    *
17797    * Set the callback function to format the indicator string.
17798    *
17799    * @see elm_slider_units_format_set() for more info on how this works.
17800    *
17801    * @ingroup Slider
17802    */
17803   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);
17804
17805   /**
17806    * Set the orientation of a given slider widget.
17807    *
17808    * @param obj The slider object.
17809    * @param horizontal Use @c EINA_TRUE to make @p obj to be
17810    * @b horizontal, @c EINA_FALSE to make it @b vertical.
17811    *
17812    * Use this function to change how your slider is to be
17813    * disposed: vertically or horizontally.
17814    *
17815    * By default it's displayed horizontally.
17816    *
17817    * @see elm_slider_horizontal_get()
17818    *
17819    * @ingroup Slider
17820    */
17821    EAPI void               elm_slider_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
17822
17823    /**
17824     * Retrieve the orientation of a given slider widget
17825     *
17826     * @param obj The slider object.
17827     * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
17828     * @c EINA_FALSE if it's @b vertical (and on errors).
17829     *
17830     * @see elm_slider_horizontal_set() for more details.
17831     *
17832     * @ingroup Slider
17833     */
17834    EAPI Eina_Bool          elm_slider_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17835
17836    /**
17837     * Set the minimum and maximum values for the slider.
17838     *
17839     * @param obj The slider object.
17840     * @param min The minimum value.
17841     * @param max The maximum value.
17842     *
17843     * Define the allowed range of values to be selected by the user.
17844     *
17845     * If actual value is less than @p min, it will be updated to @p min. If it
17846     * is bigger then @p max, will be updated to @p max. Actual value can be
17847     * get with elm_slider_value_get().
17848     *
17849     * By default, min is equal to 0.0, and max is equal to 1.0.
17850     *
17851     * @warning Maximum must be greater than minimum, otherwise behavior
17852     * is undefined.
17853     *
17854     * @see elm_slider_min_max_get()
17855     *
17856     * @ingroup Slider
17857     */
17858    EAPI void               elm_slider_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
17859
17860    /**
17861     * Get the minimum and maximum values of the slider.
17862     *
17863     * @param obj The slider object.
17864     * @param min Pointer where to store the minimum value.
17865     * @param max Pointer where to store the maximum value.
17866     *
17867     * @note If only one value is needed, the other pointer can be passed
17868     * as @c NULL.
17869     *
17870     * @see elm_slider_min_max_set() for details.
17871     *
17872     * @ingroup Slider
17873     */
17874    EAPI void               elm_slider_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
17875
17876    /**
17877     * Set the value the slider displays.
17878     *
17879     * @param obj The slider object.
17880     * @param val The value to be displayed.
17881     *
17882     * Value will be presented on the unit label following format specified with
17883     * elm_slider_unit_format_set() and on indicator with
17884     * elm_slider_indicator_format_set().
17885     *
17886     * @warning The value must to be between min and max values. This values
17887     * are set by elm_slider_min_max_set().
17888     *
17889     * @see elm_slider_value_get()
17890     * @see elm_slider_unit_format_set()
17891     * @see elm_slider_indicator_format_set()
17892     * @see elm_slider_min_max_set()
17893     *
17894     * @ingroup Slider
17895     */
17896    EAPI void               elm_slider_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
17897
17898    /**
17899     * Get the value displayed by the spinner.
17900     *
17901     * @param obj The spinner object.
17902     * @return The value displayed.
17903     *
17904     * @see elm_spinner_value_set() for details.
17905     *
17906     * @ingroup Slider
17907     */
17908    EAPI double             elm_slider_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17909
17910    /**
17911     * Invert a given slider widget's displaying values order
17912     *
17913     * @param obj The slider object.
17914     * @param inverted Use @c EINA_TRUE to make @p obj inverted,
17915     * @c EINA_FALSE to bring it back to default, non-inverted values.
17916     *
17917     * A slider may be @b inverted, in which state it gets its
17918     * values inverted, with high vales being on the left or top and
17919     * low values on the right or bottom, as opposed to normally have
17920     * the low values on the former and high values on the latter,
17921     * respectively, for horizontal and vertical modes.
17922     *
17923     * @see elm_slider_inverted_get()
17924     *
17925     * @ingroup Slider
17926     */
17927    EAPI void               elm_slider_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
17928
17929    /**
17930     * Get whether a given slider widget's displaying values are
17931     * inverted or not.
17932     *
17933     * @param obj The slider object.
17934     * @return @c EINA_TRUE, if @p obj has inverted values,
17935     * @c EINA_FALSE otherwise (and on errors).
17936     *
17937     * @see elm_slider_inverted_set() for more details.
17938     *
17939     * @ingroup Slider
17940     */
17941    EAPI Eina_Bool          elm_slider_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17942
17943    /**
17944     * Set whether to enlarge slider indicator (augmented knob) or not.
17945     *
17946     * @param obj The slider object.
17947     * @param show @c EINA_TRUE will make it enlarge, @c EINA_FALSE will
17948     * let the knob always at default size.
17949     *
17950     * By default, indicator will be bigger while dragged by the user.
17951     *
17952     * @warning It won't display values set with
17953     * elm_slider_indicator_format_set() if you disable indicator.
17954     *
17955     * @ingroup Slider
17956     */
17957    EAPI void               elm_slider_indicator_show_set(Evas_Object *obj, Eina_Bool show) EINA_ARG_NONNULL(1);
17958
17959    /**
17960     * Get whether a given slider widget's enlarging indicator or not.
17961     *
17962     * @param obj The slider object.
17963     * @return @c EINA_TRUE, if @p obj is enlarging indicator, or
17964     * @c EINA_FALSE otherwise (and on errors).
17965     *
17966     * @see elm_slider_indicator_show_set() for details.
17967     *
17968     * @ingroup Slider
17969     */
17970    EAPI Eina_Bool          elm_slider_indicator_show_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17971
17972    /**
17973     * @}
17974     */
17975
17976    /**
17977     * @addtogroup Actionslider Actionslider
17978     *
17979     * @image html img/widget/actionslider/preview-00.png
17980     * @image latex img/widget/actionslider/preview-00.eps
17981     *
17982     * An actionslider is a switcher for 2 or 3 labels with customizable magnet
17983     * properties. The user drags and releases the indicator, to choose a label.
17984     *
17985     * Labels occupy the following positions.
17986     * a. Left
17987     * b. Right
17988     * c. Center
17989     *
17990     * Positions can be enabled or disabled.
17991     *
17992     * Magnets can be set on the above positions.
17993     *
17994     * When the indicator is released, it will move to its nearest "enabled and magnetized" position.
17995     *
17996     * @note By default all positions are set as enabled.
17997     *
17998     * Signals that you can add callbacks for are:
17999     *
18000     * "selected" - when user selects an enabled position (the label is passed
18001     *              as event info)".
18002     * @n
18003     * "pos_changed" - when the indicator reaches any of the positions("left",
18004     *                 "right" or "center").
18005     *
18006     * See an example of actionslider usage @ref actionslider_example_page "here"
18007     * @{
18008     */
18009
18010    typedef enum _Elm_Actionslider_Indicator_Pos
18011      {
18012         ELM_ACTIONSLIDER_INDICATOR_NONE,
18013         ELM_ACTIONSLIDER_INDICATOR_LEFT,
18014         ELM_ACTIONSLIDER_INDICATOR_RIGHT,
18015         ELM_ACTIONSLIDER_INDICATOR_CENTER
18016      } Elm_Actionslider_Indicator_Pos;
18017
18018    typedef enum _Elm_Actionslider_Magnet_Pos
18019      {
18020         ELM_ACTIONSLIDER_MAGNET_NONE = 0,
18021         ELM_ACTIONSLIDER_MAGNET_LEFT = 1 << 0,
18022         ELM_ACTIONSLIDER_MAGNET_CENTER = 1 << 1,
18023         ELM_ACTIONSLIDER_MAGNET_RIGHT= 1 << 2,
18024         ELM_ACTIONSLIDER_MAGNET_ALL = (1 << 3) -1,
18025         ELM_ACTIONSLIDER_MAGNET_BOTH = (1 << 3)
18026      } Elm_Actionslider_Magnet_Pos;
18027
18028    typedef enum _Elm_Actionslider_Label_Pos
18029      {
18030         ELM_ACTIONSLIDER_LABEL_LEFT,
18031         ELM_ACTIONSLIDER_LABEL_RIGHT,
18032         ELM_ACTIONSLIDER_LABEL_CENTER,
18033         ELM_ACTIONSLIDER_LABEL_BUTTON
18034      } Elm_Actionslider_Label_Pos;
18035
18036    /* smart callbacks called:
18037     * "indicator,position" - when a button reaches to the special position like "left", "right" and "center".
18038     */
18039
18040    /**
18041     * Add a new actionslider to the parent.
18042     *
18043     * @param parent The parent object
18044     * @return The new actionslider object or NULL if it cannot be created
18045     */
18046    EAPI Evas_Object          *elm_actionslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18047
18048    /**
18049    * Set actionslider label.
18050    *
18051    * @param[in] obj The actionslider object
18052    * @param[in] pos The position of the label.
18053    * (ELM_ACTIONSLIDER_LABEL_LEFT, ELM_ACTIONSLIDER_LABEL_RIGHT)
18054    * @param label The label which is going to be set.
18055    */
18056    EAPI void               elm_actionslider_label_set(Evas_Object *obj, Elm_Actionslider_Label_Pos pos, const char *label) EINA_ARG_NONNULL(1);
18057    /**
18058     * Get actionslider labels.
18059     *
18060     * @param obj The actionslider object
18061     * @param left_label A char** to place the left_label of @p obj into.
18062     * @param center_label A char** to place the center_label of @p obj into.
18063     * @param right_label A char** to place the right_label of @p obj into.
18064     */
18065    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);
18066    /**
18067     * Get actionslider selected label.
18068     *
18069     * @param obj The actionslider object
18070     * @return The selected label
18071     */
18072    EAPI const char           *elm_actionslider_selected_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18073    /**
18074     * Set actionslider indicator position.
18075     *
18076     * @param obj The actionslider object.
18077     * @param pos The position of the indicator.
18078     */
18079    EAPI void                elm_actionslider_indicator_pos_set(Evas_Object *obj, Elm_Actionslider_Indicator_Pos pos) EINA_ARG_NONNULL(1);
18080    /**
18081     * Get actionslider indicator position.
18082     *
18083     * @param obj The actionslider object.
18084     * @return The position of the indicator.
18085     */
18086    EAPI Elm_Actionslider_Indicator_Pos  elm_actionslider_indicator_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18087    /**
18088     * Set actionslider magnet position. To make multiple positions magnets @c or
18089     * them together(e.g.: ELM_ACTIONSLIDER_MAGNET_LEFT | ELM_ACTIONSLIDER_MAGNET_RIGHT)
18090     *
18091     * @param obj The actionslider object.
18092     * @param pos Bit mask indicating the magnet positions.
18093     */
18094    EAPI void                elm_actionslider_magnet_pos_set(Evas_Object *obj, Elm_Actionslider_Magnet_Pos pos) EINA_ARG_NONNULL(1);
18095    /**
18096     * Get actionslider magnet position.
18097     *
18098     * @param obj The actionslider object.
18099     * @return The positions with magnet property.
18100     */
18101    EAPI Elm_Actionslider_Magnet_Pos  elm_actionslider_magnet_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18102    /**
18103     * Set actionslider enabled position. To set multiple positions as enabled @c or
18104     * them together(e.g.: ELM_ACTIONSLIDER_MAGNET_LEFT | ELM_ACTIONSLIDER_MAGNET_RIGHT).
18105     *
18106     * @note All the positions are enabled by default.
18107     *
18108     * @param obj The actionslider object.
18109     * @param pos Bit mask indicating the enabled positions.
18110     */
18111    EAPI void                  elm_actionslider_enabled_pos_set(Evas_Object *obj, Elm_Actionslider_Magnet_Pos pos) EINA_ARG_NONNULL(1);
18112    /**
18113     * Get actionslider enabled position.
18114     *
18115     * @param obj The actionslider object.
18116     * @return The enabled positions.
18117     */
18118    EAPI Elm_Actionslider_Magnet_Pos  elm_actionslider_enabled_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18119    /**
18120     * Set the label used on the indicator.
18121     *
18122     * @param obj The actionslider object
18123     * @param label The label to be set on the indicator.
18124     * @deprecated use elm_object_text_set() instead.
18125     */
18126    EINA_DEPRECATED EAPI void                  elm_actionslider_indicator_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
18127    /**
18128     * Get the label used on the indicator object.
18129     *
18130     * @param obj The actionslider object
18131     * @return The indicator label
18132     * @deprecated use elm_object_text_get() instead.
18133     */
18134    EINA_DEPRECATED EAPI const char           *elm_actionslider_indicator_label_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
18135
18136    /**
18137    * Hold actionslider object movement.
18138    *
18139    * @param[in] obj The actionslider object
18140    * @param[in] flag Actionslider hold/release
18141    * (EINA_TURE = hold/EIN_FALSE = release)
18142    *
18143    * @ingroup Actionslider
18144    */
18145    EAPI void                             elm_actionslider_hold(Evas_Object *obj, Eina_Bool flag) EINA_ARG_NONNULL(1);
18146
18147
18148    /**
18149     * @}
18150     */
18151
18152    /**
18153     * @defgroup Genlist Genlist
18154     *
18155     * @image html img/widget/genlist/preview-00.png
18156     * @image latex img/widget/genlist/preview-00.eps
18157     * @image html img/genlist.png
18158     * @image latex img/genlist.eps
18159     *
18160     * This widget aims to have more expansive list than the simple list in
18161     * Elementary that could have more flexible items and allow many more entries
18162     * while still being fast and low on memory usage. At the same time it was
18163     * also made to be able to do tree structures. But the price to pay is more
18164     * complexity when it comes to usage. If all you want is a simple list with
18165     * icons and a single label, use the normal @ref List object.
18166     *
18167     * Genlist has a fairly large API, mostly because it's relatively complex,
18168     * trying to be both expansive, powerful and efficient. First we will begin
18169     * an overview on the theory behind genlist.
18170     *
18171     * @section Genlist_Item_Class Genlist item classes - creating items
18172     *
18173     * In order to have the ability to add and delete items on the fly, genlist
18174     * implements a class (callback) system where the application provides a
18175     * structure with information about that type of item (genlist may contain
18176     * multiple different items with different classes, states and styles).
18177     * Genlist will call the functions in this struct (methods) when an item is
18178     * "realized" (i.e., created dynamically, while the user is scrolling the
18179     * grid). All objects will simply be deleted when no longer needed with
18180     * evas_object_del(). The #Elm_Genlist_Item_Class structure contains the
18181     * following members:
18182     * - @c item_style - This is a constant string and simply defines the name
18183     *   of the item style. It @b must be specified and the default should be @c
18184     *   "default".
18185     *
18186     * - @c func - A struct with pointers to functions that will be called when
18187     *   an item is going to be actually created. All of them receive a @c data
18188     *   parameter that will point to the same data passed to
18189     *   elm_genlist_item_append() and related item creation functions, and a @c
18190     *   obj parameter that points to the genlist object itself.
18191     *
18192     * The function pointers inside @c func are @c label_get, @c icon_get, @c
18193     * state_get and @c del. The 3 first functions also receive a @c part
18194     * parameter described below. A brief description of these functions follows:
18195     *
18196     * - @c label_get - The @c part parameter is the name string of one of the
18197     *   existing text parts in the Edje group implementing the item's theme.
18198     *   This function @b must return a strdup'()ed string, as the caller will
18199     *   free() it when done. See #Elm_Genlist_Item_Label_Get_Cb.
18200     * - @c content_get - The @c part parameter is the name string of one of the
18201     *   existing (content) swallow parts in the Edje group implementing the item's
18202     *   theme. It must return @c NULL, when no content is desired, or a valid
18203     *   object handle, otherwise.  The object will be deleted by the genlist on
18204     *   its deletion or when the item is "unrealized".  See
18205     *   #Elm_Genlist_Item_Content_Get_Cb.
18206     * - @c func.state_get - The @c part parameter is the name string of one of
18207     *   the state parts in the Edje group implementing the item's theme. Return
18208     *   @c EINA_FALSE for false/off or @c EINA_TRUE for true/on. Genlists will
18209     *   emit a signal to its theming Edje object with @c "elm,state,XXX,active"
18210     *   and @c "elm" as "emission" and "source" arguments, respectively, when
18211     *   the state is true (the default is false), where @c XXX is the name of
18212     *   the (state) part.  See #Elm_Genlist_Item_State_Get_Cb.
18213     * - @c func.del - This is intended for use when genlist items are deleted,
18214     *   so any data attached to the item (e.g. its data parameter on creation)
18215     *   can be deleted. See #Elm_Genlist_Item_Del_Cb.
18216     *
18217     * available item styles:
18218     * - default
18219     * - default_style - The text part is a textblock
18220     *
18221     * @image html img/widget/genlist/preview-04.png
18222     * @image latex img/widget/genlist/preview-04.eps
18223     *
18224     * - double_label
18225     *
18226     * @image html img/widget/genlist/preview-01.png
18227     * @image latex img/widget/genlist/preview-01.eps
18228     *
18229     * - icon_top_text_bottom
18230     *
18231     * @image html img/widget/genlist/preview-02.png
18232     * @image latex img/widget/genlist/preview-02.eps
18233     *
18234     * - group_index
18235     *
18236     * @image html img/widget/genlist/preview-03.png
18237     * @image latex img/widget/genlist/preview-03.eps
18238     *
18239     * @section Genlist_Items Structure of items
18240     *
18241     * An item in a genlist can have 0 or more text labels (they can be regular
18242     * text or textblock Evas objects - that's up to the style to determine), 0
18243     * or more contents (which are simply objects swallowed into the genlist item's
18244     * theming Edje object) and 0 or more <b>boolean states</b>, which have the
18245     * behavior left to the user to define. The Edje part names for each of
18246     * these properties will be looked up, in the theme file for the genlist,
18247     * under the Edje (string) data items named @c "labels", @c "contents" and @c
18248     * "states", respectively. For each of those properties, if more than one
18249     * part is provided, they must have names listed separated by spaces in the
18250     * data fields. For the default genlist item theme, we have @b one label
18251     * part (@c "elm.text"), @b two content parts (@c "elm.swalllow.icon" and @c
18252     * "elm.swallow.end") and @b no state parts.
18253     *
18254     * A genlist item may be at one of several styles. Elementary provides one
18255     * by default - "default", but this can be extended by system or application
18256     * custom themes/overlays/extensions (see @ref Theme "themes" for more
18257     * details).
18258     *
18259     * @section Genlist_Manipulation Editing and Navigating
18260     *
18261     * Items can be added by several calls. All of them return a @ref
18262     * Elm_Genlist_Item handle that is an internal member inside the genlist.
18263     * They all take a data parameter that is meant to be used for a handle to
18264     * the applications internal data (eg the struct with the original item
18265     * data). The parent parameter is the parent genlist item this belongs to if
18266     * it is a tree or an indexed group, and NULL if there is no parent. The
18267     * flags can be a bitmask of #ELM_GENLIST_ITEM_NONE,
18268     * #ELM_GENLIST_ITEM_SUBITEMS and #ELM_GENLIST_ITEM_GROUP. If
18269     * #ELM_GENLIST_ITEM_SUBITEMS is set then this item is displayed as an item
18270     * that is able to expand and have child items.  If ELM_GENLIST_ITEM_GROUP
18271     * is set then this item is group index item that is displayed at the top
18272     * until the next group comes. The func parameter is a convenience callback
18273     * that is called when the item is selected and the data parameter will be
18274     * the func_data parameter, obj be the genlist object and event_info will be
18275     * the genlist item.
18276     *
18277     * elm_genlist_item_append() adds an item to the end of the list, or if
18278     * there is a parent, to the end of all the child items of the parent.
18279     * elm_genlist_item_prepend() is the same but adds to the beginning of
18280     * the list or children list. elm_genlist_item_insert_before() inserts at
18281     * item before another item and elm_genlist_item_insert_after() inserts after
18282     * the indicated item.
18283     *
18284     * The application can clear the list with elm_gen_clear() which deletes
18285     * all the items in the list and elm_genlist_item_del() will delete a specific
18286     * item. elm_genlist_item_subitems_clear() will clear all items that are
18287     * children of the indicated parent item.
18288     *
18289     * To help inspect list items you can jump to the item at the top of the list
18290     * with elm_genlist_first_item_get() which will return the item pointer, and
18291     * similarly elm_genlist_last_item_get() gets the item at the end of the list.
18292     * elm_genlist_item_next_get() and elm_genlist_item_prev_get() get the next
18293     * and previous items respectively relative to the indicated item. Using
18294     * these calls you can walk the entire item list/tree. Note that as a tree
18295     * the items are flattened in the list, so elm_genlist_item_parent_get() will
18296     * let you know which item is the parent (and thus know how to skip them if
18297     * wanted).
18298     *
18299     * @section Genlist_Muti_Selection Multi-selection
18300     *
18301     * If the application wants multiple items to be able to be selected,
18302     * elm_genlist_multi_select_set() can enable this. If the list is
18303     * single-selection only (the default), then elm_genlist_selected_item_get()
18304     * will return the selected item, if any, or NULL if none is selected. If the
18305     * list is multi-select then elm_genlist_selected_items_get() will return a
18306     * list (that is only valid as long as no items are modified (added, deleted,
18307     * selected or unselected)).
18308     *
18309     * @section Genlist_Usage_Hints Usage hints
18310     *
18311     * There are also convenience functions. elm_gen_item_genlist_get() will
18312     * return the genlist object the item belongs to. elm_genlist_item_show()
18313     * will make the scroller scroll to show that specific item so its visible.
18314     * elm_genlist_item_data_get() returns the data pointer set by the item
18315     * creation functions.
18316     *
18317     * If an item changes (state of boolean changes, label or contents change),
18318     * then use elm_genlist_item_update() to have genlist update the item with
18319     * the new state. Genlist will re-realize the item thus call the functions
18320     * in the _Elm_Genlist_Item_Class for that item.
18321     *
18322     * To programmatically (un)select an item use elm_genlist_item_selected_set().
18323     * To get its selected state use elm_genlist_item_selected_get(). Similarly
18324     * to expand/contract an item and get its expanded state, use
18325     * elm_genlist_item_expanded_set() and elm_genlist_item_expanded_get(). And
18326     * again to make an item disabled (unable to be selected and appear
18327     * differently) use elm_genlist_item_disabled_set() to set this and
18328     * elm_genlist_item_disabled_get() to get the disabled state.
18329     *
18330     * In general to indicate how the genlist should expand items horizontally to
18331     * fill the list area, use elm_genlist_horizontal_set(). Valid modes are
18332     * ELM_LIST_LIMIT and ELM_LIST_SCROLL. The default is ELM_LIST_SCROLL. This
18333     * mode means that if items are too wide to fit, the scroller will scroll
18334     * horizontally. Otherwise items are expanded to fill the width of the
18335     * viewport of the scroller. If it is ELM_LIST_LIMIT, items will be expanded
18336     * to the viewport width and limited to that size. This can be combined with
18337     * a different style that uses edjes' ellipsis feature (cutting text off like
18338     * this: "tex...").
18339     *
18340     * Items will only call their selection func and callback when first becoming
18341     * selected. Any further clicks will do nothing, unless you enable always
18342     * select with elm_gen_always_select_mode_set(). This means even if
18343     * selected, every click will make the selected callbacks be called.
18344     * elm_genlist_no_select_mode_set() will turn off the ability to select
18345     * items entirely and they will neither appear selected nor call selected
18346     * callback functions.
18347     *
18348     * Remember that you can create new styles and add your own theme augmentation
18349     * per application with elm_theme_extension_add(). If you absolutely must
18350     * have a specific style that overrides any theme the user or system sets up
18351     * you can use elm_theme_overlay_add() to add such a file.
18352     *
18353     * @section Genlist_Implementation Implementation
18354     *
18355     * Evas tracks every object you create. Every time it processes an event
18356     * (mouse move, down, up etc.) it needs to walk through objects and find out
18357     * what event that affects. Even worse every time it renders display updates,
18358     * in order to just calculate what to re-draw, it needs to walk through many
18359     * many many objects. Thus, the more objects you keep active, the more
18360     * overhead Evas has in just doing its work. It is advisable to keep your
18361     * active objects to the minimum working set you need. Also remember that
18362     * object creation and deletion carries an overhead, so there is a
18363     * middle-ground, which is not easily determined. But don't keep massive lists
18364     * of objects you can't see or use. Genlist does this with list objects. It
18365     * creates and destroys them dynamically as you scroll around. It groups them
18366     * into blocks so it can determine the visibility etc. of a whole block at
18367     * once as opposed to having to walk the whole list. This 2-level list allows
18368     * for very large numbers of items to be in the list (tests have used up to
18369     * 2,000,000 items). Also genlist employs a queue for adding items. As items
18370     * may be different sizes, every item added needs to be calculated as to its
18371     * size and thus this presents a lot of overhead on populating the list, this
18372     * genlist employs a queue. Any item added is queued and spooled off over
18373     * time, actually appearing some time later, so if your list has many members
18374     * you may find it takes a while for them to all appear, with your process
18375     * consuming a lot of CPU while it is busy spooling.
18376     *
18377     * Genlist also implements a tree structure, but it does so with callbacks to
18378     * the application, with the application filling in tree structures when
18379     * requested (allowing for efficient building of a very deep tree that could
18380     * even be used for file-management). See the above smart signal callbacks for
18381     * details.
18382     *
18383     * @section Genlist_Smart_Events Genlist smart events
18384     *
18385     * Signals that you can add callbacks for are:
18386     * - @c "activated" - The user has double-clicked or pressed
18387     *   (enter|return|spacebar) on an item. The @c event_info parameter is the
18388     *   item that was activated.
18389     * - @c "clicked,double" - The user has double-clicked an item.  The @c
18390     *   event_info parameter is the item that was double-clicked.
18391     * - @c "selected" - This is called when a user has made an item selected.
18392     *   The event_info parameter is the genlist item that was selected.
18393     * - @c "unselected" - This is called when a user has made an item
18394     *   unselected. The event_info parameter is the genlist item that was
18395     *   unselected.
18396     * - @c "expanded" - This is called when elm_genlist_item_expanded_set() is
18397     *   called and the item is now meant to be expanded. The event_info
18398     *   parameter is the genlist item that was indicated to expand.  It is the
18399     *   job of this callback to then fill in the child items.
18400     * - @c "contracted" - This is called when elm_genlist_item_expanded_set() is
18401     *   called and the item is now meant to be contracted. The event_info
18402     *   parameter is the genlist item that was indicated to contract. It is the
18403     *   job of this callback to then delete the child items.
18404     * - @c "expand,request" - This is called when a user has indicated they want
18405     *   to expand a tree branch item. The callback should decide if the item can
18406     *   expand (has any children) and then call elm_genlist_item_expanded_set()
18407     *   appropriately to set the state. The event_info parameter is the genlist
18408     *   item that was indicated to expand.
18409     * - @c "contract,request" - This is called when a user has indicated they
18410     *   want to contract a tree branch item. The callback should decide if the
18411     *   item can contract (has any children) and then call
18412     *   elm_genlist_item_expanded_set() appropriately to set the state. The
18413     *   event_info parameter is the genlist item that was indicated to contract.
18414     * - @c "realized" - This is called when the item in the list is created as a
18415     *   real evas object. event_info parameter is the genlist item that was
18416     *   created. The object may be deleted at any time, so it is up to the
18417     *   caller to not use the object pointer from elm_genlist_item_object_get()
18418     *   in a way where it may point to freed objects.
18419     * - @c "unrealized" - This is called just before an item is unrealized.
18420     *   After this call content objects provided will be deleted and the item
18421     *   object itself delete or be put into a floating cache.
18422     * - @c "drag,start,up" - This is called when the item in the list has been
18423     *   dragged (not scrolled) up.
18424     * - @c "drag,start,down" - This is called when the item in the list has been
18425     *   dragged (not scrolled) down.
18426     * - @c "drag,start,left" - This is called when the item in the list has been
18427     *   dragged (not scrolled) left.
18428     * - @c "drag,start,right" - This is called when the item in the list has
18429     *   been dragged (not scrolled) right.
18430     * - @c "drag,stop" - This is called when the item in the list has stopped
18431     *   being dragged.
18432     * - @c "drag" - This is called when the item in the list is being dragged.
18433     * - @c "longpressed" - This is called when the item is pressed for a certain
18434     *   amount of time. By default it's 1 second.
18435     * - @c "scroll,anim,start" - This is called when scrolling animation has
18436     *   started.
18437     * - @c "scroll,anim,stop" - This is called when scrolling animation has
18438     *   stopped.
18439     * - @c "scroll,drag,start" - This is called when dragging the content has
18440     *   started.
18441     * - @c "scroll,drag,stop" - This is called when dragging the content has
18442     *   stopped.
18443     * - @c "edge,top" - This is called when the genlist is scrolled until
18444     *   the top edge.
18445     * - @c "edge,bottom" - This is called when the genlist is scrolled
18446     *   until the bottom edge.
18447     * - @c "edge,left" - This is called when the genlist is scrolled
18448     *   until the left edge.
18449     * - @c "edge,right" - This is called when the genlist is scrolled
18450     *   until the right edge.
18451     * - @c "multi,swipe,left" - This is called when the genlist is multi-touch
18452     *   swiped left.
18453     * - @c "multi,swipe,right" - This is called when the genlist is multi-touch
18454     *   swiped right.
18455     * - @c "multi,swipe,up" - This is called when the genlist is multi-touch
18456     *   swiped up.
18457     * - @c "multi,swipe,down" - This is called when the genlist is multi-touch
18458     *   swiped down.
18459     * - @c "multi,pinch,out" - This is called when the genlist is multi-touch
18460     *   pinched out.  "- @c multi,pinch,in" - This is called when the genlist is
18461     *   multi-touch pinched in.
18462     * - @c "swipe" - This is called when the genlist is swiped.
18463     * - @c "moved" - This is called when a genlist item is moved.
18464     * - @c "language,changed" - This is called when the program's language is
18465     *   changed.
18466     *
18467     * @section Genlist_Examples Examples
18468     *
18469     * Here is a list of examples that use the genlist, trying to show some of
18470     * its capabilities:
18471     * - @ref genlist_example_01
18472     * - @ref genlist_example_02
18473     * - @ref genlist_example_03
18474     * - @ref genlist_example_04
18475     * - @ref genlist_example_05
18476     */
18477
18478    /**
18479     * @addtogroup Genlist
18480     * @{
18481     */
18482
18483    /**
18484     * @enum _Elm_Genlist_Item_Flags
18485     * @typedef Elm_Genlist_Item_Flags
18486     *
18487     * Defines if the item is of any special type (has subitems or it's the
18488     * index of a group), or is just a simple item.
18489     *
18490     * @ingroup Genlist
18491     */
18492    typedef enum _Elm_Genlist_Item_Flags
18493      {
18494         ELM_GENLIST_ITEM_NONE = 0, /**< simple item */
18495         ELM_GENLIST_ITEM_SUBITEMS = (1 << 0), /**< may expand and have child items */
18496         ELM_GENLIST_ITEM_GROUP = (1 << 1) /**< index of a group of items */
18497      } Elm_Genlist_Item_Flags;
18498    typedef enum _Elm_Genlist_Item_Field_Flags
18499      {
18500         ELM_GENLIST_ITEM_FIELD_ALL = 0,
18501         ELM_GENLIST_ITEM_FIELD_LABEL = (1 << 0),
18502         ELM_GENLIST_ITEM_FIELD_ICON = (1 << 1),
18503         ELM_GENLIST_ITEM_FIELD_STATE = (1 << 2)
18504      } Elm_Genlist_Item_Field_Flags;
18505    typedef struct _Elm_Genlist_Item_Class Elm_Genlist_Item_Class;  /**< Genlist item class definition structs */
18506    typedef struct _Elm_Genlist_Item       Elm_Genlist_Item; /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
18507    typedef struct _Elm_Genlist_Item_Class_Func Elm_Genlist_Item_Class_Func;
18508    typedef char        *(*GenlistItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part);
18509    typedef Evas_Object *(*GenlistItemIconGetFunc)  (void *data, Evas_Object *obj, const char *part);
18510    typedef Eina_Bool    (*GenlistItemStateGetFunc) (void *data, Evas_Object *obj, const char *part);
18511    typedef void         (*GenlistItemDelFunc)      (void *data, Evas_Object *obj);
18512    typedef void         (*GenlistItemMovedFunc)    ( Evas_Object *genlist, Elm_Genlist_Item *item, Elm_Genlist_Item *rel_item, Eina_Bool move_after);
18513
18514    /**
18515     * @struct _Elm_Genlist_Item_Class
18516     *
18517     * Genlist item class definition structs.
18518     *
18519     * This struct contains the style and fetching functions that will define the
18520     * contents of each item.
18521     *
18522     * @see @ref Genlist_Item_Class
18523     */
18524    struct _Elm_Genlist_Item_Class
18525      {
18526         const char                *item_style;
18527         struct {
18528           GenlistItemLabelGetFunc  label_get;
18529           GenlistItemIconGetFunc   icon_get;
18530           GenlistItemStateGetFunc  state_get;
18531           GenlistItemDelFunc       del;
18532           GenlistItemMovedFunc     moved;
18533         } func;
18534         const char *edit_item_style;
18535         const char                *mode_item_style;
18536      };
18537    #define Elm_Genlist_Item_Class_Func Elm_Gen_Item_Class_Func
18538    /**
18539     * Add a new genlist widget to the given parent Elementary
18540     * (container) object
18541     *
18542     * @param parent The parent object
18543     * @return a new genlist widget handle or @c NULL, on errors
18544     *
18545     * This function inserts a new genlist widget on the canvas.
18546     *
18547     * @see elm_genlist_item_append()
18548     * @see elm_genlist_item_del()
18549     * @see elm_gen_clear()
18550     *
18551     * @ingroup Genlist
18552     */
18553    EAPI Evas_Object      *elm_genlist_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18554    /**
18555     * Remove all items from a given genlist widget.
18556     *
18557     * @param obj The genlist object
18558     *
18559     * This removes (and deletes) all items in @p obj, leaving it empty.
18560     *
18561     * This is deprecated. Please use elm_gen_clear() instead.
18562     * 
18563     * @see elm_genlist_item_del(), to remove just one item.
18564     *
18565     * @ingroup Genlist
18566     */
18567    WILL_DEPRECATE  EAPI void elm_genlist_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
18568    /**
18569     * Enable or disable multi-selection in the genlist
18570     *
18571     * @param obj The genlist object
18572     * @param multi Multi-select enable/disable. Default is disabled.
18573     *
18574     * This enables (@c EINA_TRUE) or disables (@c EINA_FALSE) multi-selection in
18575     * the list. This allows more than 1 item to be selected. To retrieve the list
18576     * of selected items, use elm_genlist_selected_items_get().
18577     *
18578     * @see elm_genlist_selected_items_get()
18579     * @see elm_genlist_multi_select_get()
18580     *
18581     * @ingroup Genlist
18582     */
18583    EAPI void              elm_genlist_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
18584    /**
18585     * Gets if multi-selection in genlist is enabled or disabled.
18586     *
18587     * @param obj The genlist object
18588     * @return Multi-select enabled/disabled
18589     * (@c EINA_TRUE = enabled/@c EINA_FALSE = disabled). Default is @c EINA_FALSE.
18590     *
18591     * @see elm_genlist_multi_select_set()
18592     *
18593     * @ingroup Genlist
18594     */
18595    EAPI Eina_Bool         elm_genlist_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18596    /**
18597     * This sets the horizontal stretching mode.
18598     *
18599     * @param obj The genlist object
18600     * @param mode The mode to use (one of #ELM_LIST_SCROLL or #ELM_LIST_LIMIT).
18601     *
18602     * This sets the mode used for sizing items horizontally. Valid modes
18603     * are #ELM_LIST_LIMIT and #ELM_LIST_SCROLL. The default is
18604     * ELM_LIST_SCROLL. This mode means that if items are too wide to fit,
18605     * the scroller will scroll horizontally. Otherwise items are expanded
18606     * to fill the width of the viewport of the scroller. If it is
18607     * ELM_LIST_LIMIT, items will be expanded to the viewport width and
18608     * limited to that size.
18609     *
18610     * @see elm_genlist_horizontal_get()
18611     *
18612     * @ingroup Genlist
18613     */
18614    EAPI void              elm_genlist_horizontal_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
18615    /**
18616     * Gets the horizontal stretching mode.
18617     *
18618     * @param obj The genlist object
18619     * @return The mode to use
18620     * (#ELM_LIST_LIMIT, #ELM_LIST_SCROLL)
18621     *
18622     * @see elm_genlist_horizontal_set()
18623     *
18624     * @ingroup Genlist
18625     */
18626    EAPI Elm_List_Mode     elm_genlist_horizontal_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18627    /**
18628     * Set the always select mode.
18629     *
18630     * @param obj The genlist object
18631     * @param always_select The always select mode (@c EINA_TRUE = on, @c
18632     * EINA_FALSE = off). Default is @c EINA_FALSE.
18633     *
18634     * Items will only call their selection func and callback when first
18635     * becoming selected. Any further clicks will do nothing, unless you
18636     * enable always select with elm_gen_always_select_mode_set().
18637     * This means that, even if selected, every click will make the selected
18638     * callbacks be called.
18639     * 
18640     * This function is deprecated. please see elm_gen_always_select_mode_set()
18641     *
18642     * @see elm_genlist_always_select_mode_get()
18643     *
18644     * @ingroup Genlist
18645     */
18646    WILL_DEPRECATE  EAPI void              elm_genlist_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
18647    /**
18648     * Get the always select mode.
18649     *
18650     * @param obj The genlist object
18651     * @return The always select mode
18652     * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18653     *
18654     * @see elm_genlist_always_select_mode_set()
18655     *
18656     * @ingroup Genlist
18657     */
18658    WILL_DEPRECATE  EAPI Eina_Bool         elm_genlist_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18659    /**
18660     * Enable/disable the no select mode.
18661     *
18662     * @param obj The genlist object
18663     * @param no_select The no select mode
18664     * (EINA_TRUE = on, EINA_FALSE = off)
18665     *
18666     * This will turn off the ability to select items entirely and they
18667     * will neither appear selected nor call selected callback functions.
18668     *
18669     * @see elm_genlist_no_select_mode_get()
18670     *
18671     * @ingroup Genlist
18672     */
18673    WILL_DEPRECATE  EAPI void              elm_genlist_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
18674    /**
18675     * Gets whether the no select mode is enabled.
18676     *
18677     * @param obj The genlist object
18678     * @return The no select mode
18679     * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18680     *
18681     * @see elm_genlist_no_select_mode_set()
18682     *
18683     * @ingroup Genlist
18684     */
18685    WILL_DEPRECATE  EAPI Eina_Bool         elm_genlist_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18686    /**
18687     * Enable/disable compress mode.
18688     *
18689     * @param obj The genlist object
18690     * @param compress The compress mode
18691     * (@c EINA_TRUE = on, @c EINA_FALSE = off). Default is @c EINA_FALSE.
18692     *
18693     * This will enable the compress mode where items are "compressed"
18694     * horizontally to fit the genlist scrollable viewport width. This is
18695     * special for genlist.  Do not rely on
18696     * elm_genlist_horizontal_set() being set to @c ELM_LIST_COMPRESS to
18697     * work as genlist needs to handle it specially.
18698     *
18699     * @see elm_genlist_compress_mode_get()
18700     *
18701     * @ingroup Genlist
18702     */
18703    EAPI void              elm_genlist_compress_mode_set(Evas_Object *obj, Eina_Bool compress) EINA_ARG_NONNULL(1);
18704    /**
18705     * Get whether the compress mode is enabled.
18706     *
18707     * @param obj The genlist object
18708     * @return The compress mode
18709     * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18710     *
18711     * @see elm_genlist_compress_mode_set()
18712     *
18713     * @ingroup Genlist
18714     */
18715    EAPI Eina_Bool         elm_genlist_compress_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18716    /**
18717     * Enable/disable height-for-width mode.
18718     *
18719     * @param obj The genlist object
18720     * @param setting The height-for-width mode (@c EINA_TRUE = on,
18721     * @c EINA_FALSE = off). Default is @c EINA_FALSE.
18722     *
18723     * With height-for-width mode the item width will be fixed (restricted
18724     * to a minimum of) to the list width when calculating its size in
18725     * order to allow the height to be calculated based on it. This allows,
18726     * for instance, text block to wrap lines if the Edje part is
18727     * configured with "text.min: 0 1".
18728     *
18729     * @note This mode will make list resize slower as it will have to
18730     *       recalculate every item height again whenever the list width
18731     *       changes!
18732     *
18733     * @note When height-for-width mode is enabled, it also enables
18734     *       compress mode (see elm_genlist_compress_mode_set()) and
18735     *       disables homogeneous (see elm_genlist_homogeneous_set()).
18736     *
18737     * @ingroup Genlist
18738     */
18739    EAPI void              elm_genlist_height_for_width_mode_set(Evas_Object *obj, Eina_Bool height_for_width) EINA_ARG_NONNULL(1);
18740    /**
18741     * Get whether the height-for-width mode is enabled.
18742     *
18743     * @param obj The genlist object
18744     * @return The height-for-width mode (@c EINA_TRUE = on, @c EINA_FALSE =
18745     * off)
18746     *
18747     * @ingroup Genlist
18748     */
18749    EAPI Eina_Bool         elm_genlist_height_for_width_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18750    /**
18751     * Enable/disable horizontal and vertical bouncing effect.
18752     *
18753     * @param obj The genlist object
18754     * @param h_bounce Allow bounce horizontally (@c EINA_TRUE = on, @c
18755     * EINA_FALSE = off). Default is @c EINA_FALSE.
18756     * @param v_bounce Allow bounce vertically (@c EINA_TRUE = on, @c
18757     * EINA_FALSE = off). Default is @c EINA_TRUE.
18758     *
18759     * This will enable or disable the scroller bouncing effect for the
18760     * genlist. See elm_scroller_bounce_set() for details.
18761     *
18762     * @see elm_scroller_bounce_set()
18763     * @see elm_genlist_bounce_get()
18764     *
18765     * @ingroup Genlist
18766     */
18767    WILL_DEPRECATE  EAPI void              elm_genlist_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
18768    /**
18769     * Get whether the horizontal and vertical bouncing effect is enabled.
18770     *
18771     * @param obj The genlist object
18772     * @param h_bounce Pointer to a bool to receive if the bounce horizontally
18773     * option is set.
18774     * @param v_bounce Pointer to a bool to receive if the bounce vertically
18775     * option is set.
18776     *
18777     * @see elm_genlist_bounce_set()
18778     *
18779     * @ingroup Genlist
18780     */
18781    WILL_DEPRECATE  EAPI void              elm_genlist_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
18782    /**
18783     * Enable/disable homogenous mode.
18784     *
18785     * @param obj The genlist object
18786     * @param homogeneous Assume the items within the genlist are of the
18787     * same height and width (EINA_TRUE = on, EINA_FALSE = off). Default is @c
18788     * EINA_FALSE.
18789     *
18790     * This will enable the homogeneous mode where items are of the same
18791     * height and width so that genlist may do the lazy-loading at its
18792     * maximum (which increases the performance for scrolling the list). This
18793     * implies 'compressed' mode.
18794     *
18795     * @see elm_genlist_compress_mode_set()
18796     * @see elm_genlist_homogeneous_get()
18797     *
18798     * @ingroup Genlist
18799     */
18800    EAPI void              elm_genlist_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
18801    /**
18802     * Get whether the homogenous mode is enabled.
18803     *
18804     * @param obj The genlist object
18805     * @return Assume the items within the genlist are of the same height
18806     * and width (EINA_TRUE = on, EINA_FALSE = off)
18807     *
18808     * @see elm_genlist_homogeneous_set()
18809     *
18810     * @ingroup Genlist
18811     */
18812    EAPI Eina_Bool         elm_genlist_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18813    /**
18814     * Set the maximum number of items within an item block
18815     *
18816     * @param obj The genlist object
18817     * @param n   Maximum number of items within an item block. Default is 32.
18818     *
18819     * This will configure the block count to tune to the target with
18820     * particular performance matrix.
18821     *
18822     * A block of objects will be used to reduce the number of operations due to
18823     * many objects in the screen. It can determine the visibility, or if the
18824     * object has changed, it theme needs to be updated, etc. doing this kind of
18825     * calculation to the entire block, instead of per object.
18826     *
18827     * The default value for the block count is enough for most lists, so unless
18828     * you know you will have a lot of objects visible in the screen at the same
18829     * time, don't try to change this.
18830     *
18831     * @see elm_genlist_block_count_get()
18832     * @see @ref Genlist_Implementation
18833     *
18834     * @ingroup Genlist
18835     */
18836    EAPI void              elm_genlist_block_count_set(Evas_Object *obj, int n) EINA_ARG_NONNULL(1);
18837    /**
18838     * Get the maximum number of items within an item block
18839     *
18840     * @param obj The genlist object
18841     * @return Maximum number of items within an item block
18842     *
18843     * @see elm_genlist_block_count_set()
18844     *
18845     * @ingroup Genlist
18846     */
18847    EAPI int               elm_genlist_block_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18848    /**
18849     * Set the timeout in seconds for the longpress event.
18850     *
18851     * @param obj The genlist object
18852     * @param timeout timeout in seconds. Default is 1.
18853     *
18854     * This option will change how long it takes to send an event "longpressed"
18855     * after the mouse down signal is sent to the list. If this event occurs, no
18856     * "clicked" event will be sent.
18857     *
18858     * @see elm_genlist_longpress_timeout_set()
18859     *
18860     * @ingroup Genlist
18861     */
18862    EAPI void              elm_genlist_longpress_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
18863    /**
18864     * Get the timeout in seconds for the longpress event.
18865     *
18866     * @param obj The genlist object
18867     * @return timeout in seconds
18868     *
18869     * @see elm_genlist_longpress_timeout_get()
18870     *
18871     * @ingroup Genlist
18872     */
18873    EAPI double            elm_genlist_longpress_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18874    /**
18875     * Append a new item in a given genlist widget.
18876     *
18877     * @param obj The genlist object
18878     * @param itc The item class for the item
18879     * @param data The item data
18880     * @param parent The parent item, or NULL if none
18881     * @param flags Item flags
18882     * @param func Convenience function called when the item is selected
18883     * @param func_data Data passed to @p func above.
18884     * @return A handle to the item added or @c NULL if not possible
18885     *
18886     * This adds the given item to the end of the list or the end of
18887     * the children list if the @p parent is given.
18888     *
18889     * @see elm_genlist_item_prepend()
18890     * @see elm_genlist_item_insert_before()
18891     * @see elm_genlist_item_insert_after()
18892     * @see elm_genlist_item_del()
18893     *
18894     * @ingroup Genlist
18895     */
18896    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);
18897    /**
18898     * Prepend a new item in a given genlist widget.
18899     *
18900     * @param obj The genlist object
18901     * @param itc The item class for the item
18902     * @param data The item data
18903     * @param parent The parent item, or NULL if none
18904     * @param flags Item flags
18905     * @param func Convenience function called when the item is selected
18906     * @param func_data Data passed to @p func above.
18907     * @return A handle to the item added or NULL if not possible
18908     *
18909     * This adds an item to the beginning of the list or beginning of the
18910     * children of the parent if given.
18911     *
18912     * @see elm_genlist_item_append()
18913     * @see elm_genlist_item_insert_before()
18914     * @see elm_genlist_item_insert_after()
18915     * @see elm_genlist_item_del()
18916     *
18917     * @ingroup Genlist
18918     */
18919    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);
18920    /**
18921     * Insert an item before another in a genlist widget
18922     *
18923     * @param obj The genlist object
18924     * @param itc The item class for the item
18925     * @param data The item data
18926     * @param before The item to place this new one before.
18927     * @param flags Item flags
18928     * @param func Convenience function called when the item is selected
18929     * @param func_data Data passed to @p func above.
18930     * @return A handle to the item added or @c NULL if not possible
18931     *
18932     * This inserts an item before another in the list. It will be in the
18933     * same tree level or group as the item it is inserted before.
18934     *
18935     * @see elm_genlist_item_append()
18936     * @see elm_genlist_item_prepend()
18937     * @see elm_genlist_item_insert_after()
18938     * @see elm_genlist_item_del()
18939     *
18940     * @ingroup Genlist
18941     */
18942    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);
18943    /**
18944     * Insert an item after another in a genlist widget
18945     *
18946     * @param obj The genlist object
18947     * @param itc The item class for the item
18948     * @param data The item data
18949     * @param after The item to place this new one after.
18950     * @param flags Item flags
18951     * @param func Convenience function called when the item is selected
18952     * @param func_data Data passed to @p func above.
18953     * @return A handle to the item added or @c NULL if not possible
18954     *
18955     * This inserts an item after another in the list. It will be in the
18956     * same tree level or group as the item it is inserted after.
18957     *
18958     * @see elm_genlist_item_append()
18959     * @see elm_genlist_item_prepend()
18960     * @see elm_genlist_item_insert_before()
18961     * @see elm_genlist_item_del()
18962     *
18963     * @ingroup Genlist
18964     */
18965    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);
18966    /**
18967     * Insert a new item into the sorted genlist object
18968     *
18969     * @param obj The genlist object
18970     * @param itc The item class for the item
18971     * @param data The item data
18972     * @param parent The parent item, or NULL if none
18973     * @param flags Item flags
18974     * @param comp The function called for the sort
18975     * @param func Convenience function called when item selected
18976     * @param func_data Data passed to @p func above.
18977     * @return A handle to the item added or NULL if not possible
18978     *
18979     * @ingroup Genlist
18980     */
18981    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);
18982    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);
18983    /* operations to retrieve existing items */
18984    /**
18985     * Get the selectd item in the genlist.
18986     *
18987     * @param obj The genlist object
18988     * @return The selected item, or NULL if none is selected.
18989     *
18990     * This gets the selected item in the list (if multi-selection is enabled, only
18991     * the item that was first selected in the list is returned - which is not very
18992     * useful, so see elm_genlist_selected_items_get() for when multi-selection is
18993     * used).
18994     *
18995     * If no item is selected, NULL is returned.
18996     *
18997     * @see elm_genlist_selected_items_get()
18998     *
18999     * @ingroup Genlist
19000     */
19001    EAPI Elm_Genlist_Item *elm_genlist_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19002    /**
19003     * Get a list of selected items in the genlist.
19004     *
19005     * @param obj The genlist object
19006     * @return The list of selected items, or NULL if none are selected.
19007     *
19008     * It returns a list of the selected items. This list pointer is only valid so
19009     * long as the selection doesn't change (no items are selected or unselected, or
19010     * unselected implicitly by deletion). The list contains Elm_Genlist_Item
19011     * pointers. The order of the items in this list is the order which they were
19012     * selected, i.e. the first item in this list is the first item that was
19013     * selected, and so on.
19014     *
19015     * @note If not in multi-select mode, consider using function
19016     * elm_genlist_selected_item_get() instead.
19017     *
19018     * @see elm_genlist_multi_select_set()
19019     * @see elm_genlist_selected_item_get()
19020     *
19021     * @ingroup Genlist
19022     */
19023    EAPI const Eina_List  *elm_genlist_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19024    /**
19025     * Get the mode item style of items in the genlist
19026     * @param obj The genlist object
19027     * @return The mode item style string, or NULL if none is specified
19028     * 
19029     * This is a constant string and simply defines the name of the
19030     * style that will be used for mode animations. It can be
19031     * @c NULL if you don't plan to use Genlist mode. See
19032     * elm_genlist_item_mode_set() for more info.
19033     * 
19034     * @ingroup Genlist
19035     */
19036    EAPI const char       *elm_genlist_mode_item_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19037    /**
19038     * Set the mode item style of items in the genlist
19039     * @param obj The genlist object
19040     * @param style The mode item style string, or NULL if none is desired
19041     * 
19042     * This is a constant string and simply defines the name of the
19043     * style that will be used for mode animations. It can be
19044     * @c NULL if you don't plan to use Genlist mode. See
19045     * elm_genlist_item_mode_set() for more info.
19046     * 
19047     * @ingroup Genlist
19048     */
19049    EAPI void              elm_genlist_mode_item_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
19050    /**
19051     * Get a list of realized items in genlist
19052     *
19053     * @param obj The genlist object
19054     * @return The list of realized items, nor NULL if none are realized.
19055     *
19056     * This returns a list of the realized items in the genlist. The list
19057     * contains Elm_Genlist_Item pointers. The list must be freed by the
19058     * caller when done with eina_list_free(). The item pointers in the
19059     * list are only valid so long as those items are not deleted or the
19060     * genlist is not deleted.
19061     *
19062     * @see elm_genlist_realized_items_update()
19063     *
19064     * @ingroup Genlist
19065     */
19066    EAPI Eina_List        *elm_genlist_realized_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19067    /**
19068     * Get the item that is at the x, y canvas coords.
19069     *
19070     * @param obj The gelinst object.
19071     * @param x The input x coordinate
19072     * @param y The input y coordinate
19073     * @param posret The position relative to the item returned here
19074     * @return The item at the coordinates or NULL if none
19075     *
19076     * This returns the item at the given coordinates (which are canvas
19077     * relative, not object-relative). If an item is at that coordinate,
19078     * that item handle is returned, and if @p posret is not NULL, the
19079     * integer pointed to is set to a value of -1, 0 or 1, depending if
19080     * the coordinate is on the upper portion of that item (-1), on the
19081     * middle section (0) or on the lower part (1). If NULL is returned as
19082     * an item (no item found there), then posret may indicate -1 or 1
19083     * based if the coordinate is above or below all items respectively in
19084     * the genlist.
19085     *
19086     * @ingroup Genlist
19087     */
19088    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);
19089    /**
19090     * Get the first item in the genlist
19091     *
19092     * This returns the first item in the list.
19093     *
19094     * @param obj The genlist object
19095     * @return The first item, or NULL if none
19096     *
19097     * @ingroup Genlist
19098     */
19099    WILL_DEPRECATE  EAPI Elm_Genlist_Item *elm_genlist_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19100    /**
19101     * Get the last item in the genlist
19102     *
19103     * This returns the last item in the list.
19104     *
19105     * @return The last item, or NULL if none
19106     *
19107     * @ingroup Genlist
19108     */
19109    WILL_DEPRECATE  EAPI Elm_Genlist_Item *elm_genlist_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19110    /**
19111     * Set the scrollbar policy
19112     *
19113     * @param obj The genlist object
19114     * @param policy_h Horizontal scrollbar policy.
19115     * @param policy_v Vertical scrollbar policy.
19116     *
19117     * This sets the scrollbar visibility policy for the given genlist
19118     * scroller. #ELM_SMART_SCROLLER_POLICY_AUTO means the scrollbar is
19119     * made visible if it is needed, and otherwise kept hidden.
19120     * #ELM_SMART_SCROLLER_POLICY_ON turns it on all the time, and
19121     * #ELM_SMART_SCROLLER_POLICY_OFF always keeps it off. This applies
19122     * respectively for the horizontal and vertical scrollbars. Default is
19123     * #ELM_SMART_SCROLLER_POLICY_AUTO
19124     *
19125     * @see elm_genlist_scroller_policy_get()
19126     *
19127     * @ingroup Genlist
19128     */
19129    EAPI void              elm_genlist_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
19130    /**
19131     * Get the scrollbar policy
19132     *
19133     * @param obj The genlist object
19134     * @param policy_h Pointer to store the horizontal scrollbar policy.
19135     * @param policy_v Pointer to store the vertical scrollbar policy.
19136     *
19137     * @see elm_genlist_scroller_policy_set()
19138     *
19139     * @ingroup Genlist
19140     */
19141    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);
19142    /**
19143     * Get the @b next item in a genlist widget's internal list of items,
19144     * given a handle to one of those items.
19145     *
19146     * @param item The genlist item to fetch next from
19147     * @return The item after @p item, or @c NULL if there's none (and
19148     * on errors)
19149     *
19150     * This returns the item placed after the @p item, on the container
19151     * genlist.
19152     *
19153     * @see elm_genlist_item_prev_get()
19154     *
19155     * @ingroup Genlist
19156     */
19157    WILL_DEPRECATE  EAPI Elm_Genlist_Item  *elm_genlist_item_next_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19158    /**
19159     * Get the @b previous item in a genlist widget's internal list of items,
19160     * given a handle to one of those items.
19161     *
19162     * @param item The genlist item to fetch previous from
19163     * @return The item before @p item, or @c NULL if there's none (and
19164     * on errors)
19165     *
19166     * This returns the item placed before the @p item, on the container
19167     * genlist.
19168     *
19169     * @see elm_genlist_item_next_get()
19170     *
19171     * @ingroup Genlist
19172     */
19173    WILL_DEPRECATE  EAPI Elm_Genlist_Item  *elm_genlist_item_prev_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19174    /**
19175     * Get the genlist object's handle which contains a given genlist
19176     * item
19177     *
19178     * @param item The item to fetch the container from
19179     * @return The genlist (parent) object
19180     *
19181     * This returns the genlist object itself that an item belongs to.
19182     *
19183     * This function is deprecated. Please use elm_gen_item_widget_get()
19184     * 
19185     * @ingroup Genlist
19186     */
19187    WILL_DEPRECATE  EAPI Evas_Object       *elm_genlist_item_genlist_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19188    /**
19189     * Get the parent item of the given item
19190     *
19191     * @param it The item
19192     * @return The parent of the item or @c NULL if it has no parent.
19193     *
19194     * This returns the item that was specified as parent of the item @p it on
19195     * elm_genlist_item_append() and insertion related functions.
19196     *
19197     * @ingroup Genlist
19198     */
19199    EAPI Elm_Genlist_Item  *elm_genlist_item_parent_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19200    /**
19201     * Remove all sub-items (children) of the given item
19202     *
19203     * @param it The item
19204     *
19205     * This removes all items that are children (and their descendants) of the
19206     * given item @p it.
19207     *
19208     * @see elm_genlist_clear()
19209     * @see elm_genlist_item_del()
19210     *
19211     * @ingroup Genlist
19212     */
19213    EAPI void               elm_genlist_item_subitems_clear(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19214    /**
19215     * Set whether a given genlist item is selected or not
19216     *
19217     * @param it The item
19218     * @param selected Use @c EINA_TRUE, to make it selected, @c
19219     * EINA_FALSE to make it unselected
19220     *
19221     * This sets the selected state of an item. If multi selection is
19222     * not enabled on the containing genlist and @p selected is @c
19223     * EINA_TRUE, any other previously selected items will get
19224     * unselected in favor of this new one.
19225     *
19226     * @see elm_genlist_item_selected_get()
19227     *
19228     * @ingroup Genlist
19229     */
19230    WILL_DEPRECATE  EAPI void elm_genlist_item_selected_set(Elm_Genlist_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
19231    /**
19232     * Get whether a given genlist item is selected or not
19233     *
19234     * @param it The item
19235     * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
19236     *
19237     * @see elm_genlist_item_selected_set() for more details
19238     *
19239     * @ingroup Genlist
19240     */
19241    WILL_DEPRECATE  EAPI Eina_Bool elm_genlist_item_selected_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19242    /**
19243     * Sets the expanded state of an item.
19244     *
19245     * @param it The item
19246     * @param expanded The expanded state (@c EINA_TRUE expanded, @c EINA_FALSE not expanded).
19247     *
19248     * This function flags the item of type #ELM_GENLIST_ITEM_SUBITEMS as
19249     * expanded or not.
19250     *
19251     * The theme will respond to this change visually, and a signal "expanded" or
19252     * "contracted" will be sent from the genlist with a pointer to the item that
19253     * has been expanded/contracted.
19254     *
19255     * Calling this function won't show or hide any child of this item (if it is
19256     * a parent). You must manually delete and create them on the callbacks fo
19257     * the "expanded" or "contracted" signals.
19258     *
19259     * @see elm_genlist_item_expanded_get()
19260     *
19261     * @ingroup Genlist
19262     */
19263    EAPI void               elm_genlist_item_expanded_set(Elm_Genlist_Item *item, Eina_Bool expanded) EINA_ARG_NONNULL(1);
19264    /**
19265     * Get the expanded state of an item
19266     *
19267     * @param it The item
19268     * @return The expanded state
19269     *
19270     * This gets the expanded state of an item.
19271     *
19272     * @see elm_genlist_item_expanded_set()
19273     *
19274     * @ingroup Genlist
19275     */
19276    EAPI Eina_Bool          elm_genlist_item_expanded_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19277    /**
19278     * Get the depth of expanded item
19279     *
19280     * @param it The genlist item object
19281     * @return The depth of expanded item
19282     *
19283     * @ingroup Genlist
19284     */
19285    EAPI int                elm_genlist_item_expanded_depth_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19286    /**
19287     * Set whether a given genlist item is disabled or not.
19288     *
19289     * @param it The item
19290     * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
19291     * to enable it back.
19292     *
19293     * A disabled item cannot be selected or unselected. It will also
19294     * change its appearance, to signal the user it's disabled.
19295     *
19296     * @see elm_genlist_item_disabled_get()
19297     *
19298     * @ingroup Genlist
19299     */
19300    EAPI void               elm_genlist_item_disabled_set(Elm_Genlist_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
19301    /**
19302     * Get whether a given genlist item is disabled or not.
19303     *
19304     * @param it The item
19305     * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
19306     * (and on errors).
19307     *
19308     * @see elm_genlist_item_disabled_set() for more details
19309     *
19310     * @ingroup Genlist
19311     */
19312    EAPI Eina_Bool          elm_genlist_item_disabled_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19313    /**
19314     * Sets the display only state of an item.
19315     *
19316     * @param it The item
19317     * @param display_only @c EINA_TRUE if the item is display only, @c
19318     * EINA_FALSE otherwise.
19319     *
19320     * A display only item cannot be selected or unselected. It is for
19321     * display only and not selecting or otherwise clicking, dragging
19322     * etc. by the user, thus finger size rules will not be applied to
19323     * this item.
19324     *
19325     * It's good to set group index items to display only state.
19326     *
19327     * @see elm_genlist_item_display_only_get()
19328     *
19329     * @ingroup Genlist
19330     */
19331    EAPI void               elm_genlist_item_display_only_set(Elm_Genlist_Item *it, Eina_Bool display_only) EINA_ARG_NONNULL(1);
19332    /**
19333     * Get the display only state of an item
19334     *
19335     * @param it The item
19336     * @return @c EINA_TRUE if the item is display only, @c
19337     * EINA_FALSE otherwise.
19338     *
19339     * @see elm_genlist_item_display_only_set()
19340     *
19341     * @ingroup Genlist
19342     */
19343    EAPI Eina_Bool          elm_genlist_item_display_only_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19344    /**
19345     * Show the portion of a genlist's internal list containing a given
19346     * item, immediately.
19347     *
19348     * @param it The item to display
19349     *
19350     * This causes genlist to jump to the given item @p it and show it (by
19351     * immediately scrolling to that position), if it is not fully visible.
19352     *
19353     * @see elm_genlist_item_bring_in()
19354     * @see elm_genlist_item_top_show()
19355     * @see elm_genlist_item_middle_show()
19356     *
19357     * @ingroup Genlist
19358     */
19359    EAPI void               elm_genlist_item_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19360    /**
19361     * Animatedly bring in, to the visible are of a genlist, a given
19362     * item on it.
19363     *
19364     * @param it The item to display
19365     *
19366     * This causes genlist to jump to the given item @p it and show it (by
19367     * animatedly scrolling), if it is not fully visible. This may use animation
19368     * to do so and take a period of time
19369     *
19370     * @see elm_genlist_item_show()
19371     * @see elm_genlist_item_top_bring_in()
19372     * @see elm_genlist_item_middle_bring_in()
19373     *
19374     * @ingroup Genlist
19375     */
19376    EAPI void               elm_genlist_item_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19377    /**
19378     * Show the portion of a genlist's internal list containing a given
19379     * item, immediately.
19380     *
19381     * @param it The item to display
19382     *
19383     * This causes genlist to jump to the given item @p it and show it (by
19384     * immediately scrolling to that position), if it is not fully visible.
19385     *
19386     * The item will be positioned at the top of the genlist viewport.
19387     *
19388     * @see elm_genlist_item_show()
19389     * @see elm_genlist_item_top_bring_in()
19390     *
19391     * @ingroup Genlist
19392     */
19393    EAPI void               elm_genlist_item_top_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19394    /**
19395     * Animatedly bring in, to the visible are of a genlist, a given
19396     * item on it.
19397     *
19398     * @param it The item
19399     *
19400     * This causes genlist to jump to the given item @p it and show it (by
19401     * animatedly scrolling), if it is not fully visible. This may use animation
19402     * to do so and take a period of time
19403     *
19404     * The item will be positioned at the top of the genlist viewport.
19405     *
19406     * @see elm_genlist_item_bring_in()
19407     * @see elm_genlist_item_top_show()
19408     *
19409     * @ingroup Genlist
19410     */
19411    EAPI void               elm_genlist_item_top_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19412    /**
19413     * Show the portion of a genlist's internal list containing a given
19414     * item, immediately.
19415     *
19416     * @param it The item to display
19417     *
19418     * This causes genlist to jump to the given item @p it and show it (by
19419     * immediately scrolling to that position), if it is not fully visible.
19420     *
19421     * The item will be positioned at the middle of the genlist viewport.
19422     *
19423     * @see elm_genlist_item_show()
19424     * @see elm_genlist_item_middle_bring_in()
19425     *
19426     * @ingroup Genlist
19427     */
19428    EAPI void               elm_genlist_item_middle_show(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19429    /**
19430     * Animatedly bring in, to the visible are of a genlist, a given
19431     * item on it.
19432     *
19433     * @param it The item
19434     *
19435     * This causes genlist to jump to the given item @p it and show it (by
19436     * animatedly scrolling), if it is not fully visible. This may use animation
19437     * to do so and take a period of time
19438     *
19439     * The item will be positioned at the middle of the genlist viewport.
19440     *
19441     * @see elm_genlist_item_bring_in()
19442     * @see elm_genlist_item_middle_show()
19443     *
19444     * @ingroup Genlist
19445     */
19446    EAPI void               elm_genlist_item_middle_bring_in(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19447    /**
19448     * Remove a genlist item from the its parent, deleting it.
19449     *
19450     * @param item The item to be removed.
19451     * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
19452     *
19453     * @see elm_genlist_clear(), to remove all items in a genlist at
19454     * once.
19455     *
19456     * @ingroup Genlist
19457     */
19458    EAPI void               elm_genlist_item_del(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19459    /**
19460     * Return the data associated to a given genlist item
19461     *
19462     * @param item The genlist item.
19463     * @return the data associated to this item.
19464     *
19465     * This returns the @c data value passed on the
19466     * elm_genlist_item_append() and related item addition calls.
19467     *
19468     * @see elm_genlist_item_append()
19469     * @see elm_genlist_item_data_set()
19470     *
19471     * @ingroup Genlist
19472     */
19473    EAPI void              *elm_genlist_item_data_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19474    /**
19475     * Set the data associated to a given genlist item
19476     *
19477     * @param item The genlist item
19478     * @param data The new data pointer to set on it
19479     *
19480     * This @b overrides the @c data value passed on the
19481     * elm_genlist_item_append() and related item addition calls. This
19482     * function @b won't call elm_genlist_item_update() automatically,
19483     * so you'd issue it afterwards if you want to hove the item
19484     * updated to reflect the that new data.
19485     *
19486     * @see elm_genlist_item_data_get()
19487     *
19488     * @ingroup Genlist
19489     */
19490    EAPI void               elm_genlist_item_data_set(Elm_Genlist_Item *it, const void *data) EINA_ARG_NONNULL(1);
19491    /**
19492     * Tells genlist to "orphan" icons fetchs by the item class
19493     *
19494     * @param it The item
19495     *
19496     * This instructs genlist to release references to icons in the item,
19497     * meaning that they will no longer be managed by genlist and are
19498     * floating "orphans" that can be re-used elsewhere if the user wants
19499     * to.
19500     *
19501     * @ingroup Genlist
19502     */
19503    EAPI void               elm_genlist_item_contents_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19504    WILL_DEPRECATE  EAPI void               elm_genlist_item_icons_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19505    /**
19506     * Get the real Evas object created to implement the view of a
19507     * given genlist item
19508     *
19509     * @param item The genlist item.
19510     * @return the Evas object implementing this item's view.
19511     *
19512     * This returns the actual Evas object used to implement the
19513     * specified genlist item's view. This may be @c NULL, as it may
19514     * not have been created or may have been deleted, at any time, by
19515     * the genlist. <b>Do not modify this object</b> (move, resize,
19516     * show, hide, etc.), as the genlist is controlling it. This
19517     * function is for querying, emitting custom signals or hooking
19518     * lower level callbacks for events on that object. Do not delete
19519     * this object under any circumstances.
19520     *
19521     * @see elm_genlist_item_data_get()
19522     *
19523     * @ingroup Genlist
19524     */
19525    EAPI const Evas_Object *elm_genlist_item_object_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19526    /**
19527     * Update the contents of an item
19528     *
19529     * @param it The item
19530     *
19531     * This updates an item by calling all the item class functions again
19532     * to get the icons, labels and states. Use this when the original
19533     * item data has changed and the changes are desired to be reflected.
19534     *
19535     * Use elm_genlist_realized_items_update() to update all already realized
19536     * items.
19537     *
19538     * @see elm_genlist_realized_items_update()
19539     *
19540     * @ingroup Genlist
19541     */
19542    EAPI void               elm_genlist_item_update(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19543    EAPI void               elm_genlist_item_fields_update(Elm_Genlist_Item *it, const char *parts, Elm_Genlist_Item_Field_Flags itf) EINA_ARG_NONNULL(1);
19544    /**
19545     * Update the item class of an item
19546     *
19547     * @param it The item
19548     * @param itc The item class for the item
19549     *
19550     * This sets another class fo the item, changing the way that it is
19551     * displayed. After changing the item class, elm_genlist_item_update() is
19552     * called on the item @p it.
19553     *
19554     * @ingroup Genlist
19555     */
19556    EAPI void               elm_genlist_item_item_class_update(Elm_Genlist_Item *it, const Elm_Genlist_Item_Class *itc) EINA_ARG_NONNULL(1, 2);
19557    EAPI const Elm_Genlist_Item_Class *elm_genlist_item_item_class_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19558    /**
19559     * Set the text to be shown in a given genlist item's tooltips.
19560     *
19561     * @param item The genlist item
19562     * @param text The text to set in the content
19563     *
19564     * This call will setup the text to be used as tooltip to that item
19565     * (analogous to elm_object_tooltip_text_set(), but being item
19566     * tooltips with higher precedence than object tooltips). It can
19567     * have only one tooltip at a time, so any previous tooltip data
19568     * will get removed.
19569     *
19570     * In order to set an icon or something else as a tooltip, look at
19571     * elm_genlist_item_tooltip_content_cb_set().
19572     *
19573     * @ingroup Genlist
19574     */
19575    EAPI void               elm_genlist_item_tooltip_text_set(Elm_Genlist_Item *item, const char *text) EINA_ARG_NONNULL(1);
19576    /**
19577     * Set the content to be shown in a given genlist item's tooltips
19578     *
19579     * @param item The genlist item.
19580     * @param func The function returning the tooltip contents.
19581     * @param data What to provide to @a func as callback data/context.
19582     * @param del_cb Called when data is not needed anymore, either when
19583     *        another callback replaces @p func, the tooltip is unset with
19584     *        elm_genlist_item_tooltip_unset() or the owner @p item
19585     *        dies. This callback receives as its first parameter the
19586     *        given @p data, being @c event_info the item handle.
19587     *
19588     * This call will setup the tooltip's contents to @p item
19589     * (analogous to elm_object_tooltip_content_cb_set(), but being
19590     * item tooltips with higher precedence than object tooltips). It
19591     * can have only one tooltip at a time, so any previous tooltip
19592     * content will get removed. @p func (with @p data) will be called
19593     * every time Elementary needs to show the tooltip and it should
19594     * return a valid Evas object, which will be fully managed by the
19595     * tooltip system, getting deleted when the tooltip is gone.
19596     *
19597     * In order to set just a text as a tooltip, look at
19598     * elm_genlist_item_tooltip_text_set().
19599     *
19600     * @ingroup Genlist
19601     */
19602    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);
19603    /**
19604     * Unset a tooltip from a given genlist item
19605     *
19606     * @param item genlist item to remove a previously set tooltip from.
19607     *
19608     * This call removes any tooltip set on @p item. The callback
19609     * provided as @c del_cb to
19610     * elm_genlist_item_tooltip_content_cb_set() will be called to
19611     * notify it is not used anymore (and have resources cleaned, if
19612     * need be).
19613     *
19614     * @see elm_genlist_item_tooltip_content_cb_set()
19615     *
19616     * @ingroup Genlist
19617     */
19618    EAPI void               elm_genlist_item_tooltip_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19619    /**
19620     * Set a different @b style for a given genlist item's tooltip.
19621     *
19622     * @param item genlist item with tooltip set
19623     * @param style the <b>theme style</b> to use on tooltips (e.g. @c
19624     * "default", @c "transparent", etc)
19625     *
19626     * Tooltips can have <b>alternate styles</b> to be displayed on,
19627     * which are defined by the theme set on Elementary. This function
19628     * works analogously as elm_object_tooltip_style_set(), but here
19629     * applied only to genlist item objects. The default style for
19630     * tooltips is @c "default".
19631     *
19632     * @note before you set a style you should define a tooltip with
19633     *       elm_genlist_item_tooltip_content_cb_set() or
19634     *       elm_genlist_item_tooltip_text_set()
19635     *
19636     * @see elm_genlist_item_tooltip_style_get()
19637     *
19638     * @ingroup Genlist
19639     */
19640    EAPI void               elm_genlist_item_tooltip_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
19641    /**
19642     * Get the style set a given genlist item's tooltip.
19643     *
19644     * @param item genlist item with tooltip already set on.
19645     * @return style the theme style in use, which defaults to
19646     *         "default". If the object does not have a tooltip set,
19647     *         then @c NULL is returned.
19648     *
19649     * @see elm_genlist_item_tooltip_style_set() for more details
19650     *
19651     * @ingroup Genlist
19652     */
19653    EAPI const char        *elm_genlist_item_tooltip_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19654    /**
19655     * @brief Disable size restrictions on an object's tooltip
19656     * @param item The tooltip's anchor object
19657     * @param disable If EINA_TRUE, size restrictions are disabled
19658     * @return EINA_FALSE on failure, EINA_TRUE on success
19659     *
19660     * This function allows a tooltip to expand beyond its parant window's canvas.
19661     * It will instead be limited only by the size of the display.
19662     */
19663    EAPI Eina_Bool          elm_genlist_item_tooltip_size_restrict_disable(Elm_Genlist_Item *item, Eina_Bool disable);
19664    /**
19665     * @brief Retrieve size restriction state of an object's tooltip
19666     * @param item The tooltip's anchor object
19667     * @return If EINA_TRUE, size restrictions are disabled
19668     *
19669     * This function returns whether a tooltip is allowed to expand beyond
19670     * its parant window's canvas.
19671     * It will instead be limited only by the size of the display.
19672     */
19673    EAPI Eina_Bool          elm_genlist_item_tooltip_size_restrict_disabled_get(const Elm_Genlist_Item *item);
19674    /**
19675     * Set the type of mouse pointer/cursor decoration to be shown,
19676     * when the mouse pointer is over the given genlist widget item
19677     *
19678     * @param item genlist item to customize cursor on
19679     * @param cursor the cursor type's name
19680     *
19681     * This function works analogously as elm_object_cursor_set(), but
19682     * here the cursor's changing area is restricted to the item's
19683     * area, and not the whole widget's. Note that that item cursors
19684     * have precedence over widget cursors, so that a mouse over @p
19685     * item will always show cursor @p type.
19686     *
19687     * If this function is called twice for an object, a previously set
19688     * cursor will be unset on the second call.
19689     *
19690     * @see elm_object_cursor_set()
19691     * @see elm_genlist_item_cursor_get()
19692     * @see elm_genlist_item_cursor_unset()
19693     *
19694     * @ingroup Genlist
19695     */
19696    EAPI void               elm_genlist_item_cursor_set(Elm_Genlist_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
19697    /**
19698     * Get the type of mouse pointer/cursor decoration set to be shown,
19699     * when the mouse pointer is over the given genlist widget item
19700     *
19701     * @param item genlist item with custom cursor set
19702     * @return the cursor type's name or @c NULL, if no custom cursors
19703     * were set to @p item (and on errors)
19704     *
19705     * @see elm_object_cursor_get()
19706     * @see elm_genlist_item_cursor_set() for more details
19707     * @see elm_genlist_item_cursor_unset()
19708     *
19709     * @ingroup Genlist
19710     */
19711    EAPI const char        *elm_genlist_item_cursor_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19712    /**
19713     * Unset any custom mouse pointer/cursor decoration set to be
19714     * shown, when the mouse pointer is over the given genlist widget
19715     * item, thus making it show the @b default cursor again.
19716     *
19717     * @param item a genlist item
19718     *
19719     * Use this call to undo any custom settings on this item's cursor
19720     * decoration, bringing it back to defaults (no custom style set).
19721     *
19722     * @see elm_object_cursor_unset()
19723     * @see elm_genlist_item_cursor_set() for more details
19724     *
19725     * @ingroup Genlist
19726     */
19727    EAPI void               elm_genlist_item_cursor_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19728    /**
19729     * Set a different @b style for a given custom cursor set for a
19730     * genlist item.
19731     *
19732     * @param item genlist item with custom cursor set
19733     * @param style the <b>theme style</b> to use (e.g. @c "default",
19734     * @c "transparent", etc)
19735     *
19736     * This function only makes sense when one is using custom mouse
19737     * cursor decorations <b>defined in a theme file</b> , which can
19738     * have, given a cursor name/type, <b>alternate styles</b> on
19739     * it. It works analogously as elm_object_cursor_style_set(), but
19740     * here applied only to genlist item objects.
19741     *
19742     * @warning Before you set a cursor style you should have defined a
19743     *       custom cursor previously on the item, with
19744     *       elm_genlist_item_cursor_set()
19745     *
19746     * @see elm_genlist_item_cursor_engine_only_set()
19747     * @see elm_genlist_item_cursor_style_get()
19748     *
19749     * @ingroup Genlist
19750     */
19751    EAPI void               elm_genlist_item_cursor_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
19752    /**
19753     * Get the current @b style set for a given genlist item's custom
19754     * cursor
19755     *
19756     * @param item genlist item with custom cursor set.
19757     * @return style the cursor style in use. If the object does not
19758     *         have a cursor set, then @c NULL is returned.
19759     *
19760     * @see elm_genlist_item_cursor_style_set() for more details
19761     *
19762     * @ingroup Genlist
19763     */
19764    EAPI const char        *elm_genlist_item_cursor_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19765    /**
19766     * Set if the (custom) cursor for a given genlist item should be
19767     * searched in its theme, also, or should only rely on the
19768     * rendering engine.
19769     *
19770     * @param item item with custom (custom) cursor already set on
19771     * @param engine_only Use @c EINA_TRUE to have cursors looked for
19772     * only on those provided by the rendering engine, @c EINA_FALSE to
19773     * have them searched on the widget's theme, as well.
19774     *
19775     * @note This call is of use only if you've set a custom cursor
19776     * for genlist items, with elm_genlist_item_cursor_set().
19777     *
19778     * @note By default, cursors will only be looked for between those
19779     * provided by the rendering engine.
19780     *
19781     * @ingroup Genlist
19782     */
19783    EAPI void               elm_genlist_item_cursor_engine_only_set(Elm_Genlist_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
19784    /**
19785     * Get if the (custom) cursor for a given genlist item is being
19786     * searched in its theme, also, or is only relying on the rendering
19787     * engine.
19788     *
19789     * @param item a genlist item
19790     * @return @c EINA_TRUE, if cursors are being looked for only on
19791     * those provided by the rendering engine, @c EINA_FALSE if they
19792     * are being searched on the widget's theme, as well.
19793     *
19794     * @see elm_genlist_item_cursor_engine_only_set(), for more details
19795     *
19796     * @ingroup Genlist
19797     */
19798    EAPI Eina_Bool          elm_genlist_item_cursor_engine_only_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19799    /**
19800     * Update the contents of all realized items.
19801     *
19802     * @param obj The genlist object.
19803     *
19804     * This updates all realized items by calling all the item class functions again
19805     * to get the icons, labels and states. Use this when the original
19806     * item data has changed and the changes are desired to be reflected.
19807     *
19808     * To update just one item, use elm_genlist_item_update().
19809     *
19810     * @see elm_genlist_realized_items_get()
19811     * @see elm_genlist_item_update()
19812     *
19813     * @ingroup Genlist
19814     */
19815    EAPI void               elm_genlist_realized_items_update(Evas_Object *obj) EINA_ARG_NONNULL(1);
19816    /**
19817     * Activate a genlist mode on an item
19818     *
19819     * @param item The genlist item
19820     * @param mode Mode name
19821     * @param mode_set Boolean to define set or unset mode.
19822     *
19823     * A genlist mode is a different way of selecting an item. Once a mode is
19824     * activated on an item, any other selected item is immediately unselected.
19825     * This feature provides an easy way of implementing a new kind of animation
19826     * for selecting an item, without having to entirely rewrite the item style
19827     * theme. However, the elm_genlist_selected_* API can't be used to get what
19828     * item is activate for a mode.
19829     *
19830     * The current item style will still be used, but applying a genlist mode to
19831     * an item will select it using a different kind of animation.
19832     *
19833     * The current active item for a mode can be found by
19834     * elm_genlist_mode_item_get().
19835     *
19836     * The characteristics of genlist mode are:
19837     * - Only one mode can be active at any time, and for only one item.
19838     * - Genlist handles deactivating other items when one item is activated.
19839     * - A mode is defined in the genlist theme (edc), and more modes can easily
19840     *   be added.
19841     * - A mode style and the genlist item style are different things. They
19842     *   can be combined to provide a default style to the item, with some kind
19843     *   of animation for that item when the mode is activated.
19844     *
19845     * When a mode is activated on an item, a new view for that item is created.
19846     * The theme of this mode defines the animation that will be used to transit
19847     * the item from the old view to the new view. This second (new) view will be
19848     * active for that item while the mode is active on the item, and will be
19849     * destroyed after the mode is totally deactivated from that item.
19850     *
19851     * @see elm_genlist_mode_get()
19852     * @see elm_genlist_mode_item_get()
19853     *
19854     * @ingroup Genlist
19855     */
19856    EAPI void               elm_genlist_item_mode_set(Elm_Genlist_Item *it, const char *mode_type, Eina_Bool mode_set) EINA_ARG_NONNULL(1, 2);
19857    /**
19858     * Get the last (or current) genlist mode used.
19859     *
19860     * @param obj The genlist object
19861     *
19862     * This function just returns the name of the last used genlist mode. It will
19863     * be the current mode if it's still active.
19864     *
19865     * @see elm_genlist_item_mode_set()
19866     * @see elm_genlist_mode_item_get()
19867     *
19868     * @ingroup Genlist
19869     */
19870    EAPI const char        *elm_genlist_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19871    /**
19872     * Get active genlist mode item
19873     *
19874     * @param obj The genlist object
19875     * @return The active item for that current mode. Or @c NULL if no item is
19876     * activated with any mode.
19877     *
19878     * This function returns the item that was activated with a mode, by the
19879     * function elm_genlist_item_mode_set().
19880     *
19881     * @see elm_genlist_item_mode_set()
19882     * @see elm_genlist_mode_get()
19883     *
19884     * @ingroup Genlist
19885     */
19886    EAPI const Elm_Genlist_Item *elm_genlist_mode_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19887
19888    /**
19889     * Set reorder mode
19890     *
19891     * @param obj The genlist object
19892     * @param reorder_mode The reorder mode
19893     * (EINA_TRUE = on, EINA_FALSE = off)
19894     *
19895     * @ingroup Genlist
19896     */
19897    EAPI void               elm_genlist_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
19898
19899    /**
19900     * Get the reorder mode
19901     *
19902     * @param obj The genlist object
19903     * @return The reorder mode
19904     * (EINA_TRUE = on, EINA_FALSE = off)
19905     *
19906     * @ingroup Genlist
19907     */
19908    EAPI Eina_Bool          elm_genlist_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19909
19910    EAPI void               elm_genlist_edit_mode_set(Evas_Object *obj, Eina_Bool edit_mode) EINA_ARG_NONNULL(1);
19911    EAPI Eina_Bool          elm_genlist_edit_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19912    EAPI void               elm_genlist_item_rename_mode_set(Elm_Genlist_Item *it, Eina_Bool renamed) EINA_ARG_NONNULL(1);
19913    EAPI Eina_Bool          elm_genlist_item_rename_mode_get(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19914    EAPI void               elm_genlist_item_move_after(Elm_Genlist_Item *it, Elm_Genlist_Item *after ) EINA_ARG_NONNULL(1, 2);
19915    EAPI void               elm_genlist_item_move_before(Elm_Genlist_Item *it, Elm_Genlist_Item *before) EINA_ARG_NONNULL(1, 2);
19916    EAPI void               elm_genlist_effect_set(const Evas_Object *obj, Eina_Bool emode) EINA_ARG_NONNULL(1);
19917    EAPI void               elm_genlist_pinch_zoom_set(Evas_Object *obj, Eina_Bool emode) EINA_ARG_NONNULL(1);
19918    EAPI void               elm_genlist_pinch_zoom_mode_set(Evas_Object *obj, Eina_Bool emode) EINA_ARG_NONNULL(1);
19919    EAPI Eina_Bool          elm_genlist_pinch_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19920
19921    /**
19922     * @}
19923     */
19924
19925    /**
19926     * @defgroup Check Check
19927     *
19928     * @image html img/widget/check/preview-00.png
19929     * @image latex img/widget/check/preview-00.eps
19930     * @image html img/widget/check/preview-01.png
19931     * @image latex img/widget/check/preview-01.eps
19932     * @image html img/widget/check/preview-02.png
19933     * @image latex img/widget/check/preview-02.eps
19934     *
19935     * @brief The check widget allows for toggling a value between true and
19936     * false.
19937     *
19938     * Check objects are a lot like radio objects in layout and functionality
19939     * except they do not work as a group, but independently and only toggle the
19940     * value of a boolean from false to true (0 or 1). elm_check_state_set() sets
19941     * the boolean state (1 for true, 0 for false), and elm_check_state_get()
19942     * returns the current state. For convenience, like the radio objects, you
19943     * can set a pointer to a boolean directly with elm_check_state_pointer_set()
19944     * for it to modify.
19945     *
19946     * Signals that you can add callbacks for are:
19947     * "changed" - This is called whenever the user changes the state of one of
19948     *             the check object(event_info is NULL).
19949     *
19950     * Default contents parts of the check widget that you can use for are:
19951     * @li "icon" - A icon of the check
19952     *
19953     * Default text parts of the check widget that you can use for are:
19954     * @li "elm.text" - Label of the check
19955     *
19956     * @ref tutorial_check should give you a firm grasp of how to use this widget
19957     * .
19958     * @{
19959     */
19960    /**
19961     * @brief Add a new Check object
19962     *
19963     * @param parent The parent object
19964     * @return The new object or NULL if it cannot be created
19965     */
19966    EAPI Evas_Object *elm_check_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19967    /**
19968     * @brief Set the text label of the check object
19969     *
19970     * @param obj The check object
19971     * @param label The text label string in UTF-8
19972     *
19973     * @deprecated use elm_object_text_set() instead.
19974     */
19975    EINA_DEPRECATED EAPI void         elm_check_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
19976    /**
19977     * @brief Get the text label of the check object
19978     *
19979     * @param obj The check object
19980     * @return The text label string in UTF-8
19981     *
19982     * @deprecated use elm_object_text_get() instead.
19983     */
19984    EINA_DEPRECATED EAPI const char  *elm_check_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19985    /**
19986     * @brief Set the icon object of the check object
19987     *
19988     * @param obj The check object
19989     * @param icon The icon object
19990     *
19991     * Once the icon object is set, a previously set one will be deleted.
19992     * If you want to keep that old content object, use the
19993     * elm_object_content_unset() function.
19994     *
19995     * @deprecated use elm_object_part_content_set() instead.
19996     *
19997     */
19998    EINA_DEPRECATED EAPI void         elm_check_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
19999    /**
20000     * @brief Get the icon object of the check object
20001     *
20002     * @param obj The check object
20003     * @return The icon object
20004     *
20005     * @deprecated use elm_object_part_content_get() instead.
20006     *  
20007     */
20008    EINA_DEPRECATED EAPI Evas_Object *elm_check_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20009    /**
20010     * @brief Unset the icon used for the check object
20011     *
20012     * @param obj The check object
20013     * @return The icon object that was being used
20014     *
20015     * Unparent and return the icon object which was set for this widget.
20016     *
20017     * @deprecated use elm_object_part_content_unset() instead.
20018     *
20019     */
20020    EINA_DEPRECATED EAPI Evas_Object *elm_check_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20021    /**
20022     * @brief Set the on/off state of the check object
20023     *
20024     * @param obj The check object
20025     * @param state The state to use (1 == on, 0 == off)
20026     *
20027     * This sets the state of the check. If set
20028     * with elm_check_state_pointer_set() the state of that variable is also
20029     * changed. Calling this @b doesn't cause the "changed" signal to be emited.
20030     */
20031    EAPI void         elm_check_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
20032    /**
20033     * @brief Get the state of the check object
20034     *
20035     * @param obj The check object
20036     * @return The boolean state
20037     */
20038    EAPI Eina_Bool    elm_check_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20039    /**
20040     * @brief Set a convenience pointer to a boolean to change
20041     *
20042     * @param obj The check object
20043     * @param statep Pointer to the boolean to modify
20044     *
20045     * This sets a pointer to a boolean, that, in addition to the check objects
20046     * state will also be modified directly. To stop setting the object pointed
20047     * to simply use NULL as the @p statep parameter. If @p statep is not NULL,
20048     * then when this is called, the check objects state will also be modified to
20049     * reflect the value of the boolean @p statep points to, just like calling
20050     * elm_check_state_set().
20051     */
20052    EAPI void         elm_check_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
20053    /**
20054     * @}
20055     */
20056
20057    /* compatibility code for toggle controls */
20058
20059    EINA_DEPRECATED EAPI extern inline Evas_Object *elm_toggle_add(Evas_Object *parent) EINA_ARG_NONNULL(1)
20060      {
20061         Evas_Object *obj;
20062
20063         obj = elm_check_add(parent);
20064         elm_object_style_set(obj, "toggle");
20065         elm_object_part_text_set(obj, "on", "ON");
20066         elm_object_part_text_set(obj, "off", "OFF");
20067         return obj;
20068      }
20069
20070    EINA_DEPRECATED EAPI extern inline void elm_toggle_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1)
20071      {
20072         elm_object_text_set(obj, label);
20073      }
20074
20075    EINA_DEPRECATED EAPI extern inline const char  *elm_toggle_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1)
20076      {
20077         return elm_object_text_get(obj);
20078      }
20079
20080    EINA_DEPRECATED EAPI extern inline void elm_toggle_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1)
20081      {
20082         elm_object_content_set(obj, icon);
20083      }
20084
20085    EINA_DEPRECATED EAPI extern inline Evas_Object *elm_toggle_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1)
20086      {
20087         return elm_object_content_get(obj);
20088      }
20089
20090    EINA_DEPRECATED EAPI extern inline Evas_Object *elm_toggle_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1)
20091      {
20092         return elm_object_content_unset(obj);
20093      }
20094
20095    EINA_DEPRECATED EAPI extern inline void elm_toggle_states_labels_set(Evas_Object *obj, const char *onlabel, const char *offlabel) EINA_ARG_NONNULL(1)
20096      {
20097         elm_object_part_text_set(obj, "on", onlabel);
20098         elm_object_part_text_set(obj, "off", offlabel);
20099      }
20100
20101    EINA_DEPRECATED EAPI extern inline void elm_toggle_states_labels_get(const Evas_Object *obj, const char **onlabel, const char **offlabel) EINA_ARG_NONNULL(1)
20102      {
20103         if (onlabel) *onlabel = elm_object_part_text_get(obj, "on");
20104         if (offlabel) *offlabel = elm_object_part_text_get(obj, "off");
20105      }
20106
20107    EINA_DEPRECATED EAPI extern inline void elm_toggle_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1)
20108      {
20109         elm_check_state_set(obj, state);
20110      }
20111
20112    EINA_DEPRECATED EAPI extern inline Eina_Bool elm_toggle_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1)
20113      {
20114         return elm_check_state_get(obj);
20115      }
20116
20117    EINA_DEPRECATED EAPI extern inline void elm_toggle_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1)
20118      {
20119         elm_check_state_pointer_set(obj, statep);
20120      }
20121
20122    /**
20123     * @defgroup Radio Radio
20124     *
20125     * @image html img/widget/radio/preview-00.png
20126     * @image latex img/widget/radio/preview-00.eps
20127     *
20128     * @brief Radio is a widget that allows for 1 or more options to be displayed
20129     * and have the user choose only 1 of them.
20130     *
20131     * A radio object contains an indicator, an optional Label and an optional
20132     * icon object. While it's possible to have a group of only one radio they,
20133     * are normally used in groups of 2 or more. To add a radio to a group use
20134     * elm_radio_group_add(). The radio object(s) will select from one of a set
20135     * of integer values, so any value they are configuring needs to be mapped to
20136     * a set of integers. To configure what value that radio object represents,
20137     * use  elm_radio_state_value_set() to set the integer it represents. To set
20138     * the value the whole group(which one is currently selected) is to indicate
20139     * use elm_radio_value_set() on any group member, and to get the groups value
20140     * use elm_radio_value_get(). For convenience the radio objects are also able
20141     * to directly set an integer(int) to the value that is selected. To specify
20142     * the pointer to this integer to modify, use elm_radio_value_pointer_set().
20143     * The radio objects will modify this directly. That implies the pointer must
20144     * point to valid memory for as long as the radio objects exist.
20145     *
20146     * Signals that you can add callbacks for are:
20147     * @li changed - This is called whenever the user changes the state of one of
20148     * the radio objects within the group of radio objects that work together.
20149     *
20150     * Default contents parts of the radio widget that you can use for are:
20151     * @li "icon" - A icon of the radio
20152     *
20153     * @ref tutorial_radio show most of this API in action.
20154     * @{
20155     */
20156    /**
20157     * @brief Add a new radio to the parent
20158     *
20159     * @param parent The parent object
20160     * @return The new object or NULL if it cannot be created
20161     */
20162    EAPI Evas_Object *elm_radio_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20163    /**
20164     * @brief Set the text label of the radio object
20165     *
20166     * @param obj The radio object
20167     * @param label The text label string in UTF-8
20168     *
20169     * @deprecated use elm_object_text_set() instead.
20170     */
20171    EINA_DEPRECATED EAPI void         elm_radio_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
20172    /**
20173     * @brief Get the text label of the radio object
20174     *
20175     * @param obj The radio object
20176     * @return The text label string in UTF-8
20177     *
20178     * @deprecated use elm_object_text_set() instead.
20179     */
20180    EINA_DEPRECATED EAPI const char  *elm_radio_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20181    /**
20182     * @brief Set the icon object of the radio object
20183     *
20184     * @param obj The radio object
20185     * @param icon The icon object
20186     *
20187     * Once the icon object is set, a previously set one will be deleted. If you
20188     * want to keep that old content object, use the elm_radio_icon_unset()
20189     * function.
20190     *
20191     * @deprecated use elm_object_part_content_set() instead.
20192     *
20193     */
20194    WILL_DEPRECATE  EAPI void         elm_radio_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
20195    /**
20196     * @brief Get the icon object of the radio object
20197     *
20198     * @param obj The radio object
20199     * @return The icon object
20200     *
20201     * @see elm_radio_icon_set()
20202     *
20203     * @deprecated use elm_object_part_content_get() instead.
20204     *
20205     */
20206    WILL_DEPRECATE  EAPI Evas_Object *elm_radio_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20207    /**
20208     * @brief Unset the icon used for the radio object
20209     *
20210     * @param obj The radio object
20211     * @return The icon object that was being used
20212     *
20213     * Unparent and return the icon object which was set for this widget.
20214     *
20215     * @see elm_radio_icon_set()
20216     * @deprecated use elm_object_part_content_unset() instead.
20217     *
20218     */
20219    WILL_DEPRECATE  EAPI Evas_Object *elm_radio_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20220    /**
20221     * @brief Add this radio to a group of other radio objects
20222     *
20223     * @param obj The radio object
20224     * @param group Any object whose group the @p obj is to join.
20225     *
20226     * Radio objects work in groups. Each member should have a different integer
20227     * value assigned. In order to have them work as a group, they need to know
20228     * about each other. This adds the given radio object to the group of which
20229     * the group object indicated is a member.
20230     */
20231    EAPI void         elm_radio_group_add(Evas_Object *obj, Evas_Object *group) EINA_ARG_NONNULL(1);
20232    /**
20233     * @brief Set the integer value that this radio object represents
20234     *
20235     * @param obj The radio object
20236     * @param value The value to use if this radio object is selected
20237     *
20238     * This sets the value of the radio.
20239     */
20240    EAPI void         elm_radio_state_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
20241    /**
20242     * @brief Get the integer value that this radio object represents
20243     *
20244     * @param obj The radio object
20245     * @return The value used if this radio object is selected
20246     *
20247     * This gets the value of the radio.
20248     *
20249     * @see elm_radio_value_set()
20250     */
20251    EAPI int          elm_radio_state_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20252    /**
20253     * @brief Set the value of the radio.
20254     *
20255     * @param obj The radio object
20256     * @param value The value to use for the group
20257     *
20258     * This sets the value of the radio group and will also set the value if
20259     * pointed to, to the value supplied, but will not call any callbacks.
20260     */
20261    EAPI void         elm_radio_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
20262    /**
20263     * @brief Get the state of the radio object
20264     *
20265     * @param obj The radio object
20266     * @return The integer state
20267     */
20268    EAPI int          elm_radio_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20269    /**
20270     * @brief Set a convenience pointer to a integer to change
20271     *
20272     * @param obj The radio object
20273     * @param valuep Pointer to the integer to modify
20274     *
20275     * This sets a pointer to a integer, that, in addition to the radio objects
20276     * state will also be modified directly. To stop setting the object pointed
20277     * to simply use NULL as the @p valuep argument. If valuep is not NULL, then
20278     * when this is called, the radio objects state will also be modified to
20279     * reflect the value of the integer valuep points to, just like calling
20280     * elm_radio_value_set().
20281     */
20282    EAPI void         elm_radio_value_pointer_set(Evas_Object *obj, int *valuep) EINA_ARG_NONNULL(1);
20283    /**
20284     * @}
20285     */
20286
20287    /**
20288     * @defgroup Pager Pager
20289     *
20290     * @image html img/widget/pager/preview-00.png
20291     * @image latex img/widget/pager/preview-00.eps
20292     *
20293     * @brief Widget that allows flipping between one or more “pages”
20294     * of objects.
20295     *
20296     * The flipping between pages of objects is animated. All content
20297     * in the pager is kept in a stack, being the last content added
20298     * (visible one) on the top of that stack.
20299     *
20300     * Objects can be pushed or popped from the stack or deleted as
20301     * well. Pushes and pops will animate the widget accordingly to its
20302     * style (a pop will also delete the child object once the
20303     * animation is finished). Any object already in the pager can be
20304     * promoted to the top (from its current stacking position) through
20305     * the use of elm_pager_content_promote(). New objects are pushed
20306     * to the top with elm_pager_content_push(). When the top item is
20307     * no longer wanted, simply pop it with elm_pager_content_pop() and
20308     * it will also be deleted. If an object is no longer needed and is
20309     * not the top item, just delete it as normal. You can query which
20310     * objects are the top and bottom with
20311     * elm_pager_content_bottom_get() and elm_pager_content_top_get().
20312     *
20313     * Signals that you can add callbacks for are:
20314     * - @c "show,finished" - when a new page is actually shown on the top
20315     * - @c "hide,finished" - when a previous page is hidden
20316     *
20317     * Only after the first of that signals the child object is
20318     * guaranteed to be visible, as in @c evas_object_visible_get().
20319     *
20320     * This widget has the following styles available:
20321     * - @c "default"
20322     * - @c "fade"
20323     * - @c "fade_translucide"
20324     * - @c "fade_invisible"
20325     *
20326     * @note These styles affect only the flipping animations on the
20327     * default theme; the appearance when not animating is unaffected
20328     * by them.
20329     *
20330     * @ref tutorial_pager gives a good overview of the usage of the API.
20331     * @{
20332     */
20333
20334    /**
20335     * Add a new pager to the parent
20336     *
20337     * @param parent The parent object
20338     * @return The new object or NULL if it cannot be created
20339     *
20340     * @ingroup Pager
20341     */
20342    EAPI Evas_Object *elm_pager_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20343
20344    /**
20345     * @brief Push an object to the top of the pager stack (and show it).
20346     *
20347     * @param obj The pager object
20348     * @param content The object to push
20349     *
20350     * The object pushed becomes a child of the pager, it will be controlled and
20351     * deleted when the pager is deleted.
20352     *
20353     * @note If the content is already in the stack use
20354     * elm_pager_content_promote().
20355     * @warning Using this function on @p content already in the stack results in
20356     * undefined behavior.
20357     */
20358    EAPI void         elm_pager_content_push(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20359
20360    /**
20361     * @brief Pop the object that is on top of the stack
20362     *
20363     * @param obj The pager object
20364     *
20365     * This pops the object that is on the top(visible) of the pager, makes it
20366     * disappear, then deletes the object. The object that was underneath it on
20367     * the stack will become visible.
20368     */
20369    EAPI void         elm_pager_content_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
20370
20371    /**
20372     * @brief Moves an object already in the pager stack to the top of the stack.
20373     *
20374     * @param obj The pager object
20375     * @param content The object to promote
20376     *
20377     * This will take the @p content and move it to the top of the stack as
20378     * if it had been pushed there.
20379     *
20380     * @note If the content isn't already in the stack use
20381     * elm_pager_content_push().
20382     * @warning Using this function on @p content not already in the stack
20383     * results in undefined behavior.
20384     */
20385    EAPI void         elm_pager_content_promote(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20386
20387    /**
20388     * @brief Return the object at the bottom of the pager stack
20389     *
20390     * @param obj The pager object
20391     * @return The bottom object or NULL if none
20392     */
20393    EAPI Evas_Object *elm_pager_content_bottom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20394
20395    /**
20396     * @brief  Return the object at the top of the pager stack
20397     *
20398     * @param obj The pager object
20399     * @return The top object or NULL if none
20400     */
20401    EAPI Evas_Object *elm_pager_content_top_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20402
20403    EAPI void         elm_pager_to_content_pop(Evas_Object *obj, Evas_Object *content); EINA_ARG_NONNULL(1);
20404
20405    /**
20406     * @}
20407     */
20408
20409    /**
20410     * @defgroup Slideshow Slideshow
20411     *
20412     * @image html img/widget/slideshow/preview-00.png
20413     * @image latex img/widget/slideshow/preview-00.eps
20414     *
20415     * This widget, as the name indicates, is a pre-made image
20416     * slideshow panel, with API functions acting on (child) image
20417     * items presentation. Between those actions, are:
20418     * - advance to next/previous image
20419     * - select the style of image transition animation
20420     * - set the exhibition time for each image
20421     * - start/stop the slideshow
20422     *
20423     * The transition animations are defined in the widget's theme,
20424     * consequently new animations can be added without having to
20425     * update the widget's code.
20426     *
20427     * @section Slideshow_Items Slideshow items
20428     *
20429     * For slideshow items, just like for @ref Genlist "genlist" ones,
20430     * the user defines a @b classes, specifying functions that will be
20431     * called on the item's creation and deletion times.
20432     *
20433     * The #Elm_Slideshow_Item_Class structure contains the following
20434     * members:
20435     *
20436     * - @c func.get - When an item is displayed, this function is
20437     *   called, and it's where one should create the item object, de
20438     *   facto. For example, the object can be a pure Evas image object
20439     *   or an Elementary @ref Photocam "photocam" widget. See
20440     *   #SlideshowItemGetFunc.
20441     * - @c func.del - When an item is no more displayed, this function
20442     *   is called, where the user must delete any data associated to
20443     *   the item. See #SlideshowItemDelFunc.
20444     *
20445     * @section Slideshow_Caching Slideshow caching
20446     *
20447     * The slideshow provides facilities to have items adjacent to the
20448     * one being displayed <b>already "realized"</b> (i.e. loaded) for
20449     * you, so that the system does not have to decode image data
20450     * anymore at the time it has to actually switch images on its
20451     * viewport. The user is able to set the numbers of items to be
20452     * cached @b before and @b after the current item, in the widget's
20453     * item list.
20454     *
20455     * Smart events one can add callbacks for are:
20456     *
20457     * - @c "changed" - when the slideshow switches its view to a new
20458     *   item
20459     *
20460     * List of examples for the slideshow widget:
20461     * @li @ref slideshow_example
20462     */
20463
20464    /**
20465     * @addtogroup Slideshow
20466     * @{
20467     */
20468
20469    typedef struct _Elm_Slideshow_Item_Class Elm_Slideshow_Item_Class; /**< Slideshow item class definition struct */
20470    typedef struct _Elm_Slideshow_Item_Class_Func Elm_Slideshow_Item_Class_Func; /**< Class functions for slideshow item classes. */
20471    typedef struct _Elm_Slideshow_Item       Elm_Slideshow_Item; /**< Slideshow item handle */
20472    typedef Evas_Object *(*SlideshowItemGetFunc) (void *data, Evas_Object *obj); /**< Image fetching class function for slideshow item classes. */
20473    typedef void         (*SlideshowItemDelFunc) (void *data, Evas_Object *obj); /**< Deletion class function for slideshow item classes. */
20474
20475    /**
20476     * @struct _Elm_Slideshow_Item_Class
20477     *
20478     * Slideshow item class definition. See @ref Slideshow_Items for
20479     * field details.
20480     */
20481    struct _Elm_Slideshow_Item_Class
20482      {
20483         struct _Elm_Slideshow_Item_Class_Func
20484           {
20485              SlideshowItemGetFunc get;
20486              SlideshowItemDelFunc del;
20487           } func;
20488      }; /**< #Elm_Slideshow_Item_Class member definitions */
20489
20490    /**
20491     * Add a new slideshow widget to the given parent Elementary
20492     * (container) object
20493     *
20494     * @param parent The parent object
20495     * @return A new slideshow widget handle or @c NULL, on errors
20496     *
20497     * This function inserts a new slideshow widget on the canvas.
20498     *
20499     * @ingroup Slideshow
20500     */
20501    EAPI Evas_Object        *elm_slideshow_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20502
20503    /**
20504     * Add (append) a new item in a given slideshow widget.
20505     *
20506     * @param obj The slideshow object
20507     * @param itc The item class for the item
20508     * @param data The item's data
20509     * @return A handle to the item added or @c NULL, on errors
20510     *
20511     * Add a new item to @p obj's internal list of items, appending it.
20512     * The item's class must contain the function really fetching the
20513     * image object to show for this item, which could be an Evas image
20514     * object or an Elementary photo, for example. The @p data
20515     * parameter is going to be passed to both class functions of the
20516     * item.
20517     *
20518     * @see #Elm_Slideshow_Item_Class
20519     * @see elm_slideshow_item_sorted_insert()
20520     *
20521     * @ingroup Slideshow
20522     */
20523    EAPI Elm_Slideshow_Item *elm_slideshow_item_add(Evas_Object *obj, const Elm_Slideshow_Item_Class *itc, const void *data) EINA_ARG_NONNULL(1);
20524
20525    /**
20526     * Insert a new item into the given slideshow widget, using the @p func
20527     * function to sort items (by item handles).
20528     *
20529     * @param obj The slideshow object
20530     * @param itc The item class for the item
20531     * @param data The item's data
20532     * @param func The comparing function to be used to sort slideshow
20533     * items <b>by #Elm_Slideshow_Item item handles</b>
20534     * @return Returns The slideshow item handle, on success, or
20535     * @c NULL, on errors
20536     *
20537     * Add a new item to @p obj's internal list of items, in a position
20538     * determined by the @p func comparing function. The item's class
20539     * must contain the function really fetching the image object to
20540     * show for this item, which could be an Evas image object or an
20541     * Elementary photo, for example. The @p data parameter is going to
20542     * be passed to both class functions of the item.
20543     *
20544     * @see #Elm_Slideshow_Item_Class
20545     * @see elm_slideshow_item_add()
20546     *
20547     * @ingroup Slideshow
20548     */
20549    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);
20550
20551    /**
20552     * Display a given slideshow widget's item, programmatically.
20553     *
20554     * @param obj The slideshow object
20555     * @param item The item to display on @p obj's viewport
20556     *
20557     * The change between the current item and @p item will use the
20558     * transition @p obj is set to use (@see
20559     * elm_slideshow_transition_set()).
20560     *
20561     * @ingroup Slideshow
20562     */
20563    EAPI void                elm_slideshow_show(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
20564
20565    /**
20566     * Slide to the @b next item, in a given slideshow widget
20567     *
20568     * @param obj The slideshow object
20569     *
20570     * The sliding animation @p obj is set to use will be the
20571     * transition effect used, after this call is issued.
20572     *
20573     * @note If the end of the slideshow's internal list of items is
20574     * reached, it'll wrap around to the list's beginning, again.
20575     *
20576     * @ingroup Slideshow
20577     */
20578    EAPI void                elm_slideshow_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
20579
20580    /**
20581     * Slide to the @b previous item, in a given slideshow widget
20582     *
20583     * @param obj The slideshow object
20584     *
20585     * The sliding animation @p obj is set to use will be the
20586     * transition effect used, after this call is issued.
20587     *
20588     * @note If the beginning of the slideshow's internal list of items
20589     * is reached, it'll wrap around to the list's end, again.
20590     *
20591     * @ingroup Slideshow
20592     */
20593    EAPI void                elm_slideshow_previous(Evas_Object *obj) EINA_ARG_NONNULL(1);
20594
20595    /**
20596     * Returns the list of sliding transition/effect names available, for a
20597     * given slideshow widget.
20598     *
20599     * @param obj The slideshow object
20600     * @return The list of transitions (list of @b stringshared strings
20601     * as data)
20602     *
20603     * The transitions, which come from @p obj's theme, must be an EDC
20604     * data item named @c "transitions" on the theme file, with (prefix)
20605     * names of EDC programs actually implementing them.
20606     *
20607     * The available transitions for slideshows on the default theme are:
20608     * - @c "fade" - the current item fades out, while the new one
20609     *   fades in to the slideshow's viewport.
20610     * - @c "black_fade" - the current item fades to black, and just
20611     *   then, the new item will fade in.
20612     * - @c "horizontal" - the current item slides horizontally, until
20613     *   it gets out of the slideshow's viewport, while the new item
20614     *   comes from the left to take its place.
20615     * - @c "vertical" - the current item slides vertically, until it
20616     *   gets out of the slideshow's viewport, while the new item comes
20617     *   from the bottom to take its place.
20618     * - @c "square" - the new item starts to appear from the middle of
20619     *   the current one, but with a tiny size, growing until its
20620     *   target (full) size and covering the old one.
20621     *
20622     * @warning The stringshared strings get no new references
20623     * exclusive to the user grabbing the list, here, so if you'd like
20624     * to use them out of this call's context, you'd better @c
20625     * eina_stringshare_ref() them.
20626     *
20627     * @see elm_slideshow_transition_set()
20628     *
20629     * @ingroup Slideshow
20630     */
20631    EAPI const Eina_List    *elm_slideshow_transitions_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20632
20633    /**
20634     * Set the current slide transition/effect in use for a given
20635     * slideshow widget
20636     *
20637     * @param obj The slideshow object
20638     * @param transition The new transition's name string
20639     *
20640     * If @p transition is implemented in @p obj's theme (i.e., is
20641     * contained in the list returned by
20642     * elm_slideshow_transitions_get()), this new sliding effect will
20643     * be used on the widget.
20644     *
20645     * @see elm_slideshow_transitions_get() for more details
20646     *
20647     * @ingroup Slideshow
20648     */
20649    EAPI void                elm_slideshow_transition_set(Evas_Object *obj, const char *transition) EINA_ARG_NONNULL(1);
20650
20651    /**
20652     * Get the current slide transition/effect in use for a given
20653     * slideshow widget
20654     *
20655     * @param obj The slideshow object
20656     * @return The current transition's name
20657     *
20658     * @see elm_slideshow_transition_set() for more details
20659     *
20660     * @ingroup Slideshow
20661     */
20662    EAPI const char         *elm_slideshow_transition_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20663
20664    /**
20665     * Set the interval between each image transition on a given
20666     * slideshow widget, <b>and start the slideshow, itself</b>
20667     *
20668     * @param obj The slideshow object
20669     * @param timeout The new displaying timeout for images
20670     *
20671     * After this call, the slideshow widget will start cycling its
20672     * view, sequentially and automatically, with the images of the
20673     * items it has. The time between each new image displayed is going
20674     * to be @p timeout, in @b seconds. If a different timeout was set
20675     * previously and an slideshow was in progress, it will continue
20676     * with the new time between transitions, after this call.
20677     *
20678     * @note A value less than or equal to 0 on @p timeout will disable
20679     * the widget's internal timer, thus halting any slideshow which
20680     * could be happening on @p obj.
20681     *
20682     * @see elm_slideshow_timeout_get()
20683     *
20684     * @ingroup Slideshow
20685     */
20686    EAPI void                elm_slideshow_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
20687
20688    /**
20689     * Get the interval set for image transitions on a given slideshow
20690     * widget.
20691     *
20692     * @param obj The slideshow object
20693     * @return Returns the timeout set on it
20694     *
20695     * @see elm_slideshow_timeout_set() for more details
20696     *
20697     * @ingroup Slideshow
20698     */
20699    EAPI double              elm_slideshow_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20700
20701    /**
20702     * Set if, after a slideshow is started, for a given slideshow
20703     * widget, its items should be displayed cyclically or not.
20704     *
20705     * @param obj The slideshow object
20706     * @param loop Use @c EINA_TRUE to make it cycle through items or
20707     * @c EINA_FALSE for it to stop at the end of @p obj's internal
20708     * list of items
20709     *
20710     * @note elm_slideshow_next() and elm_slideshow_previous() will @b
20711     * ignore what is set by this functions, i.e., they'll @b always
20712     * cycle through items. This affects only the "automatic"
20713     * slideshow, as set by elm_slideshow_timeout_set().
20714     *
20715     * @see elm_slideshow_loop_get()
20716     *
20717     * @ingroup Slideshow
20718     */
20719    EAPI void                elm_slideshow_loop_set(Evas_Object *obj, Eina_Bool loop) EINA_ARG_NONNULL(1);
20720
20721    /**
20722     * Get if, after a slideshow is started, for a given slideshow
20723     * widget, its items are to be displayed cyclically or not.
20724     *
20725     * @param obj The slideshow object
20726     * @return @c EINA_TRUE, if the items in @p obj will be cycled
20727     * through or @c EINA_FALSE, otherwise
20728     *
20729     * @see elm_slideshow_loop_set() for more details
20730     *
20731     * @ingroup Slideshow
20732     */
20733    EAPI Eina_Bool           elm_slideshow_loop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20734
20735    /**
20736     * Remove all items from a given slideshow widget
20737     *
20738     * @param obj The slideshow object
20739     *
20740     * This removes (and deletes) all items in @p obj, leaving it
20741     * empty.
20742     *
20743     * @see elm_slideshow_item_del(), to remove just one item.
20744     *
20745     * @ingroup Slideshow
20746     */
20747    EAPI void                elm_slideshow_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
20748
20749    /**
20750     * Get the internal list of items in a given slideshow widget.
20751     *
20752     * @param obj The slideshow object
20753     * @return The list of items (#Elm_Slideshow_Item as data) or
20754     * @c NULL on errors.
20755     *
20756     * This list is @b not to be modified in any way and must not be
20757     * freed. Use the list members with functions like
20758     * elm_slideshow_item_del(), elm_slideshow_item_data_get().
20759     *
20760     * @warning This list is only valid until @p obj object's internal
20761     * items list is changed. It should be fetched again with another
20762     * call to this function when changes happen.
20763     *
20764     * @ingroup Slideshow
20765     */
20766    EAPI const Eina_List    *elm_slideshow_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20767
20768    /**
20769     * Delete a given item from a slideshow widget.
20770     *
20771     * @param item The slideshow item
20772     *
20773     * @ingroup Slideshow
20774     */
20775    EAPI void                elm_slideshow_item_del(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
20776
20777    /**
20778     * Return the data associated with a given slideshow item
20779     *
20780     * @param item The slideshow item
20781     * @return Returns the data associated to this item
20782     *
20783     * @ingroup Slideshow
20784     */
20785    EAPI void               *elm_slideshow_item_data_get(const Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
20786
20787    /**
20788     * Returns the currently displayed item, in a given slideshow widget
20789     *
20790     * @param obj The slideshow object
20791     * @return A handle to the item being displayed in @p obj or
20792     * @c NULL, if none is (and on errors)
20793     *
20794     * @ingroup Slideshow
20795     */
20796    EAPI Elm_Slideshow_Item *elm_slideshow_item_current_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20797
20798    /**
20799     * Get the real Evas object created to implement the view of a
20800     * given slideshow item
20801     *
20802     * @param item The slideshow item.
20803     * @return the Evas object implementing this item's view.
20804     *
20805     * This returns the actual Evas object used to implement the
20806     * specified slideshow item's view. This may be @c NULL, as it may
20807     * not have been created or may have been deleted, at any time, by
20808     * the slideshow. <b>Do not modify this object</b> (move, resize,
20809     * show, hide, etc.), as the slideshow is controlling it. This
20810     * function is for querying, emitting custom signals or hooking
20811     * lower level callbacks for events on that object. Do not delete
20812     * this object under any circumstances.
20813     *
20814     * @see elm_slideshow_item_data_get()
20815     *
20816     * @ingroup Slideshow
20817     */
20818    EAPI Evas_Object*        elm_slideshow_item_object_get(const Elm_Slideshow_Item* item) EINA_ARG_NONNULL(1);
20819
20820    /**
20821     * Get the the item, in a given slideshow widget, placed at
20822     * position @p nth, in its internal items list
20823     *
20824     * @param obj The slideshow object
20825     * @param nth The number of the item to grab a handle to (0 being
20826     * the first)
20827     * @return The item stored in @p obj at position @p nth or @c NULL,
20828     * if there's no item with that index (and on errors)
20829     *
20830     * @ingroup Slideshow
20831     */
20832    EAPI Elm_Slideshow_Item *elm_slideshow_item_nth_get(const Evas_Object *obj, unsigned int nth) EINA_ARG_NONNULL(1);
20833
20834    /**
20835     * Set the current slide layout in use for a given slideshow widget
20836     *
20837     * @param obj The slideshow object
20838     * @param layout The new layout's name string
20839     *
20840     * If @p layout is implemented in @p obj's theme (i.e., is contained
20841     * in the list returned by elm_slideshow_layouts_get()), this new
20842     * images layout will be used on the widget.
20843     *
20844     * @see elm_slideshow_layouts_get() for more details
20845     *
20846     * @ingroup Slideshow
20847     */
20848    EAPI void                elm_slideshow_layout_set(Evas_Object *obj, const char *layout) EINA_ARG_NONNULL(1);
20849
20850    /**
20851     * Get the current slide layout in use for a given slideshow widget
20852     *
20853     * @param obj The slideshow object
20854     * @return The current layout's name
20855     *
20856     * @see elm_slideshow_layout_set() for more details
20857     *
20858     * @ingroup Slideshow
20859     */
20860    EAPI const char         *elm_slideshow_layout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20861
20862    /**
20863     * Returns the list of @b layout names available, for a given
20864     * slideshow widget.
20865     *
20866     * @param obj The slideshow object
20867     * @return The list of layouts (list of @b stringshared strings
20868     * as data)
20869     *
20870     * Slideshow layouts will change how the widget is to dispose each
20871     * image item in its viewport, with regard to cropping, scaling,
20872     * etc.
20873     *
20874     * The layouts, which come from @p obj's theme, must be an EDC
20875     * data item name @c "layouts" on the theme file, with (prefix)
20876     * names of EDC programs actually implementing them.
20877     *
20878     * The available layouts for slideshows on the default theme are:
20879     * - @c "fullscreen" - item images with original aspect, scaled to
20880     *   touch top and down slideshow borders or, if the image's heigh
20881     *   is not enough, left and right slideshow borders.
20882     * - @c "not_fullscreen" - the same behavior as the @c "fullscreen"
20883     *   one, but always leaving 10% of the slideshow's dimensions of
20884     *   distance between the item image's borders and the slideshow
20885     *   borders, for each axis.
20886     *
20887     * @warning The stringshared strings get no new references
20888     * exclusive to the user grabbing the list, here, so if you'd like
20889     * to use them out of this call's context, you'd better @c
20890     * eina_stringshare_ref() them.
20891     *
20892     * @see elm_slideshow_layout_set()
20893     *
20894     * @ingroup Slideshow
20895     */
20896    EAPI const Eina_List    *elm_slideshow_layouts_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20897
20898    /**
20899     * Set the number of items to cache, on a given slideshow widget,
20900     * <b>before the current item</b>
20901     *
20902     * @param obj The slideshow object
20903     * @param count Number of items to cache before the current one
20904     *
20905     * The default value for this property is @c 2. See
20906     * @ref Slideshow_Caching "slideshow caching" for more details.
20907     *
20908     * @see elm_slideshow_cache_before_get()
20909     *
20910     * @ingroup Slideshow
20911     */
20912    EAPI void                elm_slideshow_cache_before_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
20913
20914    /**
20915     * Retrieve the number of items to cache, on a given slideshow widget,
20916     * <b>before the current item</b>
20917     *
20918     * @param obj The slideshow object
20919     * @return The number of items set to be cached before the current one
20920     *
20921     * @see elm_slideshow_cache_before_set() for more details
20922     *
20923     * @ingroup Slideshow
20924     */
20925    EAPI int                 elm_slideshow_cache_before_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20926
20927    /**
20928     * Set the number of items to cache, on a given slideshow widget,
20929     * <b>after the current item</b>
20930     *
20931     * @param obj The slideshow object
20932     * @param count Number of items to cache after the current one
20933     *
20934     * The default value for this property is @c 2. See
20935     * @ref Slideshow_Caching "slideshow caching" for more details.
20936     *
20937     * @see elm_slideshow_cache_after_get()
20938     *
20939     * @ingroup Slideshow
20940     */
20941    EAPI void                elm_slideshow_cache_after_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
20942
20943    /**
20944     * Retrieve the number of items to cache, on a given slideshow widget,
20945     * <b>after the current item</b>
20946     *
20947     * @param obj The slideshow object
20948     * @return The number of items set to be cached after the current one
20949     *
20950     * @see elm_slideshow_cache_after_set() for more details
20951     *
20952     * @ingroup Slideshow
20953     */
20954    EAPI int                 elm_slideshow_cache_after_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20955
20956    /**
20957     * Get the number of items stored in a given slideshow widget
20958     *
20959     * @param obj The slideshow object
20960     * @return The number of items on @p obj, at the moment of this call
20961     *
20962     * @ingroup Slideshow
20963     */
20964    EAPI unsigned int        elm_slideshow_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20965
20966    /**
20967     * @}
20968     */
20969
20970    /**
20971     * @defgroup Fileselector File Selector
20972     *
20973     * @image html img/widget/fileselector/preview-00.png
20974     * @image latex img/widget/fileselector/preview-00.eps
20975     *
20976     * A file selector is a widget that allows a user to navigate
20977     * through a file system, reporting file selections back via its
20978     * API.
20979     *
20980     * It contains shortcut buttons for home directory (@c ~) and to
20981     * jump one directory upwards (..), as well as cancel/ok buttons to
20982     * confirm/cancel a given selection. After either one of those two
20983     * former actions, the file selector will issue its @c "done" smart
20984     * callback.
20985     *
20986     * There's a text entry on it, too, showing the name of the current
20987     * selection. There's the possibility of making it editable, so it
20988     * is useful on file saving dialogs on applications, where one
20989     * gives a file name to save contents to, in a given directory in
20990     * the system. This custom file name will be reported on the @c
20991     * "done" smart callback (explained in sequence).
20992     *
20993     * Finally, it has a view to display file system items into in two
20994     * possible forms:
20995     * - list
20996     * - grid
20997     *
20998     * If Elementary is built with support of the Ethumb thumbnailing
20999     * library, the second form of view will display preview thumbnails
21000     * of files which it supports.
21001     *
21002     * Smart callbacks one can register to:
21003     *
21004     * - @c "selected" - the user has clicked on a file (when not in
21005     *      folders-only mode) or directory (when in folders-only mode)
21006     * - @c "directory,open" - the list has been populated with new
21007     *      content (@c event_info is a pointer to the directory's
21008     *      path, a @b stringshared string)
21009     * - @c "done" - the user has clicked on the "ok" or "cancel"
21010     *      buttons (@c event_info is a pointer to the selection's
21011     *      path, a @b stringshared string)
21012     *
21013     * Here is an example on its usage:
21014     * @li @ref fileselector_example
21015     */
21016
21017    /**
21018     * @addtogroup Fileselector
21019     * @{
21020     */
21021
21022    /**
21023     * Defines how a file selector widget is to layout its contents
21024     * (file system entries).
21025     */
21026    typedef enum _Elm_Fileselector_Mode
21027      {
21028         ELM_FILESELECTOR_LIST = 0, /**< layout as a list */
21029         ELM_FILESELECTOR_GRID, /**< layout as a grid */
21030         ELM_FILESELECTOR_LAST /**< sentinel (helper) value, not used */
21031      } Elm_Fileselector_Mode;
21032
21033    /**
21034     * Add a new file selector widget to the given parent Elementary
21035     * (container) object
21036     *
21037     * @param parent The parent object
21038     * @return a new file selector widget handle or @c NULL, on errors
21039     *
21040     * This function inserts a new file selector widget on the canvas.
21041     *
21042     * @ingroup Fileselector
21043     */
21044    EAPI Evas_Object          *elm_fileselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21045
21046    /**
21047     * Enable/disable the file name entry box where the user can type
21048     * in a name for a file, in a given file selector widget
21049     *
21050     * @param obj The file selector object
21051     * @param is_save @c EINA_TRUE to make the file selector a "saving
21052     * dialog", @c EINA_FALSE otherwise
21053     *
21054     * Having the entry editable is useful on file saving dialogs on
21055     * applications, where one gives a file name to save contents to,
21056     * in a given directory in the system. This custom file name will
21057     * be reported on the @c "done" smart callback.
21058     *
21059     * @see elm_fileselector_is_save_get()
21060     *
21061     * @ingroup Fileselector
21062     */
21063    EAPI void                  elm_fileselector_is_save_set(Evas_Object *obj, Eina_Bool is_save) EINA_ARG_NONNULL(1);
21064
21065    /**
21066     * Get whether the given file selector is in "saving dialog" mode
21067     *
21068     * @param obj The file selector object
21069     * @return @c EINA_TRUE, if the file selector is in "saving dialog"
21070     * mode, @c EINA_FALSE otherwise (and on errors)
21071     *
21072     * @see elm_fileselector_is_save_set() for more details
21073     *
21074     * @ingroup Fileselector
21075     */
21076    EAPI Eina_Bool             elm_fileselector_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21077
21078    /**
21079     * Enable/disable folder-only view for a given file selector widget
21080     *
21081     * @param obj The file selector object
21082     * @param only @c EINA_TRUE to make @p obj only display
21083     * directories, @c EINA_FALSE to make files to be displayed in it
21084     * too
21085     *
21086     * If enabled, the widget's view will only display folder items,
21087     * naturally.
21088     *
21089     * @see elm_fileselector_folder_only_get()
21090     *
21091     * @ingroup Fileselector
21092     */
21093    EAPI void                  elm_fileselector_folder_only_set(Evas_Object *obj, Eina_Bool only) EINA_ARG_NONNULL(1);
21094
21095    /**
21096     * Get whether folder-only view is set for a given file selector
21097     * widget
21098     *
21099     * @param obj The file selector object
21100     * @return only @c EINA_TRUE if @p obj is only displaying
21101     * directories, @c EINA_FALSE if files are being displayed in it
21102     * too (and on errors)
21103     *
21104     * @see elm_fileselector_folder_only_get()
21105     *
21106     * @ingroup Fileselector
21107     */
21108    EAPI Eina_Bool             elm_fileselector_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21109
21110    /**
21111     * Enable/disable the "ok" and "cancel" buttons on a given file
21112     * selector widget
21113     *
21114     * @param obj The file selector object
21115     * @param only @c EINA_TRUE to show them, @c EINA_FALSE to hide.
21116     *
21117     * @note A file selector without those buttons will never emit the
21118     * @c "done" smart event, and is only usable if one is just hooking
21119     * to the other two events.
21120     *
21121     * @see elm_fileselector_buttons_ok_cancel_get()
21122     *
21123     * @ingroup Fileselector
21124     */
21125    EAPI void                  elm_fileselector_buttons_ok_cancel_set(Evas_Object *obj, Eina_Bool buttons) EINA_ARG_NONNULL(1);
21126
21127    /**
21128     * Get whether the "ok" and "cancel" buttons on a given file
21129     * selector widget are being shown.
21130     *
21131     * @param obj The file selector object
21132     * @return @c EINA_TRUE if they are being shown, @c EINA_FALSE
21133     * otherwise (and on errors)
21134     *
21135     * @see elm_fileselector_buttons_ok_cancel_set() for more details
21136     *
21137     * @ingroup Fileselector
21138     */
21139    EAPI Eina_Bool             elm_fileselector_buttons_ok_cancel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21140
21141    /**
21142     * Enable/disable a tree view in the given file selector widget,
21143     * <b>if it's in @c #ELM_FILESELECTOR_LIST mode</b>
21144     *
21145     * @param obj The file selector object
21146     * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
21147     * disable
21148     *
21149     * In a tree view, arrows are created on the sides of directories,
21150     * allowing them to expand in place.
21151     *
21152     * @note If it's in other mode, the changes made by this function
21153     * will only be visible when one switches back to "list" mode.
21154     *
21155     * @see elm_fileselector_expandable_get()
21156     *
21157     * @ingroup Fileselector
21158     */
21159    EAPI void                  elm_fileselector_expandable_set(Evas_Object *obj, Eina_Bool expand) EINA_ARG_NONNULL(1);
21160
21161    /**
21162     * Get whether tree view is enabled for the given file selector
21163     * widget
21164     *
21165     * @param obj The file selector object
21166     * @return @c EINA_TRUE if @p obj is in tree view, @c EINA_FALSE
21167     * otherwise (and or errors)
21168     *
21169     * @see elm_fileselector_expandable_set() for more details
21170     *
21171     * @ingroup Fileselector
21172     */
21173    EAPI Eina_Bool             elm_fileselector_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21174
21175    /**
21176     * Set, programmatically, the @b directory that a given file
21177     * selector widget will display contents from
21178     *
21179     * @param obj The file selector object
21180     * @param path The path to display in @p obj
21181     *
21182     * This will change the @b directory that @p obj is displaying. It
21183     * will also clear the text entry area on the @p obj object, which
21184     * displays select files' names.
21185     *
21186     * @see elm_fileselector_path_get()
21187     *
21188     * @ingroup Fileselector
21189     */
21190    EAPI void                  elm_fileselector_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
21191
21192    /**
21193     * Get the parent directory's path that a given file selector
21194     * widget is displaying
21195     *
21196     * @param obj The file selector object
21197     * @return The (full) path of the directory the file selector is
21198     * displaying, a @b stringshared string
21199     *
21200     * @see elm_fileselector_path_set()
21201     *
21202     * @ingroup Fileselector
21203     */
21204    EAPI const char           *elm_fileselector_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21205
21206    /**
21207     * Set, programmatically, the currently selected file/directory in
21208     * the given file selector widget
21209     *
21210     * @param obj The file selector object
21211     * @param path The (full) path to a file or directory
21212     * @return @c EINA_TRUE on success, @c EINA_FALSE on failure. The
21213     * latter case occurs if the directory or file pointed to do not
21214     * exist.
21215     *
21216     * @see elm_fileselector_selected_get()
21217     *
21218     * @ingroup Fileselector
21219     */
21220    EAPI Eina_Bool             elm_fileselector_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
21221
21222    /**
21223     * Get the currently selected item's (full) path, in the given file
21224     * selector widget
21225     *
21226     * @param obj The file selector object
21227     * @return The absolute path of the selected item, a @b
21228     * stringshared string
21229     *
21230     * @note Custom editions on @p obj object's text entry, if made,
21231     * will appear on the return string of this function, naturally.
21232     *
21233     * @see elm_fileselector_selected_set() for more details
21234     *
21235     * @ingroup Fileselector
21236     */
21237    EAPI const char           *elm_fileselector_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21238
21239    /**
21240     * Set the mode in which a given file selector widget will display
21241     * (layout) file system entries in its view
21242     *
21243     * @param obj The file selector object
21244     * @param mode The mode of the fileselector, being it one of
21245     * #ELM_FILESELECTOR_LIST (default) or #ELM_FILESELECTOR_GRID. The
21246     * first one, naturally, will display the files in a list. The
21247     * latter will make the widget to display its entries in a grid
21248     * form.
21249     *
21250     * @note By using elm_fileselector_expandable_set(), the user may
21251     * trigger a tree view for that list.
21252     *
21253     * @note If Elementary is built with support of the Ethumb
21254     * thumbnailing library, the second form of view will display
21255     * preview thumbnails of files which it supports. You must have
21256     * elm_need_ethumb() called in your Elementary for thumbnailing to
21257     * work, though.
21258     *
21259     * @see elm_fileselector_expandable_set().
21260     * @see elm_fileselector_mode_get().
21261     *
21262     * @ingroup Fileselector
21263     */
21264    EAPI void                  elm_fileselector_mode_set(Evas_Object *obj, Elm_Fileselector_Mode mode) EINA_ARG_NONNULL(1);
21265
21266    /**
21267     * Get the mode in which a given file selector widget is displaying
21268     * (layouting) file system entries in its view
21269     *
21270     * @param obj The fileselector object
21271     * @return The mode in which the fileselector is at
21272     *
21273     * @see elm_fileselector_mode_set() for more details
21274     *
21275     * @ingroup Fileselector
21276     */
21277    EAPI Elm_Fileselector_Mode elm_fileselector_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21278
21279    /**
21280     * @}
21281     */
21282
21283    /**
21284     * @defgroup Progressbar Progress bar
21285     *
21286     * The progress bar is a widget for visually representing the
21287     * progress status of a given job/task.
21288     *
21289     * A progress bar may be horizontal or vertical. It may display an
21290     * icon besides it, as well as primary and @b units labels. The
21291     * former is meant to label the widget as a whole, while the
21292     * latter, which is formatted with floating point values (and thus
21293     * accepts a <c>printf</c>-style format string, like <c>"%1.2f
21294     * units"</c>), is meant to label the widget's <b>progress
21295     * value</b>. Label, icon and unit strings/objects are @b optional
21296     * for progress bars.
21297     *
21298     * A progress bar may be @b inverted, in which state it gets its
21299     * values inverted, with high values being on the left or top and
21300     * low values on the right or bottom, as opposed to normally have
21301     * the low values on the former and high values on the latter,
21302     * respectively, for horizontal and vertical modes.
21303     *
21304     * The @b span of the progress, as set by
21305     * elm_progressbar_span_size_set(), is its length (horizontally or
21306     * vertically), unless one puts size hints on the widget to expand
21307     * on desired directions, by any container. That length will be
21308     * scaled by the object or applications scaling factor. At any
21309     * point code can query the progress bar for its value with
21310     * elm_progressbar_value_get().
21311     *
21312     * Available widget styles for progress bars:
21313     * - @c "default"
21314     * - @c "wheel" (simple style, no text, no progression, only
21315     *      "pulse" effect is available)
21316     *
21317     * Default contents parts of the progressbar widget that you can use for are:
21318     * @li "icon" - A icon of the progressbar
21319     * 
21320     * Here is an example on its usage:
21321     * @li @ref progressbar_example
21322     */
21323
21324    /**
21325     * Add a new progress bar widget to the given parent Elementary
21326     * (container) object
21327     *
21328     * @param parent The parent object
21329     * @return a new progress bar widget handle or @c NULL, on errors
21330     *
21331     * This function inserts a new progress bar widget on the canvas.
21332     *
21333     * @ingroup Progressbar
21334     */
21335    EAPI Evas_Object *elm_progressbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21336
21337    /**
21338     * Set whether a given progress bar widget is at "pulsing mode" or
21339     * not.
21340     *
21341     * @param obj The progress bar object
21342     * @param pulse @c EINA_TRUE to put @p obj in pulsing mode,
21343     * @c EINA_FALSE to put it back to its default one
21344     *
21345     * By default, progress bars will display values from the low to
21346     * high value boundaries. There are, though, contexts in which the
21347     * state of progression of a given task is @b unknown.  For those,
21348     * one can set a progress bar widget to a "pulsing state", to give
21349     * the user an idea that some computation is being held, but
21350     * without exact progress values. In the default theme it will
21351     * animate its bar with the contents filling in constantly and back
21352     * to non-filled, in a loop. To start and stop this pulsing
21353     * animation, one has to explicitly call elm_progressbar_pulse().
21354     *
21355     * @see elm_progressbar_pulse_get()
21356     * @see elm_progressbar_pulse()
21357     *
21358     * @ingroup Progressbar
21359     */
21360    EAPI void         elm_progressbar_pulse_set(Evas_Object *obj, Eina_Bool pulse) EINA_ARG_NONNULL(1);
21361
21362    /**
21363     * Get whether a given progress bar widget is at "pulsing mode" or
21364     * not.
21365     *
21366     * @param obj The progress bar object
21367     * @return @c EINA_TRUE, if @p obj is in pulsing mode, @c EINA_FALSE
21368     * if it's in the default one (and on errors)
21369     *
21370     * @ingroup Progressbar
21371     */
21372    EAPI Eina_Bool    elm_progressbar_pulse_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21373
21374    /**
21375     * Start/stop a given progress bar "pulsing" animation, if its
21376     * under that mode
21377     *
21378     * @param obj The progress bar object
21379     * @param state @c EINA_TRUE, to @b start the pulsing animation,
21380     * @c EINA_FALSE to @b stop it
21381     *
21382     * @note This call won't do anything if @p obj is not under "pulsing mode".
21383     *
21384     * @see elm_progressbar_pulse_set() for more details.
21385     *
21386     * @ingroup Progressbar
21387     */
21388    EAPI void         elm_progressbar_pulse(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
21389
21390    /**
21391     * Set the progress value (in percentage) on a given progress bar
21392     * widget
21393     *
21394     * @param obj The progress bar object
21395     * @param val The progress value (@b must be between @c 0.0 and @c
21396     * 1.0)
21397     *
21398     * Use this call to set progress bar levels.
21399     *
21400     * @note If you passes a value out of the specified range for @p
21401     * val, it will be interpreted as the @b closest of the @b boundary
21402     * values in the range.
21403     *
21404     * @ingroup Progressbar
21405     */
21406    EAPI void         elm_progressbar_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
21407
21408    /**
21409     * Get the progress value (in percentage) on a given progress bar
21410     * widget
21411     *
21412     * @param obj The progress bar object
21413     * @return The value of the progressbar
21414     *
21415     * @see elm_progressbar_value_set() for more details
21416     *
21417     * @ingroup Progressbar
21418     */
21419    EAPI double       elm_progressbar_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21420
21421    /**
21422     * Set the label of a given progress bar widget
21423     *
21424     * @param obj The progress bar object
21425     * @param label The text label string, in UTF-8
21426     *
21427     * @ingroup Progressbar
21428     * @deprecated use elm_object_text_set() instead.
21429     */
21430    EINA_DEPRECATED EAPI void         elm_progressbar_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
21431
21432    /**
21433     * Get the label of a given progress bar widget
21434     *
21435     * @param obj The progressbar object
21436     * @return The text label string, in UTF-8
21437     *
21438     * @ingroup Progressbar
21439     * @deprecated use elm_object_text_set() instead.
21440     */
21441    EINA_DEPRECATED EAPI const char  *elm_progressbar_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21442
21443    /**
21444     * Set the icon object of a given progress bar widget
21445     *
21446     * @param obj The progress bar object
21447     * @param icon The icon object
21448     *
21449     * Use this call to decorate @p obj with an icon next to it.
21450     *
21451     * @note Once the icon object is set, a previously set one will be
21452     * deleted. If you want to keep that old content object, use the
21453     * elm_progressbar_icon_unset() function.
21454     *
21455     * @see elm_progressbar_icon_get()
21456     * @deprecated use elm_object_part_content_set() instead.
21457     *
21458     * @ingroup Progressbar
21459     */
21460    WILL_DEPRECATE  EAPI void         elm_progressbar_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
21461
21462    /**
21463     * Retrieve the icon object set for a given progress bar widget
21464     *
21465     * @param obj The progress bar object
21466     * @return The icon object's handle, if @p obj had one set, or @c NULL,
21467     * otherwise (and on errors)
21468     *
21469     * @see elm_progressbar_icon_set() for more details
21470     * @deprecated use elm_object_part_content_get() instead.
21471     *
21472     * @ingroup Progressbar
21473     */
21474    WILL_DEPRECATE  EAPI Evas_Object *elm_progressbar_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21475
21476    /**
21477     * Unset an icon set on a given progress bar widget
21478     *
21479     * @param obj The progress bar object
21480     * @return The icon object that was being used, if any was set, or
21481     * @c NULL, otherwise (and on errors)
21482     *
21483     * This call will unparent and return the icon object which was set
21484     * for this widget, previously, on success.
21485     *
21486     * @see elm_progressbar_icon_set() for more details
21487     * @deprecated use elm_object_part_content_unset() instead.
21488     *
21489     * @ingroup Progressbar
21490     */
21491    WILL_DEPRECATE  EAPI Evas_Object *elm_progressbar_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
21492
21493    /**
21494     * Set the (exact) length of the bar region of a given progress bar
21495     * widget
21496     *
21497     * @param obj The progress bar object
21498     * @param size The length of the progress bar's bar region
21499     *
21500     * This sets the minimum width (when in horizontal mode) or height
21501     * (when in vertical mode) of the actual bar area of the progress
21502     * bar @p obj. This in turn affects the object's minimum size. Use
21503     * this when you're not setting other size hints expanding on the
21504     * given direction (like weight and alignment hints) and you would
21505     * like it to have a specific size.
21506     *
21507     * @note Icon, label and unit text around @p obj will require their
21508     * own space, which will make @p obj to require more the @p size,
21509     * actually.
21510     *
21511     * @see elm_progressbar_span_size_get()
21512     *
21513     * @ingroup Progressbar
21514     */
21515    EAPI void         elm_progressbar_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
21516
21517    /**
21518     * Get the length set for the bar region of a given progress bar
21519     * widget
21520     *
21521     * @param obj The progress bar object
21522     * @return The length of the progress bar's bar region
21523     *
21524     * If that size was not set previously, with
21525     * elm_progressbar_span_size_set(), this call will return @c 0.
21526     *
21527     * @ingroup Progressbar
21528     */
21529    EAPI Evas_Coord   elm_progressbar_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21530
21531    /**
21532     * Set the format string for a given progress bar widget's units
21533     * label
21534     *
21535     * @param obj The progress bar object
21536     * @param format The format string for @p obj's units label
21537     *
21538     * If @c NULL is passed on @p format, it will make @p obj's units
21539     * area to be hidden completely. If not, it'll set the <b>format
21540     * string</b> for the units label's @b text. The units label is
21541     * provided a floating point value, so the units text is up display
21542     * at most one floating point falue. Note that the units label is
21543     * optional. Use a format string such as "%1.2f meters" for
21544     * example.
21545     *
21546     * @note The default format string for a progress bar is an integer
21547     * percentage, as in @c "%.0f %%".
21548     *
21549     * @see elm_progressbar_unit_format_get()
21550     *
21551     * @ingroup Progressbar
21552     */
21553    EAPI void         elm_progressbar_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
21554
21555    /**
21556     * Retrieve the format string set for a given progress bar widget's
21557     * units label
21558     *
21559     * @param obj The progress bar object
21560     * @return The format set string for @p obj's units label or
21561     * @c NULL, if none was set (and on errors)
21562     *
21563     * @see elm_progressbar_unit_format_set() for more details
21564     *
21565     * @ingroup Progressbar
21566     */
21567    EAPI const char  *elm_progressbar_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21568
21569    /**
21570     * Set the orientation of a given progress bar widget
21571     *
21572     * @param obj The progress bar object
21573     * @param horizontal Use @c EINA_TRUE to make @p obj to be
21574     * @b horizontal, @c EINA_FALSE to make it @b vertical
21575     *
21576     * Use this function to change how your progress bar is to be
21577     * disposed: vertically or horizontally.
21578     *
21579     * @see elm_progressbar_horizontal_get()
21580     *
21581     * @ingroup Progressbar
21582     */
21583    EAPI void         elm_progressbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
21584
21585    /**
21586     * Retrieve the orientation of a given progress bar widget
21587     *
21588     * @param obj The progress bar object
21589     * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
21590     * @c EINA_FALSE if it's @b vertical (and on errors)
21591     *
21592     * @see elm_progressbar_horizontal_set() for more details
21593     *
21594     * @ingroup Progressbar
21595     */
21596    EAPI Eina_Bool    elm_progressbar_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21597
21598    /**
21599     * Invert a given progress bar widget's displaying values order
21600     *
21601     * @param obj The progress bar object
21602     * @param inverted Use @c EINA_TRUE to make @p obj inverted,
21603     * @c EINA_FALSE to bring it back to default, non-inverted values.
21604     *
21605     * A progress bar may be @b inverted, in which state it gets its
21606     * values inverted, with high values being on the left or top and
21607     * low values on the right or bottom, as opposed to normally have
21608     * the low values on the former and high values on the latter,
21609     * respectively, for horizontal and vertical modes.
21610     *
21611     * @see elm_progressbar_inverted_get()
21612     *
21613     * @ingroup Progressbar
21614     */
21615    EAPI void         elm_progressbar_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
21616
21617    /**
21618     * Get whether a given progress bar widget's displaying values are
21619     * inverted or not
21620     *
21621     * @param obj The progress bar object
21622     * @return @c EINA_TRUE, if @p obj has inverted values,
21623     * @c EINA_FALSE otherwise (and on errors)
21624     *
21625     * @see elm_progressbar_inverted_set() for more details
21626     *
21627     * @ingroup Progressbar
21628     */
21629    EAPI Eina_Bool    elm_progressbar_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21630
21631    /**
21632     * @defgroup Separator Separator
21633     *
21634     * @brief Separator is a very thin object used to separate other objects.
21635     *
21636     * A separator can be vertical or horizontal.
21637     *
21638     * @ref tutorial_separator is a good example of how to use a separator.
21639     * @{
21640     */
21641    /**
21642     * @brief Add a separator object to @p parent
21643     *
21644     * @param parent The parent object
21645     *
21646     * @return The separator object, or NULL upon failure
21647     */
21648    EAPI Evas_Object *elm_separator_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21649    /**
21650     * @brief Set the horizontal mode of a separator object
21651     *
21652     * @param obj The separator object
21653     * @param horizontal If true, the separator is horizontal
21654     */
21655    EAPI void         elm_separator_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
21656    /**
21657     * @brief Get the horizontal mode of a separator object
21658     *
21659     * @param obj The separator object
21660     * @return If true, the separator is horizontal
21661     *
21662     * @see elm_separator_horizontal_set()
21663     */
21664    EAPI Eina_Bool    elm_separator_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21665    /**
21666     * @}
21667     */
21668
21669    /**
21670     * @defgroup Spinner Spinner
21671     * @ingroup Elementary
21672     *
21673     * @image html img/widget/spinner/preview-00.png
21674     * @image latex img/widget/spinner/preview-00.eps
21675     *
21676     * A spinner is a widget which allows the user to increase or decrease
21677     * numeric values using arrow buttons, or edit values directly, clicking
21678     * over it and typing the new value.
21679     *
21680     * By default the spinner will not wrap and has a label
21681     * of "%.0f" (just showing the integer value of the double).
21682     *
21683     * A spinner has a label that is formatted with floating
21684     * point values and thus accepts a printf-style format string, like
21685     * “%1.2f units”.
21686     *
21687     * It also allows specific values to be replaced by pre-defined labels.
21688     *
21689     * Smart callbacks one can register to:
21690     *
21691     * - "changed" - Whenever the spinner value is changed.
21692     * - "delay,changed" - A short time after the value is changed by the user.
21693     *    This will be called only when the user stops dragging for a very short
21694     *    period or when they release their finger/mouse, so it avoids possibly
21695     *    expensive reactions to the value change.
21696     *
21697     * Available styles for it:
21698     * - @c "default";
21699     * - @c "vertical": up/down buttons at the right side and text left aligned.
21700     *
21701     * Here is an example on its usage:
21702     * @ref spinner_example
21703     */
21704
21705    /**
21706     * @addtogroup Spinner
21707     * @{
21708     */
21709
21710    /**
21711     * Add a new spinner widget to the given parent Elementary
21712     * (container) object.
21713     *
21714     * @param parent The parent object.
21715     * @return a new spinner widget handle or @c NULL, on errors.
21716     *
21717     * This function inserts a new spinner widget on the canvas.
21718     *
21719     * @ingroup Spinner
21720     *
21721     */
21722    EAPI Evas_Object *elm_spinner_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21723
21724    /**
21725     * Set the format string of the displayed label.
21726     *
21727     * @param obj The spinner object.
21728     * @param fmt The format string for the label display.
21729     *
21730     * If @c NULL, this sets the format to "%.0f". If not it sets the format
21731     * string for the label text. The label text is provided a floating point
21732     * value, so the label text can display up to 1 floating point value.
21733     * Note that this is optional.
21734     *
21735     * Use a format string such as "%1.2f meters" for example, and it will
21736     * display values like: "3.14 meters" for a value equal to 3.14159.
21737     *
21738     * Default is "%0.f".
21739     *
21740     * @see elm_spinner_label_format_get()
21741     *
21742     * @ingroup Spinner
21743     */
21744    EAPI void         elm_spinner_label_format_set(Evas_Object *obj, const char *fmt) EINA_ARG_NONNULL(1);
21745
21746    /**
21747     * Get the label format of the spinner.
21748     *
21749     * @param obj The spinner object.
21750     * @return The text label format string in UTF-8.
21751     *
21752     * @see elm_spinner_label_format_set() for details.
21753     *
21754     * @ingroup Spinner
21755     */
21756    EAPI const char  *elm_spinner_label_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21757
21758    /**
21759     * Set the minimum and maximum values for the spinner.
21760     *
21761     * @param obj The spinner object.
21762     * @param min The minimum value.
21763     * @param max The maximum value.
21764     *
21765     * Define the allowed range of values to be selected by the user.
21766     *
21767     * If actual value is less than @p min, it will be updated to @p min. If it
21768     * is bigger then @p max, will be updated to @p max. Actual value can be
21769     * get with elm_spinner_value_get().
21770     *
21771     * By default, min is equal to 0, and max is equal to 100.
21772     *
21773     * @warning Maximum must be greater than minimum.
21774     *
21775     * @see elm_spinner_min_max_get()
21776     *
21777     * @ingroup Spinner
21778     */
21779    EAPI void         elm_spinner_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
21780
21781    /**
21782     * Get the minimum and maximum values of the spinner.
21783     *
21784     * @param obj The spinner object.
21785     * @param min Pointer where to store the minimum value.
21786     * @param max Pointer where to store the maximum value.
21787     *
21788     * @note If only one value is needed, the other pointer can be passed
21789     * as @c NULL.
21790     *
21791     * @see elm_spinner_min_max_set() for details.
21792     *
21793     * @ingroup Spinner
21794     */
21795    EAPI void         elm_spinner_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
21796
21797    /**
21798     * Set the step used to increment or decrement the spinner value.
21799     *
21800     * @param obj The spinner object.
21801     * @param step The step value.
21802     *
21803     * This value will be incremented or decremented to the displayed value.
21804     * It will be incremented while the user keep right or top arrow pressed,
21805     * and will be decremented while the user keep left or bottom arrow pressed.
21806     *
21807     * The interval to increment / decrement can be set with
21808     * elm_spinner_interval_set().
21809     *
21810     * By default step value is equal to 1.
21811     *
21812     * @see elm_spinner_step_get()
21813     *
21814     * @ingroup Spinner
21815     */
21816    EAPI void         elm_spinner_step_set(Evas_Object *obj, double step) EINA_ARG_NONNULL(1);
21817
21818    /**
21819     * Get the step used to increment or decrement the spinner value.
21820     *
21821     * @param obj The spinner object.
21822     * @return The step value.
21823     *
21824     * @see elm_spinner_step_get() for more details.
21825     *
21826     * @ingroup Spinner
21827     */
21828    EAPI double       elm_spinner_step_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21829
21830    /**
21831     * Set the value the spinner displays.
21832     *
21833     * @param obj The spinner object.
21834     * @param val The value to be displayed.
21835     *
21836     * Value will be presented on the label following format specified with
21837     * elm_spinner_format_set().
21838     *
21839     * @warning The value must to be between min and max values. This values
21840     * are set by elm_spinner_min_max_set().
21841     *
21842     * @see elm_spinner_value_get().
21843     * @see elm_spinner_format_set().
21844     * @see elm_spinner_min_max_set().
21845     *
21846     * @ingroup Spinner
21847     */
21848    EAPI void         elm_spinner_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
21849
21850    /**
21851     * Get the value displayed by the spinner.
21852     *
21853     * @param obj The spinner object.
21854     * @return The value displayed.
21855     *
21856     * @see elm_spinner_value_set() for details.
21857     *
21858     * @ingroup Spinner
21859     */
21860    EAPI double       elm_spinner_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21861
21862    /**
21863     * Set whether the spinner should wrap when it reaches its
21864     * minimum or maximum value.
21865     *
21866     * @param obj The spinner object.
21867     * @param wrap @c EINA_TRUE to enable wrap or @c EINA_FALSE to
21868     * disable it.
21869     *
21870     * Disabled by default. If disabled, when the user tries to increment the
21871     * value,
21872     * but displayed value plus step value is bigger than maximum value,
21873     * the spinner
21874     * won't allow it. The same happens when the user tries to decrement it,
21875     * but the value less step is less than minimum value.
21876     *
21877     * When wrap is enabled, in such situations it will allow these changes,
21878     * but will get the value that would be less than minimum and subtracts
21879     * from maximum. Or add the value that would be more than maximum to
21880     * the minimum.
21881     *
21882     * E.g.:
21883     * @li min value = 10
21884     * @li max value = 50
21885     * @li step value = 20
21886     * @li displayed value = 20
21887     *
21888     * When the user decrement value (using left or bottom arrow), it will
21889     * displays @c 40, because max - (min - (displayed - step)) is
21890     * @c 50 - (@c 10 - (@c 20 - @c 20)) = @c 40.
21891     *
21892     * @see elm_spinner_wrap_get().
21893     *
21894     * @ingroup Spinner
21895     */
21896    EAPI void         elm_spinner_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
21897
21898    /**
21899     * Get whether the spinner should wrap when it reaches its
21900     * minimum or maximum value.
21901     *
21902     * @param obj The spinner object
21903     * @return @c EINA_TRUE means wrap is enabled. @c EINA_FALSE indicates
21904     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
21905     *
21906     * @see elm_spinner_wrap_set() for details.
21907     *
21908     * @ingroup Spinner
21909     */
21910    EAPI Eina_Bool    elm_spinner_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21911
21912    /**
21913     * Set whether the spinner can be directly edited by the user or not.
21914     *
21915     * @param obj The spinner object.
21916     * @param editable @c EINA_TRUE to allow users to edit it or @c EINA_FALSE to
21917     * don't allow users to edit it directly.
21918     *
21919     * Spinner objects can have edition @b disabled, in which state they will
21920     * be changed only by arrows.
21921     * Useful for contexts
21922     * where you don't want your users to interact with it writting the value.
21923     * Specially
21924     * when using special values, the user can see real value instead
21925     * of special label on edition.
21926     *
21927     * It's enabled by default.
21928     *
21929     * @see elm_spinner_editable_get()
21930     *
21931     * @ingroup Spinner
21932     */
21933    EAPI void         elm_spinner_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
21934
21935    /**
21936     * Get whether the spinner can be directly edited by the user or not.
21937     *
21938     * @param obj The spinner object.
21939     * @return @c EINA_TRUE means edition is enabled. @c EINA_FALSE indicates
21940     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
21941     *
21942     * @see elm_spinner_editable_set() for details.
21943     *
21944     * @ingroup Spinner
21945     */
21946    EAPI Eina_Bool    elm_spinner_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21947
21948    /**
21949     * Set a special string to display in the place of the numerical value.
21950     *
21951     * @param obj The spinner object.
21952     * @param value The value to be replaced.
21953     * @param label The label to be used.
21954     *
21955     * It's useful for cases when a user should select an item that is
21956     * better indicated by a label than a value. For example, weekdays or months.
21957     *
21958     * E.g.:
21959     * @code
21960     * sp = elm_spinner_add(win);
21961     * elm_spinner_min_max_set(sp, 1, 3);
21962     * elm_spinner_special_value_add(sp, 1, "January");
21963     * elm_spinner_special_value_add(sp, 2, "February");
21964     * elm_spinner_special_value_add(sp, 3, "March");
21965     * evas_object_show(sp);
21966     * @endcode
21967     *
21968     * @ingroup Spinner
21969     */
21970    EAPI void         elm_spinner_special_value_add(Evas_Object *obj, double value, const char *label) EINA_ARG_NONNULL(1);
21971
21972    /**
21973     * Set the interval on time updates for an user mouse button hold
21974     * on spinner widgets' arrows.
21975     *
21976     * @param obj The spinner object.
21977     * @param interval The (first) interval value in seconds.
21978     *
21979     * This interval value is @b decreased while the user holds the
21980     * mouse pointer either incrementing or decrementing spinner's value.
21981     *
21982     * This helps the user to get to a given value distant from the
21983     * current one easier/faster, as it will start to change quicker and
21984     * quicker on mouse button holds.
21985     *
21986     * The calculation for the next change interval value, starting from
21987     * the one set with this call, is the previous interval divided by
21988     * @c 1.05, so it decreases a little bit.
21989     *
21990     * The default starting interval value for automatic changes is
21991     * @c 0.85 seconds.
21992     *
21993     * @see elm_spinner_interval_get()
21994     *
21995     * @ingroup Spinner
21996     */
21997    EAPI void         elm_spinner_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
21998
21999    /**
22000     * Get the interval on time updates for an user mouse button hold
22001     * on spinner widgets' arrows.
22002     *
22003     * @param obj The spinner object.
22004     * @return The (first) interval value, in seconds, set on it.
22005     *
22006     * @see elm_spinner_interval_set() for more details.
22007     *
22008     * @ingroup Spinner
22009     */
22010    EAPI double       elm_spinner_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22011
22012    /**
22013     * @}
22014     */
22015
22016    /**
22017     * @defgroup Index Index
22018     *
22019     * @image html img/widget/index/preview-00.png
22020     * @image latex img/widget/index/preview-00.eps
22021     *
22022     * An index widget gives you an index for fast access to whichever
22023     * group of other UI items one might have. It's a list of text
22024     * items (usually letters, for alphabetically ordered access).
22025     *
22026     * Index widgets are by default hidden and just appear when the
22027     * user clicks over it's reserved area in the canvas. In its
22028     * default theme, it's an area one @ref Fingers "finger" wide on
22029     * the right side of the index widget's container.
22030     *
22031     * When items on the index are selected, smart callbacks get
22032     * called, so that its user can make other container objects to
22033     * show a given area or child object depending on the index item
22034     * selected. You'd probably be using an index together with @ref
22035     * List "lists", @ref Genlist "generic lists" or @ref Gengrid
22036     * "general grids".
22037     *
22038     * Smart events one  can add callbacks for are:
22039     * - @c "changed" - When the selected index item changes. @c
22040     *      event_info is the selected item's data pointer.
22041     * - @c "delay,changed" - When the selected index item changes, but
22042     *      after a small idling period. @c event_info is the selected
22043     *      item's data pointer.
22044     * - @c "selected" - When the user releases a mouse button and
22045     *      selects an item. @c event_info is the selected item's data
22046     *      pointer.
22047     * - @c "level,up" - when the user moves a finger from the first
22048     *      level to the second level
22049     * - @c "level,down" - when the user moves a finger from the second
22050     *      level to the first level
22051     *
22052     * The @c "delay,changed" event is so that it'll wait a small time
22053     * before actually reporting those events and, moreover, just the
22054     * last event happening on those time frames will actually be
22055     * reported.
22056     *
22057     * Here are some examples on its usage:
22058     * @li @ref index_example_01
22059     * @li @ref index_example_02
22060     */
22061
22062    /**
22063     * @addtogroup Index
22064     * @{
22065     */
22066
22067    typedef struct _Elm_Index_Item Elm_Index_Item; /**< Opaque handle for items of Elementary index widgets */
22068
22069    /**
22070     * Add a new index widget to the given parent Elementary
22071     * (container) object
22072     *
22073     * @param parent The parent object
22074     * @return a new index widget handle or @c NULL, on errors
22075     *
22076     * This function inserts a new index widget on the canvas.
22077     *
22078     * @ingroup Index
22079     */
22080    EAPI Evas_Object    *elm_index_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22081
22082    /**
22083     * Set whether a given index widget is or not visible,
22084     * programatically.
22085     *
22086     * @param obj The index object
22087     * @param active @c EINA_TRUE to show it, @c EINA_FALSE to hide it
22088     *
22089     * Not to be confused with visible as in @c evas_object_show() --
22090     * visible with regard to the widget's auto hiding feature.
22091     *
22092     * @see elm_index_active_get()
22093     *
22094     * @ingroup Index
22095     */
22096    EAPI void            elm_index_active_set(Evas_Object *obj, Eina_Bool active) EINA_ARG_NONNULL(1);
22097
22098    /**
22099     * Get whether a given index widget is currently visible or not.
22100     *
22101     * @param obj The index object
22102     * @return @c EINA_TRUE, if it's shown, @c EINA_FALSE otherwise
22103     *
22104     * @see elm_index_active_set() for more details
22105     *
22106     * @ingroup Index
22107     */
22108    EAPI Eina_Bool       elm_index_active_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22109
22110    /**
22111     * Set the items level for a given index widget.
22112     *
22113     * @param obj The index object.
22114     * @param level @c 0 or @c 1, the currently implemented levels.
22115     *
22116     * @see elm_index_item_level_get()
22117     *
22118     * @ingroup Index
22119     */
22120    EAPI void            elm_index_item_level_set(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
22121
22122    /**
22123     * Get the items level set for a given index widget.
22124     *
22125     * @param obj The index object.
22126     * @return @c 0 or @c 1, which are the levels @p obj might be at.
22127     *
22128     * @see elm_index_item_level_set() for more information
22129     *
22130     * @ingroup Index
22131     */
22132    EAPI int             elm_index_item_level_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22133
22134    /**
22135     * Returns the last selected item's data, for a given index widget.
22136     *
22137     * @param obj The index object.
22138     * @return The item @b data associated to the last selected item on
22139     * @p obj (or @c NULL, on errors).
22140     *
22141     * @warning The returned value is @b not an #Elm_Index_Item item
22142     * handle, but the data associated to it (see the @c item parameter
22143     * in elm_index_item_append(), as an example).
22144     *
22145     * @ingroup Index
22146     */
22147    EAPI void           *elm_index_item_selected_get(const Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
22148
22149    /**
22150     * Append a new item on a given index widget.
22151     *
22152     * @param obj The index object.
22153     * @param letter Letter under which the item should be indexed
22154     * @param item The item data to set for the index's item
22155     *
22156     * Despite the most common usage of the @p letter argument is for
22157     * single char strings, one could use arbitrary strings as index
22158     * entries.
22159     *
22160     * @c item will be the pointer returned back on @c "changed", @c
22161     * "delay,changed" and @c "selected" smart events.
22162     *
22163     * @ingroup Index
22164     */
22165    EAPI void            elm_index_item_append(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
22166
22167    /**
22168     * Prepend a new item on a given index widget.
22169     *
22170     * @param obj The index object.
22171     * @param letter Letter under which the item should be indexed
22172     * @param item The item data to set for the index's item
22173     *
22174     * Despite the most common usage of the @p letter argument is for
22175     * single char strings, one could use arbitrary strings as index
22176     * entries.
22177     *
22178     * @c item will be the pointer returned back on @c "changed", @c
22179     * "delay,changed" and @c "selected" smart events.
22180     *
22181     * @ingroup Index
22182     */
22183    EAPI void            elm_index_item_prepend(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
22184
22185    /**
22186     * Append a new item, on a given index widget, <b>after the item
22187     * having @p relative as data</b>.
22188     *
22189     * @param obj The index object.
22190     * @param letter Letter under which the item should be indexed
22191     * @param item The item data to set for the index's item
22192     * @param relative The item data of the index item to be the
22193     * predecessor of this new one
22194     *
22195     * Despite the most common usage of the @p letter argument is for
22196     * single char strings, one could use arbitrary strings as index
22197     * entries.
22198     *
22199     * @c item will be the pointer returned back on @c "changed", @c
22200     * "delay,changed" and @c "selected" smart events.
22201     *
22202     * @note If @p relative is @c NULL or if it's not found to be data
22203     * set on any previous item on @p obj, this function will behave as
22204     * elm_index_item_append().
22205     *
22206     * @ingroup Index
22207     */
22208    EAPI void            elm_index_item_append_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
22209
22210    /**
22211     * Prepend a new item, on a given index widget, <b>after the item
22212     * having @p relative as data</b>.
22213     *
22214     * @param obj The index object.
22215     * @param letter Letter under which the item should be indexed
22216     * @param item The item data to set for the index's item
22217     * @param relative The item data of the index item to be the
22218     * successor of this new one
22219     *
22220     * Despite the most common usage of the @p letter argument is for
22221     * single char strings, one could use arbitrary strings as index
22222     * entries.
22223     *
22224     * @c item will be the pointer returned back on @c "changed", @c
22225     * "delay,changed" and @c "selected" smart events.
22226     *
22227     * @note If @p relative is @c NULL or if it's not found to be data
22228     * set on any previous item on @p obj, this function will behave as
22229     * elm_index_item_prepend().
22230     *
22231     * @ingroup Index
22232     */
22233    EAPI void            elm_index_item_prepend_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
22234
22235    /**
22236     * Insert a new item into the given index widget, using @p cmp_func
22237     * function to sort items (by item handles).
22238     *
22239     * @param obj The index object.
22240     * @param letter Letter under which the item should be indexed
22241     * @param item The item data to set for the index's item
22242     * @param cmp_func The comparing function to be used to sort index
22243     * items <b>by #Elm_Index_Item item handles</b>
22244     * @param cmp_data_func A @b fallback function to be called for the
22245     * sorting of index items <b>by item data</b>). It will be used
22246     * when @p cmp_func returns @c 0 (equality), which means an index
22247     * item with provided item data already exists. To decide which
22248     * data item should be pointed to by the index item in question, @p
22249     * cmp_data_func will be used. If @p cmp_data_func returns a
22250     * non-negative value, the previous index item data will be
22251     * replaced by the given @p item pointer. If the previous data need
22252     * to be freed, it should be done by the @p cmp_data_func function,
22253     * because all references to it will be lost. If this function is
22254     * not provided (@c NULL is given), index items will be @b
22255     * duplicated, if @p cmp_func returns @c 0.
22256     *
22257     * Despite the most common usage of the @p letter argument is for
22258     * single char strings, one could use arbitrary strings as index
22259     * entries.
22260     *
22261     * @c item will be the pointer returned back on @c "changed", @c
22262     * "delay,changed" and @c "selected" smart events.
22263     *
22264     * @ingroup Index
22265     */
22266    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);
22267
22268    /**
22269     * Remove an item from a given index widget, <b>to be referenced by
22270     * it's data value</b>.
22271     *
22272     * @param obj The index object
22273     * @param item The item's data pointer for the item to be removed
22274     * from @p obj
22275     *
22276     * If a deletion callback is set, via elm_index_item_del_cb_set(),
22277     * that callback function will be called by this one.
22278     *
22279     * @warning The item to be removed from @p obj will be found via
22280     * its item data pointer, and not by an #Elm_Index_Item handle.
22281     *
22282     * @ingroup Index
22283     */
22284    EAPI void            elm_index_item_del(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
22285
22286    /**
22287     * Find a given index widget's item, <b>using item data</b>.
22288     *
22289     * @param obj The index object
22290     * @param item The item data pointed to by the desired index item
22291     * @return The index item handle, if found, or @c NULL otherwise
22292     *
22293     * @ingroup Index
22294     */
22295    EAPI Elm_Index_Item *elm_index_item_find(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
22296
22297    /**
22298     * Removes @b all items from a given index widget.
22299     *
22300     * @param obj The index object.
22301     *
22302     * If deletion callbacks are set, via elm_index_item_del_cb_set(),
22303     * that callback function will be called for each item in @p obj.
22304     *
22305     * @ingroup Index
22306     */
22307    EAPI void            elm_index_item_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
22308
22309    /**
22310     * Go to a given items level on a index widget
22311     *
22312     * @param obj The index object
22313     * @param level The index level (one of @c 0 or @c 1)
22314     *
22315     * @ingroup Index
22316     */
22317    EAPI void            elm_index_item_go(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
22318
22319    /**
22320     * Return the data associated with a given index widget item
22321     *
22322     * @param it The index widget item handle
22323     * @return The data associated with @p it
22324     *
22325     * @see elm_index_item_data_set()
22326     *
22327     * @ingroup Index
22328     */
22329    EAPI void           *elm_index_item_data_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
22330
22331    /**
22332     * Set the data associated with a given index widget item
22333     *
22334     * @param it The index widget item handle
22335     * @param data The new data pointer to set to @p it
22336     *
22337     * This sets new item data on @p it.
22338     *
22339     * @warning The old data pointer won't be touched by this function, so
22340     * the user had better to free that old data himself/herself.
22341     *
22342     * @ingroup Index
22343     */
22344    EAPI void            elm_index_item_data_set(Elm_Index_Item *it, const void *data) EINA_ARG_NONNULL(1);
22345
22346    /**
22347     * Set the function to be called when a given index widget item is freed.
22348     *
22349     * @param it The item to set the callback on
22350     * @param func The function to call on the item's deletion
22351     *
22352     * When called, @p func will have both @c data and @c event_info
22353     * arguments with the @p it item's data value and, naturally, the
22354     * @c obj argument with a handle to the parent index widget.
22355     *
22356     * @ingroup Index
22357     */
22358    EAPI void            elm_index_item_del_cb_set(Elm_Index_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
22359
22360    /**
22361     * Get the letter (string) set on a given index widget item.
22362     *
22363     * @param it The index item handle
22364     * @return The letter string set on @p it
22365     *
22366     * @ingroup Index
22367     */
22368    EAPI const char     *elm_index_item_letter_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
22369
22370    /**
22371     */
22372    EAPI void            elm_index_button_image_invisible_set(Evas_Object *obj, Eina_Bool invisible) EINA_ARG_NONNULL(1);
22373
22374    /**
22375     * @}
22376     */
22377
22378    /**
22379     * @defgroup Photocam Photocam
22380     *
22381     * @image html img/widget/photocam/preview-00.png
22382     * @image latex img/widget/photocam/preview-00.eps
22383     *
22384     * This is a widget specifically for displaying high-resolution digital
22385     * camera photos giving speedy feedback (fast load), low memory footprint
22386     * and zooming and panning as well as fitting logic. It is entirely focused
22387     * on jpeg images, and takes advantage of properties of the jpeg format (via
22388     * evas loader features in the jpeg loader).
22389     *
22390     * Signals that you can add callbacks for are:
22391     * @li "clicked" - This is called when a user has clicked the photo without
22392     *                 dragging around.
22393     * @li "press" - This is called when a user has pressed down on the photo.
22394     * @li "longpressed" - This is called when a user has pressed down on the
22395     *                     photo for a long time without dragging around.
22396     * @li "clicked,double" - This is called when a user has double-clicked the
22397     *                        photo.
22398     * @li "load" - Photo load begins.
22399     * @li "loaded" - This is called when the image file load is complete for the
22400     *                first view (low resolution blurry version).
22401     * @li "load,detail" - Photo detailed data load begins.
22402     * @li "loaded,detail" - This is called when the image file load is complete
22403     *                      for the detailed image data (full resolution needed).
22404     * @li "zoom,start" - Zoom animation started.
22405     * @li "zoom,stop" - Zoom animation stopped.
22406     * @li "zoom,change" - Zoom changed when using an auto zoom mode.
22407     * @li "scroll" - the content has been scrolled (moved)
22408     * @li "scroll,anim,start" - scrolling animation has started
22409     * @li "scroll,anim,stop" - scrolling animation has stopped
22410     * @li "scroll,drag,start" - dragging the contents around has started
22411     * @li "scroll,drag,stop" - dragging the contents around has stopped
22412     *
22413     * @ref tutorial_photocam shows the API in action.
22414     * @{
22415     */
22416    /**
22417     * @brief Types of zoom available.
22418     */
22419    typedef enum _Elm_Photocam_Zoom_Mode
22420      {
22421         ELM_PHOTOCAM_ZOOM_MODE_MANUAL = 0, /**< Zoom controled normally by elm_photocam_zoom_set */
22422         ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT, /**< Zoom until photo fits in photocam */
22423         ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL, /**< Zoom until photo fills photocam */
22424         ELM_PHOTOCAM_ZOOM_MODE_LAST
22425      } Elm_Photocam_Zoom_Mode;
22426    /**
22427     * @brief Add a new Photocam object
22428     *
22429     * @param parent The parent object
22430     * @return The new object or NULL if it cannot be created
22431     */
22432    EAPI Evas_Object           *elm_photocam_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22433    /**
22434     * @brief Set the photo file to be shown
22435     *
22436     * @param obj The photocam object
22437     * @param file The photo file
22438     * @return The return error (see EVAS_LOAD_ERROR_NONE, EVAS_LOAD_ERROR_GENERIC etc.)
22439     *
22440     * This sets (and shows) the specified file (with a relative or absolute
22441     * path) and will return a load error (same error that
22442     * evas_object_image_load_error_get() will return). The image will change and
22443     * adjust its size at this point and begin a background load process for this
22444     * photo that at some time in the future will be displayed at the full
22445     * quality needed.
22446     */
22447    EAPI Evas_Load_Error        elm_photocam_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
22448    /**
22449     * @brief Returns the path of the current image file
22450     *
22451     * @param obj The photocam object
22452     * @return Returns the path
22453     *
22454     * @see elm_photocam_file_set()
22455     */
22456    EAPI const char            *elm_photocam_file_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22457    /**
22458     * @brief Set the zoom level of the photo
22459     *
22460     * @param obj The photocam object
22461     * @param zoom The zoom level to set
22462     *
22463     * This sets the zoom level. 1 will be 1:1 pixel for pixel. 2 will be 2:1
22464     * (that is 2x2 photo pixels will display as 1 on-screen pixel). 4:1 will be
22465     * 4x4 photo pixels as 1 screen pixel, and so on. The @p zoom parameter must
22466     * be greater than 0. It is usggested to stick to powers of 2. (1, 2, 4, 8,
22467     * 16, 32, etc.).
22468     */
22469    EAPI void                   elm_photocam_zoom_set(Evas_Object *obj, double zoom) EINA_ARG_NONNULL(1);
22470    /**
22471     * @brief Get the zoom level of the photo
22472     *
22473     * @param obj The photocam object
22474     * @return The current zoom level
22475     *
22476     * This returns the current zoom level of the photocam object. Note that if
22477     * you set the fill mode to other than ELM_PHOTOCAM_ZOOM_MODE_MANUAL
22478     * (which is the default), the zoom level may be changed at any time by the
22479     * photocam object itself to account for photo size and photocam viewpoer
22480     * size.
22481     *
22482     * @see elm_photocam_zoom_set()
22483     * @see elm_photocam_zoom_mode_set()
22484     */
22485    EAPI double                 elm_photocam_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22486    /**
22487     * @brief Set the zoom mode
22488     *
22489     * @param obj The photocam object
22490     * @param mode The desired mode
22491     *
22492     * This sets the zoom mode to manual or one of several automatic levels.
22493     * Manual (ELM_PHOTOCAM_ZOOM_MODE_MANUAL) means that zoom is set manually by
22494     * elm_photocam_zoom_set() and will stay at that level until changed by code
22495     * or until zoom mode is changed. This is the default mode. The Automatic
22496     * modes will allow the photocam object to automatically adjust zoom mode
22497     * based on properties. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT) will adjust zoom so
22498     * the photo fits EXACTLY inside the scroll frame with no pixels outside this
22499     * area. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL will be similar but ensure no
22500     * pixels within the frame are left unfilled.
22501     */
22502    EAPI void                   elm_photocam_zoom_mode_set(Evas_Object *obj, Elm_Photocam_Zoom_Mode mode) EINA_ARG_NONNULL(1);
22503    /**
22504     * @brief Get the zoom mode
22505     *
22506     * @param obj The photocam object
22507     * @return The current zoom mode
22508     *
22509     * This gets the current zoom mode of the photocam object.
22510     *
22511     * @see elm_photocam_zoom_mode_set()
22512     */
22513    EAPI Elm_Photocam_Zoom_Mode elm_photocam_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22514    /**
22515     * @brief Get the current image pixel width and height
22516     *
22517     * @param obj The photocam object
22518     * @param w A pointer to the width return
22519     * @param h A pointer to the height return
22520     *
22521     * This gets the current photo pixel width and height (for the original).
22522     * The size will be returned in the integers @p w and @p h that are pointed
22523     * to.
22524     */
22525    EAPI void                   elm_photocam_image_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
22526    /**
22527     * @brief Get the area of the image that is currently shown
22528     *
22529     * @param obj
22530     * @param x A pointer to the X-coordinate of region
22531     * @param y A pointer to the Y-coordinate of region
22532     * @param w A pointer to the width
22533     * @param h A pointer to the height
22534     *
22535     * @see elm_photocam_image_region_show()
22536     * @see elm_photocam_image_region_bring_in()
22537     */
22538    EAPI void                   elm_photocam_region_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
22539    /**
22540     * @brief Set the viewed portion of the image
22541     *
22542     * @param obj The photocam object
22543     * @param x X-coordinate of region in image original pixels
22544     * @param y Y-coordinate of region in image original pixels
22545     * @param w Width of region in image original pixels
22546     * @param h Height of region in image original pixels
22547     *
22548     * This shows the region of the image without using animation.
22549     */
22550    EAPI void                   elm_photocam_image_region_show(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
22551    /**
22552     * @brief Bring in the viewed portion of the image
22553     *
22554     * @param obj The photocam object
22555     * @param x X-coordinate of region in image original pixels
22556     * @param y Y-coordinate of region in image original pixels
22557     * @param w Width of region in image original pixels
22558     * @param h Height of region in image original pixels
22559     *
22560     * This shows the region of the image using animation.
22561     */
22562    EAPI void                   elm_photocam_image_region_bring_in(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
22563    /**
22564     * @brief Set the paused state for photocam
22565     *
22566     * @param obj The photocam object
22567     * @param paused The pause state to set
22568     *
22569     * This sets the paused state to on(EINA_TRUE) or off (EINA_FALSE) for
22570     * photocam. The default is off. This will stop zooming using animation on
22571     * zoom levels changes and change instantly. This will stop any existing
22572     * animations that are running.
22573     */
22574    EAPI void                   elm_photocam_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
22575    /**
22576     * @brief Get the paused state for photocam
22577     *
22578     * @param obj The photocam object
22579     * @return The current paused state
22580     *
22581     * This gets the current paused state for the photocam object.
22582     *
22583     * @see elm_photocam_paused_set()
22584     */
22585    EAPI Eina_Bool              elm_photocam_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22586    /**
22587     * @brief Get the internal low-res image used for photocam
22588     *
22589     * @param obj The photocam object
22590     * @return The internal image object handle, or NULL if none exists
22591     *
22592     * This gets the internal image object inside photocam. Do not modify it. It
22593     * is for inspection only, and hooking callbacks to. Nothing else. It may be
22594     * deleted at any time as well.
22595     */
22596    EAPI Evas_Object           *elm_photocam_internal_image_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22597    /**
22598     * @brief Set the photocam scrolling bouncing.
22599     *
22600     * @param obj The photocam object
22601     * @param h_bounce bouncing for horizontal
22602     * @param v_bounce bouncing for vertical
22603     */
22604    EAPI void                   elm_photocam_bounce_set(Evas_Object *obj,  Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
22605    /**
22606     * @brief Get the photocam scrolling bouncing.
22607     *
22608     * @param obj The photocam object
22609     * @param h_bounce bouncing for horizontal
22610     * @param v_bounce bouncing for vertical
22611     *
22612     * @see elm_photocam_bounce_set()
22613     */
22614    EAPI void                   elm_photocam_bounce_get(const Evas_Object *obj,  Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
22615    /**
22616     * @}
22617     */
22618
22619    /**
22620     * @defgroup Map Map
22621     * @ingroup Elementary
22622     *
22623     * @image html img/widget/map/preview-00.png
22624     * @image latex img/widget/map/preview-00.eps
22625     *
22626     * This is a widget specifically for displaying a map. It uses basically
22627     * OpenStreetMap provider http://www.openstreetmap.org/,
22628     * but custom providers can be added.
22629     *
22630     * It supports some basic but yet nice features:
22631     * @li zoom and scroll
22632     * @li markers with content to be displayed when user clicks over it
22633     * @li group of markers
22634     * @li routes
22635     *
22636     * Smart callbacks one can listen to:
22637     *
22638     * - "clicked" - This is called when a user has clicked the map without
22639     *   dragging around.
22640     * - "press" - This is called when a user has pressed down on the map.
22641     * - "longpressed" - This is called when a user has pressed down on the map
22642     *   for a long time without dragging around.
22643     * - "clicked,double" - This is called when a user has double-clicked
22644     *   the map.
22645     * - "load,detail" - Map detailed data load begins.
22646     * - "loaded,detail" - This is called when all currently visible parts of
22647     *   the map are loaded.
22648     * - "zoom,start" - Zoom animation started.
22649     * - "zoom,stop" - Zoom animation stopped.
22650     * - "zoom,change" - Zoom changed when using an auto zoom mode.
22651     * - "scroll" - the content has been scrolled (moved).
22652     * - "scroll,anim,start" - scrolling animation has started.
22653     * - "scroll,anim,stop" - scrolling animation has stopped.
22654     * - "scroll,drag,start" - dragging the contents around has started.
22655     * - "scroll,drag,stop" - dragging the contents around has stopped.
22656     * - "downloaded" - This is called when all currently required map images
22657     *   are downloaded.
22658     * - "route,load" - This is called when route request begins.
22659     * - "route,loaded" - This is called when route request ends.
22660     * - "name,load" - This is called when name request begins.
22661     * - "name,loaded- This is called when name request ends.
22662     *
22663     * Available style for map widget:
22664     * - @c "default"
22665     *
22666     * Available style for markers:
22667     * - @c "radio"
22668     * - @c "radio2"
22669     * - @c "empty"
22670     *
22671     * Available style for marker bubble:
22672     * - @c "default"
22673     *
22674     * List of examples:
22675     * @li @ref map_example_01
22676     * @li @ref map_example_02
22677     * @li @ref map_example_03
22678     */
22679
22680    /**
22681     * @addtogroup Map
22682     * @{
22683     */
22684
22685    /**
22686     * @enum _Elm_Map_Zoom_Mode
22687     * @typedef Elm_Map_Zoom_Mode
22688     *
22689     * Set map's zoom behavior. It can be set to manual or automatic.
22690     *
22691     * Default value is #ELM_MAP_ZOOM_MODE_MANUAL.
22692     *
22693     * Values <b> don't </b> work as bitmask, only one can be choosen.
22694     *
22695     * @note Valid sizes are 2^zoom, consequently the map may be smaller
22696     * than the scroller view.
22697     *
22698     * @see elm_map_zoom_mode_set()
22699     * @see elm_map_zoom_mode_get()
22700     *
22701     * @ingroup Map
22702     */
22703    typedef enum _Elm_Map_Zoom_Mode
22704      {
22705         ELM_MAP_ZOOM_MODE_MANUAL, /**< Zoom controled manually by elm_map_zoom_set(). It's set by default. */
22706         ELM_MAP_ZOOM_MODE_AUTO_FIT, /**< Zoom until map fits inside the scroll frame with no pixels outside this area. */
22707         ELM_MAP_ZOOM_MODE_AUTO_FILL, /**< Zoom until map fills scroll, ensuring no pixels are left unfilled. */
22708         ELM_MAP_ZOOM_MODE_LAST
22709      } Elm_Map_Zoom_Mode;
22710
22711    /**
22712     * @enum _Elm_Map_Route_Sources
22713     * @typedef Elm_Map_Route_Sources
22714     *
22715     * Set route service to be used. By default used source is
22716     * #ELM_MAP_ROUTE_SOURCE_YOURS.
22717     *
22718     * @see elm_map_route_source_set()
22719     * @see elm_map_route_source_get()
22720     *
22721     * @ingroup Map
22722     */
22723    typedef enum _Elm_Map_Route_Sources
22724      {
22725         ELM_MAP_ROUTE_SOURCE_YOURS, /**< Routing service http://www.yournavigation.org/ . Set by default.*/
22726         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. */
22727         ELM_MAP_ROUTE_SOURCE_ORS, /**< Open Route Service: http://www.openrouteservice.org/ . It's not working with Map yet. */
22728         ELM_MAP_ROUTE_SOURCE_LAST
22729      } Elm_Map_Route_Sources;
22730
22731    typedef enum _Elm_Map_Name_Sources
22732      {
22733         ELM_MAP_NAME_SOURCE_NOMINATIM,
22734         ELM_MAP_NAME_SOURCE_LAST
22735      } Elm_Map_Name_Sources;
22736
22737    /**
22738     * @enum _Elm_Map_Route_Type
22739     * @typedef Elm_Map_Route_Type
22740     *
22741     * Set type of transport used on route.
22742     *
22743     * @see elm_map_route_add()
22744     *
22745     * @ingroup Map
22746     */
22747    typedef enum _Elm_Map_Route_Type
22748      {
22749         ELM_MAP_ROUTE_TYPE_MOTOCAR, /**< Route should consider an automobile will be used. */
22750         ELM_MAP_ROUTE_TYPE_BICYCLE, /**< Route should consider a bicycle will be used by the user. */
22751         ELM_MAP_ROUTE_TYPE_FOOT, /**< Route should consider user will be walking. */
22752         ELM_MAP_ROUTE_TYPE_LAST
22753      } Elm_Map_Route_Type;
22754
22755    /**
22756     * @enum _Elm_Map_Route_Method
22757     * @typedef Elm_Map_Route_Method
22758     *
22759     * Set the routing method, what should be priorized, time or distance.
22760     *
22761     * @see elm_map_route_add()
22762     *
22763     * @ingroup Map
22764     */
22765    typedef enum _Elm_Map_Route_Method
22766      {
22767         ELM_MAP_ROUTE_METHOD_FASTEST, /**< Route should priorize time. */
22768         ELM_MAP_ROUTE_METHOD_SHORTEST, /**< Route should priorize distance. */
22769         ELM_MAP_ROUTE_METHOD_LAST
22770      } Elm_Map_Route_Method;
22771
22772    typedef enum _Elm_Map_Name_Method
22773      {
22774         ELM_MAP_NAME_METHOD_SEARCH,
22775         ELM_MAP_NAME_METHOD_REVERSE,
22776         ELM_MAP_NAME_METHOD_LAST
22777      } Elm_Map_Name_Method;
22778
22779    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(). */
22780    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(). */
22781    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(). */
22782    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(). */
22783    typedef struct _Elm_Map_Name            Elm_Map_Name; /**< A handle for specific coordinates. */
22784    typedef struct _Elm_Map_Track           Elm_Map_Track;
22785
22786    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. */
22787    typedef void         (*ElmMapMarkerDelFunc)      (Evas_Object *obj, Elm_Map_Marker *marker, void *data, Evas_Object *o); /**< Function to delete bubble content for marker classes. */
22788    typedef Evas_Object *(*ElmMapMarkerIconGetFunc)  (Evas_Object *obj, Elm_Map_Marker *marker, void *data); /**< Icon fetching class function for marker classes. */
22789    typedef Evas_Object *(*ElmMapGroupIconGetFunc)   (Evas_Object *obj, void *data); /**< Icon fetching class function for markers group classes. */
22790
22791    typedef char        *(*ElmMapModuleSourceFunc) (void);
22792    typedef int          (*ElmMapModuleZoomMinFunc) (void);
22793    typedef int          (*ElmMapModuleZoomMaxFunc) (void);
22794    typedef char        *(*ElmMapModuleUrlFunc) (Evas_Object *obj, int x, int y, int zoom);
22795    typedef int          (*ElmMapModuleRouteSourceFunc) (void);
22796    typedef char        *(*ElmMapModuleRouteUrlFunc) (Evas_Object *obj, char *type_name, int method, double flon, double flat, double tlon, double tlat);
22797    typedef char        *(*ElmMapModuleNameUrlFunc) (Evas_Object *obj, int method, char *name, double lon, double lat);
22798    typedef Eina_Bool    (*ElmMapModuleGeoIntoCoordFunc) (const Evas_Object *obj, int zoom, double lon, double lat, int size, int *x, int *y);
22799    typedef Eina_Bool    (*ElmMapModuleCoordIntoGeoFunc) (const Evas_Object *obj, int zoom, int x, int y, int size, double *lon, double *lat);
22800
22801    /**
22802     * Add a new map widget to the given parent Elementary (container) object.
22803     *
22804     * @param parent The parent object.
22805     * @return a new map widget handle or @c NULL, on errors.
22806     *
22807     * This function inserts a new map widget on the canvas.
22808     *
22809     * @ingroup Map
22810     */
22811    EAPI Evas_Object          *elm_map_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22812
22813    /**
22814     * Set the zoom level of the map.
22815     *
22816     * @param obj The map object.
22817     * @param zoom The zoom level to set.
22818     *
22819     * This sets the zoom level.
22820     *
22821     * It will respect limits defined by elm_map_source_zoom_min_set() and
22822     * elm_map_source_zoom_max_set().
22823     *
22824     * By default these values are 0 (world map) and 18 (maximum zoom).
22825     *
22826     * This function should be used when zoom mode is set to
22827     * #ELM_MAP_ZOOM_MODE_MANUAL. This is the default mode, and can be set
22828     * with elm_map_zoom_mode_set().
22829     *
22830     * @see elm_map_zoom_mode_set().
22831     * @see elm_map_zoom_get().
22832     *
22833     * @ingroup Map
22834     */
22835    EAPI void                  elm_map_zoom_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
22836
22837    /**
22838     * Get the zoom level of the map.
22839     *
22840     * @param obj The map object.
22841     * @return The current zoom level.
22842     *
22843     * This returns the current zoom level of the map object.
22844     *
22845     * Note that if you set the fill mode to other than #ELM_MAP_ZOOM_MODE_MANUAL
22846     * (which is the default), the zoom level may be changed at any time by the
22847     * map object itself to account for map size and map viewport size.
22848     *
22849     * @see elm_map_zoom_set() for details.
22850     *
22851     * @ingroup Map
22852     */
22853    EAPI int                   elm_map_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22854
22855    /**
22856     * Set the zoom mode used by the map object.
22857     *
22858     * @param obj The map object.
22859     * @param mode The zoom mode of the map, being it one of
22860     * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
22861     * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
22862     *
22863     * This sets the zoom mode to manual or one of the automatic levels.
22864     * Manual (#ELM_MAP_ZOOM_MODE_MANUAL) means that zoom is set manually by
22865     * elm_map_zoom_set() and will stay at that level until changed by code
22866     * or until zoom mode is changed. This is the default mode.
22867     *
22868     * The Automatic modes will allow the map object to automatically
22869     * adjust zoom mode based on properties. #ELM_MAP_ZOOM_MODE_AUTO_FIT will
22870     * adjust zoom so the map fits inside the scroll frame with no pixels
22871     * outside this area. #ELM_MAP_ZOOM_MODE_AUTO_FILL will be similar but
22872     * ensure no pixels within the frame are left unfilled. Do not forget that
22873     * the valid sizes are 2^zoom, consequently the map may be smaller than
22874     * the scroller view.
22875     *
22876     * @see elm_map_zoom_set()
22877     *
22878     * @ingroup Map
22879     */
22880    EAPI void                  elm_map_zoom_mode_set(Evas_Object *obj, Elm_Map_Zoom_Mode mode) EINA_ARG_NONNULL(1);
22881
22882    /**
22883     * Get the zoom mode used by the map object.
22884     *
22885     * @param obj The map object.
22886     * @return The zoom mode of the map, being it one of
22887     * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
22888     * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
22889     *
22890     * This function returns the current zoom mode used by the map object.
22891     *
22892     * @see elm_map_zoom_mode_set() for more details.
22893     *
22894     * @ingroup Map
22895     */
22896    EAPI Elm_Map_Zoom_Mode     elm_map_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22897
22898    /**
22899     * Get the current coordinates of the map.
22900     *
22901     * @param obj The map object.
22902     * @param lon Pointer where to store longitude.
22903     * @param lat Pointer where to store latitude.
22904     *
22905     * This gets the current center coordinates of the map object. It can be
22906     * set by elm_map_geo_region_bring_in() and elm_map_geo_region_show().
22907     *
22908     * @see elm_map_geo_region_bring_in()
22909     * @see elm_map_geo_region_show()
22910     *
22911     * @ingroup Map
22912     */
22913    EAPI void                  elm_map_geo_region_get(const Evas_Object *obj, double *lon, double *lat) EINA_ARG_NONNULL(1);
22914
22915    /**
22916     * Animatedly bring in given coordinates to the center of the map.
22917     *
22918     * @param obj The map object.
22919     * @param lon Longitude to center at.
22920     * @param lat Latitude to center at.
22921     *
22922     * This causes map to jump to the given @p lat and @p lon coordinates
22923     * and show it (by scrolling) in the center of the viewport, if it is not
22924     * already centered. This will use animation to do so and take a period
22925     * of time to complete.
22926     *
22927     * @see elm_map_geo_region_show() for a function to avoid animation.
22928     * @see elm_map_geo_region_get()
22929     *
22930     * @ingroup Map
22931     */
22932    EAPI void                  elm_map_geo_region_bring_in(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
22933
22934    /**
22935     * Show the given coordinates at the center of the map, @b immediately.
22936     *
22937     * @param obj The map object.
22938     * @param lon Longitude to center at.
22939     * @param lat Latitude to center at.
22940     *
22941     * This causes map to @b redraw its viewport's contents to the
22942     * region contining the given @p lat and @p lon, that will be moved to the
22943     * center of the map.
22944     *
22945     * @see elm_map_geo_region_bring_in() for a function to move with animation.
22946     * @see elm_map_geo_region_get()
22947     *
22948     * @ingroup Map
22949     */
22950    EAPI void                  elm_map_geo_region_show(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
22951
22952    /**
22953     * Pause or unpause the map.
22954     *
22955     * @param obj The map object.
22956     * @param paused Use @c EINA_TRUE to pause the map @p obj or @c EINA_FALSE
22957     * to unpause it.
22958     *
22959     * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
22960     * for map.
22961     *
22962     * The default is off.
22963     *
22964     * This will stop zooming using animation, changing zoom levels will
22965     * change instantly. This will stop any existing animations that are running.
22966     *
22967     * @see elm_map_paused_get()
22968     *
22969     * @ingroup Map
22970     */
22971    EAPI void                  elm_map_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
22972
22973    /**
22974     * Get a value whether map is paused or not.
22975     *
22976     * @param obj The map object.
22977     * @return @c EINA_TRUE means map is pause. @c EINA_FALSE indicates
22978     * it is not. If @p obj is @c NULL, @c EINA_FALSE is returned.
22979     *
22980     * This gets the current paused state for the map object.
22981     *
22982     * @see elm_map_paused_set() for details.
22983     *
22984     * @ingroup Map
22985     */
22986    EAPI Eina_Bool             elm_map_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22987
22988    /**
22989     * Set to show markers during zoom level changes or not.
22990     *
22991     * @param obj The map object.
22992     * @param paused Use @c EINA_TRUE to @b not show markers or @c EINA_FALSE
22993     * to show them.
22994     *
22995     * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
22996     * for map.
22997     *
22998     * The default is off.
22999     *
23000     * This will stop zooming using animation, changing zoom levels will
23001     * change instantly. This will stop any existing animations that are running.
23002     *
23003     * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
23004     * for the markers.
23005     *
23006     * The default  is off.
23007     *
23008     * Enabling it will force the map to stop displaying the markers during
23009     * zoom level changes. Set to on if you have a large number of markers.
23010     *
23011     * @see elm_map_paused_markers_get()
23012     *
23013     * @ingroup Map
23014     */
23015    EAPI void                  elm_map_paused_markers_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
23016
23017    /**
23018     * Get a value whether markers will be displayed on zoom level changes or not
23019     *
23020     * @param obj The map object.
23021     * @return @c EINA_TRUE means map @b won't display markers or @c EINA_FALSE
23022     * indicates it will. If @p obj is @c NULL, @c EINA_FALSE is returned.
23023     *
23024     * This gets the current markers paused state for the map object.
23025     *
23026     * @see elm_map_paused_markers_set() for details.
23027     *
23028     * @ingroup Map
23029     */
23030    EAPI Eina_Bool             elm_map_paused_markers_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23031
23032    /**
23033     * Get the information of downloading status.
23034     *
23035     * @param obj The map object.
23036     * @param try_num Pointer where to store number of tiles being downloaded.
23037     * @param finish_num Pointer where to store number of tiles successfully
23038     * downloaded.
23039     *
23040     * This gets the current downloading status for the map object, the number
23041     * of tiles being downloaded and the number of tiles already downloaded.
23042     *
23043     * @ingroup Map
23044     */
23045    EAPI void                  elm_map_utils_downloading_status_get(const Evas_Object *obj, int *try_num, int *finish_num) EINA_ARG_NONNULL(1, 2, 3);
23046
23047    /**
23048     * Convert a pixel coordinate (x,y) into a geographic coordinate
23049     * (longitude, latitude).
23050     *
23051     * @param obj The map object.
23052     * @param x the coordinate.
23053     * @param y the coordinate.
23054     * @param size the size in pixels of the map.
23055     * The map is a square and generally his size is : pow(2.0, zoom)*256.
23056     * @param lon Pointer where to store the longitude that correspond to x.
23057     * @param lat Pointer where to store the latitude that correspond to y.
23058     *
23059     * @note Origin pixel point is the top left corner of the viewport.
23060     * Map zoom and size are taken on account.
23061     *
23062     * @see elm_map_utils_convert_geo_into_coord() if you need the inverse.
23063     *
23064     * @ingroup Map
23065     */
23066    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);
23067
23068    /**
23069     * Convert a geographic coordinate (longitude, latitude) into a pixel
23070     * coordinate (x, y).
23071     *
23072     * @param obj The map object.
23073     * @param lon the longitude.
23074     * @param lat the latitude.
23075     * @param size the size in pixels of the map. The map is a square
23076     * and generally his size is : pow(2.0, zoom)*256.
23077     * @param x Pointer where to store the horizontal pixel coordinate that
23078     * correspond to the longitude.
23079     * @param y Pointer where to store the vertical pixel coordinate that
23080     * correspond to the latitude.
23081     *
23082     * @note Origin pixel point is the top left corner of the viewport.
23083     * Map zoom and size are taken on account.
23084     *
23085     * @see elm_map_utils_convert_coord_into_geo() if you need the inverse.
23086     *
23087     * @ingroup Map
23088     */
23089    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);
23090
23091    /**
23092     * Convert a geographic coordinate (longitude, latitude) into a name
23093     * (address).
23094     *
23095     * @param obj The map object.
23096     * @param lon the longitude.
23097     * @param lat the latitude.
23098     * @return name A #Elm_Map_Name handle for this coordinate.
23099     *
23100     * To get the string for this address, elm_map_name_address_get()
23101     * should be used.
23102     *
23103     * @see elm_map_utils_convert_name_into_coord() if you need the inverse.
23104     *
23105     * @ingroup Map
23106     */
23107    EAPI Elm_Map_Name         *elm_map_utils_convert_coord_into_name(const Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
23108
23109    /**
23110     * Convert a name (address) into a geographic coordinate
23111     * (longitude, latitude).
23112     *
23113     * @param obj The map object.
23114     * @param name The address.
23115     * @return name A #Elm_Map_Name handle for this address.
23116     *
23117     * To get the longitude and latitude, elm_map_name_region_get()
23118     * should be used.
23119     *
23120     * @see elm_map_utils_convert_coord_into_name() if you need the inverse.
23121     *
23122     * @ingroup Map
23123     */
23124    EAPI Elm_Map_Name         *elm_map_utils_convert_name_into_coord(const Evas_Object *obj, char *address) EINA_ARG_NONNULL(1, 2);
23125
23126    /**
23127     * Convert a pixel coordinate into a rotated pixel coordinate.
23128     *
23129     * @param obj The map object.
23130     * @param x horizontal coordinate of the point to rotate.
23131     * @param y vertical coordinate of the point to rotate.
23132     * @param cx rotation's center horizontal position.
23133     * @param cy rotation's center vertical position.
23134     * @param degree amount of degrees from 0.0 to 360.0 to rotate arount Z axis.
23135     * @param xx Pointer where to store rotated x.
23136     * @param yy Pointer where to store rotated y.
23137     *
23138     * @ingroup Map
23139     */
23140    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);
23141
23142    /**
23143     * Add a new marker to the map object.
23144     *
23145     * @param obj The map object.
23146     * @param lon The longitude of the marker.
23147     * @param lat The latitude of the marker.
23148     * @param clas The class, to use when marker @b isn't grouped to others.
23149     * @param clas_group The class group, to use when marker is grouped to others
23150     * @param data The data passed to the callbacks.
23151     *
23152     * @return The created marker or @c NULL upon failure.
23153     *
23154     * A marker will be created and shown in a specific point of the map, defined
23155     * by @p lon and @p lat.
23156     *
23157     * It will be displayed using style defined by @p class when this marker
23158     * is displayed alone (not grouped). A new class can be created with
23159     * elm_map_marker_class_new().
23160     *
23161     * If the marker is grouped to other markers, it will be displayed with
23162     * style defined by @p class_group. Markers with the same group are grouped
23163     * if they are close. A new group class can be created with
23164     * elm_map_marker_group_class_new().
23165     *
23166     * Markers created with this method can be deleted with
23167     * elm_map_marker_remove().
23168     *
23169     * A marker can have associated content to be displayed by a bubble,
23170     * when a user click over it, as well as an icon. These objects will
23171     * be fetch using class' callback functions.
23172     *
23173     * @see elm_map_marker_class_new()
23174     * @see elm_map_marker_group_class_new()
23175     * @see elm_map_marker_remove()
23176     *
23177     * @ingroup Map
23178     */
23179    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);
23180
23181    /**
23182     * Set the maximum numbers of markers' content to be displayed in a group.
23183     *
23184     * @param obj The map object.
23185     * @param max The maximum numbers of items displayed in a bubble.
23186     *
23187     * A bubble will be displayed when the user clicks over the group,
23188     * and will place the content of markers that belong to this group
23189     * inside it.
23190     *
23191     * A group can have a long list of markers, consequently the creation
23192     * of the content of the bubble can be very slow.
23193     *
23194     * In order to avoid this, a maximum number of items is displayed
23195     * in a bubble.
23196     *
23197     * By default this number is 30.
23198     *
23199     * Marker with the same group class are grouped if they are close.
23200     *
23201     * @see elm_map_marker_add()
23202     *
23203     * @ingroup Map
23204     */
23205    EAPI void                  elm_map_max_marker_per_group_set(Evas_Object *obj, int max) EINA_ARG_NONNULL(1);
23206
23207    /**
23208     * Remove a marker from the map.
23209     *
23210     * @param marker The marker to remove.
23211     *
23212     * @see elm_map_marker_add()
23213     *
23214     * @ingroup Map
23215     */
23216    EAPI void                  elm_map_marker_remove(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
23217
23218    /**
23219     * Get the current coordinates of the marker.
23220     *
23221     * @param marker marker.
23222     * @param lat Pointer where to store the marker's latitude.
23223     * @param lon Pointer where to store the marker's longitude.
23224     *
23225     * These values are set when adding markers, with function
23226     * elm_map_marker_add().
23227     *
23228     * @see elm_map_marker_add()
23229     *
23230     * @ingroup Map
23231     */
23232    EAPI void                  elm_map_marker_region_get(const Elm_Map_Marker *marker, double *lon, double *lat) EINA_ARG_NONNULL(1);
23233
23234    /**
23235     * Animatedly bring in given marker to the center of the map.
23236     *
23237     * @param marker The marker to center at.
23238     *
23239     * This causes map to jump to the given @p marker's coordinates
23240     * and show it (by scrolling) in the center of the viewport, if it is not
23241     * already centered. This will use animation to do so and take a period
23242     * of time to complete.
23243     *
23244     * @see elm_map_marker_show() for a function to avoid animation.
23245     * @see elm_map_marker_region_get()
23246     *
23247     * @ingroup Map
23248     */
23249    EAPI void                  elm_map_marker_bring_in(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
23250
23251    /**
23252     * Show the given marker at the center of the map, @b immediately.
23253     *
23254     * @param marker The marker to center at.
23255     *
23256     * This causes map to @b redraw its viewport's contents to the
23257     * region contining the given @p marker's coordinates, that will be
23258     * moved to the center of the map.
23259     *
23260     * @see elm_map_marker_bring_in() for a function to move with animation.
23261     * @see elm_map_markers_list_show() if more than one marker need to be
23262     * displayed.
23263     * @see elm_map_marker_region_get()
23264     *
23265     * @ingroup Map
23266     */
23267    EAPI void                  elm_map_marker_show(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
23268
23269    /**
23270     * Move and zoom the map to display a list of markers.
23271     *
23272     * @param markers A list of #Elm_Map_Marker handles.
23273     *
23274     * The map will be centered on the center point of the markers in the list.
23275     * Then the map will be zoomed in order to fit the markers using the maximum
23276     * zoom which allows display of all the markers.
23277     *
23278     * @warning All the markers should belong to the same map object.
23279     *
23280     * @see elm_map_marker_show() to show a single marker.
23281     * @see elm_map_marker_bring_in()
23282     *
23283     * @ingroup Map
23284     */
23285    EAPI void                  elm_map_markers_list_show(Eina_List *markers) EINA_ARG_NONNULL(1);
23286
23287    /**
23288     * Get the Evas object returned by the ElmMapMarkerGetFunc callback
23289     *
23290     * @param marker The marker wich content should be returned.
23291     * @return Return the evas object if it exists, else @c NULL.
23292     *
23293     * To set callback function #ElmMapMarkerGetFunc for the marker class,
23294     * elm_map_marker_class_get_cb_set() should be used.
23295     *
23296     * This content is what will be inside the bubble that will be displayed
23297     * when an user clicks over the marker.
23298     *
23299     * This returns the actual Evas object used to be placed inside
23300     * the bubble. This may be @c NULL, as it may
23301     * not have been created or may have been deleted, at any time, by
23302     * the map. <b>Do not modify this object</b> (move, resize,
23303     * show, hide, etc.), as the map is controlling it. This
23304     * function is for querying, emitting custom signals or hooking
23305     * lower level callbacks for events on that object. Do not delete
23306     * this object under any circumstances.
23307     *
23308     * @ingroup Map
23309     */
23310    EAPI Evas_Object          *elm_map_marker_object_get(const Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
23311
23312    /**
23313     * Update the marker
23314     *
23315     * @param marker The marker to be updated.
23316     *
23317     * If a content is set to this marker, it will call function to delete it,
23318     * #ElmMapMarkerDelFunc, and then will fetch the content again with
23319     * #ElmMapMarkerGetFunc.
23320     *
23321     * These functions are set for the marker class with
23322     * elm_map_marker_class_get_cb_set() and elm_map_marker_class_del_cb_set().
23323     *
23324     * @ingroup Map
23325     */
23326    EAPI void                  elm_map_marker_update(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
23327
23328    /**
23329     * Close all the bubbles opened by the user.
23330     *
23331     * @param obj The map object.
23332     *
23333     * A bubble is displayed with a content fetched with #ElmMapMarkerGetFunc
23334     * when the user clicks on a marker.
23335     *
23336     * This functions is set for the marker class with
23337     * elm_map_marker_class_get_cb_set().
23338     *
23339     * @ingroup Map
23340     */
23341    EAPI void                  elm_map_bubbles_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
23342
23343    /**
23344     * Create a new group class.
23345     *
23346     * @param obj The map object.
23347     * @return Returns the new group class.
23348     *
23349     * Each marker must be associated to a group class. Markers in the same
23350     * group are grouped if they are close.
23351     *
23352     * The group class defines the style of the marker when a marker is grouped
23353     * to others markers. When it is alone, another class will be used.
23354     *
23355     * A group class will need to be provided when creating a marker with
23356     * elm_map_marker_add().
23357     *
23358     * Some properties and functions can be set by class, as:
23359     * - style, with elm_map_group_class_style_set()
23360     * - data - to be associated to the group class. It can be set using
23361     *   elm_map_group_class_data_set().
23362     * - min zoom to display markers, set with
23363     *   elm_map_group_class_zoom_displayed_set().
23364     * - max zoom to group markers, set using
23365     *   elm_map_group_class_zoom_grouped_set().
23366     * - visibility - set if markers will be visible or not, set with
23367     *   elm_map_group_class_hide_set().
23368     * - #ElmMapGroupIconGetFunc - used to fetch icon for markers group classes.
23369     *   It can be set using elm_map_group_class_icon_cb_set().
23370     *
23371     * @see elm_map_marker_add()
23372     * @see elm_map_group_class_style_set()
23373     * @see elm_map_group_class_data_set()
23374     * @see elm_map_group_class_zoom_displayed_set()
23375     * @see elm_map_group_class_zoom_grouped_set()
23376     * @see elm_map_group_class_hide_set()
23377     * @see elm_map_group_class_icon_cb_set()
23378     *
23379     * @ingroup Map
23380     */
23381    EAPI Elm_Map_Group_Class  *elm_map_group_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
23382
23383    /**
23384     * Set the marker's style of a group class.
23385     *
23386     * @param clas The group class.
23387     * @param style The style to be used by markers.
23388     *
23389     * Each marker must be associated to a group class, and will use the style
23390     * defined by such class when grouped to other markers.
23391     *
23392     * The following styles are provided by default theme:
23393     * @li @c radio - blue circle
23394     * @li @c radio2 - green circle
23395     * @li @c empty
23396     *
23397     * @see elm_map_group_class_new() for more details.
23398     * @see elm_map_marker_add()
23399     *
23400     * @ingroup Map
23401     */
23402    EAPI void                  elm_map_group_class_style_set(Elm_Map_Group_Class *clas, const char *style) EINA_ARG_NONNULL(1);
23403
23404    /**
23405     * Set the icon callback function of a group class.
23406     *
23407     * @param clas The group class.
23408     * @param icon_get The callback function that will return the icon.
23409     *
23410     * Each marker must be associated to a group class, and it can display a
23411     * custom icon. The function @p icon_get must return this icon.
23412     *
23413     * @see elm_map_group_class_new() for more details.
23414     * @see elm_map_marker_add()
23415     *
23416     * @ingroup Map
23417     */
23418    EAPI void                  elm_map_group_class_icon_cb_set(Elm_Map_Group_Class *clas, ElmMapGroupIconGetFunc icon_get) EINA_ARG_NONNULL(1);
23419
23420    /**
23421     * Set the data associated to the group class.
23422     *
23423     * @param clas The group class.
23424     * @param data The new user data.
23425     *
23426     * This data will be passed for callback functions, like icon get callback,
23427     * that can be set with elm_map_group_class_icon_cb_set().
23428     *
23429     * If a data was previously set, the object will lose the pointer for it,
23430     * so if needs to be freed, you must do it yourself.
23431     *
23432     * @see elm_map_group_class_new() for more details.
23433     * @see elm_map_group_class_icon_cb_set()
23434     * @see elm_map_marker_add()
23435     *
23436     * @ingroup Map
23437     */
23438    EAPI void                  elm_map_group_class_data_set(Elm_Map_Group_Class *clas, void *data) EINA_ARG_NONNULL(1);
23439
23440    /**
23441     * Set the minimum zoom from where the markers are displayed.
23442     *
23443     * @param clas The group class.
23444     * @param zoom The minimum zoom.
23445     *
23446     * Markers only will be displayed when the map is displayed at @p zoom
23447     * or bigger.
23448     *
23449     * @see elm_map_group_class_new() for more details.
23450     * @see elm_map_marker_add()
23451     *
23452     * @ingroup Map
23453     */
23454    EAPI void                  elm_map_group_class_zoom_displayed_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
23455
23456    /**
23457     * Set the zoom from where the markers are no more grouped.
23458     *
23459     * @param clas The group class.
23460     * @param zoom The maximum zoom.
23461     *
23462     * Markers only will be grouped when the map is displayed at
23463     * less than @p zoom.
23464     *
23465     * @see elm_map_group_class_new() for more details.
23466     * @see elm_map_marker_add()
23467     *
23468     * @ingroup Map
23469     */
23470    EAPI void                  elm_map_group_class_zoom_grouped_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
23471
23472    /**
23473     * Set if the markers associated to the group class @clas are hidden or not.
23474     *
23475     * @param clas The group class.
23476     * @param hide Use @c EINA_TRUE to hide markers or @c EINA_FALSE
23477     * to show them.
23478     *
23479     * If @p hide is @c EINA_TRUE the markers will be hidden, but default
23480     * is to show them.
23481     *
23482     * @ingroup Map
23483     */
23484    EAPI void                  elm_map_group_class_hide_set(Evas_Object *obj, Elm_Map_Group_Class *clas, Eina_Bool hide) EINA_ARG_NONNULL(1, 2);
23485
23486    /**
23487     * Create a new marker class.
23488     *
23489     * @param obj The map object.
23490     * @return Returns the new group class.
23491     *
23492     * Each marker must be associated to a class.
23493     *
23494     * The marker class defines the style of the marker when a marker is
23495     * displayed alone, i.e., not grouped to to others markers. When grouped
23496     * it will use group class style.
23497     *
23498     * A marker class will need to be provided when creating a marker with
23499     * elm_map_marker_add().
23500     *
23501     * Some properties and functions can be set by class, as:
23502     * - style, with elm_map_marker_class_style_set()
23503     * - #ElmMapMarkerIconGetFunc - used to fetch icon for markers classes.
23504     *   It can be set using elm_map_marker_class_icon_cb_set().
23505     * - #ElmMapMarkerGetFunc - used to fetch bubble content for marker classes.
23506     *   Set using elm_map_marker_class_get_cb_set().
23507     * - #ElmMapMarkerDelFunc - used to delete bubble content for marker classes.
23508     *   Set using elm_map_marker_class_del_cb_set().
23509     *
23510     * @see elm_map_marker_add()
23511     * @see elm_map_marker_class_style_set()
23512     * @see elm_map_marker_class_icon_cb_set()
23513     * @see elm_map_marker_class_get_cb_set()
23514     * @see elm_map_marker_class_del_cb_set()
23515     *
23516     * @ingroup Map
23517     */
23518    EAPI Elm_Map_Marker_Class *elm_map_marker_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
23519
23520    /**
23521     * Set the marker's style of a marker class.
23522     *
23523     * @param clas The marker class.
23524     * @param style The style to be used by markers.
23525     *
23526     * Each marker must be associated to a marker class, and will use the style
23527     * defined by such class when alone, i.e., @b not grouped to other markers.
23528     *
23529     * The following styles are provided by default theme:
23530     * @li @c radio
23531     * @li @c radio2
23532     * @li @c empty
23533     *
23534     * @see elm_map_marker_class_new() for more details.
23535     * @see elm_map_marker_add()
23536     *
23537     * @ingroup Map
23538     */
23539    EAPI void                  elm_map_marker_class_style_set(Elm_Map_Marker_Class *clas, const char *style) EINA_ARG_NONNULL(1);
23540
23541    /**
23542     * Set the icon callback function of a marker class.
23543     *
23544     * @param clas The marker class.
23545     * @param icon_get The callback function that will return the icon.
23546     *
23547     * Each marker must be associated to a marker class, and it can display a
23548     * custom icon. The function @p icon_get must return this icon.
23549     *
23550     * @see elm_map_marker_class_new() for more details.
23551     * @see elm_map_marker_add()
23552     *
23553     * @ingroup Map
23554     */
23555    EAPI void                  elm_map_marker_class_icon_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerIconGetFunc icon_get) EINA_ARG_NONNULL(1);
23556
23557    /**
23558     * Set the bubble content callback function of a marker class.
23559     *
23560     * @param clas The marker class.
23561     * @param get The callback function that will return the content.
23562     *
23563     * Each marker must be associated to a marker class, and it can display a
23564     * a content on a bubble that opens when the user click over the marker.
23565     * The function @p get must return this content object.
23566     *
23567     * If this content will need to be deleted, elm_map_marker_class_del_cb_set()
23568     * can be used.
23569     *
23570     * @see elm_map_marker_class_new() for more details.
23571     * @see elm_map_marker_class_del_cb_set()
23572     * @see elm_map_marker_add()
23573     *
23574     * @ingroup Map
23575     */
23576    EAPI void                  elm_map_marker_class_get_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerGetFunc get) EINA_ARG_NONNULL(1);
23577
23578    /**
23579     * Set the callback function used to delete bubble content of a marker class.
23580     *
23581     * @param clas The marker class.
23582     * @param del The callback function that will delete the content.
23583     *
23584     * Each marker must be associated to a marker class, and it can display a
23585     * a content on a bubble that opens when the user click over the marker.
23586     * The function to return such content can be set with
23587     * elm_map_marker_class_get_cb_set().
23588     *
23589     * If this content must be freed, a callback function need to be
23590     * set for that task with this function.
23591     *
23592     * If this callback is defined it will have to delete (or not) the
23593     * object inside, but if the callback is not defined the object will be
23594     * destroyed with evas_object_del().
23595     *
23596     * @see elm_map_marker_class_new() for more details.
23597     * @see elm_map_marker_class_get_cb_set()
23598     * @see elm_map_marker_add()
23599     *
23600     * @ingroup Map
23601     */
23602    EAPI void                  elm_map_marker_class_del_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerDelFunc del) EINA_ARG_NONNULL(1);
23603
23604    /**
23605     * Get the list of available sources.
23606     *
23607     * @param obj The map object.
23608     * @return The source names list.
23609     *
23610     * It will provide a list with all available sources, that can be set as
23611     * current source with elm_map_source_name_set(), or get with
23612     * elm_map_source_name_get().
23613     *
23614     * Available sources:
23615     * @li "Mapnik"
23616     * @li "Osmarender"
23617     * @li "CycleMap"
23618     * @li "Maplint"
23619     *
23620     * @see elm_map_source_name_set() for more details.
23621     * @see elm_map_source_name_get()
23622     *
23623     * @ingroup Map
23624     */
23625    EAPI const char          **elm_map_source_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23626
23627    /**
23628     * Set the source of the map.
23629     *
23630     * @param obj The map object.
23631     * @param source The source to be used.
23632     *
23633     * Map widget retrieves images that composes the map from a web service.
23634     * This web service can be set with this method.
23635     *
23636     * A different service can return a different maps with different
23637     * information and it can use different zoom values.
23638     *
23639     * The @p source_name need to match one of the names provided by
23640     * elm_map_source_names_get().
23641     *
23642     * The current source can be get using elm_map_source_name_get().
23643     *
23644     * @see elm_map_source_names_get()
23645     * @see elm_map_source_name_get()
23646     *
23647     *
23648     * @ingroup Map
23649     */
23650    EAPI void                  elm_map_source_name_set(Evas_Object *obj, const char *source_name) EINA_ARG_NONNULL(1);
23651
23652    /**
23653     * Get the name of currently used source.
23654     *
23655     * @param obj The map object.
23656     * @return Returns the name of the source in use.
23657     *
23658     * @see elm_map_source_name_set() for more details.
23659     *
23660     * @ingroup Map
23661     */
23662    EAPI const char           *elm_map_source_name_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23663
23664    /**
23665     * Set the source of the route service to be used by the map.
23666     *
23667     * @param obj The map object.
23668     * @param source The route service to be used, being it one of
23669     * #ELM_MAP_ROUTE_SOURCE_YOURS (default), #ELM_MAP_ROUTE_SOURCE_MONAV,
23670     * and #ELM_MAP_ROUTE_SOURCE_ORS.
23671     *
23672     * Each one has its own algorithm, so the route retrieved may
23673     * differ depending on the source route. Now, only the default is working.
23674     *
23675     * #ELM_MAP_ROUTE_SOURCE_YOURS is the routing service provided at
23676     * http://www.yournavigation.org/.
23677     *
23678     * #ELM_MAP_ROUTE_SOURCE_MONAV, offers exact routing without heuristic
23679     * assumptions. Its routing core is based on Contraction Hierarchies.
23680     *
23681     * #ELM_MAP_ROUTE_SOURCE_ORS, is provided at http://www.openrouteservice.org/
23682     *
23683     * @see elm_map_route_source_get().
23684     *
23685     * @ingroup Map
23686     */
23687    EAPI void                  elm_map_route_source_set(Evas_Object *obj, Elm_Map_Route_Sources source) EINA_ARG_NONNULL(1);
23688
23689    /**
23690     * Get the current route source.
23691     *
23692     * @param obj The map object.
23693     * @return The source of the route service used by the map.
23694     *
23695     * @see elm_map_route_source_set() for details.
23696     *
23697     * @ingroup Map
23698     */
23699    EAPI Elm_Map_Route_Sources elm_map_route_source_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23700
23701    /**
23702     * Set the minimum zoom of the source.
23703     *
23704     * @param obj The map object.
23705     * @param zoom New minimum zoom value to be used.
23706     *
23707     * By default, it's 0.
23708     *
23709     * @ingroup Map
23710     */
23711    EAPI void                  elm_map_source_zoom_min_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
23712
23713    /**
23714     * Get the minimum zoom of the source.
23715     *
23716     * @param obj The map object.
23717     * @return Returns the minimum zoom of the source.
23718     *
23719     * @see elm_map_source_zoom_min_set() for details.
23720     *
23721     * @ingroup Map
23722     */
23723    EAPI int                   elm_map_source_zoom_min_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23724
23725    /**
23726     * Set the maximum zoom of the source.
23727     *
23728     * @param obj The map object.
23729     * @param zoom New maximum zoom value to be used.
23730     *
23731     * By default, it's 18.
23732     *
23733     * @ingroup Map
23734     */
23735    EAPI void                  elm_map_source_zoom_max_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
23736
23737    /**
23738     * Get the maximum zoom of the source.
23739     *
23740     * @param obj The map object.
23741     * @return Returns the maximum zoom of the source.
23742     *
23743     * @see elm_map_source_zoom_min_set() for details.
23744     *
23745     * @ingroup Map
23746     */
23747    EAPI int                   elm_map_source_zoom_max_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23748
23749    /**
23750     * Set the user agent used by the map object to access routing services.
23751     *
23752     * @param obj The map object.
23753     * @param user_agent The user agent to be used by the map.
23754     *
23755     * User agent is a client application implementing a network protocol used
23756     * in communications within a client–server distributed computing system
23757     *
23758     * The @p user_agent identification string will transmitted in a header
23759     * field @c User-Agent.
23760     *
23761     * @see elm_map_user_agent_get()
23762     *
23763     * @ingroup Map
23764     */
23765    EAPI void                  elm_map_user_agent_set(Evas_Object *obj, const char *user_agent) EINA_ARG_NONNULL(1, 2);
23766
23767    /**
23768     * Get the user agent used by the map object.
23769     *
23770     * @param obj The map object.
23771     * @return The user agent identification string used by the map.
23772     *
23773     * @see elm_map_user_agent_set() for details.
23774     *
23775     * @ingroup Map
23776     */
23777    EAPI const char           *elm_map_user_agent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23778
23779    /**
23780     * Add a new route to the map object.
23781     *
23782     * @param obj The map object.
23783     * @param type The type of transport to be considered when tracing a route.
23784     * @param method The routing method, what should be priorized.
23785     * @param flon The start longitude.
23786     * @param flat The start latitude.
23787     * @param tlon The destination longitude.
23788     * @param tlat The destination latitude.
23789     *
23790     * @return The created route or @c NULL upon failure.
23791     *
23792     * A route will be traced by point on coordinates (@p flat, @p flon)
23793     * to point on coordinates (@p tlat, @p tlon), using the route service
23794     * set with elm_map_route_source_set().
23795     *
23796     * It will take @p type on consideration to define the route,
23797     * depending if the user will be walking or driving, the route may vary.
23798     * One of #ELM_MAP_ROUTE_TYPE_MOTOCAR, #ELM_MAP_ROUTE_TYPE_BICYCLE, or
23799     * #ELM_MAP_ROUTE_TYPE_FOOT need to be used.
23800     *
23801     * Another parameter is what the route should priorize, the minor distance
23802     * or the less time to be spend on the route. So @p method should be one
23803     * of #ELM_MAP_ROUTE_METHOD_SHORTEST or #ELM_MAP_ROUTE_METHOD_FASTEST.
23804     *
23805     * Routes created with this method can be deleted with
23806     * elm_map_route_remove(), colored with elm_map_route_color_set(),
23807     * and distance can be get with elm_map_route_distance_get().
23808     *
23809     * @see elm_map_route_remove()
23810     * @see elm_map_route_color_set()
23811     * @see elm_map_route_distance_get()
23812     * @see elm_map_route_source_set()
23813     *
23814     * @ingroup Map
23815     */
23816    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);
23817
23818    /**
23819     * Remove a route from the map.
23820     *
23821     * @param route The route to remove.
23822     *
23823     * @see elm_map_route_add()
23824     *
23825     * @ingroup Map
23826     */
23827    EAPI void                  elm_map_route_remove(Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23828
23829    /**
23830     * Set the route color.
23831     *
23832     * @param route The route object.
23833     * @param r Red channel value, from 0 to 255.
23834     * @param g Green channel value, from 0 to 255.
23835     * @param b Blue channel value, from 0 to 255.
23836     * @param a Alpha channel value, from 0 to 255.
23837     *
23838     * It uses an additive color model, so each color channel represents
23839     * how much of each primary colors must to be used. 0 represents
23840     * ausence of this color, so if all of the three are set to 0,
23841     * the color will be black.
23842     *
23843     * These component values should be integers in the range 0 to 255,
23844     * (single 8-bit byte).
23845     *
23846     * This sets the color used for the route. By default, it is set to
23847     * solid red (r = 255, g = 0, b = 0, a = 255).
23848     *
23849     * For alpha channel, 0 represents completely transparent, and 255, opaque.
23850     *
23851     * @see elm_map_route_color_get()
23852     *
23853     * @ingroup Map
23854     */
23855    EAPI void                  elm_map_route_color_set(Elm_Map_Route *route, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
23856
23857    /**
23858     * Get the route color.
23859     *
23860     * @param route The route object.
23861     * @param r Pointer where to store the red channel value.
23862     * @param g Pointer where to store the green channel value.
23863     * @param b Pointer where to store the blue channel value.
23864     * @param a Pointer where to store the alpha channel value.
23865     *
23866     * @see elm_map_route_color_set() for details.
23867     *
23868     * @ingroup Map
23869     */
23870    EAPI void                  elm_map_route_color_get(const Elm_Map_Route *route, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
23871
23872    /**
23873     * Get the route distance in kilometers.
23874     *
23875     * @param route The route object.
23876     * @return The distance of route (unit : km).
23877     *
23878     * @ingroup Map
23879     */
23880    EAPI double                elm_map_route_distance_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23881
23882    /**
23883     * Get the information of route nodes.
23884     *
23885     * @param route The route object.
23886     * @return Returns a string with the nodes of route.
23887     *
23888     * @ingroup Map
23889     */
23890    EAPI const char           *elm_map_route_node_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23891
23892    /**
23893     * Get the information of route waypoint.
23894     *
23895     * @param route the route object.
23896     * @return Returns a string with information about waypoint of route.
23897     *
23898     * @ingroup Map
23899     */
23900    EAPI const char           *elm_map_route_waypoint_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23901
23902    /**
23903     * Get the address of the name.
23904     *
23905     * @param name The name handle.
23906     * @return Returns the address string of @p name.
23907     *
23908     * This gets the coordinates of the @p name, created with one of the
23909     * conversion functions.
23910     *
23911     * @see elm_map_utils_convert_name_into_coord()
23912     * @see elm_map_utils_convert_coord_into_name()
23913     *
23914     * @ingroup Map
23915     */
23916    EAPI const char           *elm_map_name_address_get(const Elm_Map_Name *name) EINA_ARG_NONNULL(1);
23917
23918    /**
23919     * Get the current coordinates of the name.
23920     *
23921     * @param name The name handle.
23922     * @param lat Pointer where to store the latitude.
23923     * @param lon Pointer where to store The longitude.
23924     *
23925     * This gets the coordinates of the @p name, created with one of the
23926     * conversion functions.
23927     *
23928     * @see elm_map_utils_convert_name_into_coord()
23929     * @see elm_map_utils_convert_coord_into_name()
23930     *
23931     * @ingroup Map
23932     */
23933    EAPI void                  elm_map_name_region_get(const Elm_Map_Name *name, double *lon, double *lat) EINA_ARG_NONNULL(1);
23934
23935    /**
23936     * Remove a name from the map.
23937     *
23938     * @param name The name to remove.
23939     *
23940     * Basically the struct handled by @p name will be freed, so convertions
23941     * between address and coordinates will be lost.
23942     *
23943     * @see elm_map_utils_convert_name_into_coord()
23944     * @see elm_map_utils_convert_coord_into_name()
23945     *
23946     * @ingroup Map
23947     */
23948    EAPI void                  elm_map_name_remove(Elm_Map_Name *name) EINA_ARG_NONNULL(1);
23949
23950    /**
23951     * Rotate the map.
23952     *
23953     * @param obj The map object.
23954     * @param degree Angle from 0.0 to 360.0 to rotate arount Z axis.
23955     * @param cx Rotation's center horizontal position.
23956     * @param cy Rotation's center vertical position.
23957     *
23958     * @see elm_map_rotate_get()
23959     *
23960     * @ingroup Map
23961     */
23962    EAPI void                  elm_map_rotate_set(Evas_Object *obj, double degree, Evas_Coord cx, Evas_Coord cy) EINA_ARG_NONNULL(1);
23963
23964    /**
23965     * Get the rotate degree of the map
23966     *
23967     * @param obj The map object
23968     * @param degree Pointer where to store degrees from 0.0 to 360.0
23969     * to rotate arount Z axis.
23970     * @param cx Pointer where to store rotation's center horizontal position.
23971     * @param cy Pointer where to store rotation's center vertical position.
23972     *
23973     * @see elm_map_rotate_set() to set map rotation.
23974     *
23975     * @ingroup Map
23976     */
23977    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);
23978
23979    /**
23980     * Enable or disable mouse wheel to be used to zoom in / out the map.
23981     *
23982     * @param obj The map object.
23983     * @param disabled Use @c EINA_TRUE to disable mouse wheel or @c EINA_FALSE
23984     * to enable it.
23985     *
23986     * Mouse wheel can be used for the user to zoom in or zoom out the map.
23987     *
23988     * It's disabled by default.
23989     *
23990     * @see elm_map_wheel_disabled_get()
23991     *
23992     * @ingroup Map
23993     */
23994    EAPI void                  elm_map_wheel_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
23995
23996    /**
23997     * Get a value whether mouse wheel is enabled or not.
23998     *
23999     * @param obj The map object.
24000     * @return @c EINA_TRUE means map is disabled. @c EINA_FALSE indicates
24001     * it is enabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24002     *
24003     * Mouse wheel can be used for the user to zoom in or zoom out the map.
24004     *
24005     * @see elm_map_wheel_disabled_set() for details.
24006     *
24007     * @ingroup Map
24008     */
24009    EAPI Eina_Bool             elm_map_wheel_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24010
24011 #ifdef ELM_EMAP
24012    /**
24013     * Add a track on the map
24014     *
24015     * @param obj The map object.
24016     * @param emap The emap route object.
24017     * @return The route object. This is an elm object of type Route.
24018     *
24019     * @see elm_route_add() for details.
24020     *
24021     * @ingroup Map
24022     */
24023    EAPI Evas_Object          *elm_map_track_add(Evas_Object *obj, EMap_Route *emap) EINA_ARG_NONNULL(1);
24024 #endif
24025
24026    /**
24027     * Remove a track from the map
24028     *
24029     * @param obj The map object.
24030     * @param route The track to remove.
24031     *
24032     * @ingroup Map
24033     */
24034    EAPI void                  elm_map_track_remove(Evas_Object *obj, Evas_Object *route) EINA_ARG_NONNULL(1);
24035
24036    /**
24037     * @}
24038     */
24039
24040    /* Route */
24041    EAPI Evas_Object *elm_route_add(Evas_Object *parent);
24042 #ifdef ELM_EMAP
24043    EAPI void elm_route_emap_set(Evas_Object *obj, EMap_Route *emap);
24044 #endif
24045    EAPI double elm_route_lon_min_get(Evas_Object *obj);
24046    EAPI double elm_route_lat_min_get(Evas_Object *obj);
24047    EAPI double elm_route_lon_max_get(Evas_Object *obj);
24048    EAPI double elm_route_lat_max_get(Evas_Object *obj);
24049
24050
24051    /**
24052     * @defgroup Panel Panel
24053     *
24054     * @image html img/widget/panel/preview-00.png
24055     * @image latex img/widget/panel/preview-00.eps
24056     *
24057     * @brief A panel is a type of animated container that contains subobjects.
24058     * It can be expanded or contracted by clicking the button on it's edge.
24059     *
24060     * Orientations are as follows:
24061     * @li ELM_PANEL_ORIENT_TOP
24062     * @li ELM_PANEL_ORIENT_LEFT
24063     * @li ELM_PANEL_ORIENT_RIGHT
24064     *
24065     * Default contents parts of the panel widget that you can use for are:
24066     * @li "default" - A content of the panel
24067     *
24068     * @ref tutorial_panel shows one way to use this widget.
24069     * @{
24070     */
24071    typedef enum _Elm_Panel_Orient
24072      {
24073         ELM_PANEL_ORIENT_TOP, /**< Panel (dis)appears from the top */
24074         ELM_PANEL_ORIENT_BOTTOM, /**< Not implemented */
24075         ELM_PANEL_ORIENT_LEFT, /**< Panel (dis)appears from the left */
24076         ELM_PANEL_ORIENT_RIGHT, /**< Panel (dis)appears from the right */
24077      } Elm_Panel_Orient;
24078    /**
24079     * @brief Adds a panel object
24080     *
24081     * @param parent The parent object
24082     *
24083     * @return The panel object, or NULL on failure
24084     */
24085    EAPI Evas_Object          *elm_panel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24086    /**
24087     * @brief Sets the orientation of the panel
24088     *
24089     * @param parent The parent object
24090     * @param orient The panel orientation. Can be one of the following:
24091     * @li ELM_PANEL_ORIENT_TOP
24092     * @li ELM_PANEL_ORIENT_LEFT
24093     * @li ELM_PANEL_ORIENT_RIGHT
24094     *
24095     * Sets from where the panel will (dis)appear.
24096     */
24097    EAPI void                  elm_panel_orient_set(Evas_Object *obj, Elm_Panel_Orient orient) EINA_ARG_NONNULL(1);
24098    /**
24099     * @brief Get the orientation of the panel.
24100     *
24101     * @param obj The panel object
24102     * @return The Elm_Panel_Orient, or ELM_PANEL_ORIENT_LEFT on failure.
24103     */
24104    EAPI Elm_Panel_Orient      elm_panel_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24105    /**
24106     * @brief Set the content of the panel.
24107     *
24108     * @param obj The panel object
24109     * @param content The panel content
24110     *
24111     * Once the content object is set, a previously set one will be deleted.
24112     * If you want to keep that old content object, use the
24113     * elm_panel_content_unset() function.
24114     *
24115     * @deprecated use elm_object_content_set() instead
24116     *
24117     */
24118    WILL_DEPRECATE  EAPI void                  elm_panel_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24119    /**
24120     * @brief Get the content of the panel.
24121     *
24122     * @param obj The panel object
24123     * @return The content that is being used
24124     *
24125     * Return the content object which is set for this widget.
24126     *
24127     * @see elm_panel_content_set()
24128     * 
24129     * @deprecated use elm_object_content_get() instead
24130     *
24131     */
24132    WILL_DEPRECATE  EAPI Evas_Object          *elm_panel_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24133    /**
24134     * @brief Unset the content of the panel.
24135     *
24136     * @param obj The panel object
24137     * @return The content that was being used
24138     *
24139     * Unparent and return the content object which was set for this widget.
24140     *
24141     * @see elm_panel_content_set()
24142     *
24143     * @deprecated use elm_object_content_unset() instead
24144     *
24145     */
24146    WILL_DEPRECATE  EAPI Evas_Object          *elm_panel_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24147    /**
24148     * @brief Set the state of the panel.
24149     *
24150     * @param obj The panel object
24151     * @param hidden If true, the panel will run the animation to contract
24152     */
24153    EAPI void                  elm_panel_hidden_set(Evas_Object *obj, Eina_Bool hidden) EINA_ARG_NONNULL(1);
24154    /**
24155     * @brief Get the state of the panel.
24156     *
24157     * @param obj The panel object
24158     * @param hidden If true, the panel is in the "hide" state
24159     */
24160    EAPI Eina_Bool             elm_panel_hidden_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24161    /**
24162     * @brief Toggle the hidden state of the panel from code
24163     *
24164     * @param obj The panel object
24165     */
24166    EAPI void                  elm_panel_toggle(Evas_Object *obj) EINA_ARG_NONNULL(1);
24167    /**
24168     * @}
24169     */
24170
24171    /**
24172     * @defgroup Panes Panes
24173     * @ingroup Elementary
24174     *
24175     * @image html img/widget/panes/preview-00.png
24176     * @image latex img/widget/panes/preview-00.eps width=\textwidth
24177     *
24178     * @image html img/panes.png
24179     * @image latex img/panes.eps width=\textwidth
24180     *
24181     * The panes adds a dragable bar between two contents. When dragged
24182     * this bar will resize contents size.
24183     *
24184     * Panes can be displayed vertically or horizontally, and contents
24185     * size proportion can be customized (homogeneous by default).
24186     *
24187     * Smart callbacks one can listen to:
24188     * - "press" - The panes has been pressed (button wasn't released yet).
24189     * - "unpressed" - The panes was released after being pressed.
24190     * - "clicked" - The panes has been clicked>
24191     * - "clicked,double" - The panes has been double clicked
24192     *
24193     * Available styles for it:
24194     * - @c "default"
24195     *
24196     * Default contents parts of the panes widget that you can use for are:
24197     * @li "left" - A leftside content of the panes
24198     * @li "right" - A rightside content of the panes
24199     *
24200     * If panes is displayed vertically, left content will be displayed at
24201     * top.
24202     * 
24203     * Here is an example on its usage:
24204     * @li @ref panes_example
24205     */
24206
24207    /**
24208     * @addtogroup Panes
24209     * @{
24210     */
24211
24212    /**
24213     * Add a new panes widget to the given parent Elementary
24214     * (container) object.
24215     *
24216     * @param parent The parent object.
24217     * @return a new panes widget handle or @c NULL, on errors.
24218     *
24219     * This function inserts a new panes widget on the canvas.
24220     *
24221     * @ingroup Panes
24222     */
24223    EAPI Evas_Object          *elm_panes_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24224
24225    /**
24226     * Set the left content of the panes widget.
24227     *
24228     * @param obj The panes object.
24229     * @param content The new left content object.
24230     *
24231     * Once the content object is set, a previously set one will be deleted.
24232     * If you want to keep that old content object, use the
24233     * elm_panes_content_left_unset() function.
24234     *
24235     * If panes is displayed vertically, left content will be displayed at
24236     * top.
24237     *
24238     * @see elm_panes_content_left_get()
24239     * @see elm_panes_content_right_set() to set content on the other side.
24240     *
24241     * @deprecated use elm_object_part_content_set() instead
24242     *
24243     * @ingroup Panes
24244     */
24245    EINA_DEPRECATED EAPI void                  elm_panes_content_left_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24246
24247    /**
24248     * Set the right content of the panes widget.
24249     *
24250     * @param obj The panes object.
24251     * @param content The new right content object.
24252     *
24253     * Once the content object is set, a previously set one will be deleted.
24254     * If you want to keep that old content object, use the
24255     * elm_panes_content_right_unset() function.
24256     *
24257     * If panes is displayed vertically, left content will be displayed at
24258     * bottom.
24259     *
24260     * @see elm_panes_content_right_get()
24261     * @see elm_panes_content_left_set() to set content on the other side.
24262     *
24263     * @deprecated use elm_object_part_content_set() instead
24264     *
24265     * @ingroup Panes
24266     */
24267    EINA_DEPRECATED EAPI void                  elm_panes_content_right_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24268
24269    /**
24270     * Get the left content of the panes.
24271     *
24272     * @param obj The panes object.
24273     * @return The left content object that is being used.
24274     *
24275     * Return the left content object which is set for this widget.
24276     *
24277     * @see elm_panes_content_left_set() for details.
24278     *
24279     * @deprecated use elm_object_part_content_get() instead
24280     *
24281     * @ingroup Panes
24282     */
24283    EINA_DEPRECATED EAPI Evas_Object          *elm_panes_content_left_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24284
24285    /**
24286     * Get the right content of the panes.
24287     *
24288     * @param obj The panes object
24289     * @return The right content object that is being used
24290     *
24291     * Return the right content object which is set for this widget.
24292     *
24293     * @see elm_panes_content_right_set() for details.
24294     *
24295     * @deprecated use elm_object_part_content_get() instead
24296     *
24297     * @ingroup Panes
24298     */
24299    EINA_DEPRECATED EAPI Evas_Object          *elm_panes_content_right_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24300
24301    /**
24302     * Unset the left content used for the panes.
24303     *
24304     * @param obj The panes object.
24305     * @return The left content object that was being used.
24306     *
24307     * Unparent and return the left content object which was set for this widget.
24308     *
24309     * @see elm_panes_content_left_set() for details.
24310     * @see elm_panes_content_left_get().
24311     *
24312     * @deprecated use elm_object_part_content_unset() instead
24313     *
24314     * @ingroup Panes
24315     */
24316    EINA_DEPRECATED EAPI Evas_Object          *elm_panes_content_left_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24317
24318    /**
24319     * Unset the right content used for the panes.
24320     *
24321     * @param obj The panes object.
24322     * @return The right content object that was being used.
24323     *
24324     * Unparent and return the right content object which was set for this
24325     * widget.
24326     *
24327     * @see elm_panes_content_right_set() for details.
24328     * @see elm_panes_content_right_get().
24329     *
24330     * @deprecated use elm_object_part_content_unset() instead
24331     *
24332     * @ingroup Panes
24333     */
24334    WILL_DEPRECATE  EAPI Evas_Object          *elm_panes_content_right_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24335
24336    /**
24337     * Get the size proportion of panes widget's left side.
24338     *
24339     * @param obj The panes object.
24340     * @return float value between 0.0 and 1.0 representing size proportion
24341     * of left side.
24342     *
24343     * @see elm_panes_content_left_size_set() for more details.
24344     *
24345     * @ingroup Panes
24346     */
24347    EAPI double                elm_panes_content_left_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24348
24349    /**
24350     * Set the size proportion of panes widget's left side.
24351     *
24352     * @param obj The panes object.
24353     * @param size Value between 0.0 and 1.0 representing size proportion
24354     * of left side.
24355     *
24356     * By default it's homogeneous, i.e., both sides have the same size.
24357     *
24358     * If something different is required, it can be set with this function.
24359     * For example, if the left content should be displayed over
24360     * 75% of the panes size, @p size should be passed as @c 0.75.
24361     * This way, right content will be resized to 25% of panes size.
24362     *
24363     * If displayed vertically, left content is displayed at top, and
24364     * right content at bottom.
24365     *
24366     * @note This proportion will change when user drags the panes bar.
24367     *
24368     * @see elm_panes_content_left_size_get()
24369     *
24370     * @ingroup Panes
24371     */
24372    EAPI void                  elm_panes_content_left_size_set(Evas_Object *obj, double size) EINA_ARG_NONNULL(1);
24373
24374   /**
24375    * Set the orientation of a given panes widget.
24376    *
24377    * @param obj The panes object.
24378    * @param horizontal Use @c EINA_TRUE to make @p obj to be
24379    * @b horizontal, @c EINA_FALSE to make it @b vertical.
24380    *
24381    * Use this function to change how your panes is to be
24382    * disposed: vertically or horizontally.
24383    *
24384    * By default it's displayed horizontally.
24385    *
24386    * @see elm_panes_horizontal_get()
24387    *
24388    * @ingroup Panes
24389    */
24390    EAPI void                  elm_panes_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
24391
24392    /**
24393     * Retrieve the orientation of a given panes widget.
24394     *
24395     * @param obj The panes object.
24396     * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
24397     * @c EINA_FALSE if it's @b vertical (and on errors).
24398     *
24399     * @see elm_panes_horizontal_set() for more details.
24400     *
24401     * @ingroup Panes
24402     */
24403    EAPI Eina_Bool             elm_panes_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24404    EAPI void                  elm_panes_fixed_set(Evas_Object *obj, Eina_Bool fixed) EINA_ARG_NONNULL(1);
24405    EAPI Eina_Bool             elm_panes_fixed_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24406
24407    /**
24408     * @}
24409     */
24410
24411    /**
24412     * @defgroup Flip Flip
24413     *
24414     * @image html img/widget/flip/preview-00.png
24415     * @image latex img/widget/flip/preview-00.eps
24416     *
24417     * This widget holds 2 content objects(Evas_Object): one on the front and one
24418     * on the back. It allows you to flip from front to back and vice-versa using
24419     * various animations.
24420     *
24421     * If either the front or back contents are not set the flip will treat that
24422     * as transparent. So if you wore to set the front content but not the back,
24423     * and then call elm_flip_go() you would see whatever is below the flip.
24424     *
24425     * For a list of supported animations see elm_flip_go().
24426     *
24427     * Signals that you can add callbacks for are:
24428     * "animate,begin" - when a flip animation was started
24429     * "animate,done" - when a flip animation is finished
24430     *
24431     * @ref tutorial_flip show how to use most of the API.
24432     *
24433     * @{
24434     */
24435    typedef enum _Elm_Flip_Mode
24436      {
24437         ELM_FLIP_ROTATE_Y_CENTER_AXIS,
24438         ELM_FLIP_ROTATE_X_CENTER_AXIS,
24439         ELM_FLIP_ROTATE_XZ_CENTER_AXIS,
24440         ELM_FLIP_ROTATE_YZ_CENTER_AXIS,
24441         ELM_FLIP_CUBE_LEFT,
24442         ELM_FLIP_CUBE_RIGHT,
24443         ELM_FLIP_CUBE_UP,
24444         ELM_FLIP_CUBE_DOWN,
24445         ELM_FLIP_PAGE_LEFT,
24446         ELM_FLIP_PAGE_RIGHT,
24447         ELM_FLIP_PAGE_UP,
24448         ELM_FLIP_PAGE_DOWN
24449      } Elm_Flip_Mode;
24450    typedef enum _Elm_Flip_Interaction
24451      {
24452         ELM_FLIP_INTERACTION_NONE,
24453         ELM_FLIP_INTERACTION_ROTATE,
24454         ELM_FLIP_INTERACTION_CUBE,
24455         ELM_FLIP_INTERACTION_PAGE
24456      } Elm_Flip_Interaction;
24457    typedef enum _Elm_Flip_Direction
24458      {
24459         ELM_FLIP_DIRECTION_UP, /**< Allows interaction with the top of the widget */
24460         ELM_FLIP_DIRECTION_DOWN, /**< Allows interaction with the bottom of the widget */
24461         ELM_FLIP_DIRECTION_LEFT, /**< Allows interaction with the left portion of the widget */
24462         ELM_FLIP_DIRECTION_RIGHT /**< Allows interaction with the right portion of the widget */
24463      } Elm_Flip_Direction;
24464    /**
24465     * @brief Add a new flip to the parent
24466     *
24467     * @param parent The parent object
24468     * @return The new object or NULL if it cannot be created
24469     */
24470    EAPI Evas_Object *elm_flip_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24471    /**
24472     * @brief Set the front content of the flip widget.
24473     *
24474     * @param obj The flip object
24475     * @param content The new front content object
24476     *
24477     * Once the content object is set, a previously set one will be deleted.
24478     * If you want to keep that old content object, use the
24479     * elm_flip_content_front_unset() function.
24480     */
24481    EAPI void         elm_flip_content_front_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24482    /**
24483     * @brief Set the back content of the flip widget.
24484     *
24485     * @param obj The flip object
24486     * @param content The new back content object
24487     *
24488     * Once the content object is set, a previously set one will be deleted.
24489     * If you want to keep that old content object, use the
24490     * elm_flip_content_back_unset() function.
24491     */
24492    EAPI void         elm_flip_content_back_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24493    /**
24494     * @brief Get the front content used for the flip
24495     *
24496     * @param obj The flip object
24497     * @return The front content object that is being used
24498     *
24499     * Return the front content object which is set for this widget.
24500     */
24501    EAPI Evas_Object *elm_flip_content_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24502    /**
24503     * @brief Get the back content used for the flip
24504     *
24505     * @param obj The flip object
24506     * @return The back content object that is being used
24507     *
24508     * Return the back content object which is set for this widget.
24509     */
24510    EAPI Evas_Object *elm_flip_content_back_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24511    /**
24512     * @brief Unset the front content used for the flip
24513     *
24514     * @param obj The flip object
24515     * @return The front content object that was being used
24516     *
24517     * Unparent and return the front content object which was set for this widget.
24518     */
24519    EAPI Evas_Object *elm_flip_content_front_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24520    /**
24521     * @brief Unset the back content used for the flip
24522     *
24523     * @param obj The flip object
24524     * @return The back content object that was being used
24525     *
24526     * Unparent and return the back content object which was set for this widget.
24527     */
24528    EAPI Evas_Object *elm_flip_content_back_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24529    /**
24530     * @brief Get flip front visibility state
24531     *
24532     * @param obj The flip objct
24533     * @return EINA_TRUE if front front is showing, EINA_FALSE if the back is
24534     * showing.
24535     */
24536    EAPI Eina_Bool    elm_flip_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24537    /**
24538     * @brief Set flip perspective
24539     *
24540     * @param obj The flip object
24541     * @param foc The coordinate to set the focus on
24542     * @param x The X coordinate
24543     * @param y The Y coordinate
24544     *
24545     * @warning This function currently does nothing.
24546     */
24547    EAPI void         elm_flip_perspective_set(Evas_Object *obj, Evas_Coord foc, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
24548    /**
24549     * @brief Runs the flip animation
24550     *
24551     * @param obj The flip object
24552     * @param mode The mode type
24553     *
24554     * Flips the front and back contents using the @p mode animation. This
24555     * efectively hides the currently visible content and shows the hidden one.
24556     *
24557     * There a number of possible animations to use for the flipping:
24558     * @li ELM_FLIP_ROTATE_X_CENTER_AXIS - Rotate the currently visible content
24559     * around a horizontal axis in the middle of its height, the other content
24560     * is shown as the other side of the flip.
24561     * @li ELM_FLIP_ROTATE_Y_CENTER_AXIS - Rotate the currently visible content
24562     * around a vertical axis in the middle of its width, the other content is
24563     * shown as the other side of the flip.
24564     * @li ELM_FLIP_ROTATE_XZ_CENTER_AXIS - Rotate the currently visible content
24565     * around a diagonal axis in the middle of its width, the other content is
24566     * shown as the other side of the flip.
24567     * @li ELM_FLIP_ROTATE_YZ_CENTER_AXIS - Rotate the currently visible content
24568     * around a diagonal axis in the middle of its height, the other content is
24569     * shown as the other side of the flip.
24570     * @li ELM_FLIP_CUBE_LEFT - Rotate the currently visible content to the left
24571     * as if the flip was a cube, the other content is show as the right face of
24572     * the cube.
24573     * @li ELM_FLIP_CUBE_RIGHT - Rotate the currently visible content to the
24574     * right as if the flip was a cube, the other content is show as the left
24575     * face of the cube.
24576     * @li ELM_FLIP_CUBE_UP - Rotate the currently visible content up as if the
24577     * flip was a cube, the other content is show as the bottom face of the cube.
24578     * @li ELM_FLIP_CUBE_DOWN - Rotate the currently visible content down as if
24579     * the flip was a cube, the other content is show as the upper face of the
24580     * cube.
24581     * @li ELM_FLIP_PAGE_LEFT - Move the currently visible content to the left as
24582     * if the flip was a book, the other content is shown as the page below that.
24583     * @li ELM_FLIP_PAGE_RIGHT - Move the currently visible content to the right
24584     * as if the flip was a book, the other content is shown as the page below
24585     * that.
24586     * @li ELM_FLIP_PAGE_UP - Move the currently visible content up as if the
24587     * flip was a book, the other content is shown as the page below that.
24588     * @li ELM_FLIP_PAGE_DOWN - Move the currently visible content down as if the
24589     * flip was a book, the other content is shown as the page below that.
24590     *
24591     * @image html elm_flip.png
24592     * @image latex elm_flip.eps width=\textwidth
24593     */
24594    EAPI void         elm_flip_go(Evas_Object *obj, Elm_Flip_Mode mode) EINA_ARG_NONNULL(1);
24595    /**
24596     * @brief Set the interactive flip mode
24597     *
24598     * @param obj The flip object
24599     * @param mode The interactive flip mode to use
24600     *
24601     * This sets if the flip should be interactive (allow user to click and
24602     * drag a side of the flip to reveal the back page and cause it to flip).
24603     * By default a flip is not interactive. You may also need to set which
24604     * sides of the flip are "active" for flipping and how much space they use
24605     * (a minimum of a finger size) with elm_flip_interacton_direction_enabled_set()
24606     * and elm_flip_interacton_direction_hitsize_set()
24607     *
24608     * The four avilable mode of interaction are:
24609     * @li ELM_FLIP_INTERACTION_NONE - No interaction is allowed
24610     * @li ELM_FLIP_INTERACTION_ROTATE - Interaction will cause rotate animation
24611     * @li ELM_FLIP_INTERACTION_CUBE - Interaction will cause cube animation
24612     * @li ELM_FLIP_INTERACTION_PAGE - Interaction will cause page animation
24613     *
24614     * @note ELM_FLIP_INTERACTION_ROTATE won't cause
24615     * ELM_FLIP_ROTATE_XZ_CENTER_AXIS or ELM_FLIP_ROTATE_YZ_CENTER_AXIS to
24616     * happen, those can only be acheived with elm_flip_go();
24617     */
24618    EAPI void         elm_flip_interaction_set(Evas_Object *obj, Elm_Flip_Interaction mode);
24619    /**
24620     * @brief Get the interactive flip mode
24621     *
24622     * @param obj The flip object
24623     * @return The interactive flip mode
24624     *
24625     * Returns the interactive flip mode set by elm_flip_interaction_set()
24626     */
24627    EAPI Elm_Flip_Interaction elm_flip_interaction_get(const Evas_Object *obj);
24628    /**
24629     * @brief Set which directions of the flip respond to interactive flip
24630     *
24631     * @param obj The flip object
24632     * @param dir The direction to change
24633     * @param enabled If that direction is enabled or not
24634     *
24635     * By default all directions are disabled, so you may want to enable the
24636     * desired directions for flipping if you need interactive flipping. You must
24637     * call this function once for each direction that should be enabled.
24638     *
24639     * @see elm_flip_interaction_set()
24640     */
24641    EAPI void         elm_flip_interacton_direction_enabled_set(Evas_Object *obj, Elm_Flip_Direction dir, Eina_Bool enabled);
24642    /**
24643     * @brief Get the enabled state of that flip direction
24644     *
24645     * @param obj The flip object
24646     * @param dir The direction to check
24647     * @return If that direction is enabled or not
24648     *
24649     * Gets the enabled state set by elm_flip_interacton_direction_enabled_set()
24650     *
24651     * @see elm_flip_interaction_set()
24652     */
24653    EAPI Eina_Bool    elm_flip_interacton_direction_enabled_get(Evas_Object *obj, Elm_Flip_Direction dir);
24654    /**
24655     * @brief Set the amount of the flip that is sensitive to interactive flip
24656     *
24657     * @param obj The flip object
24658     * @param dir The direction to modify
24659     * @param hitsize The amount of that dimension (0.0 to 1.0) to use
24660     *
24661     * Set the amount of the flip that is sensitive to interactive flip, with 0
24662     * representing no area in the flip and 1 representing the entire flip. There
24663     * is however a consideration to be made in that the area will never be
24664     * smaller than the finger size set(as set in your Elementary configuration).
24665     *
24666     * @see elm_flip_interaction_set()
24667     */
24668    EAPI void         elm_flip_interacton_direction_hitsize_set(Evas_Object *obj, Elm_Flip_Direction dir, double hitsize);
24669    /**
24670     * @brief Get the amount of the flip that is sensitive to interactive flip
24671     *
24672     * @param obj The flip object
24673     * @param dir The direction to check
24674     * @return The size set for that direction
24675     *
24676     * Returns the amount os sensitive area set by
24677     * elm_flip_interacton_direction_hitsize_set().
24678     */
24679    EAPI double       elm_flip_interacton_direction_hitsize_get(Evas_Object *obj, Elm_Flip_Direction dir);
24680    /**
24681     * @}
24682     */
24683
24684    /* scrolledentry */
24685    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24686    EINA_DEPRECATED EAPI void         elm_scrolled_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
24687    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24688    EINA_DEPRECATED EAPI void         elm_scrolled_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
24689    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24690    EINA_DEPRECATED EAPI void         elm_scrolled_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
24691    EINA_DEPRECATED EAPI const char  *elm_scrolled_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24692    EINA_DEPRECATED EAPI void         elm_scrolled_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
24693    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24694    EINA_DEPRECATED EAPI const char  *elm_scrolled_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24695    EINA_DEPRECATED EAPI void         elm_scrolled_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
24696    EINA_DEPRECATED EAPI void         elm_scrolled_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
24697    EINA_DEPRECATED EAPI void         elm_scrolled_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
24698    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24699    EINA_DEPRECATED EAPI void         elm_scrolled_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
24700    EINA_DEPRECATED EAPI void         elm_scrolled_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
24701    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
24702    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
24703    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
24704    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
24705    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24706    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24707    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24708    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24709    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
24710    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
24711    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24712    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24713    EINA_DEPRECATED EAPI const char  *elm_scrolled_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24714    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
24715    EINA_DEPRECATED EAPI int          elm_scrolled_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24716    EINA_DEPRECATED EAPI void         elm_scrolled_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
24717    EINA_DEPRECATED EAPI void         elm_scrolled_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
24718    EINA_DEPRECATED EAPI void         elm_scrolled_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
24719    EINA_DEPRECATED EAPI void         elm_scrolled_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
24720    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);
24721    EINA_DEPRECATED EAPI void         elm_scrolled_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
24722    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24723    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);
24724    EINA_DEPRECATED EAPI void         elm_scrolled_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
24725    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);
24726    EINA_DEPRECATED EAPI void         elm_scrolled_entry_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1, 2);
24727    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24728    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24729    EINA_DEPRECATED EAPI void         elm_scrolled_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
24730    EINA_DEPRECATED EAPI void         elm_scrolled_entry_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1, 2);
24731    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24732    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24733    EINA_DEPRECATED EAPI void         elm_scrolled_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
24734    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);
24735    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);
24736    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);
24737    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);
24738    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);
24739    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);
24740    EINA_DEPRECATED EAPI void         elm_scrolled_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
24741    EINA_DEPRECATED EAPI void         elm_scrolled_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
24742    EINA_DEPRECATED EAPI void         elm_scrolled_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
24743    EINA_DEPRECATED EAPI void         elm_scrolled_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
24744    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24745    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
24746    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cnp_textonly_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
24747
24748    /**
24749     * @defgroup Conformant Conformant
24750     * @ingroup Elementary
24751     *
24752     * @image html img/widget/conformant/preview-00.png
24753     * @image latex img/widget/conformant/preview-00.eps width=\textwidth
24754     *
24755     * @image html img/conformant.png
24756     * @image latex img/conformant.eps width=\textwidth
24757     *
24758     * The aim is to provide a widget that can be used in elementary apps to
24759     * account for space taken up by the indicator, virtual keypad & softkey
24760     * windows when running the illume2 module of E17.
24761     *
24762     * So conformant content will be sized and positioned considering the
24763     * space required for such stuff, and when they popup, as a keyboard
24764     * shows when an entry is selected, conformant content won't change.
24765     *
24766     * Available styles for it:
24767     * - @c "default"
24768     *
24769     * Default contents parts of the conformant widget that you can use for are:
24770     * @li "default" - A content of the conformant
24771     *
24772     * See how to use this widget in this example:
24773     * @ref conformant_example
24774     */
24775
24776    /**
24777     * @addtogroup Conformant
24778     * @{
24779     */
24780
24781    /**
24782     * Add a new conformant widget to the given parent Elementary
24783     * (container) object.
24784     *
24785     * @param parent The parent object.
24786     * @return A new conformant widget handle or @c NULL, on errors.
24787     *
24788     * This function inserts a new conformant widget on the canvas.
24789     *
24790     * @ingroup Conformant
24791     */
24792    EAPI Evas_Object *elm_conformant_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24793
24794    /**
24795     * Set the content of the conformant widget.
24796     *
24797     * @param obj The conformant object.
24798     * @param content The content to be displayed by the conformant.
24799     *
24800     * Content will be sized and positioned considering the space required
24801     * to display a virtual keyboard. So it won't fill all the conformant
24802     * size. This way is possible to be sure that content won't resize
24803     * or be re-positioned after the keyboard is displayed.
24804     *
24805     * Once the content object is set, a previously set one will be deleted.
24806     * If you want to keep that old content object, use the
24807     * elm_object_content_unset() function.
24808     *
24809     * @see elm_object_content_unset()
24810     * @see elm_object_content_get()
24811     *
24812     * @deprecated use elm_object_content_set() instead
24813     *
24814     * @ingroup Conformant
24815     */
24816    WILL_DEPRECATE  EAPI void         elm_conformant_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24817
24818    /**
24819     * Get the content of the conformant widget.
24820     *
24821     * @param obj The conformant object.
24822     * @return The content that is being used.
24823     *
24824     * Return the content object which is set for this widget.
24825     * It won't be unparent from conformant. For that, use
24826     * elm_object_content_unset().
24827     *
24828     * @see elm_object_content_set().
24829     * @see elm_object_content_unset()
24830     *
24831     * @deprecated use elm_object_content_get() instead
24832     *
24833     * @ingroup Conformant
24834     */
24835    WILL_DEPRECATE  EAPI Evas_Object *elm_conformant_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24836
24837    /**
24838     * Unset the content of the conformant widget.
24839     *
24840     * @param obj The conformant object.
24841     * @return The content that was being used.
24842     *
24843     * Unparent and return the content object which was set for this widget.
24844     *
24845     * @see elm_object_content_set().
24846     *
24847     * @deprecated use elm_object_content_unset() instead
24848     *
24849     * @ingroup Conformant
24850     */
24851    EINA_DEPRECATED EAPI Evas_Object *elm_conformant_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24852
24853    /**
24854     * Returns the Evas_Object that represents the content area.
24855     *
24856     * @param obj The conformant object.
24857     * @return The content area of the widget.
24858     *
24859     * @ingroup Conformant
24860     */
24861    EAPI Evas_Object *elm_conformant_content_area_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24862
24863    /**
24864     * @}
24865     */
24866
24867    /**
24868     * @defgroup Mapbuf Mapbuf
24869     * @ingroup Elementary
24870     *
24871     * @image html img/widget/mapbuf/preview-00.png
24872     * @image latex img/widget/mapbuf/preview-00.eps width=\textwidth
24873     *
24874     * This holds one content object and uses an Evas Map of transformation
24875     * points to be later used with this content. So the content will be
24876     * moved, resized, etc as a single image. So it will improve performance
24877     * when you have a complex interafce, with a lot of elements, and will
24878     * need to resize or move it frequently (the content object and its
24879     * children).
24880     *
24881     * Default contents parts of the mapbuf widget that you can use for are:
24882     * @li "default" - A content of the mapbuf
24883     *
24884     * To enable map, elm_mapbuf_enabled_set() should be used.
24885     * 
24886     * See how to use this widget in this example:
24887     * @ref mapbuf_example
24888     */
24889
24890    /**
24891     * @addtogroup Mapbuf
24892     * @{
24893     */
24894
24895    /**
24896     * Add a new mapbuf widget to the given parent Elementary
24897     * (container) object.
24898     *
24899     * @param parent The parent object.
24900     * @return A new mapbuf widget handle or @c NULL, on errors.
24901     *
24902     * This function inserts a new mapbuf widget on the canvas.
24903     *
24904     * @ingroup Mapbuf
24905     */
24906    EAPI Evas_Object *elm_mapbuf_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24907
24908    /**
24909     * Set the content of the mapbuf.
24910     *
24911     * @param obj The mapbuf object.
24912     * @param content The content that will be filled in this mapbuf object.
24913     *
24914     * Once the content object is set, a previously set one will be deleted.
24915     * If you want to keep that old content object, use the
24916     * elm_mapbuf_content_unset() function.
24917     *
24918     * To enable map, elm_mapbuf_enabled_set() should be used.
24919     *
24920     * @deprecated use elm_object_content_set() instead
24921     *
24922     * @ingroup Mapbuf
24923     */
24924    WILL_DEPRECATE  EAPI void         elm_mapbuf_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24925
24926    /**
24927     * Get the content of the mapbuf.
24928     *
24929     * @param obj The mapbuf object.
24930     * @return The content that is being used.
24931     *
24932     * Return the content object which is set for this widget.
24933     *
24934     * @see elm_mapbuf_content_set() for details.
24935     *
24936     * @deprecated use elm_object_content_get() instead
24937     *
24938     * @ingroup Mapbuf
24939     */
24940    WILL_DEPRECATE  EAPI Evas_Object *elm_mapbuf_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24941
24942    /**
24943     * Unset the content of the mapbuf.
24944     *
24945     * @param obj The mapbuf object.
24946     * @return The content that was being used.
24947     *
24948     * Unparent and return the content object which was set for this widget.
24949     *
24950     * @see elm_mapbuf_content_set() for details.
24951     *
24952     * @deprecated use elm_object_content_unset() instead
24953     *
24954     * @ingroup Mapbuf
24955     */
24956    WILL_DEPRECATE  EAPI Evas_Object *elm_mapbuf_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24957
24958    /**
24959     * Enable or disable the map.
24960     *
24961     * @param obj The mapbuf object.
24962     * @param enabled @c EINA_TRUE to enable map or @c EINA_FALSE to disable it.
24963     *
24964     * This enables the map that is set or disables it. On enable, the object
24965     * geometry will be saved, and the new geometry will change (position and
24966     * size) to reflect the map geometry set.
24967     *
24968     * Also, when enabled, alpha and smooth states will be used, so if the
24969     * content isn't solid, alpha should be enabled, for example, otherwise
24970     * a black retangle will fill the content.
24971     *
24972     * When disabled, the stored map will be freed and geometry prior to
24973     * enabling the map will be restored.
24974     *
24975     * It's disabled by default.
24976     *
24977     * @see elm_mapbuf_alpha_set()
24978     * @see elm_mapbuf_smooth_set()
24979     *
24980     * @ingroup Mapbuf
24981     */
24982    EAPI void         elm_mapbuf_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
24983
24984    /**
24985     * Get a value whether map is enabled or not.
24986     *
24987     * @param obj The mapbuf object.
24988     * @return @c EINA_TRUE means map is enabled. @c EINA_FALSE indicates
24989     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24990     *
24991     * @see elm_mapbuf_enabled_set() for details.
24992     *
24993     * @ingroup Mapbuf
24994     */
24995    EAPI Eina_Bool    elm_mapbuf_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24996
24997    /**
24998     * Enable or disable smooth map rendering.
24999     *
25000     * @param obj The mapbuf object.
25001     * @param smooth @c EINA_TRUE to enable smooth map rendering or @c EINA_FALSE
25002     * to disable it.
25003     *
25004     * This sets smoothing for map rendering. If the object is a type that has
25005     * its own smoothing settings, then both the smooth settings for this object
25006     * and the map must be turned off.
25007     *
25008     * By default smooth maps are enabled.
25009     *
25010     * @ingroup Mapbuf
25011     */
25012    EAPI void         elm_mapbuf_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
25013
25014    /**
25015     * Get a value whether smooth map rendering is enabled or not.
25016     *
25017     * @param obj The mapbuf object.
25018     * @return @c EINA_TRUE means smooth map rendering is enabled. @c EINA_FALSE
25019     * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
25020     *
25021     * @see elm_mapbuf_smooth_set() for details.
25022     *
25023     * @ingroup Mapbuf
25024     */
25025    EAPI Eina_Bool    elm_mapbuf_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25026
25027    /**
25028     * Set or unset alpha flag for map rendering.
25029     *
25030     * @param obj The mapbuf object.
25031     * @param alpha @c EINA_TRUE to enable alpha blending or @c EINA_FALSE
25032     * to disable it.
25033     *
25034     * This sets alpha flag for map rendering. If the object is a type that has
25035     * its own alpha settings, then this will take precedence. Only image objects
25036     * have this currently. It stops alpha blending of the map area, and is
25037     * useful if you know the object and/or all sub-objects is 100% solid.
25038     *
25039     * Alpha is enabled by default.
25040     *
25041     * @ingroup Mapbuf
25042     */
25043    EAPI void         elm_mapbuf_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
25044
25045    /**
25046     * Get a value whether alpha blending is enabled or not.
25047     *
25048     * @param obj The mapbuf object.
25049     * @return @c EINA_TRUE means alpha blending is enabled. @c EINA_FALSE
25050     * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
25051     *
25052     * @see elm_mapbuf_alpha_set() for details.
25053     *
25054     * @ingroup Mapbuf
25055     */
25056    EAPI Eina_Bool    elm_mapbuf_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25057
25058    /**
25059     * @}
25060     */
25061
25062    /**
25063     * @defgroup Flipselector Flip Selector
25064     *
25065     * @image html img/widget/flipselector/preview-00.png
25066     * @image latex img/widget/flipselector/preview-00.eps
25067     *
25068     * A flip selector is a widget to show a set of @b text items, one
25069     * at a time, with the same sheet switching style as the @ref Clock
25070     * "clock" widget, when one changes the current displaying sheet
25071     * (thus, the "flip" in the name).
25072     *
25073     * User clicks to flip sheets which are @b held for some time will
25074     * make the flip selector to flip continuosly and automatically for
25075     * the user. The interval between flips will keep growing in time,
25076     * so that it helps the user to reach an item which is distant from
25077     * the current selection.
25078     *
25079     * Smart callbacks one can register to:
25080     * - @c "selected" - when the widget's selected text item is changed
25081     * - @c "overflowed" - when the widget's current selection is changed
25082     *   from the first item in its list to the last
25083     * - @c "underflowed" - when the widget's current selection is changed
25084     *   from the last item in its list to the first
25085     *
25086     * Available styles for it:
25087     * - @c "default"
25088     *
25089          * To set/get the label of the flipselector item, you can use
25090          * elm_object_item_text_set/get APIs.
25091          * Once the text is set, a previously set one will be deleted.
25092          * 
25093     * Here is an example on its usage:
25094     * @li @ref flipselector_example
25095     */
25096
25097    /**
25098     * @addtogroup Flipselector
25099     * @{
25100     */
25101
25102    /**
25103     * Add a new flip selector widget to the given parent Elementary
25104     * (container) widget
25105     *
25106     * @param parent The parent object
25107     * @return a new flip selector widget handle or @c NULL, on errors
25108     *
25109     * This function inserts a new flip selector widget on the canvas.
25110     *
25111     * @ingroup Flipselector
25112     */
25113    EAPI Evas_Object               *elm_flipselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25114
25115    /**
25116     * Programmatically select the next item of a flip selector widget
25117     *
25118     * @param obj The flipselector object
25119     *
25120     * @note The selection will be animated. Also, if it reaches the
25121     * end of its list of member items, it will continue with the first
25122     * one onwards.
25123     *
25124     * @ingroup Flipselector
25125     */
25126    EAPI void                       elm_flipselector_flip_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
25127
25128    /**
25129     * Programmatically select the previous item of a flip selector
25130     * widget
25131     *
25132     * @param obj The flipselector object
25133     *
25134     * @note The selection will be animated.  Also, if it reaches the
25135     * beginning of its list of member items, it will continue with the
25136     * last one backwards.
25137     *
25138     * @ingroup Flipselector
25139     */
25140    EAPI void                       elm_flipselector_flip_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
25141
25142    /**
25143     * Append a (text) item to a flip selector widget
25144     *
25145     * @param obj The flipselector object
25146     * @param label The (text) label of the new item
25147     * @param func Convenience callback function to take place when
25148     * item is selected
25149     * @param data Data passed to @p func, above
25150     * @return A handle to the item added or @c NULL, on errors
25151     *
25152     * The widget's list of labels to show will be appended with the
25153     * given value. If the user wishes so, a callback function pointer
25154     * can be passed, which will get called when this same item is
25155     * selected.
25156     *
25157     * @note The current selection @b won't be modified by appending an
25158     * element to the list.
25159     *
25160     * @note The maximum length of the text label is going to be
25161     * determined <b>by the widget's theme</b>. Strings larger than
25162     * that value are going to be @b truncated.
25163     *
25164     * @ingroup Flipselector
25165     */
25166    EAPI Elm_Object_Item     *elm_flipselector_item_append(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
25167
25168    /**
25169     * Prepend a (text) item to a flip selector widget
25170     *
25171     * @param obj The flipselector object
25172     * @param label The (text) label of the new item
25173     * @param func Convenience callback function to take place when
25174     * item is selected
25175     * @param data Data passed to @p func, above
25176     * @return A handle to the item added or @c NULL, on errors
25177     *
25178     * The widget's list of labels to show will be prepended with the
25179     * given value. If the user wishes so, a callback function pointer
25180     * can be passed, which will get called when this same item is
25181     * selected.
25182     *
25183     * @note The current selection @b won't be modified by prepending
25184     * an element to the list.
25185     *
25186     * @note The maximum length of the text label is going to be
25187     * determined <b>by the widget's theme</b>. Strings larger than
25188     * that value are going to be @b truncated.
25189     *
25190     * @ingroup Flipselector
25191     */
25192    EAPI Elm_Object_Item     *elm_flipselector_item_prepend(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
25193
25194    /**
25195     * Get the internal list of items in a given flip selector widget.
25196     *
25197     * @param obj The flipselector object
25198     * @return The list of items (#Elm_Object_Item as data) or
25199     * @c NULL on errors.
25200     *
25201     * This list is @b not to be modified in any way and must not be
25202     * freed. Use the list members with functions like
25203     * elm_object_item_text_set(),
25204     * elm_object_item_text_get(),
25205     * elm_flipselector_item_del(),
25206     * elm_flipselector_item_selected_get(),
25207     * elm_flipselector_item_selected_set().
25208     *
25209     * @warning This list is only valid until @p obj object's internal
25210     * items list is changed. It should be fetched again with another
25211     * call to this function when changes happen.
25212     *
25213     * @ingroup Flipselector
25214     */
25215    EAPI const Eina_List           *elm_flipselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25216
25217    /**
25218     * Get the first item in the given flip selector widget's list of
25219     * items.
25220     *
25221     * @param obj The flipselector object
25222     * @return The first item or @c NULL, if it has no items (and on
25223     * errors)
25224     *
25225     * @see elm_flipselector_item_append()
25226     * @see elm_flipselector_last_item_get()
25227     *
25228     * @ingroup Flipselector
25229     */
25230    EAPI Elm_Object_Item     *elm_flipselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25231
25232    /**
25233     * Get the last item in the given flip selector widget's list of
25234     * items.
25235     *
25236     * @param obj The flipselector object
25237     * @return The last item or @c NULL, if it has no items (and on
25238     * errors)
25239     *
25240     * @see elm_flipselector_item_prepend()
25241     * @see elm_flipselector_first_item_get()
25242     *
25243     * @ingroup Flipselector
25244     */
25245    EAPI Elm_Object_Item     *elm_flipselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25246
25247    /**
25248     * Get the currently selected item in a flip selector widget.
25249     *
25250     * @param obj The flipselector object
25251     * @return The selected item or @c NULL, if the widget has no items
25252     * (and on erros)
25253     *
25254     * @ingroup Flipselector
25255     */
25256    EAPI Elm_Object_Item     *elm_flipselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25257
25258    /**
25259     * Set whether a given flip selector widget's item should be the
25260     * currently selected one.
25261     *
25262     * @param it The flip selector item
25263     * @param selected @c EINA_TRUE to select it, @c EINA_FALSE to unselect.
25264     *
25265     * This sets whether @p item is or not the selected (thus, under
25266     * display) one. If @p item is different than one under display,
25267     * the latter will be unselected. If the @p item is set to be
25268     * unselected, on the other hand, the @b first item in the widget's
25269     * internal members list will be the new selected one.
25270     *
25271     * @see elm_flipselector_item_selected_get()
25272     *
25273     * @ingroup Flipselector
25274     */
25275    EAPI void                       elm_flipselector_item_selected_set(Elm_Object_Item *it, Eina_Bool selected) EINA_ARG_NONNULL(1);
25276
25277    /**
25278     * Get whether a given flip selector widget's item is the currently
25279     * selected one.
25280     *
25281     * @param it The flip selector item
25282     * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
25283     * (or on errors).
25284     *
25285     * @see elm_flipselector_item_selected_set()
25286     *
25287     * @ingroup Flipselector
25288     */
25289    EAPI Eina_Bool                  elm_flipselector_item_selected_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
25290
25291    /**
25292     * Delete a given item from a flip selector widget.
25293     *
25294     * @param it The item to delete
25295     *
25296     * @ingroup Flipselector
25297     */
25298    EAPI void                       elm_flipselector_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
25299
25300    /**
25301     * Get the label of a given flip selector widget's item.
25302     *
25303     * @param it The item to get label from
25304     * @return The text label of @p item or @c NULL, on errors
25305     *
25306     * @see elm_object_item_text_set()
25307     *
25308     * @deprecated see elm_object_item_text_get() instead
25309     * @ingroup Flipselector
25310     */
25311    EINA_DEPRECATED EAPI const char                *elm_flipselector_item_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
25312
25313    /**
25314     * Set the label of a given flip selector widget's item.
25315     *
25316     * @param it The item to set label on
25317     * @param label The text label string, in UTF-8 encoding
25318     *
25319     * @see elm_object_item_text_get()
25320     *
25321          * @deprecated see elm_object_item_text_set() instead
25322     * @ingroup Flipselector
25323     */
25324    EINA_DEPRECATED EAPI void                       elm_flipselector_item_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
25325
25326    /**
25327     * Gets the item before @p item in a flip selector widget's
25328     * internal list of items.
25329     *
25330     * @param it The item to fetch previous from
25331     * @return The item before the @p item, in its parent's list. If
25332     *         there is no previous item for @p item or there's an
25333     *         error, @c NULL is returned.
25334     *
25335     * @see elm_flipselector_item_next_get()
25336     *
25337     * @ingroup Flipselector
25338     */
25339    EAPI Elm_Object_Item     *elm_flipselector_item_prev_get(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
25340
25341    /**
25342     * Gets the item after @p item in a flip selector widget's
25343     * internal list of items.
25344     *
25345     * @param it The item to fetch next from
25346     * @return The item after the @p item, in its parent's list. If
25347     *         there is no next item for @p item or there's an
25348     *         error, @c NULL is returned.
25349     *
25350     * @see elm_flipselector_item_next_get()
25351     *
25352     * @ingroup Flipselector
25353     */
25354    EAPI Elm_Object_Item     *elm_flipselector_item_next_get(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
25355
25356    /**
25357     * Set the interval on time updates for an user mouse button hold
25358     * on a flip selector widget.
25359     *
25360     * @param obj The flip selector object
25361     * @param interval The (first) interval value in seconds
25362     *
25363     * This interval value is @b decreased while the user holds the
25364     * mouse pointer either flipping up or flipping doww a given flip
25365     * selector.
25366     *
25367     * This helps the user to get to a given item distant from the
25368     * current one easier/faster, as it will start to flip quicker and
25369     * quicker on mouse button holds.
25370     *
25371     * The calculation for the next flip interval value, starting from
25372     * the one set with this call, is the previous interval divided by
25373     * 1.05, so it decreases a little bit.
25374     *
25375     * The default starting interval value for automatic flips is
25376     * @b 0.85 seconds.
25377     *
25378     * @see elm_flipselector_interval_get()
25379     *
25380     * @ingroup Flipselector
25381     */
25382    EAPI void                       elm_flipselector_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
25383
25384    /**
25385     * Get the interval on time updates for an user mouse button hold
25386     * on a flip selector widget.
25387     *
25388     * @param obj The flip selector object
25389     * @return The (first) interval value, in seconds, set on it
25390     *
25391     * @see elm_flipselector_interval_set() for more details
25392     *
25393     * @ingroup Flipselector
25394     */
25395    EAPI double                     elm_flipselector_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25396    /**
25397     * @}
25398     */
25399
25400    /**
25401     * @addtogroup Calendar
25402     * @{
25403     */
25404
25405    /**
25406     * @enum _Elm_Calendar_Mark_Repeat
25407     * @typedef Elm_Calendar_Mark_Repeat
25408     *
25409     * Event periodicity, used to define if a mark should be repeated
25410     * @b beyond event's day. It's set when a mark is added.
25411     *
25412     * So, for a mark added to 13th May with periodicity set to WEEKLY,
25413     * there will be marks every week after this date. Marks will be displayed
25414     * at 13th, 20th, 27th, 3rd June ...
25415     *
25416     * Values don't work as bitmask, only one can be choosen.
25417     *
25418     * @see elm_calendar_mark_add()
25419     *
25420     * @ingroup Calendar
25421     */
25422    typedef enum _Elm_Calendar_Mark_Repeat
25423      {
25424         ELM_CALENDAR_UNIQUE, /**< Default value. Marks will be displayed only on event day. */
25425         ELM_CALENDAR_DAILY, /**< Marks will be displayed everyday after event day (inclusive). */
25426         ELM_CALENDAR_WEEKLY, /**< Marks will be displayed every week after event day (inclusive) - i.e. each seven days. */
25427         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*/
25428         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. */
25429      } Elm_Calendar_Mark_Repeat;
25430
25431    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(). */
25432
25433    /**
25434     * Add a new calendar widget to the given parent Elementary
25435     * (container) object.
25436     *
25437     * @param parent The parent object.
25438     * @return a new calendar widget handle or @c NULL, on errors.
25439     *
25440     * This function inserts a new calendar widget on the canvas.
25441     *
25442     * @ref calendar_example_01
25443     *
25444     * @ingroup Calendar
25445     */
25446    EAPI Evas_Object       *elm_calendar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25447
25448    /**
25449     * Get weekdays names displayed by the calendar.
25450     *
25451     * @param obj The calendar object.
25452     * @return Array of seven strings to be used as weekday names.
25453     *
25454     * By default, weekdays abbreviations get from system are displayed:
25455     * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
25456     * The first string is related to Sunday, the second to Monday...
25457     *
25458     * @see elm_calendar_weekdays_name_set()
25459     *
25460     * @ref calendar_example_05
25461     *
25462     * @ingroup Calendar
25463     */
25464    EAPI const char       **elm_calendar_weekdays_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25465
25466    /**
25467     * Set weekdays names to be displayed by the calendar.
25468     *
25469     * @param obj The calendar object.
25470     * @param weekdays Array of seven strings to be used as weekday names.
25471     * @warning It must have 7 elements, or it will access invalid memory.
25472     * @warning The strings must be NULL terminated ('@\0').
25473     *
25474     * By default, weekdays abbreviations get from system are displayed:
25475     * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
25476     *
25477     * The first string should be related to Sunday, the second to Monday...
25478     *
25479     * The usage should be like this:
25480     * @code
25481     *   const char *weekdays[] =
25482     *   {
25483     *      "Sunday", "Monday", "Tuesday", "Wednesday",
25484     *      "Thursday", "Friday", "Saturday"
25485     *   };
25486     *   elm_calendar_weekdays_names_set(calendar, weekdays);
25487     * @endcode
25488     *
25489     * @see elm_calendar_weekdays_name_get()
25490     *
25491     * @ref calendar_example_02
25492     *
25493     * @ingroup Calendar
25494     */
25495    EAPI void               elm_calendar_weekdays_names_set(Evas_Object *obj, const char *weekdays[]) EINA_ARG_NONNULL(1, 2);
25496
25497    /**
25498     * Set the minimum and maximum values for the year
25499     *
25500     * @param obj The calendar object
25501     * @param min The minimum year, greater than 1901;
25502     * @param max The maximum year;
25503     *
25504     * Maximum must be greater than minimum, except if you don't wan't to set
25505     * maximum year.
25506     * Default values are 1902 and -1.
25507     *
25508     * If the maximum year is a negative value, it will be limited depending
25509     * on the platform architecture (year 2037 for 32 bits);
25510     *
25511     * @see elm_calendar_min_max_year_get()
25512     *
25513     * @ref calendar_example_03
25514     *
25515     * @ingroup Calendar
25516     */
25517    EAPI void               elm_calendar_min_max_year_set(Evas_Object *obj, int min, int max) EINA_ARG_NONNULL(1);
25518
25519    /**
25520     * Get the minimum and maximum values for the year
25521     *
25522     * @param obj The calendar object.
25523     * @param min The minimum year.
25524     * @param max The maximum year.
25525     *
25526     * Default values are 1902 and -1.
25527     *
25528     * @see elm_calendar_min_max_year_get() for more details.
25529     *
25530     * @ref calendar_example_05
25531     *
25532     * @ingroup Calendar
25533     */
25534    EAPI void               elm_calendar_min_max_year_get(const Evas_Object *obj, int *min, int *max) EINA_ARG_NONNULL(1);
25535
25536    /**
25537     * Enable or disable day selection
25538     *
25539     * @param obj The calendar object.
25540     * @param enabled @c EINA_TRUE to enable selection or @c EINA_FALSE to
25541     * disable it.
25542     *
25543     * Enabled by default. If disabled, the user still can select months,
25544     * but not days. Selected days are highlighted on calendar.
25545     * It should be used if you won't need such selection for the widget usage.
25546     *
25547     * When a day is selected, or month is changed, smart callbacks for
25548     * signal "changed" will be called.
25549     *
25550     * @see elm_calendar_day_selection_enable_get()
25551     *
25552     * @ref calendar_example_04
25553     *
25554     * @ingroup Calendar
25555     */
25556    EAPI void               elm_calendar_day_selection_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
25557
25558    /**
25559     * Get a value whether day selection is enabled or not.
25560     *
25561     * @see elm_calendar_day_selection_enable_set() for details.
25562     *
25563     * @param obj The calendar object.
25564     * @return EINA_TRUE means day selection is enabled. EINA_FALSE indicates
25565     * it's disabled. If @p obj is NULL, EINA_FALSE is returned.
25566     *
25567     * @ref calendar_example_05
25568     *
25569     * @ingroup Calendar
25570     */
25571    EAPI Eina_Bool          elm_calendar_day_selection_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25572
25573
25574    /**
25575     * Set selected date to be highlighted on calendar.
25576     *
25577     * @param obj The calendar object.
25578     * @param selected_time A @b tm struct to represent the selected date.
25579     *
25580     * Set the selected date, changing the displayed month if needed.
25581     * Selected date changes when the user goes to next/previous month or
25582     * select a day pressing over it on calendar.
25583     *
25584     * @see elm_calendar_selected_time_get()
25585     *
25586     * @ref calendar_example_04
25587     *
25588     * @ingroup Calendar
25589     */
25590    EAPI void               elm_calendar_selected_time_set(Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1);
25591
25592    /**
25593     * Get selected date.
25594     *
25595     * @param obj The calendar object
25596     * @param selected_time A @b tm struct to point to selected date
25597     * @return EINA_FALSE means an error ocurred and returned time shouldn't
25598     * be considered.
25599     *
25600     * Get date selected by the user or set by function
25601     * elm_calendar_selected_time_set().
25602     * Selected date changes when the user goes to next/previous month or
25603     * select a day pressing over it on calendar.
25604     *
25605     * @see elm_calendar_selected_time_get()
25606     *
25607     * @ref calendar_example_05
25608     *
25609     * @ingroup Calendar
25610     */
25611    EAPI Eina_Bool          elm_calendar_selected_time_get(const Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1, 2);
25612
25613    /**
25614     * Set a function to format the string that will be used to display
25615     * month and year;
25616     *
25617     * @param obj The calendar object
25618     * @param format_function Function to set the month-year string given
25619     * the selected date
25620     *
25621     * By default it uses strftime with "%B %Y" format string.
25622     * It should allocate the memory that will be used by the string,
25623     * that will be freed by the widget after usage.
25624     * A pointer to the string and a pointer to the time struct will be provided.
25625     *
25626     * Example:
25627     * @code
25628     * static char *
25629     * _format_month_year(struct tm *selected_time)
25630     * {
25631     *    char buf[32];
25632     *    if (!strftime(buf, sizeof(buf), "%B %Y", selected_time)) return NULL;
25633     *    return strdup(buf);
25634     * }
25635     *
25636     * elm_calendar_format_function_set(calendar, _format_month_year);
25637     * @endcode
25638     *
25639     * @ref calendar_example_02
25640     *
25641     * @ingroup Calendar
25642     */
25643    EAPI void               elm_calendar_format_function_set(Evas_Object *obj, char * (*format_function) (struct tm *stime)) EINA_ARG_NONNULL(1);
25644
25645    /**
25646     * Add a new mark to the calendar
25647     *
25648     * @param obj The calendar object
25649     * @param mark_type A string used to define the type of mark. It will be
25650     * emitted to the theme, that should display a related modification on these
25651     * days representation.
25652     * @param mark_time A time struct to represent the date of inclusion of the
25653     * mark. For marks that repeats it will just be displayed after the inclusion
25654     * date in the calendar.
25655     * @param repeat Repeat the event following this periodicity. Can be a unique
25656     * mark (that don't repeat), daily, weekly, monthly or annually.
25657     * @return The created mark or @p NULL upon failure.
25658     *
25659     * Add a mark that will be drawn in the calendar respecting the insertion
25660     * time and periodicity. It will emit the type as signal to the widget theme.
25661     * Default theme supports "holiday" and "checked", but it can be extended.
25662     *
25663     * It won't immediately update the calendar, drawing the marks.
25664     * For this, call elm_calendar_marks_draw(). However, when user selects
25665     * next or previous month calendar forces marks drawn.
25666     *
25667     * Marks created with this method can be deleted with
25668     * elm_calendar_mark_del().
25669     *
25670     * Example
25671     * @code
25672     * struct tm selected_time;
25673     * time_t current_time;
25674     *
25675     * current_time = time(NULL) + 5 * 84600;
25676     * localtime_r(&current_time, &selected_time);
25677     * elm_calendar_mark_add(cal, "holiday", selected_time,
25678     *     ELM_CALENDAR_ANNUALLY);
25679     *
25680     * current_time = time(NULL) + 1 * 84600;
25681     * localtime_r(&current_time, &selected_time);
25682     * elm_calendar_mark_add(cal, "checked", selected_time, ELM_CALENDAR_UNIQUE);
25683     *
25684     * elm_calendar_marks_draw(cal);
25685     * @endcode
25686     *
25687     * @see elm_calendar_marks_draw()
25688     * @see elm_calendar_mark_del()
25689     *
25690     * @ref calendar_example_06
25691     *
25692     * @ingroup Calendar
25693     */
25694    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);
25695
25696    /**
25697     * Delete mark from the calendar.
25698     *
25699     * @param mark The mark to be deleted.
25700     *
25701     * If deleting all calendar marks is required, elm_calendar_marks_clear()
25702     * should be used instead of getting marks list and deleting each one.
25703     *
25704     * @see elm_calendar_mark_add()
25705     *
25706     * @ref calendar_example_06
25707     *
25708     * @ingroup Calendar
25709     */
25710    EAPI void               elm_calendar_mark_del(Elm_Calendar_Mark *mark) EINA_ARG_NONNULL(1);
25711
25712    /**
25713     * Remove all calendar's marks
25714     *
25715     * @param obj The calendar object.
25716     *
25717     * @see elm_calendar_mark_add()
25718     * @see elm_calendar_mark_del()
25719     *
25720     * @ingroup Calendar
25721     */
25722    EAPI void               elm_calendar_marks_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
25723
25724
25725    /**
25726     * Get a list of all the calendar marks.
25727     *
25728     * @param obj The calendar object.
25729     * @return An @c Eina_List of calendar marks objects, or @c NULL on failure.
25730     *
25731     * @see elm_calendar_mark_add()
25732     * @see elm_calendar_mark_del()
25733     * @see elm_calendar_marks_clear()
25734     *
25735     * @ingroup Calendar
25736     */
25737    EAPI const Eina_List   *elm_calendar_marks_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25738
25739    /**
25740     * Draw calendar marks.
25741     *
25742     * @param obj The calendar object.
25743     *
25744     * Should be used after adding, removing or clearing marks.
25745     * It will go through the entire marks list updating the calendar.
25746     * If lots of marks will be added, add all the marks and then call
25747     * this function.
25748     *
25749     * When the month is changed, i.e. user selects next or previous month,
25750     * marks will be drawed.
25751     *
25752     * @see elm_calendar_mark_add()
25753     * @see elm_calendar_mark_del()
25754     * @see elm_calendar_marks_clear()
25755     *
25756     * @ref calendar_example_06
25757     *
25758     * @ingroup Calendar
25759     */
25760    EAPI void               elm_calendar_marks_draw(Evas_Object *obj) EINA_ARG_NONNULL(1);
25761
25762    /**
25763     * Set a day text color to the same that represents Saturdays.
25764     *
25765     * @param obj The calendar object.
25766     * @param pos The text position. Position is the cell counter, from left
25767     * to right, up to down. It starts on 0 and ends on 41.
25768     *
25769     * @deprecated use elm_calendar_mark_add() instead like:
25770     *
25771     * @code
25772     * struct tm t = { 0, 0, 12, 6, 0, 0, 6, 6, -1 };
25773     * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
25774     * @endcode
25775     *
25776     * @see elm_calendar_mark_add()
25777     *
25778     * @ingroup Calendar
25779     */
25780    EINA_DEPRECATED EAPI void               elm_calendar_text_saturday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25781
25782    /**
25783     * Set a day text color to the same that represents Sundays.
25784     *
25785     * @param obj The calendar object.
25786     * @param pos The text position. Position is the cell counter, from left
25787     * to right, up to down. It starts on 0 and ends on 41.
25788
25789     * @deprecated use elm_calendar_mark_add() instead like:
25790     *
25791     * @code
25792     * struct tm t = { 0, 0, 12, 7, 0, 0, 0, 0, -1 };
25793     * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
25794     * @endcode
25795     *
25796     * @see elm_calendar_mark_add()
25797     *
25798     * @ingroup Calendar
25799     */
25800    EINA_DEPRECATED EAPI void               elm_calendar_text_sunday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25801
25802    /**
25803     * Set a day text color to the same that represents Weekdays.
25804     *
25805     * @param obj The calendar object
25806     * @param pos The text position. Position is the cell counter, from left
25807     * to right, up to down. It starts on 0 and ends on 41.
25808     *
25809     * @deprecated use elm_calendar_mark_add() instead like:
25810     *
25811     * @code
25812     * struct tm t = { 0, 0, 12, 1, 0, 0, 0, 0, -1 };
25813     *
25814     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // monday
25815     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25816     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // tuesday
25817     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25818     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // wednesday
25819     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25820     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // thursday
25821     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25822     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // friday
25823     * @endcode
25824     *
25825     * @see elm_calendar_mark_add()
25826     *
25827     * @ingroup Calendar
25828     */
25829    EINA_DEPRECATED EAPI void               elm_calendar_text_weekday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25830
25831    /**
25832     * Set the interval on time updates for an user mouse button hold
25833     * on calendar widgets' month selection.
25834     *
25835     * @param obj The calendar object
25836     * @param interval The (first) interval value in seconds
25837     *
25838     * This interval value is @b decreased while the user holds the
25839     * mouse pointer either selecting next or previous month.
25840     *
25841     * This helps the user to get to a given month distant from the
25842     * current one easier/faster, as it will start to change quicker and
25843     * quicker on mouse button holds.
25844     *
25845     * The calculation for the next change interval value, starting from
25846     * the one set with this call, is the previous interval divided by
25847     * 1.05, so it decreases a little bit.
25848     *
25849     * The default starting interval value for automatic changes is
25850     * @b 0.85 seconds.
25851     *
25852     * @see elm_calendar_interval_get()
25853     *
25854     * @ingroup Calendar
25855     */
25856    EAPI void               elm_calendar_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
25857
25858    /**
25859     * Get the interval on time updates for an user mouse button hold
25860     * on calendar widgets' month selection.
25861     *
25862     * @param obj The calendar object
25863     * @return The (first) interval value, in seconds, set on it
25864     *
25865     * @see elm_calendar_interval_set() for more details
25866     *
25867     * @ingroup Calendar
25868     */
25869    EAPI double             elm_calendar_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25870
25871    /**
25872     * @}
25873     */
25874
25875    /**
25876     * @defgroup Diskselector Diskselector
25877     * @ingroup Elementary
25878     *
25879     * @image html img/widget/diskselector/preview-00.png
25880     * @image latex img/widget/diskselector/preview-00.eps
25881     *
25882     * A diskselector is a kind of list widget. It scrolls horizontally,
25883     * and can contain label and icon objects. Three items are displayed
25884     * with the selected one in the middle.
25885     *
25886     * It can act like a circular list with round mode and labels can be
25887     * reduced for a defined length for side items.
25888     *
25889     * Smart callbacks one can listen to:
25890     * - "selected" - when item is selected, i.e. scroller stops.
25891     *
25892     * Available styles for it:
25893     * - @c "default"
25894     *
25895     * List of examples:
25896     * @li @ref diskselector_example_01
25897     * @li @ref diskselector_example_02
25898     */
25899
25900    /**
25901     * @addtogroup Diskselector
25902     * @{
25903     */
25904
25905    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(). */
25906
25907    /**
25908     * Add a new diskselector widget to the given parent Elementary
25909     * (container) object.
25910     *
25911     * @param parent The parent object.
25912     * @return a new diskselector widget handle or @c NULL, on errors.
25913     *
25914     * This function inserts a new diskselector widget on the canvas.
25915     *
25916     * @ingroup Diskselector
25917     */
25918    EAPI Evas_Object           *elm_diskselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25919
25920    /**
25921     * Enable or disable round mode.
25922     *
25923     * @param obj The diskselector object.
25924     * @param round @c EINA_TRUE to enable round mode or @c EINA_FALSE to
25925     * disable it.
25926     *
25927     * Disabled by default. If round mode is enabled the items list will
25928     * work like a circle list, so when the user reaches the last item,
25929     * the first one will popup.
25930     *
25931     * @see elm_diskselector_round_get()
25932     *
25933     * @ingroup Diskselector
25934     */
25935    EAPI void                   elm_diskselector_round_set(Evas_Object *obj, Eina_Bool round) EINA_ARG_NONNULL(1);
25936
25937    /**
25938     * Get a value whether round mode is enabled or not.
25939     *
25940     * @see elm_diskselector_round_set() for details.
25941     *
25942     * @param obj The diskselector object.
25943     * @return @c EINA_TRUE means round mode is enabled. @c EINA_FALSE indicates
25944     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
25945     *
25946     * @ingroup Diskselector
25947     */
25948    EAPI Eina_Bool              elm_diskselector_round_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25949
25950    /**
25951     * Get the side labels max length.
25952     *
25953     * @deprecated use elm_diskselector_side_label_length_get() instead:
25954     *
25955     * @param obj The diskselector object.
25956     * @return The max length defined for side labels, or 0 if not a valid
25957     * diskselector.
25958     *
25959     * @ingroup Diskselector
25960     */
25961    EINA_DEPRECATED EAPI int    elm_diskselector_side_label_lenght_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25962
25963    /**
25964     * Set the side labels max length.
25965     *
25966     * @deprecated use elm_diskselector_side_label_length_set() instead:
25967     *
25968     * @param obj The diskselector object.
25969     * @param len The max length defined for side labels.
25970     *
25971     * @ingroup Diskselector
25972     */
25973    EINA_DEPRECATED EAPI void   elm_diskselector_side_label_lenght_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
25974
25975    /**
25976     * Get the side labels max length.
25977     *
25978     * @see elm_diskselector_side_label_length_set() for details.
25979     *
25980     * @param obj The diskselector object.
25981     * @return The max length defined for side labels, or 0 if not a valid
25982     * diskselector.
25983     *
25984     * @ingroup Diskselector
25985     */
25986    EAPI int                    elm_diskselector_side_label_length_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25987
25988    /**
25989     * Set the side labels max length.
25990     *
25991     * @param obj The diskselector object.
25992     * @param len The max length defined for side labels.
25993     *
25994     * Length is the number of characters of items' label that will be
25995     * visible when it's set on side positions. It will just crop
25996     * the string after defined size. E.g.:
25997     *
25998     * An item with label "January" would be displayed on side position as
25999     * "Jan" if max length is set to 3, or "Janu", if this property
26000     * is set to 4.
26001     *
26002     * When it's selected, the entire label will be displayed, except for
26003     * width restrictions. In this case label will be cropped and "..."
26004     * will be concatenated.
26005     *
26006     * Default side label max length is 3.
26007     *
26008     * This property will be applyed over all items, included before or
26009     * later this function call.
26010     *
26011     * @ingroup Diskselector
26012     */
26013    EAPI void                   elm_diskselector_side_label_length_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
26014
26015    /**
26016     * Set the number of items to be displayed.
26017     *
26018     * @param obj The diskselector object.
26019     * @param num The number of items the diskselector will display.
26020     *
26021     * Default value is 3, and also it's the minimun. If @p num is less
26022     * than 3, it will be set to 3.
26023     *
26024     * Also, it can be set on theme, using data item @c display_item_num
26025     * on group "elm/diskselector/item/X", where X is style set.
26026     * E.g.:
26027     *
26028     * group { name: "elm/diskselector/item/X";
26029     * data {
26030     *     item: "display_item_num" "5";
26031     *     }
26032     *
26033     * @ingroup Diskselector
26034     */
26035    EAPI void                   elm_diskselector_display_item_num_set(Evas_Object *obj, int num) EINA_ARG_NONNULL(1);
26036
26037    /**
26038     * Get the number of items in the diskselector object.
26039     *
26040     * @param obj The diskselector object.
26041     *
26042     * @ingroup Diskselector
26043     */
26044    EAPI int                   elm_diskselector_display_item_num_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26045
26046    /**
26047     * Set bouncing behaviour when the scrolled content reaches an edge.
26048     *
26049     * Tell the internal scroller object whether it should bounce or not
26050     * when it reaches the respective edges for each axis.
26051     *
26052     * @param obj The diskselector object.
26053     * @param h_bounce Whether to bounce or not in the horizontal axis.
26054     * @param v_bounce Whether to bounce or not in the vertical axis.
26055     *
26056     * @see elm_scroller_bounce_set()
26057     *
26058     * @ingroup Diskselector
26059     */
26060    EAPI void                   elm_diskselector_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
26061
26062    /**
26063     * Get the bouncing behaviour of the internal scroller.
26064     *
26065     * Get whether the internal scroller should bounce when the edge of each
26066     * axis is reached scrolling.
26067     *
26068     * @param obj The diskselector object.
26069     * @param h_bounce Pointer where to store the bounce state of the horizontal
26070     * axis.
26071     * @param v_bounce Pointer where to store the bounce state of the vertical
26072     * axis.
26073     *
26074     * @see elm_scroller_bounce_get()
26075     * @see elm_diskselector_bounce_set()
26076     *
26077     * @ingroup Diskselector
26078     */
26079    EAPI void                   elm_diskselector_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
26080
26081    /**
26082     * Get the scrollbar policy.
26083     *
26084     * @see elm_diskselector_scroller_policy_get() for details.
26085     *
26086     * @param obj The diskselector object.
26087     * @param policy_h Pointer where to store horizontal scrollbar policy.
26088     * @param policy_v Pointer where to store vertical scrollbar policy.
26089     *
26090     * @ingroup Diskselector
26091     */
26092    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);
26093
26094    /**
26095     * Set the scrollbar policy.
26096     *
26097     * @param obj The diskselector object.
26098     * @param policy_h Horizontal scrollbar policy.
26099     * @param policy_v Vertical scrollbar policy.
26100     *
26101     * This sets the scrollbar visibility policy for the given scroller.
26102     * #ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it
26103     * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
26104     * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
26105     * This applies respectively for the horizontal and vertical scrollbars.
26106     *
26107     * The both are disabled by default, i.e., are set to
26108     * #ELM_SCROLLER_POLICY_OFF.
26109     *
26110     * @ingroup Diskselector
26111     */
26112    EAPI void                   elm_diskselector_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
26113
26114    /**
26115     * Remove all diskselector's items.
26116     *
26117     * @param obj The diskselector object.
26118     *
26119     * @see elm_diskselector_item_del()
26120     * @see elm_diskselector_item_append()
26121     *
26122     * @ingroup Diskselector
26123     */
26124    EAPI void                   elm_diskselector_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
26125
26126    /**
26127     * Get a list of all the diskselector items.
26128     *
26129     * @param obj The diskselector object.
26130     * @return An @c Eina_List of diskselector items, #Elm_Diskselector_Item,
26131     * or @c NULL on failure.
26132     *
26133     * @see elm_diskselector_item_append()
26134     * @see elm_diskselector_item_del()
26135     * @see elm_diskselector_clear()
26136     *
26137     * @ingroup Diskselector
26138     */
26139    EAPI const Eina_List       *elm_diskselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26140
26141    /**
26142     * Appends a new item to the diskselector object.
26143     *
26144     * @param obj The diskselector object.
26145     * @param label The label of the diskselector item.
26146     * @param icon The icon object to use at left side of the item. An
26147     * icon can be any Evas object, but usually it is an icon created
26148     * with elm_icon_add().
26149     * @param func The function to call when the item is selected.
26150     * @param data The data to associate with the item for related callbacks.
26151     *
26152     * @return The created item or @c NULL upon failure.
26153     *
26154     * A new item will be created and appended to the diskselector, i.e., will
26155     * be set as last item. Also, if there is no selected item, it will
26156     * be selected. This will always happens for the first appended item.
26157     *
26158     * If no icon is set, label will be centered on item position, otherwise
26159     * the icon will be placed at left of the label, that will be shifted
26160     * to the right.
26161     *
26162     * Items created with this method can be deleted with
26163     * elm_diskselector_item_del().
26164     *
26165     * Associated @p data can be properly freed when item is deleted if a
26166     * callback function is set with elm_diskselector_item_del_cb_set().
26167     *
26168     * If a function is passed as argument, it will be called everytime this item
26169     * is selected, i.e., the user stops the diskselector with this
26170     * item on center position. If such function isn't needed, just passing
26171     * @c NULL as @p func is enough. The same should be done for @p data.
26172     *
26173     * Simple example (with no function callback or data associated):
26174     * @code
26175     * disk = elm_diskselector_add(win);
26176     * ic = elm_icon_add(win);
26177     * elm_icon_file_set(ic, "path/to/image", NULL);
26178     * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
26179     * elm_diskselector_item_append(disk, "label", ic, NULL, NULL);
26180     * @endcode
26181     *
26182     * @see elm_diskselector_item_del()
26183     * @see elm_diskselector_item_del_cb_set()
26184     * @see elm_diskselector_clear()
26185     * @see elm_icon_add()
26186     *
26187     * @ingroup Diskselector
26188     */
26189    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);
26190
26191
26192    /**
26193     * Delete them item from the diskselector.
26194     *
26195     * @param it The item of diskselector to be deleted.
26196     *
26197     * If deleting all diskselector items is required, elm_diskselector_clear()
26198     * should be used instead of getting items list and deleting each one.
26199     *
26200     * @see elm_diskselector_clear()
26201     * @see elm_diskselector_item_append()
26202     * @see elm_diskselector_item_del_cb_set()
26203     *
26204     * @ingroup Diskselector
26205     */
26206    EAPI void                   elm_diskselector_item_del(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26207
26208    /**
26209     * Set the function called when a diskselector item is freed.
26210     *
26211     * @param it The item to set the callback on
26212     * @param func The function called
26213     *
26214     * If there is a @p func, then it will be called prior item's memory release.
26215     * That will be called with the following arguments:
26216     * @li item's data;
26217     * @li item's Evas object;
26218     * @li item itself;
26219     *
26220     * This way, a data associated to a diskselector item could be properly
26221     * freed.
26222     *
26223     * @ingroup Diskselector
26224     */
26225    EAPI void                   elm_diskselector_item_del_cb_set(Elm_Diskselector_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
26226
26227    /**
26228     * Get the data associated to the item.
26229     *
26230     * @param it The diskselector item
26231     * @return The data associated to @p it
26232     *
26233     * The return value is a pointer to data associated to @p item when it was
26234     * created, with function elm_diskselector_item_append(). If no data
26235     * was passed as argument, it will return @c NULL.
26236     *
26237     * @see elm_diskselector_item_append()
26238     *
26239     * @ingroup Diskselector
26240     */
26241    EAPI void                  *elm_diskselector_item_data_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26242
26243    /**
26244     * Set the icon associated to the item.
26245     *
26246     * @param it The diskselector item
26247     * @param icon The icon object to associate with @p it
26248     *
26249     * The icon object to use at left side of the item. An
26250     * icon can be any Evas object, but usually it is an icon created
26251     * with elm_icon_add().
26252     *
26253     * Once the icon object is set, a previously set one will be deleted.
26254     * @warning Setting the same icon for two items will cause the icon to
26255     * dissapear from the first item.
26256     *
26257     * If an icon was passed as argument on item creation, with function
26258     * elm_diskselector_item_append(), it will be already
26259     * associated to the item.
26260     *
26261     * @see elm_diskselector_item_append()
26262     * @see elm_diskselector_item_icon_get()
26263     *
26264     * @ingroup Diskselector
26265     */
26266    EAPI void                   elm_diskselector_item_icon_set(Elm_Diskselector_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
26267
26268    /**
26269     * Get the icon associated to the item.
26270     *
26271     * @param it The diskselector item
26272     * @return The icon associated to @p it
26273     *
26274     * The return value is a pointer to the icon associated to @p item when it was
26275     * created, with function elm_diskselector_item_append(), or later
26276     * with function elm_diskselector_item_icon_set. If no icon
26277     * was passed as argument, it will return @c NULL.
26278     *
26279     * @see elm_diskselector_item_append()
26280     * @see elm_diskselector_item_icon_set()
26281     *
26282     * @ingroup Diskselector
26283     */
26284    EAPI Evas_Object           *elm_diskselector_item_icon_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26285
26286    /**
26287     * Set the label of item.
26288     *
26289     * @param it The item of diskselector.
26290     * @param label The label of item.
26291     *
26292     * The label to be displayed by the item.
26293     *
26294     * If no icon is set, label will be centered on item position, otherwise
26295     * the icon will be placed at left of the label, that will be shifted
26296     * to the right.
26297     *
26298     * An item with label "January" would be displayed on side position as
26299     * "Jan" if max length is set to 3 with function
26300     * elm_diskselector_side_label_lenght_set(), or "Janu", if this property
26301     * is set to 4.
26302     *
26303     * When this @p item is selected, the entire label will be displayed,
26304     * except for width restrictions.
26305     * In this case label will be cropped and "..." will be concatenated,
26306     * but only for display purposes. It will keep the entire string, so
26307     * if diskselector is resized the remaining characters will be displayed.
26308     *
26309     * If a label was passed as argument on item creation, with function
26310     * elm_diskselector_item_append(), it will be already
26311     * displayed by the item.
26312     *
26313     * @see elm_diskselector_side_label_lenght_set()
26314     * @see elm_diskselector_item_label_get()
26315     * @see elm_diskselector_item_append()
26316     *
26317     * @ingroup Diskselector
26318     */
26319    EAPI void                   elm_diskselector_item_label_set(Elm_Diskselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
26320
26321    /**
26322     * Get the label of item.
26323     *
26324     * @param it The item of diskselector.
26325     * @return The label of item.
26326     *
26327     * The return value is a pointer to the label associated to @p item when it was
26328     * created, with function elm_diskselector_item_append(), or later
26329     * with function elm_diskselector_item_label_set. If no label
26330     * was passed as argument, it will return @c NULL.
26331     *
26332     * @see elm_diskselector_item_label_set() for more details.
26333     * @see elm_diskselector_item_append()
26334     *
26335     * @ingroup Diskselector
26336     */
26337    EAPI const char            *elm_diskselector_item_label_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26338
26339    /**
26340     * Get the selected item.
26341     *
26342     * @param obj The diskselector object.
26343     * @return The selected diskselector item.
26344     *
26345     * The selected item can be unselected with function
26346     * elm_diskselector_item_selected_set(), and the first item of
26347     * diskselector will be selected.
26348     *
26349     * The selected item always will be centered on diskselector, with
26350     * full label displayed, i.e., max lenght set to side labels won't
26351     * apply on the selected item. More details on
26352     * elm_diskselector_side_label_length_set().
26353     *
26354     * @ingroup Diskselector
26355     */
26356    EAPI Elm_Diskselector_Item *elm_diskselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26357
26358    /**
26359     * Set the selected state of an item.
26360     *
26361     * @param it The diskselector item
26362     * @param selected The selected state
26363     *
26364     * This sets the selected state of the given item @p it.
26365     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
26366     *
26367     * If a new item is selected the previosly selected will be unselected.
26368     * Previoulsy selected item can be get with function
26369     * elm_diskselector_selected_item_get().
26370     *
26371     * If the item @p it is unselected, the first item of diskselector will
26372     * be selected.
26373     *
26374     * Selected items will be visible on center position of diskselector.
26375     * So if it was on another position before selected, or was invisible,
26376     * diskselector will animate items until the selected item reaches center
26377     * position.
26378     *
26379     * @see elm_diskselector_item_selected_get()
26380     * @see elm_diskselector_selected_item_get()
26381     *
26382     * @ingroup Diskselector
26383     */
26384    EAPI void                   elm_diskselector_item_selected_set(Elm_Diskselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
26385
26386    /*
26387     * Get whether the @p item is selected or not.
26388     *
26389     * @param it The diskselector item.
26390     * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
26391     * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
26392     *
26393     * @see elm_diskselector_selected_item_set() for details.
26394     * @see elm_diskselector_item_selected_get()
26395     *
26396     * @ingroup Diskselector
26397     */
26398    EAPI Eina_Bool              elm_diskselector_item_selected_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26399
26400    /**
26401     * Get the first item of the diskselector.
26402     *
26403     * @param obj The diskselector object.
26404     * @return The first item, or @c NULL if none.
26405     *
26406     * The list of items follows append order. So it will return the first
26407     * item appended to the widget that wasn't deleted.
26408     *
26409     * @see elm_diskselector_item_append()
26410     * @see elm_diskselector_items_get()
26411     *
26412     * @ingroup Diskselector
26413     */
26414    EAPI Elm_Diskselector_Item *elm_diskselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26415
26416    /**
26417     * Get the last item of the diskselector.
26418     *
26419     * @param obj The diskselector object.
26420     * @return The last item, or @c NULL if none.
26421     *
26422     * The list of items follows append order. So it will return last first
26423     * item appended to the widget that wasn't deleted.
26424     *
26425     * @see elm_diskselector_item_append()
26426     * @see elm_diskselector_items_get()
26427     *
26428     * @ingroup Diskselector
26429     */
26430    EAPI Elm_Diskselector_Item *elm_diskselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26431
26432    /**
26433     * Get the item before @p item in diskselector.
26434     *
26435     * @param it The diskselector item.
26436     * @return The item before @p item, or @c NULL if none or on failure.
26437     *
26438     * The list of items follows append order. So it will return item appended
26439     * just before @p item and that wasn't deleted.
26440     *
26441     * If it is the first item, @c NULL will be returned.
26442     * First item can be get by elm_diskselector_first_item_get().
26443     *
26444     * @see elm_diskselector_item_append()
26445     * @see elm_diskselector_items_get()
26446     *
26447     * @ingroup Diskselector
26448     */
26449    EAPI Elm_Diskselector_Item *elm_diskselector_item_prev_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26450
26451    /**
26452     * Get the item after @p item in diskselector.
26453     *
26454     * @param it The diskselector item.
26455     * @return The item after @p item, or @c NULL if none or on failure.
26456     *
26457     * The list of items follows append order. So it will return item appended
26458     * just after @p item and that wasn't deleted.
26459     *
26460     * If it is the last item, @c NULL will be returned.
26461     * Last item can be get by elm_diskselector_last_item_get().
26462     *
26463     * @see elm_diskselector_item_append()
26464     * @see elm_diskselector_items_get()
26465     *
26466     * @ingroup Diskselector
26467     */
26468    EAPI Elm_Diskselector_Item *elm_diskselector_item_next_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26469
26470    /**
26471     * Set the text to be shown in the diskselector item.
26472     *
26473     * @param item Target item
26474     * @param text The text to set in the content
26475     *
26476     * Setup the text as tooltip to object. The item can have only one tooltip,
26477     * so any previous tooltip data is removed.
26478     *
26479     * @see elm_object_tooltip_text_set() for more details.
26480     *
26481     * @ingroup Diskselector
26482     */
26483    EAPI void                   elm_diskselector_item_tooltip_text_set(Elm_Diskselector_Item *item, const char *text) EINA_ARG_NONNULL(1);
26484
26485    /**
26486     * Set the content to be shown in the tooltip item.
26487     *
26488     * Setup the tooltip to item. The item can have only one tooltip,
26489     * so any previous tooltip data is removed. @p func(with @p data) will
26490     * be called every time that need show the tooltip and it should
26491     * return a valid Evas_Object. This object is then managed fully by
26492     * tooltip system and is deleted when the tooltip is gone.
26493     *
26494     * @param item the diskselector item being attached a tooltip.
26495     * @param func the function used to create the tooltip contents.
26496     * @param data what to provide to @a func as callback data/context.
26497     * @param del_cb called when data is not needed anymore, either when
26498     *        another callback replaces @p func, the tooltip is unset with
26499     *        elm_diskselector_item_tooltip_unset() or the owner @a item
26500     *        dies. This callback receives as the first parameter the
26501     *        given @a data, and @c event_info is the item.
26502     *
26503     * @see elm_object_tooltip_content_cb_set() for more details.
26504     *
26505     * @ingroup Diskselector
26506     */
26507    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);
26508
26509    /**
26510     * Unset tooltip from item.
26511     *
26512     * @param item diskselector item to remove previously set tooltip.
26513     *
26514     * Remove tooltip from item. The callback provided as del_cb to
26515     * elm_diskselector_item_tooltip_content_cb_set() will be called to notify
26516     * it is not used anymore.
26517     *
26518     * @see elm_object_tooltip_unset() for more details.
26519     * @see elm_diskselector_item_tooltip_content_cb_set()
26520     *
26521     * @ingroup Diskselector
26522     */
26523    EAPI void                   elm_diskselector_item_tooltip_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26524
26525
26526    /**
26527     * Sets a different style for this item tooltip.
26528     *
26529     * @note before you set a style you should define a tooltip with
26530     *       elm_diskselector_item_tooltip_content_cb_set() or
26531     *       elm_diskselector_item_tooltip_text_set()
26532     *
26533     * @param item diskselector item with tooltip already set.
26534     * @param style the theme style to use (default, transparent, ...)
26535     *
26536     * @see elm_object_tooltip_style_set() for more details.
26537     *
26538     * @ingroup Diskselector
26539     */
26540    EAPI void                   elm_diskselector_item_tooltip_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
26541
26542    /**
26543     * Get the style for this item tooltip.
26544     *
26545     * @param item diskselector item with tooltip already set.
26546     * @return style the theme style in use, defaults to "default". If the
26547     *         object does not have a tooltip set, then NULL is returned.
26548     *
26549     * @see elm_object_tooltip_style_get() for more details.
26550     * @see elm_diskselector_item_tooltip_style_set()
26551     *
26552     * @ingroup Diskselector
26553     */
26554    EAPI const char            *elm_diskselector_item_tooltip_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26555
26556    /**
26557     * Set the cursor to be shown when mouse is over the diskselector item
26558     *
26559     * @param item Target item
26560     * @param cursor the cursor name to be used.
26561     *
26562     * @see elm_object_cursor_set() for more details.
26563     *
26564     * @ingroup Diskselector
26565     */
26566    EAPI void                   elm_diskselector_item_cursor_set(Elm_Diskselector_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
26567
26568    /**
26569     * Get the cursor to be shown when mouse is over the diskselector item
26570     *
26571     * @param item diskselector item with cursor already set.
26572     * @return the cursor name.
26573     *
26574     * @see elm_object_cursor_get() for more details.
26575     * @see elm_diskselector_cursor_set()
26576     *
26577     * @ingroup Diskselector
26578     */
26579    EAPI const char            *elm_diskselector_item_cursor_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26580
26581
26582    /**
26583     * Unset the cursor to be shown when mouse is over the diskselector item
26584     *
26585     * @param item Target item
26586     *
26587     * @see elm_object_cursor_unset() for more details.
26588     * @see elm_diskselector_cursor_set()
26589     *
26590     * @ingroup Diskselector
26591     */
26592    EAPI void                   elm_diskselector_item_cursor_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26593
26594    /**
26595     * Sets a different style for this item cursor.
26596     *
26597     * @note before you set a style you should define a cursor with
26598     *       elm_diskselector_item_cursor_set()
26599     *
26600     * @param item diskselector item with cursor already set.
26601     * @param style the theme style to use (default, transparent, ...)
26602     *
26603     * @see elm_object_cursor_style_set() for more details.
26604     *
26605     * @ingroup Diskselector
26606     */
26607    EAPI void                   elm_diskselector_item_cursor_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
26608
26609
26610    /**
26611     * Get the style for this item cursor.
26612     *
26613     * @param item diskselector item with cursor already set.
26614     * @return style the theme style in use, defaults to "default". If the
26615     *         object does not have a cursor set, then @c NULL is returned.
26616     *
26617     * @see elm_object_cursor_style_get() for more details.
26618     * @see elm_diskselector_item_cursor_style_set()
26619     *
26620     * @ingroup Diskselector
26621     */
26622    EAPI const char            *elm_diskselector_item_cursor_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26623
26624
26625    /**
26626     * Set if the cursor set should be searched on the theme or should use
26627     * the provided by the engine, only.
26628     *
26629     * @note before you set if should look on theme you should define a cursor
26630     * with elm_diskselector_item_cursor_set().
26631     * By default it will only look for cursors provided by the engine.
26632     *
26633     * @param item widget item with cursor already set.
26634     * @param engine_only boolean to define if cursors set with
26635     * elm_diskselector_item_cursor_set() should be searched only
26636     * between cursors provided by the engine or searched on widget's
26637     * theme as well.
26638     *
26639     * @see elm_object_cursor_engine_only_set() for more details.
26640     *
26641     * @ingroup Diskselector
26642     */
26643    EAPI void                   elm_diskselector_item_cursor_engine_only_set(Elm_Diskselector_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
26644
26645    /**
26646     * Get the cursor engine only usage for this item cursor.
26647     *
26648     * @param item widget item with cursor already set.
26649     * @return engine_only boolean to define it cursors should be looked only
26650     * between the provided by the engine or searched on widget's theme as well.
26651     * If the item does not have a cursor set, then @c EINA_FALSE is returned.
26652     *
26653     * @see elm_object_cursor_engine_only_get() for more details.
26654     * @see elm_diskselector_item_cursor_engine_only_set()
26655     *
26656     * @ingroup Diskselector
26657     */
26658    EAPI Eina_Bool              elm_diskselector_item_cursor_engine_only_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26659
26660    /**
26661     * @}
26662     */
26663
26664    /**
26665     * @defgroup Colorselector Colorselector
26666     *
26667     * @{
26668     *
26669     * @image html img/widget/colorselector/preview-00.png
26670     * @image latex img/widget/colorselector/preview-00.eps
26671     *
26672     * @brief Widget for user to select a color.
26673     *
26674     * Signals that you can add callbacks for are:
26675     * "changed" - When the color value changes(event_info is NULL).
26676     *
26677     * See @ref tutorial_colorselector.
26678     */
26679    /**
26680     * @brief Add a new colorselector to the parent
26681     *
26682     * @param parent The parent object
26683     * @return The new object or NULL if it cannot be created
26684     *
26685     * @ingroup Colorselector
26686     */
26687    EAPI Evas_Object *elm_colorselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26688    /**
26689     * Set a color for the colorselector
26690     *
26691     * @param obj   Colorselector object
26692     * @param r     r-value of color
26693     * @param g     g-value of color
26694     * @param b     b-value of color
26695     * @param a     a-value of color
26696     *
26697     * @ingroup Colorselector
26698     */
26699    EAPI void         elm_colorselector_color_set(Evas_Object *obj, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
26700    /**
26701     * Get a color from the colorselector
26702     *
26703     * @param obj   Colorselector object
26704     * @param r     integer pointer for r-value of color
26705     * @param g     integer pointer for g-value of color
26706     * @param b     integer pointer for b-value of color
26707     * @param a     integer pointer for a-value of color
26708     *
26709     * @ingroup Colorselector
26710     */
26711    EAPI void         elm_colorselector_color_get(const Evas_Object *obj, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
26712    /**
26713     * @}
26714     */
26715
26716    /**
26717     * @defgroup Ctxpopup Ctxpopup
26718     *
26719     * @image html img/widget/ctxpopup/preview-00.png
26720     * @image latex img/widget/ctxpopup/preview-00.eps
26721     *
26722     * @brief Context popup widet.
26723     *
26724     * A ctxpopup is a widget that, when shown, pops up a list of items.
26725     * It automatically chooses an area inside its parent object's view
26726     * (set via elm_ctxpopup_add() and elm_ctxpopup_hover_parent_set()) to
26727     * optimally fit into it. In the default theme, it will also point an
26728     * arrow to it's top left position at the time one shows it. Ctxpopup
26729     * items have a label and/or an icon. It is intended for a small
26730     * number of items (hence the use of list, not genlist).
26731     *
26732     * @note Ctxpopup is a especialization of @ref Hover.
26733     *
26734     * Signals that you can add callbacks for are:
26735     * "dismissed" - the ctxpopup was dismissed
26736     *
26737     * Default contents parts of the ctxpopup widget that you can use for are:
26738     * @li "default" - A content of the ctxpopup
26739     *
26740     * Default contents parts of the naviframe items that you can use for are:
26741     * @li "icon" - A icon in the title area
26742     * 
26743     * Default text parts of the naviframe items that you can use for are:
26744     * @li "default" - Title label in the title area
26745     *
26746     * @ref tutorial_ctxpopup shows the usage of a good deal of the API.
26747     * @{
26748     */
26749    typedef enum _Elm_Ctxpopup_Direction
26750      {
26751         ELM_CTXPOPUP_DIRECTION_DOWN, /**< ctxpopup show appear below clicked
26752                                           area */
26753         ELM_CTXPOPUP_DIRECTION_RIGHT, /**< ctxpopup show appear to the right of
26754                                            the clicked area */
26755         ELM_CTXPOPUP_DIRECTION_LEFT, /**< ctxpopup show appear to the left of
26756                                           the clicked area */
26757         ELM_CTXPOPUP_DIRECTION_UP, /**< ctxpopup show appear above the clicked
26758                                         area */
26759         ELM_CTXPOPUP_DIRECTION_UNKNOWN, /**< ctxpopup does not determine it's direction yet*/
26760      } Elm_Ctxpopup_Direction;
26761 #define Elm_Ctxpopup_Item Elm_Object_Item
26762
26763    /**
26764     * @brief Add a new Ctxpopup object to the parent.
26765     *
26766     * @param parent Parent object
26767     * @return New object or @c NULL, if it cannot be created
26768     */
26769    EAPI Evas_Object  *elm_ctxpopup_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26770    /**
26771     * @brief Set the Ctxpopup's parent
26772     *
26773     * @param obj The ctxpopup object
26774     * @param area The parent to use
26775     *
26776     * Set the parent object.
26777     *
26778     * @note elm_ctxpopup_add() will automatically call this function
26779     * with its @c parent argument.
26780     *
26781     * @see elm_ctxpopup_add()
26782     * @see elm_hover_parent_set()
26783     */
26784    EAPI void          elm_ctxpopup_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1, 2);
26785    /**
26786     * @brief Get the Ctxpopup's parent
26787     *
26788     * @param obj The ctxpopup object
26789     *
26790     * @see elm_ctxpopup_hover_parent_set() for more information
26791     */
26792    EAPI Evas_Object  *elm_ctxpopup_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26793    /**
26794     * @brief Clear all items in the given ctxpopup object.
26795     *
26796     * @param obj Ctxpopup object
26797     */
26798    EAPI void          elm_ctxpopup_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
26799    /**
26800     * @brief Change the ctxpopup's orientation to horizontal or vertical.
26801     *
26802     * @param obj Ctxpopup object
26803     * @param horizontal @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical
26804     */
26805    EAPI void          elm_ctxpopup_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
26806    /**
26807     * @brief Get the value of current ctxpopup object's orientation.
26808     *
26809     * @param obj Ctxpopup object
26810     * @return @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical mode (or errors)
26811     *
26812     * @see elm_ctxpopup_horizontal_set()
26813     */
26814    EAPI Eina_Bool     elm_ctxpopup_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26815    /**
26816     * @brief Add a new item to a ctxpopup object.
26817     *
26818     * @param obj Ctxpopup object
26819     * @param icon Icon to be set on new item
26820     * @param label The Label of the new item
26821     * @param func Convenience function called when item selected
26822     * @param data Data passed to @p func
26823     * @return A handle to the item added or @c NULL, on errors
26824     *
26825     * @warning Ctxpopup can't hold both an item list and a content at the same
26826     * time. When an item is added, any previous content will be removed.
26827     *
26828     * @see elm_ctxpopup_content_set()
26829     */
26830    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);
26831    /**
26832     * @brief Delete the given item in a ctxpopup object.
26833     *
26834     * @param it Ctxpopup item to be deleted
26835     *
26836     * @see elm_ctxpopup_item_append()
26837     */
26838    EAPI void          elm_ctxpopup_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26839    /**
26840     * @brief Set the ctxpopup item's state as disabled or enabled.
26841     *
26842     * @param it Ctxpopup item to be enabled/disabled
26843     * @param disabled @c EINA_TRUE to disable it, @c EINA_FALSE to enable it
26844     *
26845     * When disabled the item is greyed out to indicate it's state.
26846     * @deprecated use elm_object_item_disabled_set() instead
26847     */
26848    WILL_DEPRECATE  EAPI void          elm_ctxpopup_item_disabled_set(Elm_Object_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
26849    /**
26850     * @brief Get the ctxpopup item's disabled/enabled state.
26851     *
26852     * @param it Ctxpopup item to be enabled/disabled
26853     * @return disabled @c EINA_TRUE, if disabled, @c EINA_FALSE otherwise
26854     *
26855     * @see elm_ctxpopup_item_disabled_set()
26856     * @deprecated use elm_object_item_disabled_get() instead
26857     */
26858    EAPI Eina_Bool     elm_ctxpopup_item_disabled_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26859    /**
26860     * @brief Get the icon object for the given ctxpopup item.
26861     *
26862     * @param it Ctxpopup item
26863     * @return icon object or @c NULL, if the item does not have icon or an error
26864     * occurred
26865     *
26866     * @see elm_ctxpopup_item_append()
26867     * @see elm_ctxpopup_item_icon_set()
26868     *
26869     * @deprecated use elm_object_item_part_content_get() instead
26870     */
26871    WILL_DEPRECATE  EAPI Evas_Object  *elm_ctxpopup_item_icon_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26872    /**
26873     * @brief Sets the side icon associated with the ctxpopup item
26874     *
26875     * @param it Ctxpopup item
26876     * @param icon Icon object to be set
26877     *
26878     * Once the icon object is set, a previously set one will be deleted.
26879     * @warning Setting the same icon for two items will cause the icon to
26880     * dissapear from the first item.
26881     *
26882     * @see elm_ctxpopup_item_append()
26883     *  
26884     * @deprecated use elm_object_item_part_content_set() instead
26885     *
26886     */
26887    WILL_DEPRECATE  EAPI void          elm_ctxpopup_item_icon_set(Elm_Object_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
26888    /**
26889     * @brief Get the label for the given ctxpopup item.
26890     *
26891     * @param it Ctxpopup item
26892     * @return label string or @c NULL, if the item does not have label or an
26893     * error occured
26894     *
26895     * @see elm_ctxpopup_item_append()
26896     * @see elm_ctxpopup_item_label_set()
26897     *
26898     * @deprecated use elm_object_item_text_get() instead
26899     */
26900    WILL_DEPRECATE  EAPI const char   *elm_ctxpopup_item_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26901    /**
26902     * @brief (Re)set the label on the given ctxpopup item.
26903     *
26904     * @param it Ctxpopup item
26905     * @param label String to set as label
26906     *
26907     * @deprecated use elm_object_item_text_set() instead
26908     */
26909    WILL_DEPRECATE  EAPI void          elm_ctxpopup_item_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
26910    /**
26911     * @brief Set an elm widget as the content of the ctxpopup.
26912     *
26913     * @param obj Ctxpopup object
26914     * @param content Content to be swallowed
26915     *
26916     * If the content object is already set, a previous one will bedeleted. If
26917     * you want to keep that old content object, use the
26918     * elm_ctxpopup_content_unset() function.
26919     *
26920     * @warning Ctxpopup can't hold both a item list and a content at the same
26921     * time. When a content is set, any previous items will be removed.
26922     * 
26923     * @deprecated use elm_object_content_set() instead
26924     *
26925     */
26926    WILL_DEPRECATE  EAPI void          elm_ctxpopup_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1, 2);
26927    /**
26928     * @brief Unset the ctxpopup content
26929     *
26930     * @param obj Ctxpopup object
26931     * @return The content that was being used
26932     *
26933     * Unparent and return the content object which was set for this widget.
26934     *
26935     * @deprecated use elm_object_content_unset()
26936     *
26937     * @see elm_ctxpopup_content_set()
26938     *
26939     * @deprecated use elm_object_content_unset() instead
26940     *
26941     */
26942    WILL_DEPRECATE  EAPI Evas_Object  *elm_ctxpopup_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
26943    /**
26944     * @brief Set the direction priority of a ctxpopup.
26945     *
26946     * @param obj Ctxpopup object
26947     * @param first 1st priority of direction
26948     * @param second 2nd priority of direction
26949     * @param third 3th priority of direction
26950     * @param fourth 4th priority of direction
26951     *
26952     * This functions gives a chance to user to set the priority of ctxpopup
26953     * showing direction. This doesn't guarantee the ctxpopup will appear in the
26954     * requested direction.
26955     *
26956     * @see Elm_Ctxpopup_Direction
26957     */
26958    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);
26959    /**
26960     * @brief Get the direction priority of a ctxpopup.
26961     *
26962     * @param obj Ctxpopup object
26963     * @param first 1st priority of direction to be returned
26964     * @param second 2nd priority of direction to be returned
26965     * @param third 3th priority of direction to be returned
26966     * @param fourth 4th priority of direction to be returned
26967     *
26968     * @see elm_ctxpopup_direction_priority_set() for more information.
26969     */
26970    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);
26971
26972    /**
26973     * @brief Get the current direction of a ctxpopup.
26974     *
26975     * @param obj Ctxpopup object
26976     * @return current direction of a ctxpopup
26977     *
26978     * @warning Once the ctxpopup showed up, the direction would be determined
26979     */
26980    EAPI Elm_Ctxpopup_Direction elm_ctxpopup_direction_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26981
26982    /**
26983     * @}
26984     */
26985
26986    /* transit */
26987    /**
26988     *
26989     * @defgroup Transit Transit
26990     * @ingroup Elementary
26991     *
26992     * Transit is designed to apply various animated transition effects to @c
26993     * Evas_Object, such like translation, rotation, etc. For using these
26994     * effects, create an @ref Elm_Transit and add the desired transition effects.
26995     *
26996     * Once the effects are added into transit, they will be automatically
26997     * managed (their callback will be called until the duration is ended, and
26998     * they will be deleted on completion).
26999     *
27000     * Example:
27001     * @code
27002     * Elm_Transit *trans = elm_transit_add();
27003     * elm_transit_object_add(trans, obj);
27004     * elm_transit_effect_translation_add(trans, 0, 0, 280, 280
27005     * elm_transit_duration_set(transit, 1);
27006     * elm_transit_auto_reverse_set(transit, EINA_TRUE);
27007     * elm_transit_tween_mode_set(transit, ELM_TRANSIT_TWEEN_MODE_DECELERATE);
27008     * elm_transit_repeat_times_set(transit, 3);
27009     * @endcode
27010     *
27011     * Some transition effects are used to change the properties of objects. They
27012     * are:
27013     * @li @ref elm_transit_effect_translation_add
27014     * @li @ref elm_transit_effect_color_add
27015     * @li @ref elm_transit_effect_rotation_add
27016     * @li @ref elm_transit_effect_wipe_add
27017     * @li @ref elm_transit_effect_zoom_add
27018     * @li @ref elm_transit_effect_resizing_add
27019     *
27020     * Other transition effects are used to make one object disappear and another
27021     * object appear on its old place. These effects are:
27022     *
27023     * @li @ref elm_transit_effect_flip_add
27024     * @li @ref elm_transit_effect_resizable_flip_add
27025     * @li @ref elm_transit_effect_fade_add
27026     * @li @ref elm_transit_effect_blend_add
27027     *
27028     * It's also possible to make a transition chain with @ref
27029     * elm_transit_chain_transit_add.
27030     *
27031     * @warning We strongly recommend to use elm_transit just when edje can not do
27032     * the trick. Edje has more advantage than Elm_Transit, it has more flexibility and
27033     * animations can be manipulated inside the theme.
27034     *
27035     * List of examples:
27036     * @li @ref transit_example_01_explained
27037     * @li @ref transit_example_02_explained
27038     * @li @ref transit_example_03_c
27039     * @li @ref transit_example_04_c
27040     *
27041     * @{
27042     */
27043
27044    /**
27045     * @enum Elm_Transit_Tween_Mode
27046     *
27047     * The type of acceleration used in the transition.
27048     */
27049    typedef enum
27050      {
27051         ELM_TRANSIT_TWEEN_MODE_LINEAR, /**< Constant speed */
27052         ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL, /**< Starts slow, increase speed
27053                                              over time, then decrease again
27054                                              and stop slowly */
27055         ELM_TRANSIT_TWEEN_MODE_DECELERATE, /**< Starts fast and decrease
27056                                              speed over time */
27057         ELM_TRANSIT_TWEEN_MODE_ACCELERATE /**< Starts slow and increase speed
27058                                             over time */
27059      } Elm_Transit_Tween_Mode;
27060
27061    /**
27062     * @enum Elm_Transit_Effect_Flip_Axis
27063     *
27064     * The axis where flip effect should be applied.
27065     */
27066    typedef enum
27067      {
27068         ELM_TRANSIT_EFFECT_FLIP_AXIS_X, /**< Flip on X axis */
27069         ELM_TRANSIT_EFFECT_FLIP_AXIS_Y /**< Flip on Y axis */
27070      } Elm_Transit_Effect_Flip_Axis;
27071    /**
27072     * @enum Elm_Transit_Effect_Wipe_Dir
27073     *
27074     * The direction where the wipe effect should occur.
27075     */
27076    typedef enum
27077      {
27078         ELM_TRANSIT_EFFECT_WIPE_DIR_LEFT, /**< Wipe to the left */
27079         ELM_TRANSIT_EFFECT_WIPE_DIR_RIGHT, /**< Wipe to the right */
27080         ELM_TRANSIT_EFFECT_WIPE_DIR_UP, /**< Wipe up */
27081         ELM_TRANSIT_EFFECT_WIPE_DIR_DOWN /**< Wipe down */
27082      } Elm_Transit_Effect_Wipe_Dir;
27083    /** @enum Elm_Transit_Effect_Wipe_Type
27084     *
27085     * Whether the wipe effect should show or hide the object.
27086     */
27087    typedef enum
27088      {
27089         ELM_TRANSIT_EFFECT_WIPE_TYPE_HIDE, /**< Hide the object during the
27090                                              animation */
27091         ELM_TRANSIT_EFFECT_WIPE_TYPE_SHOW /**< Show the object during the
27092                                             animation */
27093      } Elm_Transit_Effect_Wipe_Type;
27094
27095    /**
27096     * @typedef Elm_Transit
27097     *
27098     * The Transit created with elm_transit_add(). This type has the information
27099     * about the objects which the transition will be applied, and the
27100     * transition effects that will be used. It also contains info about
27101     * duration, number of repetitions, auto-reverse, etc.
27102     */
27103    typedef struct _Elm_Transit Elm_Transit;
27104    typedef void Elm_Transit_Effect;
27105    /**
27106     * @typedef Elm_Transit_Effect_Transition_Cb
27107     *
27108     * Transition callback called for this effect on each transition iteration.
27109     */
27110    typedef void (*Elm_Transit_Effect_Transition_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit, double progress);
27111    /**
27112     * Elm_Transit_Effect_End_Cb
27113     *
27114     * Transition callback called for this effect when the transition is over.
27115     */
27116    typedef void (*Elm_Transit_Effect_End_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit);
27117
27118    /**
27119     * Elm_Transit_Del_Cb
27120     *
27121     * A callback called when the transit is deleted.
27122     */
27123    typedef void (*Elm_Transit_Del_Cb) (void *data, Elm_Transit *transit);
27124
27125    /**
27126     * Add new transit.
27127     *
27128     * @note Is not necessary to delete the transit object, it will be deleted at
27129     * the end of its operation.
27130     * @note The transit will start playing when the program enter in the main loop, is not
27131     * necessary to give a start to the transit.
27132     *
27133     * @return The transit object.
27134     *
27135     * @ingroup Transit
27136     */
27137    EAPI Elm_Transit                *elm_transit_add(void);
27138
27139    /**
27140     * Stops the animation and delete the @p transit object.
27141     *
27142     * Call this function if you wants to stop the animation before the duration
27143     * time. Make sure the @p transit object is still alive with
27144     * elm_transit_del_cb_set() function.
27145     * All added effects will be deleted, calling its repective data_free_cb
27146     * functions. The function setted by elm_transit_del_cb_set() will be called.
27147     *
27148     * @see elm_transit_del_cb_set()
27149     *
27150     * @param transit The transit object to be deleted.
27151     *
27152     * @ingroup Transit
27153     * @warning Just call this function if you are sure the transit is alive.
27154     */
27155    EAPI void                        elm_transit_del(Elm_Transit *transit) EINA_ARG_NONNULL(1);
27156
27157    /**
27158     * Add a new effect to the transit.
27159     *
27160     * @note The cb function and the data are the key to the effect. If you try to
27161     * add an already added effect, nothing is done.
27162     * @note After the first addition of an effect in @p transit, if its
27163     * effect list become empty again, the @p transit will be killed by
27164     * elm_transit_del(transit) function.
27165     *
27166     * Exemple:
27167     * @code
27168     * Elm_Transit *transit = elm_transit_add();
27169     * elm_transit_effect_add(transit,
27170     *                        elm_transit_effect_blend_op,
27171     *                        elm_transit_effect_blend_context_new(),
27172     *                        elm_transit_effect_blend_context_free);
27173     * @endcode
27174     *
27175     * @param transit The transit object.
27176     * @param transition_cb The operation function. It is called when the
27177     * animation begins, it is the function that actually performs the animation.
27178     * It is called with the @p data, @p transit and the time progression of the
27179     * animation (a double value between 0.0 and 1.0).
27180     * @param effect The context data of the effect.
27181     * @param end_cb The function to free the context data, it will be called
27182     * at the end of the effect, it must finalize the animation and free the
27183     * @p data.
27184     *
27185     * @ingroup Transit
27186     * @warning The transit free the context data at the and of the transition with
27187     * the data_free_cb function, do not use the context data in another transit.
27188     */
27189    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);
27190
27191    /**
27192     * Delete an added effect.
27193     *
27194     * This function will remove the effect from the @p transit, calling the
27195     * data_free_cb to free the @p data.
27196     *
27197     * @see elm_transit_effect_add()
27198     *
27199     * @note If the effect is not found, nothing is done.
27200     * @note If the effect list become empty, this function will call
27201     * elm_transit_del(transit), that is, it will kill the @p transit.
27202     *
27203     * @param transit The transit object.
27204     * @param transition_cb The operation function.
27205     * @param effect The context data of the effect.
27206     *
27207     * @ingroup Transit
27208     */
27209    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);
27210
27211    /**
27212     * Add new object to apply the effects.
27213     *
27214     * @note After the first addition of an object in @p transit, if its
27215     * object list become empty again, the @p transit will be killed by
27216     * elm_transit_del(transit) function.
27217     * @note If the @p obj belongs to another transit, the @p obj will be
27218     * removed from it and it will only belong to the @p transit. If the old
27219     * transit stays without objects, it will die.
27220     * @note When you add an object into the @p transit, its state from
27221     * evas_object_pass_events_get(obj) is saved, and it is applied when the
27222     * transit ends, if you change this state whith evas_object_pass_events_set()
27223     * after add the object, this state will change again when @p transit stops to
27224     * run.
27225     *
27226     * @param transit The transit object.
27227     * @param obj Object to be animated.
27228     *
27229     * @ingroup Transit
27230     * @warning It is not allowed to add a new object after transit begins to go.
27231     */
27232    EAPI void                        elm_transit_object_add(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
27233
27234    /**
27235     * Removes an added object from the transit.
27236     *
27237     * @note If the @p obj is not in the @p transit, nothing is done.
27238     * @note If the list become empty, this function will call
27239     * elm_transit_del(transit), that is, it will kill the @p transit.
27240     *
27241     * @param transit The transit object.
27242     * @param obj Object to be removed from @p transit.
27243     *
27244     * @ingroup Transit
27245     * @warning It is not allowed to remove objects after transit begins to go.
27246     */
27247    EAPI void                        elm_transit_object_remove(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
27248
27249    /**
27250     * Get the objects of the transit.
27251     *
27252     * @param transit The transit object.
27253     * @return a Eina_List with the objects from the transit.
27254     *
27255     * @ingroup Transit
27256     */
27257    EAPI const Eina_List            *elm_transit_objects_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27258
27259    /**
27260     * Enable/disable keeping up the objects states.
27261     * If it is not kept, the objects states will be reset when transition ends.
27262     *
27263     * @note @p transit can not be NULL.
27264     * @note One state includes geometry, color, map data.
27265     *
27266     * @param transit The transit object.
27267     * @param state_keep Keeping or Non Keeping.
27268     *
27269     * @ingroup Transit
27270     */
27271    EAPI void                        elm_transit_objects_final_state_keep_set(Elm_Transit *transit, Eina_Bool state_keep) EINA_ARG_NONNULL(1);
27272
27273    /**
27274     * Get a value whether the objects states will be reset or not.
27275     *
27276     * @note @p transit can not be NULL
27277     *
27278     * @see elm_transit_objects_final_state_keep_set()
27279     *
27280     * @param transit The transit object.
27281     * @return EINA_TRUE means the states of the objects will be reset.
27282     * If @p transit is NULL, EINA_FALSE is returned
27283     *
27284     * @ingroup Transit
27285     */
27286    EAPI Eina_Bool                   elm_transit_objects_final_state_keep_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27287
27288    /**
27289     * Set the event enabled when transit is operating.
27290     *
27291     * If @p enabled is EINA_TRUE, the objects of the transit will receives
27292     * events from mouse and keyboard during the animation.
27293     * @note When you add an object with elm_transit_object_add(), its state from
27294     * evas_object_pass_events_get(obj) is saved, and it is applied when the
27295     * transit ends, if you change this state with evas_object_pass_events_set()
27296     * after adding the object, this state will change again when @p transit stops
27297     * to run.
27298     *
27299     * @param transit The transit object.
27300     * @param enabled Events are received when enabled is @c EINA_TRUE, and
27301     * ignored otherwise.
27302     *
27303     * @ingroup Transit
27304     */
27305    EAPI void                        elm_transit_event_enabled_set(Elm_Transit *transit, Eina_Bool enabled) EINA_ARG_NONNULL(1);
27306
27307    /**
27308     * Get the value of event enabled status.
27309     *
27310     * @see elm_transit_event_enabled_set()
27311     *
27312     * @param transit The Transit object
27313     * @return EINA_TRUE, when event is enabled. If @p transit is NULL
27314     * EINA_FALSE is returned
27315     *
27316     * @ingroup Transit
27317     */
27318    EAPI Eina_Bool                   elm_transit_event_enabled_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27319
27320    /**
27321     * Set the user-callback function when the transit is deleted.
27322     *
27323     * @note Using this function twice will overwrite the first function setted.
27324     * @note the @p transit object will be deleted after call @p cb function.
27325     *
27326     * @param transit The transit object.
27327     * @param cb Callback function pointer. This function will be called before
27328     * the deletion of the transit.
27329     * @param data Callback funtion user data. It is the @p op parameter.
27330     *
27331     * @ingroup Transit
27332     */
27333    EAPI void                        elm_transit_del_cb_set(Elm_Transit *transit, Elm_Transit_Del_Cb cb, void *data) EINA_ARG_NONNULL(1);
27334
27335    /**
27336     * Set reverse effect automatically.
27337     *
27338     * If auto reverse is setted, after running the effects with the progress
27339     * parameter from 0 to 1, it will call the effecs again with the progress
27340     * from 1 to 0. The transit will last for a time iqual to (2 * duration * repeat),
27341     * where the duration was setted with the function elm_transit_add and
27342     * the repeat with the function elm_transit_repeat_times_set().
27343     *
27344     * @param transit The transit object.
27345     * @param reverse EINA_TRUE means the auto_reverse is on.
27346     *
27347     * @ingroup Transit
27348     */
27349    EAPI void                        elm_transit_auto_reverse_set(Elm_Transit *transit, Eina_Bool reverse) EINA_ARG_NONNULL(1);
27350
27351    /**
27352     * Get if the auto reverse is on.
27353     *
27354     * @see elm_transit_auto_reverse_set()
27355     *
27356     * @param transit The transit object.
27357     * @return EINA_TRUE means auto reverse is on. If @p transit is NULL
27358     * EINA_FALSE is returned
27359     *
27360     * @ingroup Transit
27361     */
27362    EAPI Eina_Bool                   elm_transit_auto_reverse_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27363
27364    /**
27365     * Set the transit repeat count. Effect will be repeated by repeat count.
27366     *
27367     * This function sets the number of repetition the transit will run after
27368     * the first one, that is, if @p repeat is 1, the transit will run 2 times.
27369     * If the @p repeat is a negative number, it will repeat infinite times.
27370     *
27371     * @note If this function is called during the transit execution, the transit
27372     * will run @p repeat times, ignoring the times it already performed.
27373     *
27374     * @param transit The transit object
27375     * @param repeat Repeat count
27376     *
27377     * @ingroup Transit
27378     */
27379    EAPI void                        elm_transit_repeat_times_set(Elm_Transit *transit, int repeat) EINA_ARG_NONNULL(1);
27380
27381    /**
27382     * Get the transit repeat count.
27383     *
27384     * @see elm_transit_repeat_times_set()
27385     *
27386     * @param transit The Transit object.
27387     * @return The repeat count. If @p transit is NULL
27388     * 0 is returned
27389     *
27390     * @ingroup Transit
27391     */
27392    EAPI int                         elm_transit_repeat_times_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27393
27394    /**
27395     * Set the transit animation acceleration type.
27396     *
27397     * This function sets the tween mode of the transit that can be:
27398     * ELM_TRANSIT_TWEEN_MODE_LINEAR - The default mode.
27399     * ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL - Starts in accelerate mode and ends decelerating.
27400     * ELM_TRANSIT_TWEEN_MODE_DECELERATE - The animation will be slowed over time.
27401     * ELM_TRANSIT_TWEEN_MODE_ACCELERATE - The animation will accelerate over time.
27402     *
27403     * @param transit The transit object.
27404     * @param tween_mode The tween type.
27405     *
27406     * @ingroup Transit
27407     */
27408    EAPI void                        elm_transit_tween_mode_set(Elm_Transit *transit, Elm_Transit_Tween_Mode tween_mode) EINA_ARG_NONNULL(1);
27409
27410    /**
27411     * Get the transit animation acceleration type.
27412     *
27413     * @note @p transit can not be NULL
27414     *
27415     * @param transit The transit object.
27416     * @return The tween type. If @p transit is NULL
27417     * ELM_TRANSIT_TWEEN_MODE_LINEAR is returned.
27418     *
27419     * @ingroup Transit
27420     */
27421    EAPI Elm_Transit_Tween_Mode      elm_transit_tween_mode_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27422
27423    /**
27424     * Set the transit animation time
27425     *
27426     * @note @p transit can not be NULL
27427     *
27428     * @param transit The transit object.
27429     * @param duration The animation time.
27430     *
27431     * @ingroup Transit
27432     */
27433    EAPI void                        elm_transit_duration_set(Elm_Transit *transit, double duration) EINA_ARG_NONNULL(1);
27434
27435    /**
27436     * Get the transit animation time
27437     *
27438     * @note @p transit can not be NULL
27439     *
27440     * @param transit The transit object.
27441     *
27442     * @return The transit animation time.
27443     *
27444     * @ingroup Transit
27445     */
27446    EAPI double                      elm_transit_duration_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27447
27448    /**
27449     * Starts the transition.
27450     * Once this API is called, the transit begins to measure the time.
27451     *
27452     * @note @p transit can not be NULL
27453     *
27454     * @param transit The transit object.
27455     *
27456     * @ingroup Transit
27457     */
27458    EAPI void                        elm_transit_go(Elm_Transit *transit) EINA_ARG_NONNULL(1);
27459
27460    /**
27461     * Pause/Resume the transition.
27462     *
27463     * If you call elm_transit_go again, the transit will be started from the
27464     * beginning, and will be unpaused.
27465     *
27466     * @note @p transit can not be NULL
27467     *
27468     * @param transit The transit object.
27469     * @param paused Whether the transition should be paused or not.
27470     *
27471     * @ingroup Transit
27472     */
27473    EAPI void                        elm_transit_paused_set(Elm_Transit *transit, Eina_Bool paused) EINA_ARG_NONNULL(1);
27474
27475    /**
27476     * Get the value of paused status.
27477     *
27478     * @see elm_transit_paused_set()
27479     *
27480     * @note @p transit can not be NULL
27481     *
27482     * @param transit The transit object.
27483     * @return EINA_TRUE means transition is paused. If @p transit is NULL
27484     * EINA_FALSE is returned
27485     *
27486     * @ingroup Transit
27487     */
27488    EAPI Eina_Bool                   elm_transit_paused_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27489
27490    /**
27491     * Get the time progression of the animation (a double value between 0.0 and 1.0).
27492     *
27493     * The value returned is a fraction (current time / total time). It
27494     * represents the progression position relative to the total.
27495     *
27496     * @note @p transit can not be NULL
27497     *
27498     * @param transit The transit object.
27499     *
27500     * @return The time progression value. If @p transit is NULL
27501     * 0 is returned
27502     *
27503     * @ingroup Transit
27504     */
27505    EAPI double                      elm_transit_progress_value_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27506
27507    /**
27508     * Makes the chain relationship between two transits.
27509     *
27510     * @note @p transit can not be NULL. Transit would have multiple chain transits.
27511     * @note @p chain_transit can not be NULL. Chain transits could be chained to the only one transit.
27512     *
27513     * @param transit The transit object.
27514     * @param chain_transit The chain transit object. This transit will be operated
27515     *        after transit is done.
27516     *
27517     * This function adds @p chain_transit transition to a chain after the @p
27518     * transit, and will be started as soon as @p transit ends. See @ref
27519     * transit_example_02_explained for a full example.
27520     *
27521     * @ingroup Transit
27522     */
27523    EAPI void                        elm_transit_chain_transit_add(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1, 2);
27524
27525    /**
27526     * Cut off the chain relationship between two transits.
27527     *
27528     * @note @p transit can not be NULL. Transit would have the chain relationship with @p chain transit.
27529     * @note @p chain_transit can not be NULL. Chain transits should be chained to the @p transit.
27530     *
27531     * @param transit The transit object.
27532     * @param chain_transit The chain transit object.
27533     *
27534     * This function remove the @p chain_transit transition from the @p transit.
27535     *
27536     * @ingroup Transit
27537     */
27538    EAPI void                        elm_transit_chain_transit_del(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1,2);
27539
27540    /**
27541     * Get the current chain transit list.
27542     *
27543     * @note @p transit can not be NULL.
27544     *
27545     * @param transit The transit object.
27546     * @return chain transit list.
27547     *
27548     * @ingroup Transit
27549     */
27550    EAPI Eina_List                  *elm_transit_chain_transits_get(const Elm_Transit *transit);
27551
27552    /**
27553     * Add the Resizing Effect to Elm_Transit.
27554     *
27555     * @note This API is one of the facades. It creates resizing effect context
27556     * and add it's required APIs to elm_transit_effect_add.
27557     *
27558     * @see elm_transit_effect_add()
27559     *
27560     * @param transit Transit object.
27561     * @param from_w Object width size when effect begins.
27562     * @param from_h Object height size when effect begins.
27563     * @param to_w Object width size when effect ends.
27564     * @param to_h Object height size when effect ends.
27565     * @return Resizing effect context data.
27566     *
27567     * @ingroup Transit
27568     */
27569    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);
27570
27571    /**
27572     * Add the Translation Effect to Elm_Transit.
27573     *
27574     * @note This API is one of the facades. It creates translation effect context
27575     * and add it's required APIs to elm_transit_effect_add.
27576     *
27577     * @see elm_transit_effect_add()
27578     *
27579     * @param transit Transit object.
27580     * @param from_dx X Position variation when effect begins.
27581     * @param from_dy Y Position variation when effect begins.
27582     * @param to_dx X Position variation when effect ends.
27583     * @param to_dy Y Position variation when effect ends.
27584     * @return Translation effect context data.
27585     *
27586     * @ingroup Transit
27587     * @warning It is highly recommended just create a transit with this effect when
27588     * the window that the objects of the transit belongs has already been created.
27589     * This is because this effect needs the geometry information about the objects,
27590     * and if the window was not created yet, it can get a wrong information.
27591     */
27592    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);
27593
27594    /**
27595     * Add the Zoom Effect to Elm_Transit.
27596     *
27597     * @note This API is one of the facades. It creates zoom effect context
27598     * and add it's required APIs to elm_transit_effect_add.
27599     *
27600     * @see elm_transit_effect_add()
27601     *
27602     * @param transit Transit object.
27603     * @param from_rate Scale rate when effect begins (1 is current rate).
27604     * @param to_rate Scale rate when effect ends.
27605     * @return Zoom effect context data.
27606     *
27607     * @ingroup Transit
27608     * @warning It is highly recommended just create a transit with this effect when
27609     * the window that the objects of the transit belongs has already been created.
27610     * This is because this effect needs the geometry information about the objects,
27611     * and if the window was not created yet, it can get a wrong information.
27612     */
27613    EAPI Elm_Transit_Effect *elm_transit_effect_zoom_add(Elm_Transit *transit, float from_rate, float to_rate);
27614
27615    /**
27616     * Add the Flip Effect to Elm_Transit.
27617     *
27618     * @note This API is one of the facades. It creates flip effect context
27619     * and add it's required APIs to elm_transit_effect_add.
27620     * @note This effect is applied to each pair of objects in the order they are listed
27621     * in the transit list of objects. The first object in the pair will be the
27622     * "front" object and the second will be the "back" object.
27623     *
27624     * @see elm_transit_effect_add()
27625     *
27626     * @param transit Transit object.
27627     * @param axis Flipping Axis(X or Y).
27628     * @param cw Flipping Direction. EINA_TRUE is clock-wise.
27629     * @return Flip effect context data.
27630     *
27631     * @ingroup Transit
27632     * @warning It is highly recommended just create a transit with this effect when
27633     * the window that the objects of the transit belongs has already been created.
27634     * This is because this effect needs the geometry information about the objects,
27635     * and if the window was not created yet, it can get a wrong information.
27636     */
27637    EAPI Elm_Transit_Effect *elm_transit_effect_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
27638
27639    /**
27640     * Add the Resizable Flip Effect to Elm_Transit.
27641     *
27642     * @note This API is one of the facades. It creates resizable flip effect context
27643     * and add it's required APIs to elm_transit_effect_add.
27644     * @note This effect is applied to each pair of objects in the order they are listed
27645     * in the transit list of objects. The first object in the pair will be the
27646     * "front" object and the second will be the "back" object.
27647     *
27648     * @see elm_transit_effect_add()
27649     *
27650     * @param transit Transit object.
27651     * @param axis Flipping Axis(X or Y).
27652     * @param cw Flipping Direction. EINA_TRUE is clock-wise.
27653     * @return Resizable flip effect context data.
27654     *
27655     * @ingroup Transit
27656     * @warning It is highly recommended just create a transit with this effect when
27657     * the window that the objects of the transit belongs has already been created.
27658     * This is because this effect needs the geometry information about the objects,
27659     * and if the window was not created yet, it can get a wrong information.
27660     */
27661    EAPI Elm_Transit_Effect *elm_transit_effect_resizable_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
27662
27663    /**
27664     * Add the Wipe Effect to Elm_Transit.
27665     *
27666     * @note This API is one of the facades. It creates wipe effect context
27667     * and add it's required APIs to elm_transit_effect_add.
27668     *
27669     * @see elm_transit_effect_add()
27670     *
27671     * @param transit Transit object.
27672     * @param type Wipe type. Hide or show.
27673     * @param dir Wipe Direction.
27674     * @return Wipe effect context data.
27675     *
27676     * @ingroup Transit
27677     * @warning It is highly recommended just create a transit with this effect when
27678     * the window that the objects of the transit belongs has already been created.
27679     * This is because this effect needs the geometry information about the objects,
27680     * and if the window was not created yet, it can get a wrong information.
27681     */
27682    EAPI Elm_Transit_Effect *elm_transit_effect_wipe_add(Elm_Transit *transit, Elm_Transit_Effect_Wipe_Type type, Elm_Transit_Effect_Wipe_Dir dir);
27683
27684    /**
27685     * Add the Color Effect to Elm_Transit.
27686     *
27687     * @note This API is one of the facades. It creates color effect context
27688     * and add it's required APIs to elm_transit_effect_add.
27689     *
27690     * @see elm_transit_effect_add()
27691     *
27692     * @param transit        Transit object.
27693     * @param  from_r        RGB R when effect begins.
27694     * @param  from_g        RGB G when effect begins.
27695     * @param  from_b        RGB B when effect begins.
27696     * @param  from_a        RGB A when effect begins.
27697     * @param  to_r          RGB R when effect ends.
27698     * @param  to_g          RGB G when effect ends.
27699     * @param  to_b          RGB B when effect ends.
27700     * @param  to_a          RGB A when effect ends.
27701     * @return               Color effect context data.
27702     *
27703     * @ingroup Transit
27704     */
27705    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);
27706
27707    /**
27708     * Add the Fade Effect to Elm_Transit.
27709     *
27710     * @note This API is one of the facades. It creates fade effect context
27711     * and add it's required APIs to elm_transit_effect_add.
27712     * @note This effect is applied to each pair of objects in the order they are listed
27713     * in the transit list of objects. The first object in the pair will be the
27714     * "before" object and the second will be the "after" object.
27715     *
27716     * @see elm_transit_effect_add()
27717     *
27718     * @param transit Transit object.
27719     * @return Fade effect context data.
27720     *
27721     * @ingroup Transit
27722     * @warning It is highly recommended just create a transit with this effect when
27723     * the window that the objects of the transit belongs has already been created.
27724     * This is because this effect needs the color information about the objects,
27725     * and if the window was not created yet, it can get a wrong information.
27726     */
27727    EAPI Elm_Transit_Effect *elm_transit_effect_fade_add(Elm_Transit *transit);
27728
27729    /**
27730     * Add the Blend Effect to Elm_Transit.
27731     *
27732     * @note This API is one of the facades. It creates blend effect context
27733     * and add it's required APIs to elm_transit_effect_add.
27734     * @note This effect is applied to each pair of objects in the order they are listed
27735     * in the transit list of objects. The first object in the pair will be the
27736     * "before" object and the second will be the "after" object.
27737     *
27738     * @see elm_transit_effect_add()
27739     *
27740     * @param transit Transit object.
27741     * @return Blend effect context data.
27742     *
27743     * @ingroup Transit
27744     * @warning It is highly recommended just create a transit with this effect when
27745     * the window that the objects of the transit belongs has already been created.
27746     * This is because this effect needs the color information about the objects,
27747     * and if the window was not created yet, it can get a wrong information.
27748     */
27749    EAPI Elm_Transit_Effect *elm_transit_effect_blend_add(Elm_Transit *transit);
27750
27751    /**
27752     * Add the Rotation Effect to Elm_Transit.
27753     *
27754     * @note This API is one of the facades. It creates rotation effect context
27755     * and add it's required APIs to elm_transit_effect_add.
27756     *
27757     * @see elm_transit_effect_add()
27758     *
27759     * @param transit Transit object.
27760     * @param from_degree Degree when effect begins.
27761     * @param to_degree Degree when effect is ends.
27762     * @return Rotation effect context data.
27763     *
27764     * @ingroup Transit
27765     * @warning It is highly recommended just create a transit with this effect when
27766     * the window that the objects of the transit belongs has already been created.
27767     * This is because this effect needs the geometry information about the objects,
27768     * and if the window was not created yet, it can get a wrong information.
27769     */
27770    EAPI Elm_Transit_Effect *elm_transit_effect_rotation_add(Elm_Transit *transit, float from_degree, float to_degree);
27771
27772    /**
27773     * Add the ImageAnimation Effect to Elm_Transit.
27774     *
27775     * @note This API is one of the facades. It creates image animation effect context
27776     * and add it's required APIs to elm_transit_effect_add.
27777     * The @p images parameter is a list images paths. This list and
27778     * its contents will be deleted at the end of the effect by
27779     * elm_transit_effect_image_animation_context_free() function.
27780     *
27781     * Example:
27782     * @code
27783     * char buf[PATH_MAX];
27784     * Eina_List *images = NULL;
27785     * Elm_Transit *transi = elm_transit_add();
27786     *
27787     * snprintf(buf, sizeof(buf), "%s/images/icon_11.png", PACKAGE_DATA_DIR);
27788     * images = eina_list_append(images, eina_stringshare_add(buf));
27789     *
27790     * snprintf(buf, sizeof(buf), "%s/images/logo_small.png", PACKAGE_DATA_DIR);
27791     * images = eina_list_append(images, eina_stringshare_add(buf));
27792     * elm_transit_effect_image_animation_add(transi, images);
27793     *
27794     * @endcode
27795     *
27796     * @see elm_transit_effect_add()
27797     *
27798     * @param transit Transit object.
27799     * @param images Eina_List of images file paths. This list and
27800     * its contents will be deleted at the end of the effect by
27801     * elm_transit_effect_image_animation_context_free() function.
27802     * @return Image Animation effect context data.
27803     *
27804     * @ingroup Transit
27805     */
27806    EAPI Elm_Transit_Effect *elm_transit_effect_image_animation_add(Elm_Transit *transit, Eina_List *images);
27807    /**
27808     * @}
27809     */
27810
27811    /* Store */
27812    typedef struct _Elm_Store                      Elm_Store;
27813    typedef struct _Elm_Store_DBsystem             Elm_Store_DBsystem;
27814    typedef struct _Elm_Store_Filesystem           Elm_Store_Filesystem;
27815    typedef struct _Elm_Store_Item                 Elm_Store_Item;
27816    typedef struct _Elm_Store_Item_DBsystem        Elm_Store_Item_DBsystem;
27817    typedef struct _Elm_Store_Item_Filesystem      Elm_Store_Item_Filesystem;
27818    typedef struct _Elm_Store_Item_Info            Elm_Store_Item_Info;
27819    typedef struct _Elm_Store_Item_Info_Filesystem Elm_Store_Item_Info_Filesystem;
27820    typedef struct _Elm_Store_Item_Mapping         Elm_Store_Item_Mapping;
27821    typedef struct _Elm_Store_Item_Mapping_Empty   Elm_Store_Item_Mapping_Empty;
27822    typedef struct _Elm_Store_Item_Mapping_Icon    Elm_Store_Item_Mapping_Icon;
27823    typedef struct _Elm_Store_Item_Mapping_Photo   Elm_Store_Item_Mapping_Photo;
27824    typedef struct _Elm_Store_Item_Mapping_Custom  Elm_Store_Item_Mapping_Custom;
27825
27826    typedef Eina_Bool (*Elm_Store_Item_List_Cb) (void *data, Elm_Store_Item_Info *info);
27827    typedef void      (*Elm_Store_Item_Fetch_Cb) (void *data, Elm_Store_Item *sti, Elm_Store_Item_Info *info);
27828    typedef void      (*Elm_Store_Item_Unfetch_Cb) (void *data, Elm_Store_Item *sti, Elm_Store_Item_Info *info);
27829    typedef void      (*Elm_Store_Item_Select_Cb) (void *data, Elm_Store_Item *sti);
27830    typedef int       (*Elm_Store_Item_Sort_Cb) (void *data, Elm_Store_Item_Info *info1, Elm_Store_Item_Info *info2);
27831    typedef void      (*Elm_Store_Item_Free_Cb) (void *data, Elm_Store_Item_Info *info);
27832    typedef void     *(*Elm_Store_Item_Mapping_Cb) (void *data, Elm_Store_Item *sti, const char *part);
27833
27834    typedef enum
27835      {
27836         ELM_STORE_ITEM_MAPPING_NONE = 0,
27837         ELM_STORE_ITEM_MAPPING_LABEL, // const char * -> label
27838         ELM_STORE_ITEM_MAPPING_STATE, // Eina_Bool -> state
27839         ELM_STORE_ITEM_MAPPING_ICON, // char * -> icon path
27840         ELM_STORE_ITEM_MAPPING_PHOTO, // char * -> photo path
27841         ELM_STORE_ITEM_MAPPING_CUSTOM, // item->custom(it->data, it, part) -> void * (-> any)
27842         // can add more here as needed by common apps
27843         ELM_STORE_ITEM_MAPPING_LAST
27844      } Elm_Store_Item_Mapping_Type;
27845
27846    struct _Elm_Store_Item_Mapping_Icon
27847      {
27848         // FIXME: allow edje file icons
27849         int                   w, h;
27850         Elm_Icon_Lookup_Order lookup_order;
27851         Eina_Bool             standard_name : 1;
27852         Eina_Bool             no_scale : 1;
27853         Eina_Bool             smooth : 1;
27854         Eina_Bool             scale_up : 1;
27855         Eina_Bool             scale_down : 1;
27856      };
27857
27858    struct _Elm_Store_Item_Mapping_Empty
27859      {
27860         Eina_Bool             dummy;
27861      };
27862
27863    struct _Elm_Store_Item_Mapping_Photo
27864      {
27865         int                   size;
27866      };
27867
27868    struct _Elm_Store_Item_Mapping_Custom
27869      {
27870         Elm_Store_Item_Mapping_Cb func;
27871      };
27872
27873    struct _Elm_Store_Item_Mapping
27874      {
27875         Elm_Store_Item_Mapping_Type     type;
27876         const char                     *part;
27877         int                             offset;
27878         union
27879           {
27880              Elm_Store_Item_Mapping_Empty  empty;
27881              Elm_Store_Item_Mapping_Icon   icon;
27882              Elm_Store_Item_Mapping_Photo  photo;
27883              Elm_Store_Item_Mapping_Custom custom;
27884              // add more types here
27885           } details;
27886      };
27887
27888    struct _Elm_Store_Item_Info
27889      {
27890         int                           index;
27891         int                           item_type;
27892         int                           group_index;
27893         Eina_Bool                     rec_item;
27894         int                           pre_group_index;
27895
27896         Elm_Genlist_Item_Class       *item_class;
27897         const Elm_Store_Item_Mapping *mapping;
27898         void                         *data;
27899         char                         *sort_id;
27900      };
27901
27902    struct _Elm_Store_Item_Info_Filesystem
27903      {
27904         Elm_Store_Item_Info  base;
27905         char                *path;
27906      };
27907
27908 #define ELM_STORE_ITEM_MAPPING_END { ELM_STORE_ITEM_MAPPING_NONE, NULL, 0, { .empty = { EINA_TRUE } } }
27909 #define ELM_STORE_ITEM_MAPPING_OFFSET(st, it) offsetof(st, it)
27910
27911    /**
27912     * dbsystem Store object
27913     *
27914     * @addtogroup DBStore
27915     * @{
27916     *
27917     * @return The new object or NULL if it cannot be created
27918     */
27919    EAPI Elm_Store              *elm_store_dbsystem_new(void);
27920    /**
27921     * Sets the item count of a store
27922     *
27923     * @param st The store object
27924     * @param count The item count of an store
27925     */
27926    EAPI void                    elm_store_item_count_set(Elm_Store *st, int count) EINA_ARG_NONNULL(1);
27927    /**
27928     * Set the select func that select the state of a list item whether true or false
27929     *
27930     * @param st The store object
27931     * @param func The select cb function of an store
27932     * @param data The new data pointer to set
27933     */
27934    EAPI void                    elm_store_item_select_func_set(Elm_Store *st, Elm_Store_Item_Select_Cb func, const void *data) EINA_ARG_NONNULL(1);
27935    /**
27936     * Sets the sort func that sort the item with a next in the list
27937     *
27938     * @param st The store object
27939     * @param func The sort cb function of an store
27940     * @param data The new data pointer to set
27941     */
27942    EAPI void                    elm_store_item_sort_func_set(Elm_Store *st, Elm_Store_Item_Sort_Cb func, const void *data) EINA_ARG_NONNULL(1);
27943    /**
27944     * Set the store item free func
27945     *
27946     * @param st The store object
27947     * @param func The free cb function of an store
27948     * @param data The new data pointer to set
27949     */
27950    EAPI void                    elm_store_item_free_func_set(Elm_Store *st, Elm_Store_Item_Free_Cb func, const void *data) EINA_ARG_NONNULL(1);
27951    /**
27952     * Get the item index that included header items
27953     *
27954     * @param sti The store item object
27955     * @return The item index in genlist
27956     */
27957    EAPI int                     elm_store_item_data_index_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27958    /**
27959     * Get the DB pointer of an item
27960     *
27961     * @param sti The store item object
27962     * @return The DB pointer of item
27963     */
27964    EAPI void                   *elm_store_dbsystem_db_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27965    /**
27966     * Set the DB pointer of an item
27967     *
27968     * @param sti The store item object
27969     * @parm p_db The DB pointer of item
27970     */
27971    EAPI void                    elm_store_dbsystem_db_set(Elm_Store *store, void *pDB) EINA_ARG_NONNULL(1);
27972    /**
27973     */
27974    EAPI int                     elm_store_item_index_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27975    /**
27976     * Append the item to the genlist
27977     *
27978     * @param st The store object
27979     * @param info The store item info dbsystem object
27980     * @return The item of store
27981     */
27982    EAPI Elm_Store_Item         *elm_store_item_add(Elm_Store *st, Elm_Store_Item_Info *info) EINA_ARG_NONNULL(1);
27983    /**
27984     * Realize the visible items to the screen
27985     *
27986     * @param st The store object
27987     */
27988    EAPI void                    elm_store_item_update(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27989    /**
27990     * Realize the item to the screen
27991     *
27992     * @param sti The store item object
27993     */
27994    EAPI void                    elm_store_visible_items_update(Elm_Store *st) EINA_ARG_NONNULL(1);
27995    /**
27996     * Delete the item of genlist
27997     *
27998     * @param sti The store item object
27999     */
28000    EAPI void                    elm_store_item_del(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
28001    EAPI void                    elm_store_free(Elm_Store *st);
28002    EAPI Elm_Store              *elm_store_filesystem_new(void);
28003    EAPI void                    elm_store_filesystem_directory_set(Elm_Store *st, const char *dir) EINA_ARG_NONNULL(1);
28004    EAPI const char             *elm_store_filesystem_directory_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
28005    EAPI const char             *elm_store_item_filesystem_path_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
28006
28007    EAPI void                    elm_store_target_genlist_set(Elm_Store *st, Evas_Object *obj) EINA_ARG_NONNULL(1);
28008
28009    EAPI void                    elm_store_cache_set(Elm_Store *st, int max) EINA_ARG_NONNULL(1);
28010    EAPI int                     elm_store_cache_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
28011    EAPI void                    elm_store_list_func_set(Elm_Store *st, Elm_Store_Item_List_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
28012    EAPI void                    elm_store_fetch_func_set(Elm_Store *st, Elm_Store_Item_Fetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
28013    EAPI void                    elm_store_fetch_thread_set(Elm_Store *st, Eina_Bool use_thread) EINA_ARG_NONNULL(1);
28014    EAPI Eina_Bool               elm_store_fetch_thread_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
28015
28016    EAPI void                    elm_store_unfetch_func_set(Elm_Store *st, Elm_Store_Item_Unfetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
28017    EAPI void                    elm_store_sorted_set(Elm_Store *st, Eina_Bool sorted) EINA_ARG_NONNULL(1);
28018    EAPI Eina_Bool               elm_store_sorted_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
28019    EAPI void                    elm_store_item_data_set(Elm_Store_Item *sti, void *data) EINA_ARG_NONNULL(1);
28020    EAPI void                   *elm_store_item_data_get(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
28021    EAPI const Elm_Store        *elm_store_item_store_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
28022    EAPI const Elm_Genlist_Item *elm_store_item_genlist_item_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
28023    /**
28024     * @}
28025     */
28026
28027    /**
28028     * @defgroup SegmentControl SegmentControl
28029     * @ingroup Elementary
28030     *
28031     * @image html img/widget/segment_control/preview-00.png
28032     * @image latex img/widget/segment_control/preview-00.eps width=\textwidth
28033     *
28034     * @image html img/segment_control.png
28035     * @image latex img/segment_control.eps width=\textwidth
28036     *
28037     * Segment control widget is a horizontal control made of multiple segment
28038     * items, each segment item functioning similar to discrete two state button.
28039     * A segment control groups the items together and provides compact
28040     * single button with multiple equal size segments.
28041     *
28042     * Segment item size is determined by base widget
28043     * size and the number of items added.
28044     * Only one segment item can be at selected state. A segment item can display
28045     * combination of Text and any Evas_Object like Images or other widget.
28046     *
28047     * Smart callbacks one can listen to:
28048     * - "changed" - When the user clicks on a segment item which is not
28049     *   previously selected and get selected. The event_info parameter is the
28050     *   segment item pointer.
28051     *
28052     * Available styles for it:
28053     * - @c "default"
28054     *
28055     * Here is an example on its usage:
28056     * @li @ref segment_control_example
28057     */
28058
28059    /**
28060     * @addtogroup SegmentControl
28061     * @{
28062     */
28063
28064    typedef struct _Elm_Segment_Item Elm_Segment_Item; /**< Item handle for a segment control widget. */
28065
28066    /**
28067     * Add a new segment control widget to the given parent Elementary
28068     * (container) object.
28069     *
28070     * @param parent The parent object.
28071     * @return a new segment control widget handle or @c NULL, on errors.
28072     *
28073     * This function inserts a new segment control widget on the canvas.
28074     *
28075     * @ingroup SegmentControl
28076     */
28077    EAPI Evas_Object      *elm_segment_control_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
28078
28079    /**
28080     * Append a new item to the segment control object.
28081     *
28082     * @param obj The segment control object.
28083     * @param icon The icon object to use for the left side of the item. An
28084     * icon can be any Evas object, but usually it is an icon created
28085     * with elm_icon_add().
28086     * @param label The label of the item.
28087     *        Note that, NULL is different from empty string "".
28088     * @return The created item or @c NULL upon failure.
28089     *
28090     * A new item will be created and appended to the segment control, i.e., will
28091     * be set as @b last item.
28092     *
28093     * If it should be inserted at another position,
28094     * elm_segment_control_item_insert_at() should be used instead.
28095     *
28096     * Items created with this function can be deleted with function
28097     * elm_segment_control_item_del() or elm_segment_control_item_del_at().
28098     *
28099     * @note @p label set to @c NULL is different from empty string "".
28100     * If an item
28101     * only has icon, it will be displayed bigger and centered. If it has
28102     * icon and label, even that an empty string, icon will be smaller and
28103     * positioned at left.
28104     *
28105     * Simple example:
28106     * @code
28107     * sc = elm_segment_control_add(win);
28108     * ic = elm_icon_add(win);
28109     * elm_icon_file_set(ic, "path/to/image", NULL);
28110     * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
28111     * elm_segment_control_item_add(sc, ic, "label");
28112     * evas_object_show(sc);
28113     * @endcode
28114     *
28115     * @see elm_segment_control_item_insert_at()
28116     * @see elm_segment_control_item_del()
28117     *
28118     * @ingroup SegmentControl
28119     */
28120    EAPI Elm_Segment_Item *elm_segment_control_item_add(Evas_Object *obj, Evas_Object *icon, const char *label) EINA_ARG_NONNULL(1);
28121
28122    /**
28123     * Insert a new item to the segment control object at specified position.
28124     *
28125     * @param obj The segment control object.
28126     * @param icon The icon object to use for the left side of the item. An
28127     * icon can be any Evas object, but usually it is an icon created
28128     * with elm_icon_add().
28129     * @param label The label of the item.
28130     * @param index Item position. Value should be between 0 and items count.
28131     * @return The created item or @c NULL upon failure.
28132
28133     * Index values must be between @c 0, when item will be prepended to
28134     * segment control, and items count, that can be get with
28135     * elm_segment_control_item_count_get(), case when item will be appended
28136     * to segment control, just like elm_segment_control_item_add().
28137     *
28138     * Items created with this function can be deleted with function
28139     * elm_segment_control_item_del() or elm_segment_control_item_del_at().
28140     *
28141     * @note @p label set to @c NULL is different from empty string "".
28142     * If an item
28143     * only has icon, it will be displayed bigger and centered. If it has
28144     * icon and label, even that an empty string, icon will be smaller and
28145     * positioned at left.
28146     *
28147     * @see elm_segment_control_item_add()
28148     * @see elm_segment_control_item_count_get()
28149     * @see elm_segment_control_item_del()
28150     *
28151     * @ingroup SegmentControl
28152     */
28153    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);
28154
28155    /**
28156     * Remove a segment control item from its parent, deleting it.
28157     *
28158     * @param it The item to be removed.
28159     *
28160     * Items can be added with elm_segment_control_item_add() or
28161     * elm_segment_control_item_insert_at().
28162     *
28163     * @ingroup SegmentControl
28164     */
28165    EAPI void              elm_segment_control_item_del(Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
28166
28167    /**
28168     * Remove a segment control item at given index from its parent,
28169     * deleting it.
28170     *
28171     * @param obj The segment control object.
28172     * @param index The position of the segment control item to be deleted.
28173     *
28174     * Items can be added with elm_segment_control_item_add() or
28175     * elm_segment_control_item_insert_at().
28176     *
28177     * @ingroup SegmentControl
28178     */
28179    EAPI void              elm_segment_control_item_del_at(Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
28180
28181    /**
28182     * Get the Segment items count from segment control.
28183     *
28184     * @param obj The segment control object.
28185     * @return Segment items count.
28186     *
28187     * It will just return the number of items added to segment control @p obj.
28188     *
28189     * @ingroup SegmentControl
28190     */
28191    EAPI int               elm_segment_control_item_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28192
28193    /**
28194     * Get the item placed at specified index.
28195     *
28196     * @param obj The segment control object.
28197     * @param index The index of the segment item.
28198     * @return The segment control item or @c NULL on failure.
28199     *
28200     * Index is the position of an item in segment control widget. Its
28201     * range is from @c 0 to <tt> count - 1 </tt>.
28202     * Count is the number of items, that can be get with
28203     * elm_segment_control_item_count_get().
28204     *
28205     * @ingroup SegmentControl
28206     */
28207    EAPI Elm_Segment_Item *elm_segment_control_item_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
28208
28209    /**
28210     * Get the label of item.
28211     *
28212     * @param obj The segment control object.
28213     * @param index The index of the segment item.
28214     * @return The label of the item at @p index.
28215     *
28216     * The return value is a pointer to the label associated to the item when
28217     * it was created, with function elm_segment_control_item_add(), or later
28218     * with function elm_segment_control_item_label_set. If no label
28219     * was passed as argument, it will return @c NULL.
28220     *
28221     * @see elm_segment_control_item_label_set() for more details.
28222     * @see elm_segment_control_item_add()
28223     *
28224     * @ingroup SegmentControl
28225     */
28226    EAPI const char       *elm_segment_control_item_label_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
28227
28228    /**
28229     * Set the label of item.
28230     *
28231     * @param it The item of segment control.
28232     * @param text The label of item.
28233     *
28234     * The label to be displayed by the item.
28235     * Label will be at right of the icon (if set).
28236     *
28237     * If a label was passed as argument on item creation, with function
28238     * elm_control_segment_item_add(), it will be already
28239     * displayed by the item.
28240     *
28241     * @see elm_segment_control_item_label_get()
28242     * @see elm_segment_control_item_add()
28243     *
28244     * @ingroup SegmentControl
28245     */
28246    EAPI void              elm_segment_control_item_label_set(Elm_Segment_Item* it, const char* label) EINA_ARG_NONNULL(1);
28247
28248    /**
28249     * Get the icon associated to the item.
28250     *
28251     * @param obj The segment control object.
28252     * @param index The index of the segment item.
28253     * @return The left side icon associated to the item at @p index.
28254     *
28255     * The return value is a pointer to the icon associated to the item when
28256     * it was created, with function elm_segment_control_item_add(), or later
28257     * with function elm_segment_control_item_icon_set(). If no icon
28258     * was passed as argument, it will return @c NULL.
28259     *
28260     * @see elm_segment_control_item_add()
28261     * @see elm_segment_control_item_icon_set()
28262     *
28263     * @ingroup SegmentControl
28264     */
28265    EAPI Evas_Object      *elm_segment_control_item_icon_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
28266
28267    /**
28268     * Set the icon associated to the item.
28269     *
28270     * @param it The segment control item.
28271     * @param icon The icon object to associate with @p it.
28272     *
28273     * The icon object to use at left side of the item. An
28274     * icon can be any Evas object, but usually it is an icon created
28275     * with elm_icon_add().
28276     *
28277     * Once the icon object is set, a previously set one will be deleted.
28278     * @warning Setting the same icon for two items will cause the icon to
28279     * dissapear from the first item.
28280     *
28281     * If an icon was passed as argument on item creation, with function
28282     * elm_segment_control_item_add(), it will be already
28283     * associated to the item.
28284     *
28285     * @see elm_segment_control_item_add()
28286     * @see elm_segment_control_item_icon_get()
28287     *
28288     * @ingroup SegmentControl
28289     */
28290    EAPI void              elm_segment_control_item_icon_set(Elm_Segment_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
28291
28292    /**
28293     * Get the index of an item.
28294     *
28295     * @param it The segment control item.
28296     * @return The position of item in segment control widget.
28297     *
28298     * Index is the position of an item in segment control widget. Its
28299     * range is from @c 0 to <tt> count - 1 </tt>.
28300     * Count is the number of items, that can be get with
28301     * elm_segment_control_item_count_get().
28302     *
28303     * @ingroup SegmentControl
28304     */
28305    EAPI int               elm_segment_control_item_index_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
28306
28307    /**
28308     * Get the base object of the item.
28309     *
28310     * @param it The segment control item.
28311     * @return The base object associated with @p it.
28312     *
28313     * Base object is the @c Evas_Object that represents that item.
28314     *
28315     * @ingroup SegmentControl
28316     */
28317    EAPI Evas_Object      *elm_segment_control_item_object_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
28318
28319    /**
28320     * Get the selected item.
28321     *
28322     * @param obj The segment control object.
28323     * @return The selected item or @c NULL if none of segment items is
28324     * selected.
28325     *
28326     * The selected item can be unselected with function
28327     * elm_segment_control_item_selected_set().
28328     *
28329     * The selected item always will be highlighted on segment control.
28330     *
28331     * @ingroup SegmentControl
28332     */
28333    EAPI Elm_Segment_Item *elm_segment_control_item_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28334
28335    /**
28336     * Set the selected state of an item.
28337     *
28338     * @param it The segment control item
28339     * @param select The selected state
28340     *
28341     * This sets the selected state of the given item @p it.
28342     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
28343     *
28344     * If a new item is selected the previosly selected will be unselected.
28345     * Previoulsy selected item can be get with function
28346     * elm_segment_control_item_selected_get().
28347     *
28348     * The selected item always will be highlighted on segment control.
28349     *
28350     * @see elm_segment_control_item_selected_get()
28351     *
28352     * @ingroup SegmentControl
28353     */
28354    EAPI void              elm_segment_control_item_selected_set(Elm_Segment_Item *it, Eina_Bool select) EINA_ARG_NONNULL(1);
28355
28356    /**
28357     * @}
28358     */
28359
28360    /**
28361     * @defgroup Grid Grid
28362     *
28363     * The grid is a grid layout widget that lays out a series of children as a
28364     * fixed "grid" of widgets using a given percentage of the grid width and
28365     * height each using the child object.
28366     *
28367     * The Grid uses a "Virtual resolution" that is stretched to fill the grid
28368     * widgets size itself. The default is 100 x 100, so that means the
28369     * position and sizes of children will effectively be percentages (0 to 100)
28370     * of the width or height of the grid widget
28371     *
28372     * @{
28373     */
28374
28375    /**
28376     * Add a new grid to the parent
28377     *
28378     * @param parent The parent object
28379     * @return The new object or NULL if it cannot be created
28380     *
28381     * @ingroup Grid
28382     */
28383    EAPI Evas_Object *elm_grid_add(Evas_Object *parent);
28384
28385    /**
28386     * Set the virtual size of the grid
28387     *
28388     * @param obj The grid object
28389     * @param w The virtual width of the grid
28390     * @param h The virtual height of the grid
28391     *
28392     * @ingroup Grid
28393     */
28394    EAPI void         elm_grid_size_set(Evas_Object *obj, int w, int h);
28395
28396    /**
28397     * Get the virtual size of the grid
28398     *
28399     * @param obj The grid object
28400     * @param w Pointer to integer to store the virtual width of the grid
28401     * @param h Pointer to integer to store the virtual height of the grid
28402     *
28403     * @ingroup Grid
28404     */
28405    EAPI void         elm_grid_size_get(Evas_Object *obj, int *w, int *h);
28406
28407    /**
28408     * Pack child at given position and size
28409     *
28410     * @param obj The grid object
28411     * @param subobj The child to pack
28412     * @param x The virtual x coord at which to pack it
28413     * @param y The virtual y coord at which to pack it
28414     * @param w The virtual width at which to pack it
28415     * @param h The virtual height at which to pack it
28416     *
28417     * @ingroup Grid
28418     */
28419    EAPI void         elm_grid_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h);
28420
28421    /**
28422     * Unpack a child from a grid object
28423     *
28424     * @param obj The grid object
28425     * @param subobj The child to unpack
28426     *
28427     * @ingroup Grid
28428     */
28429    EAPI void         elm_grid_unpack(Evas_Object *obj, Evas_Object *subobj);
28430
28431    /**
28432     * Faster way to remove all child objects from a grid object.
28433     *
28434     * @param obj The grid object
28435     * @param clear If true, it will delete just removed children
28436     *
28437     * @ingroup Grid
28438     */
28439    EAPI void         elm_grid_clear(Evas_Object *obj, Eina_Bool clear);
28440
28441    /**
28442     * Set packing of an existing child at to position and size
28443     *
28444     * @param subobj The child to set packing of
28445     * @param x The virtual x coord at which to pack it
28446     * @param y The virtual y coord at which to pack it
28447     * @param w The virtual width at which to pack it
28448     * @param h The virtual height at which to pack it
28449     *
28450     * @ingroup Grid
28451     */
28452    EAPI void         elm_grid_pack_set(Evas_Object *subobj, int x, int y, int w, int h);
28453
28454    /**
28455     * get packing of a child
28456     *
28457     * @param subobj The child to query
28458     * @param x Pointer to integer to store the virtual x coord
28459     * @param y Pointer to integer to store the virtual y coord
28460     * @param w Pointer to integer to store the virtual width
28461     * @param h Pointer to integer to store the virtual height
28462     *
28463     * @ingroup Grid
28464     */
28465    EAPI void         elm_grid_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h);
28466
28467    /**
28468     * @}
28469     */
28470
28471    EAPI Evas_Object *elm_factory_add(Evas_Object *parent);
28472    EINA_DEPRECATED EAPI void         elm_factory_content_set(Evas_Object *obj, Evas_Object *content);
28473    EINA_DEPRECATED EAPI Evas_Object *elm_factory_content_get(const Evas_Object *obj);
28474    EAPI void         elm_factory_maxmin_mode_set(Evas_Object *obj, Eina_Bool enabled);
28475    EAPI Eina_Bool    elm_factory_maxmin_mode_get(const Evas_Object *obj);
28476    EAPI void         elm_factory_maxmin_reset_set(Evas_Object *obj);
28477
28478    /**
28479     * @defgroup Video Video
28480     *
28481     * @addtogroup Video
28482     * @{
28483     *
28484     * Elementary comes with two object that help design application that need
28485     * to display video. The main one, Elm_Video, display a video by using Emotion.
28486     * It does embedded the video inside an Edje object, so you can do some
28487     * animation depending on the video state change. It does also implement a
28488     * ressource management policy to remove this burden from the application writer.
28489     *
28490     * The second one, Elm_Player is a video player that need to be linked with and Elm_Video.
28491     * It take care of updating its content according to Emotion event and provide a
28492     * way to theme itself. It also does automatically raise the priority of the
28493     * linked Elm_Video so it will use the video decoder if available. It also does
28494     * activate the remember function on the linked Elm_Video object.
28495     *
28496     * Signals that you can add callback for are :
28497     *
28498     * "forward,clicked" - the user clicked the forward button.
28499     * "info,clicked" - the user clicked the info button.
28500     * "next,clicked" - the user clicked the next button.
28501     * "pause,clicked" - the user clicked the pause button.
28502     * "play,clicked" - the user clicked the play button.
28503     * "prev,clicked" - the user clicked the prev button.
28504     * "rewind,clicked" - the user clicked the rewind button.
28505     * "stop,clicked" - the user clicked the stop button.
28506     * 
28507     * Default contents parts of the player widget that you can use for are:
28508     * @li "video" - A video of the player
28509     * 
28510     */
28511
28512    /**
28513     * @brief Add a new Elm_Player object to the given parent Elementary (container) object.
28514     *
28515     * @param parent The parent object
28516     * @return a new player widget handle or @c NULL, on errors.
28517     *
28518     * This function inserts a new player widget on the canvas.
28519     *
28520     * @see elm_object_part_content_set()
28521     *
28522     * @ingroup Video
28523     */
28524    EAPI Evas_Object *elm_player_add(Evas_Object *parent);
28525
28526    /**
28527     * @brief Link a Elm_Payer with an Elm_Video object.
28528     *
28529     * @param player the Elm_Player object.
28530     * @param video The Elm_Video object.
28531     *
28532     * This mean that action on the player widget will affect the
28533     * video object and the state of the video will be reflected in
28534     * the player itself.
28535     *
28536     * @see elm_player_add()
28537     * @see elm_video_add()
28538     * @deprecated use elm_object_part_content_set() instead
28539     *
28540     * @ingroup Video
28541     */
28542    EINA_DEPRECATED EAPI void elm_player_video_set(Evas_Object *player, Evas_Object *video);
28543
28544    /**
28545     * @brief Add a new Elm_Video object to the given parent Elementary (container) object.
28546     *
28547     * @param parent The parent object
28548     * @return a new video widget handle or @c NULL, on errors.
28549     *
28550     * This function inserts a new video widget on the canvas.
28551     *
28552     * @seeelm_video_file_set()
28553     * @see elm_video_uri_set()
28554     *
28555     * @ingroup Video
28556     */
28557    EAPI Evas_Object *elm_video_add(Evas_Object *parent);
28558
28559    /**
28560     * @brief Define the file that will be the video source.
28561     *
28562     * @param video The video object to define the file for.
28563     * @param filename The file to target.
28564     *
28565     * This function will explicitly define a filename as a source
28566     * for the video of the Elm_Video object.
28567     *
28568     * @see elm_video_uri_set()
28569     * @see elm_video_add()
28570     * @see elm_player_add()
28571     *
28572     * @ingroup Video
28573     */
28574    EAPI void elm_video_file_set(Evas_Object *video, const char *filename);
28575
28576    /**
28577     * @brief Define the uri that will be the video source.
28578     *
28579     * @param video The video object to define the file for.
28580     * @param uri The uri to target.
28581     *
28582     * This function will define an uri as a source for the video of the
28583     * Elm_Video object. URI could be remote source of video, like http:// or local source
28584     * like for example WebCam who are most of the time v4l2:// (but that depend and
28585     * you should use Emotion API to request and list the available Webcam on your system).
28586     *
28587     * @see elm_video_file_set()
28588     * @see elm_video_add()
28589     * @see elm_player_add()
28590     *
28591     * @ingroup Video
28592     */
28593    EAPI void elm_video_uri_set(Evas_Object *video, const char *uri);
28594
28595    /**
28596     * @brief Get the underlying Emotion object.
28597     *
28598     * @param video The video object to proceed the request on.
28599     * @return the underlying Emotion object.
28600     *
28601     * @ingroup Video
28602     */
28603    EAPI Evas_Object *elm_video_emotion_get(const Evas_Object *video);
28604
28605    /**
28606     * @brief Start to play the video
28607     *
28608     * @param video The video object to proceed the request on.
28609     *
28610     * Start to play the video and cancel all suspend state.
28611     *
28612     * @ingroup Video
28613     */
28614    EAPI void elm_video_play(Evas_Object *video);
28615
28616    /**
28617     * @brief Pause the video
28618     *
28619     * @param video The video object to proceed the request on.
28620     *
28621     * Pause the video and start a timer to trigger suspend mode.
28622     *
28623     * @ingroup Video
28624     */
28625    EAPI void elm_video_pause(Evas_Object *video);
28626
28627    /**
28628     * @brief Stop the video
28629     *
28630     * @param video The video object to proceed the request on.
28631     *
28632     * Stop the video and put the emotion in deep sleep mode.
28633     *
28634     * @ingroup Video
28635     */
28636    EAPI void elm_video_stop(Evas_Object *video);
28637
28638    /**
28639     * @brief Is the video actually playing.
28640     *
28641     * @param video The video object to proceed the request on.
28642     * @return EINA_TRUE if the video is actually playing.
28643     *
28644     * You should consider watching event on the object instead of polling
28645     * the object state.
28646     *
28647     * @ingroup Video
28648     */
28649    EAPI Eina_Bool elm_video_is_playing(const Evas_Object *video);
28650
28651    /**
28652     * @brief Is it possible to seek inside the video.
28653     *
28654     * @param video The video object to proceed the request on.
28655     * @return EINA_TRUE if is possible to seek inside the video.
28656     *
28657     * @ingroup Video
28658     */
28659    EAPI Eina_Bool elm_video_is_seekable(const Evas_Object *video);
28660
28661    /**
28662     * @brief Is the audio muted.
28663     *
28664     * @param video The video object to proceed the request on.
28665     * @return EINA_TRUE if the audio is muted.
28666     *
28667     * @ingroup Video
28668     */
28669    EAPI Eina_Bool elm_video_audio_mute_get(const Evas_Object *video);
28670
28671    /**
28672     * @brief Change the mute state of the Elm_Video object.
28673     *
28674     * @param video The video object to proceed the request on.
28675     * @param mute The new mute state.
28676     *
28677     * @ingroup Video
28678     */
28679    EAPI void elm_video_audio_mute_set(Evas_Object *video, Eina_Bool mute);
28680
28681    /**
28682     * @brief Get the audio level of the current video.
28683     *
28684     * @param video The video object to proceed the request on.
28685     * @return the current audio level.
28686     *
28687     * @ingroup Video
28688     */
28689    EAPI double elm_video_audio_level_get(const Evas_Object *video);
28690
28691    /**
28692     * @brief Set the audio level of anElm_Video object.
28693     *
28694     * @param video The video object to proceed the request on.
28695     * @param volume The new audio volume.
28696     *
28697     * @ingroup Video
28698     */
28699    EAPI void elm_video_audio_level_set(Evas_Object *video, double volume);
28700
28701    EAPI double elm_video_play_position_get(const Evas_Object *video);
28702    EAPI void elm_video_play_position_set(Evas_Object *video, double position);
28703    EAPI double elm_video_play_length_get(const Evas_Object *video);
28704    EAPI void elm_video_remember_position_set(Evas_Object *video, Eina_Bool remember);
28705    EAPI Eina_Bool elm_video_remember_position_get(const Evas_Object *video);
28706    EAPI const char *elm_video_title_get(const Evas_Object *video);
28707    /**
28708     * @}
28709     */
28710
28711    // FIXME: incomplete - carousel. don't use this until this comment is removed
28712    typedef struct _Elm_Carousel_Item Elm_Carousel_Item;
28713    EAPI Evas_Object       *elm_carousel_add(Evas_Object *parent);
28714    EAPI Elm_Carousel_Item *elm_carousel_item_add(Evas_Object *obj, Evas_Object *icon, const char *label, Evas_Smart_Cb func, const void *data);
28715    EAPI void               elm_carousel_item_del(Elm_Carousel_Item *item);
28716    EAPI void               elm_carousel_item_select(Elm_Carousel_Item *item);
28717    /* smart callbacks called:
28718     * "clicked" - when the user clicks on a carousel item and becomes selected
28719     */
28720
28721    /* datefield */
28722
28723    typedef enum _Elm_Datefield_ItemType
28724      {
28725         ELM_DATEFIELD_YEAR = 0,
28726         ELM_DATEFIELD_MONTH,
28727         ELM_DATEFIELD_DATE,
28728         ELM_DATEFIELD_HOUR,
28729         ELM_DATEFIELD_MINUTE,
28730         ELM_DATEFIELD_AMPM
28731      } Elm_Datefield_ItemType;
28732
28733    EAPI Evas_Object *elm_datefield_add(Evas_Object *parent);
28734    EAPI void         elm_datefield_format_set(Evas_Object *obj, const char *fmt);
28735    EAPI char        *elm_datefield_format_get(const Evas_Object *obj);
28736    EAPI void         elm_datefield_item_enabled_set(Evas_Object *obj, Elm_Datefield_ItemType itemtype, Eina_Bool enable);
28737    EAPI Eina_Bool    elm_datefield_item_enabled_get(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
28738    EAPI void         elm_datefield_item_value_set(Evas_Object *obj, Elm_Datefield_ItemType itemtype, int value);
28739    EAPI int          elm_datefield_item_value_get(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
28740    EAPI void         elm_datefield_item_min_set(Evas_Object *obj, Elm_Datefield_ItemType itemtype, int value, Eina_Bool abs_limit);
28741    EAPI int          elm_datefield_item_min_get(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
28742    EAPI Eina_Bool    elm_datefield_item_min_is_absolute(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
28743    EAPI void         elm_datefield_item_max_set(Evas_Object *obj, Elm_Datefield_ItemType itemtype, int value, Eina_Bool abs_limit);
28744    EAPI int          elm_datefield_item_max_get(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
28745    EAPI Eina_Bool    elm_datefield_item_max_is_absolute(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
28746
28747    /* smart callbacks called:
28748    * "changed" - when datefield value is changed, this signal is sent.
28749    */
28750
28751    /* popup */
28752    typedef enum _Elm_Popup_Response
28753      {
28754         ELM_POPUP_RESPONSE_NONE = -1,
28755         ELM_POPUP_RESPONSE_TIMEOUT = -2,
28756         ELM_POPUP_RESPONSE_OK = -3,
28757         ELM_POPUP_RESPONSE_CANCEL = -4,
28758         ELM_POPUP_RESPONSE_CLOSE = -5
28759      } Elm_Popup_Response;
28760
28761    typedef enum _Elm_Popup_Mode
28762      {
28763         ELM_POPUP_TYPE_NONE = 0,
28764         ELM_POPUP_TYPE_ALERT = (1 << 0)
28765      } Elm_Popup_Mode;
28766
28767    typedef enum _Elm_Popup_Orient
28768      {
28769         ELM_POPUP_ORIENT_TOP,
28770         ELM_POPUP_ORIENT_CENTER,
28771         ELM_POPUP_ORIENT_BOTTOM,
28772         ELM_POPUP_ORIENT_LEFT,
28773         ELM_POPUP_ORIENT_RIGHT,
28774         ELM_POPUP_ORIENT_TOP_LEFT,
28775         ELM_POPUP_ORIENT_TOP_RIGHT,
28776         ELM_POPUP_ORIENT_BOTTOM_LEFT,
28777         ELM_POPUP_ORIENT_BOTTOM_RIGHT
28778      } Elm_Popup_Orient;
28779
28780    /* smart callbacks called:
28781     * "response" - when ever popup is closed, this signal is sent with appropriate response id.".
28782     */
28783
28784    EAPI Evas_Object *elm_popup_add(Evas_Object *parent);
28785    EAPI void         elm_popup_desc_set(Evas_Object *obj, const char *text);
28786    EAPI const char  *elm_popup_desc_get(Evas_Object *obj);
28787    EAPI void         elm_popup_title_label_set(Evas_Object *obj, const char *text);
28788    EAPI const char  *elm_popup_title_label_get(Evas_Object *obj);
28789    EAPI void         elm_popup_title_icon_set(Evas_Object *obj, Evas_Object *icon);
28790    EAPI Evas_Object *elm_popup_title_icon_get(Evas_Object *obj);
28791    EAPI void         elm_popup_content_set(Evas_Object *obj, Evas_Object *content);
28792    EAPI Evas_Object *elm_popup_content_get(Evas_Object *obj);
28793    EAPI void         elm_popup_buttons_add(Evas_Object *obj,int no_of_buttons, const char *first_button_text,  ...);
28794    EAPI Evas_Object *elm_popup_with_buttons_add(Evas_Object *parent, const char *title, const char *desc_text,int no_of_buttons, const char *first_button_text, ... );
28795    EAPI void         elm_popup_timeout_set(Evas_Object *obj, double timeout);
28796    EAPI void         elm_popup_mode_set(Evas_Object *obj, Elm_Popup_Mode mode);
28797    EAPI void         elm_popup_response(Evas_Object *obj, int  response_id);
28798    EAPI void         elm_popup_orient_set(Evas_Object *obj, Elm_Popup_Orient orient);
28799    EAPI int          elm_popup_run(Evas_Object *obj);
28800
28801    /**
28802     * @defgroup Naviframe Naviframe
28803     * @ingroup Elementary
28804     *
28805     * @brief Naviframe is a kind of view manager for the applications.
28806     *
28807     * Naviframe provides functions to switch different pages with stack
28808     * mechanism. It means if one page(item) needs to be changed to the new one,
28809     * then naviframe would push the new page to it's internal stack. Of course,
28810     * it can be back to the previous page by popping the top page. Naviframe
28811     * provides some transition effect while the pages are switching (same as
28812     * pager).
28813     *
28814     * Since each item could keep the different styles, users could keep the
28815     * same look & feel for the pages or different styles for the items in it's
28816     * application.
28817     *
28818     * Signals that you can add callback for are:
28819     * @li "transition,finished" - When the transition is finished in changing
28820     *     the item
28821     * @li "title,clicked" - User clicked title area
28822     *
28823     * Default contents parts of the naviframe items that you can use for are:
28824     * @li "default" - A main content of the page
28825     * @li "icon" - A icon in the title area
28826     * @li "prev_btn" - A button to go to the previous page
28827     * @li "next_btn" - A button to go to the next page
28828     *
28829     * Default text parts of the naviframe items that you can use for are:
28830     * @li "default" - Title label in the title area
28831     * @li "subtitle" - Sub-title label in the title area
28832     *
28833     * @ref tutorial_naviframe gives a good overview of the usage of the API.
28834     */
28835
28836   //Available commonly
28837   #define ELM_NAVIFRAME_ITEM_CONTENT "elm.swallow.content"
28838   #define ELM_NAVIFRAME_ITEM_ICON "elm.swallow.icon"
28839   #define ELM_NAVIFRAME_ITEM_OPTIONHEADER "elm.swallow.optionheader"
28840   #define ELM_NAVIFRAME_ITEM_TITLE_LABEL "elm.text.title"
28841   #define ELM_NAVIFRAME_ITEM_PREV_BTN "elm.swallow.prev_btn"
28842   #define ELM_NAVIFRAME_ITEM_TITLE_LEFT_BTN "elm.swallow.left_btn"
28843   #define ELM_NAVIFRAME_ITEM_TITLE_RIGHT_BTN "elm.swallow.right_btn"
28844   #define ELM_NAVIFRAME_ITEM_TITLE_MORE_BTN "elm.swallow.more_btn"
28845   #define ELM_NAVIFRAME_ITEM_CONTROLBAR "elm.swallow.controlbar"
28846   #define ELM_NAVIFRAME_ITEM_SIGNAL_OPTIONHEADER_CLOSE "elm,state,optionheader,close", ""
28847   #define ELM_NAVIFRAME_ITEM_SIGNAL_OPTIONHEADER_OPEN "elm,state,optionheader,open", ""
28848   #define ELM_NAVIFRAME_ITEM_SIGNAL_OPTIONHEADER_INSTANT_CLOSE "elm,state,optionheader,instant_close", ""
28849   #define ELM_NAVIFRAME_ITEM_SIGNAL_OPTIONHEADER_INSTANT_OPEN "elm,state,optionheader,instant_open", ""
28850   #define ELM_NAVIFRAME_ITEM_SIGNAL_CONTROLBAR_CLOSE "elm,state,controlbar,close", ""
28851   #define ELM_NAVIFRAME_ITEM_SIGNAL_CONTROLBAR_OPEN "elm,state,controlbar,open", ""
28852   #define ELM_NAVIFRAME_ITEM_SIGNAL_CONTROLBAR_INSTANT_CLOSE "elm,state,controlbar,instant_close", ""
28853   #define ELM_NAVIFRAME_ITEM_SIGNAL_CONTROLBAR_INSTANT_OPEN "elm,state,controlbar,instant_open", ""
28854
28855    //Available only in a style - "2line"
28856   #define ELM_NAVIFRAME_ITEM_OPTIONHEADER2 "elm.swallow.optionheader2"
28857
28858   //Available only in a style - "segment"
28859   #define ELM_NAVIFRAME_ITEM_SEGMENT2 "elm.swallow.segment2"
28860   #define ELM_NAVIFRAME_ITEM_SEGMENT3 "elm.swallow.segment3"
28861
28862    /**
28863     * @addtogroup Naviframe
28864     * @{
28865     */
28866
28867    /**
28868     * @brief Add a new Naviframe object to the parent.
28869     *
28870     * @param parent Parent object
28871     * @return New object or @c NULL, if it cannot be created
28872     *
28873     * @ingroup Naviframe
28874     */
28875    EAPI Evas_Object        *elm_naviframe_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
28876    /**
28877     * @brief Push a new item to the top of the naviframe stack (and show it).
28878     *
28879     * @param obj The naviframe object
28880     * @param title_label The label in the title area. The name of the title
28881     *        label part is "elm.text.title"
28882     * @param prev_btn The button to go to the previous item. If it is NULL,
28883     *        then naviframe will create a back button automatically. The name of
28884     *        the prev_btn part is "elm.swallow.prev_btn"
28885     * @param next_btn The button to go to the next item. Or It could be just an
28886     *        extra function button. The name of the next_btn part is
28887     *        "elm.swallow.next_btn"
28888     * @param content The main content object. The name of content part is
28889     *        "elm.swallow.content"
28890     * @param item_style The current item style name. @c NULL would be default.
28891     * @return The created item or @c NULL upon failure.
28892     *
28893     * The item pushed becomes one page of the naviframe, this item will be
28894     * deleted when it is popped.
28895     *
28896     * @see also elm_naviframe_item_style_set()
28897     * @see also elm_naviframe_item_insert_before()
28898     * @see also elm_naviframe_item_insert_after()
28899     *
28900     * The following styles are available for this item:
28901     * @li @c "default"
28902     *
28903     * @ingroup Naviframe
28904     */
28905    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);
28906     /**
28907     * @brief Insert a new item into the naviframe before item @p before.
28908     *
28909     * @param before The naviframe item to insert before.
28910     * @param title_label The label in the title area. The name of the title
28911     *        label part is "elm.text.title"
28912     * @param prev_btn The button to go to the previous item. If it is NULL,
28913     *        then naviframe will create a back button automatically. The name of
28914     *        the prev_btn part is "elm.swallow.prev_btn"
28915     * @param next_btn The button to go to the next item. Or It could be just an
28916     *        extra function button. The name of the next_btn part is
28917     *        "elm.swallow.next_btn"
28918     * @param content The main content object. The name of content part is
28919     *        "elm.swallow.content"
28920     * @param item_style The current item style name. @c NULL would be default.
28921     * @return The created item or @c NULL upon failure.
28922     *
28923     * The item is inserted into the naviframe straight away without any
28924     * transition operations. This item will be deleted when it is popped.
28925     *
28926     * @see also elm_naviframe_item_style_set()
28927     * @see also elm_naviframe_item_push()
28928     * @see also elm_naviframe_item_insert_after()
28929     *
28930     * The following styles are available for this item:
28931     * @li @c "default"
28932     *
28933     * @ingroup Naviframe
28934     */
28935    EAPI Elm_Object_Item    *elm_naviframe_item_insert_before(Elm_Object_Item *before, const char *title_label, Evas_Object *prev_btn, Evas_Object *next_btn, Evas_Object *content, const char *item_style) EINA_ARG_NONNULL(1, 5);
28936    /**
28937     * @brief Insert a new item into the naviframe after item @p after.
28938     *
28939     * @param after The naviframe item to insert after.
28940     * @param title_label The label in the title area. The name of the title
28941     *        label part is "elm.text.title"
28942     * @param prev_btn The button to go to the previous item. If it is NULL,
28943     *        then naviframe will create a back button automatically. The name of
28944     *        the prev_btn part is "elm.swallow.prev_btn"
28945     * @param next_btn The button to go to the next item. Or It could be just an
28946     *        extra function button. The name of the next_btn part is
28947     *        "elm.swallow.next_btn"
28948     * @param content The main content object. The name of content part is
28949     *        "elm.swallow.content"
28950     * @param item_style The current item style name. @c NULL would be default.
28951     * @return The created item or @c NULL upon failure.
28952     *
28953     * The item is inserted into the naviframe straight away without any
28954     * transition operations. This item will be deleted when it is popped.
28955     *
28956     * @see also elm_naviframe_item_style_set()
28957     * @see also elm_naviframe_item_push()
28958     * @see also elm_naviframe_item_insert_before()
28959     *
28960     * The following styles are available for this item:
28961     * @li @c "default"
28962     *
28963     * @ingroup Naviframe
28964     */
28965    EAPI Elm_Object_Item    *elm_naviframe_item_insert_after(Elm_Object_Item *after, const char *title_label, Evas_Object *prev_btn, Evas_Object *next_btn, Evas_Object *content, const char *item_style) EINA_ARG_NONNULL(1, 5);
28966    /**
28967     * @brief Pop an item that is on top of the stack
28968     *
28969     * @param obj The naviframe object
28970     * @return @c NULL or the content object(if the
28971     *         elm_naviframe_content_preserve_on_pop_get is true).
28972     *
28973     * This pops an item that is on the top(visible) of the naviframe, makes it
28974     * disappear, then deletes the item. The item that was underneath it on the
28975     * stack will become visible.
28976     *
28977     * @see also elm_naviframe_content_preserve_on_pop_get()
28978     *
28979     * @ingroup Naviframe
28980     */
28981    EAPI Evas_Object        *elm_naviframe_item_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
28982    /**
28983     * @brief Pop the items between the top and the above one on the given item.
28984     *
28985     * @param it The naviframe item
28986     *
28987     * @ingroup Naviframe
28988     */
28989    EAPI void                elm_naviframe_item_pop_to(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
28990    /**
28991    * Promote an item already in the naviframe stack to the top of the stack
28992    *
28993    * @param it The naviframe item
28994    *
28995    * This will take the indicated item and promote it to the top of the stack
28996    * as if it had been pushed there. The item must already be inside the
28997    * naviframe stack to work.
28998    *
28999    */
29000    EAPI void                elm_naviframe_item_promote(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
29001    /**
29002     * @brief Delete the given item instantly.
29003     *
29004     * @param it The naviframe item
29005     *
29006     * This just deletes the given item from the naviframe item list instantly.
29007     * So this would not emit any signals for view transitions but just change
29008     * the current view if the given item is a top one.
29009     *
29010     * @ingroup Naviframe
29011     */
29012    EAPI void                elm_naviframe_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
29013    /**
29014     * @brief preserve the content objects when items are popped.
29015     *
29016     * @param obj The naviframe object
29017     * @param preserve Enable the preserve mode if EINA_TRUE, disable otherwise
29018     *
29019     * @see also elm_naviframe_content_preserve_on_pop_get()
29020     *
29021     * @ingroup Naviframe
29022     */
29023    EAPI void                elm_naviframe_content_preserve_on_pop_set(Evas_Object *obj, Eina_Bool preserve) EINA_ARG_NONNULL(1);
29024    /**
29025     * @brief Get a value whether preserve mode is enabled or not.
29026     *
29027     * @param obj The naviframe object
29028     * @return If @c EINA_TRUE, preserve mode is enabled
29029     *
29030     * @see also elm_naviframe_content_preserve_on_pop_set()
29031     *
29032     * @ingroup Naviframe
29033     */
29034    EAPI Eina_Bool           elm_naviframe_content_preserve_on_pop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
29035    /**
29036     * @brief Get a top item on the naviframe stack
29037     *
29038     * @param obj The naviframe object
29039     * @return The top item on the naviframe stack or @c NULL, if the stack is
29040     *         empty
29041     *
29042     * @ingroup Naviframe
29043     */
29044    EAPI Elm_Object_Item    *elm_naviframe_top_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
29045    /**
29046     * @brief Get a bottom item on the naviframe stack
29047     *
29048     * @param obj The naviframe object
29049     * @return The bottom item on the naviframe stack or @c NULL, if the stack is
29050     *         empty
29051     *
29052     * @ingroup Naviframe
29053     */
29054    EAPI Elm_Object_Item    *elm_naviframe_bottom_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
29055    /**
29056     * @brief Set an item style
29057     *
29058     * @param obj The naviframe item
29059     * @param item_style The current item style name. @c NULL would be default
29060     *
29061     * The following styles are available for this item:
29062     * @li @c "default"
29063     *
29064     * @see also elm_naviframe_item_style_get()
29065     *
29066     * @ingroup Naviframe
29067     */
29068    EAPI void                elm_naviframe_item_style_set(Elm_Object_Item *it, const char *item_style) EINA_ARG_NONNULL(1);
29069    /**
29070     * @brief Get an item style
29071     *
29072     * @param obj The naviframe item
29073     * @return The current item style name
29074     *
29075     * @see also elm_naviframe_item_style_set()
29076     *
29077     * @ingroup Naviframe
29078     */
29079    EAPI const char         *elm_naviframe_item_style_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
29080    /**
29081     * @brief Show/Hide the title area
29082     *
29083     * @param it The naviframe item
29084     * @param visible If @c EINA_TRUE, title area will be visible, hidden
29085     *        otherwise
29086     *
29087     * When the title area is invisible, then the controls would be hidden so as     * to expand the content area to full-size.
29088     *
29089     * @see also elm_naviframe_item_title_visible_get()
29090     *
29091     * @ingroup Naviframe
29092     */
29093    EAPI void                elm_naviframe_item_title_visible_set(Elm_Object_Item *it, Eina_Bool visible) EINA_ARG_NONNULL(1);
29094    /**
29095     * @brief Get a value whether title area is visible or not.
29096     *
29097     * @param it The naviframe item
29098     * @return If @c EINA_TRUE, title area is visible
29099     *
29100     * @see also elm_naviframe_item_title_visible_set()
29101     *
29102     * @ingroup Naviframe
29103     */
29104    EAPI Eina_Bool           elm_naviframe_item_title_visible_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
29105
29106    /**
29107     * @brief Set creating prev button automatically or not
29108     *
29109     * @param obj The naviframe object
29110     * @param auto_pushed If @c EINA_TRUE, the previous button(back button) will
29111     *        be created internally when you pass the @c NULL to the prev_btn
29112     *        parameter in elm_naviframe_item_push
29113     *
29114     * @see also elm_naviframe_item_push()
29115     */
29116    EAPI void                elm_naviframe_prev_btn_auto_pushed_set(Evas_Object *obj, Eina_Bool auto_pushed) EINA_ARG_NONNULL(1);
29117    /**
29118     * @brief Get a value whether prev button(back button) will be auto pushed or
29119     *        not.
29120     *
29121     * @param obj The naviframe object
29122     * @return If @c EINA_TRUE, prev button will be auto pushed.
29123     *
29124     * @see also elm_naviframe_item_push()
29125     *           elm_naviframe_prev_btn_auto_pushed_set()
29126     */
29127    EAPI Eina_Bool           elm_naviframe_prev_btn_auto_pushed_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
29128    /**
29129     * @brief Get a list of all the naviframe items.
29130     *
29131     * @param obj The naviframe object
29132     * @return An Eina_Inlist* of naviframe items, #Elm_Object_Item,
29133     * or @c NULL on failure.
29134     */
29135    EAPI Eina_Inlist        *elm_naviframe_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
29136
29137    /**
29138     * @}
29139     */
29140
29141    /**
29142     * @defgroup Controlbar Controlbar
29143     * @ingroup Elementary
29144     * @addtogroup Controlbar
29145     * @{
29146     *
29147     * This is a Controlbar. It can contain label and icon objects.
29148     * In edit mode, you can change the location of items.
29149     */
29150
29151    /* Control Bar */
29152    #define CONTROLBAR_SYSTEM_ICON_ALBUMS "controlbar_albums"
29153    #define CONTROLBAR_SYSTEM_ICON_ARTISTS "controlbar_artists"
29154    #define CONTROLBAR_SYSTEM_ICON_SONGS "controlbar_songs"
29155    #define CONTROLBAR_SYSTEM_ICON_PLAYLIST "controlbar_playlist"
29156    #define CONTROLBAR_SYSTEM_ICON_MORE "controlbar_more"
29157    #define CONTROLBAR_SYSTEM_ICON_CONTACTS "controlbar_contacts"
29158    #define CONTROLBAR_SYSTEM_ICON_DIALER "controlbar_dialer"
29159    #define CONTROLBAR_SYSTEM_ICON_FAVORITES "controlbar_favorites"
29160    #define CONTROLBAR_SYSTEM_ICON_LOGS "controlbar_logs"
29161
29162    typedef enum _Elm_Controlbar_Mode_Type
29163      {
29164         ELM_CONTROLBAR_MODE_DEFAULT = 0,
29165         ELM_CONTROLBAR_MODE_TRANSLUCENCE,
29166         ELM_CONTROLBAR_MODE_TRANSPARENCY,
29167         ELM_CONTROLBAR_MODE_LARGE,
29168         ELM_CONTROLBAR_MODE_SMALL,
29169         ELM_CONTROLBAR_MODE_LEFT,
29170         ELM_CONTROLBAR_MODE_RIGHT
29171      } Elm_Controlbar_Mode_Type;
29172
29173    typedef struct _Elm_Controlbar_Item Elm_Controlbar_Item;
29174    /**
29175     * Add a new controlbar object
29176     *
29177     * @param parent The parent object
29178     * @return The new object or NULL if it cannot be created
29179     */
29180    EAPI Evas_Object *elm_controlbar_add(Evas_Object *parent);
29181    /**
29182     * Append new tab item
29183     *
29184     * @param    obj The controlbar object
29185     * @param    icon_path The icon path of item
29186     * @param    label The label of item
29187     * @param    view The view of item
29188     * @return   The item of controlbar
29189     */
29190    EAPI Elm_Controlbar_Item *elm_controlbar_tab_item_append(Evas_Object *obj, const char *icon_path, const char *label, Evas_Object *view);
29191    /**
29192     * Prepend new tab item
29193     *
29194     * @param    obj The controlbar object
29195     * @param    icon_path The icon path of item
29196     * @param    label The label of item
29197     * @param    view The view of item
29198     * @return   The item of controlbar
29199     */
29200    EAPI Elm_Controlbar_Item *elm_controlbar_tab_item_prepend(Evas_Object *obj, const char *icon_path, const char *label, Evas_Object *view);
29201    /**
29202     * Insert new tab item before given item
29203     *
29204     * @param    obj The controlbar object
29205     * @param    before The given item
29206     * @param    icon_path The icon path of item
29207     * @param    label The label of item
29208     * @param    view The view of item
29209     * @return   The item of controlbar
29210     */
29211    EAPI Elm_Controlbar_Item *elm_controlbar_tab_item_insert_before(Evas_Object *obj, Elm_Controlbar_Item *before, const char *icon_path, const char *label, Evas_Object *view);
29212    /**
29213     * Insert new tab item after given item
29214     *
29215     * @param    obj The controlbar object
29216     * @param    after The given item
29217     * @param    icon_path The icon path of item
29218     * @param    label The label of item
29219     * @param    view The view of item
29220     * @return   The item of controlbar
29221     */
29222    EAPI Elm_Controlbar_Item *elm_controlbar_tab_item_insert_after(Evas_Object *obj, Elm_Controlbar_Item *after, const char *icon_path, const char *label, Evas_Object *view);
29223    /**
29224     * Append new tool item
29225     *
29226     * @param    obj The controlbar object
29227     * @param    icon_path The icon path of item
29228     * @param    label The label of item
29229     * @param    func Callback function of item
29230     * @param    data The data of callback function
29231     * @return   The item of controlbar
29232     */
29233    EAPI Elm_Controlbar_Item *elm_controlbar_tool_item_append(Evas_Object *obj, const char *icon_path, const char *label, void (*func) (void *data, Evas_Object *obj, void *event_info), void *data);
29234    /**
29235     * Prepend new tool item
29236     *
29237     * @param    obj The controlbar object
29238     * @param    icon_path The icon path of item
29239     * @param    label The label of item
29240     * @param    func Callback function of item
29241     * @param    data The data of callback function
29242     * @return   The item of controlbar
29243     */
29244    EAPI Elm_Controlbar_Item *elm_controlbar_tool_item_prepend(Evas_Object *obj, const char *icon_path, const char *label, void (*func) (void *data, Evas_Object *obj, void *event_info), void *data);
29245    /**
29246     * Insert new tool item before given item
29247     *
29248     * @param    obj The controlbar object
29249     * @param    before The given item
29250     * @param    icon_path The icon path of item
29251     * @param    label The label of item
29252     * @param    func Callback function of item
29253     * @param    data The data of callback function
29254     * @return   The item of controlbar
29255     */
29256    EAPI Elm_Controlbar_Item *elm_controlbar_tool_item_insert_before(Evas_Object *obj, Elm_Controlbar_Item *before, const char *icon_path, const char *label, void (*func) (void *data, Evas_Object *obj, void *event_info), void *data);
29257    /**
29258     * Insert new tool item after given item
29259     *
29260     * @param    obj The controlbar object
29261     * @param    after The given item
29262     * @param    icon_path The icon path of item
29263     * @param    label The label of item
29264     * @param    func Callback function of item
29265     * @param    data The data of callback function
29266     * @return   The item of controlbar
29267     */
29268    EAPI Elm_Controlbar_Item *elm_controlbar_tool_item_insert_after(Evas_Object *obj, Elm_Controlbar_Item *after, const char *icon_path, const char *label, void (*func) (void *data, Evas_Object *obj, void *event_info), void *data);
29269    /**
29270     * Append new object item
29271     *
29272     * @param    obj The controlbar object
29273     * @param    obj_item The object of item
29274     * @param    sel The number of sel occupied
29275     * @return  The item of controlbar
29276     */
29277    EAPI Elm_Controlbar_Item *elm_controlbar_object_item_append(Evas_Object *obj, Evas_Object *obj_item, const int sel);
29278    /**
29279     * Prepend new object item
29280     *
29281     * @param    obj The controlbar object
29282     * @param    obj_item The object of item
29283     * @param    sel The number of sel occupied
29284     * @return  The item of controlbar
29285     */
29286    EAPI Elm_Controlbar_Item *elm_controlbar_object_item_prepend(Evas_Object *obj, Evas_Object *obj_item, const int sel);
29287    /**
29288     * Insert new object item before given item
29289     *
29290     * @param    obj The controlbar object
29291     * @param    before The given item
29292     * @param    obj_item The object of item
29293     * @param    sel The number of sel occupied
29294     * @return  The item of controlbar
29295     */
29296    EAPI Elm_Controlbar_Item *elm_controlbar_object_item_insert_before(Evas_Object *obj, Elm_Controlbar_Item *before, Evas_Object *obj_item, const int sel);
29297    /**
29298     * Insert new object item after given item
29299     *
29300     * @param    obj The controlbar object
29301     * @param    after The given item
29302     * @param    obj_item The object of item
29303     * @param    sel The number of sel occupied
29304     * @return  The item of controlbar
29305     */
29306    EAPI Elm_Controlbar_Item *elm_controlbar_object_item_insert_after(Evas_Object *obj, Elm_Controlbar_Item *after, Evas_Object *obj_item, const int sel);
29307    /**
29308     * Get the object of the object item
29309     *
29310     * @param       it The item of controlbar
29311     * @return      The object of the object item
29312     */
29313    EAPI Evas_Object *elm_controlbar_object_item_object_get(const Elm_Controlbar_Item *it);
29314    /**
29315     * Delete item from controlbar
29316     *
29317     * @param    it The item of controlbar
29318     */
29319    EAPI void         elm_controlbar_item_del(Elm_Controlbar_Item *it);
29320    /**
29321     * Select item in controlbar
29322     *
29323     * @param    it The item of controlbar
29324     */
29325    EAPI void         elm_controlbar_item_select(Elm_Controlbar_Item *it);
29326    /**
29327     * Set the visible status of item in bar
29328     *
29329     * @param    it The item of controlbar
29330     * @param    bar EINA_TRUE or EINA_FALSE
29331     */
29332    EAPI void         elm_controlbar_item_visible_set(Elm_Controlbar_Item *it, Eina_Bool bar);
29333    /**
29334     * Get the result which or not item is visible in bar
29335     *
29336     * @param    it The item of controlbar
29337     * @return   EINA_TRUE or EINA_FALSE
29338     */
29339    EAPI Eina_Bool    elm_controlbar_item_visible_get(const Elm_Controlbar_Item * it);
29340    /**
29341     * Set item disable
29342     *
29343     * @param    it The item of controlbar
29344     * @param    bar EINA_TRUE or EINA_FALSE
29345     */
29346    EAPI void         elm_controlbar_item_disabled_set(Elm_Controlbar_Item * it, Eina_Bool disabled);
29347    /**
29348     * Get item disable
29349     *
29350     * @param    it The item of controlbar
29351     * @return   EINA_TRUE or EINA_FALSE
29352     */
29353    EAPI Eina_Bool    elm_controlbar_item_disabled_get(const Elm_Controlbar_Item * it);
29354    /**
29355     * Set the icon of item
29356     *
29357     * @param    it The item of controlbar
29358     * @param    icon_path The icon path of the item
29359     * @return   The icon object
29360     */
29361    EAPI void         elm_controlbar_item_icon_set(Elm_Controlbar_Item *it, const char *icon_path);
29362    /**
29363     * Get the icon of item
29364     *
29365     * @param    it The item of controlbar
29366     * @return   The icon object
29367     */
29368    EAPI Evas_Object *elm_controlbar_item_icon_get(const Elm_Controlbar_Item *it);
29369    /**
29370     * Set the label of item
29371     *
29372     * @param    it The item of controlbar
29373     * @param    label The label of item
29374     */
29375    EAPI void         elm_controlbar_item_label_set(Elm_Controlbar_Item *it, const char *label);
29376    /**
29377     * Get the label of item
29378     *
29379     * @param    it The item of controlbar
29380     * @return The label of item
29381     */
29382    EAPI const char  *elm_controlbar_item_label_get(const Elm_Controlbar_Item *it);
29383    /**
29384     * Get the selected item
29385     *
29386     * @param    obj The controlbar object
29387     * @return           The item of controlbar
29388     */
29389    EAPI Elm_Controlbar_Item *elm_controlbar_selected_item_get(const Evas_Object *obj);
29390    /**
29391     * Get the first item
29392     *
29393     * @param    obj The controlbar object
29394     * @return           The item of controlbar
29395     */
29396    EAPI Elm_Controlbar_Item *elm_controlbar_first_item_get(const Evas_Object *obj);
29397    /**
29398     * Get the last item
29399     *
29400     * @param    obj The controlbar object
29401     * @return           The item of controlbar
29402     */
29403    EAPI Elm_Controlbar_Item *elm_controlbar_last_item_get(const Evas_Object *obj);
29404    /**
29405     * Get the items
29406     *
29407     * @param    obj The controlbar object
29408     * @return   The list of the items
29409     */
29410    EAPI const Eina_List   *elm_controlbar_items_get(const Evas_Object *obj);
29411    /**
29412     * Get the previous item
29413     *
29414     * @param    it The item of controlbar
29415     * @return   The previous item of the parameter item
29416     */
29417    EAPI Elm_Controlbar_Item *elm_controlbar_item_prev(Elm_Controlbar_Item *it);
29418    /**
29419     * Get the next item
29420     *
29421     * @param    obj The controlbar object
29422     * @return   The next item of the parameter item
29423     */
29424    EAPI Elm_Controlbar_Item *elm_controlbar_item_next(Elm_Controlbar_Item *it);
29425    /**
29426     * Set the view of the item
29427     *
29428     * @param    it The item of controlbar
29429     * @param    view The view for the item
29430     */
29431    EAPI void         elm_controlbar_item_view_set(Elm_Controlbar_Item *it, Evas_Object * view);
29432    /**
29433     * Get the view of the item
29434     *
29435     * @param    it The item of controlbar
29436     * @return   The view for the item
29437     */
29438    EAPI Evas_Object *elm_controlbar_item_view_get(const Elm_Controlbar_Item *it);
29439    /**
29440     * Unset the view of the item
29441     *
29442     * @param    it The item of controlbar
29443     * @return   The view for the item
29444     */
29445    EAPI Evas_Object *elm_controlbar_item_view_unset(Elm_Controlbar_Item *it);
29446    /**
29447     * Set the vertical mode of the controlbar
29448     *
29449     * @param    obj The object of the controlbar
29450     * @param    vertical The vertical mode of the controlbar (TRUE = vertical, FALSE = horizontal)
29451     */
29452    EAPI Evas_Object *elm_controlbar_item_button_get(const Elm_Controlbar_Item *it);
29453    /**
29454     * Set the mode of the controlbar
29455     *
29456     * @param    obj The object of the controlbar
29457     * @param    mode The mode of the controlbar
29458     */
29459    EAPI void         elm_controlbar_mode_set(Evas_Object *obj, int mode);
29460    /**
29461     * Set the alpha of the controlbar
29462     *
29463     * @param    obj The object of the controlbar
29464     * @param    alpha The alpha value of the controlbar (0-100)
29465     */
29466    EAPI void         elm_controlbar_alpha_set(Evas_Object *obj, int alpha);
29467    /**
29468     * Set auto-align mode of the controlbar(It's not prepared yet)
29469     * If you set the auto-align and add items more than 5,
29470     * the "more" item will be made and the items more than 5 will be unvisible.
29471     *
29472     * @param    obj The object of the controlbar
29473     * @param    auto_align The dicision that the controlbar use the auto-align
29474     */
29475    EAPI void         elm_controlbar_item_auto_align_set(Evas_Object *obj, Eina_Bool auto_align);
29476    /**
29477     * Get the button object of the item
29478     *
29479     * @param    it The item of controlbar
29480     * @return  button object of the item
29481     */
29482    EAPI void         elm_controlbar_vertical_set(Evas_Object *obj, Eina_Bool vertical);
29483    /**
29484     * @}
29485     */
29486
29487
29488    /**
29489     * @defgroup Searchbar Searchbar
29490     * @addtogroup TickerNoti
29491     * @{
29492     * @ingroup Elementary
29493     *
29494     * This is Searchbar.
29495     * It can contain a simple entry and button object.
29496     */
29497
29498    /**
29499     * Add a new searchbar to the parent
29500     * @param parent The parent object
29501     * @return The new object or NULL if it cannot be created
29502     */
29503    EAPI Evas_Object *elm_searchbar_add(Evas_Object *parent);
29504    /**
29505     * set the text of entry
29506     *
29507     * @param obj The searchbar object
29508     * @return void
29509     */
29510    EAPI void         elm_searchbar_text_set(Evas_Object *obj, const char *entry);
29511    /**
29512     * get the text of entry
29513     *
29514     * @param obj The searchbar object
29515     * @return string pointer of entry
29516     */
29517    EAPI const char  *elm_searchbar_text_get(Evas_Object *obj);
29518    /**
29519     * get the pointer of entry
29520     *
29521     * @param obj The searchbar object
29522     * @return the entry object
29523     */
29524    EAPI Evas_Object *elm_searchbar_entry_get(Evas_Object *obj);
29525    /**
29526     * get the pointer of editfield
29527     *
29528     * @param obj The searchbar object
29529     * @return the editfield object
29530     */
29531    EAPI Evas_Object *elm_searchbar_editfield_get(Evas_Object *obj);
29532    /**
29533     * set the cancel button animation flag
29534     *
29535     * @param obj The searchbar object
29536     * @param cancel_btn_ani_flag The flag of animating cancen button or not
29537     * @return void
29538     */
29539    EAPI void         elm_searchbar_cancel_button_animation_set(Evas_Object *obj, Eina_Bool cancel_btn_ani_flag);
29540    /**
29541     * set the cancel button show mode
29542     *
29543     * @param obj The searchbar object
29544     * @param visible The flag of cancen button show or not
29545     * @return void
29546     */
29547    EAPI void         elm_searchbar_cancel_button_set(Evas_Object *obj, Eina_Bool visible);
29548    /**
29549     * clear searchbar status
29550     *
29551     * @param obj The searchbar object
29552     * @return void
29553     */
29554    EAPI void         elm_searchbar_clear(Evas_Object *obj);
29555    /**
29556     * set the searchbar boundary rect mode(with bg rect) set
29557     *
29558     * @param obj The searchbar object
29559     * @param boundary The present flag of boundary rect or not
29560     * @return void
29561     */
29562    EAPI void         elm_searchbar_boundary_rect_set(Evas_Object *obj, Eina_Bool boundary);
29563    /**
29564     * @}
29565     */
29566
29567    EAPI Evas_Object *elm_page_control_add(Evas_Object *parent);
29568    EAPI void         elm_page_control_page_count_set(Evas_Object *obj, unsigned int page_count);
29569    EAPI void         elm_page_control_page_id_set(Evas_Object *obj, unsigned int page_id);
29570    EAPI unsigned int elm_page_control_page_id_get(Evas_Object *obj);
29571
29572    /* NoContents */
29573    EAPI Evas_Object *elm_nocontents_add(Evas_Object *parent);
29574    EAPI void         elm_nocontents_label_set(Evas_Object *obj, const char *label);
29575    EAPI const char  *elm_nocontents_label_get(const Evas_Object *obj);
29576    EAPI void         elm_nocontents_custom_set(const Evas_Object *obj, Evas_Object *custom);
29577    EAPI Evas_Object *elm_nocontents_custom_get(const Evas_Object *obj);
29578
29579    /**
29580     * @defgroup TickerNoti TickerNoti
29581     * @addtogroup TickerNoti
29582     * @{
29583     *
29584     * This is a notification widget which can be used to display some short information.
29585     *
29586     * Parts which can be used with elm_object_text_part_set() and
29587     * elm_object_text_part_get():
29588     *
29589     * @li NULL/"default" - Operates on tickernoti content-text
29590     *
29591     * Parts which can be used with elm_object_content_part_set(),
29592     * elm_object_content_part_get() and elm_object_content_part_unset():
29593     *
29594     * @li "icon" - Operates on tickernoti's icon
29595     * @li "button" - Operates on tickernoti's button
29596     *
29597     * smart callbacks called:
29598     * @li "clicked" - emitted when tickernoti is clicked, except at the
29599     * swallow/button region, if any.
29600     * @li "hide" - emitted when the tickernoti is completely hidden. In case of
29601     * any hide animation, this signal is emitted after the animation.
29602     */
29603    typedef enum
29604      {
29605         ELM_TICKERNOTI_ORIENT_TOP = 0,
29606         ELM_TICKERNOTI_ORIENT_BOTTOM,
29607         ELM_TICKERNOTI_ORIENT_LAST
29608      }  Elm_Tickernoti_Orient;
29609
29610    /**
29611     * Add a tickernoti object to @p parent
29612     *
29613     * @param parent The parent object
29614     *
29615     * @return The tickernoti object, or NULL upon failure
29616     */
29617    EAPI Evas_Object              *elm_tickernoti_add (Evas_Object *parent);
29618    /**
29619     * Set the orientation of the tickernoti object
29620     *
29621     * @param obj The tickernoti object
29622     * @param orient The orientation of tickernoti object
29623     */
29624    EAPI void                      elm_tickernoti_orient_set (Evas_Object *obj, Elm_Tickernoti_Orient orient) EINA_ARG_NONNULL(1);
29625    /**
29626     * Get the orientation of the tickernoti object
29627     *
29628     * @param obj The tickernotil object
29629     * @return The orientation of tickernotil object
29630     */
29631    EAPI Elm_Tickernoti_Orient     elm_tickernoti_orient_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
29632    /**
29633     * Get the rotation of tickernoti object
29634     *
29635     * @param obj The tickernotil object
29636     * @return The rotation angle
29637     */
29638    EAPI int                       elm_tickernoti_rotation_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
29639    /**
29640     * Set the rotation angle for the tickernoti object
29641     *
29642     * @param obj The tickernoti object
29643     * @param angle The rotation angle(in degree) will be used on the tickernoti object
29644     */
29645    EAPI void                      elm_tickernoti_rotation_set (Evas_Object *obj, int angle) EINA_ARG_NONNULL(1);
29646    /**
29647     * Get the view window(elm_win) on the tickernoti object
29648     *
29649     * @param obj The tickernotil object
29650     * @return internal view window(elm_win) object
29651     */
29652    EAPI Evas_Object              *elm_tickernoti_win_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
29653    /* #### Below APIs and data structures are going to be deprecated, announcment will be made soon ####*/
29654    /**
29655     * @deprecated
29656     */
29657    typedef enum
29658     {
29659        ELM_TICKERNOTI_DEFAULT,
29660        ELM_TICKERNOTI_DETAILVIEW
29661     } Elm_Tickernoti_Mode;
29662    /**
29663     * Set the detail label on the tickernoti object
29664     *
29665     * @param obj The tickernoti object
29666     * @param label The label will be used on the tickernoti object
29667     * @deprecated use elm_object_text_set() instead
29668     */
29669    WILL_DEPRECATE  EAPI void                      elm_tickernoti_detailview_label_set (Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
29670    /**
29671     * Get the detail label used on the tickernoti object
29672     *
29673     * @param obj The tickernotil object
29674     * @return The string inside the label
29675     * @deprecated use elm_object_text_get() instead
29676     */
29677    WILL_DEPRECATE  EAPI const char               *elm_tickernoti_detailview_label_get (const Evas_Object *obj)EINA_ARG_NONNULL(1);
29678    /**
29679     * Set the button object used on the tickernoti object
29680     *
29681     * @param obj The tickernotil object
29682     * @param button The button object will be used on the tickernoti object
29683     * @deprecated use elm_object_content_part_set() instead with "icon" as part name
29684     */
29685    WILL_DEPRECATE  EAPI void                      elm_tickernoti_detailview_button_set (Evas_Object *obj, Evas_Object *button) EINA_ARG_NONNULL(2);
29686    /**
29687     * Get the button object used on the tickernoti object
29688     *
29689     * @param obj The tickernotil object
29690     * @return The button object inside the tickernoti
29691     * @deprecated use elm_object_content_part_get() instead with "button" as part name
29692     */
29693    WILL_DEPRECATE  EAPI Evas_Object              *elm_tickernoti_detailview_button_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
29694    /**
29695     * Set the detail icon object used on the tickernoti object
29696     *
29697     * @param obj The tickernotil object
29698     * @param icon The icon object will be used on the tickernoti object
29699     * @deprecated use elm_object_content_part_set() instead with "icon" as part name
29700     */
29701    WILL_DEPRECATE  EAPI void                      elm_tickernoti_detailview_icon_set (Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
29702    /**
29703     * Get the detail icon object used on the tickernoti object
29704     *
29705     * @param obj The tickernotil object
29706     * @return The icon object inside the tickernoti
29707     * @deprecated use elm_object_content_part_get() instead with "icon" as part name
29708     */
29709    WILL_DEPRECATE  EAPI Evas_Object              *elm_tickernoti_detailview_icon_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
29710    /**
29711     * Get the view mode on the tickernoti object
29712     *
29713     * @param obj The tickernotil object
29714     * @return The view mode
29715     * @deprecated removed as now styles are used instead
29716     */
29717    WILL_DEPRECATE  EAPI Evas_Object              *elm_tickernoti_detailview_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
29718    /**
29719     * Set the view mode used on the tickernoti object
29720     *
29721     * @param obj The tickernotil object
29722     * @param mode The view mode will be used on the tickernoti object
29723     * @deprecated removed as now styles are used instead
29724     */
29725    WILL_DEPRECATE  EAPI void                      elm_tickernoti_mode_set (Evas_Object *obj, Elm_Tickernoti_Mode mode) EINA_ARG_NONNULL(1);
29726    /**
29727     * Get the detail view window(elm_win) on the tickernoti object
29728     *
29729     * @param obj The tickernotil object
29730     * @return detail view window(elm_win) object
29731     */
29732    WILL_DEPRECATE  EAPI Elm_Tickernoti_Mode       elm_tickernoti_mode_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
29733    /**
29734     * Set the orientation of the tickernoti object
29735     *
29736     * @param obj The tickernoti object
29737     * @param orient The orientation of tickernoti object
29738     * @deprecated use elm_tickernoti_orient_set() instead
29739     */
29740    WILL_DEPRECATE  EAPI void                      elm_tickernoti_orientation_set (Evas_Object *obj, Elm_Tickernoti_Orient orient) EINA_ARG_NONNULL(1);
29741    /**
29742     * Get the orientation of the tickernoti object
29743     *
29744     * @param obj The tickernotil object
29745     * @return The orientation of tickernotil object
29746     * @deprecated use elm_tickernoti_orient_get() instead
29747     */
29748    WILL_DEPRECATE  EAPI Elm_Tickernoti_Orient     elm_tickernoti_orientation_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
29749    /**
29750     * Set the label on the tickernoti object
29751     *
29752     * @param obj The tickernoti object
29753     * @param label The label will be used on the tickernoti object
29754     * @deprecated use elm_object_text_get()
29755     */
29756    WILL_DEPRECATE  EAPI void                      elm_tickernoti_label_set (Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
29757    /**
29758     * Get the label used on the tickernoti object
29759     *
29760     * @param obj The tickernotil object
29761     * @return The string inside the label
29762     * @deprecated use elm_object_text_get() instead
29763     */
29764    WILL_DEPRECATE  EAPI const char               *elm_tickernoti_label_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
29765    /**
29766     * Set the icon object of the tickernoti object
29767     *
29768     * @param obj The tickernotil object
29769     * @param icon The icon object will be used on the tickernoti object
29770     * @deprecated use elm_object_content_part_set() instead with "icon" as part name
29771     */
29772    WILL_DEPRECATE  EAPI void                      elm_tickernoti_icon_set (Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
29773    /**
29774     * Get the icon object of the tickernoti object
29775     *
29776     * @param obj The tickernotil object
29777     * @return The icon object inside the tickernoti
29778     * @deprecated use elm_object_content_part_get() instead with "icon" as part name
29779     */
29780    WILL_DEPRECATE  EAPI Evas_Object              *elm_tickernoti_icon_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
29781    /**
29782     * Set the action button object used on the tickernoti object
29783     *
29784     * @param obj The tickernotil object
29785     * @param button The button object will be used on the tickernoti object
29786     * @deprecated use elm_object_content_part_set() instead with "button" as part name
29787     */
29788    WILL_DEPRECATE  EAPI void                      elm_tickernoti_button_set (Evas_Object *obj, Evas_Object *button) EINA_ARG_NONNULL(1);
29789    /**
29790     * Get the action button object used on the tickernoti object
29791     *
29792     * @param obj The tickernotil object
29793     * @return The button object inside the tickernoti
29794     * @deprecated use elm_object_content_part_get() instead with "button" as part name
29795     */
29796    WILL_DEPRECATE  EAPI Evas_Object              *elm_tickernoti_button_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
29797    /**
29798     * @}
29799     */
29800
29801    /**
29802     * @defgroup Colorpalette Colorpalette
29803     * @ingroup Elementary
29804     * @addtogroup Colorpalette
29805     * @{
29806     *
29807     * Using colorpalette, you can select a color by clicking
29808     * a color rectangle on the colorpalette.
29809     *
29810     * Smart callbacks that you can add are:
29811     *
29812     * clicked - This signal is sent when a color rectangle is clicked.
29813     */
29814    typedef struct _Colorpalette_Color Elm_Colorpalette_Color;
29815    struct _Colorpalette_Color
29816      {
29817         unsigned int r, g, b;
29818      };
29819
29820    /**
29821     * Add a new colorpalette to the parent.
29822     *
29823     * @param parent The parent object
29824     * @return The new object or NULL if it cannot be created
29825     *
29826     * @ingroup Colorpalette
29827     */
29828    EAPI Evas_Object *elm_colorpalette_add(Evas_Object *parent);
29829    /**
29830     * Set colors to the colorpalette.
29831     *
29832     * @param obj   Colorpalette object
29833     * @param color_num     number of the colors on the colorpalette
29834     * @param color     Color lists
29835     */
29836    EAPI void         elm_colorpalette_color_set(Evas_Object *obj, int color_num, Elm_Colorpalette_Color *color);
29837    /**
29838     * Set row/column value for the colorpalette.
29839     *
29840     * @param obj   Colorpalette object
29841     * @param row   row value for the colorpalette
29842     * @param col   column value for the colorpalette
29843     */
29844    EAPI void         elm_colorpalette_row_column_set(Evas_Object *obj, int row, int col);
29845
29846    /**
29847     * @}
29848     */
29849
29850    /* editfield */
29851    EAPI Evas_Object *elm_editfield_add(Evas_Object *parent);
29852    EAPI void         elm_editfield_label_set(Evas_Object *obj, const char *label);
29853    EAPI const char  *elm_editfield_label_get(Evas_Object *obj);
29854    EAPI void         elm_editfield_guide_text_set(Evas_Object *obj, const char *text);
29855    EAPI const char  *elm_editfield_guide_text_get(Evas_Object *obj);
29856    EAPI Evas_Object *elm_editfield_entry_get(Evas_Object *obj);
29857 //   EAPI Evas_Object *elm_editfield_clear_button_show(Evas_Object *obj, Eina_Bool show);
29858    EAPI void         elm_editfield_right_icon_set(Evas_Object *obj, Evas_Object *icon);
29859    EAPI Evas_Object *elm_editfield_right_icon_get(Evas_Object *obj);
29860    EAPI void         elm_editfield_left_icon_set(Evas_Object *obj, Evas_Object *icon);
29861    EAPI Evas_Object *elm_editfield_left_icon_get(Evas_Object *obj);
29862    EAPI void         elm_editfield_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line);
29863    EAPI Eina_Bool    elm_editfield_entry_single_line_get(Evas_Object *obj);
29864    EAPI void         elm_editfield_eraser_set(Evas_Object *obj, Eina_Bool visible);
29865    EAPI Eina_Bool    elm_editfield_eraser_get(Evas_Object *obj);
29866    /* smart callbacks called:
29867     * "clicked" - when an editfield is clicked
29868     * "unfocused" - when an editfield is unfocused
29869     */
29870
29871
29872    /**
29873     * @defgroup Multibuttonenetry Multibuttonenetry
29874     *
29875     * @image html img/widget/flipselector/preview-00.png
29876     * @image latex img/widget/flipselector/preview-00.eps
29877     *
29878     * A Multibuttonentry is a widget to allow a user to insert a text button.
29879     * the text button is inserted by pressing the "return" key. If there is no space in the current row,
29880     * the new button is entered in the next row. If the button is pressed, it will become focused. 
29881     * The focus can be removed by pressing the "backspace" key.
29882     * when items are added over 1 lines, if Multibuttonentry lost focus, it becase shrink mode ( made it 1 line)
29883     *
29884     * Smart callbacks one can register to:
29885     * - @c "item,selected" - when item is selected . it can be called by backspace key.                       
29886     * - @c "item,added" - when a new multibuttonentry item is added. 
29887     * - @c "item,deleted" -when a multibuttonentry item is deleted. 
29888     * - @c "item,clicked" - selected item of multibuttonentry is clicked.                  
29889     * - @c "clicked" - when multibuttonentry is clicked. 
29890     * - @c "focused" - when multibuttonentry is focused. 
29891     * - @c "unfocused" - when multibuttonentry is unfocused. 
29892     * - @c "expanded" - when multibuttonentry is expanded . 
29893     * - @c "shrank" - when multibuttonentry is shrank. 
29894     * - @c "shrank,state,changed" - when shrink mode state of multibuttonentry is changed. 
29895     *
29896     * Here is an example on its usage:
29897     * @li @ref multibuttonentry_example
29898     */
29899     /**
29900     * @addtogroup Multibuttonentry
29901     * @{
29902     */
29903
29904    /* multibuttonentry */
29905    typedef struct _Multibuttonentry_Item Elm_Multibuttonentry_Item;
29906    typedef Eina_Bool (*Elm_Multibuttonentry_Item_Verify_Callback) (Evas_Object *obj, const char *item_label, void *item_data, void *data);
29907
29908    /**
29909     * @brief Add a new multibuttonentry to the parent
29910     *
29911     * @param parent The parent object
29912     * @return The new object or NULL if it cannot be created
29913     */
29914    EAPI Evas_Object               *elm_multibuttonentry_add(Evas_Object *parent);
29915    /**
29916     * Get the label
29917     *
29918     * @param obj The multibuttonentry object
29919     * @return The label, or NULL if none
29920     */
29921    EAPI const char                *elm_multibuttonentry_label_get(const Evas_Object *obj);
29922    /**
29923     * Set the label
29924     *
29925     * @param obj The multibuttonentry object
29926     * @param label The text label string
29927     */
29928    EAPI void                       elm_multibuttonentry_label_set(Evas_Object *obj, const char *label);
29929    /**
29930     * Get the entry of the multibuttonentry object
29931     *
29932     * @param obj The multibuttonentry object
29933     * @return The entry object, or NULL if none
29934     */
29935    EAPI Evas_Object               *elm_multibuttonentry_entry_get(const Evas_Object *obj);
29936    /**
29937     * Get the guide text
29938     *
29939     * @param obj The multibuttonentry object
29940     * @return The guide text, or NULL if none
29941     */
29942    EAPI const char *               elm_multibuttonentry_guide_text_get(const Evas_Object *obj);
29943    /**
29944     * Set the guide text
29945     *
29946     * @param obj The multibuttonentry object
29947     * @param label The guide text string
29948     */
29949    EAPI void                       elm_multibuttonentry_guide_text_set(Evas_Object *obj, const char *guidetext);
29950    /**
29951     * Get the value of shrink_mode state.
29952     *
29953     * @param obj The multibuttonentry object
29954     * @param the value of shrink mode state.
29955     */
29956    EAPI int                        elm_multibuttonentry_contracted_state_get(const Evas_Object *obj);
29957    /**
29958     * Set/Unset the multibuttonentry to shrink mode state of single line
29959     *
29960     * @param obj The multibuttonentry object
29961     * @param the value of shrink_mode state. set this to 1 to set the multibuttonentry to shrink state of single line. set this to 0 to unset the contracted state.
29962     */
29963    EAPI void                       elm_multibuttonentry_contracted_state_set(Evas_Object *obj, int contracted);
29964    /**
29965     * Prepend a new item to the multibuttonentry
29966     *
29967     * @param obj The multibuttonentry object
29968     * @param label The label of new item
29969     * @param data The ponter to the data to be attached
29970     * @return A handle to the item added or NULL if not possible
29971     */
29972    EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_add_start(Evas_Object *obj, const char *label, void *data);
29973    /**
29974     * Append a new item to the multibuttonentry
29975     *
29976     * @param obj The multibuttonentry object
29977     * @param label The label of new item
29978     * @param data The ponter to the data to be attached
29979     * @return A handle to the item added or NULL if not possible
29980     */
29981    EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_add_end(Evas_Object *obj, const char *label, void *data);
29982    /**
29983     * Add a new item to the multibuttonentry before the indicated object
29984     *
29985     * reference.
29986     * @param obj The multibuttonentry object
29987     * @param before The item before which to add it
29988     * @param label The label of new item
29989     * @param data The ponter to the data to be attached
29990     * @return A handle to the item added or NULL if not possible
29991     */
29992    EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_add_before(Evas_Object *obj, const char *label, Elm_Multibuttonentry_Item *before, void *data);
29993    /**
29994     * Add a new item to the multibuttonentry after the indicated object
29995     *
29996     * @param obj The multibuttonentry object
29997     * @param after The item after which to add it
29998     * @param label The label of new item
29999     * @param data The ponter to the data to be attached
30000     * @return A handle to the item added or NULL if not possible
30001     */
30002    EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_add_after(Evas_Object *obj, const char *label, Elm_Multibuttonentry_Item *after, void *data);
30003    /**
30004     * Get a list of items in the multibuttonentry
30005     *
30006     * @param obj The multibuttonentry object
30007     * @return The list of items, or NULL if none
30008     */
30009    EAPI const Eina_List           *elm_multibuttonentry_items_get(const Evas_Object *obj);
30010    /**
30011     * Get the first item in the multibuttonentry
30012     *
30013     * @param obj The multibuttonentry object
30014     * @return The first item, or NULL if none
30015     */
30016    EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_first_get(const Evas_Object *obj);
30017    /**
30018     * Get the last item in the multibuttonentry
30019     *
30020     * @param obj The multibuttonentry object
30021     * @return The last item, or NULL if none
30022     */
30023    EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_last_get(const Evas_Object *obj);
30024    /**
30025     * Get the selected item in the multibuttonentry
30026     *
30027     * @param obj The multibuttonentry object
30028     * @return The selected item, or NULL if none
30029     */
30030    EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_selected_get(const Evas_Object *obj);
30031    /**
30032     * Set the selected state of an item
30033     *
30034     * @param item The item
30035     * @param selected if it's EINA_TRUE, select the item otherwise, unselect the item
30036     */
30037    EAPI void                       elm_multibuttonentry_item_selected_set(Elm_Multibuttonentry_Item *item);
30038    /**
30039    * unselect all of items.
30040    *
30041    * @param obj The multibuttonentry object
30042    */
30043    EAPI void                       elm_multibuttonentry_item_unselect_all(Evas_Object *obj);
30044   /**
30045    * Delete a given item
30046    *
30047    * @param item The item
30048    */
30049    EAPI void                       elm_multibuttonentry_item_del(Elm_Multibuttonentry_Item *item);
30050   /**
30051    * Remove all items in the multibuttonentry.
30052    *
30053    * @param obj The multibuttonentry object
30054    */
30055    EAPI void                       elm_multibuttonentry_items_del(Evas_Object *obj);
30056   /**
30057    * Get the label of a given item
30058    *
30059    * @param item The item
30060    * @return The label of a given item, or NULL if none
30061    */
30062    EAPI const char                *elm_multibuttonentry_item_label_get(const Elm_Multibuttonentry_Item *item);
30063   /**
30064    * Set the label of a given item
30065    *
30066    * @param item The item
30067    * @param label The text label string
30068    */
30069    EAPI void                       elm_multibuttonentry_item_label_set(Elm_Multibuttonentry_Item *item, const char *str);
30070   /**
30071    * Get the previous item in the multibuttonentry
30072    *
30073    * @param item The item
30074    * @return The item before the item @p item
30075    */
30076    EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_prev(Elm_Multibuttonentry_Item *item);
30077   /**
30078    * Get the next item in the multibuttonentry
30079    *
30080    * @param item The item
30081    * @return The item after the item @p item
30082    */
30083    EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_next(Elm_Multibuttonentry_Item *item);
30084
30085    EAPI void                      *elm_multibuttonentry_item_data_get(const Elm_Multibuttonentry_Item *item);
30086    EAPI void                       elm_multibuttonentry_item_data_set(Elm_Multibuttonentry_Item *item, void *data);
30087    EAPI void                       elm_multibuttonentry_item_verify_callback_set(Evas_Object *obj, Elm_Multibuttonentry_Item_Verify_Callback func, void *data);
30088
30089    /**
30090     * @}
30091     */
30092
30093    /**
30094     * @defgroup Stackedicon Stackedicon
30095     * @ingroup Elementary
30096     * @addtogroup Stackedicon
30097     * @{
30098     *
30099     * This is a Stackedicon.
30100     * smart callback called:
30101     * "expanded" - This signal is emitted when a stackedicon is expanded.
30102     * "clicked" - This signal is emitted when a stackedicon is clicked.
30103     *
30104     * available styles:
30105     * default
30106     */
30107    typedef struct _Stackedicon_Item Elm_Stackedicon_Item;
30108    /**
30109     * Add a new stackedicon to the parent
30110     *
30111     * @param parent The parent object
30112     * @return The new object or NULL if it cannot be created
30113     */
30114    EAPI Evas_Object          *elm_stackedicon_add(Evas_Object *parent);
30115    /**
30116     * This appends a path to the stackedicon
30117     *
30118     * @param    obj   The stackedicon object
30119     * @param    path   The image full path
30120     * @return   The new item or NULL if it cannot be created
30121     */
30122    EAPI Elm_Stackedicon_Item *elm_stackedicon_item_append(Evas_Object *obj, const char *path);
30123    /**
30124     * This prepends a path to the stackedicon
30125     *
30126     * @param    obj   The stackedicon object
30127     * @param    path   The image full path
30128     * @return   The new item or NULL if it cannot be created
30129     */
30130    EAPI Elm_Stackedicon_Item *elm_stackedicon_item_prepend(Evas_Object *obj, const char *path);
30131    /**
30132     * This delete a path at the stackedicon
30133     *
30134     * @param    Elm_Stackedicon_Item   The delete item
30135     */
30136    EAPI void                  elm_stackedicon_item_del(Elm_Stackedicon_Item *it);
30137    /**
30138     * Get item list from the stackedicon
30139     *
30140     * @param    obj   The stackedicon object
30141     * @return   The item list or NULL if it cannot be created
30142     */
30143    EAPI Eina_List            *elm_stackedicon_item_list_get(Evas_Object *obj);
30144    /**
30145     * @}
30146     */
30147
30148    /* Dayselector */
30149    typedef enum
30150      {
30151         ELM_DAYSELECTOR_SUN,
30152         ELM_DAYSELECTOR_MON,
30153         ELM_DAYSELECTOR_TUE,
30154         ELM_DAYSELECTOR_WED,
30155         ELM_DAYSELECTOR_THU,
30156         ELM_DAYSELECTOR_FRI,
30157         ELM_DAYSELECTOR_SAT
30158      } Elm_DaySelector_Day;
30159
30160    EAPI Evas_Object *elm_dayselector_add(Evas_Object *parent);
30161    EAPI Eina_Bool    elm_dayselector_check_state_get(Evas_Object *obj, Elm_DaySelector_Day day);
30162    EAPI void         elm_dayselector_check_state_set(Evas_Object *obj, Elm_DaySelector_Day day, Eina_Bool checked);
30163
30164    /**
30165     * @defgroup Imageslider Imageslider
30166     * @ingroup Elementary
30167     * @addtogroup Imageslider
30168     * @{
30169     *
30170     * By flicking images on the screen,
30171     * you can see the images in specific path.
30172     */
30173    typedef struct _Imageslider_Item Elm_Imageslider_Item;
30174    typedef void (*Elm_Imageslider_Cb)(void *data, Evas_Object *obj, void *event_info);
30175
30176    /**
30177     * Add an Image Slider widget
30178     *
30179     * @param        parent  The parent object
30180     * @return       The new Image slider object or NULL if it cannot be created
30181     */
30182    EAPI Evas_Object           *elm_imageslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
30183    /**
30184     * Append an Image Slider item
30185     *
30186     * @param        obj          The Image Slider object
30187     * @param        photo_file   photo file path
30188     * @param        func         callback function
30189     * @param        data         callback data
30190     * @return       The Image Slider item handle or NULL
30191     */
30192    EAPI Elm_Imageslider_Item  *elm_imageslider_item_append(Evas_Object *obj, const char *photo_file, Elm_Imageslider_Cb func, void *data) EINA_ARG_NONNULL(1);
30193    /**
30194     * Insert an Image Slider item into the Image Slider Widget by using the given index.
30195     *
30196     * @param        obj                     The Image Slider object
30197     * @param        photo_file      photo file path
30198     * @param        func            callback function
30199     * @param        index           required position
30200     * @param        data            callback data
30201     * @return       The Image Slider item handle or NULL
30202     */
30203    EAPI Elm_Imageslider_Item  *elm_imageslider_item_append_relative(Evas_Object *obj, const char *photo_file, Elm_Imageslider_Cb func, unsigned int index, void *data) EINA_ARG_NONNULL(1);
30204    /**
30205     * Prepend Image Slider item
30206     *
30207     * @param        obj          The Image Slider object
30208     * @param        photo_file   photo file path
30209     * @param        func         callback function
30210     * @param        data         callback data
30211     * @return       The imageslider item handle or NULL
30212     */
30213    EAPI Elm_Imageslider_Item  *elm_imageslider_item_prepend(Evas_Object *obj, const char *photo_file, Elm_Imageslider_Cb func, void *data) EINA_ARG_NONNULL(1);
30214    /**
30215     * Delete the selected Image Slider item
30216     *
30217     * @param it             The selected Image Slider item handle
30218     */
30219    EAPI void                   elm_imageslider_item_del(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
30220    /**
30221     * Get the selected Image Slider item
30222     *
30223     * @param obj            The Image Slider object
30224     * @return The selected Image Slider item or NULL
30225     */
30226    EAPI Elm_Imageslider_Item  *elm_imageslider_selected_item_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
30227    /**
30228     * Get whether an Image Slider item is selected or not
30229     *
30230     * @param it              the selected Image Slider item
30231     * @return EINA_TRUE or EINA_FALSE
30232     */
30233    EAPI Eina_Bool              elm_imageslider_item_selected_get(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
30234    /**
30235     * Set the selected Image Slider item
30236     *
30237     * @param it             The Imaga Slider item
30238     */
30239    EAPI void                   elm_imageslider_item_selected_set(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
30240    /**
30241     * Get the photo file path of given Image Slider item
30242     *
30243     * @param it             The Image Slider item
30244     * @return The photo file path or NULL;
30245     */
30246    EAPI const char            *elm_imageslider_item_photo_file_get(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
30247    /**
30248     * Sets the photo file path of given Image Slider item
30249     *
30250     * @param it         The Image Slider item
30251     * @param photo_file The photo file path or NULL;
30252     */
30253    EAPI Elm_Imageslider_Item  *elm_imageslider_item_prev(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
30254    /**
30255     * Get the previous Image Slider item
30256     *
30257     * @param it             The Image Slider item
30258     * @return The previous Image Slider item or NULL
30259     */
30260    EAPI Elm_Imageslider_Item  *elm_imageslider_item_next(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
30261    /**
30262     * Get the next Image Slider item
30263     *
30264     * @param it             The Image Slider item
30265     * @return The next Image Slider item or NULL
30266     */
30267    EAPI void                   elm_imageslider_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
30268    /**
30269     * Move to the previous Image Slider item
30270     *
30271     * @param obj    The Image Slider object
30272     */
30273    EAPI void                   elm_imageslider_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
30274    /**
30275     * Move to the next Image Slider item
30276     *
30277     * @param obj The Image Slider object
30278     */
30279    EAPI void                   elm_imageslider_item_photo_file_set(Elm_Imageslider_Item *it, const char *photo_file) EINA_ARG_NONNULL(1,2);
30280    /**
30281     * Updates an Image Slider item
30282     *
30283     * @param it The Image Slider item
30284     */
30285    EAPI void                   elm_imageslider_item_update(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
30286    /**
30287     * @}
30288     */
30289 #ifdef __cplusplus
30290 }
30291 #endif
30292
30293 #endif