Merge branch 'master' of 165.213.180.234:/slp/pkgs/e/elementary
[framework/uifw/elementary.git] / src / lib / Elementary.h.in
1 /*
2  *
3  * vim:ts=8:sw=3:sts=3:expandtab:cino=>5n-3f0^-2{2(0W1st0
4  */
5
6 /**
7 @file Elementary.h.in
8 @brief Elementary Widget Library
9 */
10
11 /**
12 @mainpage Elementary
13 @image html  elementary.png
14 @version 0.8.0
15 @date 2008-2011
16
17 @section intro What is Elementary?
18
19 This is a VERY SIMPLE toolkit. It is not meant for writing extensive desktop
20 applications (yet). Small simple ones with simple needs.
21
22 It is meant to make the programmers work almost brainless but give them lots
23 of flexibility.
24
25 @li @ref Start - Go here to quickly get started with writing Apps
26
27 @section organization Organization
28
29 One can divide Elemementary into three main groups:
30 @li @ref infralist - These are modules that deal with Elementary as a whole.
31 @li @ref widgetslist - These are the widgets you'll compose your UI out of.
32 @li @ref containerslist - These are the containers which hold the widgets.
33
34 @section license License
35
36 LGPL v2 (see COPYING in the base of Elementary's source). This applies to
37 all files in the source tree.
38
39 @section ack Acknowledgements
40 There is a lot that goes into making a widget set, and they don't happen out of
41 nothing. It's like trying to make everyone everywhere happy, regardless of age,
42 gender, race or nationality - and that is really tough. So thanks to people and
43 organisations behind this, as listed in the @ref authors page.
44 */
45
46
47 /**
48  * @defgroup Start Getting Started
49  *
50  * To write an Elementary app, you can get started with the following:
51  *
52 @code
53 #include <Elementary.h>
54 EAPI_MAIN int
55 elm_main(int argc, char **argv)
56 {
57    // create window(s) here and do any application init
58    elm_run(); // run main loop
59    elm_shutdown(); // after mainloop finishes running, shutdown
60    return 0; // exit 0 for exit code
61 }
62 ELM_MAIN()
63 @endcode
64  *
65  * To use autotools (which helps in many ways in the long run, like being able
66  * to immediately create releases of your software directly from your tree
67  * and ensure everything needed to build it is there) you will need a
68  * configure.ac, Makefile.am and autogen.sh file.
69  *
70  * configure.ac:
71  *
72 @verbatim
73 AC_INIT(myapp, 0.0.0, myname@mydomain.com)
74 AC_PREREQ(2.52)
75 AC_CONFIG_SRCDIR(configure.ac)
76 AM_CONFIG_HEADER(config.h)
77 AC_PROG_CC
78 AM_INIT_AUTOMAKE(1.6 dist-bzip2)
79 PKG_CHECK_MODULES([ELEMENTARY], elementary)
80 AC_OUTPUT(Makefile)
81 @endverbatim
82  *
83  * Makefile.am:
84  *
85 @verbatim
86 AUTOMAKE_OPTIONS = 1.4 foreign
87 MAINTAINERCLEANFILES = Makefile.in aclocal.m4 config.h.in configure depcomp install-sh missing
88
89 INCLUDES = -I$(top_srcdir)
90
91 bin_PROGRAMS = myapp
92
93 myapp_SOURCES = main.c
94 myapp_LDADD = @ELEMENTARY_LIBS@
95 myapp_CFLAGS = @ELEMENTARY_CFLAGS@
96 @endverbatim
97  *
98  * autogen.sh:
99  *
100 @verbatim
101 #!/bin/sh
102 echo "Running aclocal..." ; aclocal $ACLOCAL_FLAGS || exit 1
103 echo "Running autoheader..." ; autoheader || exit 1
104 echo "Running autoconf..." ; autoconf || exit 1
105 echo "Running automake..." ; automake --add-missing --copy --gnu || exit 1
106 ./configure "$@"
107 @endverbatim
108  *
109  * To generate all the things needed to bootstrap just run:
110  *
111 @verbatim
112 ./autogen.sh
113 @endverbatim
114  *
115  * This will generate Makefile.in's, the confgure script and everything else.
116  * After this it works like all normal autotools projects:
117 @verbatim
118 ./configure
119 make
120 sudo make install
121 @endverbatim
122  *
123  * Note sudo was assumed to get root permissions, as this would install in
124  * /usr/local which is system-owned. Use any way you like to gain root, or
125  * specify a different prefix with configure:
126  *
127 @verbatim
128 ./confiugre --prefix=$HOME/mysoftware
129 @endverbatim
130  *
131  * Also remember that autotools buys you some useful commands like:
132 @verbatim
133 make uninstall
134 @endverbatim
135  *
136  * This uninstalls the software after it was installed with "make install".
137  * It is very useful to clear up what you built if you wish to clean the
138  * system.
139  *
140 @verbatim
141 make distcheck
142 @endverbatim
143  *
144  * This firstly checks if your build tree is "clean" and ready for
145  * distribution. It also builds a tarball (myapp-0.0.0.tar.gz) that is
146  * ready to upload and distribute to the world, that contains the generated
147  * Makefile.in's and configure script. The users do not need to run
148  * autogen.sh - just configure and on. They don't need autotools installed.
149  * This tarball also builds cleanly, has all the sources it needs to build
150  * included (that is sources for your application, not libraries it depends
151  * on like Elementary). It builds cleanly in a buildroot and does not
152  * contain any files that are temporarily generated like binaries and other
153  * build-generated files, so the tarball is clean, and no need to worry
154  * about cleaning up your tree before packaging.
155  *
156 @verbatim
157 make clean
158 @endverbatim
159  *
160  * This cleans up all build files (binaries, objects etc.) from the tree.
161  *
162 @verbatim
163 make distclean
164 @endverbatim
165  *
166  * This cleans out all files from the build and from configure's output too.
167  *
168 @verbatim
169 make maintainer-clean
170 @endverbatim
171  *
172  * This deletes all the files autogen.sh will produce so the tree is clean
173  * to be put into a revision-control system (like CVS, SVN or GIT for example).
174  *
175  * There is a more advanced way of making use of the quicklaunch infrastructure
176  * in Elementary (which will not be covered here due to its more advanced
177  * nature).
178  *
179  * Now let's actually create an interactive "Hello World" gui that you can
180  * click the ok button to exit. It's more code because this now does something
181  * much more significant, but it's still very simple:
182  *
183 @code
184 #include <Elementary.h>
185
186 static void
187 on_done(void *data, Evas_Object *obj, void *event_info)
188 {
189    // quit the mainloop (elm_run function will return)
190    elm_exit();
191 }
192
193 EAPI_MAIN int
194 elm_main(int argc, char **argv)
195 {
196    Evas_Object *win, *bg, *box, *lab, *btn;
197
198    // new window - do the usual and give it a name (hello) and title (Hello)
199    win = elm_win_util_standard_add("hello", "Hello");
200    // when the user clicks "close" on a window there is a request to delete
201    evas_object_smart_callback_add(win, "delete,request", on_done, NULL);
202
203    // add a box object - default is vertical. a box holds children in a row,
204    // either horizontally or vertically. nothing more.
205    box = elm_box_add(win);
206    // make the box hotizontal
207    elm_box_horizontal_set(box, EINA_TRUE);
208    // add object as a resize object for the window (controls window minimum
209    // size as well as gets resized if window is resized)
210    elm_win_resize_object_add(win, box);
211    evas_object_show(box);
212
213    // add a label widget, set the text and put it in the pad frame
214    lab = elm_label_add(win);
215    // set default text of the label
216    elm_object_text_set(lab, "Hello out there world!");
217    // pack the label at the end of the box
218    elm_box_pack_end(box, lab);
219    evas_object_show(lab);
220
221    // add an ok button
222    btn = elm_button_add(win);
223    // set default text of button to "OK"
224    elm_object_text_set(btn, "OK");
225    // pack the button at the end of the box
226    elm_box_pack_end(box, btn);
227    evas_object_show(btn);
228    // call on_done when button is clicked
229    evas_object_smart_callback_add(btn, "clicked", on_done, NULL);
230
231    // now we are done, show the window
232    evas_object_show(win);
233
234    // run the mainloop and process events and callbacks
235    elm_run();
236    return 0;
237 }
238 ELM_MAIN()
239 @endcode
240    *
241    */
242
243 /**
244 @page authors Authors
245 @author Carsten Haitzler <raster@@rasterman.com>
246 @author Gustavo Sverzut Barbieri <barbieri@@profusion.mobi>
247 @author Cedric Bail <cedric.bail@@free.fr>
248 @author Vincent Torri <vtorri@@univ-evry.fr>
249 @author Daniel Kolesa <quaker66@@gmail.com>
250 @author Jaime Thomas <avi.thomas@@gmail.com>
251 @author Swisscom - http://www.swisscom.ch/
252 @author Christopher Michael <devilhorns@@comcast.net>
253 @author Marco Trevisan (Treviño) <mail@@3v1n0.net>
254 @author Michael Bouchaud <michael.bouchaud@@gmail.com>
255 @author Jonathan Atton (Watchwolf) <jonathan.atton@@gmail.com>
256 @author Brian Wang <brian.wang.0721@@gmail.com>
257 @author Mike Blumenkrantz (zmike) <mike@@zentific.com>
258 @author Samsung Electronics <tbd>
259 @author Samsung SAIT <tbd>
260 @author Brett Nash <nash@@nash.id.au>
261 @author Bruno Dilly <bdilly@@profusion.mobi>
262 @author Rafael Fonseca <rfonseca@@profusion.mobi>
263 @author Chuneon Park <hermet@@hermet.pe.kr>
264 @author Woohyun Jung <wh0705.jung@@samsung.com>
265 @author Jaehwan Kim <jae.hwan.kim@@samsung.com>
266 @author Wonguk Jeong <wonguk.jeong@@samsung.com>
267 @author Leandro A. F. Pereira <leandro@@profusion.mobi>
268 @author Helen Fornazier <helen.fornazier@@profusion.mobi>
269 @author Gustavo Lima Chaves <glima@@profusion.mobi>
270 @author Fabiano Fidêncio <fidencio@@profusion.mobi>
271 @author Tiago Falcão <tiago@@profusion.mobi>
272 @author Otavio Pontes <otavio@@profusion.mobi>
273 @author Viktor Kojouharov <vkojouharov@@gmail.com>
274 @author Daniel Juyung Seo (SeoZ) <juyung.seo@@samsung.com> <seojuyung2@@gmail.com>
275 @author Sangho Park <sangho.g.park@@samsung.com> <gouache95@@gmail.com>
276 @author Rajeev Ranjan (Rajeev) <rajeev.r@@samsung.com> <rajeev.jnnce@@gmail.com>
277 @author Seunggyun Kim <sgyun.kim@@samsung.com> <tmdrbs@@gmail.com>
278 @author Sohyun Kim <anna1014.kim@@samsung.com> <sohyun.anna@@gmail.com>
279 @author Jihoon Kim <jihoon48.kim@@samsung.com>
280 @author Jeonghyun Yun (arosis) <jh0506.yun@@samsung.com>
281 @author Tom Hacohen <tom@@stosb.com>
282 @author Aharon Hillel <a.hillel@@partner.samsung.com>
283 @author Jonathan Atton (Watchwolf) <jonathan.atton@@gmail.com>
284 @author Shinwoo Kim <kimcinoo@@gmail.com>
285 @author Govindaraju SM <govi.sm@@samsung.com> <govism@@gmail.com>
286 @author Prince Kumar Dubey <prince.dubey@@samsung.com> <prince.dubey@@gmail.com>
287 @author Sung W. Park <sungwoo@gmail.com>
288 @author Thierry el Borgi <thierry@substantiel.fr>
289 @author Shilpa Singh <shilpa.singh@samsung.com> <shilpasingh.o@gmail.com>
290 @author Chanwook Jung <joey.jung@samsung.com>
291 @author Hyoyoung Chang <hyoyoung.chang@samsung.com>
292 @author Guillaume "Kuri" Friloux <guillaume.friloux@asp64.com>
293 @author Kim Yunhan <spbear@gmail.com>
294
295 Please contact <enlightenment-devel@lists.sourceforge.net> to get in
296 contact with the developers and maintainers.
297  */
298
299 #ifndef ELEMENTARY_H
300 #define ELEMENTARY_H
301
302 /**
303  * @file Elementary.h
304  * @brief Elementary's API
305  *
306  * Elementary API.
307  */
308
309 @ELM_UNIX_DEF@ ELM_UNIX
310 @ELM_WIN32_DEF@ ELM_WIN32
311 @ELM_WINCE_DEF@ ELM_WINCE
312 @ELM_EDBUS_DEF@ ELM_EDBUS
313 @ELM_EFREET_DEF@ ELM_EFREET
314 @ELM_ETHUMB_DEF@ ELM_ETHUMB
315 @ELM_WEB_DEF@ ELM_WEB
316 @ELM_EMAP_DEF@ ELM_EMAP
317 @ELM_DEBUG_DEF@ ELM_DEBUG
318 @ELM_ALLOCA_H_DEF@ ELM_ALLOCA_H
319 @ELM_LIBINTL_H_DEF@ ELM_LIBINTL_H
320
321 /* Standard headers for standard system calls etc. */
322 #include <stdio.h>
323 #include <stdlib.h>
324 #include <unistd.h>
325 #include <string.h>
326 #include <sys/types.h>
327 #include <sys/stat.h>
328 #include <sys/time.h>
329 #include <sys/param.h>
330 #include <dlfcn.h>
331 #include <math.h>
332 #include <fnmatch.h>
333 #include <limits.h>
334 #include <ctype.h>
335 #include <time.h>
336 #include <dirent.h>
337 #include <pwd.h>
338 #include <errno.h>
339
340 #ifdef ELM_UNIX
341 # include <locale.h>
342 # ifdef ELM_LIBINTL_H
343 #  include <libintl.h>
344 # endif
345 # include <signal.h>
346 # include <grp.h>
347 # include <glob.h>
348 #endif
349
350 #ifdef ELM_ALLOCA_H
351 # include <alloca.h>
352 #endif
353
354 #if defined (ELM_WIN32) || defined (ELM_WINCE)
355 # include <malloc.h>
356 # ifndef alloca
357 #  define alloca _alloca
358 # endif
359 #endif
360
361
362 /* EFL headers */
363 #include <Eina.h>
364 #include <Eet.h>
365 #include <Evas.h>
366 #include <Evas_GL.h>
367 #include <Ecore.h>
368 #include <Ecore_Evas.h>
369 #include <Ecore_File.h>
370 #include <Ecore_IMF.h>
371 @ELEMENTARY_ECORE_CON_INC@
372 #include <Edje.h>
373
374 #ifdef ELM_EDBUS
375 # include <E_DBus.h>
376 #endif
377
378 #ifdef ELM_EFREET
379 # include <Efreet.h>
380 # include <Efreet_Mime.h>
381 # include <Efreet_Trash.h>
382 #endif
383
384 #ifdef ELM_ETHUMB
385 # include <Ethumb_Client.h>
386 #endif
387
388 #ifdef ELM_EMAP
389 # include <EMap.h>
390 #endif
391
392 #ifdef EAPI
393 # undef EAPI
394 #endif
395
396 #ifdef _WIN32
397 # ifdef ELEMENTARY_BUILD
398 #  ifdef DLL_EXPORT
399 #   define EAPI __declspec(dllexport)
400 #  else
401 #   define EAPI
402 #  endif /* ! DLL_EXPORT */
403 # else
404 #  define EAPI __declspec(dllimport)
405 # endif /* ! EFL_EVAS_BUILD */
406 #else
407 # ifdef __GNUC__
408 #  if __GNUC__ >= 4
409 #   define EAPI __attribute__ ((visibility("default")))
410 #  else
411 #   define EAPI
412 #  endif
413 # else
414 #  define EAPI
415 # endif
416 #endif /* ! _WIN32 */
417
418 #ifdef _WIN32
419 # define EAPI_MAIN
420 #else
421 # define EAPI_MAIN EAPI
422 #endif
423
424 #define WILL_DEPRECATE /* API is deprecated in upstream EFL, will be deprecated in SLP soon */
425
426 /* allow usage from c++ */
427 #ifdef __cplusplus
428 extern "C" {
429 #endif
430
431 #define ELM_VERSION_MAJOR @VMAJ@
432 #define ELM_VERSION_MINOR @VMIN@
433
434    typedef struct _Elm_Version
435      {
436         int major;
437         int minor;
438         int micro;
439         int revision;
440      } Elm_Version;
441
442    EAPI extern Elm_Version *elm_version;
443
444 /* handy macros */
445 #define ELM_RECTS_INTERSECT(x, y, w, h, xx, yy, ww, hh) (((x) < ((xx) + (ww))) && ((y) < ((yy) + (hh))) && (((x) + (w)) > (xx)) && (((y) + (h)) > (yy)))
446 #define ELM_PI 3.14159265358979323846
447
448    /**
449     * @defgroup General General
450     *
451     * @brief General Elementary API. Functions that don't relate to
452     * Elementary objects specifically.
453     *
454     * Here are documented functions which init/shutdown the library,
455     * that apply to generic Elementary objects, that deal with
456     * configuration, et cetera.
457     *
458     * @ref general_functions_example_page "This" example contemplates
459     * some of these functions.
460     */
461
462    /**
463     * @addtogroup General
464     * @{
465     */
466
467   /**
468    * Defines couple of standard Evas_Object layers to be used
469    * with evas_object_layer_set().
470    *
471    * @note whenever extending with new values, try to keep some padding
472    *       to siblings so there is room for further extensions.
473    */
474   typedef enum _Elm_Object_Layer
475     {
476        ELM_OBJECT_LAYER_BACKGROUND = EVAS_LAYER_MIN + 64, /**< where to place backgrounds */
477        ELM_OBJECT_LAYER_DEFAULT = 0, /**< Evas_Object default layer (and thus for Elementary) */
478        ELM_OBJECT_LAYER_FOCUS = EVAS_LAYER_MAX - 128, /**< where focus object visualization is */
479        ELM_OBJECT_LAYER_TOOLTIP = EVAS_LAYER_MAX - 64, /**< where to show tooltips */
480        ELM_OBJECT_LAYER_CURSOR = EVAS_LAYER_MAX - 32, /**< where to show cursors */
481        ELM_OBJECT_LAYER_LAST /**< last layer known by Elementary */
482     } Elm_Object_Layer;
483
484 /**************************************************************************/
485    EAPI extern int ELM_ECORE_EVENT_ETHUMB_CONNECT;
486
487    /**
488     * Emitted when any Elementary's policy value is changed.
489     */
490    EAPI extern int ELM_EVENT_POLICY_CHANGED;
491
492    /**
493     * @typedef Elm_Event_Policy_Changed
494     *
495     * Data on the event when an Elementary policy has changed
496     */
497     typedef struct _Elm_Event_Policy_Changed Elm_Event_Policy_Changed;
498
499    /**
500     * @struct _Elm_Event_Policy_Changed
501     *
502     * Data on the event when an Elementary policy has changed
503     */
504     struct _Elm_Event_Policy_Changed
505      {
506         unsigned int policy; /**< the policy identifier */
507         int          new_value; /**< value the policy had before the change */
508         int          old_value; /**< new value the policy got */
509     };
510
511    /**
512     * Policy identifiers.
513     */
514     typedef enum _Elm_Policy
515     {
516         ELM_POLICY_QUIT, /**< under which circumstances the application
517                           * should quit automatically. @see
518                           * Elm_Policy_Quit.
519                           */
520         ELM_POLICY_LAST
521     } Elm_Policy; /**< Elementary policy identifiers/groups enumeration.  @see elm_policy_set()
522  */
523
524    typedef enum _Elm_Policy_Quit
525      {
526         ELM_POLICY_QUIT_NONE = 0, /**< never quit the application
527                                    * automatically */
528         ELM_POLICY_QUIT_LAST_WINDOW_CLOSED /**< quit when the
529                                             * application's last
530                                             * window is closed */
531      } Elm_Policy_Quit; /**< Possible values for the #ELM_POLICY_QUIT policy */
532
533    typedef enum _Elm_Focus_Direction
534      {
535         ELM_FOCUS_PREVIOUS,
536         ELM_FOCUS_NEXT
537      } Elm_Focus_Direction;
538
539    typedef enum _Elm_Text_Format
540      {
541         ELM_TEXT_FORMAT_PLAIN_UTF8,
542         ELM_TEXT_FORMAT_MARKUP_UTF8
543      } Elm_Text_Format;
544
545    /**
546     * Line wrapping types.
547     */
548    typedef enum _Elm_Wrap_Type
549      {
550         ELM_WRAP_NONE = 0, /**< No wrap - value is zero */
551         ELM_WRAP_CHAR, /**< Char wrap - wrap between characters */
552         ELM_WRAP_WORD, /**< Word wrap - wrap in allowed wrapping points (as defined in the unicode standard) */
553         ELM_WRAP_MIXED, /**< Mixed wrap - Word wrap, and if that fails, char wrap. */
554         ELM_WRAP_LAST
555      } Elm_Wrap_Type;
556
557    typedef enum
558      {
559         ELM_INPUT_PANEL_LAYOUT_NORMAL,          /**< Default layout */
560         ELM_INPUT_PANEL_LAYOUT_NUMBER,          /**< Number layout */
561         ELM_INPUT_PANEL_LAYOUT_EMAIL,           /**< Email layout */
562         ELM_INPUT_PANEL_LAYOUT_URL,             /**< URL layout */
563         ELM_INPUT_PANEL_LAYOUT_PHONENUMBER,     /**< Phone Number layout */
564         ELM_INPUT_PANEL_LAYOUT_IP,              /**< IP layout */
565         ELM_INPUT_PANEL_LAYOUT_MONTH,           /**< Month layout */
566         ELM_INPUT_PANEL_LAYOUT_NUMBERONLY,      /**< Number Only layout */
567         ELM_INPUT_PANEL_LAYOUT_INVALID
568      } Elm_Input_Panel_Layout;
569
570    typedef enum
571      {
572         ELM_AUTOCAPITAL_TYPE_NONE,
573         ELM_AUTOCAPITAL_TYPE_WORD,
574         ELM_AUTOCAPITAL_TYPE_SENTENCE,
575         ELM_AUTOCAPITAL_TYPE_ALLCHARACTER,
576      } Elm_Autocapital_Type;
577
578    /**
579     * @typedef Elm_Object_Item
580     * An Elementary Object item handle.
581     * @ingroup General
582     */
583    typedef struct _Elm_Object_Item Elm_Object_Item;
584
585
586    /**
587     * Called back when a widget's tooltip is activated and needs content.
588     * @param data user-data given to elm_object_tooltip_content_cb_set()
589     * @param obj owner widget.
590     * @param tooltip The tooltip object (affix content to this!)
591     */
592    typedef Evas_Object *(*Elm_Tooltip_Content_Cb) (void *data, Evas_Object *obj, Evas_Object *tooltip);
593
594    /**
595     * Called back when a widget's item tooltip is activated and needs content.
596     * @param data user-data given to elm_object_tooltip_content_cb_set()
597     * @param obj owner widget.
598     * @param tooltip The tooltip object (affix content to this!)
599     * @param item context dependent item. As an example, if tooltip was
600     *        set on Elm_List_Item, then it is of this type.
601     */
602    typedef Evas_Object *(*Elm_Tooltip_Item_Content_Cb) (void *data, Evas_Object *obj, Evas_Object *tooltip, void *item);
603
604    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. */
605
606 #ifndef ELM_LIB_QUICKLAUNCH
607 #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 */
608 #else
609 #define ELM_MAIN() int main(int argc, char **argv) {return elm_quicklaunch_fallback(argc, argv);} /**< macro to be used after the elm_main() function */
610 #endif
611
612 /**************************************************************************/
613    /* General calls */
614
615    /**
616     * Initialize Elementary
617     *
618     * @param[in] argc System's argument count value
619     * @param[in] argv System's pointer to array of argument strings
620     * @return The init counter value.
621     *
622     * This function initializes Elementary and increments a counter of
623     * the number of calls to it. It returns the new counter's value.
624     *
625     * @warning This call is exported only for use by the @c ELM_MAIN()
626     * macro. There is no need to use this if you use this macro (which
627     * is highly advisable). An elm_main() should contain the entry
628     * point code for your application, having the same prototype as
629     * elm_init(), and @b not being static (putting the @c EAPI symbol
630     * in front of its type declaration is advisable). The @c
631     * ELM_MAIN() call should be placed just after it.
632     *
633     * Example:
634     * @dontinclude bg_example_01.c
635     * @skip static void
636     * @until ELM_MAIN
637     *
638     * See the full @ref bg_example_01_c "example".
639     *
640     * @see elm_shutdown().
641     * @ingroup General
642     */
643    EAPI int          elm_init(int argc, char **argv);
644
645    /**
646     * Shut down Elementary
647     *
648     * @return The init counter value.
649     *
650     * This should be called at the end of your application, just
651     * before it ceases to do any more processing. This will clean up
652     * any permanent resources your application may have allocated via
653     * Elementary that would otherwise persist.
654     *
655     * @see elm_init() for an example
656     *
657     * @ingroup General
658     */
659    EAPI int          elm_shutdown(void);
660
661    /**
662     * Run Elementary's main loop
663     *
664     * This call should be issued just after all initialization is
665     * completed. This function will not return until elm_exit() is
666     * called. It will keep looping, running the main
667     * (event/processing) loop for Elementary.
668     *
669     * @see elm_init() for an example
670     *
671     * @ingroup General
672     */
673    EAPI void         elm_run(void);
674
675    /**
676     * Exit Elementary's main loop
677     *
678     * If this call is issued, it will flag the main loop to cease
679     * processing and return back to its parent function (usually your
680     * elm_main() function).
681     *
682     * @see elm_init() for an example. There, just after a request to
683     * close the window comes, the main loop will be left.
684     *
685     * @note By using the appropriate #ELM_POLICY_QUIT on your Elementary
686     * applications, you'll be able to get this function called automatically for you.
687     *
688     * @ingroup General
689     */
690    EAPI void         elm_exit(void);
691
692    /**
693     * Provide information in order to make Elementary determine the @b
694     * run time location of the software in question, so other data files
695     * such as images, sound files, executable utilities, libraries,
696     * modules and locale files can be found.
697     *
698     * @param mainfunc This is your application's main function name,
699     *        whose binary's location is to be found. Providing @c NULL
700     *        will make Elementary not to use it
701     * @param dom This will be used as the application's "domain", in the
702     *        form of a prefix to any environment variables that may
703     *        override prefix detection and the directory name, inside the
704     *        standard share or data directories, where the software's
705     *        data files will be looked for.
706     * @param checkfile This is an (optional) magic file's path to check
707     *        for existence (and it must be located in the data directory,
708     *        under the share directory provided above). Its presence will
709     *        help determine the prefix found was correct. Pass @c NULL if
710     *        the check is not to be done.
711     *
712     * This function allows one to re-locate the application somewhere
713     * else after compilation, if the developer wishes for easier
714     * distribution of pre-compiled binaries.
715     *
716     * The prefix system is designed to locate where the given software is
717     * installed (under a common path prefix) at run time and then report
718     * specific locations of this prefix and common directories inside
719     * this prefix like the binary, library, data and locale directories,
720     * through the @c elm_app_*_get() family of functions.
721     *
722     * Call elm_app_info_set() early on before you change working
723     * directory or anything about @c argv[0], so it gets accurate
724     * information.
725     *
726     * It will then try and trace back which file @p mainfunc comes from,
727     * if provided, to determine the application's prefix directory.
728     *
729     * The @p dom parameter provides a string prefix to prepend before
730     * environment variables, allowing a fallback to @b specific
731     * environment variables to locate the software. You would most
732     * probably provide a lowercase string there, because it will also
733     * serve as directory domain, explained next. For environment
734     * variables purposes, this string is made uppercase. For example if
735     * @c "myapp" is provided as the prefix, then the program would expect
736     * @c "MYAPP_PREFIX" as a master environment variable to specify the
737     * exact install prefix for the software, or more specific environment
738     * variables like @c "MYAPP_BIN_DIR", @c "MYAPP_LIB_DIR", @c
739     * "MYAPP_DATA_DIR" and @c "MYAPP_LOCALE_DIR", which could be set by
740     * the user or scripts before launching. If not provided (@c NULL),
741     * environment variables will not be used to override compiled-in
742     * defaults or auto detections.
743     *
744     * The @p dom string also provides a subdirectory inside the system
745     * shared data directory for data files. For example, if the system
746     * directory is @c /usr/local/share, then this directory name is
747     * appended, creating @c /usr/local/share/myapp, if it @p was @c
748     * "myapp". It is expected that the application installs data files in
749     * this directory.
750     *
751     * The @p checkfile is a file name or path of something inside the
752     * share or data directory to be used to test that the prefix
753     * detection worked. For example, your app will install a wallpaper
754     * image as @c /usr/local/share/myapp/images/wallpaper.jpg and so to
755     * check that this worked, provide @c "images/wallpaper.jpg" as the @p
756     * checkfile string.
757     *
758     * @see elm_app_compile_bin_dir_set()
759     * @see elm_app_compile_lib_dir_set()
760     * @see elm_app_compile_data_dir_set()
761     * @see elm_app_compile_locale_set()
762     * @see elm_app_prefix_dir_get()
763     * @see elm_app_bin_dir_get()
764     * @see elm_app_lib_dir_get()
765     * @see elm_app_data_dir_get()
766     * @see elm_app_locale_dir_get()
767     */
768    EAPI void         elm_app_info_set(void *mainfunc, const char *dom, const char *checkfile);
769
770    /**
771     * Provide information on the @b fallback application's binaries
772     * directory, in scenarios where they get overriden by
773     * elm_app_info_set().
774     *
775     * @param dir The path to the default binaries directory (compile time
776     * one)
777     *
778     * @note Elementary will as well use this path to determine actual
779     * names of binaries' directory paths, maybe changing it to be @c
780     * something/local/bin instead of @c something/bin, only, for
781     * example.
782     *
783     * @warning You should call this function @b before
784     * elm_app_info_set().
785     */
786    EAPI void         elm_app_compile_bin_dir_set(const char *dir);
787
788    /**
789     * Provide information on the @b fallback application's libraries
790     * directory, on scenarios where they get overriden by
791     * elm_app_info_set().
792     *
793     * @param dir The path to the default libraries directory (compile
794     * time one)
795     *
796     * @note Elementary will as well use this path to determine actual
797     * names of libraries' directory paths, maybe changing it to be @c
798     * something/lib32 or @c something/lib64 instead of @c something/lib,
799     * only, for example.
800     *
801     * @warning You should call this function @b before
802     * elm_app_info_set().
803     */
804    EAPI void         elm_app_compile_lib_dir_set(const char *dir);
805
806    /**
807     * Provide information on the @b fallback application's data
808     * directory, on scenarios where they get overriden by
809     * elm_app_info_set().
810     *
811     * @param dir The path to the default data directory (compile time
812     * one)
813     *
814     * @note Elementary will as well use this path to determine actual
815     * names of data directory paths, maybe changing it to be @c
816     * something/local/share instead of @c something/share, only, for
817     * example.
818     *
819     * @warning You should call this function @b before
820     * elm_app_info_set().
821     */
822    EAPI void         elm_app_compile_data_dir_set(const char *dir);
823
824    /**
825     * Provide information on the @b fallback application's locale
826     * directory, on scenarios where they get overriden by
827     * elm_app_info_set().
828     *
829     * @param dir The path to the default locale directory (compile time
830     * one)
831     *
832     * @warning You should call this function @b before
833     * elm_app_info_set().
834     */
835    EAPI void         elm_app_compile_locale_set(const char *dir);
836
837    /**
838     * Retrieve the application's run time prefix directory, as set by
839     * elm_app_info_set() and the way (environment) the application was
840     * run from.
841     *
842     * @return The directory prefix the application is actually using.
843     */
844    EAPI const char  *elm_app_prefix_dir_get(void);
845
846    /**
847     * Retrieve the application's run time binaries prefix directory, as
848     * set by elm_app_info_set() and the way (environment) the application
849     * was run from.
850     *
851     * @return The binaries directory prefix the application is actually
852     * using.
853     */
854    EAPI const char  *elm_app_bin_dir_get(void);
855
856    /**
857     * Retrieve the application's run time libraries prefix directory, as
858     * set by elm_app_info_set() and the way (environment) the application
859     * was run from.
860     *
861     * @return The libraries directory prefix the application is actually
862     * using.
863     */
864    EAPI const char  *elm_app_lib_dir_get(void);
865
866    /**
867     * Retrieve the application's run time data prefix directory, as
868     * set by elm_app_info_set() and the way (environment) the application
869     * was run from.
870     *
871     * @return The data directory prefix the application is actually
872     * using.
873     */
874    EAPI const char  *elm_app_data_dir_get(void);
875
876    /**
877     * Retrieve the application's run time locale prefix directory, as
878     * set by elm_app_info_set() and the way (environment) the application
879     * was run from.
880     *
881     * @return The locale directory prefix the application is actually
882     * using.
883     */
884    EAPI const char  *elm_app_locale_dir_get(void);
885
886    EAPI void         elm_quicklaunch_mode_set(Eina_Bool ql_on);
887    EAPI Eina_Bool    elm_quicklaunch_mode_get(void);
888    EAPI int          elm_quicklaunch_init(int argc, char **argv);
889    EAPI int          elm_quicklaunch_sub_init(int argc, char **argv);
890    EAPI int          elm_quicklaunch_sub_shutdown(void);
891    EAPI int          elm_quicklaunch_shutdown(void);
892    EAPI void         elm_quicklaunch_seed(void);
893    EAPI Eina_Bool    elm_quicklaunch_prepare(int argc, char **argv);
894    EAPI Eina_Bool    elm_quicklaunch_fork(int argc, char **argv, char *cwd, void (postfork_func) (void *data), void *postfork_data);
895    EAPI void         elm_quicklaunch_cleanup(void);
896    EAPI int          elm_quicklaunch_fallback(int argc, char **argv);
897    EAPI char        *elm_quicklaunch_exe_path_get(const char *exe);
898
899    EAPI Eina_Bool    elm_need_efreet(void);
900    EAPI Eina_Bool    elm_need_e_dbus(void);
901
902    /**
903     * This must be called before any other function that deals with
904     * elm_thumb objects or ethumb_client instances.
905     *
906     * @ingroup Thumb
907     */
908    EAPI Eina_Bool    elm_need_ethumb(void);
909
910    /**
911     * This must be called before any other function that deals with
912     * elm_web objects or ewk_view instances.
913     *
914     * @ingroup Web
915     */
916    EAPI Eina_Bool    elm_need_web(void);
917
918    /**
919     * Set a new policy's value (for a given policy group/identifier).
920     *
921     * @param policy policy identifier, as in @ref Elm_Policy.
922     * @param value policy value, which depends on the identifier
923     *
924     * @return @c EINA_TRUE on success or @c EINA_FALSE, on error.
925     *
926     * Elementary policies define applications' behavior,
927     * somehow. These behaviors are divided in policy groups (see
928     * #Elm_Policy enumeration). This call will emit the Ecore event
929     * #ELM_EVENT_POLICY_CHANGED, which can be hooked at with
930     * handlers. An #Elm_Event_Policy_Changed struct will be passed,
931     * then.
932     *
933     * @note Currently, we have only one policy identifier/group
934     * (#ELM_POLICY_QUIT), which has two possible values.
935     *
936     * @ingroup General
937     */
938    EAPI Eina_Bool    elm_policy_set(unsigned int policy, int value);
939
940    /**
941     * Gets the policy value for given policy identifier.
942     *
943     * @param policy policy identifier, as in #Elm_Policy.
944     * @return The currently set policy value, for that
945     * identifier. Will be @c 0 if @p policy passed is invalid.
946     *
947     * @ingroup General
948     */
949    EAPI int          elm_policy_get(unsigned int policy);
950
951    /**
952     * Change the language of the current application
953     *
954     * The @p lang passed must be the full name of the locale to use, for
955     * example "en_US.utf8" or "es_ES@euro".
956     *
957     * Changing language with this function will make Elementary run through
958     * all its widgets, translating strings set with
959     * elm_object_domain_translatable_text_part_set(). This way, an entire
960     * UI can have its language changed without having to restart the program.
961     *
962     * For more complex cases, like having formatted strings that need
963     * translation, widgets will also emit a "language,changed" signal that
964     * the user can listen to to manually translate the text.
965     *
966     * @param lang Language to set, must be the full name of the locale
967     *
968     * @ingroup General
969     */
970    EAPI void         elm_language_set(const char *lang);
971
972    /**
973     * Set a label of an object
974     *
975     * @param obj The Elementary object
976     * @param part The text part name to set (NULL for the default label)
977     * @param label The new text of the label
978     *
979     * @note Elementary objects may have many labels (e.g. Action Slider)
980     * @deprecated Use elm_object_part_text_set() instead.
981     * @ingroup General
982     */
983    EINA_DEPRECATED EAPI void elm_object_text_part_set(Evas_Object *obj, const char *part, const char *label);
984
985    /**
986     * Set a label of an object
987     *
988     * @param obj The Elementary object
989     * @param part The text part name to set (NULL for the default label)
990     * @param label The new text of the label
991     *
992     * @note Elementary objects may have many labels (e.g. Action Slider)
993     *
994     * @ingroup General
995     */
996    EAPI void elm_object_part_text_set(Evas_Object *obj, const char *part, const char *label);
997
998 #define elm_object_text_set(obj, label) elm_object_part_text_set((obj), NULL, (label))
999
1000    /**
1001     * Get a label of an object
1002     *
1003     * @param obj The Elementary object
1004     * @param part The text part name to get (NULL for the default label)
1005     * @return text of the label or NULL for any error
1006     *
1007     * @note Elementary objects may have many labels (e.g. Action Slider)
1008     * @deprecated Use elm_object_part_text_get() instead.
1009     * @ingroup General
1010     */
1011    EINA_DEPRECATED EAPI const char  *elm_object_text_part_get(const Evas_Object *obj, const char *part);
1012
1013    /**
1014     * Get a label of an object
1015     *
1016     * @param obj The Elementary object
1017     * @param part The text part name to get (NULL for the default label)
1018     * @return text of the label or NULL for any error
1019     *
1020     * @note Elementary objects may have many labels (e.g. Action Slider)
1021     *
1022     * @ingroup General
1023     */
1024    EAPI const char  *elm_object_part_text_get(const Evas_Object *obj, const char *part);
1025
1026 #define elm_object_text_get(obj) elm_object_part_text_get((obj), NULL)
1027
1028    /**
1029     * Set the text for an objects' part, marking it as translatable.
1030     *
1031     * The string to set as @p text must be the original one. Do not pass the
1032     * return of @c gettext() here. Elementary will translate the string
1033     * internally and set it on the object using elm_object_part_text_set(),
1034     * also storing the original string so that it can be automatically
1035     * translated when the language is changed with elm_language_set().
1036     *
1037     * The @p domain will be stored along to find the translation in the
1038     * correct catalog. It can be NULL, in which case it will use whatever
1039     * domain was set by the application with @c textdomain(). This is useful
1040     * in case you are building a library on top of Elementary that will have
1041     * its own translatable strings, that should not be mixed with those of
1042     * programs using the library.
1043     *
1044     * @param obj The object containing the text part
1045     * @param part The name of the part to set
1046     * @param domain The translation domain to use
1047     * @param text The original, non-translated text to set
1048     *
1049     * @ingroup General
1050     */
1051    EAPI void         elm_object_domain_translatable_text_part_set(Evas_Object *obj, const char *part, const char *domain, const char *text);
1052
1053 #define elm_object_domain_translatable_text_set(obj, domain, text) elm_object_domain_translatable_text_part_set((obj), NULL, (domain), (text))
1054
1055 #define elm_object_translatable_text_set(obj, text) elm_object_domain_translatable_text_part_set((obj), NULL, NULL, (text))
1056
1057    /**
1058     * Gets the original string set as translatable for an object
1059     *
1060     * When setting translated strings, the function elm_object_part_text_get()
1061     * will return the translation returned by @c gettext(). To get the
1062     * original string use this function.
1063     *
1064     * @param obj The object
1065     * @param part The name of the part that was set
1066     *
1067     * @return The original, untranslated string
1068     *
1069     * @ingroup General
1070     */
1071    EAPI const char  *elm_object_translatable_text_part_get(const Evas_Object *obj, const char *part);
1072
1073 #define elm_object_translatable_text_get(obj) elm_object_translatable_text_part_get((obj), NULL)
1074
1075    /**
1076     * Set a content of an object
1077     *
1078     * @param obj The Elementary object
1079     * @param part The content part name to set (NULL for the default content)
1080     * @param content The new content of the object
1081     *
1082     * @note Elementary objects may have many contents
1083     * @deprecated Use elm_object_part_content_set instead.
1084     * @ingroup General
1085     */
1086    EINA_DEPRECATED EAPI void elm_object_content_part_set(Evas_Object *obj, const char *part, Evas_Object *content);
1087
1088    /**
1089     * Set a content of an object
1090     *
1091     * @param obj The Elementary object
1092     * @param part The content part name to set (NULL for the default content)
1093     * @param content The new content of the object
1094     *
1095     * @note Elementary objects may have many contents
1096     *
1097     * @ingroup General
1098     */
1099    EAPI void elm_object_part_content_set(Evas_Object *obj, const char *part, Evas_Object *content);
1100
1101 #define elm_object_content_set(obj, content) elm_object_part_content_set((obj), NULL, (content))
1102
1103    /**
1104     * Get a content of an object
1105     *
1106     * @param obj The Elementary object
1107     * @param item The content part name to get (NULL for the default content)
1108     * @return content of the object or NULL for any error
1109     *
1110     * @note Elementary objects may have many contents
1111     * @deprecated Use elm_object_part_content_get instead.
1112     * @ingroup General
1113     */
1114    EINA_DEPRECATED EAPI Evas_Object *elm_object_content_part_get(const Evas_Object *obj, const char *part);
1115
1116    /**
1117     * Get a content of an object
1118     *
1119     * @param obj The Elementary object
1120     * @param item The content part name to get (NULL for the default content)
1121     * @return content of the object or NULL for any error
1122     *
1123     * @note Elementary objects may have many contents
1124     *
1125     * @ingroup General
1126     */
1127    EAPI Evas_Object *elm_object_part_content_get(const Evas_Object *obj, const char *part);
1128
1129 #define elm_object_content_get(obj) elm_object_part_content_get((obj), NULL)
1130
1131    /**
1132     * Unset a content of an object
1133     *
1134     * @param obj The Elementary object
1135     * @param item The content part name to unset (NULL for the default content)
1136     *
1137     * @note Elementary objects may have many contents
1138     * @deprecated Use elm_object_part_content_unset instead.
1139     * @ingroup General
1140     */
1141    EINA_DEPRECATED EAPI Evas_Object *elm_object_content_part_unset(Evas_Object *obj, const char *part);
1142
1143    /**
1144     * Unset a content of an object
1145     *
1146     * @param obj The Elementary object
1147     * @param item The content part name to unset (NULL for the default content)
1148     *
1149     * @note Elementary objects may have many contents
1150     *
1151     * @ingroup General
1152     */
1153    EAPI Evas_Object *elm_object_part_content_unset(Evas_Object *obj, const char *part);
1154
1155 #define elm_object_content_unset(obj) elm_object_part_content_unset((obj), NULL)
1156
1157    /**
1158     * Set the text to read out when in accessibility mode
1159     *
1160     * @param obj The object which is to be described
1161     * @param txt The text that describes the widget to people with poor or no vision
1162     *
1163     * @ingroup General
1164     */
1165    EAPI void elm_object_access_info_set(Evas_Object *obj, const char *txt);
1166
1167    /**
1168     * Get the widget object's handle which contains a given item
1169     *
1170     * @param item The Elementary object item
1171     * @return The widget object
1172     *
1173     * @note This returns the widget object itself that an item belongs to.
1174     *
1175     * @ingroup General
1176     */
1177    EAPI Evas_Object *elm_object_item_object_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
1178
1179    /**
1180     * Set a content of an object item
1181     *
1182     * @param it The Elementary object item
1183     * @param part The content part name to set (NULL for the default content)
1184     * @param content The new content of the object item
1185     *
1186     * @note Elementary object items may have many contents
1187     * @deprecated Use elm_object_item_part_content_set instead.
1188     * @ingroup General
1189     */
1190    EINA_DEPRECATED EAPI void elm_object_item_content_part_set(Elm_Object_Item *it, const char *part, Evas_Object *content);
1191
1192    /**
1193     * Set a content of an object item
1194     *
1195     * @param it The Elementary object item
1196     * @param part The content part name to set (NULL for the default content)
1197     * @param content The new content of the object item
1198     *
1199     * @note Elementary object items may have many contents
1200     *
1201     * @ingroup General
1202     */
1203    EAPI void elm_object_item_part_content_set(Elm_Object_Item *it, const char *part, Evas_Object *content);
1204
1205 #define elm_object_item_content_set(it, content) elm_object_item_part_content_set((it), NULL, (content))
1206
1207    /**
1208     * Get a content of an object item
1209     *
1210     * @param it The Elementary object item
1211     * @param part The content part name to unset (NULL for the default content)
1212     * @return content of the object item or NULL for any error
1213     *
1214     * @note Elementary object items may have many contents
1215     * @deprecated Use elm_object_item_part_content_get instead.
1216     * @ingroup General
1217     */
1218    EAPI Evas_Object *elm_object_item_content_part_get(const Elm_Object_Item *it, const char *part);
1219
1220    /**
1221     * Get a content of an object item
1222     *
1223     * @param it The Elementary object item
1224     * @param part The content part name to unset (NULL for the default content)
1225     * @return content of the object item or NULL for any error
1226     *
1227     * @note Elementary object items may have many contents
1228     *
1229     * @ingroup General
1230     */
1231    EAPI Evas_Object *elm_object_item_part_content_get(const Elm_Object_Item *it, const char *part);
1232
1233 #define elm_object_item_content_get(it) elm_object_item_part_content_get((it), NULL)
1234
1235    /**
1236     * Unset a content of an object item
1237     *
1238     * @param it The Elementary object item
1239     * @param part The content part name to unset (NULL for the default content)
1240     *
1241     * @note Elementary object items may have many contents
1242     * @deprecated Use elm_object_item_part_content_unset instead.
1243     * @ingroup General
1244     */
1245    EINA_DEPRECATED EAPI Evas_Object *elm_object_item_content_part_unset(Elm_Object_Item *it, const char *part);
1246
1247    /**
1248     * Unset a content of an object item
1249     *
1250     * @param it The Elementary object item
1251     * @param part The content part name to unset (NULL for the default content)
1252     *
1253     * @note Elementary object items may have many contents
1254     *
1255     * @ingroup General
1256     */
1257    EAPI Evas_Object *elm_object_item_part_content_unset(Elm_Object_Item *it, const char *part);
1258
1259 #define elm_object_item_content_unset(it) elm_object_item_part_content_unset((it), NULL)
1260
1261    /**
1262     * Set a label of an object item
1263     *
1264     * @param it The Elementary object item
1265     * @param part The text part name to set (NULL for the default label)
1266     * @param label The new text of the label
1267     *
1268     * @note Elementary object items may have many labels
1269     * @deprecated Use elm_object_item_part_text_set instead.
1270     * @ingroup General
1271     */
1272    WILL_DEPRECATE  EAPI void elm_object_item_text_part_set(Elm_Object_Item *it, const char *part, const char *label);
1273
1274    /**
1275     * Set a label of an object item
1276     *
1277     * @param it The Elementary object item
1278     * @param part The text part name to set (NULL for the default label)
1279     * @param label The new text of the label
1280     *
1281     * @note Elementary object items may have many labels
1282     *
1283     * @ingroup General
1284     */
1285    EAPI void elm_object_item_part_text_set(Elm_Object_Item *it, const char *part, const char *label);
1286
1287 #define elm_object_item_text_set(it, label) elm_object_item_part_text_set((it), NULL, (label))
1288
1289    /**
1290     * Get a label of an object item
1291     *
1292     * @param it The Elementary object item
1293     * @param part The text part name to get (NULL for the default label)
1294     * @return text of the label or NULL for any error
1295     *
1296     * @note Elementary object items may have many labels
1297     * @deprecated Use elm_object_item_part_text_get instead.
1298     * @ingroup General
1299     */
1300    WILL_DEPRECATE  EAPI const char *elm_object_item_text_part_get(const Elm_Object_Item *it, const char *part);
1301    /**
1302     * Get a label of an object item
1303     *
1304     * @param it The Elementary object item
1305     * @param part The text part name to get (NULL for the default label)
1306     * @return text of the label or NULL for any error
1307     *
1308     * @note Elementary object items may have many labels
1309     *
1310     * @ingroup General
1311     */
1312    EAPI const char *elm_object_item_part_text_get(const Elm_Object_Item *it, const char *part);
1313
1314    /**
1315     * Set the text to read out when in accessibility mode
1316     *
1317     * @param obj The object which is to be described
1318     * @param txt The text that describes the widget to people with poor or no vision
1319     *
1320     * @ingroup General
1321     */
1322    EAPI void elm_object_access_info_set(Evas_Object *obj, const char *txt);
1323
1324    /**
1325     * Set the text to read out when in accessibility mode
1326     *
1327     * @param it The object item which is to be described
1328     * @param txt The text that describes the widget to people with poor or no vision
1329     *
1330     * @ingroup General
1331     */
1332    EAPI void elm_object_item_access_info_set(Elm_Object_Item *it, const char *txt);
1333
1334 #define elm_object_item_text_get(it) elm_object_item_part_text_get((it), NULL)
1335
1336    /**
1337     * Set the text to read out when in accessibility mode
1338     *
1339     * @param it The object item which is to be described
1340     * @param txt The text that describes the widget to people with poor or no vision
1341     *
1342     * @ingroup General
1343     */
1344    EAPI void elm_object_item_access_info_set(Elm_Object_Item *it, const char *txt);
1345
1346    /**
1347     * Get the data associated with an object item
1348     * @param it The Elementary object item
1349     * @return The data associated with @p it
1350     *
1351     * @ingroup General
1352     */
1353    EAPI void *elm_object_item_data_get(const Elm_Object_Item *it);
1354
1355    /**
1356     * Set the data associated with an object item
1357     * @param it The Elementary object item
1358     * @param data The data to be associated with @p it
1359     *
1360     * @ingroup General
1361     */
1362    EAPI void elm_object_item_data_set(Elm_Object_Item *it, void *data);
1363
1364    /**
1365     * Send a signal to the edje object of the widget item.
1366     *
1367     * This function sends a signal to the edje object of the obj item. An
1368     * edje program can respond to a signal by specifying matching
1369     * 'signal' and 'source' fields.
1370     *
1371     * @param it The Elementary object item
1372     * @param emission The signal's name.
1373     * @param source The signal's source.
1374     * @ingroup General
1375     */
1376    EAPI void elm_object_item_signal_emit(Elm_Object_Item *it, const char *emission, const char *source) EINA_ARG_NONNULL(1);
1377
1378    /**
1379     * Set the disabled state of an widget item.
1380     *
1381     * @param obj The Elementary object item
1382     * @param disabled The state to put in in: @c EINA_TRUE for
1383     *        disabled, @c EINA_FALSE for enabled
1384     *
1385     * Elementary object item can be @b disabled, in which state they won't
1386     * receive input and, in general, will be themed differently from
1387     * their normal state, usually greyed out. Useful for contexts
1388     * where you don't want your users to interact with some of the
1389     * parts of you interface.
1390     *
1391     * This sets the state for the widget item, either disabling it or
1392     * enabling it back.
1393     *
1394     * @ingroup Styles
1395     */
1396    EAPI void elm_object_item_disabled_set(Elm_Object_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
1397
1398    /**
1399     * Get the disabled state of an widget item.
1400     *
1401     * @param obj The Elementary object
1402     * @return @c EINA_TRUE, if the widget item is disabled, @c EINA_FALSE
1403     *            if it's enabled (or on errors)
1404     *
1405     * This gets the state of the widget, which might be enabled or disabled.
1406     *
1407     * @ingroup Styles
1408     */
1409    EAPI Eina_Bool    elm_object_item_disabled_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
1410
1411    /**
1412     * @}
1413     */
1414
1415    /**
1416     * @defgroup Caches Caches
1417     *
1418     * These are functions which let one fine-tune some cache values for
1419     * Elementary applications, thus allowing for performance adjustments.
1420     *
1421     * @{
1422     */
1423
1424    /**
1425     * @brief Flush all caches.
1426     *
1427     * Frees all data that was in cache and is not currently being used to reduce
1428     * memory usage. This frees Edje's, Evas' and Eet's cache. This is equivalent
1429     * to calling all of the following functions:
1430     * @li edje_file_cache_flush()
1431     * @li edje_collection_cache_flush()
1432     * @li eet_clearcache()
1433     * @li evas_image_cache_flush()
1434     * @li evas_font_cache_flush()
1435     * @li evas_render_dump()
1436     * @note Evas caches are flushed for every canvas associated with a window.
1437     *
1438     * @ingroup Caches
1439     */
1440    EAPI void         elm_all_flush(void);
1441
1442    /**
1443     * Get the configured cache flush interval time
1444     *
1445     * This gets the globally configured cache flush interval time, in
1446     * ticks
1447     *
1448     * @return The cache flush interval time
1449     * @ingroup Caches
1450     *
1451     * @see elm_all_flush()
1452     */
1453    EAPI int          elm_cache_flush_interval_get(void);
1454
1455    /**
1456     * Set the configured cache flush interval time
1457     *
1458     * This sets the globally configured cache flush interval time, in ticks
1459     *
1460     * @param size The cache flush interval time
1461     * @ingroup Caches
1462     *
1463     * @see elm_all_flush()
1464     */
1465    EAPI void         elm_cache_flush_interval_set(int size);
1466
1467    /**
1468     * Set the configured cache flush interval time for all applications on the
1469     * display
1470     *
1471     * This sets the globally configured cache flush interval time -- in ticks
1472     * -- for all applications on the display.
1473     *
1474     * @param size The cache flush interval time
1475     * @ingroup Caches
1476     */
1477    EAPI void         elm_cache_flush_interval_all_set(int size);
1478
1479    /**
1480     * Get the configured cache flush enabled state
1481     *
1482     * This gets the globally configured cache flush state - if it is enabled
1483     * or not. When cache flushing is enabled, elementary will regularly
1484     * (see elm_cache_flush_interval_get() ) flush caches and dump data out of
1485     * memory and allow usage to re-seed caches and data in memory where it
1486     * can do so. An idle application will thus minimise its memory usage as
1487     * data will be freed from memory and not be re-loaded as it is idle and
1488     * not rendering or doing anything graphically right now.
1489     *
1490     * @return The cache flush state
1491     * @ingroup Caches
1492     *
1493     * @see elm_all_flush()
1494     */
1495    EAPI Eina_Bool    elm_cache_flush_enabled_get(void);
1496
1497    /**
1498     * Set the configured cache flush enabled state
1499     *
1500     * This sets the globally configured cache flush enabled state.
1501     *
1502     * @param size The cache flush enabled state
1503     * @ingroup Caches
1504     *
1505     * @see elm_all_flush()
1506     */
1507    EAPI void         elm_cache_flush_enabled_set(Eina_Bool enabled);
1508
1509    /**
1510     * Set the configured cache flush enabled state for all applications on the
1511     * display
1512     *
1513     * This sets the globally configured cache flush enabled state for all
1514     * applications on the display.
1515     *
1516     * @param size The cache flush enabled state
1517     * @ingroup Caches
1518     */
1519    EAPI void         elm_cache_flush_enabled_all_set(Eina_Bool enabled);
1520
1521    /**
1522     * Get the configured font cache size
1523     *
1524     * This gets the globally configured font cache size, in bytes.
1525     *
1526     * @return The font cache size
1527     * @ingroup Caches
1528     */
1529    EAPI int          elm_font_cache_get(void);
1530
1531    /**
1532     * Set the configured font cache size
1533     *
1534     * This sets the globally configured font cache size, in bytes
1535     *
1536     * @param size The font cache size
1537     * @ingroup Caches
1538     */
1539    EAPI void         elm_font_cache_set(int size);
1540
1541    /**
1542     * Set the configured font cache size for all applications on the
1543     * display
1544     *
1545     * This sets the globally configured font cache size -- in bytes
1546     * -- for all applications on the display.
1547     *
1548     * @param size The font cache size
1549     * @ingroup Caches
1550     */
1551    EAPI void         elm_font_cache_all_set(int size);
1552
1553    /**
1554     * Get the configured image cache size
1555     *
1556     * This gets the globally configured image cache size, in bytes
1557     *
1558     * @return The image cache size
1559     * @ingroup Caches
1560     */
1561    EAPI int          elm_image_cache_get(void);
1562
1563    /**
1564     * Set the configured image cache size
1565     *
1566     * This sets the globally configured image cache size, in bytes
1567     *
1568     * @param size The image cache size
1569     * @ingroup Caches
1570     */
1571    EAPI void         elm_image_cache_set(int size);
1572
1573    /**
1574     * Set the configured image cache size for all applications on the
1575     * display
1576     *
1577     * This sets the globally configured image cache size -- in bytes
1578     * -- for all applications on the display.
1579     *
1580     * @param size The image cache size
1581     * @ingroup Caches
1582     */
1583    EAPI void         elm_image_cache_all_set(int size);
1584
1585    /**
1586     * Get the configured edje file cache size.
1587     *
1588     * This gets the globally configured edje file cache size, in number
1589     * of files.
1590     *
1591     * @return The edje file cache size
1592     * @ingroup Caches
1593     */
1594    EAPI int          elm_edje_file_cache_get(void);
1595
1596    /**
1597     * Set the configured edje file cache size
1598     *
1599     * This sets the globally configured edje file cache size, in number
1600     * of files.
1601     *
1602     * @param size The edje file cache size
1603     * @ingroup Caches
1604     */
1605    EAPI void         elm_edje_file_cache_set(int size);
1606
1607    /**
1608     * Set the configured edje file cache size for all applications on the
1609     * display
1610     *
1611     * This sets the globally configured edje file cache size -- in number
1612     * of files -- for all applications on the display.
1613     *
1614     * @param size The edje file cache size
1615     * @ingroup Caches
1616     */
1617    EAPI void         elm_edje_file_cache_all_set(int size);
1618
1619    /**
1620     * Get the configured edje collections (groups) cache size.
1621     *
1622     * This gets the globally configured edje collections cache size, in
1623     * number of collections.
1624     *
1625     * @return The edje collections cache size
1626     * @ingroup Caches
1627     */
1628    EAPI int          elm_edje_collection_cache_get(void);
1629
1630    /**
1631     * Set the configured edje collections (groups) cache size
1632     *
1633     * This sets the globally configured edje collections cache size, in
1634     * number of collections.
1635     *
1636     * @param size The edje collections cache size
1637     * @ingroup Caches
1638     */
1639    EAPI void         elm_edje_collection_cache_set(int size);
1640
1641    /**
1642     * Set the configured edje collections (groups) cache size for all
1643     * applications on the display
1644     *
1645     * This sets the globally configured edje collections cache size -- in
1646     * number of collections -- for all applications on the display.
1647     *
1648     * @param size The edje collections cache size
1649     * @ingroup Caches
1650     */
1651    EAPI void         elm_edje_collection_cache_all_set(int size);
1652
1653    /**
1654     * @}
1655     */
1656
1657    /**
1658     * @defgroup Scaling Widget Scaling
1659     *
1660     * Different widgets can be scaled independently. These functions
1661     * allow you to manipulate this scaling on a per-widget basis. The
1662     * object and all its children get their scaling factors multiplied
1663     * by the scale factor set. This is multiplicative, in that if a
1664     * child also has a scale size set it is in turn multiplied by its
1665     * parent's scale size. @c 1.0 means “don't scale”, @c 2.0 is
1666     * double size, @c 0.5 is half, etc.
1667     *
1668     * @ref general_functions_example_page "This" example contemplates
1669     * some of these functions.
1670     */
1671
1672    /**
1673     * Get the global scaling factor
1674     *
1675     * This gets the globally configured scaling factor that is applied to all
1676     * objects.
1677     *
1678     * @return The scaling factor
1679     * @ingroup Scaling
1680     */
1681    EAPI double       elm_scale_get(void);
1682
1683    /**
1684     * Set the global scaling factor
1685     *
1686     * This sets the globally configured scaling factor that is applied to all
1687     * objects.
1688     *
1689     * @param scale The scaling factor to set
1690     * @ingroup Scaling
1691     */
1692    EAPI void         elm_scale_set(double scale);
1693
1694    /**
1695     * Set the global scaling factor for all applications on the display
1696     *
1697     * This sets the globally configured scaling factor that is applied to all
1698     * objects for all applications.
1699     * @param scale The scaling factor to set
1700     * @ingroup Scaling
1701     */
1702    EAPI void         elm_scale_all_set(double scale);
1703
1704    /**
1705     * Set the scaling factor for a given Elementary object
1706     *
1707     * @param obj The Elementary to operate on
1708     * @param scale Scale factor (from @c 0.0 up, with @c 1.0 meaning
1709     * no scaling)
1710     *
1711     * @ingroup Scaling
1712     */
1713    EAPI void         elm_object_scale_set(Evas_Object *obj, double scale) EINA_ARG_NONNULL(1);
1714
1715    /**
1716     * Get the scaling factor for a given Elementary object
1717     *
1718     * @param obj The object
1719     * @return The scaling factor set by elm_object_scale_set()
1720     *
1721     * @ingroup Scaling
1722     */
1723    EAPI double       elm_object_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1724
1725    /**
1726     * @defgroup Password_last_show Password last input show
1727     *
1728     * Last show feature of password mode enables user to view
1729     * the last input entered for few seconds before masking it.
1730     * These functions allow to set this feature in password mode
1731     * of entry widget and also allow to manipulate the duration
1732     * for which the input has to be visible.
1733     *
1734     * @{
1735     */
1736
1737    /**
1738     * Get show last setting of password mode.
1739     *
1740     * This gets the show last input setting of password mode which might be
1741     * enabled or disabled.
1742     *
1743     * @return @c EINA_TRUE, if the last input show setting is enabled, @c EINA_FALSE
1744     *            if it's disabled.
1745     * @ingroup Password_last_show
1746     */
1747    EAPI Eina_Bool elm_password_show_last_get(void);
1748
1749    /**
1750     * Set show last setting in password mode.
1751     *
1752     * This enables or disables show last setting of password mode.
1753     *
1754     * @param password_show_last If EINA_TRUE enable's last input show in password mode.
1755     * @see elm_password_show_last_timeout_set()
1756     * @ingroup Password_last_show
1757     */
1758    EAPI void elm_password_show_last_set(Eina_Bool password_show_last);
1759
1760    /**
1761     * Get's the timeout value in last show password mode.
1762     *
1763     * This gets the time out value for which the last input entered in password
1764     * mode will be visible.
1765     *
1766     * @return The timeout value of last show password mode.
1767     * @ingroup Password_last_show
1768     */
1769    EAPI double elm_password_show_last_timeout_get(void);
1770
1771    /**
1772     * Set's the timeout value in last show password mode.
1773     *
1774     * This sets the time out value for which the last input entered in password
1775     * mode will be visible.
1776     *
1777     * @param password_show_last_timeout The timeout value.
1778     * @see elm_password_show_last_set()
1779     * @ingroup Password_last_show
1780     */
1781    EAPI void elm_password_show_last_timeout_set(double password_show_last_timeout);
1782
1783    /**
1784     * @}
1785     */
1786
1787    /**
1788     * @defgroup UI-Mirroring Selective Widget mirroring
1789     *
1790     * These functions allow you to set ui-mirroring on specific
1791     * widgets or the whole interface. Widgets can be in one of two
1792     * modes, automatic and manual.  Automatic means they'll be changed
1793     * according to the system mirroring mode and manual means only
1794     * explicit changes will matter. You are not supposed to change
1795     * mirroring state of a widget set to automatic, will mostly work,
1796     * but the behavior is not really defined.
1797     *
1798     * @{
1799     */
1800
1801    EAPI Eina_Bool    elm_mirrored_get(void);
1802    EAPI void         elm_mirrored_set(Eina_Bool mirrored);
1803
1804    /**
1805     * Get the system mirrored mode. This determines the default mirrored mode
1806     * of widgets.
1807     *
1808     * @return EINA_TRUE if mirrored is set, EINA_FALSE otherwise
1809     */
1810    EAPI Eina_Bool    elm_object_mirrored_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1811
1812    /**
1813     * Set the system mirrored mode. This determines the default mirrored mode
1814     * of widgets.
1815     *
1816     * @param mirrored EINA_TRUE to set mirrored mode, EINA_FALSE to unset it.
1817     */
1818    EAPI void         elm_object_mirrored_set(Evas_Object *obj, Eina_Bool mirrored) EINA_ARG_NONNULL(1);
1819
1820    /**
1821     * Returns the widget's mirrored mode setting.
1822     *
1823     * @param obj The widget.
1824     * @return mirrored mode setting of the object.
1825     *
1826     **/
1827    EAPI Eina_Bool    elm_object_mirrored_automatic_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1828
1829    /**
1830     * Sets the widget's mirrored mode setting.
1831     * When widget in automatic mode, it follows the system mirrored mode set by
1832     * elm_mirrored_set().
1833     * @param obj The widget.
1834     * @param automatic EINA_TRUE for auto mirrored mode. EINA_FALSE for manual.
1835     */
1836    EAPI void         elm_object_mirrored_automatic_set(Evas_Object *obj, Eina_Bool automatic) EINA_ARG_NONNULL(1);
1837
1838    /**
1839     * @}
1840     */
1841
1842    /**
1843     * Set the style to use by a widget
1844     *
1845     * Sets the style name that will define the appearance of a widget. Styles
1846     * vary from widget to widget and may also be defined by other themes
1847     * by means of extensions and overlays.
1848     *
1849     * @param obj The Elementary widget to style
1850     * @param style The style name to use
1851     *
1852     * @see elm_theme_extension_add()
1853     * @see elm_theme_extension_del()
1854     * @see elm_theme_overlay_add()
1855     * @see elm_theme_overlay_del()
1856     *
1857     * @ingroup Styles
1858     */
1859    EAPI void         elm_object_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
1860    /**
1861     * Get the style used by the widget
1862     *
1863     * This gets the style being used for that widget. Note that the string
1864     * pointer is only valid as longas the object is valid and the style doesn't
1865     * change.
1866     *
1867     * @param obj The Elementary widget to query for its style
1868     * @return The style name used
1869     *
1870     * @see elm_object_style_set()
1871     *
1872     * @ingroup Styles
1873     */
1874    EAPI const char  *elm_object_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1875
1876    /**
1877     * @defgroup Styles Styles
1878     *
1879     * Widgets can have different styles of look. These generic API's
1880     * set styles of widgets, if they support them (and if the theme(s)
1881     * do).
1882     *
1883     * @ref general_functions_example_page "This" example contemplates
1884     * some of these functions.
1885     */
1886
1887    /**
1888     * Set the disabled state of an Elementary object.
1889     *
1890     * @param obj The Elementary object to operate on
1891     * @param disabled The state to put in in: @c EINA_TRUE for
1892     *        disabled, @c EINA_FALSE for enabled
1893     *
1894     * Elementary objects can be @b disabled, in which state they won't
1895     * receive input and, in general, will be themed differently from
1896     * their normal state, usually greyed out. Useful for contexts
1897     * where you don't want your users to interact with some of the
1898     * parts of you interface.
1899     *
1900     * This sets the state for the widget, either disabling it or
1901     * enabling it back.
1902     *
1903     * @ingroup Styles
1904     */
1905    EAPI void         elm_object_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
1906
1907    /**
1908     * Get the disabled state of an Elementary object.
1909     *
1910     * @param obj The Elementary object to operate on
1911     * @return @c EINA_TRUE, if the widget is disabled, @c EINA_FALSE
1912     *            if it's enabled (or on errors)
1913     *
1914     * This gets the state of the widget, which might be enabled or disabled.
1915     *
1916     * @ingroup Styles
1917     */
1918    EAPI Eina_Bool    elm_object_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1919
1920    /**
1921     * @defgroup WidgetNavigation Widget Tree Navigation.
1922     *
1923     * How to check if an Evas Object is an Elementary widget? How to
1924     * get the first elementary widget that is parent of the given
1925     * object?  These are all covered in widget tree navigation.
1926     *
1927     * @ref general_functions_example_page "This" example contemplates
1928     * some of these functions.
1929     */
1930
1931    /**
1932     * Check if the given Evas Object is an Elementary widget.
1933     *
1934     * @param obj the object to query.
1935     * @return @c EINA_TRUE if it is an elementary widget variant,
1936     *         @c EINA_FALSE otherwise
1937     * @ingroup WidgetNavigation
1938     */
1939    EAPI Eina_Bool    elm_object_widget_check(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1940
1941    /**
1942     * Get the first parent of the given object that is an Elementary
1943     * widget.
1944     *
1945     * @param obj the Elementary object to query parent from.
1946     * @return the parent object that is an Elementary widget, or @c
1947     *         NULL, if it was not found.
1948     *
1949     * Use this to query for an object's parent widget.
1950     *
1951     * @note Most of Elementary users wouldn't be mixing non-Elementary
1952     * smart objects in the objects tree of an application, as this is
1953     * an advanced usage of Elementary with Evas. So, except for the
1954     * application's window, which is the root of that tree, all other
1955     * objects would have valid Elementary widget parents.
1956     *
1957     * @ingroup WidgetNavigation
1958     */
1959    EAPI Evas_Object *elm_object_parent_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1960
1961    /**
1962     * Get the top level parent of an Elementary widget.
1963     *
1964     * @param obj The object to query.
1965     * @return The top level Elementary widget, or @c NULL if parent cannot be
1966     * found.
1967     * @ingroup WidgetNavigation
1968     */
1969    EAPI Evas_Object *elm_object_top_widget_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1970
1971    /**
1972     * Get the string that represents this Elementary widget.
1973     *
1974     * @note Elementary is weird and exposes itself as a single
1975     *       Evas_Object_Smart_Class of type "elm_widget", so
1976     *       evas_object_type_get() always return that, making debug and
1977     *       language bindings hard. This function tries to mitigate this
1978     *       problem, but the solution is to change Elementary to use
1979     *       proper inheritance.
1980     *
1981     * @param obj the object to query.
1982     * @return Elementary widget name, or @c NULL if not a valid widget.
1983     * @ingroup WidgetNavigation
1984     */
1985    EAPI const char  *elm_object_widget_type_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
1986
1987    /**
1988     * @defgroup Config Elementary Config
1989     *
1990     * Elementary configuration is formed by a set options bounded to a
1991     * given @ref Profile profile, like @ref Theme theme, @ref Fingers
1992     * "finger size", etc. These are functions with which one syncronizes
1993     * changes made to those values to the configuration storing files, de
1994     * facto. You most probably don't want to use the functions in this
1995     * group unlees you're writing an elementary configuration manager.
1996     *
1997     * @{
1998     */
1999
2000    /**
2001     * Save back Elementary's configuration, so that it will persist on
2002     * future sessions.
2003     *
2004     * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
2005     * @ingroup Config
2006     *
2007     * This function will take effect -- thus, do I/O -- immediately. Use
2008     * it when you want to apply all configuration changes at once. The
2009     * current configuration set will get saved onto the current profile
2010     * configuration file.
2011     *
2012     */
2013    EAPI Eina_Bool    elm_config_save(void);
2014
2015    /**
2016     * Reload Elementary's configuration, bounded to current selected
2017     * profile.
2018     *
2019     * @return @c EINA_TRUE, when sucessful. @c EINA_FALSE, otherwise.
2020     * @ingroup Config
2021     *
2022     * Useful when you want to force reloading of configuration values for
2023     * a profile. If one removes user custom configuration directories,
2024     * for example, it will force a reload with system values instead.
2025     *
2026     */
2027    EAPI void         elm_config_reload(void);
2028
2029    /**
2030     * @}
2031     */
2032
2033    /**
2034     * @defgroup Profile Elementary Profile
2035     *
2036     * Profiles are pre-set options that affect the whole look-and-feel of
2037     * Elementary-based applications. There are, for example, profiles
2038     * aimed at desktop computer applications and others aimed at mobile,
2039     * touchscreen-based ones. You most probably don't want to use the
2040     * functions in this group unlees you're writing an elementary
2041     * configuration manager.
2042     *
2043     * @{
2044     */
2045
2046    /**
2047     * Get Elementary's profile in use.
2048     *
2049     * This gets the global profile that is applied to all Elementary
2050     * applications.
2051     *
2052     * @return The profile's name
2053     * @ingroup Profile
2054     */
2055    EAPI const char  *elm_profile_current_get(void);
2056
2057    /**
2058     * Get an Elementary's profile directory path in the filesystem. One
2059     * may want to fetch a system profile's dir or an user one (fetched
2060     * inside $HOME).
2061     *
2062     * @param profile The profile's name
2063     * @param is_user Whether to lookup for an user profile (@c EINA_TRUE)
2064     *                or a system one (@c EINA_FALSE)
2065     * @return The profile's directory path.
2066     * @ingroup Profile
2067     *
2068     * @note You must free it with elm_profile_dir_free().
2069     */
2070    EAPI const char  *elm_profile_dir_get(const char *profile, Eina_Bool is_user);
2071
2072    /**
2073     * Free an Elementary's profile directory path, as returned by
2074     * elm_profile_dir_get().
2075     *
2076     * @param p_dir The profile's path
2077     * @ingroup Profile
2078     *
2079     */
2080    EAPI void         elm_profile_dir_free(const char *p_dir);
2081
2082    /**
2083     * Get Elementary's list of available profiles.
2084     *
2085     * @return The profiles list. List node data are the profile name
2086     *         strings.
2087     * @ingroup Profile
2088     *
2089     * @note One must free this list, after usage, with the function
2090     *       elm_profile_list_free().
2091     */
2092    EAPI Eina_List   *elm_profile_list_get(void);
2093
2094    /**
2095     * Free Elementary's list of available profiles.
2096     *
2097     * @param l The profiles list, as returned by elm_profile_list_get().
2098     * @ingroup Profile
2099     *
2100     */
2101    EAPI void         elm_profile_list_free(Eina_List *l);
2102
2103    /**
2104     * Set Elementary's profile.
2105     *
2106     * This sets the global profile that is applied to Elementary
2107     * applications. Just the process the call comes from will be
2108     * affected.
2109     *
2110     * @param profile The profile's name
2111     * @ingroup Profile
2112     *
2113     */
2114    EAPI void         elm_profile_set(const char *profile);
2115
2116    /**
2117     * Set Elementary's profile.
2118     *
2119     * This sets the global profile that is applied to all Elementary
2120     * applications. All running Elementary windows will be affected.
2121     *
2122     * @param profile The profile's name
2123     * @ingroup Profile
2124     *
2125     */
2126    EAPI void         elm_profile_all_set(const char *profile);
2127
2128    /**
2129     * @}
2130     */
2131
2132    /**
2133     * @defgroup Engine Elementary Engine
2134     *
2135     * These are functions setting and querying which rendering engine
2136     * Elementary will use for drawing its windows' pixels.
2137     *
2138     * The following are the available engines:
2139     * @li "software_x11"
2140     * @li "fb"
2141     * @li "directfb"
2142     * @li "software_16_x11"
2143     * @li "software_8_x11"
2144     * @li "xrender_x11"
2145     * @li "opengl_x11"
2146     * @li "software_gdi"
2147     * @li "software_16_wince_gdi"
2148     * @li "sdl"
2149     * @li "software_16_sdl"
2150     * @li "opengl_sdl"
2151     * @li "buffer"
2152     * @li "ews"
2153     * @li "opengl_cocoa"
2154     * @li "psl1ght"
2155     *
2156     * @{
2157     */
2158
2159    /**
2160     * @brief Get Elementary's rendering engine in use.
2161     *
2162     * @return The rendering engine's name
2163     * @note there's no need to free the returned string, here.
2164     *
2165     * This gets the global rendering engine that is applied to all Elementary
2166     * applications.
2167     *
2168     * @see elm_engine_set()
2169     */
2170    EAPI const char  *elm_engine_current_get(void);
2171
2172    /**
2173     * @brief Set Elementary's rendering engine for use.
2174     *
2175     * @param engine The rendering engine's name
2176     *
2177     * This sets global rendering engine that is applied to all Elementary
2178     * applications. Note that it will take effect only to Elementary windows
2179     * created after this is called.
2180     *
2181     * @see elm_win_add()
2182     */
2183    EAPI void         elm_engine_set(const char *engine);
2184
2185    /**
2186     * @}
2187     */
2188
2189    /**
2190     * @defgroup Fonts Elementary Fonts
2191     *
2192     * These are functions dealing with font rendering, selection and the
2193     * like for Elementary applications. One might fetch which system
2194     * fonts are there to use and set custom fonts for individual classes
2195     * of UI items containing text (text classes).
2196     *
2197     * @{
2198     */
2199
2200   typedef struct _Elm_Text_Class
2201     {
2202        const char *name;
2203        const char *desc;
2204     } Elm_Text_Class;
2205
2206   typedef struct _Elm_Font_Overlay
2207     {
2208        const char     *text_class;
2209        const char     *font;
2210        Evas_Font_Size  size;
2211     } Elm_Font_Overlay;
2212
2213   typedef struct _Elm_Font_Properties
2214     {
2215        const char *name;
2216        Eina_List  *styles;
2217     } Elm_Font_Properties;
2218
2219    /**
2220     * Get Elementary's list of supported text classes.
2221     *
2222     * @return The text classes list, with @c Elm_Text_Class blobs as data.
2223     * @ingroup Fonts
2224     *
2225     * Release the list with elm_text_classes_list_free().
2226     */
2227    EAPI const Eina_List     *elm_text_classes_list_get(void);
2228
2229    /**
2230     * Free Elementary's list of supported text classes.
2231     *
2232     * @ingroup Fonts
2233     *
2234     * @see elm_text_classes_list_get().
2235     */
2236    EAPI void                 elm_text_classes_list_free(const Eina_List *list);
2237
2238    /**
2239     * Get Elementary's list of font overlays, set with
2240     * elm_font_overlay_set().
2241     *
2242     * @return The font overlays list, with @c Elm_Font_Overlay blobs as
2243     * data.
2244     *
2245     * @ingroup Fonts
2246     *
2247     * For each text class, one can set a <b>font overlay</b> for it,
2248     * overriding the default font properties for that class coming from
2249     * the theme in use. There is no need to free this list.
2250     *
2251     * @see elm_font_overlay_set() and elm_font_overlay_unset().
2252     */
2253    EAPI const Eina_List     *elm_font_overlay_list_get(void);
2254
2255    /**
2256     * Set a font overlay for a given Elementary text class.
2257     *
2258     * @param text_class Text class name
2259     * @param font Font name and style string
2260     * @param size Font size
2261     *
2262     * @ingroup Fonts
2263     *
2264     * @p font has to be in the format returned by
2265     * elm_font_fontconfig_name_get(). @see elm_font_overlay_list_get()
2266     * and elm_font_overlay_unset().
2267     */
2268    EAPI void                 elm_font_overlay_set(const char *text_class, const char *font, Evas_Font_Size size);
2269
2270    /**
2271     * Unset a font overlay for a given Elementary text class.
2272     *
2273     * @param text_class Text class name
2274     *
2275     * @ingroup Fonts
2276     *
2277     * This will bring back text elements belonging to text class
2278     * @p text_class back to their default font settings.
2279     */
2280    EAPI void                 elm_font_overlay_unset(const char *text_class);
2281
2282    /**
2283     * Apply the changes made with elm_font_overlay_set() and
2284     * elm_font_overlay_unset() on the current Elementary window.
2285     *
2286     * @ingroup Fonts
2287     *
2288     * This applies all font overlays set to all objects in the UI.
2289     */
2290    EAPI void                 elm_font_overlay_apply(void);
2291
2292    /**
2293     * Apply the changes made with elm_font_overlay_set() and
2294     * elm_font_overlay_unset() on all Elementary application windows.
2295     *
2296     * @ingroup Fonts
2297     *
2298     * This applies all font overlays set to all objects in the UI.
2299     */
2300    EAPI void                 elm_font_overlay_all_apply(void);
2301
2302    /**
2303     * Translate a font (family) name string in fontconfig's font names
2304     * syntax into an @c Elm_Font_Properties struct.
2305     *
2306     * @param font The font name and styles string
2307     * @return the font properties struct
2308     *
2309     * @ingroup Fonts
2310     *
2311     * @note The reverse translation can be achived with
2312     * elm_font_fontconfig_name_get(), for one style only (single font
2313     * instance, not family).
2314     */
2315    EAPI Elm_Font_Properties *elm_font_properties_get(const char *font) EINA_ARG_NONNULL(1);
2316
2317    /**
2318     * Free font properties return by elm_font_properties_get().
2319     *
2320     * @param efp the font properties struct
2321     *
2322     * @ingroup Fonts
2323     */
2324    EAPI void                 elm_font_properties_free(Elm_Font_Properties *efp) EINA_ARG_NONNULL(1);
2325
2326    /**
2327     * Translate a font name, bound to a style, into fontconfig's font names
2328     * syntax.
2329     *
2330     * @param name The font (family) name
2331     * @param style The given style (may be @c NULL)
2332     *
2333     * @return the font name and style string
2334     *
2335     * @ingroup Fonts
2336     *
2337     * @note The reverse translation can be achived with
2338     * elm_font_properties_get(), for one style only (single font
2339     * instance, not family).
2340     */
2341    EAPI const char          *elm_font_fontconfig_name_get(const char *name, const char *style) EINA_ARG_NONNULL(1);
2342
2343    /**
2344     * Free the font string return by elm_font_fontconfig_name_get().
2345     *
2346     * @param efp the font properties struct
2347     *
2348     * @ingroup Fonts
2349     */
2350    EAPI void                 elm_font_fontconfig_name_free(const char *name) EINA_ARG_NONNULL(1);
2351
2352    /**
2353     * Create a font hash table of available system fonts.
2354     *
2355     * One must call it with @p list being the return value of
2356     * evas_font_available_list(). The hash will be indexed by font
2357     * (family) names, being its values @c Elm_Font_Properties blobs.
2358     *
2359     * @param list The list of available system fonts, as returned by
2360     * evas_font_available_list().
2361     * @return the font hash.
2362     *
2363     * @ingroup Fonts
2364     *
2365     * @note The user is supposed to get it populated at least with 3
2366     * default font families (Sans, Serif, Monospace), which should be
2367     * present on most systems.
2368     */
2369    EAPI Eina_Hash           *elm_font_available_hash_add(Eina_List *list);
2370
2371    /**
2372     * Free the hash return by elm_font_available_hash_add().
2373     *
2374     * @param hash the hash to be freed.
2375     *
2376     * @ingroup Fonts
2377     */
2378    EAPI void                 elm_font_available_hash_del(Eina_Hash *hash);
2379
2380    /**
2381     * @}
2382     */
2383
2384    /**
2385     * @defgroup Fingers Fingers
2386     *
2387     * Elementary is designed to be finger-friendly for touchscreens,
2388     * and so in addition to scaling for display resolution, it can
2389     * also scale based on finger "resolution" (or size). You can then
2390     * customize the granularity of the areas meant to receive clicks
2391     * on touchscreens.
2392     *
2393     * Different profiles may have pre-set values for finger sizes.
2394     *
2395     * @ref general_functions_example_page "This" example contemplates
2396     * some of these functions.
2397     *
2398     * @{
2399     */
2400
2401    /**
2402     * Get the configured "finger size"
2403     *
2404     * @return The finger size
2405     *
2406     * This gets the globally configured finger size, <b>in pixels</b>
2407     *
2408     * @ingroup Fingers
2409     */
2410    EAPI Evas_Coord       elm_finger_size_get(void);
2411
2412    /**
2413     * Set the configured finger size
2414     *
2415     * This sets the globally configured finger size in pixels
2416     *
2417     * @param size The finger size
2418     * @ingroup Fingers
2419     */
2420    EAPI void             elm_finger_size_set(Evas_Coord size);
2421
2422    /**
2423     * Set the configured finger size for all applications on the display
2424     *
2425     * This sets the globally configured finger size in pixels for all
2426     * applications on the display
2427     *
2428     * @param size The finger size
2429     * @ingroup Fingers
2430     */
2431    EAPI void             elm_finger_size_all_set(Evas_Coord size);
2432
2433    /**
2434     * @}
2435     */
2436
2437    /**
2438     * @defgroup Focus Focus
2439     *
2440     * An Elementary application has, at all times, one (and only one)
2441     * @b focused object. This is what determines where the input
2442     * events go to within the application's window. Also, focused
2443     * objects can be decorated differently, in order to signal to the
2444     * user where the input is, at a given moment.
2445     *
2446     * Elementary applications also have the concept of <b>focus
2447     * chain</b>: one can cycle through all the windows' focusable
2448     * objects by input (tab key) or programmatically. The default
2449     * focus chain for an application is the one define by the order in
2450     * which the widgets where added in code. One will cycle through
2451     * top level widgets, and, for each one containg sub-objects, cycle
2452     * through them all, before returning to the level
2453     * above. Elementary also allows one to set @b custom focus chains
2454     * for their applications.
2455     *
2456     * Besides the focused decoration a widget may exhibit, when it
2457     * gets focus, Elementary has a @b global focus highlight object
2458     * that can be enabled for a window. If one chooses to do so, this
2459     * extra highlight effect will surround the current focused object,
2460     * too.
2461     *
2462     * @note Some Elementary widgets are @b unfocusable, after
2463     * creation, by their very nature: they are not meant to be
2464     * interacted with input events, but are there just for visual
2465     * purposes.
2466     *
2467     * @ref general_functions_example_page "This" example contemplates
2468     * some of these functions.
2469     */
2470
2471    /**
2472     * Get the enable status of the focus highlight
2473     *
2474     * This gets whether the highlight on focused objects is enabled or not
2475     * @ingroup Focus
2476     */
2477    EAPI Eina_Bool        elm_focus_highlight_enabled_get(void);
2478
2479    /**
2480     * Set the enable status of the focus highlight
2481     *
2482     * Set whether to show or not the highlight on focused objects
2483     * @param enable Enable highlight if EINA_TRUE, disable otherwise
2484     * @ingroup Focus
2485     */
2486    EAPI void             elm_focus_highlight_enabled_set(Eina_Bool enable);
2487
2488    /**
2489     * Get the enable status of the highlight animation
2490     *
2491     * Get whether the focus highlight, if enabled, will animate its switch from
2492     * one object to the next
2493     * @ingroup Focus
2494     */
2495    EAPI Eina_Bool        elm_focus_highlight_animate_get(void);
2496
2497    /**
2498     * Set the enable status of the highlight animation
2499     *
2500     * Set whether the focus highlight, if enabled, will animate its switch from
2501     * one object to the next
2502     * @param animate Enable animation if EINA_TRUE, disable otherwise
2503     * @ingroup Focus
2504     */
2505    EAPI void             elm_focus_highlight_animate_set(Eina_Bool animate);
2506
2507    /**
2508     * Get the whether an Elementary object has the focus or not.
2509     *
2510     * @param obj The Elementary object to get the information from
2511     * @return @c EINA_TRUE, if the object is focused, @c EINA_FALSE if
2512     *            not (and on errors).
2513     *
2514     * @see elm_object_focus_set()
2515     *
2516     * @ingroup Focus
2517     */
2518    EAPI Eina_Bool        elm_object_focus_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2519
2520    /**
2521     * Set/unset focus to a given Elementary object.
2522     *
2523     * @param obj The Elementary object to operate on.
2524     * @param enable @c EINA_TRUE Set focus to a given object,
2525     *               @c EINA_FALSE Unset focus to a given object.
2526     *
2527     * @note When you set focus to this object, if it can handle focus, will
2528     * take the focus away from the one who had it previously and will, for
2529     * now on, be the one receiving input events. Unsetting focus will remove
2530     * the focus from @p obj, passing it back to the previous element in the
2531     * focus chain list.
2532     *
2533     * @see elm_object_focus_get(), elm_object_focus_custom_chain_get()
2534     *
2535     * @ingroup Focus
2536     */
2537    EAPI void             elm_object_focus_set(Evas_Object *obj, Eina_Bool focus) EINA_ARG_NONNULL(1);
2538
2539    /**
2540     * Make a given Elementary object the focused one.
2541     *
2542     * @param obj The Elementary object to make focused.
2543     *
2544     * @note This object, if it can handle focus, will take the focus
2545     * away from the one who had it previously and will, for now on, be
2546     * the one receiving input events.
2547     *
2548     * @see elm_object_focus_get()
2549     * @deprecated use elm_object_focus_set() instead.
2550     *
2551     * @ingroup Focus
2552     */
2553    WILL_DEPRECATE  EAPI void             elm_object_focus(Evas_Object *obj) EINA_ARG_NONNULL(1);
2554
2555    /**
2556     * Remove the focus from an Elementary object
2557     *
2558     * @param obj The Elementary to take focus from
2559     *
2560     * This removes the focus from @p obj, passing it back to the
2561     * previous element in the focus chain list.
2562     *
2563     * @see elm_object_focus() and elm_object_focus_custom_chain_get()
2564     * @deprecated use elm_object_focus_set() instead.
2565     *
2566     * @ingroup Focus
2567     */
2568    WILL_DEPRECATE  EAPI void             elm_object_unfocus(Evas_Object *obj) EINA_ARG_NONNULL(1);
2569
2570    /**
2571     * Set the ability for an Element object to be focused
2572     *
2573     * @param obj The Elementary object to operate on
2574     * @param enable @c EINA_TRUE if the object can be focused, @c
2575     *        EINA_FALSE if not (and on errors)
2576     *
2577     * This sets whether the object @p obj is able to take focus or
2578     * not. Unfocusable objects do nothing when programmatically
2579     * focused, being the nearest focusable parent object the one
2580     * really getting focus. Also, when they receive mouse input, they
2581     * will get the event, but not take away the focus from where it
2582     * was previously.
2583     *
2584     * @ingroup Focus
2585     */
2586    EAPI void             elm_object_focus_allow_set(Evas_Object *obj, Eina_Bool enable) EINA_ARG_NONNULL(1);
2587
2588    /**
2589     * Get whether an Elementary object is focusable or not
2590     *
2591     * @param obj The Elementary object to operate on
2592     * @return @c EINA_TRUE if the object is allowed to be focused, @c
2593     *             EINA_FALSE if not (and on errors)
2594     *
2595     * @note Objects which are meant to be interacted with by input
2596     * events are created able to be focused, by default. All the
2597     * others are not.
2598     *
2599     * @ingroup Focus
2600     */
2601    EAPI Eina_Bool        elm_object_focus_allow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2602
2603    /**
2604     * Set custom focus chain.
2605     *
2606     * This function overwrites any previous custom focus chain within
2607     * the list of objects. The previous list will be deleted and this list
2608     * will be managed by elementary. After it is set, don't modify it.
2609     *
2610     * @note On focus cycle, only will be evaluated children of this container.
2611     *
2612     * @param obj The container object
2613     * @param objs Chain of objects to pass focus
2614     * @ingroup Focus
2615     */
2616    EAPI void             elm_object_focus_custom_chain_set(Evas_Object *obj, Eina_List *objs) EINA_ARG_NONNULL(1);
2617
2618    /**
2619     * Unset a custom focus chain on a given Elementary widget
2620     *
2621     * @param obj The container object to remove focus chain from
2622     *
2623     * Any focus chain previously set on @p obj (for its child objects)
2624     * is removed entirely after this call.
2625     *
2626     * @ingroup Focus
2627     */
2628    EAPI void             elm_object_focus_custom_chain_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
2629
2630    /**
2631     * Get custom focus chain
2632     *
2633     * @param obj The container object
2634     * @ingroup Focus
2635     */
2636    EAPI const Eina_List *elm_object_focus_custom_chain_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2637
2638    /**
2639     * Append object to custom focus chain.
2640     *
2641     * @note If relative_child equal to NULL or not in custom chain, the object
2642     * will be added in end.
2643     *
2644     * @note On focus cycle, only will be evaluated children of this container.
2645     *
2646     * @param obj The container object
2647     * @param child The child to be added in custom chain
2648     * @param relative_child The relative object to position the child
2649     * @ingroup Focus
2650     */
2651    EAPI void             elm_object_focus_custom_chain_append(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
2652
2653    /**
2654     * Prepend object to custom focus chain.
2655     *
2656     * @note If relative_child equal to NULL or not in custom chain, the object
2657     * will be added in begin.
2658     *
2659     * @note On focus cycle, only will be evaluated children of this container.
2660     *
2661     * @param obj The container object
2662     * @param child The child to be added in custom chain
2663     * @param relative_child The relative object to position the child
2664     * @ingroup Focus
2665     */
2666    EAPI void             elm_object_focus_custom_chain_prepend(Evas_Object *obj, Evas_Object *child, Evas_Object *relative_child) EINA_ARG_NONNULL(1, 2);
2667
2668    /**
2669     * Give focus to next object in object tree.
2670     *
2671     * Give focus to next object in focus chain of one object sub-tree.
2672     * If the last object of chain already have focus, the focus will go to the
2673     * first object of chain.
2674     *
2675     * @param obj The object root of sub-tree
2676     * @param dir Direction to cycle the focus
2677     *
2678     * @ingroup Focus
2679     */
2680    EAPI void             elm_object_focus_cycle(Evas_Object *obj, Elm_Focus_Direction dir) EINA_ARG_NONNULL(1);
2681
2682    /**
2683     * Give focus to near object in one direction.
2684     *
2685     * Give focus to near object in direction of one object.
2686     * If none focusable object in given direction, the focus will not change.
2687     *
2688     * @param obj The reference object
2689     * @param x Horizontal component of direction to focus
2690     * @param y Vertical component of direction to focus
2691     *
2692     * @ingroup Focus
2693     */
2694    EAPI void             elm_object_focus_direction_go(Evas_Object *obj, int x, int y) EINA_ARG_NONNULL(1);
2695
2696    /**
2697     * Make the elementary object and its children to be unfocusable
2698     * (or focusable).
2699     *
2700     * @param obj The Elementary object to operate on
2701     * @param tree_unfocusable @c EINA_TRUE for unfocusable,
2702     *        @c EINA_FALSE for focusable.
2703     *
2704     * This sets whether the object @p obj and its children objects
2705     * are able to take focus or not. If the tree is set as unfocusable,
2706     * newest focused object which is not in this tree will get focus.
2707     * This API can be helpful for an object to be deleted.
2708     * When an object will be deleted soon, it and its children may not
2709     * want to get focus (by focus reverting or by other focus controls).
2710     * Then, just use this API before deleting.
2711     *
2712     * @see elm_object_tree_unfocusable_get()
2713     *
2714     * @ingroup Focus
2715     */
2716    EAPI void             elm_object_tree_unfocusable_set(Evas_Object *obj, Eina_Bool tree_unfocusable) EINA_ARG_NONNULL(1);
2717
2718    /**
2719     * Get whether an Elementary object and its children are unfocusable or not.
2720     *
2721     * @param obj The Elementary object to get the information from
2722     * @return @c EINA_TRUE, if the tree is unfocussable,
2723     *         @c EINA_FALSE if not (and on errors).
2724     *
2725     * @see elm_object_tree_unfocusable_set()
2726     *
2727     * @ingroup Focus
2728     */
2729    EAPI Eina_Bool        elm_object_tree_unfocusable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
2730
2731    /**
2732     * @defgroup Scrolling Scrolling
2733     *
2734     * These are functions setting how scrollable views in Elementary
2735     * widgets should behave on user interaction.
2736     *
2737     * @{
2738     */
2739
2740    /**
2741     * Get whether scrollers should bounce when they reach their
2742     * viewport's edge during a scroll.
2743     *
2744     * @return the thumb scroll bouncing state
2745     *
2746     * This is the default behavior for touch screens, in general.
2747     * @ingroup Scrolling
2748     */
2749    EAPI Eina_Bool        elm_scroll_bounce_enabled_get(void);
2750
2751    /**
2752     * Set whether scrollers should bounce when they reach their
2753     * viewport's edge during a scroll.
2754     *
2755     * @param enabled the thumb scroll bouncing state
2756     *
2757     * @see elm_thumbscroll_bounce_enabled_get()
2758     * @ingroup Scrolling
2759     */
2760    EAPI void             elm_scroll_bounce_enabled_set(Eina_Bool enabled);
2761
2762    /**
2763     * Set whether scrollers should bounce when they reach their
2764     * viewport's edge during a scroll, for all Elementary application
2765     * windows.
2766     *
2767     * @param enabled the thumb scroll bouncing state
2768     *
2769     * @see elm_thumbscroll_bounce_enabled_get()
2770     * @ingroup Scrolling
2771     */
2772    EAPI void             elm_scroll_bounce_enabled_all_set(Eina_Bool enabled);
2773
2774    /**
2775     * Get the amount of inertia a scroller will impose at bounce
2776     * animations.
2777     *
2778     * @return the thumb scroll bounce friction
2779     *
2780     * @ingroup Scrolling
2781     */
2782    EAPI double           elm_scroll_bounce_friction_get(void);
2783
2784    /**
2785     * Set the amount of inertia a scroller will impose at bounce
2786     * animations.
2787     *
2788     * @param friction the thumb scroll bounce friction
2789     *
2790     * @see elm_thumbscroll_bounce_friction_get()
2791     * @ingroup Scrolling
2792     */
2793    EAPI void             elm_scroll_bounce_friction_set(double friction);
2794
2795    /**
2796     * Set the amount of inertia a scroller will impose at bounce
2797     * animations, for all Elementary application windows.
2798     *
2799     * @param friction the thumb scroll bounce friction
2800     *
2801     * @see elm_thumbscroll_bounce_friction_get()
2802     * @ingroup Scrolling
2803     */
2804    EAPI void             elm_scroll_bounce_friction_all_set(double friction);
2805
2806    /**
2807     * Get the amount of inertia a <b>paged</b> scroller will impose at
2808     * page fitting animations.
2809     *
2810     * @return the page scroll friction
2811     *
2812     * @ingroup Scrolling
2813     */
2814    EAPI double           elm_scroll_page_scroll_friction_get(void);
2815
2816    /**
2817     * Set the amount of inertia a <b>paged</b> scroller will impose at
2818     * page fitting animations.
2819     *
2820     * @param friction the page scroll friction
2821     *
2822     * @see elm_thumbscroll_page_scroll_friction_get()
2823     * @ingroup Scrolling
2824     */
2825    EAPI void             elm_scroll_page_scroll_friction_set(double friction);
2826
2827    /**
2828     * Set the amount of inertia a <b>paged</b> scroller will impose at
2829     * page fitting animations, for all Elementary application windows.
2830     *
2831     * @param friction the page scroll friction
2832     *
2833     * @see elm_thumbscroll_page_scroll_friction_get()
2834     * @ingroup Scrolling
2835     */
2836    EAPI void             elm_scroll_page_scroll_friction_all_set(double friction);
2837
2838    /**
2839     * Get the amount of inertia a scroller will impose at region bring
2840     * animations.
2841     *
2842     * @return the bring in scroll friction
2843     *
2844     * @ingroup Scrolling
2845     */
2846    EAPI double           elm_scroll_bring_in_scroll_friction_get(void);
2847
2848    /**
2849     * Set the amount of inertia a scroller will impose at region bring
2850     * animations.
2851     *
2852     * @param friction the bring in scroll friction
2853     *
2854     * @see elm_thumbscroll_bring_in_scroll_friction_get()
2855     * @ingroup Scrolling
2856     */
2857    EAPI void             elm_scroll_bring_in_scroll_friction_set(double friction);
2858
2859    /**
2860     * Set the amount of inertia a scroller will impose at region bring
2861     * animations, for all Elementary application windows.
2862     *
2863     * @param friction the bring in scroll friction
2864     *
2865     * @see elm_thumbscroll_bring_in_scroll_friction_get()
2866     * @ingroup Scrolling
2867     */
2868    EAPI void             elm_scroll_bring_in_scroll_friction_all_set(double friction);
2869
2870    /**
2871     * Get the amount of inertia scrollers will impose at animations
2872     * triggered by Elementary widgets' zooming API.
2873     *
2874     * @return the zoom friction
2875     *
2876     * @ingroup Scrolling
2877     */
2878    EAPI double           elm_scroll_zoom_friction_get(void);
2879
2880    /**
2881     * Set the amount of inertia scrollers will impose at animations
2882     * triggered by Elementary widgets' zooming API.
2883     *
2884     * @param friction the zoom friction
2885     *
2886     * @see elm_thumbscroll_zoom_friction_get()
2887     * @ingroup Scrolling
2888     */
2889    EAPI void             elm_scroll_zoom_friction_set(double friction);
2890
2891    /**
2892     * Set the amount of inertia scrollers will impose at animations
2893     * triggered by Elementary widgets' zooming API, for all Elementary
2894     * application windows.
2895     *
2896     * @param friction the zoom friction
2897     *
2898     * @see elm_thumbscroll_zoom_friction_get()
2899     * @ingroup Scrolling
2900     */
2901    EAPI void             elm_scroll_zoom_friction_all_set(double friction);
2902
2903    /**
2904     * Get whether scrollers should be draggable from any point in their
2905     * views.
2906     *
2907     * @return the thumb scroll state
2908     *
2909     * @note This is the default behavior for touch screens, in general.
2910     * @note All other functions namespaced with "thumbscroll" will only
2911     *       have effect if this mode is enabled.
2912     *
2913     * @ingroup Scrolling
2914     */
2915    EAPI Eina_Bool        elm_scroll_thumbscroll_enabled_get(void);
2916
2917    /**
2918     * Set whether scrollers should be draggable from any point in their
2919     * views.
2920     *
2921     * @param enabled the thumb scroll state
2922     *
2923     * @see elm_thumbscroll_enabled_get()
2924     * @ingroup Scrolling
2925     */
2926    EAPI void             elm_scroll_thumbscroll_enabled_set(Eina_Bool enabled);
2927
2928    /**
2929     * Set whether scrollers should be draggable from any point in their
2930     * views, for all Elementary application windows.
2931     *
2932     * @param enabled the thumb scroll state
2933     *
2934     * @see elm_thumbscroll_enabled_get()
2935     * @ingroup Scrolling
2936     */
2937    EAPI void             elm_scroll_thumbscroll_enabled_all_set(Eina_Bool enabled);
2938
2939    /**
2940     * Get the number of pixels one should travel while dragging a
2941     * scroller's view to actually trigger scrolling.
2942     *
2943     * @return the thumb scroll threshould
2944     *
2945     * One would use higher values for touch screens, in general, because
2946     * of their inherent imprecision.
2947     * @ingroup Scrolling
2948     */
2949    EAPI unsigned int     elm_scroll_thumbscroll_threshold_get(void);
2950
2951    /**
2952     * Set the number of pixels one should travel while dragging a
2953     * scroller's view to actually trigger scrolling.
2954     *
2955     * @param threshold the thumb scroll threshould
2956     *
2957     * @see elm_thumbscroll_threshould_get()
2958     * @ingroup Scrolling
2959     */
2960    EAPI void             elm_scroll_thumbscroll_threshold_set(unsigned int threshold);
2961
2962    /**
2963     * Set the number of pixels one should travel while dragging a
2964     * scroller's view to actually trigger scrolling, for all Elementary
2965     * application windows.
2966     *
2967     * @param threshold the thumb scroll threshould
2968     *
2969     * @see elm_thumbscroll_threshould_get()
2970     * @ingroup Scrolling
2971     */
2972    EAPI void             elm_scroll_thumbscroll_threshold_all_set(unsigned int threshold);
2973
2974    /**
2975     * Get the minimum speed of mouse cursor movement which will trigger
2976     * list self scrolling animation after a mouse up event
2977     * (pixels/second).
2978     *
2979     * @return the thumb scroll momentum threshould
2980     *
2981     * @ingroup Scrolling
2982     */
2983    EAPI double           elm_scroll_thumbscroll_momentum_threshold_get(void);
2984
2985    /**
2986     * Set the minimum speed of mouse cursor movement which will trigger
2987     * list self scrolling animation after a mouse up event
2988     * (pixels/second).
2989     *
2990     * @param threshold the thumb scroll momentum threshould
2991     *
2992     * @see elm_thumbscroll_momentum_threshould_get()
2993     * @ingroup Scrolling
2994     */
2995    EAPI void             elm_scroll_thumbscroll_momentum_threshold_set(double threshold);
2996
2997    /**
2998     * Set the minimum speed of mouse cursor movement which will trigger
2999     * list self scrolling animation after a mouse up event
3000     * (pixels/second), for all Elementary application windows.
3001     *
3002     * @param threshold the thumb scroll momentum threshould
3003     *
3004     * @see elm_thumbscroll_momentum_threshould_get()
3005     * @ingroup Scrolling
3006     */
3007    EAPI void             elm_scroll_thumbscroll_momentum_threshold_all_set(double threshold);
3008
3009    /**
3010     * Get the amount of inertia a scroller will impose at self scrolling
3011     * animations.
3012     *
3013     * @return the thumb scroll friction
3014     *
3015     * @ingroup Scrolling
3016     */
3017    EAPI double           elm_scroll_thumbscroll_friction_get(void);
3018
3019    /**
3020     * Set the amount of inertia a scroller will impose at self scrolling
3021     * animations.
3022     *
3023     * @param friction the thumb scroll friction
3024     *
3025     * @see elm_thumbscroll_friction_get()
3026     * @ingroup Scrolling
3027     */
3028    EAPI void             elm_scroll_thumbscroll_friction_set(double friction);
3029
3030    /**
3031     * Set the amount of inertia a scroller will impose at self scrolling
3032     * animations, for all Elementary application windows.
3033     *
3034     * @param friction the thumb scroll friction
3035     *
3036     * @see elm_thumbscroll_friction_get()
3037     * @ingroup Scrolling
3038     */
3039    EAPI void             elm_scroll_thumbscroll_friction_all_set(double friction);
3040
3041    /**
3042     * Get the amount of lag between your actual mouse cursor dragging
3043     * movement and a scroller's view movement itself, while pushing it
3044     * into bounce state manually.
3045     *
3046     * @return the thumb scroll border friction
3047     *
3048     * @ingroup Scrolling
3049     */
3050    EAPI double           elm_scroll_thumbscroll_border_friction_get(void);
3051
3052    /**
3053     * Set the amount of lag between your actual mouse cursor dragging
3054     * movement and a scroller's view movement itself, while pushing it
3055     * into bounce state manually.
3056     *
3057     * @param friction the thumb scroll border friction. @c 0.0 for
3058     *        perfect synchrony between two movements, @c 1.0 for maximum
3059     *        lag.
3060     *
3061     * @see elm_thumbscroll_border_friction_get()
3062     * @note parameter value will get bound to 0.0 - 1.0 interval, always
3063     *
3064     * @ingroup Scrolling
3065     */
3066    EAPI void             elm_scroll_thumbscroll_border_friction_set(double friction);
3067
3068    /**
3069     * Set the amount of lag between your actual mouse cursor dragging
3070     * movement and a scroller's view movement itself, while pushing it
3071     * into bounce state manually, for all Elementary application windows.
3072     *
3073     * @param friction the thumb scroll border friction. @c 0.0 for
3074     *        perfect synchrony between two movements, @c 1.0 for maximum
3075     *        lag.
3076     *
3077     * @see elm_thumbscroll_border_friction_get()
3078     * @note parameter value will get bound to 0.0 - 1.0 interval, always
3079     *
3080     * @ingroup Scrolling
3081     */
3082    EAPI void             elm_scroll_thumbscroll_border_friction_all_set(double friction);
3083
3084    /**
3085     * Get the sensitivity amount which is be multiplied by the length of
3086     * mouse dragging.
3087     *
3088     * @return the thumb scroll sensitivity friction
3089     *
3090     * @ingroup Scrolling
3091     */
3092    EAPI double           elm_scroll_thumbscroll_sensitivity_friction_get(void);
3093
3094    /**
3095     * Set the sensitivity amount which is be multiplied by the length of
3096     * mouse dragging.
3097     *
3098     * @param friction the thumb scroll sensitivity friction. @c 0.1 for
3099     *        minimun sensitivity, @c 1.0 for maximum sensitivity. 0.25
3100     *        is proper.
3101     *
3102     * @see elm_thumbscroll_sensitivity_friction_get()
3103     * @note parameter value will get bound to 0.1 - 1.0 interval, always
3104     *
3105     * @ingroup Scrolling
3106     */
3107    EAPI void             elm_scroll_thumbscroll_sensitivity_friction_set(double friction);
3108
3109    /**
3110     * Set the sensitivity amount which is be multiplied by the length of
3111     * mouse dragging, for all Elementary application windows.
3112     *
3113     * @param friction the thumb scroll sensitivity friction. @c 0.1 for
3114     *        minimun sensitivity, @c 1.0 for maximum sensitivity. 0.25
3115     *        is proper.
3116     *
3117     * @see elm_thumbscroll_sensitivity_friction_get()
3118     * @note parameter value will get bound to 0.1 - 1.0 interval, always
3119     *
3120     * @ingroup Scrolling
3121     */
3122    EAPI void             elm_scroll_thumbscroll_sensitivity_friction_all_set(double friction);
3123
3124    /**
3125     * @}
3126     */
3127
3128    /**
3129     * @defgroup Scrollhints Scrollhints
3130     *
3131     * Objects when inside a scroller can scroll, but this may not always be
3132     * desirable in certain situations. This allows an object to hint to itself
3133     * and parents to "not scroll" in one of 2 ways. If any child object of a
3134     * scroller has pushed a scroll freeze or hold then it affects all parent
3135     * scrollers until all children have released them.
3136     *
3137     * 1. To hold on scrolling. This means just flicking and dragging may no
3138     * longer scroll, but pressing/dragging near an edge of the scroller will
3139     * still scroll. This is automatically used by the entry object when
3140     * selecting text.
3141     *
3142     * 2. To totally freeze scrolling. This means it stops. until
3143     * popped/released.
3144     *
3145     * @{
3146     */
3147
3148    /**
3149     * Push the scroll hold by 1
3150     *
3151     * This increments the scroll hold count by one. If it is more than 0 it will
3152     * take effect on the parents of the indicated object.
3153     *
3154     * @param obj The object
3155     * @ingroup Scrollhints
3156     */
3157    EAPI void             elm_object_scroll_hold_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
3158
3159    /**
3160     * Pop the scroll hold by 1
3161     *
3162     * This decrements the scroll hold count by one. If it is more than 0 it will
3163     * take effect on the parents of the indicated object.
3164     *
3165     * @param obj The object
3166     * @ingroup Scrollhints
3167     */
3168    EAPI void             elm_object_scroll_hold_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
3169
3170    /**
3171     * Push the scroll freeze by 1
3172     *
3173     * This increments the scroll freeze count by one. If it is more
3174     * than 0 it will take effect on the parents of the indicated
3175     * object.
3176     *
3177     * @param obj The object
3178     * @ingroup Scrollhints
3179     */
3180    EAPI void             elm_object_scroll_freeze_push(Evas_Object *obj) EINA_ARG_NONNULL(1);
3181
3182    /**
3183     * Pop the scroll freeze by 1
3184     *
3185     * This decrements the scroll freeze count by one. If it is more
3186     * than 0 it will take effect on the parents of the indicated
3187     * object.
3188     *
3189     * @param obj The object
3190     * @ingroup Scrollhints
3191     */
3192    EAPI void             elm_object_scroll_freeze_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
3193
3194    /**
3195     * Lock the scrolling of the given widget (and thus all parents)
3196     *
3197     * This locks the given object from scrolling in the X axis (and implicitly
3198     * also locks all parent scrollers too from doing the same).
3199     *
3200     * @param obj The object
3201     * @param lock The lock state (1 == locked, 0 == unlocked)
3202     * @ingroup Scrollhints
3203     */
3204    EAPI void             elm_object_scroll_lock_x_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
3205
3206    /**
3207     * Lock the scrolling of the given widget (and thus all parents)
3208     *
3209     * This locks the given object from scrolling in the Y axis (and implicitly
3210     * also locks all parent scrollers too from doing the same).
3211     *
3212     * @param obj The object
3213     * @param lock The lock state (1 == locked, 0 == unlocked)
3214     * @ingroup Scrollhints
3215     */
3216    EAPI void             elm_object_scroll_lock_y_set(Evas_Object *obj, Eina_Bool lock) EINA_ARG_NONNULL(1);
3217
3218    /**
3219     * Get the scrolling lock of the given widget
3220     *
3221     * This gets the lock for X axis scrolling.
3222     *
3223     * @param obj The object
3224     * @ingroup Scrollhints
3225     */
3226    EAPI Eina_Bool        elm_object_scroll_lock_x_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3227
3228    /**
3229     * Get the scrolling lock of the given widget
3230     *
3231     * This gets the lock for X axis scrolling.
3232     *
3233     * @param obj The object
3234     * @ingroup Scrollhints
3235     */
3236    EAPI Eina_Bool        elm_object_scroll_lock_y_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3237
3238    /**
3239     * @}
3240     */
3241
3242    /**
3243     * Send a signal to the widget edje object.
3244     *
3245     * This function sends a signal to the edje object of the obj. An
3246     * edje program can respond to a signal by specifying matching
3247     * 'signal' and 'source' fields.
3248     *
3249     * @param obj The object
3250     * @param emission The signal's name.
3251     * @param source The signal's source.
3252     * @ingroup General
3253     */
3254    EAPI void             elm_object_signal_emit(Evas_Object *obj, const char *emission, const char *source) EINA_ARG_NONNULL(1);
3255
3256    /**
3257     * Add a callback for a signal emitted by widget edje object.
3258     *
3259     * This function connects a callback function to a signal emitted by the
3260     * edje object of the obj.
3261     * Globs can occur in either the emission or source name.
3262     *
3263     * @param obj The object
3264     * @param emission The signal's name.
3265     * @param source The signal's source.
3266     * @param func The callback function to be executed when the signal is
3267     * emitted.
3268     * @param data A pointer to data to pass in to the callback function.
3269     * @ingroup General
3270     */
3271    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);
3272
3273    /**
3274     * Remove a signal-triggered callback from a widget edje object.
3275     *
3276     * This function removes a callback, previoulsy attached to a
3277     * signal emitted by the edje object of the obj.  The parameters
3278     * emission, source and func must match exactly those passed to a
3279     * previous call to elm_object_signal_callback_add(). The data
3280     * pointer that was passed to this call will be returned.
3281     *
3282     * @param obj The object
3283     * @param emission The signal's name.
3284     * @param source The signal's source.
3285     * @param func The callback function to be executed when the signal is
3286     * emitted.
3287     * @return The data pointer
3288     * @ingroup General
3289     */
3290    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);
3291
3292    /**
3293     * Add a callback for input events (key up, key down, mouse wheel)
3294     * on a given Elementary widget
3295     *
3296     * @param obj The widget to add an event callback on
3297     * @param func The callback function to be executed when the event
3298     * happens
3299     * @param data Data to pass in to @p func
3300     *
3301     * Every widget in an Elementary interface set to receive focus,
3302     * with elm_object_focus_allow_set(), will propagate @b all of its
3303     * key up, key down and mouse wheel input events up to its parent
3304     * object, and so on. All of the focusable ones in this chain which
3305     * had an event callback set, with this call, will be able to treat
3306     * those events. There are two ways of making the propagation of
3307     * these event upwards in the tree of widgets to @b cease:
3308     * - Just return @c EINA_TRUE on @p func. @c EINA_FALSE will mean
3309     *   the event was @b not processed, so the propagation will go on.
3310     * - The @c event_info pointer passed to @p func will contain the
3311     *   event's structure and, if you OR its @c event_flags inner
3312     *   value to @c EVAS_EVENT_FLAG_ON_HOLD, you're telling Elementary
3313     *   one has already handled it, thus killing the event's
3314     *   propagation, too.
3315     *
3316     * @note Your event callback will be issued on those events taking
3317     * place only if no other child widget of @obj has consumed the
3318     * event already.
3319     *
3320     * @note Not to be confused with @c
3321     * evas_object_event_callback_add(), which will add event callbacks
3322     * per type on general Evas objects (no event propagation
3323     * infrastructure taken in account).
3324     *
3325     * @note Not to be confused with @c
3326     * elm_object_signal_callback_add(), which will add callbacks to @b
3327     * signals coming from a widget's theme, not input events.
3328     *
3329     * @note Not to be confused with @c
3330     * edje_object_signal_callback_add(), which does the same as
3331     * elm_object_signal_callback_add(), but directly on an Edje
3332     * object.
3333     *
3334     * @note Not to be confused with @c
3335     * evas_object_smart_callback_add(), which adds callbacks to smart
3336     * objects' <b>smart events</b>, and not input events.
3337     *
3338     * @see elm_object_event_callback_del()
3339     *
3340     * @ingroup General
3341     */
3342    EAPI void             elm_object_event_callback_add(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
3343
3344    /**
3345     * Remove an event callback from a widget.
3346     *
3347     * This function removes a callback, previoulsy attached to event emission
3348     * by the @p obj.
3349     * The parameters func and data must match exactly those passed to
3350     * a previous call to elm_object_event_callback_add(). The data pointer that
3351     * was passed to this call will be returned.
3352     *
3353     * @param obj The object
3354     * @param func The callback function to be executed when the event is
3355     * emitted.
3356     * @param data Data to pass in to the callback function.
3357     * @return The data pointer
3358     * @ingroup General
3359     */
3360    EAPI void            *elm_object_event_callback_del(Evas_Object *obj, Elm_Event_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
3361
3362    /**
3363     * Adjust size of an element for finger usage.
3364     *
3365     * @param times_w How many fingers should fit horizontally
3366     * @param w Pointer to the width size to adjust
3367     * @param times_h How many fingers should fit vertically
3368     * @param h Pointer to the height size to adjust
3369     *
3370     * This takes width and height sizes (in pixels) as input and a
3371     * size multiple (which is how many fingers you want to place
3372     * within the area, being "finger" the size set by
3373     * elm_finger_size_set()), and adjusts the size to be large enough
3374     * to accommodate the resulting size -- if it doesn't already
3375     * accommodate it. On return the @p w and @p h sizes pointed to by
3376     * these parameters will be modified, on those conditions.
3377     *
3378     * @note This is kind of a low level Elementary call, most useful
3379     * on size evaluation times for widgets. An external user wouldn't
3380     * be calling, most of the time.
3381     *
3382     * @ingroup Fingers
3383     */
3384    EAPI void             elm_coords_finger_size_adjust(int times_w, Evas_Coord *w, int times_h, Evas_Coord *h);
3385
3386    /**
3387     * Get the duration for occuring long press event.
3388     *
3389     * @return Timeout for long press event
3390     * @ingroup Longpress
3391     */
3392    EAPI double           elm_longpress_timeout_get(void);
3393
3394    /**
3395     * Set the duration for occuring long press event.
3396     *
3397     * @param lonpress_timeout Timeout for long press event
3398     * @ingroup Longpress
3399     */
3400    EAPI void             elm_longpress_timeout_set(double longpress_timeout);
3401
3402    /**
3403     * @defgroup Debug Debug
3404     * don't use it unless you are sure
3405     *
3406     * @{
3407     */
3408
3409    /**
3410     * Print Tree object hierarchy in stdout
3411     *
3412     * @param obj The root object
3413     * @ingroup Debug
3414     */
3415    EAPI void             elm_object_tree_dump(const Evas_Object *top);
3416    EAPI void             elm_object_tree_dot_dump(const Evas_Object *top, const char *file);
3417
3418    EAPI void             elm_autocapitalization_allow_all_set(Eina_Bool autocap);
3419    EAPI void             elm_autoperiod_allow_all_set(Eina_Bool autoperiod);
3420    /**
3421     * Print Elm Objects tree hierarchy in file as dot(graphviz) syntax.
3422     *
3423     * @param obj The root object
3424     * @param file The path of output file
3425     * @ingroup Debug
3426     */
3427    EAPI void             elm_object_tree_dot_dump(const Evas_Object *top, const char *file);
3428
3429    /**
3430     * @}
3431     */
3432
3433    /**
3434     * @defgroup Theme Theme
3435     *
3436     * Elementary uses Edje to theme its widgets, naturally. But for the most
3437     * part this is hidden behind a simpler interface that lets the user set
3438     * extensions and choose the style of widgets in a much easier way.
3439     *
3440     * Instead of thinking in terms of paths to Edje files and their groups
3441     * each time you want to change the appearance of a widget, Elementary
3442     * works so you can add any theme file with extensions or replace the
3443     * main theme at one point in the application, and then just set the style
3444     * of widgets with elm_object_style_set() and related functions. Elementary
3445     * will then look in its list of themes for a matching group and apply it,
3446     * and when the theme changes midway through the application, all widgets
3447     * will be updated accordingly.
3448     *
3449     * There are three concepts you need to know to understand how Elementary
3450     * theming works: default theme, extensions and overlays.
3451     *
3452     * Default theme, obviously enough, is the one that provides the default
3453     * look of all widgets. End users can change the theme used by Elementary
3454     * by setting the @c ELM_THEME environment variable before running an
3455     * application, or globally for all programs using the @c elementary_config
3456     * utility. Applications can change the default theme using elm_theme_set(),
3457     * but this can go against the user wishes, so it's not an adviced practice.
3458     *
3459     * Ideally, applications should find everything they need in the already
3460     * provided theme, but there may be occasions when that's not enough and
3461     * custom styles are required to correctly express the idea. For this
3462     * cases, Elementary has extensions.
3463     *
3464     * Extensions allow the application developer to write styles of its own
3465     * to apply to some widgets. This requires knowledge of how each widget
3466     * is themed, as extensions will always replace the entire group used by
3467     * the widget, so important signals and parts need to be there for the
3468     * object to behave properly (see documentation of Edje for details).
3469     * Once the theme for the extension is done, the application needs to add
3470     * it to the list of themes Elementary will look into, using
3471     * elm_theme_extension_add(), and set the style of the desired widgets as
3472     * he would normally with elm_object_style_set().
3473     *
3474     * Overlays, on the other hand, can replace the look of all widgets by
3475     * overriding the default style. Like extensions, it's up to the application
3476     * developer to write the theme for the widgets it wants, the difference
3477     * being that when looking for the theme, Elementary will check first the
3478     * list of overlays, then the set theme and lastly the list of extensions,
3479     * so with overlays it's possible to replace the default view and every
3480     * widget will be affected. This is very much alike to setting the whole
3481     * theme for the application and will probably clash with the end user
3482     * options, not to mention the risk of ending up with not matching styles
3483     * across the program. Unless there's a very special reason to use them,
3484     * overlays should be avoided for the resons exposed before.
3485     *
3486     * All these theme lists are handled by ::Elm_Theme instances. Elementary
3487     * keeps one default internally and every function that receives one of
3488     * these can be called with NULL to refer to this default (except for
3489     * elm_theme_free()). It's possible to create a new instance of a
3490     * ::Elm_Theme to set other theme for a specific widget (and all of its
3491     * children), but this is as discouraged, if not even more so, than using
3492     * overlays. Don't use this unless you really know what you are doing.
3493     *
3494     * But to be less negative about things, you can look at the following
3495     * examples:
3496     * @li @ref theme_example_01 "Using extensions"
3497     * @li @ref theme_example_02 "Using overlays"
3498     *
3499     * @{
3500     */
3501    /**
3502     * @typedef Elm_Theme
3503     *
3504     * Opaque handler for the list of themes Elementary looks for when
3505     * rendering widgets.
3506     *
3507     * Stay out of this unless you really know what you are doing. For most
3508     * cases, sticking to the default is all a developer needs.
3509     */
3510    typedef struct _Elm_Theme Elm_Theme;
3511
3512    /**
3513     * Create a new specific theme
3514     *
3515     * This creates an empty specific theme that only uses the default theme. A
3516     * specific theme has its own private set of extensions and overlays too
3517     * (which are empty by default). Specific themes do not fall back to themes
3518     * of parent objects. They are not intended for this use. Use styles, overlays
3519     * and extensions when needed, but avoid specific themes unless there is no
3520     * other way (example: you want to have a preview of a new theme you are
3521     * selecting in a "theme selector" window. The preview is inside a scroller
3522     * and should display what the theme you selected will look like, but not
3523     * actually apply it yet. The child of the scroller will have a specific
3524     * theme set to show this preview before the user decides to apply it to all
3525     * applications).
3526     */
3527    EAPI Elm_Theme       *elm_theme_new(void);
3528    /**
3529     * Free a specific theme
3530     *
3531     * @param th The theme to free
3532     *
3533     * This frees a theme created with elm_theme_new().
3534     */
3535    EAPI void             elm_theme_free(Elm_Theme *th);
3536    /**
3537     * Copy the theme fom the source to the destination theme
3538     *
3539     * @param th The source theme to copy from
3540     * @param thdst The destination theme to copy data to
3541     *
3542     * This makes a one-time static copy of all the theme config, extensions
3543     * and overlays from @p th to @p thdst. If @p th references a theme, then
3544     * @p thdst is also set to reference it, with all the theme settings,
3545     * overlays and extensions that @p th had.
3546     */
3547    EAPI void             elm_theme_copy(Elm_Theme *th, Elm_Theme *thdst);
3548    /**
3549     * Tell the source theme to reference the ref theme
3550     *
3551     * @param th The theme that will do the referencing
3552     * @param thref The theme that is the reference source
3553     *
3554     * This clears @p th to be empty and then sets it to refer to @p thref
3555     * so @p th acts as an override to @p thref, but where its overrides
3556     * don't apply, it will fall through to @p thref for configuration.
3557     */
3558    EAPI void             elm_theme_ref_set(Elm_Theme *th, Elm_Theme *thref);
3559    /**
3560     * Return the theme referred to
3561     *
3562     * @param th The theme to get the reference from
3563     * @return The referenced theme handle
3564     *
3565     * This gets the theme set as the reference theme by elm_theme_ref_set().
3566     * If no theme is set as a reference, NULL is returned.
3567     */
3568    EAPI Elm_Theme       *elm_theme_ref_get(Elm_Theme *th);
3569    /**
3570     * Return the default theme
3571     *
3572     * @return The default theme handle
3573     *
3574     * This returns the internal default theme setup handle that all widgets
3575     * use implicitly unless a specific theme is set. This is also often use
3576     * as a shorthand of NULL.
3577     */
3578    EAPI Elm_Theme       *elm_theme_default_get(void);
3579    /**
3580     * Prepends a theme overlay to the list of overlays
3581     *
3582     * @param th The theme to add to, or if NULL, the default theme
3583     * @param item The Edje file path to be used
3584     *
3585     * Use this if your application needs to provide some custom overlay theme
3586     * (An Edje file that replaces some default styles of widgets) where adding
3587     * new styles, or changing system theme configuration is not possible. Do
3588     * NOT use this instead of a proper system theme configuration. Use proper
3589     * configuration files, profiles, environment variables etc. to set a theme
3590     * so that the theme can be altered by simple confiugration by a user. Using
3591     * this call to achieve that effect is abusing the API and will create lots
3592     * of trouble.
3593     *
3594     * @see elm_theme_extension_add()
3595     */
3596    EAPI void             elm_theme_overlay_add(Elm_Theme *th, const char *item);
3597    /**
3598     * Delete a theme overlay from the list of overlays
3599     *
3600     * @param th The theme to delete from, or if NULL, the default theme
3601     * @param item The name of the theme overlay
3602     *
3603     * @see elm_theme_overlay_add()
3604     */
3605    EAPI void             elm_theme_overlay_del(Elm_Theme *th, const char *item);
3606    /**
3607     * Appends a theme extension to the list of extensions.
3608     *
3609     * @param th The theme to add to, or if NULL, the default theme
3610     * @param item The Edje file path to be used
3611     *
3612     * This is intended when an application needs more styles of widgets or new
3613     * widget themes that the default does not provide (or may not provide). The
3614     * application has "extended" usage by coming up with new custom style names
3615     * for widgets for specific uses, but as these are not "standard", they are
3616     * not guaranteed to be provided by a default theme. This means the
3617     * application is required to provide these extra elements itself in specific
3618     * Edje files. This call adds one of those Edje files to the theme search
3619     * path to be search after the default theme. The use of this call is
3620     * encouraged when default styles do not meet the needs of the application.
3621     * Use this call instead of elm_theme_overlay_add() for almost all cases.
3622     *
3623     * @see elm_object_style_set()
3624     */
3625    EAPI void             elm_theme_extension_add(Elm_Theme *th, const char *item);
3626    /**
3627     * Deletes a theme extension from the list of extensions.
3628     *
3629     * @param th The theme to delete from, or if NULL, the default theme
3630     * @param item The name of the theme extension
3631     *
3632     * @see elm_theme_extension_add()
3633     */
3634    EAPI void             elm_theme_extension_del(Elm_Theme *th, const char *item);
3635    /**
3636     * Set the theme search order for the given theme
3637     *
3638     * @param th The theme to set the search order, or if NULL, the default theme
3639     * @param theme Theme search string
3640     *
3641     * This sets the search string for the theme in path-notation from first
3642     * theme to search, to last, delimited by the : character. Example:
3643     *
3644     * "shiny:/path/to/file.edj:default"
3645     *
3646     * See the ELM_THEME environment variable for more information.
3647     *
3648     * @see elm_theme_get()
3649     * @see elm_theme_list_get()
3650     */
3651    EAPI void             elm_theme_set(Elm_Theme *th, const char *theme);
3652    /**
3653     * Return the theme search order
3654     *
3655     * @param th The theme to get the search order, or if NULL, the default theme
3656     * @return The internal search order path
3657     *
3658     * This function returns a colon separated string of theme elements as
3659     * returned by elm_theme_list_get().
3660     *
3661     * @see elm_theme_set()
3662     * @see elm_theme_list_get()
3663     */
3664    EAPI const char      *elm_theme_get(Elm_Theme *th);
3665    /**
3666     * Return a list of theme elements to be used in a theme.
3667     *
3668     * @param th Theme to get the list of theme elements from.
3669     * @return The internal list of theme elements
3670     *
3671     * This returns the internal list of theme elements (will only be valid as
3672     * long as the theme is not modified by elm_theme_set() or theme is not
3673     * freed by elm_theme_free(). This is a list of strings which must not be
3674     * altered as they are also internal. If @p th is NULL, then the default
3675     * theme element list is returned.
3676     *
3677     * A theme element can consist of a full or relative path to a .edj file,
3678     * or a name, without extension, for a theme to be searched in the known
3679     * theme paths for Elemementary.
3680     *
3681     * @see elm_theme_set()
3682     * @see elm_theme_get()
3683     */
3684    EAPI const Eina_List *elm_theme_list_get(const Elm_Theme *th);
3685    /**
3686     * Return the full patrh for a theme element
3687     *
3688     * @param f The theme element name
3689     * @param in_search_path Pointer to a boolean to indicate if item is in the search path or not
3690     * @return The full path to the file found.
3691     *
3692     * This returns a string you should free with free() on success, NULL on
3693     * failure. This will search for the given theme element, and if it is a
3694     * full or relative path element or a simple searchable name. The returned
3695     * path is the full path to the file, if searched, and the file exists, or it
3696     * is simply the full path given in the element or a resolved path if
3697     * relative to home. The @p in_search_path boolean pointed to is set to
3698     * EINA_TRUE if the file was a searchable file andis in the search path,
3699     * and EINA_FALSE otherwise.
3700     */
3701    EAPI char            *elm_theme_list_item_path_get(const char *f, Eina_Bool *in_search_path);
3702    /**
3703     * Flush the current theme.
3704     *
3705     * @param th Theme to flush
3706     *
3707     * This flushes caches that let elementary know where to find theme elements
3708     * in the given theme. If @p th is NULL, then the default theme is flushed.
3709     * Call this function if source theme data has changed in such a way as to
3710     * make any caches Elementary kept invalid.
3711     */
3712    EAPI void             elm_theme_flush(Elm_Theme *th);
3713    /**
3714     * This flushes all themes (default and specific ones).
3715     *
3716     * This will flush all themes in the current application context, by calling
3717     * elm_theme_flush() on each of them.
3718     */
3719    EAPI void             elm_theme_full_flush(void);
3720    /**
3721     * Set the theme for all elementary using applications on the current display
3722     *
3723     * @param theme The name of the theme to use. Format same as the ELM_THEME
3724     * environment variable.
3725     */
3726    EAPI void             elm_theme_all_set(const char *theme);
3727    /**
3728     * Return a list of theme elements in the theme search path
3729     *
3730     * @return A list of strings that are the theme element names.
3731     *
3732     * This lists all available theme files in the standard Elementary search path
3733     * for theme elements, and returns them in alphabetical order as theme
3734     * element names in a list of strings. Free this with
3735     * elm_theme_name_available_list_free() when you are done with the list.
3736     */
3737    EAPI Eina_List       *elm_theme_name_available_list_new(void);
3738    /**
3739     * Free the list returned by elm_theme_name_available_list_new()
3740     *
3741     * This frees the list of themes returned by
3742     * elm_theme_name_available_list_new(). Once freed the list should no longer
3743     * be used. a new list mys be created.
3744     */
3745    EAPI void             elm_theme_name_available_list_free(Eina_List *list);
3746    /**
3747     * Set a specific theme to be used for this object and its children
3748     *
3749     * @param obj The object to set the theme on
3750     * @param th The theme to set
3751     *
3752     * This sets a specific theme that will be used for the given object and any
3753     * child objects it has. If @p th is NULL then the theme to be used is
3754     * cleared and the object will inherit its theme from its parent (which
3755     * ultimately will use the default theme if no specific themes are set).
3756     *
3757     * Use special themes with great care as this will annoy users and make
3758     * configuration difficult. Avoid any custom themes at all if it can be
3759     * helped.
3760     */
3761    EAPI void             elm_object_theme_set(Evas_Object *obj, Elm_Theme *th) EINA_ARG_NONNULL(1);
3762    /**
3763     * Get the specific theme to be used
3764     *
3765     * @param obj The object to get the specific theme from
3766     * @return The specifc theme set.
3767     *
3768     * This will return a specific theme set, or NULL if no specific theme is
3769     * set on that object. It will not return inherited themes from parents, only
3770     * the specific theme set for that specific object. See elm_object_theme_set()
3771     * for more information.
3772     */
3773    EAPI Elm_Theme       *elm_object_theme_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
3774
3775    /**
3776     * Get a data item from a theme
3777     *
3778     * @param th The theme, or NULL for default theme
3779     * @param key The data key to search with
3780     * @return The data value, or NULL on failure
3781     *
3782     * This function is used to return data items from edc in @p th, an overlay, or an extension.
3783     * It works the same way as edje_file_data_get() except that the return is stringshared.
3784     */
3785    EAPI const char      *elm_theme_data_get(Elm_Theme *th, const char *key) EINA_ARG_NONNULL(2);
3786    /**
3787     * @}
3788     */
3789
3790    /* win */
3791    /** @defgroup Win Win
3792     *
3793     * @image html img/widget/win/preview-00.png
3794     * @image latex img/widget/win/preview-00.eps
3795     *
3796     * The window class of Elementary.  Contains functions to manipulate
3797     * windows. The Evas engine used to render the window contents is specified
3798     * in the system or user elementary config files (whichever is found last),
3799     * and can be overridden with the ELM_ENGINE environment variable for
3800     * testing.  Engines that may be supported (depending on Evas and Ecore-Evas
3801     * compilation setup and modules actually installed at runtime) are (listed
3802     * in order of best supported and most likely to be complete and work to
3803     * lowest quality).
3804     *
3805     * @li "x11", "x", "software-x11", "software_x11" (Software rendering in X11)
3806     * @li "gl", "opengl", "opengl-x11", "opengl_x11" (OpenGL or OpenGL-ES2
3807     * rendering in X11)
3808     * @li "shot:..." (Virtual screenshot renderer - renders to output file and
3809     * exits)
3810     * @li "fb", "software-fb", "software_fb" (Linux framebuffer direct software
3811     * rendering)
3812     * @li "sdl", "software-sdl", "software_sdl" (SDL software rendering to SDL
3813     * buffer)
3814     * @li "gl-sdl", "gl_sdl", "opengl-sdl", "opengl_sdl" (OpenGL or OpenGL-ES2
3815     * rendering using SDL as the buffer)
3816     * @li "gdi", "software-gdi", "software_gdi" (Windows WIN32 rendering via
3817     * GDI with software)
3818     * @li "dfb", "directfb" (Rendering to a DirectFB window)
3819     * @li "x11-8", "x8", "software-8-x11", "software_8_x11" (Rendering in
3820     * grayscale using dedicated 8bit software engine in X11)
3821     * @li "x11-16", "x16", "software-16-x11", "software_16_x11" (Rendering in
3822     * X11 using 16bit software engine)
3823     * @li "wince-gdi", "software-16-wince-gdi", "software_16_wince_gdi"
3824     * (Windows CE rendering via GDI with 16bit software renderer)
3825     * @li "sdl-16", "software-16-sdl", "software_16_sdl" (Rendering to SDL
3826     * buffer with 16bit software renderer)
3827     * @li "ews" (rendering to EWS - Ecore + Evas Single Process Windowing System)
3828     * @li "gl-cocoa", "gl_cocoa", "opengl-cocoa", "opengl_cocoa" (OpenGL rendering in Cocoa)
3829     * @li "psl1ght" (PS3 rendering using PSL1GHT)
3830     *
3831     * All engines use a simple string to select the engine to render, EXCEPT
3832     * the "shot" engine. This actually encodes the output of the virtual
3833     * screenshot and how long to delay in the engine string. The engine string
3834     * is encoded in the following way:
3835     *
3836     *   "shot:[delay=XX][:][repeat=DDD][:][file=XX]"
3837     *
3838     * Where options are separated by a ":" char if more than one option is
3839     * given, with delay, if provided being the first option and file the last
3840     * (order is important). The delay specifies how long to wait after the
3841     * window is shown before doing the virtual "in memory" rendering and then
3842     * save the output to the file specified by the file option (and then exit).
3843     * If no delay is given, the default is 0.5 seconds. If no file is given the
3844     * default output file is "out.png". Repeat option is for continous
3845     * capturing screenshots. Repeat range is from 1 to 999 and filename is
3846     * fixed to "out001.png" Some examples of using the shot engine:
3847     *
3848     *   ELM_ENGINE="shot:delay=1.0:repeat=5:file=elm_test.png" elementary_test
3849     *   ELM_ENGINE="shot:delay=1.0:file=elm_test.png" elementary_test
3850     *   ELM_ENGINE="shot:file=elm_test2.png" elementary_test
3851     *   ELM_ENGINE="shot:delay=2.0" elementary_test
3852     *   ELM_ENGINE="shot:" elementary_test
3853     *
3854     * Signals that you can add callbacks for are:
3855     *
3856     * @li "delete,request": the user requested to close the window. See
3857     * elm_win_autodel_set().
3858     * @li "focus,in": window got focus
3859     * @li "focus,out": window lost focus
3860     * @li "moved": window that holds the canvas was moved
3861     *
3862     * Examples:
3863     * @li @ref win_example_01
3864     *
3865     * @{
3866     */
3867    /**
3868     * Defines the types of window that can be created
3869     *
3870     * These are hints set on the window so that a running Window Manager knows
3871     * how the window should be handled and/or what kind of decorations it
3872     * should have.
3873     *
3874     * Currently, only the X11 backed engines use them.
3875     */
3876    typedef enum _Elm_Win_Type
3877      {
3878         ELM_WIN_BASIC, /**< A normal window. Indicates a normal, top-level
3879                          window. Almost every window will be created with this
3880                          type. */
3881         ELM_WIN_DIALOG_BASIC, /**< Used for simple dialog windows/ */
3882         ELM_WIN_DESKTOP, /**< For special desktop windows, like a background
3883                            window holding desktop icons. */
3884         ELM_WIN_DOCK, /**< The window is used as a dock or panel. Usually would
3885                         be kept on top of any other window by the Window
3886                         Manager. */
3887         ELM_WIN_TOOLBAR, /**< The window is used to hold a floating toolbar, or
3888                            similar. */
3889         ELM_WIN_MENU, /**< Similar to #ELM_WIN_TOOLBAR. */
3890         ELM_WIN_UTILITY, /**< A persistent utility window, like a toolbox or
3891                            pallete. */
3892         ELM_WIN_SPLASH, /**< Splash window for a starting up application. */
3893         ELM_WIN_DROPDOWN_MENU, /**< The window is a dropdown menu, as when an
3894                                  entry in a menubar is clicked. Typically used
3895                                  with elm_win_override_set(). This hint exists
3896                                  for completion only, as the EFL way of
3897                                  implementing a menu would not normally use a
3898                                  separate window for its contents. */
3899         ELM_WIN_POPUP_MENU, /**< Like #ELM_WIN_DROPDOWN_MENU, but for the menu
3900                               triggered by right-clicking an object. */
3901         ELM_WIN_TOOLTIP, /**< The window is a tooltip. A short piece of
3902                            explanatory text that typically appear after the
3903                            mouse cursor hovers over an object for a while.
3904                            Typically used with elm_win_override_set() and also
3905                            not very commonly used in the EFL. */
3906         ELM_WIN_NOTIFICATION, /**< A notification window, like a warning about
3907                                 battery life or a new E-Mail received. */
3908         ELM_WIN_COMBO, /**< A window holding the contents of a combo box. Not
3909                          usually used in the EFL. */
3910         ELM_WIN_DND, /**< Used to indicate the window is a representation of an
3911                        object being dragged across different windows, or even
3912                        applications. Typically used with
3913                        elm_win_override_set(). */
3914         ELM_WIN_INLINED_IMAGE, /**< The window is rendered onto an image
3915                                  buffer. No actual window is created for this
3916                                  type, instead the window and all of its
3917                                  contents will be rendered to an image buffer.
3918                                  This allows to have children window inside a
3919                                  parent one just like any other object would
3920                                  be, and do other things like applying @c
3921                                  Evas_Map effects to it. This is the only type
3922                                  of window that requires the @c parent
3923                                  parameter of elm_win_add() to be a valid @c
3924                                  Evas_Object. */
3925      } Elm_Win_Type;
3926
3927    /**
3928     * The differents layouts that can be requested for the virtual keyboard.
3929     *
3930     * When the application window is being managed by Illume, it may request
3931     * any of the following layouts for the virtual keyboard.
3932     */
3933    typedef enum _Elm_Win_Keyboard_Mode
3934      {
3935         ELM_WIN_KEYBOARD_UNKNOWN, /**< Unknown keyboard state */
3936         ELM_WIN_KEYBOARD_OFF, /**< Request to deactivate the keyboard */
3937         ELM_WIN_KEYBOARD_ON, /**< Enable keyboard with default layout */
3938         ELM_WIN_KEYBOARD_ALPHA, /**< Alpha (a-z) keyboard layout */
3939         ELM_WIN_KEYBOARD_NUMERIC, /**< Numeric keyboard layout */
3940         ELM_WIN_KEYBOARD_PIN, /**< PIN keyboard layout */
3941         ELM_WIN_KEYBOARD_PHONE_NUMBER, /**< Phone keyboard layout */
3942         ELM_WIN_KEYBOARD_HEX, /**< Hexadecimal numeric keyboard layout */
3943         ELM_WIN_KEYBOARD_TERMINAL, /**< Full (QUERTY) keyboard layout */
3944         ELM_WIN_KEYBOARD_PASSWORD, /**< Password keyboard layout */
3945         ELM_WIN_KEYBOARD_IP, /**< IP keyboard layout */
3946         ELM_WIN_KEYBOARD_HOST, /**< Host keyboard layout */
3947         ELM_WIN_KEYBOARD_FILE, /**< File keyboard layout */
3948         ELM_WIN_KEYBOARD_URL, /**< URL keyboard layout */
3949         ELM_WIN_KEYBOARD_KEYPAD, /**< Keypad layout */
3950         ELM_WIN_KEYBOARD_J2ME /**< J2ME keyboard layout */
3951      } Elm_Win_Keyboard_Mode;
3952
3953    /**
3954     * Available commands that can be sent to the Illume manager.
3955     *
3956     * When running under an Illume session, a window may send commands to the
3957     * Illume manager to perform different actions.
3958     */
3959    typedef enum _Elm_Illume_Command
3960      {
3961         ELM_ILLUME_COMMAND_FOCUS_BACK, /**< Reverts focus to the previous
3962                                          window */
3963         ELM_ILLUME_COMMAND_FOCUS_FORWARD, /**< Sends focus to the next window\
3964                                             in the list */
3965         ELM_ILLUME_COMMAND_FOCUS_HOME, /**< Hides all windows to show the Home
3966                                          screen */
3967         ELM_ILLUME_COMMAND_CLOSE /**< Closes the currently active window */
3968      } Elm_Illume_Command;
3969
3970    /**
3971     * Adds a window object. If this is the first window created, pass NULL as
3972     * @p parent.
3973     *
3974     * @param parent Parent object to add the window to, or NULL
3975     * @param name The name of the window
3976     * @param type The window type, one of #Elm_Win_Type.
3977     *
3978     * The @p parent paramter can be @c NULL for every window @p type except
3979     * #ELM_WIN_INLINED_IMAGE, which needs a parent to retrieve the canvas on
3980     * which the image object will be created.
3981     *
3982     * @return The created object, or NULL on failure
3983     */
3984    EAPI Evas_Object *elm_win_add(Evas_Object *parent, const char *name, Elm_Win_Type type);
3985    /**
3986     * Adds a window object with standard setup
3987     *
3988     * @param name The name of the window
3989     * @param title The title for the window
3990     *
3991     * This creates a window like elm_win_add() but also puts in a standard
3992     * background with elm_bg_add(), as well as setting the window title to
3993     * @p title. The window type created is of type ELM_WIN_BASIC, with NULL
3994     * as the parent widget.
3995     * 
3996     * @return The created object, or NULL on failure
3997     *
3998     * @see elm_win_add()
3999     */
4000    EAPI Evas_Object *elm_win_util_standard_add(const char *name, const char *title);
4001    /**
4002     * Add @p subobj as a resize object of window @p obj.
4003     *
4004     *
4005     * Setting an object as a resize object of the window means that the
4006     * @p subobj child's size and position will be controlled by the window
4007     * directly. That is, the object will be resized to match the window size
4008     * and should never be moved or resized manually by the developer.
4009     *
4010     * In addition, resize objects of the window control what the minimum size
4011     * of it will be, as well as whether it can or not be resized by the user.
4012     *
4013     * For the end user to be able to resize a window by dragging the handles
4014     * or borders provided by the Window Manager, or using any other similar
4015     * mechanism, all of the resize objects in the window should have their
4016     * evas_object_size_hint_weight_set() set to EVAS_HINT_EXPAND.
4017     *
4018     * @param obj The window object
4019     * @param subobj The resize object to add
4020     */
4021    EAPI void         elm_win_resize_object_add(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
4022    /**
4023     * Delete @p subobj as a resize object of window @p obj.
4024     *
4025     * This function removes the object @p subobj from the resize objects of
4026     * the window @p obj. It will not delete the object itself, which will be
4027     * left unmanaged and should be deleted by the developer, manually handled
4028     * or set as child of some other container.
4029     *
4030     * @param obj The window object
4031     * @param subobj The resize object to add
4032     */
4033    EAPI void         elm_win_resize_object_del(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
4034    /**
4035     * Set the title of the window
4036     *
4037     * @param obj The window object
4038     * @param title The title to set
4039     */
4040    EAPI void         elm_win_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
4041    /**
4042     * Get the title of the window
4043     *
4044     * The returned string is an internal one and should not be freed or
4045     * modified. It will also be rendered invalid if a new title is set or if
4046     * the window is destroyed.
4047     *
4048     * @param obj The window object
4049     * @return The title
4050     */
4051    EAPI const char  *elm_win_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4052    /**
4053     * Set the window's autodel state.
4054     *
4055     * When closing the window in any way outside of the program control, like
4056     * pressing the X button in the titlebar or using a command from the
4057     * Window Manager, a "delete,request" signal is emitted to indicate that
4058     * this event occurred and the developer can take any action, which may
4059     * include, or not, destroying the window object.
4060     *
4061     * When the @p autodel parameter is set, the window will be automatically
4062     * destroyed when this event occurs, after the signal is emitted.
4063     * If @p autodel is @c EINA_FALSE, then the window will not be destroyed
4064     * and is up to the program to do so when it's required.
4065     *
4066     * @param obj The window object
4067     * @param autodel If true, the window will automatically delete itself when
4068     * closed
4069     */
4070    EAPI void         elm_win_autodel_set(Evas_Object *obj, Eina_Bool autodel) EINA_ARG_NONNULL(1);
4071    /**
4072     * Get the window's autodel state.
4073     *
4074     * @param obj The window object
4075     * @return If the window will automatically delete itself when closed
4076     *
4077     * @see elm_win_autodel_set()
4078     */
4079    EAPI Eina_Bool    elm_win_autodel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4080    /**
4081     * Activate a window object.
4082     *
4083     * This function sends a request to the Window Manager to activate the
4084     * window pointed by @p obj. If honored by the WM, the window will receive
4085     * the keyboard focus.
4086     *
4087     * @note This is just a request that a Window Manager may ignore, so calling
4088     * this function does not ensure in any way that the window will be the
4089     * active one after it.
4090     *
4091     * @param obj The window object
4092     */
4093    EAPI void         elm_win_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
4094    /**
4095     * Lower a window object.
4096     *
4097     * Places the window pointed by @p obj at the bottom of the stack, so that
4098     * no other window is covered by it.
4099     *
4100     * If elm_win_override_set() is not set, the Window Manager may ignore this
4101     * request.
4102     *
4103     * @param obj The window object
4104     */
4105    EAPI void         elm_win_lower(Evas_Object *obj) EINA_ARG_NONNULL(1);
4106    /**
4107     * Raise a window object.
4108     *
4109     * Places the window pointed by @p obj at the top of the stack, so that it's
4110     * not covered by any other window.
4111     *
4112     * If elm_win_override_set() is not set, the Window Manager may ignore this
4113     * request.
4114     *
4115     * @param obj The window object
4116     */
4117    EAPI void         elm_win_raise(Evas_Object *obj) EINA_ARG_NONNULL(1);
4118    /**
4119     * Set the borderless state of a window.
4120     *
4121     * This function requests the Window Manager to not draw any decoration
4122     * around the window.
4123     *
4124     * @param obj The window object
4125     * @param borderless If true, the window is borderless
4126     */
4127    EAPI void         elm_win_borderless_set(Evas_Object *obj, Eina_Bool borderless) EINA_ARG_NONNULL(1);
4128    /**
4129     * Get the borderless state of a window.
4130     *
4131     * @param obj The window object
4132     * @return If true, the window is borderless
4133     */
4134    EAPI Eina_Bool    elm_win_borderless_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4135    /**
4136     * Set the shaped state of a window.
4137     *
4138     * Shaped windows, when supported, will render the parts of the window that
4139     * has no content, transparent.
4140     *
4141     * If @p shaped is EINA_FALSE, then it is strongly adviced to have some
4142     * background object or cover the entire window in any other way, or the
4143     * parts of the canvas that have no data will show framebuffer artifacts.
4144     *
4145     * @param obj The window object
4146     * @param shaped If true, the window is shaped
4147     *
4148     * @see elm_win_alpha_set()
4149     */
4150    EAPI void         elm_win_shaped_set(Evas_Object *obj, Eina_Bool shaped) EINA_ARG_NONNULL(1);
4151    /**
4152     * Get the shaped state of a window.
4153     *
4154     * @param obj The window object
4155     * @return If true, the window is shaped
4156     *
4157     * @see elm_win_shaped_set()
4158     */
4159    EAPI Eina_Bool    elm_win_shaped_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4160    /**
4161     * Set the alpha channel state of a window.
4162     *
4163     * If @p alpha is EINA_TRUE, the alpha channel of the canvas will be enabled
4164     * possibly making parts of the window completely or partially transparent.
4165     * This is also subject to the underlying system supporting it, like for
4166     * example, running under a compositing manager. If no compositing is
4167     * available, enabling this option will instead fallback to using shaped
4168     * windows, with elm_win_shaped_set().
4169     *
4170     * @param obj The window object
4171     * @param alpha If true, the window has an alpha channel
4172     *
4173     * @see elm_win_alpha_set()
4174     */
4175    EAPI void         elm_win_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
4176    /**
4177     * Get the transparency state of a window.
4178     *
4179     * @param obj The window object
4180     * @return If true, the window is transparent
4181     *
4182     * @see elm_win_transparent_set()
4183     */
4184    EAPI Eina_Bool    elm_win_transparent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4185    /**
4186     * Set the transparency state of a window.
4187     *
4188     * Use elm_win_alpha_set() instead.
4189     *
4190     * @param obj The window object
4191     * @param transparent If true, the window is transparent
4192     *
4193     * @see elm_win_alpha_set()
4194     */
4195    EAPI void         elm_win_transparent_set(Evas_Object *obj, Eina_Bool transparent) EINA_ARG_NONNULL(1);
4196    /**
4197     * Get the alpha channel state of a window.
4198     *
4199     * @param obj The window object
4200     * @return If true, the window has an alpha channel
4201     */
4202    EAPI Eina_Bool    elm_win_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4203    /**
4204     * Set the override state of a window.
4205     *
4206     * A window with @p override set to EINA_TRUE will not be managed by the
4207     * Window Manager. This means that no decorations of any kind will be shown
4208     * for it, moving and resizing must be handled by the application, as well
4209     * as the window visibility.
4210     *
4211     * This should not be used for normal windows, and even for not so normal
4212     * ones, it should only be used when there's a good reason and with a lot
4213     * of care. Mishandling override windows may result situations that
4214     * disrupt the normal workflow of the end user.
4215     *
4216     * @param obj The window object
4217     * @param override If true, the window is overridden
4218     */
4219    EAPI void         elm_win_override_set(Evas_Object *obj, Eina_Bool override) EINA_ARG_NONNULL(1);
4220    /**
4221     * Get the override state of a window.
4222     *
4223     * @param obj The window object
4224     * @return If true, the window is overridden
4225     *
4226     * @see elm_win_override_set()
4227     */
4228    EAPI Eina_Bool    elm_win_override_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4229    /**
4230     * Set the fullscreen state of a window.
4231     *
4232     * @param obj The window object
4233     * @param fullscreen If true, the window is fullscreen
4234     */
4235    EAPI void         elm_win_fullscreen_set(Evas_Object *obj, Eina_Bool fullscreen) EINA_ARG_NONNULL(1);
4236    /**
4237     * Get the fullscreen state of a window.
4238     *
4239     * @param obj The window object
4240     * @return If true, the window is fullscreen
4241     */
4242    EAPI Eina_Bool    elm_win_fullscreen_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4243    /**
4244     * Set the maximized state of a window.
4245     *
4246     * @param obj The window object
4247     * @param maximized If true, the window is maximized
4248     */
4249    EAPI void         elm_win_maximized_set(Evas_Object *obj, Eina_Bool maximized) EINA_ARG_NONNULL(1);
4250    /**
4251     * Get the maximized state of a window.
4252     *
4253     * @param obj The window object
4254     * @return If true, the window is maximized
4255     */
4256    EAPI Eina_Bool    elm_win_maximized_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4257    /**
4258     * Set the iconified state of a window.
4259     *
4260     * @param obj The window object
4261     * @param iconified If true, the window is iconified
4262     */
4263    EAPI void         elm_win_iconified_set(Evas_Object *obj, Eina_Bool iconified) EINA_ARG_NONNULL(1);
4264    /**
4265     * Get the iconified state of a window.
4266     *
4267     * @param obj The window object
4268     * @return If true, the window is iconified
4269     */
4270    EAPI Eina_Bool    elm_win_iconified_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4271    /**
4272     * Set the layer of the window.
4273     *
4274     * What this means exactly will depend on the underlying engine used.
4275     *
4276     * In the case of X11 backed engines, the value in @p layer has the
4277     * following meanings:
4278     * @li < 3: The window will be placed below all others.
4279     * @li > 5: The window will be placed above all others.
4280     * @li other: The window will be placed in the default layer.
4281     *
4282     * @param obj The window object
4283     * @param layer The layer of the window
4284     */
4285    EAPI void         elm_win_layer_set(Evas_Object *obj, int layer) EINA_ARG_NONNULL(1);
4286    /**
4287     * Get the layer of the window.
4288     *
4289     * @param obj The window object
4290     * @return The layer of the window
4291     *
4292     * @see elm_win_layer_set()
4293     */
4294    EAPI int          elm_win_layer_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4295    /**
4296     * Set the rotation of the window.
4297     *
4298     * Most engines only work with multiples of 90.
4299     *
4300     * This function is used to set the orientation of the window @p obj to
4301     * match that of the screen. The window itself will be resized to adjust
4302     * to the new geometry of its contents. If you want to keep the window size,
4303     * see elm_win_rotation_with_resize_set().
4304     *
4305     * @param obj The window object
4306     * @param rotation The rotation of the window, in degrees (0-360),
4307     * counter-clockwise.
4308     */
4309    EAPI void         elm_win_rotation_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
4310    /**
4311     * Rotates the window and resizes it.
4312     *
4313     * Like elm_win_rotation_set(), but it also resizes the window's contents so
4314     * that they fit inside the current window geometry.
4315     *
4316     * @param obj The window object
4317     * @param layer The rotation of the window in degrees (0-360),
4318     * counter-clockwise.
4319     */
4320    EAPI void         elm_win_rotation_with_resize_set(Evas_Object *obj, int rotation) EINA_ARG_NONNULL(1);
4321    /**
4322     * Get the rotation of the window.
4323     *
4324     * @param obj The window object
4325     * @return The rotation of the window in degrees (0-360)
4326     *
4327     * @see elm_win_rotation_set()
4328     * @see elm_win_rotation_with_resize_set()
4329     */
4330    EAPI int          elm_win_rotation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4331    /**
4332     * Set the sticky state of the window.
4333     *
4334     * Hints the Window Manager that the window in @p obj should be left fixed
4335     * at its position even when the virtual desktop it's on moves or changes.
4336     *
4337     * @param obj The window object
4338     * @param sticky If true, the window's sticky state is enabled
4339     */
4340    EAPI void         elm_win_sticky_set(Evas_Object *obj, Eina_Bool sticky) EINA_ARG_NONNULL(1);
4341    /**
4342     * Get the sticky state of the window.
4343     *
4344     * @param obj The window object
4345     * @return If true, the window's sticky state is enabled
4346     *
4347     * @see elm_win_sticky_set()
4348     */
4349    EAPI Eina_Bool    elm_win_sticky_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4350    /**
4351     * Set if this window is an illume conformant window
4352     *
4353     * @param obj The window object
4354     * @param conformant The conformant flag (1 = conformant, 0 = non-conformant)
4355     */
4356    EAPI void         elm_win_conformant_set(Evas_Object *obj, Eina_Bool conformant) EINA_ARG_NONNULL(1);
4357    /**
4358     * Get if this window is an illume conformant window
4359     *
4360     * @param obj The window object
4361     * @return A boolean if this window is illume conformant or not
4362     */
4363    EAPI Eina_Bool    elm_win_conformant_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4364    /**
4365     * Set a window to be an illume quickpanel window
4366     *
4367     * By default window objects are not quickpanel windows.
4368     *
4369     * @param obj The window object
4370     * @param quickpanel The quickpanel flag (1 = quickpanel, 0 = normal window)
4371     */
4372    EAPI void         elm_win_quickpanel_set(Evas_Object *obj, Eina_Bool quickpanel) EINA_ARG_NONNULL(1);
4373    /**
4374     * Get if this window is a quickpanel or not
4375     *
4376     * @param obj The window object
4377     * @return A boolean if this window is a quickpanel or not
4378     */
4379    EAPI Eina_Bool    elm_win_quickpanel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4380    /**
4381     * Set the major priority of a quickpanel window
4382     *
4383     * @param obj The window object
4384     * @param priority The major priority for this quickpanel
4385     */
4386    EAPI void         elm_win_quickpanel_priority_major_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
4387    /**
4388     * Get the major priority of a quickpanel window
4389     *
4390     * @param obj The window object
4391     * @return The major priority of this quickpanel
4392     */
4393    EAPI int          elm_win_quickpanel_priority_major_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4394    /**
4395     * Set the minor priority of a quickpanel window
4396     *
4397     * @param obj The window object
4398     * @param priority The minor priority for this quickpanel
4399     */
4400    EAPI void         elm_win_quickpanel_priority_minor_set(Evas_Object *obj, int priority) EINA_ARG_NONNULL(1);
4401    /**
4402     * Get the minor priority of a quickpanel window
4403     *
4404     * @param obj The window object
4405     * @return The minor priority of this quickpanel
4406     */
4407    EAPI int          elm_win_quickpanel_priority_minor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4408    /**
4409     * Set which zone this quickpanel should appear in
4410     *
4411     * @param obj The window object
4412     * @param zone The requested zone for this quickpanel
4413     */
4414    EAPI void         elm_win_quickpanel_zone_set(Evas_Object *obj, int zone) EINA_ARG_NONNULL(1);
4415    /**
4416     * Get which zone this quickpanel should appear in
4417     *
4418     * @param obj The window object
4419     * @return The requested zone for this quickpanel
4420     */
4421    EAPI int          elm_win_quickpanel_zone_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4422    /**
4423     * Set the window to be skipped by keyboard focus
4424     *
4425     * This sets the window to be skipped by normal keyboard input. This means
4426     * a window manager will be asked to not focus this window as well as omit
4427     * it from things like the taskbar, pager, "alt-tab" list etc. etc.
4428     *
4429     * Call this and enable it on a window BEFORE you show it for the first time,
4430     * otherwise it may have no effect.
4431     *
4432     * Use this for windows that have only output information or might only be
4433     * interacted with by the mouse or fingers, and never for typing input.
4434     * Be careful that this may have side-effects like making the window
4435     * non-accessible in some cases unless the window is specially handled. Use
4436     * this with care.
4437     *
4438     * @param obj The window object
4439     * @param skip The skip flag state (EINA_TRUE if it is to be skipped)
4440     */
4441    EAPI void         elm_win_prop_focus_skip_set(Evas_Object *obj, Eina_Bool skip) EINA_ARG_NONNULL(1);
4442    /**
4443     * Send a command to the windowing environment
4444     *
4445     * This is intended to work in touchscreen or small screen device
4446     * environments where there is a more simplistic window management policy in
4447     * place. This uses the window object indicated to select which part of the
4448     * environment to control (the part that this window lives in), and provides
4449     * a command and an optional parameter structure (use NULL for this if not
4450     * needed).
4451     *
4452     * @param obj The window object that lives in the environment to control
4453     * @param command The command to send
4454     * @param params Optional parameters for the command
4455     */
4456    EAPI void         elm_win_illume_command_send(Evas_Object *obj, Elm_Illume_Command command, void *params) EINA_ARG_NONNULL(1);
4457    /**
4458     * Get the inlined image object handle
4459     *
4460     * When you create a window with elm_win_add() of type ELM_WIN_INLINED_IMAGE,
4461     * then the window is in fact an evas image object inlined in the parent
4462     * canvas. You can get this object (be careful to not manipulate it as it
4463     * is under control of elementary), and use it to do things like get pixel
4464     * data, save the image to a file, etc.
4465     *
4466     * @param obj The window object to get the inlined image from
4467     * @return The inlined image object, or NULL if none exists
4468     */
4469    EAPI Evas_Object *elm_win_inlined_image_object_get(Evas_Object *obj);
4470    /**
4471     * Determine whether a window has focus
4472     * @param obj The window to query
4473     * @return EINA_TRUE if the window exists and has focus, else EINA_FALSE
4474     */
4475    EAPI Eina_Bool    elm_win_focus_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4476    /**
4477     * Get screen geometry details for the screen that a window is on
4478     * @param obj The window to query
4479     * @param x where to return the horizontal offset value. May be NULL.
4480     * @param y  where to return the vertical offset value. May be NULL.
4481     * @param w  where to return the width value. May be NULL.
4482     * @param h  where to return the height value. May be NULL.
4483     */
4484    EAPI void         elm_win_screen_size_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
4485    /**
4486     * Set the enabled status for the focus highlight in a window
4487     *
4488     * This function will enable or disable the focus highlight only for the
4489     * given window, regardless of the global setting for it
4490     *
4491     * @param obj The window where to enable the highlight
4492     * @param enabled The enabled value for the highlight
4493     */
4494    EAPI void         elm_win_focus_highlight_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
4495    /**
4496     * Get the enabled value of the focus highlight for this window
4497     *
4498     * @param obj The window in which to check if the focus highlight is enabled
4499     *
4500     * @return EINA_TRUE if enabled, EINA_FALSE otherwise
4501     */
4502    EAPI Eina_Bool    elm_win_focus_highlight_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4503    /**
4504     * Set the style for the focus highlight on this window
4505     *
4506     * Sets the style to use for theming the highlight of focused objects on
4507     * the given window. If @p style is NULL, the default will be used.
4508     *
4509     * @param obj The window where to set the style
4510     * @param style The style to set
4511     */
4512    EAPI void         elm_win_focus_highlight_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
4513    /**
4514     * Get the style set for the focus highlight object
4515     *
4516     * Gets the style set for this windows highilght object, or NULL if none
4517     * is set.
4518     *
4519     * @param obj The window to retrieve the highlights style from
4520     *
4521     * @return The style set or NULL if none was. Default is used in that case.
4522     */
4523    EAPI const char  *elm_win_focus_highlight_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4524    EAPI void         elm_win_indicator_state_set(Evas_Object *obj, int show_state);
4525    EAPI int          elm_win_indicator_state_get(Evas_Object *obj);
4526    /*...
4527     * ecore_x_icccm_hints_set -> accepts_focus (add to ecore_evas)
4528     * ecore_x_icccm_hints_set -> window_group (add to ecore_evas)
4529     * ecore_x_icccm_size_pos_hints_set -> request_pos (add to ecore_evas)
4530     * ecore_x_icccm_client_leader_set -> l (add to ecore_evas)
4531     * ecore_x_icccm_window_role_set -> role (add to ecore_evas)
4532     * ecore_x_icccm_transient_for_set -> forwin (add to ecore_evas)
4533     * ecore_x_netwm_window_type_set -> type (add to ecore_evas)
4534     *
4535     * (add to ecore_x) set netwm argb icon! (add to ecore_evas)
4536     * (blank mouse, private mouse obj, defaultmouse)
4537     *
4538     */
4539    /**
4540     * Sets the keyboard mode of the window.
4541     *
4542     * @param obj The window object
4543     * @param mode The mode to set, one of #Elm_Win_Keyboard_Mode
4544     */
4545    EAPI void                  elm_win_keyboard_mode_set(Evas_Object *obj, Elm_Win_Keyboard_Mode mode) EINA_ARG_NONNULL(1);
4546    /**
4547     * Gets the keyboard mode of the window.
4548     *
4549     * @param obj The window object
4550     * @return The mode, one of #Elm_Win_Keyboard_Mode
4551     */
4552    EAPI Elm_Win_Keyboard_Mode elm_win_keyboard_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4553    /**
4554     * Sets whether the window is a keyboard.
4555     *
4556     * @param obj The window object
4557     * @param is_keyboard If true, the window is a virtual keyboard
4558     */
4559    EAPI void                  elm_win_keyboard_win_set(Evas_Object *obj, Eina_Bool is_keyboard) EINA_ARG_NONNULL(1);
4560    /**
4561     * Gets whether the window is a keyboard.
4562     *
4563     * @param obj The window object
4564     * @return If the window is a virtual keyboard
4565     */
4566    EAPI Eina_Bool             elm_win_keyboard_win_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4567
4568    /**
4569     * Get the screen position of a window.
4570     *
4571     * @param obj The window object
4572     * @param x The int to store the x coordinate to
4573     * @param y The int to store the y coordinate to
4574     */
4575    EAPI void                  elm_win_screen_position_get(const Evas_Object *obj, int *x, int *y) EINA_ARG_NONNULL(1);
4576    /**
4577     * @}
4578     */
4579
4580    /**
4581     * @defgroup Inwin Inwin
4582     *
4583     * @image html img/widget/inwin/preview-00.png
4584     * @image latex img/widget/inwin/preview-00.eps
4585     * @image html img/widget/inwin/preview-01.png
4586     * @image latex img/widget/inwin/preview-01.eps
4587     * @image html img/widget/inwin/preview-02.png
4588     * @image latex img/widget/inwin/preview-02.eps
4589     *
4590     * An inwin is a window inside a window that is useful for a quick popup.
4591     * It does not hover.
4592     *
4593     * It works by creating an object that will occupy the entire window, so it
4594     * must be created using an @ref Win "elm_win" as parent only. The inwin
4595     * object can be hidden or restacked below every other object if it's
4596     * needed to show what's behind it without destroying it. If this is done,
4597     * the elm_win_inwin_activate() function can be used to bring it back to
4598     * full visibility again.
4599     *
4600     * There are three styles available in the default theme. These are:
4601     * @li default: The inwin is sized to take over most of the window it's
4602     * placed in.
4603     * @li minimal: The size of the inwin will be the minimum necessary to show
4604     * its contents.
4605     * @li minimal_vertical: Horizontally, the inwin takes as much space as
4606     * possible, but it's sized vertically the most it needs to fit its\
4607     * contents.
4608     *
4609     * Some examples of Inwin can be found in the following:
4610     * @li @ref inwin_example_01
4611     *
4612     * @{
4613     */
4614    /**
4615     * Adds an inwin to the current window
4616     *
4617     * The @p obj used as parent @b MUST be an @ref Win "Elementary Window".
4618     * Never call this function with anything other than the top-most window
4619     * as its parameter, unless you are fond of undefined behavior.
4620     *
4621     * After creating the object, the widget will set itself as resize object
4622     * for the window with elm_win_resize_object_add(), so when shown it will
4623     * appear to cover almost the entire window (how much of it depends on its
4624     * content and the style used). It must not be added into other container
4625     * objects and it needs not be moved or resized manually.
4626     *
4627     * @param parent The parent object
4628     * @return The new object or NULL if it cannot be created
4629     */
4630    EAPI Evas_Object          *elm_win_inwin_add(Evas_Object *obj) EINA_ARG_NONNULL(1);
4631    /**
4632     * Activates an inwin object, ensuring its visibility
4633     *
4634     * This function will make sure that the inwin @p obj is completely visible
4635     * by calling evas_object_show() and evas_object_raise() on it, to bring it
4636     * to the front. It also sets the keyboard focus to it, which will be passed
4637     * onto its content.
4638     *
4639     * The object's theme will also receive the signal "elm,action,show" with
4640     * source "elm".
4641     *
4642     * @param obj The inwin to activate
4643     */
4644    EAPI void                  elm_win_inwin_activate(Evas_Object *obj) EINA_ARG_NONNULL(1);
4645    /**
4646     * Set the content of an inwin object.
4647     *
4648     * Once the content object is set, a previously set one will be deleted.
4649     * If you want to keep that old content object, use the
4650     * elm_win_inwin_content_unset() function.
4651     *
4652     * @param obj The inwin object
4653     * @param content The object to set as content
4654     */
4655    EAPI void                  elm_win_inwin_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
4656    /**
4657     * Get the content of an inwin object.
4658     *
4659     * Return the content object which is set for this widget.
4660     *
4661     * The returned object is valid as long as the inwin is still alive and no
4662     * other content is set on it. Deleting the object will notify the inwin
4663     * about it and this one will be left empty.
4664     *
4665     * If you need to remove an inwin's content to be reused somewhere else,
4666     * see elm_win_inwin_content_unset().
4667     *
4668     * @param obj The inwin object
4669     * @return The content that is being used
4670     */
4671    EAPI Evas_Object          *elm_win_inwin_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4672    /**
4673     * Unset the content of an inwin object.
4674     *
4675     * Unparent and return the content object which was set for this widget.
4676     *
4677     * @param obj The inwin object
4678     * @return The content that was being used
4679     */
4680    EAPI Evas_Object          *elm_win_inwin_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4681    /**
4682     * @}
4683     */
4684    /* X specific calls - won't work on non-x engines (return 0) */
4685
4686    /**
4687     * Get the Ecore_X_Window of an Evas_Object
4688     *
4689     * @param obj The object
4690     *
4691     * @return The Ecore_X_Window of @p obj
4692     *
4693     * @ingroup Win
4694     */
4695    EAPI Ecore_X_Window elm_win_xwindow_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4696
4697    /* smart callbacks called:
4698     * "delete,request" - the user requested to delete the window
4699     * "focus,in" - window got focus
4700     * "focus,out" - window lost focus
4701     * "moved" - window that holds the canvas was moved
4702     */
4703
4704    /**
4705     * @defgroup Bg Bg
4706     *
4707     * @image html img/widget/bg/preview-00.png
4708     * @image latex img/widget/bg/preview-00.eps
4709     *
4710     * @brief Background object, used for setting a solid color, image or Edje
4711     * group as background to a window or any container object.
4712     *
4713     * The bg object is used for setting a solid background to a window or
4714     * packing into any container object. It works just like an image, but has
4715     * some properties useful to a background, like setting it to tiled,
4716     * centered, scaled or stretched.
4717     * 
4718     * Default contents parts of the bg widget that you can use for are:
4719     * @li "overlay" - overlay of the bg
4720     *
4721     * Here is some sample code using it:
4722     * @li @ref bg_01_example_page
4723     * @li @ref bg_02_example_page
4724     * @li @ref bg_03_example_page
4725     */
4726
4727    /* bg */
4728    typedef enum _Elm_Bg_Option
4729      {
4730         ELM_BG_OPTION_CENTER,  /**< center the background */
4731         ELM_BG_OPTION_SCALE,   /**< scale the background retaining aspect ratio */
4732         ELM_BG_OPTION_STRETCH, /**< stretch the background to fill */
4733         ELM_BG_OPTION_TILE     /**< tile background at its original size */
4734      } Elm_Bg_Option;
4735
4736    /**
4737     * Add a new background to the parent
4738     *
4739     * @param parent The parent object
4740     * @return The new object or NULL if it cannot be created
4741     *
4742     * @ingroup Bg
4743     */
4744    EAPI Evas_Object  *elm_bg_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
4745
4746    /**
4747     * Set the file (image or edje) used for the background
4748     *
4749     * @param obj The bg object
4750     * @param file The file path
4751     * @param group Optional key (group in Edje) within the file
4752     *
4753     * This sets the image file used in the background object. The image (or edje)
4754     * will be stretched (retaining aspect if its an image file) to completely fill
4755     * the bg object. This may mean some parts are not visible.
4756     *
4757     * @note  Once the image of @p obj is set, a previously set one will be deleted,
4758     * even if @p file is NULL.
4759     *
4760     * @ingroup Bg
4761     */
4762    EAPI void          elm_bg_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
4763
4764    /**
4765     * Get the file (image or edje) used for the background
4766     *
4767     * @param obj The bg object
4768     * @param file The file path
4769     * @param group Optional key (group in Edje) within the file
4770     *
4771     * @ingroup Bg
4772     */
4773    EAPI void          elm_bg_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
4774
4775    /**
4776     * Set the option used for the background image
4777     *
4778     * @param obj The bg object
4779     * @param option The desired background option (TILE, SCALE)
4780     *
4781     * This sets the option used for manipulating the display of the background
4782     * image. The image can be tiled or scaled.
4783     *
4784     * @ingroup Bg
4785     */
4786    EAPI void          elm_bg_option_set(Evas_Object *obj, Elm_Bg_Option option) EINA_ARG_NONNULL(1);
4787
4788    /**
4789     * Get the option used for the background image
4790     *
4791     * @param obj The bg object
4792     * @return The desired background option (CENTER, SCALE, STRETCH or TILE)
4793     *
4794     * @ingroup Bg
4795     */
4796    EAPI Elm_Bg_Option elm_bg_option_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4797    /**
4798     * Set the option used for the background color
4799     *
4800     * @param obj The bg object
4801     * @param r
4802     * @param g
4803     * @param b
4804     *
4805     * This sets the color used for the background rectangle. Its range goes
4806     * from 0 to 255.
4807     *
4808     * @ingroup Bg
4809     */
4810    EAPI void          elm_bg_color_set(Evas_Object *obj, int r, int g, int b) EINA_ARG_NONNULL(1);
4811    /**
4812     * Get the option used for the background color
4813     *
4814     * @param obj The bg object
4815     * @param r
4816     * @param g
4817     * @param b
4818     *
4819     * @ingroup Bg
4820     */
4821    EAPI void          elm_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b) EINA_ARG_NONNULL(1);
4822
4823    /**
4824     * Set the overlay object used for the background object.
4825     *
4826     * @param obj The bg object
4827     * @param overlay The overlay object
4828     *
4829     * This provides a way for elm_bg to have an 'overlay' that will be on top
4830     * of the bg. Once the over object is set, a previously set one will be
4831     * deleted, even if you set the new one to NULL. If you want to keep that
4832     * old content object, use the elm_bg_overlay_unset() function.
4833     *
4834     * @deprecated use elm_object_part_content_set() instead
4835     *
4836     * @ingroup Bg
4837     */
4838
4839    WILL_DEPRECATE  EAPI void          elm_bg_overlay_set(Evas_Object *obj, Evas_Object *overlay) EINA_ARG_NONNULL(1);
4840
4841    /**
4842     * Get the overlay object used for the background object.
4843     *
4844     * @param obj The bg object
4845     * @return The content that is being used
4846     *
4847     * Return the content object which is set for this widget
4848     *
4849     * @deprecated use elm_object_part_content_get() instead
4850     *
4851     * @ingroup Bg
4852     */
4853    EINA_DEPRECATED EAPI Evas_Object  *elm_bg_overlay_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
4854
4855    /**
4856     * Get the overlay object used for the background object.
4857     *
4858     * @param obj The bg object
4859     * @return The content that was being used
4860     *
4861     * Unparent and return the overlay object which was set for this widget
4862     *
4863     * @deprecated use elm_object_part_content_unset() instead
4864     *
4865     * @ingroup Bg
4866     */
4867    WILL_DEPRECATE  EAPI Evas_Object  *elm_bg_overlay_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
4868
4869    /**
4870     * Set the size of the pixmap representation of the image.
4871     *
4872     * This option just makes sense if an image is going to be set in the bg.
4873     *
4874     * @param obj The bg object
4875     * @param w The new width of the image pixmap representation.
4876     * @param h The new height of the image pixmap representation.
4877     *
4878     * This function sets a new size for pixmap representation of the given bg
4879     * image. It allows the image to be loaded already in the specified size,
4880     * reducing the memory usage and load time when loading a big image with load
4881     * size set to a smaller size.
4882     *
4883     * NOTE: this is just a hint, the real size of the pixmap may differ
4884     * depending on the type of image being loaded, being bigger than requested.
4885     *
4886     * @ingroup Bg
4887     */
4888    EAPI void          elm_bg_load_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
4889    /* smart callbacks called:
4890     */
4891
4892    /**
4893     * @defgroup Icon Icon
4894     *
4895     * @image html img/widget/icon/preview-00.png
4896     * @image latex img/widget/icon/preview-00.eps
4897     *
4898     * An object that provides standard icon images (delete, edit, arrows, etc.)
4899     * or a custom file (PNG, JPG, EDJE, etc.) used for an icon.
4900     *
4901     * The icon image requested can be in the elementary theme, or in the
4902     * freedesktop.org paths. It's possible to set the order of preference from
4903     * where the image will be used.
4904     *
4905     * This API is very similar to @ref Image, but with ready to use images.
4906     *
4907     * Default images provided by the theme are described below.
4908     *
4909     * The first list contains icons that were first intended to be used in
4910     * toolbars, but can be used in many other places too:
4911     * @li home
4912     * @li close
4913     * @li apps
4914     * @li arrow_up
4915     * @li arrow_down
4916     * @li arrow_left
4917     * @li arrow_right
4918     * @li chat
4919     * @li clock
4920     * @li delete
4921     * @li edit
4922     * @li refresh
4923     * @li folder
4924     * @li file
4925     *
4926     * Now some icons that were designed to be used in menus (but again, you can
4927     * use them anywhere else):
4928     * @li menu/home
4929     * @li menu/close
4930     * @li menu/apps
4931     * @li menu/arrow_up
4932     * @li menu/arrow_down
4933     * @li menu/arrow_left
4934     * @li menu/arrow_right
4935     * @li menu/chat
4936     * @li menu/clock
4937     * @li menu/delete
4938     * @li menu/edit
4939     * @li menu/refresh
4940     * @li menu/folder
4941     * @li menu/file
4942     *
4943     * And here we have some media player specific icons:
4944     * @li media_player/forward
4945     * @li media_player/info
4946     * @li media_player/next
4947     * @li media_player/pause
4948     * @li media_player/play
4949     * @li media_player/prev
4950     * @li media_player/rewind
4951     * @li media_player/stop
4952     *
4953     * Signals that you can add callbacks for are:
4954     *
4955     * "clicked" - This is called when a user has clicked the icon
4956     *
4957     * An example of usage for this API follows:
4958     * @li @ref tutorial_icon
4959     */
4960
4961    /**
4962     * @addtogroup Icon
4963     * @{
4964     */
4965
4966    typedef enum _Elm_Icon_Type
4967      {
4968         ELM_ICON_NONE,
4969         ELM_ICON_FILE,
4970         ELM_ICON_STANDARD
4971      } Elm_Icon_Type;
4972    /**
4973     * @enum _Elm_Icon_Lookup_Order
4974     * @typedef Elm_Icon_Lookup_Order
4975     *
4976     * Lookup order used by elm_icon_standard_set(). Should look for icons in the
4977     * theme, FDO paths, or both?
4978     *
4979     * @ingroup Icon
4980     */
4981    typedef enum _Elm_Icon_Lookup_Order
4982      {
4983         ELM_ICON_LOOKUP_FDO_THEME, /**< icon look up order: freedesktop, theme */
4984         ELM_ICON_LOOKUP_THEME_FDO, /**< icon look up order: theme, freedesktop */
4985         ELM_ICON_LOOKUP_FDO,       /**< icon look up order: freedesktop */
4986         ELM_ICON_LOOKUP_THEME      /**< icon look up order: theme */
4987      } Elm_Icon_Lookup_Order;
4988
4989    /**
4990     * Add a new icon object to the parent.
4991     *
4992     * @param parent The parent object
4993     * @return The new object or NULL if it cannot be created
4994     *
4995     * @see elm_icon_file_set()
4996     *
4997     * @ingroup Icon
4998     */
4999    EAPI Evas_Object          *elm_icon_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5000    /**
5001     * Set the file that will be used as icon.
5002     *
5003     * @param obj The icon object
5004     * @param file The path to file that will be used as icon image
5005     * @param group The group that the icon belongs to an edje file
5006     *
5007     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
5008     *
5009     * @note The icon image set by this function can be changed by
5010     * elm_icon_standard_set().
5011     *
5012     * @see elm_icon_file_get()
5013     *
5014     * @ingroup Icon
5015     */
5016    EAPI Eina_Bool             elm_icon_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
5017    /**
5018     * Set a location in memory to be used as an icon
5019     *
5020     * @param obj The icon object
5021     * @param img The binary data that will be used as an image
5022     * @param size The size of binary data @p img
5023     * @param format Optional format of @p img to pass to the image loader
5024     * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
5025     *
5026     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
5027     *
5028     * @note The icon image set by this function can be changed by
5029     * elm_icon_standard_set().
5030     *
5031     * @ingroup Icon
5032     */
5033    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);
5034    /**
5035     * Get the file that will be used as icon.
5036     *
5037     * @param obj The icon object
5038     * @param file The path to file that will be used as the icon image
5039     * @param group The group that the icon belongs to, in edje file
5040     *
5041     * @see elm_icon_file_set()
5042     *
5043     * @ingroup Icon
5044     */
5045    EAPI void                  elm_icon_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
5046    EAPI void                  elm_icon_thumb_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
5047    /**
5048     * Set the icon by icon standards names.
5049     *
5050     * @param obj The icon object
5051     * @param name The icon name
5052     *
5053     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
5054     *
5055     * For example, freedesktop.org defines standard icon names such as "home",
5056     * "network", etc. There can be different icon sets to match those icon
5057     * keys. The @p name given as parameter is one of these "keys", and will be
5058     * used to look in the freedesktop.org paths and elementary theme. One can
5059     * change the lookup order with elm_icon_order_lookup_set().
5060     *
5061     * If name is not found in any of the expected locations and it is the
5062     * absolute path of an image file, this image will be used.
5063     *
5064     * @note The icon image set by this function can be changed by
5065     * elm_icon_file_set().
5066     *
5067     * @see elm_icon_standard_get()
5068     * @see elm_icon_file_set()
5069     *
5070     * @ingroup Icon
5071     */
5072    EAPI Eina_Bool             elm_icon_standard_set(Evas_Object *obj, const char *name) EINA_ARG_NONNULL(1);
5073    /**
5074     * Get the icon name set by icon standard names.
5075     *
5076     * @param obj The icon object
5077     * @return The icon name
5078     *
5079     * If the icon image was set using elm_icon_file_set() instead of
5080     * elm_icon_standard_set(), then this function will return @c NULL.
5081     *
5082     * @see elm_icon_standard_set()
5083     *
5084     * @ingroup Icon
5085     */
5086    EAPI const char           *elm_icon_standard_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5087    /**
5088     * Set the smooth scaling for an icon object.
5089     *
5090     * @param obj The icon object
5091     * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
5092     * otherwise. Default is @c EINA_TRUE.
5093     *
5094     * Set the scaling algorithm to be used when scaling the icon image. Smooth
5095     * scaling provides a better resulting image, but is slower.
5096     *
5097     * The smooth scaling should be disabled when making animations that change
5098     * the icon size, since they will be faster. Animations that don't require
5099     * resizing of the icon can keep the smooth scaling enabled (even if the icon
5100     * is already scaled, since the scaled icon image will be cached).
5101     *
5102     * @see elm_icon_smooth_get()
5103     *
5104     * @ingroup Icon
5105     */
5106    EAPI void                  elm_icon_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
5107    /**
5108     * Get whether smooth scaling is enabled for an icon object.
5109     *
5110     * @param obj The icon object
5111     * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
5112     *
5113     * @see elm_icon_smooth_set()
5114     *
5115     * @ingroup Icon
5116     */
5117    EAPI Eina_Bool             elm_icon_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5118    /**
5119     * Disable scaling of this object.
5120     *
5121     * @param obj The icon object.
5122     * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
5123     * otherwise. Default is @c EINA_FALSE.
5124     *
5125     * This function disables scaling of the icon object through the function
5126     * elm_object_scale_set(). However, this does not affect the object
5127     * size/resize in any way. For that effect, take a look at
5128     * elm_icon_scale_set().
5129     *
5130     * @see elm_icon_no_scale_get()
5131     * @see elm_icon_scale_set()
5132     * @see elm_object_scale_set()
5133     *
5134     * @ingroup Icon
5135     */
5136    EAPI void                  elm_icon_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
5137    /**
5138     * Get whether scaling is disabled on the object.
5139     *
5140     * @param obj The icon object
5141     * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
5142     *
5143     * @see elm_icon_no_scale_set()
5144     *
5145     * @ingroup Icon
5146     */
5147    EAPI Eina_Bool             elm_icon_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5148    /**
5149     * Set if the object is (up/down) resizable.
5150     *
5151     * @param obj The icon object
5152     * @param scale_up A bool to set if the object is resizable up. Default is
5153     * @c EINA_TRUE.
5154     * @param scale_down A bool to set if the object is resizable down. Default
5155     * is @c EINA_TRUE.
5156     *
5157     * This function limits the icon object resize ability. If @p scale_up is set to
5158     * @c EINA_FALSE, the object can't have its height or width resized to a value
5159     * higher than the original icon size. Same is valid for @p scale_down.
5160     *
5161     * @see elm_icon_scale_get()
5162     *
5163     * @ingroup Icon
5164     */
5165    EAPI void                  elm_icon_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
5166    /**
5167     * Get if the object is (up/down) resizable.
5168     *
5169     * @param obj The icon object
5170     * @param scale_up A bool to set if the object is resizable up
5171     * @param scale_down A bool to set if the object is resizable down
5172     *
5173     * @see elm_icon_scale_set()
5174     *
5175     * @ingroup Icon
5176     */
5177    EAPI void                  elm_icon_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
5178    /**
5179     * Get the object's image size
5180     *
5181     * @param obj The icon object
5182     * @param w A pointer to store the width in
5183     * @param h A pointer to store the height in
5184     *
5185     * @ingroup Icon
5186     */
5187    EAPI void                  elm_icon_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
5188    /**
5189     * Set if the icon fill the entire object area.
5190     *
5191     * @param obj The icon object
5192     * @param fill_outside @c EINA_TRUE if the object is filled outside,
5193     * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5194     *
5195     * When the icon object is resized to a different aspect ratio from the
5196     * original icon image, the icon image will still keep its aspect. This flag
5197     * tells how the image should fill the object's area. They are: keep the
5198     * entire icon inside the limits of height and width of the object (@p
5199     * fill_outside is @c EINA_FALSE) or let the extra width or height go outside
5200     * of the object, and the icon will fill the entire object (@p fill_outside
5201     * is @c EINA_TRUE).
5202     *
5203     * @note Unlike @ref Image, there's no option in icon to set the aspect ratio
5204     * retain property to false. Thus, the icon image will always keep its
5205     * original aspect ratio.
5206     *
5207     * @see elm_icon_fill_outside_get()
5208     * @see elm_image_fill_outside_set()
5209     *
5210     * @ingroup Icon
5211     */
5212    EAPI void                  elm_icon_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
5213    /**
5214     * Get if the object is filled outside.
5215     *
5216     * @param obj The icon object
5217     * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
5218     *
5219     * @see elm_icon_fill_outside_set()
5220     *
5221     * @ingroup Icon
5222     */
5223    EAPI Eina_Bool             elm_icon_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5224    /**
5225     * Set the prescale size for the icon.
5226     *
5227     * @param obj The icon object
5228     * @param size The prescale size. This value is used for both width and
5229     * height.
5230     *
5231     * This function sets a new size for pixmap representation of the given
5232     * icon. It allows the icon to be loaded already in the specified size,
5233     * reducing the memory usage and load time when loading a big icon with load
5234     * size set to a smaller size.
5235     *
5236     * It's equivalent to the elm_bg_load_size_set() function for bg.
5237     *
5238     * @note this is just a hint, the real size of the pixmap may differ
5239     * depending on the type of icon being loaded, being bigger than requested.
5240     *
5241     * @see elm_icon_prescale_get()
5242     * @see elm_bg_load_size_set()
5243     *
5244     * @ingroup Icon
5245     */
5246    EAPI void                  elm_icon_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
5247    /**
5248     * Get the prescale size for the icon.
5249     *
5250     * @param obj The icon object
5251     * @return The prescale size
5252     *
5253     * @see elm_icon_prescale_set()
5254     *
5255     * @ingroup Icon
5256     */
5257    EAPI int                   elm_icon_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5258    /**
5259     * Gets the image object of the icon. DO NOT MODIFY THIS.
5260     *
5261     * @param obj The icon object
5262     * @return The internal icon object
5263     *
5264     * @ingroup Icon
5265     */
5266    EAPI Evas_Object          *elm_icon_object_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
5267    /**
5268     * Sets the icon lookup order used by elm_icon_standard_set().
5269     *
5270     * @param obj The icon object
5271     * @param order The icon lookup order (can be one of
5272     * ELM_ICON_LOOKUP_FDO_THEME, ELM_ICON_LOOKUP_THEME_FDO, ELM_ICON_LOOKUP_FDO
5273     * or ELM_ICON_LOOKUP_THEME)
5274     *
5275     * @see elm_icon_order_lookup_get()
5276     * @see Elm_Icon_Lookup_Order
5277     *
5278     * @ingroup Icon
5279     */
5280    EAPI void                  elm_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
5281    /**
5282     * Gets the icon lookup order.
5283     *
5284     * @param obj The icon object
5285     * @return The icon lookup order
5286     *
5287     * @see elm_icon_order_lookup_set()
5288     * @see Elm_Icon_Lookup_Order
5289     *
5290     * @ingroup Icon
5291     */
5292    EAPI Elm_Icon_Lookup_Order elm_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5293    /**
5294     * Enable or disable preloading of the icon
5295     *
5296     * @param obj The icon object
5297     * @param disable If EINA_TRUE, preloading will be disabled
5298     * @ingroup Icon
5299     */
5300    EAPI void                  elm_icon_preload_set(Evas_Object *obj, Eina_Bool disable) EINA_ARG_NONNULL(1);
5301    /**
5302     * Get if the icon supports animation or not.
5303     *
5304     * @param obj The icon object
5305     * @return @c EINA_TRUE if the icon supports animation,
5306     *         @c EINA_FALSE otherwise.
5307     *
5308     * Return if this elm icon's image can be animated. Currently Evas only
5309     * supports gif animation. If the return value is EINA_FALSE, other
5310     * elm_icon_animated_XXX APIs won't work.
5311     * @ingroup Icon
5312     */
5313    EAPI Eina_Bool           elm_icon_animated_available_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5314    /**
5315     * Set animation mode of the icon.
5316     *
5317     * @param obj The icon object
5318     * @param anim @c EINA_TRUE if the object do animation job,
5319     * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5320     *
5321     * Since the default animation mode is set to EINA_FALSE, 
5322     * the icon is shown without animation.
5323     * This might be desirable when the application developer wants to show
5324     * a snapshot of the animated icon.
5325     * Set it to EINA_TRUE when the icon needs to be animated.
5326     * @ingroup Icon
5327     */
5328    EAPI void                elm_icon_animated_set(Evas_Object *obj, Eina_Bool animated) EINA_ARG_NONNULL(1);
5329    /**
5330     * Get animation mode of the icon.
5331     *
5332     * @param obj The icon object
5333     * @return The animation mode of the icon object
5334     * @see elm_icon_animated_set
5335     * @ingroup Icon
5336     */
5337    EAPI Eina_Bool           elm_icon_animated_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5338    /**
5339     * Set animation play mode of the icon.
5340     *
5341     * @param obj The icon object
5342     * @param play @c EINA_TRUE the object play animation images,
5343     * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5344     *
5345     * To play elm icon's animation, set play to EINA_TURE.
5346     * For example, you make gif player using this set/get API and click event.
5347     *
5348     * 1. Click event occurs
5349     * 2. Check play flag using elm_icon_animaged_play_get
5350     * 3. If elm icon was playing, set play to EINA_FALSE.
5351     *    Then animation will be stopped and vice versa
5352     * @ingroup Icon
5353     */
5354    EAPI void                elm_icon_animated_play_set(Evas_Object *obj, Eina_Bool play) EINA_ARG_NONNULL(1);
5355    /**
5356     * Get animation play mode of the icon.
5357     *
5358     * @param obj The icon object
5359     * @return The play mode of the icon object
5360     *
5361     * @see elm_icon_animated_play_get
5362     * @ingroup Icon
5363     */
5364    EAPI Eina_Bool           elm_icon_animated_play_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5365
5366    /* compatibility code to avoid API and ABI breaks */
5367    EINA_DEPRECATED EAPI extern inline void elm_icon_anim_set(Evas_Object *obj, Eina_Bool animated)
5368      {
5369         elm_icon_animated_set(obj, animated);
5370      }
5371
5372    EINA_DEPRECATED EAPI extern inline Eina_Bool elm_icon_anim_get(const Evas_Object *obj)
5373      {
5374         return elm_icon_animated_get(obj);
5375      }
5376
5377    EINA_DEPRECATED EAPI extern inline void elm_icon_anim_play_set(Evas_Object *obj, Eina_Bool play)
5378      {
5379         elm_icon_animated_play_set(obj, play);
5380      }
5381
5382    EINA_DEPRECATED EAPI extern inline Eina_Bool elm_icon_anim_play_get(const Evas_Object *obj)
5383      {
5384         return elm_icon_animated_play_get(obj);
5385      }
5386
5387    /**
5388     * @}
5389     */
5390
5391    /**
5392     * @defgroup Image Image
5393     *
5394     * @image html img/widget/image/preview-00.png
5395     * @image latex img/widget/image/preview-00.eps
5396
5397     *
5398     * An object that allows one to load an image file to it. It can be used
5399     * anywhere like any other elementary widget.
5400     *
5401     * This widget provides most of the functionality provided from @ref Bg or @ref
5402     * Icon, but with a slightly different API (use the one that fits better your
5403     * needs).
5404     *
5405     * The features not provided by those two other image widgets are:
5406     * @li allowing to get the basic @c Evas_Object with elm_image_object_get();
5407     * @li change the object orientation with elm_image_orient_set();
5408     * @li and turning the image editable with elm_image_editable_set().
5409     *
5410     * Signals that you can add callbacks for are:
5411     *
5412     * @li @c "clicked" - This is called when a user has clicked the image
5413     *
5414     * An example of usage for this API follows:
5415     * @li @ref tutorial_image
5416     */
5417
5418    /**
5419     * @addtogroup Image
5420     * @{
5421     */
5422
5423    /**
5424     * @enum _Elm_Image_Orient
5425     * @typedef Elm_Image_Orient
5426     *
5427     * Possible orientation options for elm_image_orient_set().
5428     *
5429     * @image html elm_image_orient_set.png
5430     * @image latex elm_image_orient_set.eps width=\textwidth
5431     *
5432     * @ingroup Image
5433     */
5434    typedef enum _Elm_Image_Orient
5435      {
5436         ELM_IMAGE_ORIENT_NONE, /**< no orientation change */
5437         ELM_IMAGE_ROTATE_90_CW, /**< rotate 90 degrees clockwise */
5438         ELM_IMAGE_ROTATE_180_CW, /**< rotate 180 degrees clockwise */
5439         ELM_IMAGE_ROTATE_90_CCW, /**< rotate 90 degrees counter-clockwise (i.e. 270 degrees clockwise) */
5440         ELM_IMAGE_FLIP_HORIZONTAL, /**< flip image horizontally */
5441         ELM_IMAGE_FLIP_VERTICAL, /**< flip image vertically */
5442         ELM_IMAGE_FLIP_TRANSPOSE, /**< flip the image along the y = (side - x) line*/
5443         ELM_IMAGE_FLIP_TRANSVERSE /**< flip the image along the y = x line */
5444      } Elm_Image_Orient;
5445
5446    /**
5447     * Add a new image to the parent.
5448     *
5449     * @param parent The parent object
5450     * @return The new object or NULL if it cannot be created
5451     *
5452     * @see elm_image_file_set()
5453     *
5454     * @ingroup Image
5455     */
5456    EAPI Evas_Object     *elm_image_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5457    /**
5458     * Set the file that will be used as image.
5459     *
5460     * @param obj The image object
5461     * @param file The path to file that will be used as image
5462     * @param group The group that the image belongs in edje file (if it's an
5463     * edje image)
5464     *
5465     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
5466     *
5467     * @see elm_image_file_get()
5468     *
5469     * @ingroup Image
5470     */
5471    EAPI Eina_Bool        elm_image_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
5472    /**
5473     * Get the file that will be used as image.
5474     *
5475     * @param obj The image object
5476     * @param file The path to file
5477     * @param group The group that the image belongs in edje file
5478     *
5479     * @see elm_image_file_set()
5480     *
5481     * @ingroup Image
5482     */
5483    EAPI void             elm_image_file_get(const Evas_Object *obj, const char **file, const char **group) EINA_ARG_NONNULL(1);
5484    /**
5485     * Set the smooth effect for an image.
5486     *
5487     * @param obj The image object
5488     * @param smooth @c EINA_TRUE if smooth scaling should be used, @c EINA_FALSE
5489     * otherwise. Default is @c EINA_TRUE.
5490     *
5491     * Set the scaling algorithm to be used when scaling the image. Smooth
5492     * scaling provides a better resulting image, but is slower.
5493     *
5494     * The smooth scaling should be disabled when making animations that change
5495     * the image size, since it will be faster. Animations that don't require
5496     * resizing of the image can keep the smooth scaling enabled (even if the
5497     * image is already scaled, since the scaled image will be cached).
5498     *
5499     * @see elm_image_smooth_get()
5500     *
5501     * @ingroup Image
5502     */
5503    EAPI void             elm_image_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
5504    /**
5505     * Get the smooth effect for an image.
5506     *
5507     * @param obj The image object
5508     * @return @c EINA_TRUE if smooth scaling is enabled, @c EINA_FALSE otherwise.
5509     *
5510     * @see elm_image_smooth_get()
5511     *
5512     * @ingroup Image
5513     */
5514    EAPI Eina_Bool        elm_image_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5515
5516    /**
5517     * Gets the current size of the image.
5518     *
5519     * @param obj The image object.
5520     * @param w Pointer to store width, or NULL.
5521     * @param h Pointer to store height, or NULL.
5522     *
5523     * This is the real size of the image, not the size of the object.
5524     *
5525     * On error, neither w or h will be written.
5526     *
5527     * @ingroup Image
5528     */
5529    EAPI void             elm_image_object_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
5530    /**
5531     * Disable scaling of this object.
5532     *
5533     * @param obj The image object.
5534     * @param no_scale @c EINA_TRUE if the object is not scalable, @c EINA_FALSE
5535     * otherwise. Default is @c EINA_FALSE.
5536     *
5537     * This function disables scaling of the elm_image widget through the
5538     * function elm_object_scale_set(). However, this does not affect the widget
5539     * size/resize in any way. For that effect, take a look at
5540     * elm_image_scale_set().
5541     *
5542     * @see elm_image_no_scale_get()
5543     * @see elm_image_scale_set()
5544     * @see elm_object_scale_set()
5545     *
5546     * @ingroup Image
5547     */
5548    EAPI void             elm_image_no_scale_set(Evas_Object *obj, Eina_Bool no_scale) EINA_ARG_NONNULL(1);
5549    /**
5550     * Get whether scaling is disabled on the object.
5551     *
5552     * @param obj The image object
5553     * @return @c EINA_TRUE if scaling is disabled, @c EINA_FALSE otherwise
5554     *
5555     * @see elm_image_no_scale_set()
5556     *
5557     * @ingroup Image
5558     */
5559    EAPI Eina_Bool        elm_image_no_scale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5560    /**
5561     * Set 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. Default is
5565     * @c EINA_TRUE.
5566     * @param scale_down A bool to set if the object is resizable down. Default
5567     * is @c EINA_TRUE.
5568     *
5569     * This function limits the image resize ability. If @p scale_up is set to
5570     * @c EINA_FALSE, the object can't have its height or width resized to a value
5571     * higher than the original image size. Same is valid for @p scale_down.
5572     *
5573     * @see elm_image_scale_get()
5574     *
5575     * @ingroup Image
5576     */
5577    EAPI void             elm_image_scale_set(Evas_Object *obj, Eina_Bool scale_up, Eina_Bool scale_down) EINA_ARG_NONNULL(1);
5578    /**
5579     * Get if the object is (up/down) resizable.
5580     *
5581     * @param obj The image object
5582     * @param scale_up A bool to set if the object is resizable up
5583     * @param scale_down A bool to set if the object is resizable down
5584     *
5585     * @see elm_image_scale_set()
5586     *
5587     * @ingroup Image
5588     */
5589    EAPI void             elm_image_scale_get(const Evas_Object *obj, Eina_Bool *scale_up, Eina_Bool *scale_down) EINA_ARG_NONNULL(1);
5590    /**
5591     * Set if the image fills the entire object area, when keeping the aspect ratio.
5592     *
5593     * @param obj The image object
5594     * @param fill_outside @c EINA_TRUE if the object is filled outside,
5595     * @c EINA_FALSE otherwise. Default is @c EINA_FALSE.
5596     *
5597     * When the image should keep its aspect ratio even if resized to another
5598     * aspect ratio, there are two possibilities to resize it: keep the entire
5599     * image inside the limits of height and width of the object (@p fill_outside
5600     * is @c EINA_FALSE) or let the extra width or height go outside of the object,
5601     * and the image will fill the entire object (@p fill_outside is @c EINA_TRUE).
5602     *
5603     * @note This option will have no effect if
5604     * elm_image_aspect_ratio_retained_set() is set to @c EINA_FALSE.
5605     *
5606     * @see elm_image_fill_outside_get()
5607     * @see elm_image_aspect_ratio_retained_set()
5608     *
5609     * @ingroup Image
5610     */
5611    EAPI void             elm_image_fill_outside_set(Evas_Object *obj, Eina_Bool fill_outside) EINA_ARG_NONNULL(1);
5612    /**
5613     * Get if the object is filled outside
5614     *
5615     * @param obj The image object
5616     * @return @c EINA_TRUE if the object is filled outside, @c EINA_FALSE otherwise.
5617     *
5618     * @see elm_image_fill_outside_set()
5619     *
5620     * @ingroup Image
5621     */
5622    EAPI Eina_Bool        elm_image_fill_outside_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5623    /**
5624     * Set the prescale size for the image
5625     *
5626     * @param obj The image object
5627     * @param size The prescale size. This value is used for both width and
5628     * height.
5629     *
5630     * This function sets a new size for pixmap representation of the given
5631     * image. It allows the image to be loaded already in the specified size,
5632     * reducing the memory usage and load time when loading a big image with load
5633     * size set to a smaller size.
5634     *
5635     * It's equivalent to the elm_bg_load_size_set() function for bg.
5636     *
5637     * @note this is just a hint, the real size of the pixmap may differ
5638     * depending on the type of image being loaded, being bigger than requested.
5639     *
5640     * @see elm_image_prescale_get()
5641     * @see elm_bg_load_size_set()
5642     *
5643     * @ingroup Image
5644     */
5645    EAPI void             elm_image_prescale_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
5646    /**
5647     * Get the prescale size for the image
5648     *
5649     * @param obj The image object
5650     * @return The prescale size
5651     *
5652     * @see elm_image_prescale_set()
5653     *
5654     * @ingroup Image
5655     */
5656    EAPI int              elm_image_prescale_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5657    /**
5658     * Set the image orientation.
5659     *
5660     * @param obj The image object
5661     * @param orient The image orientation @ref Elm_Image_Orient
5662     *  Default is #ELM_IMAGE_ORIENT_NONE.
5663     *
5664     * This function allows to rotate or flip the given image.
5665     *
5666     * @see elm_image_orient_get()
5667     * @see @ref Elm_Image_Orient
5668     *
5669     * @ingroup Image
5670     */
5671    EAPI void             elm_image_orient_set(Evas_Object *obj, Elm_Image_Orient orient) EINA_ARG_NONNULL(1);
5672    /**
5673     * Get the image orientation.
5674     *
5675     * @param obj The image object
5676     * @return The image orientation @ref Elm_Image_Orient
5677     *
5678     * @see elm_image_orient_set()
5679     * @see @ref Elm_Image_Orient
5680     *
5681     * @ingroup Image
5682     */
5683    EAPI Elm_Image_Orient elm_image_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5684    /**
5685     * Make the image 'editable'.
5686     *
5687     * @param obj Image object.
5688     * @param set Turn on or off editability. Default is @c EINA_FALSE.
5689     *
5690     * This means the image is a valid drag target for drag and drop, and can be
5691     * cut or pasted too.
5692     *
5693     * @ingroup Image
5694     */
5695    EAPI void             elm_image_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
5696    /**
5697     * Check if the image 'editable'.
5698     *
5699     * @param obj Image object.
5700     * @return Editability.
5701     *
5702     * A return value of EINA_TRUE means the image is a valid drag target
5703     * for drag and drop, and can be cut or pasted too.
5704     *
5705     * @ingroup Image
5706     */
5707    EAPI Eina_Bool        elm_image_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5708    /**
5709     * Get the basic Evas_Image object from this object (widget).
5710     *
5711     * @param obj The image object to get the inlined image from
5712     * @return The inlined image object, or NULL if none exists
5713     *
5714     * This function allows one to get the underlying @c Evas_Object of type
5715     * Image from this elementary widget. It can be useful to do things like get
5716     * the pixel data, save the image to a file, etc.
5717     *
5718     * @note Be careful to not manipulate it, as it is under control of
5719     * elementary.
5720     *
5721     * @ingroup Image
5722     */
5723    EAPI Evas_Object     *elm_image_object_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5724    /**
5725     * Set whether the original aspect ratio of the image should be kept on resize.
5726     *
5727     * @param obj The image object.
5728     * @param retained @c EINA_TRUE if the image should retain the aspect,
5729     * @c EINA_FALSE otherwise.
5730     *
5731     * The original aspect ratio (width / height) of the image is usually
5732     * distorted to match the object's size. Enabling this option will retain
5733     * this original aspect, and the way that the image is fit into the object's
5734     * area depends on the option set by elm_image_fill_outside_set().
5735     *
5736     * @see elm_image_aspect_ratio_retained_get()
5737     * @see elm_image_fill_outside_set()
5738     *
5739     * @ingroup Image
5740     */
5741    EAPI void             elm_image_aspect_ratio_retained_set(Evas_Object *obj, Eina_Bool retained) EINA_ARG_NONNULL(1);
5742    /**
5743     * Get if the object retains the original aspect ratio.
5744     *
5745     * @param obj The image object.
5746     * @return @c EINA_TRUE if the object keeps the original aspect, @c EINA_FALSE
5747     * otherwise.
5748     *
5749     * @ingroup Image
5750     */
5751    EAPI Eina_Bool        elm_image_aspect_ratio_retained_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5752
5753    /**
5754     * @}
5755     */
5756
5757    /* glview */
5758    typedef void (*Elm_GLView_Func_Cb)(Evas_Object *obj);
5759
5760    /* old API compatibility */
5761    typedef Elm_GLView_Func_Cb Elm_GLView_Func;
5762
5763    typedef enum _Elm_GLView_Mode
5764      {
5765         ELM_GLVIEW_ALPHA   = 1,
5766         ELM_GLVIEW_DEPTH   = 2,
5767         ELM_GLVIEW_STENCIL = 4
5768      } Elm_GLView_Mode;
5769
5770    /**
5771     * Defines a policy for the glview resizing.
5772     *
5773     * @note Default is ELM_GLVIEW_RESIZE_POLICY_RECREATE
5774     */
5775    typedef enum _Elm_GLView_Resize_Policy
5776      {
5777         ELM_GLVIEW_RESIZE_POLICY_RECREATE = 1,      /**< Resize the internal surface along with the image */
5778         ELM_GLVIEW_RESIZE_POLICY_SCALE    = 2       /**< Only reize the internal image and not the surface */
5779      } Elm_GLView_Resize_Policy;
5780
5781    typedef enum _Elm_GLView_Render_Policy
5782      {
5783         ELM_GLVIEW_RENDER_POLICY_ON_DEMAND = 1,     /**< Render only when there is a need for redrawing */
5784         ELM_GLVIEW_RENDER_POLICY_ALWAYS    = 2      /**< Render always even when it is not visible */
5785      } Elm_GLView_Render_Policy;
5786
5787    /**
5788     * @defgroup GLView
5789     *
5790     * A simple GLView widget that allows GL rendering.
5791     *
5792     * Signals that you can add callbacks for are:
5793     *
5794     * @{
5795     */
5796
5797    /**
5798     * Add a new glview to the parent
5799     *
5800     * @param parent The parent object
5801     * @return The new object or NULL if it cannot be created
5802     *
5803     * @ingroup GLView
5804     */
5805    EAPI Evas_Object     *elm_glview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
5806
5807    /**
5808     * Sets the size of the glview
5809     *
5810     * @param obj The glview object
5811     * @param width width of the glview object
5812     * @param height height of the glview object
5813     *
5814     * @ingroup GLView
5815     */
5816    EAPI void             elm_glview_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
5817
5818    /**
5819     * Gets the size of the glview.
5820     *
5821     * @param obj The glview object
5822     * @param width width of the glview object
5823     * @param height height of the glview object
5824     *
5825     * Note that this function returns the actual image size of the
5826     * glview.  This means that when the scale policy is set to
5827     * ELM_GLVIEW_RESIZE_POLICY_SCALE, it'll return the non-scaled
5828     * size.
5829     *
5830     * @ingroup GLView
5831     */
5832    EAPI void             elm_glview_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
5833
5834    /**
5835     * Gets the gl api struct for gl rendering
5836     *
5837     * @param obj The glview object
5838     * @return The api object or NULL if it cannot be created
5839     *
5840     * @ingroup GLView
5841     */
5842    EAPI Evas_GL_API     *elm_glview_gl_api_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
5843
5844    /**
5845     * Set the mode of the GLView. Supports Three simple modes.
5846     *
5847     * @param obj The glview object
5848     * @param mode The mode Options OR'ed enabling Alpha, Depth, Stencil.
5849     * @return True if set properly.
5850     *
5851     * @ingroup GLView
5852     */
5853    EAPI Eina_Bool        elm_glview_mode_set(Evas_Object *obj, Elm_GLView_Mode mode) EINA_ARG_NONNULL(1);
5854
5855    /**
5856     * Set the resize policy for the glview object.
5857     *
5858     * @param obj The glview object.
5859     * @param policy The scaling policy.
5860     *
5861     * By default, the resize policy is set to
5862     * ELM_GLVIEW_RESIZE_POLICY_RECREATE.  When resize is called it
5863     * destroys the previous surface and recreates the newly specified
5864     * size. If the policy is set to ELM_GLVIEW_RESIZE_POLICY_SCALE,
5865     * however, glview only scales the image object and not the underlying
5866     * GL Surface.
5867     *
5868     * @ingroup GLView
5869     */
5870    EAPI Eina_Bool        elm_glview_resize_policy_set(Evas_Object *obj, Elm_GLView_Resize_Policy policy) EINA_ARG_NONNULL(1);
5871
5872    /**
5873     * Set the render policy for the glview object.
5874     *
5875     * @param obj The glview object.
5876     * @param policy The render policy.
5877     *
5878     * By default, the render policy is set to
5879     * ELM_GLVIEW_RENDER_POLICY_ON_DEMAND.  This policy is set such
5880     * that during the render loop, glview is only redrawn if it needs
5881     * to be redrawn. (i.e. When it is visible) If the policy is set to
5882     * ELM_GLVIEWW_RENDER_POLICY_ALWAYS, it redraws regardless of
5883     * whether it is visible/need redrawing or not.
5884     *
5885     * @ingroup GLView
5886     */
5887    EAPI Eina_Bool        elm_glview_render_policy_set(Evas_Object *obj, Elm_GLView_Render_Policy policy) EINA_ARG_NONNULL(1);
5888
5889    /**
5890     * Set the init function that runs once in the main loop.
5891     *
5892     * @param obj The glview object.
5893     * @param func The init function to be registered.
5894     *
5895     * The registered init function gets called once during the render loop.
5896     *
5897     * @ingroup GLView
5898     */
5899    EAPI void             elm_glview_init_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5900
5901    /**
5902     * Set the render function that runs in the main loop.
5903     *
5904     * @param obj The glview object.
5905     * @param func The delete function to be registered.
5906     *
5907     * The registered del function gets called when GLView object is deleted.
5908     *
5909     * @ingroup GLView
5910     */
5911    EAPI void             elm_glview_del_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5912
5913    /**
5914     * Set the resize function that gets called when resize happens.
5915     *
5916     * @param obj The glview object.
5917     * @param func The resize function to be registered.
5918     *
5919     * @ingroup GLView
5920     */
5921    EAPI void             elm_glview_resize_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5922
5923    /**
5924     * Set the render function that runs in the main loop.
5925     *
5926     * @param obj The glview object.
5927     * @param func The render function to be registered.
5928     *
5929     * @ingroup GLView
5930     */
5931    EAPI void             elm_glview_render_func_set(Evas_Object *obj, Elm_GLView_Func_Cb func) EINA_ARG_NONNULL(1);
5932
5933    /**
5934     * Notifies that there has been changes in the GLView.
5935     *
5936     * @param obj The glview object.
5937     *
5938     * @ingroup GLView
5939     */
5940    EAPI void             elm_glview_changed_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
5941
5942    /**
5943     * @}
5944     */
5945
5946    /* box */
5947    /**
5948     * @defgroup Box Box
5949     *
5950     * @image html img/widget/box/preview-00.png
5951     * @image latex img/widget/box/preview-00.eps width=\textwidth
5952     *
5953     * @image html img/box.png
5954     * @image latex img/box.eps width=\textwidth
5955     *
5956     * A box arranges objects in a linear fashion, governed by a layout function
5957     * that defines the details of this arrangement.
5958     *
5959     * By default, the box will use an internal function to set the layout to
5960     * a single row, either vertical or horizontal. This layout is affected
5961     * by a number of parameters, such as the homogeneous flag set by
5962     * elm_box_homogeneous_set(), the values given by elm_box_padding_set() and
5963     * elm_box_align_set() and the hints set to each object in the box.
5964     *
5965     * For this default layout, it's possible to change the orientation with
5966     * elm_box_horizontal_set(). The box will start in the vertical orientation,
5967     * placing its elements ordered from top to bottom. When horizontal is set,
5968     * the order will go from left to right. If the box is set to be
5969     * homogeneous, every object in it will be assigned the same space, that
5970     * of the largest object. Padding can be used to set some spacing between
5971     * the cell given to each object. The alignment of the box, set with
5972     * elm_box_align_set(), determines how the bounding box of all the elements
5973     * will be placed within the space given to the box widget itself.
5974     *
5975     * The size hints of each object also affect how they are placed and sized
5976     * within the box. evas_object_size_hint_min_set() will give the minimum
5977     * size the object can have, and the box will use it as the basis for all
5978     * latter calculations. Elementary widgets set their own minimum size as
5979     * needed, so there's rarely any need to use it manually.
5980     *
5981     * evas_object_size_hint_weight_set(), when not in homogeneous mode, is
5982     * used to tell whether the object will be allocated the minimum size it
5983     * needs or if the space given to it should be expanded. It's important
5984     * to realize that expanding the size given to the object is not the same
5985     * thing as resizing the object. It could very well end being a small
5986     * widget floating in a much larger empty space. If not set, the weight
5987     * for objects will normally be 0.0 for both axis, meaning the widget will
5988     * not be expanded. To take as much space possible, set the weight to
5989     * EVAS_HINT_EXPAND (defined to 1.0) for the desired axis to expand.
5990     *
5991     * Besides how much space each object is allocated, it's possible to control
5992     * how the widget will be placed within that space using
5993     * evas_object_size_hint_align_set(). By default, this value will be 0.5
5994     * for both axis, meaning the object will be centered, but any value from
5995     * 0.0 (left or top, for the @c x and @c y axis, respectively) to 1.0
5996     * (right or bottom) can be used. The special value EVAS_HINT_FILL, which
5997     * is -1.0, means the object will be resized to fill the entire space it
5998     * was allocated.
5999     *
6000     * In addition, customized functions to define the layout can be set, which
6001     * allow the application developer to organize the objects within the box
6002     * in any number of ways.
6003     *
6004     * The special elm_box_layout_transition() function can be used
6005     * to switch from one layout to another, animating the motion of the
6006     * children of the box.
6007     *
6008     * @note Objects should not be added to box objects using _add() calls.
6009     *
6010     * Some examples on how to use boxes follow:
6011     * @li @ref box_example_01
6012     * @li @ref box_example_02
6013     *
6014     * @{
6015     */
6016    /**
6017     * @typedef Elm_Box_Transition
6018     *
6019     * Opaque handler containing the parameters to perform an animated
6020     * transition of the layout the box uses.
6021     *
6022     * @see elm_box_transition_new()
6023     * @see elm_box_layout_set()
6024     * @see elm_box_layout_transition()
6025     */
6026    typedef struct _Elm_Box_Transition Elm_Box_Transition;
6027
6028    /**
6029     * Add a new box to the parent
6030     *
6031     * By default, the box will be in vertical mode and non-homogeneous.
6032     *
6033     * @param parent The parent object
6034     * @return The new object or NULL if it cannot be created
6035     */
6036    EAPI Evas_Object        *elm_box_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6037    /**
6038     * Set the horizontal orientation
6039     *
6040     * By default, box object arranges their contents vertically from top to
6041     * bottom.
6042     * By calling this function with @p horizontal as EINA_TRUE, the box will
6043     * become horizontal, arranging contents from left to right.
6044     *
6045     * @note This flag is ignored if a custom layout function is set.
6046     *
6047     * @param obj The box object
6048     * @param horizontal The horizontal flag (EINA_TRUE = horizontal,
6049     * EINA_FALSE = vertical)
6050     */
6051    EAPI void                elm_box_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
6052    /**
6053     * Get the horizontal orientation
6054     *
6055     * @param obj The box object
6056     * @return EINA_TRUE if the box is set to horizontal mode, EINA_FALSE otherwise
6057     */
6058    EAPI Eina_Bool           elm_box_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6059    /**
6060     * Set the box to arrange its children homogeneously
6061     *
6062     * If enabled, homogeneous layout makes all items the same size, according
6063     * to the size of the largest of its children.
6064     *
6065     * @note This flag is ignored if a custom layout function is set.
6066     *
6067     * @param obj The box object
6068     * @param homogeneous The homogeneous flag
6069     */
6070    EAPI void                elm_box_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
6071    /**
6072     * Get whether the box is using homogeneous mode or not
6073     *
6074     * @param obj The box object
6075     * @return EINA_TRUE if it's homogeneous, EINA_FALSE otherwise
6076     */
6077    EAPI Eina_Bool           elm_box_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6078    EINA_DEPRECATED EAPI void elm_box_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
6079    EINA_DEPRECATED EAPI Eina_Bool elm_box_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6080    /**
6081     * Add an object to the beginning of the pack list
6082     *
6083     * Pack @p subobj into the box @p obj, placing it first in the list of
6084     * children objects. The actual position the object will get on screen
6085     * depends on the layout used. If no custom layout is set, it will be at
6086     * the top or left, depending if the box is vertical or horizontal,
6087     * respectively.
6088     *
6089     * @param obj The box object
6090     * @param subobj The object to add to the box
6091     *
6092     * @see elm_box_pack_end()
6093     * @see elm_box_pack_before()
6094     * @see elm_box_pack_after()
6095     * @see elm_box_unpack()
6096     * @see elm_box_unpack_all()
6097     * @see elm_box_clear()
6098     */
6099    EAPI void                elm_box_pack_start(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
6100    /**
6101     * Add an object at the end of the pack list
6102     *
6103     * Pack @p subobj into the box @p obj, placing it last in the list of
6104     * children objects. The actual position the object will get on screen
6105     * depends on the layout used. If no custom layout is set, it will be at
6106     * the bottom or right, depending if the box is vertical or horizontal,
6107     * respectively.
6108     *
6109     * @param obj The box object
6110     * @param subobj The object to add to the box
6111     *
6112     * @see elm_box_pack_start()
6113     * @see elm_box_pack_before()
6114     * @see elm_box_pack_after()
6115     * @see elm_box_unpack()
6116     * @see elm_box_unpack_all()
6117     * @see elm_box_clear()
6118     */
6119    EAPI void                elm_box_pack_end(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
6120    /**
6121     * Adds an object to the box before the indicated object
6122     *
6123     * This will add the @p subobj to the box indicated before the object
6124     * indicated with @p before. If @p before is not already in the box, results
6125     * are undefined. Before means either to the left of the indicated object or
6126     * above it depending on orientation.
6127     *
6128     * @param obj The box object
6129     * @param subobj The object to add to the box
6130     * @param before The object before which to add it
6131     *
6132     * @see elm_box_pack_start()
6133     * @see elm_box_pack_end()
6134     * @see elm_box_pack_after()
6135     * @see elm_box_unpack()
6136     * @see elm_box_unpack_all()
6137     * @see elm_box_clear()
6138     */
6139    EAPI void                elm_box_pack_before(Evas_Object *obj, Evas_Object *subobj, Evas_Object *before) EINA_ARG_NONNULL(1);
6140    /**
6141     * Adds an object to the box after the indicated object
6142     *
6143     * This will add the @p subobj to the box indicated after the object
6144     * indicated with @p after. If @p after is not already in the box, results
6145     * are undefined. After means either to the right of the indicated object or
6146     * below it depending on orientation.
6147     *
6148     * @param obj The box object
6149     * @param subobj The object to add to the box
6150     * @param after The object after which to add it
6151     *
6152     * @see elm_box_pack_start()
6153     * @see elm_box_pack_end()
6154     * @see elm_box_pack_before()
6155     * @see elm_box_unpack()
6156     * @see elm_box_unpack_all()
6157     * @see elm_box_clear()
6158     */
6159    EAPI void                elm_box_pack_after(Evas_Object *obj, Evas_Object *subobj, Evas_Object *after) EINA_ARG_NONNULL(1);
6160    /**
6161     * Clear the box of all children
6162     *
6163     * Remove all the elements contained by the box, deleting the respective
6164     * objects.
6165     *
6166     * @param obj The box object
6167     *
6168     * @see elm_box_unpack()
6169     * @see elm_box_unpack_all()
6170     */
6171    EAPI void                elm_box_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
6172    /**
6173     * Unpack a box item
6174     *
6175     * Remove the object given by @p subobj from the box @p obj without
6176     * deleting it.
6177     *
6178     * @param obj The box object
6179     *
6180     * @see elm_box_unpack_all()
6181     * @see elm_box_clear()
6182     */
6183    EAPI void                elm_box_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
6184    /**
6185     * Remove all items from the box, without deleting them
6186     *
6187     * Clear the box from all children, but don't delete the respective objects.
6188     * If no other references of the box children exist, the objects will never
6189     * be deleted, and thus the application will leak the memory. Make sure
6190     * when using this function that you hold a reference to all the objects
6191     * in the box @p obj.
6192     *
6193     * @param obj The box object
6194     *
6195     * @see elm_box_clear()
6196     * @see elm_box_unpack()
6197     */
6198    EAPI void                elm_box_unpack_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
6199    /**
6200     * Retrieve a list of the objects packed into the box
6201     *
6202     * Returns a new @c Eina_List with a pointer to @c Evas_Object in its nodes.
6203     * The order of the list corresponds to the packing order the box uses.
6204     *
6205     * You must free this list with eina_list_free() once you are done with it.
6206     *
6207     * @param obj The box object
6208     */
6209    EAPI const Eina_List    *elm_box_children_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6210    /**
6211     * Set the space (padding) between the box's elements.
6212     *
6213     * Extra space in pixels that will be added between a box child and its
6214     * neighbors after its containing cell has been calculated. This padding
6215     * is set for all elements in the box, besides any possible padding that
6216     * individual elements may have through their size hints.
6217     *
6218     * @param obj The box object
6219     * @param horizontal The horizontal space between elements
6220     * @param vertical The vertical space between elements
6221     */
6222    EAPI void                elm_box_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
6223    /**
6224     * Get the space (padding) between the box's elements.
6225     *
6226     * @param obj The box object
6227     * @param horizontal The horizontal space between elements
6228     * @param vertical The vertical space between elements
6229     *
6230     * @see elm_box_padding_set()
6231     */
6232    EAPI void                elm_box_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
6233    /**
6234     * Set the alignment of the whole bouding box of contents.
6235     *
6236     * Sets how the bounding box containing all the elements of the box, after
6237     * their sizes and position has been calculated, will be aligned within
6238     * the space given for the whole box widget.
6239     *
6240     * @param obj The box object
6241     * @param horizontal The horizontal alignment of elements
6242     * @param vertical The vertical alignment of elements
6243     */
6244    EAPI void                elm_box_align_set(Evas_Object *obj, double horizontal, double vertical) EINA_ARG_NONNULL(1);
6245    /**
6246     * Get the alignment of the whole bouding box of contents.
6247     *
6248     * @param obj The box object
6249     * @param horizontal The horizontal alignment of elements
6250     * @param vertical The vertical alignment of elements
6251     *
6252     * @see elm_box_align_set()
6253     */
6254    EAPI void                elm_box_align_get(const Evas_Object *obj, double *horizontal, double *vertical) EINA_ARG_NONNULL(1);
6255
6256    /**
6257     * Force the box to recalculate its children packing.
6258     *
6259     * If any children was added or removed, box will not calculate the
6260     * values immediately rather leaving it to the next main loop
6261     * iteration. While this is great as it would save lots of
6262     * recalculation, whenever you need to get the position of a just
6263     * added item you must force recalculate before doing so.
6264     *
6265     * @param obj The box object.
6266     */
6267    EAPI void                 elm_box_recalculate(Evas_Object *obj);
6268
6269    /**
6270     * Set the layout defining function to be used by the box
6271     *
6272     * Whenever anything changes that requires the box in @p obj to recalculate
6273     * the size and position of its elements, the function @p cb will be called
6274     * to determine what the layout of the children will be.
6275     *
6276     * Once a custom function is set, everything about the children layout
6277     * is defined by it. The flags set by elm_box_horizontal_set() and
6278     * elm_box_homogeneous_set() no longer have any meaning, and the values
6279     * given by elm_box_padding_set() and elm_box_align_set() are up to this
6280     * layout function to decide if they are used and how. These last two
6281     * will be found in the @c priv parameter, of type @c Evas_Object_Box_Data,
6282     * passed to @p cb. The @c Evas_Object the function receives is not the
6283     * Elementary widget, but the internal Evas Box it uses, so none of the
6284     * functions described here can be used on it.
6285     *
6286     * Any of the layout functions in @c Evas can be used here, as well as the
6287     * special elm_box_layout_transition().
6288     *
6289     * The final @p data argument received by @p cb is the same @p data passed
6290     * here, and the @p free_data function will be called to free it
6291     * whenever the box is destroyed or another layout function is set.
6292     *
6293     * Setting @p cb to NULL will revert back to the default layout function.
6294     *
6295     * @param obj The box object
6296     * @param cb The callback function used for layout
6297     * @param data Data that will be passed to layout function
6298     * @param free_data Function called to free @p data
6299     *
6300     * @see elm_box_layout_transition()
6301     */
6302    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);
6303    /**
6304     * Special layout function that animates the transition from one layout to another
6305     *
6306     * Normally, when switching the layout function for a box, this will be
6307     * reflected immediately on screen on the next render, but it's also
6308     * possible to do this through an animated transition.
6309     *
6310     * This is done by creating an ::Elm_Box_Transition and setting the box
6311     * layout to this function.
6312     *
6313     * For example:
6314     * @code
6315     * Elm_Box_Transition *t = elm_box_transition_new(1.0,
6316     *                            evas_object_box_layout_vertical, // start
6317     *                            NULL, // data for initial layout
6318     *                            NULL, // free function for initial data
6319     *                            evas_object_box_layout_horizontal, // end
6320     *                            NULL, // data for final layout
6321     *                            NULL, // free function for final data
6322     *                            anim_end, // will be called when animation ends
6323     *                            NULL); // data for anim_end function\
6324     * elm_box_layout_set(box, elm_box_layout_transition, t,
6325     *                    elm_box_transition_free);
6326     * @endcode
6327     *
6328     * @note This function can only be used with elm_box_layout_set(). Calling
6329     * it directly will not have the expected results.
6330     *
6331     * @see elm_box_transition_new
6332     * @see elm_box_transition_free
6333     * @see elm_box_layout_set
6334     */
6335    EAPI void                elm_box_layout_transition(Evas_Object *obj, Evas_Object_Box_Data *priv, void *data);
6336    /**
6337     * Create a new ::Elm_Box_Transition to animate the switch of layouts
6338     *
6339     * If you want to animate the change from one layout to another, you need
6340     * to set the layout function of the box to elm_box_layout_transition(),
6341     * passing as user data to it an instance of ::Elm_Box_Transition with the
6342     * necessary information to perform this animation. The free function to
6343     * set for the layout is elm_box_transition_free().
6344     *
6345     * The parameters to create an ::Elm_Box_Transition sum up to how long
6346     * will it be, in seconds, a layout function to describe the initial point,
6347     * another for the final position of the children and one function to be
6348     * called when the whole animation ends. This last function is useful to
6349     * set the definitive layout for the box, usually the same as the end
6350     * layout for the animation, but could be used to start another transition.
6351     *
6352     * @param start_layout The layout function that will be used to start the animation
6353     * @param start_layout_data The data to be passed the @p start_layout function
6354     * @param start_layout_free_data Function to free @p start_layout_data
6355     * @param end_layout The layout function that will be used to end the animation
6356     * @param end_layout_free_data The data to be passed the @p end_layout function
6357     * @param end_layout_free_data Function to free @p end_layout_data
6358     * @param transition_end_cb Callback function called when animation ends
6359     * @param transition_end_data Data to be passed to @p transition_end_cb
6360     * @return An instance of ::Elm_Box_Transition
6361     *
6362     * @see elm_box_transition_new
6363     * @see elm_box_layout_transition
6364     */
6365    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);
6366    /**
6367     * Free a Elm_Box_Transition instance created with elm_box_transition_new().
6368     *
6369     * This function is mostly useful as the @c free_data parameter in
6370     * elm_box_layout_set() when elm_box_layout_transition().
6371     *
6372     * @param data The Elm_Box_Transition instance to be freed.
6373     *
6374     * @see elm_box_transition_new
6375     * @see elm_box_layout_transition
6376     */
6377    EAPI void                elm_box_transition_free(void *data);
6378    /**
6379     * @}
6380     */
6381
6382    /* button */
6383    /**
6384     * @defgroup Button Button
6385     *
6386     * @image html img/widget/button/preview-00.png
6387     * @image latex img/widget/button/preview-00.eps
6388     * @image html img/widget/button/preview-01.png
6389     * @image latex img/widget/button/preview-01.eps
6390     * @image html img/widget/button/preview-02.png
6391     * @image latex img/widget/button/preview-02.eps
6392     *
6393     * This is a push-button. Press it and run some function. It can contain
6394     * a simple label and icon object and it also has an autorepeat feature.
6395     *
6396     * This widgets emits the following signals:
6397     * @li "clicked": the user clicked the button (press/release).
6398     * @li "repeated": the user pressed the button without releasing it.
6399     * @li "pressed": button was pressed.
6400     * @li "unpressed": button was released after being pressed.
6401     * In all three cases, the @c event parameter of the callback will be
6402     * @c NULL.
6403     *
6404     * Also, defined in the default theme, the button has the following styles
6405     * available:
6406     * @li default: a normal button.
6407     * @li anchor: Like default, but the button fades away when the mouse is not
6408     * over it, leaving only the text or icon.
6409     * @li hoversel_vertical: Internally used by @ref Hoversel to give a
6410     * continuous look across its options.
6411     * @li hoversel_vertical_entry: Another internal for @ref Hoversel.
6412     *
6413     * Default contents parts of the button widget that you can use for are:
6414     * @li "icon" - A icon of the button
6415     *
6416     * Default text parts of the button widget that you can use for are:
6417     * @li "default" - Label of the button
6418     *
6419     * Follow through a complete example @ref button_example_01 "here".
6420     * @{
6421     */
6422
6423    typedef enum
6424      {
6425         UIControlStateDefault,
6426         UIControlStateHighlighted,
6427         UIControlStateDisabled,
6428         UIControlStateFocused,
6429         UIControlStateReserved
6430      } UIControlState;
6431
6432    /**
6433     * Add a new button to the parent's canvas
6434     *
6435     * @param parent The parent object
6436     * @return The new object or NULL if it cannot be created
6437     */
6438    EAPI Evas_Object *elm_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6439    /**
6440     * Set the label used in the button
6441     *
6442     * The passed @p label can be NULL to clean any existing text in it and
6443     * leave the button as an icon only object.
6444     *
6445     * @param obj The button object
6446     * @param label The text will be written on the button
6447     * @deprecated use elm_object_text_set() instead.
6448     */
6449    EINA_DEPRECATED EAPI void         elm_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6450    /**
6451     * Get the label set for the button
6452     *
6453     * The string returned is an internal pointer and should not be freed or
6454     * altered. It will also become invalid when the button is destroyed.
6455     * The string returned, if not NULL, is a stringshare, so if you need to
6456     * keep it around even after the button is destroyed, you can use
6457     * eina_stringshare_ref().
6458     *
6459     * @param obj The button object
6460     * @return The text set to the label, or NULL if nothing is set
6461     * @deprecated use elm_object_text_set() instead.
6462     */
6463    EINA_DEPRECATED EAPI const char  *elm_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6464    /**
6465     * Set the label for each state of button
6466     *
6467     * The passed @p label can be NULL to clean any existing text in it and
6468     * leave the button as an icon only object for the state.
6469     *
6470     * @param obj The button object
6471     * @param label The text will be written on the button
6472     * @param state The state of button
6473     *
6474     * @ingroup Button
6475     */
6476    EINA_DEPRECATED EAPI void         elm_button_label_set_for_state(Evas_Object *obj, const char *label, UIControlState state) EINA_ARG_NONNULL(1);
6477    /**
6478     * Get the label of button for each state
6479     *
6480     * The string returned is an internal pointer and should not be freed or
6481     * altered. It will also become invalid when the button is destroyed.
6482     * The string returned, if not NULL, is a stringshare, so if you need to
6483     * keep it around even after the button is destroyed, you can use
6484     * eina_stringshare_ref().
6485     *
6486     * @param obj The button object
6487     * @param state The state of button
6488     * @return The title of button for state
6489     *
6490     * @ingroup Button
6491     */
6492    EINA_DEPRECATED EAPI const char  *elm_button_label_get_for_state(const Evas_Object *obj, UIControlState state) EINA_ARG_NONNULL(1);
6493    /**
6494     * Set the icon used for the button
6495     *
6496     * Setting a new icon will delete any other that was previously set, making
6497     * any reference to them invalid. If you need to maintain the previous
6498     * object alive, unset it first with elm_button_icon_unset().
6499     *
6500     * @param obj The button object
6501     * @param icon The icon object for the button
6502     * @deprecated use elm_object_part_content_set() instead.
6503     */
6504    WILL_DEPRECATE  EAPI void         elm_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6505    /**
6506     * Get the icon used for the button
6507     *
6508     * Return the icon object which is set for this widget. If the button is
6509     * destroyed or another icon is set, the returned object will be deleted
6510     * and any reference to it will be invalid.
6511     *
6512     * @param obj The button object
6513     * @return The icon object that is being used
6514     *
6515     * @deprecated use elm_object_part_content_get() instead
6516     */
6517    WILL_DEPRECATE  EAPI Evas_Object *elm_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6518    /**
6519     * Remove the icon set without deleting it and return the object
6520     *
6521     * This function drops the reference the button holds of the icon object
6522     * and returns this last object. It is used in case you want to remove any
6523     * icon, or set another one, without deleting the actual object. The button
6524     * will be left without an icon set.
6525     *
6526     * @param obj The button object
6527     * @return The icon object that was being used
6528     * @deprecated use elm_object_part_content_unset() instead.
6529     */
6530    WILL_DEPRECATE  EAPI Evas_Object *elm_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6531    /**
6532     * Turn on/off the autorepeat event generated when the button is kept pressed
6533     *
6534     * When off, no autorepeat is performed and buttons emit a normal @c clicked
6535     * signal when they are clicked.
6536     *
6537     * When on, keeping a button pressed will continuously emit a @c repeated
6538     * signal until the button is released. The time it takes until it starts
6539     * emitting the signal is given by
6540     * elm_button_autorepeat_initial_timeout_set(), and the time between each
6541     * new emission by elm_button_autorepeat_gap_timeout_set().
6542     *
6543     * @param obj The button object
6544     * @param on  A bool to turn on/off the event
6545     */
6546    EAPI void         elm_button_autorepeat_set(Evas_Object *obj, Eina_Bool on) EINA_ARG_NONNULL(1);
6547    /**
6548     * Get whether the autorepeat feature is enabled
6549     *
6550     * @param obj The button object
6551     * @return EINA_TRUE if autorepeat is on, EINA_FALSE otherwise
6552     *
6553     * @see elm_button_autorepeat_set()
6554     */
6555    EAPI Eina_Bool    elm_button_autorepeat_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6556    /**
6557     * Set the initial timeout before the autorepeat event is generated
6558     *
6559     * Sets the timeout, in seconds, since the button is pressed until the
6560     * first @c repeated signal is emitted. If @p t is 0.0 or less, there
6561     * won't be any delay and the even will be fired the moment the button is
6562     * pressed.
6563     *
6564     * @param obj The button object
6565     * @param t   Timeout in seconds
6566     *
6567     * @see elm_button_autorepeat_set()
6568     * @see elm_button_autorepeat_gap_timeout_set()
6569     */
6570    EAPI void         elm_button_autorepeat_initial_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
6571    /**
6572     * Get the initial timeout before the autorepeat event is generated
6573     *
6574     * @param obj The button object
6575     * @return Timeout in seconds
6576     *
6577     * @see elm_button_autorepeat_initial_timeout_set()
6578     */
6579    EAPI double       elm_button_autorepeat_initial_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6580    /**
6581     * Set the interval between each generated autorepeat event
6582     *
6583     * After the first @c repeated event is fired, all subsequent ones will
6584     * follow after a delay of @p t seconds for each.
6585     *
6586     * @param obj The button object
6587     * @param t   Interval in seconds
6588     *
6589     * @see elm_button_autorepeat_initial_timeout_set()
6590     */
6591    EAPI void         elm_button_autorepeat_gap_timeout_set(Evas_Object *obj, double t) EINA_ARG_NONNULL(1);
6592    /**
6593     * Get the interval between each generated autorepeat event
6594     *
6595     * @param obj The button object
6596     * @return Interval in seconds
6597     */
6598    EAPI double       elm_button_autorepeat_gap_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6599    /**
6600     * @}
6601     */
6602
6603    /**
6604     * @defgroup File_Selector_Button File Selector Button
6605     *
6606     * @image html img/widget/fileselector_button/preview-00.png
6607     * @image latex img/widget/fileselector_button/preview-00.eps
6608     * @image html img/widget/fileselector_button/preview-01.png
6609     * @image latex img/widget/fileselector_button/preview-01.eps
6610     * @image html img/widget/fileselector_button/preview-02.png
6611     * @image latex img/widget/fileselector_button/preview-02.eps
6612     *
6613     * This is a button that, when clicked, creates an Elementary
6614     * window (or inner window) <b> with a @ref Fileselector "file
6615     * selector widget" within</b>. When a file is chosen, the (inner)
6616     * window is closed and the button emits a signal having the
6617     * selected file as it's @c event_info.
6618     *
6619     * This widget encapsulates operations on its internal file
6620     * selector on its own API. There is less control over its file
6621     * selector than that one would have instatiating one directly.
6622     *
6623     * The following styles are available for this button:
6624     * @li @c "default"
6625     * @li @c "anchor"
6626     * @li @c "hoversel_vertical"
6627     * @li @c "hoversel_vertical_entry"
6628     *
6629     * Smart callbacks one can register to:
6630     * - @c "file,chosen" - the user has selected a path, whose string
6631     *   pointer comes as the @c event_info data (a stringshared
6632     *   string)
6633     *
6634     * Here is an example on its usage:
6635     * @li @ref fileselector_button_example
6636     *
6637     * @see @ref File_Selector_Entry for a similar widget.
6638     * @{
6639     */
6640
6641    /**
6642     * Add a new file selector button widget to the given parent
6643     * Elementary (container) object
6644     *
6645     * @param parent The parent object
6646     * @return a new file selector button widget handle or @c NULL, on
6647     * errors
6648     */
6649    EAPI Evas_Object *elm_fileselector_button_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6650
6651    /**
6652     * Set the label for a given file selector button widget
6653     *
6654     * @param obj The file selector button widget
6655     * @param label The text label to be displayed on @p obj
6656     *
6657     * @deprecated use elm_object_text_set() instead.
6658     */
6659    EINA_DEPRECATED EAPI void         elm_fileselector_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6660
6661    /**
6662     * Get the label set for a given file selector button widget
6663     *
6664     * @param obj The file selector button widget
6665     * @return The button label
6666     *
6667     * @deprecated use elm_object_text_set() instead.
6668     */
6669    EINA_DEPRECATED EAPI const char  *elm_fileselector_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6670
6671    /**
6672     * Set the icon on a given file selector button widget
6673     *
6674     * @param obj The file selector button widget
6675     * @param icon The icon object for the button
6676     *
6677     * Once the icon object is set, a previously set one will be
6678     * deleted. If you want to keep the latter, use the
6679     * elm_fileselector_button_icon_unset() function.
6680     *
6681     * @see elm_fileselector_button_icon_get()
6682     */
6683    EAPI void         elm_fileselector_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
6684
6685    /**
6686     * Get the icon set for a given file selector button widget
6687     *
6688     * @param obj The file selector button widget
6689     * @return The icon object currently set on @p obj or @c NULL, if
6690     * none is
6691     *
6692     * @see elm_fileselector_button_icon_set()
6693     */
6694    EAPI Evas_Object *elm_fileselector_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6695
6696    /**
6697     * Unset the icon used in a given file selector button widget
6698     *
6699     * @param obj The file selector button widget
6700     * @return The icon object that was being used on @p obj or @c
6701     * NULL, on errors
6702     *
6703     * Unparent and return the icon object which was set for this
6704     * widget.
6705     *
6706     * @see elm_fileselector_button_icon_set()
6707     */
6708    EAPI Evas_Object *elm_fileselector_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
6709
6710    /**
6711     * Set the title for a given file selector button widget's window
6712     *
6713     * @param obj The file selector button widget
6714     * @param title The title string
6715     *
6716     * This will change the window's title, when the file selector pops
6717     * out after a click on the button. Those windows have the default
6718     * (unlocalized) value of @c "Select a file" as titles.
6719     *
6720     * @note It will only take any effect if the file selector
6721     * button widget is @b not under "inwin mode".
6722     *
6723     * @see elm_fileselector_button_window_title_get()
6724     */
6725    EAPI void         elm_fileselector_button_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
6726
6727    /**
6728     * Get the title set for a given file selector button widget's
6729     * window
6730     *
6731     * @param obj The file selector button widget
6732     * @return Title of the file selector button's window
6733     *
6734     * @see elm_fileselector_button_window_title_get() for more details
6735     */
6736    EAPI const char  *elm_fileselector_button_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6737
6738    /**
6739     * Set the size of a given file selector button widget's window,
6740     * holding the file selector itself.
6741     *
6742     * @param obj The file selector button widget
6743     * @param width The window's width
6744     * @param height The window's height
6745     *
6746     * @note it will only take any effect if the file selector button
6747     * widget is @b not under "inwin mode". The default size for the
6748     * window (when applicable) is 400x400 pixels.
6749     *
6750     * @see elm_fileselector_button_window_size_get()
6751     */
6752    EAPI void         elm_fileselector_button_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
6753
6754    /**
6755     * Get the size of a given file selector button widget's window,
6756     * holding the file selector itself.
6757     *
6758     * @param obj The file selector button widget
6759     * @param width Pointer into which to store the width value
6760     * @param height Pointer into which to store the height value
6761     *
6762     * @note Use @c NULL pointers on the size values you're not
6763     * interested in: they'll be ignored by the function.
6764     *
6765     * @see elm_fileselector_button_window_size_set(), for more details
6766     */
6767    EAPI void         elm_fileselector_button_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
6768
6769    /**
6770     * Set the initial file system path for a given file selector
6771     * button widget
6772     *
6773     * @param obj The file selector button widget
6774     * @param path The path string
6775     *
6776     * It must be a <b>directory</b> path, which will have the contents
6777     * displayed initially in the file selector's view, when invoked
6778     * from @p obj. The default initial path is the @c "HOME"
6779     * environment variable's value.
6780     *
6781     * @see elm_fileselector_button_path_get()
6782     */
6783    EAPI void         elm_fileselector_button_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
6784
6785    /**
6786     * Get the initial file system path set for a given file selector
6787     * button widget
6788     *
6789     * @param obj The file selector button widget
6790     * @return path The path string
6791     *
6792     * @see elm_fileselector_button_path_set() for more details
6793     */
6794    EAPI const char  *elm_fileselector_button_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6795
6796    /**
6797     * Enable/disable a tree view in the given file selector button
6798     * widget's internal file selector
6799     *
6800     * @param obj The file selector button widget
6801     * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
6802     * disable
6803     *
6804     * This has the same effect as elm_fileselector_expandable_set(),
6805     * but now applied to a file selector button's internal file
6806     * selector.
6807     *
6808     * @note There's no way to put a file selector button's internal
6809     * file selector in "grid mode", as one may do with "pure" file
6810     * selectors.
6811     *
6812     * @see elm_fileselector_expandable_get()
6813     */
6814    EAPI void         elm_fileselector_button_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6815
6816    /**
6817     * Get whether tree view is enabled for the given file selector
6818     * button widget's internal file selector
6819     *
6820     * @param obj The file selector button widget
6821     * @return @c EINA_TRUE if @p obj widget's internal file selector
6822     * is in tree view, @c EINA_FALSE otherwise (and or errors)
6823     *
6824     * @see elm_fileselector_expandable_set() for more details
6825     */
6826    EAPI Eina_Bool    elm_fileselector_button_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6827
6828    /**
6829     * Set whether a given file selector button widget's internal file
6830     * selector is to display folders only or the directory contents,
6831     * as well.
6832     *
6833     * @param obj The file selector button widget
6834     * @param only @c EINA_TRUE to make @p obj widget's internal file
6835     * selector only display directories, @c EINA_FALSE to make files
6836     * to be displayed in it too
6837     *
6838     * This has the same effect as elm_fileselector_folder_only_set(),
6839     * but now applied to a file selector button's internal file
6840     * selector.
6841     *
6842     * @see elm_fileselector_folder_only_get()
6843     */
6844    EAPI void         elm_fileselector_button_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6845
6846    /**
6847     * Get whether a given file selector button widget's internal file
6848     * selector is displaying folders only or the directory contents,
6849     * as well.
6850     *
6851     * @param obj The file selector button widget
6852     * @return @c EINA_TRUE if @p obj widget's internal file
6853     * selector is only displaying directories, @c EINA_FALSE if files
6854     * are being displayed in it too (and on errors)
6855     *
6856     * @see elm_fileselector_button_folder_only_set() for more details
6857     */
6858    EAPI Eina_Bool    elm_fileselector_button_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6859
6860    /**
6861     * Enable/disable the file name entry box where the user can type
6862     * in a name for a file, in a given file selector button widget's
6863     * internal file selector.
6864     *
6865     * @param obj The file selector button widget
6866     * @param is_save @c EINA_TRUE to make @p obj widget's internal
6867     * file selector a "saving dialog", @c EINA_FALSE otherwise
6868     *
6869     * This has the same effect as elm_fileselector_is_save_set(),
6870     * but now applied to a file selector button's internal file
6871     * selector.
6872     *
6873     * @see elm_fileselector_is_save_get()
6874     */
6875    EAPI void         elm_fileselector_button_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6876
6877    /**
6878     * Get whether the given file selector button widget's internal
6879     * file selector is in "saving dialog" mode
6880     *
6881     * @param obj The file selector button widget
6882     * @return @c EINA_TRUE, if @p obj widget's internal file selector
6883     * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
6884     * errors)
6885     *
6886     * @see elm_fileselector_button_is_save_set() for more details
6887     */
6888    EAPI Eina_Bool    elm_fileselector_button_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6889
6890    /**
6891     * Set whether a given file selector button widget's internal file
6892     * selector will raise an Elementary "inner window", instead of a
6893     * dedicated Elementary window. By default, it won't.
6894     *
6895     * @param obj The file selector button widget
6896     * @param value @c EINA_TRUE to make it use an inner window, @c
6897     * EINA_TRUE to make it use a dedicated window
6898     *
6899     * @see elm_win_inwin_add() for more information on inner windows
6900     * @see elm_fileselector_button_inwin_mode_get()
6901     */
6902    EAPI void         elm_fileselector_button_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
6903
6904    /**
6905     * Get whether a given file selector button widget's internal file
6906     * selector will raise an Elementary "inner window", instead of a
6907     * dedicated Elementary window.
6908     *
6909     * @param obj The file selector button widget
6910     * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
6911     * if it will use a dedicated window
6912     *
6913     * @see elm_fileselector_button_inwin_mode_set() for more details
6914     */
6915    EAPI Eina_Bool    elm_fileselector_button_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
6916
6917    /**
6918     * @}
6919     */
6920
6921     /**
6922     * @defgroup File_Selector_Entry File Selector Entry
6923     *
6924     * @image html img/widget/fileselector_entry/preview-00.png
6925     * @image latex img/widget/fileselector_entry/preview-00.eps
6926     *
6927     * This is an entry made to be filled with or display a <b>file
6928     * system path string</b>. Besides the entry itself, the widget has
6929     * a @ref File_Selector_Button "file selector button" on its side,
6930     * which will raise an internal @ref Fileselector "file selector widget",
6931     * when clicked, for path selection aided by file system
6932     * navigation.
6933     *
6934     * This file selector may appear in an Elementary window or in an
6935     * inner window. When a file is chosen from it, the (inner) window
6936     * is closed and the selected file's path string is exposed both as
6937     * an smart event and as the new text on the entry.
6938     *
6939     * This widget encapsulates operations on its internal file
6940     * selector on its own API. There is less control over its file
6941     * selector than that one would have instatiating one directly.
6942     *
6943     * Smart callbacks one can register to:
6944     * - @c "changed" - The text within the entry was changed
6945     * - @c "activated" - The entry has had editing finished and
6946     *   changes are to be "committed"
6947     * - @c "press" - The entry has been clicked
6948     * - @c "longpressed" - The entry has been clicked (and held) for a
6949     *   couple seconds
6950     * - @c "clicked" - The entry has been clicked
6951     * - @c "clicked,double" - The entry has been double clicked
6952     * - @c "focused" - The entry has received focus
6953     * - @c "unfocused" - The entry has lost focus
6954     * - @c "selection,paste" - A paste action has occurred on the
6955     *   entry
6956     * - @c "selection,copy" - A copy action has occurred on the entry
6957     * - @c "selection,cut" - A cut action has occurred on the entry
6958     * - @c "unpressed" - The file selector entry's button was released
6959     *   after being pressed.
6960     * - @c "file,chosen" - The user has selected a path via the file
6961     *   selector entry's internal file selector, whose string pointer
6962     *   comes as the @c event_info data (a stringshared string)
6963     *
6964     * Here is an example on its usage:
6965     * @li @ref fileselector_entry_example
6966     *
6967     * @see @ref File_Selector_Button for a similar widget.
6968     * @{
6969     */
6970
6971    /**
6972     * Add a new file selector entry widget to the given parent
6973     * Elementary (container) object
6974     *
6975     * @param parent The parent object
6976     * @return a new file selector entry widget handle or @c NULL, on
6977     * errors
6978     */
6979    EAPI Evas_Object *elm_fileselector_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
6980
6981    /**
6982     * Set the label for a given file selector entry widget's button
6983     *
6984     * @param obj The file selector entry widget
6985     * @param label The text label to be displayed on @p obj widget's
6986     * button
6987     *
6988     * @deprecated use elm_object_text_set() instead.
6989     */
6990    EINA_DEPRECATED EAPI void         elm_fileselector_entry_button_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
6991
6992    /**
6993     * Get the label set for a given file selector entry widget's button
6994     *
6995     * @param obj The file selector entry widget
6996     * @return The widget button's label
6997     *
6998     * @deprecated use elm_object_text_set() instead.
6999     */
7000    EINA_DEPRECATED EAPI const char  *elm_fileselector_entry_button_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7001
7002    /**
7003     * Set the icon on a given file selector entry widget's button
7004     *
7005     * @param obj The file selector entry widget
7006     * @param icon The icon object for the entry's button
7007     *
7008     * Once the icon object is set, a previously set one will be
7009     * deleted. If you want to keep the latter, use the
7010     * elm_fileselector_entry_button_icon_unset() function.
7011     *
7012     * @see elm_fileselector_entry_button_icon_get()
7013     */
7014    EAPI void         elm_fileselector_entry_button_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
7015
7016    /**
7017     * Get the icon set for a given file selector entry widget's button
7018     *
7019     * @param obj The file selector entry widget
7020     * @return The icon object currently set on @p obj widget's button
7021     * or @c NULL, if none is
7022     *
7023     * @see elm_fileselector_entry_button_icon_set()
7024     */
7025    EAPI Evas_Object *elm_fileselector_entry_button_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7026
7027    /**
7028     * Unset the icon used in a given file selector entry widget's
7029     * button
7030     *
7031     * @param obj The file selector entry widget
7032     * @return The icon object that was being used on @p obj widget's
7033     * button or @c NULL, on errors
7034     *
7035     * Unparent and return the icon object which was set for this
7036     * widget's button.
7037     *
7038     * @see elm_fileselector_entry_button_icon_set()
7039     */
7040    EAPI Evas_Object *elm_fileselector_entry_button_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7041
7042    /**
7043     * Set the title for a given file selector entry widget's window
7044     *
7045     * @param obj The file selector entry widget
7046     * @param title The title string
7047     *
7048     * This will change the window's title, when the file selector pops
7049     * out after a click on the entry's button. Those windows have the
7050     * default (unlocalized) value of @c "Select a file" as titles.
7051     *
7052     * @note It will only take any effect if the file selector
7053     * entry widget is @b not under "inwin mode".
7054     *
7055     * @see elm_fileselector_entry_window_title_get()
7056     */
7057    EAPI void         elm_fileselector_entry_window_title_set(Evas_Object *obj, const char *title) EINA_ARG_NONNULL(1);
7058
7059    /**
7060     * Get the title set for a given file selector entry widget's
7061     * window
7062     *
7063     * @param obj The file selector entry widget
7064     * @return Title of the file selector entry's window
7065     *
7066     * @see elm_fileselector_entry_window_title_get() for more details
7067     */
7068    EAPI const char  *elm_fileselector_entry_window_title_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7069
7070    /**
7071     * Set the size of a given file selector entry widget's window,
7072     * holding the file selector itself.
7073     *
7074     * @param obj The file selector entry widget
7075     * @param width The window's width
7076     * @param height The window's height
7077     *
7078     * @note it will only take any effect if the file selector entry
7079     * widget is @b not under "inwin mode". The default size for the
7080     * window (when applicable) is 400x400 pixels.
7081     *
7082     * @see elm_fileselector_entry_window_size_get()
7083     */
7084    EAPI void         elm_fileselector_entry_window_size_set(Evas_Object *obj, Evas_Coord width, Evas_Coord height) EINA_ARG_NONNULL(1);
7085
7086    /**
7087     * Get the size of a given file selector entry widget's window,
7088     * holding the file selector itself.
7089     *
7090     * @param obj The file selector entry widget
7091     * @param width Pointer into which to store the width value
7092     * @param height Pointer into which to store the height value
7093     *
7094     * @note Use @c NULL pointers on the size values you're not
7095     * interested in: they'll be ignored by the function.
7096     *
7097     * @see elm_fileselector_entry_window_size_set(), for more details
7098     */
7099    EAPI void         elm_fileselector_entry_window_size_get(const Evas_Object *obj, Evas_Coord *width, Evas_Coord *height) EINA_ARG_NONNULL(1);
7100
7101    /**
7102     * Set the initial file system path and the entry's path string for
7103     * a given file selector entry widget
7104     *
7105     * @param obj The file selector entry widget
7106     * @param path The path string
7107     *
7108     * It must be a <b>directory</b> path, which will have the contents
7109     * displayed initially in the file selector's view, when invoked
7110     * from @p obj. The default initial path is the @c "HOME"
7111     * environment variable's value.
7112     *
7113     * @see elm_fileselector_entry_path_get()
7114     */
7115    EAPI void         elm_fileselector_entry_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
7116
7117    /**
7118     * Get the entry's path string for a given file selector entry
7119     * widget
7120     *
7121     * @param obj The file selector entry widget
7122     * @return path The path string
7123     *
7124     * @see elm_fileselector_entry_path_set() for more details
7125     */
7126    EAPI const char  *elm_fileselector_entry_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7127
7128    /**
7129     * Enable/disable a tree view in the given file selector entry
7130     * widget's internal file selector
7131     *
7132     * @param obj The file selector entry widget
7133     * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
7134     * disable
7135     *
7136     * This has the same effect as elm_fileselector_expandable_set(),
7137     * but now applied to a file selector entry's internal file
7138     * selector.
7139     *
7140     * @note There's no way to put a file selector entry's internal
7141     * file selector in "grid mode", as one may do with "pure" file
7142     * selectors.
7143     *
7144     * @see elm_fileselector_expandable_get()
7145     */
7146    EAPI void         elm_fileselector_entry_expandable_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
7147
7148    /**
7149     * Get whether tree view is enabled for the given file selector
7150     * entry widget's internal file selector
7151     *
7152     * @param obj The file selector entry widget
7153     * @return @c EINA_TRUE if @p obj widget's internal file selector
7154     * is in tree view, @c EINA_FALSE otherwise (and or errors)
7155     *
7156     * @see elm_fileselector_expandable_set() for more details
7157     */
7158    EAPI Eina_Bool    elm_fileselector_entry_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7159
7160    /**
7161     * Set whether a given file selector entry widget's internal file
7162     * selector is to display folders only or the directory contents,
7163     * as well.
7164     *
7165     * @param obj The file selector entry widget
7166     * @param only @c EINA_TRUE to make @p obj widget's internal file
7167     * selector only display directories, @c EINA_FALSE to make files
7168     * to be displayed in it too
7169     *
7170     * This has the same effect as elm_fileselector_folder_only_set(),
7171     * but now applied to a file selector entry's internal file
7172     * selector.
7173     *
7174     * @see elm_fileselector_folder_only_get()
7175     */
7176    EAPI void         elm_fileselector_entry_folder_only_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
7177
7178    /**
7179     * Get whether a given file selector entry widget's internal file
7180     * selector is displaying folders only or the directory contents,
7181     * as well.
7182     *
7183     * @param obj The file selector entry widget
7184     * @return @c EINA_TRUE if @p obj widget's internal file
7185     * selector is only displaying directories, @c EINA_FALSE if files
7186     * are being displayed in it too (and on errors)
7187     *
7188     * @see elm_fileselector_entry_folder_only_set() for more details
7189     */
7190    EAPI Eina_Bool    elm_fileselector_entry_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7191
7192    /**
7193     * Enable/disable the file name entry box where the user can type
7194     * in a name for a file, in a given file selector entry widget's
7195     * internal file selector.
7196     *
7197     * @param obj The file selector entry widget
7198     * @param is_save @c EINA_TRUE to make @p obj widget's internal
7199     * file selector a "saving dialog", @c EINA_FALSE otherwise
7200     *
7201     * This has the same effect as elm_fileselector_is_save_set(),
7202     * but now applied to a file selector entry's internal file
7203     * selector.
7204     *
7205     * @see elm_fileselector_is_save_get()
7206     */
7207    EAPI void         elm_fileselector_entry_is_save_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
7208
7209    /**
7210     * Get whether the given file selector entry widget's internal
7211     * file selector is in "saving dialog" mode
7212     *
7213     * @param obj The file selector entry widget
7214     * @return @c EINA_TRUE, if @p obj widget's internal file selector
7215     * is in "saving dialog" mode, @c EINA_FALSE otherwise (and on
7216     * errors)
7217     *
7218     * @see elm_fileselector_entry_is_save_set() for more details
7219     */
7220    EAPI Eina_Bool    elm_fileselector_entry_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7221
7222    /**
7223     * Set whether a given file selector entry widget's internal file
7224     * selector will raise an Elementary "inner window", instead of a
7225     * dedicated Elementary window. By default, it won't.
7226     *
7227     * @param obj The file selector entry widget
7228     * @param value @c EINA_TRUE to make it use an inner window, @c
7229     * EINA_TRUE to make it use a dedicated window
7230     *
7231     * @see elm_win_inwin_add() for more information on inner windows
7232     * @see elm_fileselector_entry_inwin_mode_get()
7233     */
7234    EAPI void         elm_fileselector_entry_inwin_mode_set(Evas_Object *obj, Eina_Bool value) EINA_ARG_NONNULL(1);
7235
7236    /**
7237     * Get whether a given file selector entry widget's internal file
7238     * selector will raise an Elementary "inner window", instead of a
7239     * dedicated Elementary window.
7240     *
7241     * @param obj The file selector entry widget
7242     * @return @c EINA_TRUE if will use an inner window, @c EINA_TRUE
7243     * if it will use a dedicated window
7244     *
7245     * @see elm_fileselector_entry_inwin_mode_set() for more details
7246     */
7247    EAPI Eina_Bool    elm_fileselector_entry_inwin_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7248
7249    /**
7250     * Set the initial file system path for a given file selector entry
7251     * widget
7252     *
7253     * @param obj The file selector entry widget
7254     * @param path The path string
7255     *
7256     * It must be a <b>directory</b> path, which will have the contents
7257     * displayed initially in the file selector's view, when invoked
7258     * from @p obj. The default initial path is the @c "HOME"
7259     * environment variable's value.
7260     *
7261     * @see elm_fileselector_entry_path_get()
7262     */
7263    EAPI void         elm_fileselector_entry_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
7264
7265    /**
7266     * Get the parent directory's path to the latest file selection on
7267     * a given filer selector entry widget
7268     *
7269     * @param obj The file selector object
7270     * @return The (full) path of the directory of the last selection
7271     * on @p obj widget, a @b stringshared string
7272     *
7273     * @see elm_fileselector_entry_path_set()
7274     */
7275    EAPI const char  *elm_fileselector_entry_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7276
7277    /**
7278     * @}
7279     */
7280
7281    /**
7282     * @defgroup Scroller Scroller
7283     *
7284     * A scroller holds a single object and "scrolls it around". This means that
7285     * it allows the user to use a scrollbar (or a finger) to drag the viewable
7286     * region around, allowing to move through a much larger object that is
7287     * contained in the scroller. The scroller will always have a small minimum
7288     * size by default as it won't be limited by the contents of the scroller.
7289     *
7290     * Signals that you can add callbacks for are:
7291     * @li "edge,left" - the left edge of the content has been reached
7292     * @li "edge,right" - the right edge of the content has been reached
7293     * @li "edge,top" - the top edge of the content has been reached
7294     * @li "edge,bottom" - the bottom edge of the content has been reached
7295     * @li "scroll" - the content has been scrolled (moved)
7296     * @li "scroll,anim,start" - scrolling animation has started
7297     * @li "scroll,anim,stop" - scrolling animation has stopped
7298     * @li "scroll,drag,start" - dragging the contents around has started
7299     * @li "scroll,drag,stop" - dragging the contents around has stopped
7300     * @note The "scroll,anim,*" and "scroll,drag,*" signals are only emitted by
7301     * user intervetion.
7302     *
7303     * @note When Elemementary is in embedded mode the scrollbars will not be
7304     * dragable, they appear merely as indicators of how much has been scrolled.
7305     * @note When Elementary is in desktop mode the thumbscroll(a.k.a.
7306     * fingerscroll) won't work.
7307     *
7308     * Default contents parts of the scroller widget that you can use for are:
7309     * @li "default" - A content of the scroller
7310     *
7311     * In @ref tutorial_scroller you'll find an example of how to use most of
7312     * this API.
7313     * @{
7314     */
7315    /**
7316     * @brief Type that controls when scrollbars should appear.
7317     *
7318     * @see elm_scroller_policy_set()
7319     */
7320    typedef enum _Elm_Scroller_Policy
7321      {
7322         ELM_SCROLLER_POLICY_AUTO = 0, /**< Show scrollbars as needed */
7323         ELM_SCROLLER_POLICY_ON, /**< Always show scrollbars */
7324         ELM_SCROLLER_POLICY_OFF, /**< Never show scrollbars */
7325         ELM_SCROLLER_POLICY_LAST
7326      } Elm_Scroller_Policy;
7327    /**
7328     * @brief Add a new scroller to the parent
7329     *
7330     * @param parent The parent object
7331     * @return The new object or NULL if it cannot be created
7332     */
7333    EAPI Evas_Object *elm_scroller_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7334    /**
7335     * @brief Set the content of the scroller widget (the object to be scrolled around).
7336     *
7337     * @param obj The scroller object
7338     * @param content The new content object
7339     *
7340     * Once the content object is set, a previously set one will be deleted.
7341     * If you want to keep that old content object, use the
7342     * elm_scroller_content_unset() function.
7343     * @deprecated use elm_object_content_set() instead
7344     */
7345    WILL_DEPRECATE  EAPI void elm_scroller_content_set(Evas_Object *obj, Evas_Object *child) EINA_ARG_NONNULL(1);
7346    /**
7347     * @brief Get the content of the scroller widget
7348     *
7349     * @param obj The slider object
7350     * @return The content that is being used
7351     *
7352     * Return the content object which is set for this widget
7353     *
7354     * @see elm_scroller_content_set()
7355     * @deprecated use elm_object_content_get() instead.
7356     */
7357    WILL_DEPRECATE  EAPI Evas_Object *elm_scroller_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7358    /**
7359     * @brief Unset the content of the scroller widget
7360     *
7361     * @param obj The slider object
7362     * @return The content that was being used
7363     *
7364     * Unparent and return the content object which was set for this widget
7365     *
7366     * @see elm_scroller_content_set()
7367     * @deprecated use elm_object_content_unset() instead.
7368     */
7369    WILL_DEPRECATE  EAPI Evas_Object *elm_scroller_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7370    /**
7371     * @brief Set custom theme elements for the scroller
7372     *
7373     * @param obj The scroller object
7374     * @param widget The widget name to use (default is "scroller")
7375     * @param base The base name to use (default is "base")
7376     */
7377    EAPI void         elm_scroller_custom_widget_base_theme_set(Evas_Object *obj, const char *widget, const char *base) EINA_ARG_NONNULL(1, 2, 3);
7378    /**
7379     * @brief Make the scroller minimum size limited to the minimum size of the content
7380     *
7381     * @param obj The scroller object
7382     * @param w Enable limiting minimum size horizontally
7383     * @param h Enable limiting minimum size vertically
7384     *
7385     * By default the scroller will be as small as its design allows,
7386     * irrespective of its content. This will make the scroller minimum size the
7387     * right size horizontally and/or vertically to perfectly fit its content in
7388     * that direction.
7389     */
7390    EAPI void         elm_scroller_content_min_limit(Evas_Object *obj, Eina_Bool w, Eina_Bool h) EINA_ARG_NONNULL(1);
7391    /**
7392     * @brief Show a specific virtual region within the scroller content object
7393     *
7394     * @param obj The scroller object
7395     * @param x X coordinate of the region
7396     * @param y Y coordinate of the region
7397     * @param w Width of the region
7398     * @param h Height of the region
7399     *
7400     * This will ensure all (or part if it does not fit) of the designated
7401     * region in the virtual content object (0, 0 starting at the top-left of the
7402     * virtual content object) is shown within the scroller.
7403     */
7404    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);
7405    /**
7406     * @brief Set the scrollbar visibility policy
7407     *
7408     * @param obj The scroller object
7409     * @param policy_h Horizontal scrollbar policy
7410     * @param policy_v Vertical scrollbar policy
7411     *
7412     * This sets the scrollbar visibility policy for the given scroller.
7413     * ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it is
7414     * needed, and otherwise kept hidden. ELM_SCROLLER_POLICY_ON turns it on all
7415     * the time, and ELM_SCROLLER_POLICY_OFF always keeps it off. This applies
7416     * respectively for the horizontal and vertical scrollbars.
7417     */
7418    EAPI void         elm_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
7419    /**
7420     * @brief Gets scrollbar visibility policy
7421     *
7422     * @param obj The scroller object
7423     * @param policy_h Horizontal scrollbar policy
7424     * @param policy_v Vertical scrollbar policy
7425     *
7426     * @see elm_scroller_policy_set()
7427     */
7428    EAPI void         elm_scroller_policy_get(const Evas_Object *obj, Elm_Scroller_Policy *policy_h, Elm_Scroller_Policy *policy_v) EINA_ARG_NONNULL(1);
7429    /**
7430     * @brief Get the currently visible content region
7431     *
7432     * @param obj The scroller object
7433     * @param x X coordinate of the region
7434     * @param y Y coordinate of the region
7435     * @param w Width of the region
7436     * @param h Height of the region
7437     *
7438     * This gets the current region in the content object that is visible through
7439     * the scroller. The region co-ordinates are returned in the @p x, @p y, @p
7440     * w, @p h values pointed to.
7441     *
7442     * @note All coordinates are relative to the content.
7443     *
7444     * @see elm_scroller_region_show()
7445     */
7446    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);
7447    /**
7448     * @brief Get the size of the content object
7449     *
7450     * @param obj The scroller object
7451     * @param w Width of the content object.
7452     * @param h Height of the content object.
7453     *
7454     * This gets the size of the content object of the scroller.
7455     */
7456    EAPI void         elm_scroller_child_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
7457    /**
7458     * @brief Set bouncing behavior
7459     *
7460     * @param obj The scroller object
7461     * @param h_bounce Allow bounce horizontally
7462     * @param v_bounce Allow bounce vertically
7463     *
7464     * When scrolling, the scroller may "bounce" when reaching an edge of the
7465     * content object. This is a visual way to indicate the end has been reached.
7466     * This is enabled by default for both axis. This API will set if it is enabled
7467     * for the given axis with the boolean parameters for each axis.
7468     */
7469    EAPI void         elm_scroller_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
7470    /**
7471     * @brief Get the bounce behaviour
7472     *
7473     * @param obj The Scroller object
7474     * @param h_bounce Will the scroller bounce horizontally or not
7475     * @param v_bounce Will the scroller bounce vertically or not
7476     *
7477     * @see elm_scroller_bounce_set()
7478     */
7479    EAPI void         elm_scroller_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
7480    /**
7481     * @brief Set scroll page size relative to viewport size.
7482     *
7483     * @param obj The scroller object
7484     * @param h_pagerel The horizontal page relative size
7485     * @param v_pagerel The vertical page relative size
7486     *
7487     * The scroller is capable of limiting scrolling by the user to "pages". That
7488     * is to jump by and only show a "whole page" at a time as if the continuous
7489     * area of the scroller content is split into page sized pieces. This sets
7490     * the size of a page relative to the viewport of the scroller. 1.0 is "1
7491     * viewport" is size (horizontally or vertically). 0.0 turns it off in that
7492     * axis. This is mutually exclusive with page size
7493     * (see elm_scroller_page_size_set()  for more information). Likewise 0.5
7494     * is "half a viewport". Sane usable values are normally between 0.0 and 1.0
7495     * including 1.0. If you only want 1 axis to be page "limited", use 0.0 for
7496     * the other axis.
7497     */
7498    EAPI void         elm_scroller_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
7499    /**
7500     * @brief Set scroll page size.
7501     *
7502     * @param obj The scroller object
7503     * @param h_pagesize The horizontal page size
7504     * @param v_pagesize The vertical page size
7505     *
7506     * This sets the page size to an absolute fixed value, with 0 turning it off
7507     * for that axis.
7508     *
7509     * @see elm_scroller_page_relative_set()
7510     */
7511    EAPI void         elm_scroller_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
7512    /**
7513     * @brief Get scroll current page number.
7514     *
7515     * @param obj The scroller object
7516     * @param h_pagenumber The horizontal page number
7517     * @param v_pagenumber The vertical page number
7518     *
7519     * The page number starts from 0. 0 is the first page.
7520     * Current page means the page which meets the top-left of the viewport.
7521     * If there are two or more pages in the viewport, it returns the number of the page
7522     * which meets the top-left of the viewport.
7523     *
7524     * @see elm_scroller_last_page_get()
7525     * @see elm_scroller_page_show()
7526     * @see elm_scroller_page_brint_in()
7527     */
7528    EAPI void         elm_scroller_current_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
7529    /**
7530     * @brief Get scroll last page number.
7531     *
7532     * @param obj The scroller object
7533     * @param h_pagenumber The horizontal page number
7534     * @param v_pagenumber The vertical page number
7535     *
7536     * The page number starts from 0. 0 is the first page.
7537     * This returns the last page number among the pages.
7538     *
7539     * @see elm_scroller_current_page_get()
7540     * @see elm_scroller_page_show()
7541     * @see elm_scroller_page_brint_in()
7542     */
7543    EAPI void         elm_scroller_last_page_get(const Evas_Object *obj, int *h_pagenumber, int *v_pagenumber) EINA_ARG_NONNULL(1);
7544    /**
7545     * Show a specific virtual region within the scroller content object by page number.
7546     *
7547     * @param obj The scroller object
7548     * @param h_pagenumber The horizontal page number
7549     * @param v_pagenumber The vertical page number
7550     *
7551     * 0, 0 of the indicated page is located at the top-left of the viewport.
7552     * This will jump to the page directly without animation.
7553     *
7554     * Example of usage:
7555     *
7556     * @code
7557     * sc = elm_scroller_add(win);
7558     * elm_scroller_content_set(sc, content);
7559     * elm_scroller_page_relative_set(sc, 1, 0);
7560     * elm_scroller_current_page_get(sc, &h_page, &v_page);
7561     * elm_scroller_page_show(sc, h_page + 1, v_page);
7562     * @endcode
7563     *
7564     * @see elm_scroller_page_bring_in()
7565     */
7566    EAPI void         elm_scroller_page_show(Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
7567    /**
7568     * Show a specific virtual region within the scroller content object by page number.
7569     *
7570     * @param obj The scroller object
7571     * @param h_pagenumber The horizontal page number
7572     * @param v_pagenumber The vertical page number
7573     *
7574     * 0, 0 of the indicated page is located at the top-left of the viewport.
7575     * This will slide to the page with animation.
7576     *
7577     * Example of usage:
7578     *
7579     * @code
7580     * sc = elm_scroller_add(win);
7581     * elm_scroller_content_set(sc, content);
7582     * elm_scroller_page_relative_set(sc, 1, 0);
7583     * elm_scroller_last_page_get(sc, &h_page, &v_page);
7584     * elm_scroller_page_bring_in(sc, h_page, v_page);
7585     * @endcode
7586     *
7587     * @see elm_scroller_page_show()
7588     */
7589    EAPI void         elm_scroller_page_bring_in(Evas_Object *obj, int h_pagenumber, int v_pagenumber) EINA_ARG_NONNULL(1);
7590    /**
7591     * @brief Show a specific virtual region within the scroller content object.
7592     *
7593     * @param obj The scroller object
7594     * @param x X coordinate of the region
7595     * @param y Y coordinate of the region
7596     * @param w Width of the region
7597     * @param h Height of the region
7598     *
7599     * This will ensure all (or part if it does not fit) of the designated
7600     * region in the virtual content object (0, 0 starting at the top-left of the
7601     * virtual content object) is shown within the scroller. Unlike
7602     * elm_scroller_region_show(), this allow the scroller to "smoothly slide"
7603     * to this location (if configuration in general calls for transitions). It
7604     * may not jump immediately to the new location and make take a while and
7605     * show other content along the way.
7606     *
7607     * @see elm_scroller_region_show()
7608     */
7609    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);
7610    /**
7611     * @brief Set event propagation on a scroller
7612     *
7613     * @param obj The scroller object
7614     * @param propagation If propagation is enabled or not
7615     *
7616     * This enables or disabled event propagation from the scroller content to
7617     * the scroller and its parent. By default event propagation is disabled.
7618     */
7619    EAPI void         elm_scroller_propagate_events_set(Evas_Object *obj, Eina_Bool propagation) EINA_ARG_NONNULL(1);
7620    /**
7621     * @brief Get event propagation for a scroller
7622     *
7623     * @param obj The scroller object
7624     * @return The propagation state
7625     *
7626     * This gets the event propagation for a scroller.
7627     *
7628     * @see elm_scroller_propagate_events_set()
7629     */
7630    EAPI Eina_Bool    elm_scroller_propagate_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7631    /**
7632     * @brief Set scrolling gravity on a scroller
7633     *
7634     * @param obj The scroller object
7635     * @param x The scrolling horizontal gravity
7636     * @param y The scrolling vertical gravity
7637     *
7638     * The gravity, defines how the scroller will adjust its view
7639     * when the size of the scroller contents increase.
7640     *
7641     * The scroller will adjust the view to glue itself as follows.
7642     *
7643     *  x=0.0, for showing the left most region of the content.
7644     *  x=1.0, for showing the right most region of the content.
7645     *  y=0.0, for showing the bottom most region of the content.
7646     *  y=1.0, for showing the top most region of the content.
7647     *
7648     * Default values for x and y are 0.0
7649     */
7650    EAPI void         elm_scroller_gravity_set(Evas_Object *obj, double x, double y) EINA_ARG_NONNULL(1);
7651    /**
7652     * @brief Get scrolling gravity values for a scroller
7653     *
7654     * @param obj The scroller object
7655     * @param x The scrolling horizontal gravity
7656     * @param y The scrolling vertical gravity
7657     *
7658     * This gets gravity values for a scroller.
7659     *
7660     * @see elm_scroller_gravity_set()
7661     *
7662     */
7663    EAPI void         elm_scroller_gravity_get(const Evas_Object *obj, double *x, double *y) EINA_ARG_NONNULL(1);
7664    /**
7665     * @}
7666     */
7667
7668    /**
7669     * @defgroup Label Label
7670     *
7671     * @image html img/widget/label/preview-00.png
7672     * @image latex img/widget/label/preview-00.eps
7673     *
7674     * @brief Widget to display text, with simple html-like markup.
7675     *
7676     * The Label widget @b doesn't allow text to overflow its boundaries, if the
7677     * text doesn't fit the geometry of the label it will be ellipsized or be
7678     * cut. Elementary provides several styles for this widget:
7679     * @li default - No animation
7680     * @li marker - Centers the text in the label and make it bold by default
7681     * @li slide_long - The entire text appears from the right of the screen and
7682     * slides until it disappears in the left of the screen(reappering on the
7683     * right again).
7684     * @li slide_short - The text appears in the left of the label and slides to
7685     * the right to show the overflow. When all of the text has been shown the
7686     * position is reset.
7687     * @li slide_bounce - The text appears in the left of the label and slides to
7688     * the right to show the overflow. When all of the text has been shown the
7689     * animation reverses, moving the text to the left.
7690     *
7691     * Custom themes can of course invent new markup tags and style them any way
7692     * they like.
7693     *
7694     * The following signals may be emitted by the label widget:
7695     * @li "language,changed": The program's language changed.
7696     *
7697     * See @ref tutorial_label for a demonstration of how to use a label widget.
7698     * @{
7699     */
7700    /**
7701     * @brief Add a new label to the parent
7702     *
7703     * @param parent The parent object
7704     * @return The new object or NULL if it cannot be created
7705     */
7706    EAPI Evas_Object *elm_label_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7707    /**
7708     * @brief Set the label on the label object
7709     *
7710     * @param obj The label object
7711     * @param label The label will be used on the label object
7712     * @deprecated See elm_object_text_set()
7713     */
7714    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 */
7715    /**
7716     * @brief Get the label used on the label object
7717     *
7718     * @param obj The label object
7719     * @return The string inside the label
7720     * @deprecated See elm_object_text_get()
7721     */
7722    EINA_DEPRECATED EAPI const char *elm_label_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1); /* deprecated, use elm_object_text_get instead */
7723    /**
7724     * @brief Set the wrapping behavior of the label
7725     *
7726     * @param obj The label object
7727     * @param wrap To wrap text or not
7728     *
7729     * By default no wrapping is done. Possible values for @p wrap are:
7730     * @li ELM_WRAP_NONE - No wrapping
7731     * @li ELM_WRAP_CHAR - wrap between characters
7732     * @li ELM_WRAP_WORD - wrap between words
7733     * @li ELM_WRAP_MIXED - Word wrap, and if that fails, char wrap
7734     */
7735    EAPI void         elm_label_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
7736    /**
7737     * @brief Get the wrapping behavior of the label
7738     *
7739     * @param obj The label object
7740     * @return Wrap type
7741     *
7742     * @see elm_label_line_wrap_set()
7743     */
7744    EAPI Elm_Wrap_Type elm_label_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7745    /**
7746     * @brief Set wrap width of the label
7747     *
7748     * @param obj The label object
7749     * @param w The wrap width in pixels at a minimum where words need to wrap
7750     *
7751     * This function sets the maximum width size hint of the label.
7752     *
7753     * @warning This is only relevant if the label is inside a container.
7754     */
7755    EAPI void         elm_label_wrap_width_set(Evas_Object *obj, Evas_Coord w) EINA_ARG_NONNULL(1);
7756    /**
7757     * @brief Get wrap width of the label
7758     *
7759     * @param obj The label object
7760     * @return The wrap width in pixels at a minimum where words need to wrap
7761     *
7762     * @see elm_label_wrap_width_set()
7763     */
7764    EAPI Evas_Coord   elm_label_wrap_width_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7765    /**
7766     * @brief Set wrap height of the label
7767     *
7768     * @param obj The label object
7769     * @param h The wrap height in pixels at a minimum where words need to wrap
7770     *
7771     * This function sets the maximum height size hint of the label.
7772     *
7773     * @warning This is only relevant if the label is inside a container.
7774     */
7775    EAPI void         elm_label_wrap_height_set(Evas_Object *obj, Evas_Coord h) EINA_ARG_NONNULL(1);
7776    /**
7777     * @brief get wrap width of the label
7778     *
7779     * @param obj The label object
7780     * @return The wrap height in pixels at a minimum where words need to wrap
7781     */
7782    EAPI Evas_Coord   elm_label_wrap_height_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7783    /**
7784     * @brief Set the font size on the label object.
7785     *
7786     * @param obj The label object
7787     * @param size font size
7788     *
7789     * @warning NEVER use this. It is for hyper-special cases only. use styles
7790     * instead. e.g. "default", "marker", "slide_long" etc.
7791     */
7792    EAPI void         elm_label_fontsize_set(Evas_Object *obj, int fontsize) EINA_ARG_NONNULL(1);
7793    /**
7794     * @brief Set the text color on the label object
7795     *
7796     * @param obj The label object
7797     * @param r Red property background color of The label object
7798     * @param g Green property background color of The label object
7799     * @param b Blue property background color of The label object
7800     * @param a Alpha property background color of The label object
7801     *
7802     * @warning NEVER use this. It is for hyper-special cases only. use styles
7803     * instead. e.g. "default", "marker", "slide_long" etc.
7804     */
7805    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);
7806    /**
7807     * @brief Set the text align on the label object
7808     *
7809     * @param obj The label object
7810     * @param align align mode ("left", "center", "right")
7811     *
7812     * @warning NEVER use this. It is for hyper-special cases only. use styles
7813     * instead. e.g. "default", "marker", "slide_long" etc.
7814     */
7815    EAPI void         elm_label_text_align_set(Evas_Object *obj, const char *alignmode) EINA_ARG_NONNULL(1);
7816    /**
7817     * @brief Set background color of the label
7818     *
7819     * @param obj The label object
7820     * @param r Red property background color of The label object
7821     * @param g Green property background color of The label object
7822     * @param b Blue property background color of The label object
7823     * @param a Alpha property background alpha of The label object
7824     *
7825     * @warning NEVER use this. It is for hyper-special cases only. use styles
7826     * instead. e.g. "default", "marker", "slide_long" etc.
7827     */
7828    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);
7829    /**
7830     * @brief Set the ellipsis behavior of the label
7831     *
7832     * @param obj The label object
7833     * @param ellipsis To ellipsis text or not
7834     *
7835     * If set to true and the text doesn't fit in the label an ellipsis("...")
7836     * will be shown at the end of the widget.
7837     *
7838     * @warning This doesn't work with slide(elm_label_slide_set()) or if the
7839     * choosen wrap method was ELM_WRAP_WORD.
7840     */
7841    EAPI void         elm_label_ellipsis_set(Evas_Object *obj, Eina_Bool ellipsis) EINA_ARG_NONNULL(1);
7842    EINA_DEPRECATED EAPI void elm_label_wrap_mode_set(Evas_Object *obj, Eina_Bool wrapmode) EINA_ARG_NONNULL(1);
7843    /**
7844     * @brief Set the text slide of the label
7845     *
7846     * @param obj The label object
7847     * @param slide To start slide or stop
7848     *
7849     * If set to true, the text of the label will slide/scroll through the length of
7850     * label.
7851     *
7852     * @warning This only works with the themes "slide_short", "slide_long" and
7853     * "slide_bounce".
7854     */
7855    EAPI void         elm_label_slide_set(Evas_Object *obj, Eina_Bool slide) EINA_ARG_NONNULL(1);
7856    /**
7857     * @brief Get the text slide mode of the label
7858     *
7859     * @param obj The label object
7860     * @return slide slide mode value
7861     *
7862     * @see elm_label_slide_set()
7863     */
7864    EAPI Eina_Bool    elm_label_slide_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7865    /**
7866     * @brief Set the slide duration(speed) of the label
7867     *
7868     * @param obj The label object
7869     * @return The duration in seconds in moving text from slide begin position
7870     * to slide end position
7871     */
7872    EAPI void         elm_label_slide_duration_set(Evas_Object *obj, double duration) EINA_ARG_NONNULL(1);
7873    /**
7874     * @brief Get the slide duration(speed) of the label
7875     *
7876     * @param obj The label object
7877     * @return The duration time in moving text from slide begin position to slide end position
7878     *
7879     * @see elm_label_slide_duration_set()
7880     */
7881    EAPI double       elm_label_slide_duration_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
7882    /**
7883     * @}
7884     */
7885
7886    /**
7887     * @defgroup Frame Frame
7888     *
7889     * @image html img/widget/frame/preview-00.png
7890     * @image latex img/widget/frame/preview-00.eps
7891     *
7892     * @brief Frame is a widget that holds some content and has a title.
7893     *
7894     * The default look is a frame with a title, but Frame supports multple
7895     * styles:
7896     * @li default
7897     * @li pad_small
7898     * @li pad_medium
7899     * @li pad_large
7900     * @li pad_huge
7901     * @li outdent_top
7902     * @li outdent_bottom
7903     *
7904     * Of all this styles only default shows the title. Frame emits no signals.
7905     *
7906     * Default contents parts of the frame widget that you can use for are:
7907     * @li "default" - A content of the frame
7908     *
7909     * Default text parts of the frame widget that you can use for are:
7910     * @li "elm.text" - Label of the frame
7911     *
7912     * For a detailed example see the @ref tutorial_frame.
7913     *
7914     * @{
7915     */
7916    /**
7917     * @brief Add a new frame to the parent
7918     *
7919     * @param parent The parent object
7920     * @return The new object or NULL if it cannot be created
7921     */
7922    EAPI Evas_Object *elm_frame_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
7923    /**
7924     * @brief Set the frame label
7925     *
7926     * @param obj The frame object
7927     * @param label The label of this frame object
7928     *
7929     * @deprecated use elm_object_text_set() instead.
7930     */
7931    EINA_DEPRECATED EAPI void         elm_frame_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
7932    /**
7933     * @brief Get the frame label
7934     *
7935     * @param obj The frame object
7936     *
7937     * @return The label of this frame objet or NULL if unable to get frame
7938     *
7939     * @deprecated use elm_object_text_get() instead.
7940     */
7941    EINA_DEPRECATED EAPI const char  *elm_frame_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7942    /**
7943     * @brief Set the content of the frame widget
7944     *
7945     * Once the content object is set, a previously set one will be deleted.
7946     * If you want to keep that old content object, use the
7947     * elm_frame_content_unset() function.
7948     *
7949     * @param obj The frame object
7950     * @param content The content will be filled in this frame object
7951     *
7952     * @deprecated use elm_object_content_set() instead.
7953     */
7954    WILL_DEPRECATE  EAPI void         elm_frame_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
7955    /**
7956     * @brief Get the content of the frame widget
7957     *
7958     * Return the content object which is set for this widget
7959     *
7960     * @param obj The frame object
7961     * @return The content that is being used
7962     *
7963     * @deprecated use elm_object_content_get() instead.
7964     */
7965    WILL_DEPRECATE  EAPI Evas_Object *elm_frame_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
7966    /**
7967     * @brief Unset the content of the frame widget
7968     *
7969     * Unparent and return the content object which was set for this widget
7970     *
7971     * @param obj The frame object
7972     * @return The content that was being used
7973     *
7974     * @deprecated use elm_object_content_unset() instead.
7975     */
7976    WILL_DEPRECATE  EAPI Evas_Object *elm_frame_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
7977    /**
7978     * @}
7979     */
7980
7981    /**
7982     * @defgroup Table Table
7983     *
7984     * A container widget to arrange other widgets in a table where items can
7985     * also span multiple columns or rows - even overlap (and then be raised or
7986     * lowered accordingly to adjust stacking if they do overlap).
7987     *
7988     * For a Table widget the row/column count is not fixed.
7989     * The table widget adjusts itself when subobjects are added to it dynamically.
7990     *
7991     * The followin are examples of how to use a table:
7992     * @li @ref tutorial_table_01
7993     * @li @ref tutorial_table_02
7994     *
7995     * @{
7996     */
7997    /**
7998     * @brief Add a new table to the parent
7999     *
8000     * @param parent The parent object
8001     * @return The new object or NULL if it cannot be created
8002     */
8003    EAPI Evas_Object *elm_table_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8004    /**
8005     * @brief Set the homogeneous layout in the table
8006     *
8007     * @param obj The layout object
8008     * @param homogeneous A boolean to set if the layout is homogeneous in the
8009     * table (EINA_TRUE = homogeneous,  EINA_FALSE = no homogeneous)
8010     */
8011    EAPI void         elm_table_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
8012    /**
8013     * @brief Get the current table homogeneous mode.
8014     *
8015     * @param obj The table object
8016     * @return A boolean to indicating if the layout is homogeneous in the table
8017     * (EINA_TRUE = homogeneous,  EINA_FALSE = no homogeneous)
8018     */
8019    EAPI Eina_Bool    elm_table_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8020    /**
8021     * @warning <b>Use elm_table_homogeneous_set() instead</b>
8022     */
8023    EINA_DEPRECATED EAPI void elm_table_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
8024    /**
8025     * @warning <b>Use elm_table_homogeneous_get() instead</b>
8026     */
8027    EINA_DEPRECATED EAPI Eina_Bool elm_table_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8028    /**
8029     * @brief Set padding between cells.
8030     *
8031     * @param obj The layout object.
8032     * @param horizontal set the horizontal padding.
8033     * @param vertical set the vertical padding.
8034     *
8035     * Default value is 0.
8036     */
8037    EAPI void         elm_table_padding_set(Evas_Object *obj, Evas_Coord horizontal, Evas_Coord vertical) EINA_ARG_NONNULL(1);
8038    /**
8039     * @brief Get padding between cells.
8040     *
8041     * @param obj The layout object.
8042     * @param horizontal set the horizontal padding.
8043     * @param vertical set the vertical padding.
8044     */
8045    EAPI void         elm_table_padding_get(const Evas_Object *obj, Evas_Coord *horizontal, Evas_Coord *vertical) EINA_ARG_NONNULL(1);
8046    /**
8047     * @brief Add a subobject on the table with the coordinates passed
8048     *
8049     * @param obj The table object
8050     * @param subobj The subobject to be added to the table
8051     * @param x Row number
8052     * @param y Column number
8053     * @param w rowspan
8054     * @param h colspan
8055     *
8056     * @note All positioning inside the table is relative to rows and columns, so
8057     * a value of 0 for x and y, means the top left cell of the table, and a
8058     * value of 1 for w and h means @p subobj only takes that 1 cell.
8059     */
8060    EAPI void         elm_table_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
8061    /**
8062     * @brief Remove child from table.
8063     *
8064     * @param obj The table object
8065     * @param subobj The subobject
8066     */
8067    EAPI void         elm_table_unpack(Evas_Object *obj, Evas_Object *subobj) EINA_ARG_NONNULL(1);
8068    /**
8069     * @brief Faster way to remove all child objects from a table object.
8070     *
8071     * @param obj The table object
8072     * @param clear If true, will delete children, else just remove from table.
8073     */
8074    EAPI void         elm_table_clear(Evas_Object *obj, Eina_Bool clear) EINA_ARG_NONNULL(1);
8075    /**
8076     * @brief Set the packing location of an existing child of the table
8077     *
8078     * @param subobj The subobject to be modified in the table
8079     * @param x Row number
8080     * @param y Column number
8081     * @param w rowspan
8082     * @param h colspan
8083     *
8084     * Modifies the position of an object already in the table.
8085     *
8086     * @note All positioning inside the table is relative to rows and columns, so
8087     * a value of 0 for x and y, means the top left cell of the table, and a
8088     * value of 1 for w and h means @p subobj only takes that 1 cell.
8089     */
8090    EAPI void         elm_table_pack_set(Evas_Object *subobj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
8091    /**
8092     * @brief Get the packing location of an existing child of the table
8093     *
8094     * @param subobj The subobject to be modified in the table
8095     * @param x Row number
8096     * @param y Column number
8097     * @param w rowspan
8098     * @param h colspan
8099     *
8100     * @see elm_table_pack_set()
8101     */
8102    EAPI void         elm_table_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
8103    /**
8104     * @}
8105     */
8106
8107    /**
8108     * @defgroup Gengrid Gengrid (Generic grid)
8109     *
8110     * This widget aims to position objects in a grid layout while
8111     * actually creating and rendering only the visible ones, using the
8112     * same idea as the @ref Genlist "genlist": the user defines a @b
8113     * class for each item, specifying functions that will be called at
8114     * object creation, deletion, etc. When those items are selected by
8115     * the user, a callback function is issued. Users may interact with
8116     * a gengrid via the mouse (by clicking on items to select them and
8117     * clicking on the grid's viewport and swiping to pan the whole
8118     * view) or via the keyboard, navigating through item with the
8119     * arrow keys.
8120     *
8121     * @section Gengrid_Layouts Gengrid layouts
8122     *
8123     * Gengrid may layout its items in one of two possible layouts:
8124     * - horizontal or
8125     * - vertical.
8126     *
8127     * When in "horizontal mode", items will be placed in @b columns,
8128     * from top to bottom and, when the space for a column is filled,
8129     * another one is started on the right, thus expanding the grid
8130     * horizontally, making for horizontal scrolling. When in "vertical
8131     * mode" , though, items will be placed in @b rows, from left to
8132     * right and, when the space for a row is filled, another one is
8133     * started below, thus expanding the grid vertically (and making
8134     * for vertical scrolling).
8135     *
8136     * @section Gengrid_Items Gengrid items
8137     *
8138     * An item in a gengrid can have 0 or more text labels (they can be
8139     * regular text or textblock Evas objects - that's up to the style
8140     * to determine), 0 or more icons (which are simply objects
8141     * swallowed into the gengrid item's theming Edje object) and 0 or
8142     * more <b>boolean states</b>, which have the behavior left to the
8143     * user to define. The Edje part names for each of these properties
8144     * will be looked up, in the theme file for the gengrid, under the
8145     * Edje (string) data items named @c "labels", @c "icons" and @c
8146     * "states", respectively. For each of those properties, if more
8147     * than one part is provided, they must have names listed separated
8148     * by spaces in the data fields. For the default gengrid item
8149     * theme, we have @b one label part (@c "elm.text"), @b two icon
8150     * parts (@c "elm.swalllow.icon" and @c "elm.swallow.end") and @b
8151     * no state parts.
8152     *
8153     * A gengrid item may be at one of several styles. Elementary
8154     * provides one by default - "default", but this can be extended by
8155     * system or application custom themes/overlays/extensions (see
8156     * @ref Theme "themes" for more details).
8157     *
8158     * @section Gengrid_Item_Class Gengrid item classes
8159     *
8160     * In order to have the ability to add and delete items on the fly,
8161     * gengrid implements a class (callback) system where the
8162     * application provides a structure with information about that
8163     * type of item (gengrid may contain multiple different items with
8164     * different classes, states and styles). Gengrid will call the
8165     * functions in this struct (methods) when an item is "realized"
8166     * (i.e., created dynamically, while the user is scrolling the
8167     * grid). All objects will simply be deleted when no longer needed
8168     * with evas_object_del(). The #Elm_GenGrid_Item_Class structure
8169     * contains the following members:
8170     * - @c item_style - This is a constant string and simply defines
8171     * the name of the item style. It @b must be specified and the
8172     * default should be @c "default".
8173     * - @c func.label_get - This function is called when an item
8174     * object is actually created. The @c data parameter will point to
8175     * the same data passed to elm_gengrid_item_append() and related
8176     * item creation functions. The @c obj parameter is the gengrid
8177     * object itself, while the @c part one is the name string of one
8178     * of the existing text parts in the Edje group implementing the
8179     * item's theme. This function @b must return a strdup'()ed string,
8180     * as the caller will free() it when done. See
8181     * #Elm_Gengrid_Item_Label_Get_Cb.
8182     * - @c func.content_get - This function is called when an item object
8183     * is actually created. The @c data parameter will point to the
8184     * same data passed to elm_gengrid_item_append() and related item
8185     * creation functions. The @c obj parameter is the gengrid object
8186     * itself, while the @c part one is the name string of one of the
8187     * existing (content) swallow parts in the Edje group implementing the
8188     * item's theme. It must return @c NULL, when no content is desired,
8189     * or a valid object handle, otherwise. The object will be deleted
8190     * by the gengrid on its deletion or when the item is "unrealized".
8191     * See #Elm_Gengrid_Item_Content_Get_Cb.
8192     * - @c func.state_get - This function is called when an item
8193     * object is actually created. The @c data parameter will point to
8194     * the same data passed to elm_gengrid_item_append() and related
8195     * item creation functions. The @c obj parameter is the gengrid
8196     * object itself, while the @c part one is the name string of one
8197     * of the state parts in the Edje group implementing the item's
8198     * theme. Return @c EINA_FALSE for false/off or @c EINA_TRUE for
8199     * true/on. Gengrids will emit a signal to its theming Edje object
8200     * with @c "elm,state,XXX,active" and @c "elm" as "emission" and
8201     * "source" arguments, respectively, when the state is true (the
8202     * default is false), where @c XXX is the name of the (state) part.
8203     * See #Elm_Gengrid_Item_State_Get_Cb.
8204     * - @c func.del - This is called when elm_gengrid_item_del() is
8205     * called on an item or elm_gengrid_clear() is called on the
8206     * gengrid. This is intended for use when gengrid items are
8207     * deleted, so any data attached to the item (e.g. its data
8208     * parameter on creation) can be deleted. See #Elm_Gengrid_Item_Del_Cb.
8209     *
8210     * @section Gengrid_Usage_Hints Usage hints
8211     *
8212     * If the user wants to have multiple items selected at the same
8213     * time, elm_gengrid_multi_select_set() will permit it. If the
8214     * gengrid is single-selection only (the default), then
8215     * elm_gengrid_select_item_get() will return the selected item or
8216     * @c NULL, if none is selected. If the gengrid is under
8217     * multi-selection, then elm_gengrid_selected_items_get() will
8218     * return a list (that is only valid as long as no items are
8219     * modified (added, deleted, selected or unselected) of child items
8220     * on a gengrid.
8221     *
8222     * If an item changes (internal (boolean) state, label or content 
8223     * changes), then use elm_gengrid_item_update() to have gengrid
8224     * update the item with the new state. A gengrid will re-"realize"
8225     * the item, thus calling the functions in the
8226     * #Elm_Gengrid_Item_Class set for that item.
8227     *
8228     * To programmatically (un)select an item, use
8229     * elm_gengrid_item_selected_set(). To get its selected state use
8230     * elm_gengrid_item_selected_get(). To make an item disabled
8231     * (unable to be selected and appear differently) use
8232     * elm_gengrid_item_disabled_set() to set this and
8233     * elm_gengrid_item_disabled_get() to get the disabled state.
8234     *
8235     * Grid cells will only have their selection smart callbacks called
8236     * when firstly getting selected. Any further clicks will do
8237     * nothing, unless you enable the "always select mode", with
8238     * elm_gengrid_always_select_mode_set(), thus making every click to
8239     * issue selection callbacks. elm_gengrid_no_select_mode_set() will
8240     * turn off the ability to select items entirely in the widget and
8241     * they will neither appear selected nor call the selection smart
8242     * callbacks.
8243     *
8244     * Remember that you can create new styles and add your own theme
8245     * augmentation per application with elm_theme_extension_add(). If
8246     * you absolutely must have a specific style that overrides any
8247     * theme the user or system sets up you can use
8248     * elm_theme_overlay_add() to add such a file.
8249     *
8250     * @section Gengrid_Smart_Events Gengrid smart events
8251     *
8252     * Smart events that you can add callbacks for are:
8253     * - @c "activated" - The user has double-clicked or pressed
8254     *   (enter|return|spacebar) on an item. The @c event_info parameter
8255     *   is the gengrid item that was activated.
8256     * - @c "clicked,double" - The user has double-clicked an item.
8257     *   The @c event_info parameter is the gengrid item that was double-clicked.
8258     * - @c "longpressed" - This is called when the item is pressed for a certain
8259     *   amount of time. By default it's 1 second.
8260     * - @c "selected" - The user has made an item selected. The
8261     *   @c event_info parameter is the gengrid item that was selected.
8262     * - @c "unselected" - The user has made an item unselected. The
8263     *   @c event_info parameter is the gengrid item that was unselected.
8264     * - @c "realized" - This is called when the item in the gengrid
8265     *   has its implementing Evas object instantiated, de facto. @c
8266     *   event_info is the gengrid item that was created. The object
8267     *   may be deleted at any time, so it is highly advised to the
8268     *   caller @b not to use the object pointer returned from
8269     *   elm_gengrid_item_object_get(), because it may point to freed
8270     *   objects.
8271     * - @c "unrealized" - This is called when the implementing Evas
8272     *   object for this item is deleted. @c event_info is the gengrid
8273     *   item that was deleted.
8274     * - @c "changed" - Called when an item is added, removed, resized
8275     *   or moved and when the gengrid is resized or gets "horizontal"
8276     *   property changes.
8277     * - @c "scroll,anim,start" - This is called when scrolling animation has
8278     *   started.
8279     * - @c "scroll,anim,stop" - This is called when scrolling animation has
8280     *   stopped.
8281     * - @c "drag,start,up" - Called when the item in the gengrid has
8282     *   been dragged (not scrolled) up.
8283     * - @c "drag,start,down" - Called when the item in the gengrid has
8284     *   been dragged (not scrolled) down.
8285     * - @c "drag,start,left" - Called when the item in the gengrid has
8286     *   been dragged (not scrolled) left.
8287     * - @c "drag,start,right" - Called when the item in the gengrid has
8288     *   been dragged (not scrolled) right.
8289     * - @c "drag,stop" - Called when the item in the gengrid has
8290     *   stopped being dragged.
8291     * - @c "drag" - Called when the item in the gengrid is being
8292     *   dragged.
8293     * - @c "scroll" - called when the content has been scrolled
8294     *   (moved).
8295     * - @c "scroll,drag,start" - called when dragging the content has
8296     *   started.
8297     * - @c "scroll,drag,stop" - called when dragging the content has
8298     *   stopped.
8299     * - @c "edge,top" - This is called when the gengrid is scrolled until
8300     *   the top edge.
8301     * - @c "edge,bottom" - This is called when the gengrid is scrolled
8302     *   until the bottom edge.
8303     * - @c "edge,left" - This is called when the gengrid is scrolled
8304     *   until the left edge.
8305     * - @c "edge,right" - This is called when the gengrid is scrolled
8306     *   until the right edge.
8307     *
8308     * List of gengrid examples:
8309     * @li @ref gengrid_example
8310     */
8311
8312    /**
8313     * @addtogroup Gengrid
8314     * @{
8315     */
8316
8317    typedef struct _Elm_Gengrid_Item_Class Elm_Gengrid_Item_Class; /**< Gengrid item class definition structs */
8318    typedef struct _Elm_Gengrid_Item Elm_Gengrid_Item; /**< Gengrid item handles */
8319    typedef struct _Elm_Gengrid_Item_Class_Func Elm_Gengrid_Item_Class_Func; /**< Class functions for gengrid item classes. */
8320    /**
8321     * Label fetching class function for Elm_Gen_Item_Class.
8322     * @param data The data passed in the item creation function
8323     * @param obj The base widget object
8324     * @param part The part name of the swallow
8325     * @return The allocated (NOT stringshared) string to set as the label
8326     */
8327    typedef char        *(*Elm_Gengrid_Item_Label_Get_Cb) (void *data, Evas_Object *obj, const char *part);
8328    /**
8329     * Content (swallowed object) fetching class function for Elm_Gen_Item_Class.
8330     * @param data The data passed in the item creation function
8331     * @param obj The base widget object
8332     * @param part The part name of the swallow
8333     * @return The content object to swallow
8334     */
8335    typedef Evas_Object *(*Elm_Gengrid_Item_Content_Get_Cb)  (void *data, Evas_Object *obj, const char *part);
8336    /**
8337     * State fetching class function for Elm_Gen_Item_Class.
8338     * @param data The data passed in the item creation function
8339     * @param obj The base widget object
8340     * @param part The part name of the swallow
8341     * @return The hell if I know
8342     */
8343    typedef Eina_Bool    (*Elm_Gengrid_Item_State_Get_Cb) (void *data, Evas_Object *obj, const char *part);
8344    /**
8345     * Deletion class function for Elm_Gen_Item_Class.
8346     * @param data The data passed in the item creation function
8347     * @param obj The base widget object
8348     */
8349    typedef void         (*Elm_Gengrid_Item_Del_Cb)      (void *data, Evas_Object *obj);
8350
8351    /* temporary compatibility code */
8352    typedef Elm_Gengrid_Item_Label_Get_Cb GridItemLabelGetFunc EINA_DEPRECATED;
8353    typedef Elm_Gengrid_Item_Content_Get_Cb GridItemIconGetFunc EINA_DEPRECATED;
8354    typedef Elm_Gengrid_Item_State_Get_Cb GridItemStateGetFunc EINA_DEPRECATED;
8355    typedef Elm_Gengrid_Item_Del_Cb GridItemDelFunc EINA_DEPRECATED;
8356
8357    /**
8358     * @struct _Elm_Gengrid_Item_Class
8359     *
8360     * Gengrid item class definition. See @ref Gengrid_Item_Class for
8361     * field details.
8362     */
8363    struct _Elm_Gengrid_Item_Class
8364      {
8365         const char             *item_style;
8366         struct _Elm_Gengrid_Item_Class_Func
8367           {
8368              Elm_Gengrid_Item_Label_Get_Cb label_get;
8369              union { /* temporary compatibility code */
8370                Elm_Gengrid_Item_Content_Get_Cb icon_get EINA_DEPRECATED;
8371                Elm_Gengrid_Item_Content_Get_Cb content_get;
8372              };
8373              Elm_Gengrid_Item_State_Get_Cb state_get;
8374              Elm_Gengrid_Item_Del_Cb       del;
8375           } func;
8376      }; /**< #Elm_Gengrid_Item_Class member definitions */
8377    /**
8378     * Add a new gengrid widget to the given parent Elementary
8379     * (container) object
8380     *
8381     * @param parent The parent object
8382     * @return a new gengrid widget handle or @c NULL, on errors
8383     *
8384     * This function inserts a new gengrid widget on the canvas.
8385     *
8386     * @see elm_gengrid_item_size_set()
8387     * @see elm_gengrid_group_item_size_set()
8388     * @see elm_gengrid_horizontal_set()
8389     * @see elm_gengrid_item_append()
8390     * @see elm_gengrid_item_del()
8391     * @see elm_gengrid_clear()
8392     *
8393     * @ingroup Gengrid
8394     */
8395    EAPI Evas_Object       *elm_gengrid_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
8396
8397    /**
8398     * Set the size for the items of a given gengrid widget
8399     *
8400     * @param obj The gengrid object.
8401     * @param w The items' width.
8402     * @param h The items' height;
8403     *
8404     * A gengrid, after creation, has still no information on the size
8405     * to give to each of its cells. So, you most probably will end up
8406     * with squares one @ref Fingers "finger" wide, the default
8407     * size. Use this function to force a custom size for you items,
8408     * making them as big as you wish.
8409     *
8410     * @see elm_gengrid_item_size_get()
8411     *
8412     * @ingroup Gengrid
8413     */
8414    EAPI void               elm_gengrid_item_size_set(Evas_Object *obj, Evas_Coord w, Evas_Coord h) EINA_ARG_NONNULL(1);
8415
8416    /**
8417     * Get the size set for the items of a given gengrid widget
8418     *
8419     * @param obj The gengrid object.
8420     * @param w Pointer to a variable where to store the items' width.
8421     * @param h Pointer to a variable where to store the items' height.
8422     *
8423     * @note Use @c NULL pointers on the size values you're not
8424     * interested in: they'll be ignored by the function.
8425     *
8426     * @see elm_gengrid_item_size_get() for more details
8427     *
8428     * @ingroup Gengrid
8429     */
8430    EAPI void               elm_gengrid_item_size_get(const Evas_Object *obj, Evas_Coord *w, Evas_Coord *h) EINA_ARG_NONNULL(1);
8431
8432    /**
8433     * Set the items grid's alignment within a given gengrid widget
8434     *
8435     * @param obj The gengrid object.
8436     * @param align_x Alignment in the horizontal axis (0 <= align_x <= 1).
8437     * @param align_y Alignment in the vertical axis (0 <= align_y <= 1).
8438     *
8439     * This sets the alignment of the whole grid of items of a gengrid
8440     * within its given viewport. By default, those values are both
8441     * 0.5, meaning that the gengrid will have its items grid placed
8442     * exactly in the middle of its viewport.
8443     *
8444     * @note If given alignment values are out of the cited ranges,
8445     * they'll be changed to the nearest boundary values on the valid
8446     * ranges.
8447     *
8448     * @see elm_gengrid_align_get()
8449     *
8450     * @ingroup Gengrid
8451     */
8452    EAPI void               elm_gengrid_align_set(Evas_Object *obj, double align_x, double align_y) EINA_ARG_NONNULL(1);
8453
8454    /**
8455     * Get the items grid's alignment values within a given gengrid
8456     * widget
8457     *
8458     * @param obj The gengrid object.
8459     * @param align_x Pointer to a variable where to store the
8460     * horizontal alignment.
8461     * @param align_y Pointer to a variable where to store the vertical
8462     * alignment.
8463     *
8464     * @note Use @c NULL pointers on the alignment values you're not
8465     * interested in: they'll be ignored by the function.
8466     *
8467     * @see elm_gengrid_align_set() for more details
8468     *
8469     * @ingroup Gengrid
8470     */
8471    EAPI void               elm_gengrid_align_get(const Evas_Object *obj, double *align_x, double *align_y) EINA_ARG_NONNULL(1);
8472
8473    /**
8474     * Set whether a given gengrid widget is or not able have items
8475     * @b reordered
8476     *
8477     * @param obj The gengrid object
8478     * @param reorder_mode Use @c EINA_TRUE to turn reoderding on,
8479     * @c EINA_FALSE to turn it off
8480     *
8481     * If a gengrid is set to allow reordering, a click held for more
8482     * than 0.5 over a given item will highlight it specially,
8483     * signalling the gengrid has entered the reordering state. From
8484     * that time on, the user will be able to, while still holding the
8485     * mouse button down, move the item freely in the gengrid's
8486     * viewport, replacing to said item to the locations it goes to.
8487     * The replacements will be animated and, whenever the user
8488     * releases the mouse button, the item being replaced gets a new
8489     * definitive place in the grid.
8490     *
8491     * @see elm_gengrid_reorder_mode_get()
8492     *
8493     * @ingroup Gengrid
8494     */
8495    EAPI void               elm_gengrid_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
8496
8497    /**
8498     * Get whether a given gengrid widget is or not able have items
8499     * @b reordered
8500     *
8501     * @param obj The gengrid object
8502     * @return @c EINA_TRUE, if reoderding is on, @c EINA_FALSE if it's
8503     * off
8504     *
8505     * @see elm_gengrid_reorder_mode_set() for more details
8506     *
8507     * @ingroup Gengrid
8508     */
8509    EAPI Eina_Bool          elm_gengrid_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8510
8511    /**
8512     * Append a new item in a given gengrid widget.
8513     *
8514     * @param obj The gengrid object.
8515     * @param gic The item class for the item.
8516     * @param data The item data.
8517     * @param func Convenience function called when the item is
8518     * selected.
8519     * @param func_data Data to be passed to @p func.
8520     * @return A handle to the item added or @c NULL, on errors.
8521     *
8522     * This adds an item to the beginning of the gengrid.
8523     *
8524     * @see elm_gengrid_item_prepend()
8525     * @see elm_gengrid_item_insert_before()
8526     * @see elm_gengrid_item_insert_after()
8527     * @see elm_gengrid_item_del()
8528     *
8529     * @ingroup Gengrid
8530     */
8531    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);
8532
8533    /**
8534     * Prepend a new item in a given gengrid widget.
8535     *
8536     * @param obj The gengrid object.
8537     * @param gic The item class for the item.
8538     * @param data The item data.
8539     * @param func Convenience function called when the item is
8540     * selected.
8541     * @param func_data Data to be passed to @p func.
8542     * @return A handle to the item added or @c NULL, on errors.
8543     *
8544     * This adds an item to the end of the gengrid.
8545     *
8546     * @see elm_gengrid_item_append()
8547     * @see elm_gengrid_item_insert_before()
8548     * @see elm_gengrid_item_insert_after()
8549     * @see elm_gengrid_item_del()
8550     *
8551     * @ingroup Gengrid
8552     */
8553    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);
8554
8555    /**
8556     * Insert an item before another in a gengrid widget
8557     *
8558     * @param obj The gengrid object.
8559     * @param gic The item class for the item.
8560     * @param data The item data.
8561     * @param relative The item to place this new one before.
8562     * @param func Convenience function called when the item is
8563     * selected.
8564     * @param func_data Data to be passed to @p func.
8565     * @return A handle to the item added or @c NULL, on errors.
8566     *
8567     * This inserts an item before another in the gengrid.
8568     *
8569     * @see elm_gengrid_item_append()
8570     * @see elm_gengrid_item_prepend()
8571     * @see elm_gengrid_item_insert_after()
8572     * @see elm_gengrid_item_del()
8573     *
8574     * @ingroup Gengrid
8575     */
8576    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);
8577
8578    /**
8579     * Insert an item after another in a gengrid widget
8580     *
8581     * @param obj The gengrid object.
8582     * @param gic The item class for the item.
8583     * @param data The item data.
8584     * @param relative The item to place this new one after.
8585     * @param func Convenience function called when the item is
8586     * selected.
8587     * @param func_data Data to be passed to @p func.
8588     * @return A handle to the item added or @c NULL, on errors.
8589     *
8590     * This inserts an item after another in the gengrid.
8591     *
8592     * @see elm_gengrid_item_append()
8593     * @see elm_gengrid_item_prepend()
8594     * @see elm_gengrid_item_insert_after()
8595     * @see elm_gengrid_item_del()
8596     *
8597     * @ingroup Gengrid
8598     */
8599    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);
8600
8601    /**
8602     * Insert an item in a gengrid widget using a user-defined sort function.
8603     *
8604     * @param obj The gengrid object.
8605     * @param gic The item class for the item.
8606     * @param data The item data.
8607     * @param comp User defined comparison function that defines the sort order based on
8608     * Elm_Gen_Item and its data param.
8609     * @param func Convenience function called when the item is selected.
8610     * @param func_data Data to be passed to @p func.
8611     * @return A handle to the item added or @c NULL, on errors.
8612     *
8613     * This inserts an item in the gengrid based on user defined comparison function.
8614     *
8615     * @see elm_gengrid_item_append()
8616     * @see elm_gengrid_item_prepend()
8617     * @see elm_gengrid_item_insert_after()
8618     * @see elm_gengrid_item_del()
8619     * @see elm_gengrid_item_direct_sorted_insert()
8620     *
8621     * @ingroup Gengrid
8622     */
8623    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);
8624
8625    /**
8626     * Insert an item in a gengrid widget using a user-defined sort function.
8627     *
8628     * @param obj The gengrid object.
8629     * @param gic The item class for the item.
8630     * @param data The item data.
8631     * @param comp User defined comparison function that defines the sort order based on
8632     * Elm_Gen_Item.
8633     * @param func Convenience function called when the item is selected.
8634     * @param func_data Data to be passed to @p func.
8635     * @return A handle to the item added or @c NULL, on errors.
8636     *
8637     * This inserts an item in the gengrid based on user defined comparison function.
8638     *
8639     * @see elm_gengrid_item_append()
8640     * @see elm_gengrid_item_prepend()
8641     * @see elm_gengrid_item_insert_after()
8642     * @see elm_gengrid_item_del()
8643     * @see elm_gengrid_item_sorted_insert()
8644     *
8645     * @ingroup Gengrid
8646     */
8647    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);
8648
8649    /**
8650     * Set whether items on a given gengrid widget are to get their
8651     * selection callbacks issued for @b every subsequent selection
8652     * click on them or just for the first click.
8653     *
8654     * @param obj The gengrid object
8655     * @param always_select @c EINA_TRUE to make items "always
8656     * selected", @c EINA_FALSE, otherwise
8657     *
8658     * By default, grid items will only call their selection callback
8659     * function when firstly getting selected, any subsequent further
8660     * clicks will do nothing. With this call, you make those
8661     * subsequent clicks also to issue the selection callbacks.
8662     *
8663     * @note <b>Double clicks</b> will @b always be reported on items.
8664     *
8665     * @see elm_gengrid_always_select_mode_get()
8666     *
8667     * @ingroup Gengrid
8668     */
8669    WILL_DEPRECATE  EAPI void               elm_gengrid_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
8670
8671    /**
8672     * Get whether items on a given gengrid widget have their selection
8673     * callbacks issued for @b every subsequent selection click on them
8674     * or just for the first click.
8675     *
8676     * @param obj The gengrid object.
8677     * @return @c EINA_TRUE if the gengrid items are "always selected",
8678     * @c EINA_FALSE, otherwise
8679     *
8680     * @see elm_gengrid_always_select_mode_set() for more details
8681     *
8682     * @ingroup Gengrid
8683     */
8684    WILL_DEPRECATE  EAPI Eina_Bool          elm_gengrid_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8685
8686    /**
8687     * Set whether items on a given gengrid widget can be selected or not.
8688     *
8689     * @param obj The gengrid object
8690     * @param no_select @c EINA_TRUE to make items selectable,
8691     * @c EINA_FALSE otherwise
8692     *
8693     * This will make items in @p obj selectable or not. In the latter
8694     * case, any user interaction on the gengrid items will neither make
8695     * them appear selected nor them call their selection callback
8696     * functions.
8697     *
8698     * @see elm_gengrid_no_select_mode_get()
8699     *
8700     * @ingroup Gengrid
8701     */
8702    WILL_DEPRECATE  EAPI void               elm_gengrid_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
8703
8704    /**
8705     * Get whether items on a given gengrid widget can be selected or
8706     * not.
8707     *
8708     * @param obj The gengrid object
8709     * @return @c EINA_TRUE, if items are selectable, @c EINA_FALSE
8710     * otherwise
8711     *
8712     * @see elm_gengrid_no_select_mode_set() for more details
8713     *
8714     * @ingroup Gengrid
8715     */
8716    WILL_DEPRECATE  EAPI Eina_Bool          elm_gengrid_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8717
8718    /**
8719     * Enable or disable multi-selection in a given gengrid widget
8720     *
8721     * @param obj The gengrid object.
8722     * @param multi @c EINA_TRUE, to enable multi-selection,
8723     * @c EINA_FALSE to disable it.
8724     *
8725     * Multi-selection is the ability to have @b more than one
8726     * item selected, on a given gengrid, simultaneously. When it is
8727     * enabled, a sequence of clicks on different items will make them
8728     * all selected, progressively. A click on an already selected item
8729     * will unselect it. If interacting via the keyboard,
8730     * multi-selection is enabled while holding the "Shift" key.
8731     *
8732     * @note By default, multi-selection is @b disabled on gengrids
8733     *
8734     * @see elm_gengrid_multi_select_get()
8735     *
8736     * @ingroup Gengrid
8737     */
8738    EAPI void               elm_gengrid_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
8739
8740    /**
8741     * Get whether multi-selection is enabled or disabled for a given
8742     * gengrid widget
8743     *
8744     * @param obj The gengrid object.
8745     * @return @c EINA_TRUE, if multi-selection is enabled, @c
8746     * EINA_FALSE otherwise
8747     *
8748     * @see elm_gengrid_multi_select_set() for more details
8749     *
8750     * @ingroup Gengrid
8751     */
8752    EAPI Eina_Bool          elm_gengrid_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8753
8754    /**
8755     * Enable or disable bouncing effect for a given gengrid widget
8756     *
8757     * @param obj The gengrid object
8758     * @param h_bounce @c EINA_TRUE, to enable @b horizontal bouncing,
8759     * @c EINA_FALSE to disable it
8760     * @param v_bounce @c EINA_TRUE, to enable @b vertical bouncing,
8761     * @c EINA_FALSE to disable it
8762     *
8763     * The bouncing effect occurs whenever one reaches the gengrid's
8764     * edge's while panning it -- it will scroll past its limits a
8765     * little bit and return to the edge again, in a animated for,
8766     * automatically.
8767     *
8768     * @note By default, gengrids have bouncing enabled on both axis
8769     *
8770     * @see elm_gengrid_bounce_get()
8771     *
8772     * @ingroup Gengrid
8773     */
8774    WILL_DEPRECATE  EAPI void               elm_gengrid_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
8775
8776    /**
8777     * Get whether bouncing effects are enabled or disabled, for a
8778     * given gengrid widget, on each axis
8779     *
8780     * @param obj The gengrid object
8781     * @param h_bounce Pointer to a variable where to store the
8782     * horizontal bouncing flag.
8783     * @param v_bounce Pointer to a variable where to store the
8784     * vertical bouncing flag.
8785     *
8786     * @see elm_gengrid_bounce_set() for more details
8787     *
8788     * @ingroup Gengrid
8789     */
8790    WILL_DEPRECATE  EAPI void               elm_gengrid_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
8791
8792    /**
8793     * Set a given gengrid widget's scrolling page size, relative to
8794     * its viewport size.
8795     *
8796     * @param obj The gengrid object
8797     * @param h_pagerel The horizontal page (relative) size
8798     * @param v_pagerel The vertical page (relative) size
8799     *
8800     * The gengrid's scroller is capable of binding scrolling by the
8801     * user to "pages". It means that, while scrolling and, specially
8802     * after releasing the mouse button, the grid will @b snap to the
8803     * nearest displaying page's area. When page sizes are set, the
8804     * grid's continuous content area is split into (equal) page sized
8805     * pieces.
8806     *
8807     * This function sets the size of a page <b>relatively to the
8808     * viewport dimensions</b> of the gengrid, for each axis. A value
8809     * @c 1.0 means "the exact viewport's size", in that axis, while @c
8810     * 0.0 turns paging off in that axis. Likewise, @c 0.5 means "half
8811     * a viewport". Sane usable values are, than, between @c 0.0 and @c
8812     * 1.0. Values beyond those will make it behave behave
8813     * inconsistently. If you only want one axis to snap to pages, use
8814     * the value @c 0.0 for the other one.
8815     *
8816     * There is a function setting page size values in @b absolute
8817     * values, too -- elm_gengrid_page_size_set(). Naturally, its use
8818     * is mutually exclusive to this one.
8819     *
8820     * @see elm_gengrid_page_relative_get()
8821     *
8822     * @ingroup Gengrid
8823     */
8824    WILL_DEPRECATE  EAPI void               elm_gengrid_page_relative_set(Evas_Object *obj, double h_pagerel, double v_pagerel) EINA_ARG_NONNULL(1);
8825
8826    /**
8827     * Get a given gengrid widget's scrolling page size, relative to
8828     * its viewport size.
8829     *
8830     * @param obj The gengrid object
8831     * @param h_pagerel Pointer to a variable where to store the
8832     * horizontal page (relative) size
8833     * @param v_pagerel Pointer to a variable where to store the
8834     * vertical page (relative) size
8835     *
8836     * @see elm_gengrid_page_relative_set() for more details
8837     *
8838     * @ingroup Gengrid
8839     */
8840    WILL_DEPRECATE  EAPI void               elm_gengrid_page_relative_get(const Evas_Object *obj, double *h_pagerel, double *v_pagerel) EINA_ARG_NONNULL(1);
8841
8842    /**
8843     * Set a given gengrid widget's scrolling page size
8844     *
8845     * @param obj The gengrid object
8846     * @param h_pagerel The horizontal page size, in pixels
8847     * @param v_pagerel The vertical page size, in pixels
8848     *
8849     * The gengrid's scroller is capable of binding scrolling by the
8850     * user to "pages". It means that, while scrolling and, specially
8851     * after releasing the mouse button, the grid will @b snap to the
8852     * nearest displaying page's area. When page sizes are set, the
8853     * grid's continuous content area is split into (equal) page sized
8854     * pieces.
8855     *
8856     * This function sets the size of a page of the gengrid, in pixels,
8857     * for each axis. Sane usable values are, between @c 0 and the
8858     * dimensions of @p obj, for each axis. Values beyond those will
8859     * make it behave behave inconsistently. If you only want one axis
8860     * to snap to pages, use the value @c 0 for the other one.
8861     *
8862     * There is a function setting page size values in @b relative
8863     * values, too -- elm_gengrid_page_relative_set(). Naturally, its
8864     * use is mutually exclusive to this one.
8865     *
8866     * @ingroup Gengrid
8867     */
8868    EAPI void               elm_gengrid_page_size_set(Evas_Object *obj, Evas_Coord h_pagesize, Evas_Coord v_pagesize) EINA_ARG_NONNULL(1);
8869
8870    /**
8871     * Set the direction in which a given gengrid widget will expand while
8872     * placing its items.
8873     *
8874     * @param obj The gengrid object.
8875     * @param setting @c EINA_TRUE to make the gengrid expand
8876     * horizontally, @c EINA_FALSE to expand vertically.
8877     *
8878     * When in "horizontal mode" (@c EINA_TRUE), items will be placed
8879     * in @b columns, from top to bottom and, when the space for a
8880     * column is filled, another one is started on the right, thus
8881     * expanding the grid horizontally. When in "vertical mode"
8882     * (@c EINA_FALSE), though, items will be placed in @b rows, from left
8883     * to right and, when the space for a row is filled, another one is
8884     * started below, thus expanding the grid vertically.
8885     *
8886     * @see elm_gengrid_horizontal_get()
8887     *
8888     * @ingroup Gengrid
8889     */
8890    EAPI void               elm_gengrid_horizontal_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
8891
8892    /**
8893     * Get for what direction a given gengrid widget will expand while
8894     * placing its items.
8895     *
8896     * @param obj The gengrid object.
8897     * @return @c EINA_TRUE, if @p obj is set to expand horizontally,
8898     * @c EINA_FALSE if it's set to expand vertically.
8899     *
8900     * @see elm_gengrid_horizontal_set() for more detais
8901     *
8902     * @ingroup Gengrid
8903     */
8904    EAPI Eina_Bool          elm_gengrid_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8905
8906    /**
8907     * Get the first item in a given gengrid widget
8908     *
8909     * @param obj The gengrid object
8910     * @return The first item's handle or @c NULL, if there are no
8911     * items in @p obj (and on errors)
8912     *
8913     * This returns the first item in the @p obj's internal list of
8914     * items.
8915     *
8916     * @see elm_gengrid_last_item_get()
8917     *
8918     * @ingroup Gengrid
8919     */
8920    WILL_DEPRECATE EAPI Elm_Gengrid_Item  *elm_gengrid_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8921
8922    /**
8923     * Get the last item in a given gengrid widget
8924     *
8925     * @param obj The gengrid object
8926     * @return The last item's handle or @c NULL, if there are no
8927     * items in @p obj (and on errors)
8928     *
8929     * This returns the last item in the @p obj's internal list of
8930     * items.
8931     *
8932     * @see elm_gengrid_first_item_get()
8933     *
8934     * @ingroup Gengrid
8935     */
8936    WILL_DEPRECATE EAPI Elm_Gengrid_Item  *elm_gengrid_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
8937
8938    /**
8939     * Get the @b next item in a gengrid widget's internal list of items,
8940     * given a handle to one of those items.
8941     *
8942     * @param item The gengrid item to fetch next from
8943     * @return The item after @p item, or @c NULL if there's none (and
8944     * on errors)
8945     *
8946     * This returns the item placed after the @p item, on the container
8947     * gengrid.
8948     *
8949     * @see elm_gengrid_item_prev_get()
8950     *
8951     * @ingroup Gengrid
8952     */
8953    WILL_DEPRECATE EAPI Elm_Gengrid_Item  *elm_gengrid_item_next_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8954
8955    /**
8956     * Get the @b previous item in a gengrid widget's internal list of items,
8957     * given a handle to one of those items.
8958     *
8959     * @param item The gengrid item to fetch previous from
8960     * @return The item before @p item, or @c NULL if there's none (and
8961     * on errors)
8962     *
8963     * This returns the item placed before the @p item, on the container
8964     * gengrid.
8965     *
8966     * @see elm_gengrid_item_next_get()
8967     *
8968     * @ingroup Gengrid
8969     */
8970    WILL_DEPRECATE EAPI Elm_Gengrid_Item  *elm_gengrid_item_prev_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8971
8972    /**
8973     * Get the gengrid object's handle which contains a given gengrid
8974     * item
8975     *
8976     * @param item The item to fetch the container from
8977     * @return The gengrid (parent) object
8978     *
8979     * This returns the gengrid object itself that an item belongs to.
8980     *
8981     * @ingroup Gengrid
8982     */
8983    WILL_DEPRECATE EAPI Evas_Object       *elm_gengrid_item_gengrid_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8984
8985    /**
8986     * Remove a gengrid item from its parent, deleting it.
8987     *
8988     * @param item The item to be removed.
8989     * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
8990     *
8991     * @see elm_gengrid_clear(), to remove all items in a gengrid at
8992     * once.
8993     *
8994     * @ingroup Gengrid
8995     */
8996    EAPI void               elm_gengrid_item_del(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
8997
8998    /**
8999     * Update the contents of a given gengrid item
9000     *
9001     * @param item The gengrid item
9002     *
9003     * This updates an item by calling all the item class functions
9004     * again to get the contents, labels and states. Use this when the
9005     * original item data has changed and you want the changes to be
9006     * reflected.
9007     *
9008     * @ingroup Gengrid
9009     */
9010    EAPI void               elm_gengrid_item_update(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9011
9012    /**
9013     * Get the Gengrid Item class for the given Gengrid Item.
9014     *
9015     * @param item The gengrid item
9016     *
9017     * This returns the Gengrid_Item_Class for the given item. It can be used to examine
9018     * the function pointers and item_style.
9019     *
9020     * @ingroup Gengrid
9021     */
9022    EAPI const Elm_Gengrid_Item_Class *elm_gengrid_item_item_class_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9023
9024    /**
9025     * Get the Gengrid Item class for the given Gengrid Item.
9026     *
9027     * This sets the Gengrid_Item_Class for the given item. It can be used to examine
9028     * the function pointers and item_style.
9029     *
9030     * @param item The gengrid item
9031     * @param gic The gengrid item class describing the function pointers and the item style.
9032     *
9033     * @ingroup Gengrid
9034     */
9035    EAPI void               elm_gengrid_item_item_class_set(Elm_Gengrid_Item *item, const Elm_Gengrid_Item_Class *gic) EINA_ARG_NONNULL(1, 2);
9036
9037    /**
9038     * Return the data associated to a given gengrid item
9039     *
9040     * @param item The gengrid item.
9041     * @return the data associated with this item.
9042     *
9043     * This returns the @c data value passed on the
9044     * elm_gengrid_item_append() and related item addition calls.
9045     *
9046     * @see elm_gengrid_item_append()
9047     * @see elm_gengrid_item_data_set()
9048     *
9049     * @ingroup Gengrid
9050     */
9051    EAPI void              *elm_gengrid_item_data_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9052
9053    /**
9054     * Set the data associated with a given gengrid item
9055     *
9056     * @param item The gengrid item
9057     * @param data The data pointer to set on it
9058     *
9059     * This @b overrides the @c data value passed on the
9060     * elm_gengrid_item_append() and related item addition calls. This
9061     * function @b won't call elm_gengrid_item_update() automatically,
9062     * so you'd issue it afterwards if you want to have the item
9063     * updated to reflect the new data.
9064     *
9065     * @see elm_gengrid_item_data_get()
9066     * @see elm_gengrid_item_update()
9067     *
9068     * @ingroup Gengrid
9069     */
9070    EAPI void               elm_gengrid_item_data_set(Elm_Gengrid_Item *item, const void *data) EINA_ARG_NONNULL(1);
9071
9072    /**
9073     * Get a given gengrid item's position, relative to the whole
9074     * gengrid's grid area.
9075     *
9076     * @param item The Gengrid item.
9077     * @param x Pointer to variable to store the item's <b>row number</b>.
9078     * @param y Pointer to variable to store the item's <b>column number</b>.
9079     *
9080     * This returns the "logical" position of the item within the
9081     * gengrid. For example, @c (0, 1) would stand for first row,
9082     * second column.
9083     *
9084     * @ingroup Gengrid
9085     */
9086    EAPI void               elm_gengrid_item_pos_get(const Elm_Gengrid_Item *item, unsigned int *x, unsigned int *y) EINA_ARG_NONNULL(1);
9087
9088    /**
9089     * Set whether a given gengrid item is selected or not
9090     *
9091     * @param item The gengrid item
9092     * @param selected Use @c EINA_TRUE, to make it selected, @c
9093     * EINA_FALSE to make it unselected
9094     *
9095     * This sets the selected state of an item. If multi-selection is
9096     * not enabled on the containing gengrid and @p selected is @c
9097     * EINA_TRUE, any other previously selected items will get
9098     * unselected in favor of this new one.
9099     *
9100     * @see elm_gengrid_item_selected_get()
9101     *
9102     * @ingroup Gengrid
9103     */
9104    WILL_DEPRECATE EAPI void elm_gengrid_item_selected_set(Elm_Gengrid_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
9105
9106    /**
9107     * Get whether a given gengrid item is selected or not
9108     *
9109     * @param item The gengrid item
9110     * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
9111     *
9112     * This API returns EINA_TRUE for all the items selected in multi-select mode as well.
9113     *
9114     * @see elm_gengrid_item_selected_set() for more details
9115     *
9116     * @ingroup Gengrid
9117     */
9118    WILL_DEPRECATE EAPI Eina_Bool elm_gengrid_item_selected_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9119
9120    /**
9121     * Get the real Evas object created to implement the view of a
9122     * given gengrid item
9123     *
9124     * @param item The gengrid item.
9125     * @return the Evas object implementing this item's view.
9126     *
9127     * This returns the actual Evas object used to implement the
9128     * specified gengrid item's view. This may be @c NULL, as it may
9129     * not have been created or may have been deleted, at any time, by
9130     * the gengrid. <b>Do not modify this object</b> (move, resize,
9131     * show, hide, etc.), as the gengrid is controlling it. This
9132     * function is for querying, emitting custom signals or hooking
9133     * lower level callbacks for events on that object. Do not delete
9134     * this object under any circumstances.
9135     *
9136     * @see elm_gengrid_item_data_get()
9137     *
9138     * @ingroup Gengrid
9139     */
9140    EAPI const Evas_Object *elm_gengrid_item_object_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9141
9142    /**
9143     * Show the portion of a gengrid's internal grid containing a given
9144     * item, @b immediately.
9145     *
9146     * @param item The item to display
9147     *
9148     * This causes gengrid to @b redraw its viewport's contents to the
9149     * region contining the given @p item item, if it is not fully
9150     * visible.
9151     *
9152     * @see elm_gengrid_item_bring_in()
9153     *
9154     * @ingroup Gengrid
9155     */
9156    EAPI void               elm_gengrid_item_show(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9157
9158    /**
9159     * Animatedly bring in, to the visible area of a gengrid, a given
9160     * item on it.
9161     *
9162     * @param item The gengrid item to display
9163     *
9164     * This causes gengrid to jump to the given @p item and show
9165     * it (by scrolling), if it is not fully visible. This will use
9166     * animation to do so and take a period of time to complete.
9167     *
9168     * @see elm_gengrid_item_show()
9169     *
9170     * @ingroup Gengrid
9171     */
9172    EAPI void               elm_gengrid_item_bring_in(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9173
9174    /**
9175     * Set whether a given gengrid item is disabled or not.
9176     *
9177     * @param item The gengrid item
9178     * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
9179     * to enable it back.
9180     *
9181     * A disabled item cannot be selected or unselected. It will also
9182     * change its appearance, to signal the user it's disabled.
9183     *
9184     * @see elm_gengrid_item_disabled_get()
9185     *
9186     * @ingroup Gengrid
9187     */
9188    EAPI void               elm_gengrid_item_disabled_set(Elm_Gengrid_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
9189
9190    /**
9191     * Get whether a given gengrid item is disabled or not.
9192     *
9193     * @param item The gengrid item
9194     * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
9195     * (and on errors).
9196     *
9197     * @see elm_gengrid_item_disabled_set() for more details
9198     *
9199     * @ingroup Gengrid
9200     */
9201    EAPI Eina_Bool          elm_gengrid_item_disabled_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9202
9203    /**
9204     * Set the text to be shown in a given gengrid item's tooltips.
9205     *
9206     * @param item The gengrid item
9207     * @param text The text to set in the content
9208     *
9209     * This call will setup the text to be used as tooltip to that item
9210     * (analogous to elm_object_tooltip_text_set(), but being item
9211     * tooltips with higher precedence than object tooltips). It can
9212     * have only one tooltip at a time, so any previous tooltip data
9213     * will get removed.
9214     *
9215     * @ingroup Gengrid
9216     */
9217    EAPI void               elm_gengrid_item_tooltip_text_set(Elm_Gengrid_Item *item, const char *text) EINA_ARG_NONNULL(1);
9218
9219    /**
9220     * Set the content to be shown in a given gengrid item's tooltip
9221     *
9222     * @param item The gengrid item.
9223     * @param func The function returning the tooltip contents.
9224     * @param data What to provide to @a func as callback data/context.
9225     * @param del_cb Called when data is not needed anymore, either when
9226     *        another callback replaces @p func, the tooltip is unset with
9227     *        elm_gengrid_item_tooltip_unset() or the owner @p item
9228     *        dies. This callback receives as its first parameter the
9229     *        given @p data, being @c event_info the item handle.
9230     *
9231     * This call will setup the tooltip's contents to @p item
9232     * (analogous to elm_object_tooltip_content_cb_set(), but being
9233     * item tooltips with higher precedence than object tooltips). It
9234     * can have only one tooltip at a time, so any previous tooltip
9235     * content will get removed. @p func (with @p data) will be called
9236     * every time Elementary needs to show the tooltip and it should
9237     * return a valid Evas object, which will be fully managed by the
9238     * tooltip system, getting deleted when the tooltip is gone.
9239     *
9240     * @ingroup Gengrid
9241     */
9242    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);
9243
9244    /**
9245     * Unset a tooltip from a given gengrid item
9246     *
9247     * @param item gengrid item to remove a previously set tooltip from.
9248     *
9249     * This call removes any tooltip set on @p item. The callback
9250     * provided as @c del_cb to
9251     * elm_gengrid_item_tooltip_content_cb_set() will be called to
9252     * notify it is not used anymore (and have resources cleaned, if
9253     * need be).
9254     *
9255     * @see elm_gengrid_item_tooltip_content_cb_set()
9256     *
9257     * @ingroup Gengrid
9258     */
9259    EAPI void               elm_gengrid_item_tooltip_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9260
9261    /**
9262     * Set a different @b style for a given gengrid item's tooltip.
9263     *
9264     * @param item gengrid item with tooltip set
9265     * @param style the <b>theme style</b> to use on tooltips (e.g. @c
9266     * "default", @c "transparent", etc)
9267     *
9268     * Tooltips can have <b>alternate styles</b> to be displayed on,
9269     * which are defined by the theme set on Elementary. This function
9270     * works analogously as elm_object_tooltip_style_set(), but here
9271     * applied only to gengrid item objects. The default style for
9272     * tooltips is @c "default".
9273     *
9274     * @note before you set a style you should define a tooltip with
9275     *       elm_gengrid_item_tooltip_content_cb_set() or
9276     *       elm_gengrid_item_tooltip_text_set()
9277     *
9278     * @see elm_gengrid_item_tooltip_style_get()
9279     *
9280     * @ingroup Gengrid
9281     */
9282    EAPI void               elm_gengrid_item_tooltip_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
9283
9284    /**
9285     * Get the style set a given gengrid item's tooltip.
9286     *
9287     * @param item gengrid item with tooltip already set on.
9288     * @return style the theme style in use, which defaults to
9289     *         "default". If the object does not have a tooltip set,
9290     *         then @c NULL is returned.
9291     *
9292     * @see elm_gengrid_item_tooltip_style_set() for more details
9293     *
9294     * @ingroup Gengrid
9295     */
9296    EAPI const char        *elm_gengrid_item_tooltip_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9297    /**
9298     * @brief Disable size restrictions on an object's tooltip
9299     * @param item The tooltip's anchor object
9300     * @param disable If EINA_TRUE, size restrictions are disabled
9301     * @return EINA_FALSE on failure, EINA_TRUE on success
9302     *
9303     * This function allows a tooltip to expand beyond its parant window's canvas.
9304     * It will instead be limited only by the size of the display.
9305     */
9306    EAPI Eina_Bool          elm_gengrid_item_tooltip_size_restrict_disable(Elm_Gengrid_Item *item, Eina_Bool disable);
9307    /**
9308     * @brief Retrieve size restriction state of an object's tooltip
9309     * @param item The tooltip's anchor object
9310     * @return If EINA_TRUE, size restrictions are disabled
9311     *
9312     * This function returns whether a tooltip is allowed to expand beyond
9313     * its parant window's canvas.
9314     * It will instead be limited only by the size of the display.
9315     */
9316    EAPI Eina_Bool          elm_gengrid_item_tooltip_size_restrict_disabled_get(const Elm_Gengrid_Item *item);
9317    /**
9318     * Set the type of mouse pointer/cursor decoration to be shown,
9319     * when the mouse pointer is over the given gengrid widget item
9320     *
9321     * @param item gengrid item to customize cursor on
9322     * @param cursor the cursor type's name
9323     *
9324     * This function works analogously as elm_object_cursor_set(), but
9325     * here the cursor's changing area is restricted to the item's
9326     * area, and not the whole widget's. Note that that item cursors
9327     * have precedence over widget cursors, so that a mouse over @p
9328     * item will always show cursor @p type.
9329     *
9330     * If this function is called twice for an object, a previously set
9331     * cursor will be unset on the second call.
9332     *
9333     * @see elm_object_cursor_set()
9334     * @see elm_gengrid_item_cursor_get()
9335     * @see elm_gengrid_item_cursor_unset()
9336     *
9337     * @ingroup Gengrid
9338     */
9339    EAPI void               elm_gengrid_item_cursor_set(Elm_Gengrid_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
9340
9341    /**
9342     * Get the type of mouse pointer/cursor decoration set to be shown,
9343     * when the mouse pointer is over the given gengrid widget item
9344     *
9345     * @param item gengrid item with custom cursor set
9346     * @return the cursor type's name or @c NULL, if no custom cursors
9347     * were set to @p item (and on errors)
9348     *
9349     * @see elm_object_cursor_get()
9350     * @see elm_gengrid_item_cursor_set() for more details
9351     * @see elm_gengrid_item_cursor_unset()
9352     *
9353     * @ingroup Gengrid
9354     */
9355    EAPI const char        *elm_gengrid_item_cursor_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9356
9357    /**
9358     * Unset any custom mouse pointer/cursor decoration set to be
9359     * shown, when the mouse pointer is over the given gengrid widget
9360     * item, thus making it show the @b default cursor again.
9361     *
9362     * @param item a gengrid item
9363     *
9364     * Use this call to undo any custom settings on this item's cursor
9365     * decoration, bringing it back to defaults (no custom style set).
9366     *
9367     * @see elm_object_cursor_unset()
9368     * @see elm_gengrid_item_cursor_set() for more details
9369     *
9370     * @ingroup Gengrid
9371     */
9372    EAPI void               elm_gengrid_item_cursor_unset(Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9373
9374    /**
9375     * Set a different @b style for a given custom cursor set for a
9376     * gengrid item.
9377     *
9378     * @param item gengrid item with custom cursor set
9379     * @param style the <b>theme style</b> to use (e.g. @c "default",
9380     * @c "transparent", etc)
9381     *
9382     * This function only makes sense when one is using custom mouse
9383     * cursor decorations <b>defined in a theme file</b> , which can
9384     * have, given a cursor name/type, <b>alternate styles</b> on
9385     * it. It works analogously as elm_object_cursor_style_set(), but
9386     * here applied only to gengrid item objects.
9387     *
9388     * @warning Before you set a cursor style you should have defined a
9389     *       custom cursor previously on the item, with
9390     *       elm_gengrid_item_cursor_set()
9391     *
9392     * @see elm_gengrid_item_cursor_engine_only_set()
9393     * @see elm_gengrid_item_cursor_style_get()
9394     *
9395     * @ingroup Gengrid
9396     */
9397    EAPI void               elm_gengrid_item_cursor_style_set(Elm_Gengrid_Item *item, const char *style) EINA_ARG_NONNULL(1);
9398
9399    /**
9400     * Get the current @b style set for a given gengrid item's custom
9401     * cursor
9402     *
9403     * @param item gengrid item with custom cursor set.
9404     * @return style the cursor style in use. If the object does not
9405     *         have a cursor set, then @c NULL is returned.
9406     *
9407     * @see elm_gengrid_item_cursor_style_set() for more details
9408     *
9409     * @ingroup Gengrid
9410     */
9411    EAPI const char        *elm_gengrid_item_cursor_style_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9412
9413    /**
9414     * Set if the (custom) cursor for a given gengrid item should be
9415     * searched in its theme, also, or should only rely on the
9416     * rendering engine.
9417     *
9418     * @param item item with custom (custom) cursor already set on
9419     * @param engine_only Use @c EINA_TRUE to have cursors looked for
9420     * only on those provided by the rendering engine, @c EINA_FALSE to
9421     * have them searched on the widget's theme, as well.
9422     *
9423     * @note This call is of use only if you've set a custom cursor
9424     * for gengrid items, with elm_gengrid_item_cursor_set().
9425     *
9426     * @note By default, cursors will only be looked for between those
9427     * provided by the rendering engine.
9428     *
9429     * @ingroup Gengrid
9430     */
9431    EAPI void               elm_gengrid_item_cursor_engine_only_set(Elm_Gengrid_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
9432
9433    /**
9434     * Get if the (custom) cursor for a given gengrid item is being
9435     * searched in its theme, also, or is only relying on the rendering
9436     * engine.
9437     *
9438     * @param item a gengrid item
9439     * @return @c EINA_TRUE, if cursors are being looked for only on
9440     * those provided by the rendering engine, @c EINA_FALSE if they
9441     * are being searched on the widget's theme, as well.
9442     *
9443     * @see elm_gengrid_item_cursor_engine_only_set(), for more details
9444     *
9445     * @ingroup Gengrid
9446     */
9447    EAPI Eina_Bool          elm_gengrid_item_cursor_engine_only_get(const Elm_Gengrid_Item *item) EINA_ARG_NONNULL(1);
9448
9449    /**
9450     * Remove all items from a given gengrid widget
9451     *
9452     * @param obj The gengrid object.
9453     *
9454     * This removes (and deletes) all items in @p obj, leaving it
9455     * empty.
9456     *
9457     * @see elm_gengrid_item_del(), to remove just one item.
9458     *
9459     * @ingroup Gengrid
9460     */
9461    WILL_DEPRECATE EAPI void elm_gengrid_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
9462
9463    /**
9464     * Get the selected item in a given gengrid widget
9465     *
9466     * @param obj The gengrid object.
9467     * @return The selected item's handleor @c NULL, if none is
9468     * selected at the moment (and on errors)
9469     *
9470     * This returns the selected item in @p obj. If multi selection is
9471     * enabled on @p obj (@see elm_gengrid_multi_select_set()), only
9472     * the first item in the list is selected, which might not be very
9473     * useful. For that case, see elm_gengrid_selected_items_get().
9474     *
9475     * @ingroup Gengrid
9476     */
9477    EAPI Elm_Gengrid_Item  *elm_gengrid_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9478
9479    /**
9480     * Get <b>a list</b> of selected items in a given gengrid
9481     *
9482     * @param obj The gengrid object.
9483     * @return The list of selected items or @c NULL, if none is
9484     * selected at the moment (and on errors)
9485     *
9486     * This returns a list of the selected items, in the order that
9487     * they appear in the grid. This list is only valid as long as no
9488     * more items are selected or unselected (or unselected implictly
9489     * by deletion). The list contains #Elm_Gengrid_Item pointers as
9490     * data, naturally.
9491     *
9492     * @see elm_gengrid_selected_item_get()
9493     *
9494     * @ingroup Gengrid
9495     */
9496    EAPI const Eina_List   *elm_gengrid_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9497
9498    /**
9499     * @}
9500     */
9501
9502    /**
9503     * @defgroup Clock Clock
9504     *
9505     * @image html img/widget/clock/preview-00.png
9506     * @image latex img/widget/clock/preview-00.eps
9507     *
9508     * This is a @b digital clock widget. In its default theme, it has a
9509     * vintage "flipping numbers clock" appearance, which will animate
9510     * sheets of individual algarisms individually as time goes by.
9511     *
9512     * A newly created clock will fetch system's time (already
9513     * considering local time adjustments) to start with, and will tick
9514     * accondingly. It may or may not show seconds.
9515     *
9516     * Clocks have an @b edition mode. When in it, the sheets will
9517     * display extra arrow indications on the top and bottom and the
9518     * user may click on them to raise or lower the time values. After
9519     * it's told to exit edition mode, it will keep ticking with that
9520     * new time set (it keeps the difference from local time).
9521     *
9522     * Also, when under edition mode, user clicks on the cited arrows
9523     * which are @b held for some time will make the clock to flip the
9524     * sheet, thus editing the time, continuosly and automatically for
9525     * the user. The interval between sheet flips will keep growing in
9526     * time, so that it helps the user to reach a time which is distant
9527     * from the one set.
9528     *
9529     * The time display is, by default, in military mode (24h), but an
9530     * am/pm indicator may be optionally shown, too, when it will
9531     * switch to 12h.
9532     *
9533     * Smart callbacks one can register to:
9534     * - "changed" - the clock's user changed the time
9535     *
9536     * Here is an example on its usage:
9537     * @li @ref clock_example
9538     */
9539
9540    /**
9541     * @addtogroup Clock
9542     * @{
9543     */
9544
9545    /**
9546     * Identifiers for which clock digits should be editable, when a
9547     * clock widget is in edition mode. Values may be ORed together to
9548     * make a mask, naturally.
9549     *
9550     * @see elm_clock_edit_set()
9551     * @see elm_clock_digit_edit_set()
9552     */
9553    typedef enum _Elm_Clock_Digedit
9554      {
9555         ELM_CLOCK_NONE         = 0, /**< Default value. Means that all digits are editable, when in edition mode. */
9556         ELM_CLOCK_HOUR_DECIMAL = 1 << 0, /**< Decimal algarism of hours value should be editable */
9557         ELM_CLOCK_HOUR_UNIT    = 1 << 1, /**< Unit algarism of hours value should be editable */
9558         ELM_CLOCK_MIN_DECIMAL  = 1 << 2, /**< Decimal algarism of minutes value should be editable */
9559         ELM_CLOCK_MIN_UNIT     = 1 << 3, /**< Unit algarism of minutes value should be editable */
9560         ELM_CLOCK_SEC_DECIMAL  = 1 << 4, /**< Decimal algarism of seconds value should be editable */
9561         ELM_CLOCK_SEC_UNIT     = 1 << 5, /**< Unit algarism of seconds value should be editable */
9562         ELM_CLOCK_ALL          = (1 << 6) - 1 /**< All digits should be editable */
9563      } Elm_Clock_Digedit;
9564
9565    /**
9566     * Add a new clock widget to the given parent Elementary
9567     * (container) object
9568     *
9569     * @param parent The parent object
9570     * @return a new clock widget handle or @c NULL, on errors
9571     *
9572     * This function inserts a new clock widget on the canvas.
9573     *
9574     * @ingroup Clock
9575     */
9576    EAPI Evas_Object      *elm_clock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9577
9578    /**
9579     * Set a clock widget's time, programmatically
9580     *
9581     * @param obj The clock widget object
9582     * @param hrs The hours to set
9583     * @param min The minutes to set
9584     * @param sec The secondes to set
9585     *
9586     * This function updates the time that is showed by the clock
9587     * widget.
9588     *
9589     *  Values @b must be set within the following ranges:
9590     * - 0 - 23, for hours
9591     * - 0 - 59, for minutes
9592     * - 0 - 59, for seconds,
9593     *
9594     * even if the clock is not in "military" mode.
9595     *
9596     * @warning The behavior for values set out of those ranges is @b
9597     * undefined.
9598     *
9599     * @ingroup Clock
9600     */
9601    EAPI void              elm_clock_time_set(Evas_Object *obj, int hrs, int min, int sec) EINA_ARG_NONNULL(1);
9602
9603    /**
9604     * Get a clock widget's time values
9605     *
9606     * @param obj The clock object
9607     * @param[out] hrs Pointer to the variable to get the hours value
9608     * @param[out] min Pointer to the variable to get the minutes value
9609     * @param[out] sec Pointer to the variable to get the seconds value
9610     *
9611     * This function gets the time set for @p obj, returning
9612     * it on the variables passed as the arguments to function
9613     *
9614     * @note Use @c NULL pointers on the time values you're not
9615     * interested in: they'll be ignored by the function.
9616     *
9617     * @ingroup Clock
9618     */
9619    EAPI void              elm_clock_time_get(const Evas_Object *obj, int *hrs, int *min, int *sec) EINA_ARG_NONNULL(1);
9620
9621    /**
9622     * Set whether a given clock widget is under <b>edition mode</b> or
9623     * under (default) displaying-only mode.
9624     *
9625     * @param obj The clock object
9626     * @param edit @c EINA_TRUE to put it in edition, @c EINA_FALSE to
9627     * put it back to "displaying only" mode
9628     *
9629     * This function makes a clock's time to be editable or not <b>by
9630     * user interaction</b>. When in edition mode, clocks @b stop
9631     * ticking, until one brings them back to canonical mode. The
9632     * elm_clock_digit_edit_set() function will influence which digits
9633     * of the clock will be editable. By default, all of them will be
9634     * (#ELM_CLOCK_NONE).
9635     *
9636     * @note am/pm sheets, if being shown, will @b always be editable
9637     * under edition mode.
9638     *
9639     * @see elm_clock_edit_get()
9640     *
9641     * @ingroup Clock
9642     */
9643    EAPI void              elm_clock_edit_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
9644
9645    /**
9646     * Retrieve whether a given clock widget is under <b>edition
9647     * mode</b> or under (default) displaying-only mode.
9648     *
9649     * @param obj The clock object
9650     * @param edit @c EINA_TRUE, if it's in edition mode, @c EINA_FALSE
9651     * otherwise
9652     *
9653     * This function retrieves whether the clock's time can be edited
9654     * or not by user interaction.
9655     *
9656     * @see elm_clock_edit_set() for more details
9657     *
9658     * @ingroup Clock
9659     */
9660    EAPI Eina_Bool         elm_clock_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9661
9662    /**
9663     * Set what digits of the given clock widget should be editable
9664     * when in edition mode.
9665     *
9666     * @param obj The clock object
9667     * @param digedit Bit mask indicating the digits to be editable
9668     * (values in #Elm_Clock_Digedit).
9669     *
9670     * If the @p digedit param is #ELM_CLOCK_NONE, editing will be
9671     * disabled on @p obj (same effect as elm_clock_edit_set(), with @c
9672     * EINA_FALSE).
9673     *
9674     * @see elm_clock_digit_edit_get()
9675     *
9676     * @ingroup Clock
9677     */
9678    EAPI void              elm_clock_digit_edit_set(Evas_Object *obj, Elm_Clock_Digedit digedit) EINA_ARG_NONNULL(1);
9679
9680    /**
9681     * Retrieve what digits of the given clock widget should be
9682     * editable when in edition mode.
9683     *
9684     * @param obj The clock object
9685     * @return Bit mask indicating the digits to be editable
9686     * (values in #Elm_Clock_Digedit).
9687     *
9688     * @see elm_clock_digit_edit_set() for more details
9689     *
9690     * @ingroup Clock
9691     */
9692    EAPI Elm_Clock_Digedit elm_clock_digit_edit_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9693
9694    /**
9695     * Set if the given clock widget must show hours in military or
9696     * am/pm mode
9697     *
9698     * @param obj The clock object
9699     * @param am_pm @c EINA_TRUE to put it in am/pm mode, @c EINA_FALSE
9700     * to military mode
9701     *
9702     * This function sets if the clock must show hours in military or
9703     * am/pm mode. In some countries like Brazil the military mode
9704     * (00-24h-format) is used, in opposition to the USA, where the
9705     * am/pm mode is more commonly used.
9706     *
9707     * @see elm_clock_show_am_pm_get()
9708     *
9709     * @ingroup Clock
9710     */
9711    EAPI void              elm_clock_show_am_pm_set(Evas_Object *obj, Eina_Bool am_pm) EINA_ARG_NONNULL(1);
9712
9713    /**
9714     * Get if the given clock widget shows hours in military or am/pm
9715     * mode
9716     *
9717     * @param obj The clock object
9718     * @return @c EINA_TRUE, if in am/pm mode, @c EINA_FALSE if in
9719     * military
9720     *
9721     * This function gets if the clock shows hours in military or am/pm
9722     * mode.
9723     *
9724     * @see elm_clock_show_am_pm_set() for more details
9725     *
9726     * @ingroup Clock
9727     */
9728    EAPI Eina_Bool         elm_clock_show_am_pm_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9729
9730    /**
9731     * Set if the given clock widget must show time with seconds or not
9732     *
9733     * @param obj The clock object
9734     * @param seconds @c EINA_TRUE to show seconds, @c EINA_FALSE otherwise
9735     *
9736     * This function sets if the given clock must show or not elapsed
9737     * seconds. By default, they are @b not shown.
9738     *
9739     * @see elm_clock_show_seconds_get()
9740     *
9741     * @ingroup Clock
9742     */
9743    EAPI void              elm_clock_show_seconds_set(Evas_Object *obj, Eina_Bool seconds) EINA_ARG_NONNULL(1);
9744
9745    /**
9746     * Get whether the given clock widget is showing time with seconds
9747     * or not
9748     *
9749     * @param obj The clock object
9750     * @return @c EINA_TRUE if it's showing seconds, @c EINA_FALSE otherwise
9751     *
9752     * This function gets whether @p obj is showing or not the elapsed
9753     * seconds.
9754     *
9755     * @see elm_clock_show_seconds_set()
9756     *
9757     * @ingroup Clock
9758     */
9759    EAPI Eina_Bool         elm_clock_show_seconds_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9760
9761    /**
9762     * Set the interval on time updates for an user mouse button hold
9763     * on clock widgets' time edition.
9764     *
9765     * @param obj The clock object
9766     * @param interval The (first) interval value in seconds
9767     *
9768     * This interval value is @b decreased while the user holds the
9769     * mouse pointer either incrementing or decrementing a given the
9770     * clock digit's value.
9771     *
9772     * This helps the user to get to a given time distant from the
9773     * current one easier/faster, as it will start to flip quicker and
9774     * quicker on mouse button holds.
9775     *
9776     * The calculation for the next flip interval value, starting from
9777     * the one set with this call, is the previous interval divided by
9778     * 1.05, so it decreases a little bit.
9779     *
9780     * The default starting interval value for automatic flips is
9781     * @b 0.85 seconds.
9782     *
9783     * @see elm_clock_interval_get()
9784     *
9785     * @ingroup Clock
9786     */
9787    EAPI void              elm_clock_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
9788
9789    /**
9790     * Get the interval on time updates for an user mouse button hold
9791     * on clock widgets' time edition.
9792     *
9793     * @param obj The clock object
9794     * @return The (first) interval value, in seconds, set on it
9795     *
9796     * @see elm_clock_interval_set() for more details
9797     *
9798     * @ingroup Clock
9799     */
9800    EAPI double            elm_clock_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
9801
9802    /**
9803     * @}
9804     */
9805
9806    /**
9807     * @defgroup Layout Layout
9808     *
9809     * @image html img/widget/layout/preview-00.png
9810     * @image latex img/widget/layout/preview-00.eps width=\textwidth
9811     *
9812     * @image html img/layout-predefined.png
9813     * @image latex img/layout-predefined.eps width=\textwidth
9814     *
9815     * This is a container widget that takes a standard Edje design file and
9816     * wraps it very thinly in a widget.
9817     *
9818     * An Edje design (theme) file has a very wide range of possibilities to
9819     * describe the behavior of elements added to the Layout. Check out the Edje
9820     * documentation and the EDC reference to get more information about what can
9821     * be done with Edje.
9822     *
9823     * Just like @ref List, @ref Box, and other container widgets, any
9824     * object added to the Layout will become its child, meaning that it will be
9825     * deleted if the Layout is deleted, move if the Layout is moved, and so on.
9826     *
9827     * The Layout widget can contain as many Contents, Boxes or Tables as
9828     * described in its theme file. For instance, objects can be added to
9829     * different Tables by specifying the respective Table part names. The same
9830     * is valid for Content and Box.
9831     *
9832     * The objects added as child of the Layout will behave as described in the
9833     * part description where they were added. There are 3 possible types of
9834     * parts where a child can be added:
9835     *
9836     * @section secContent Content (SWALLOW part)
9837     *
9838     * Only one object can be added to the @c SWALLOW part (but you still can
9839     * have many @c SWALLOW parts and one object on each of them). Use the @c
9840     * elm_object_content_set/get/unset functions to set, retrieve and unset 
9841     * objects as content of the @c SWALLOW. After being set to this part, the 
9842     * object size, position, visibility, clipping and other description 
9843     * properties will be totally controled by the description of the given part 
9844     * (inside the Edje theme file).
9845     *
9846     * One can use @c evas_object_size_hint_* functions on the child to have some
9847     * kind of control over its behavior, but the resulting behavior will still
9848     * depend heavily on the @c SWALLOW part description.
9849     *
9850     * The Edje theme also can change the part description, based on signals or
9851     * scripts running inside the theme. This change can also be animated. All of
9852     * this will affect the child object set as content accordingly. The object
9853     * size will be changed if the part size is changed, it will animate move if
9854     * the part is moving, and so on.
9855     *
9856     * The following picture demonstrates a Layout widget with a child object
9857     * added to its @c SWALLOW:
9858     *
9859     * @image html layout_swallow.png
9860     * @image latex layout_swallow.eps width=\textwidth
9861     *
9862     * @section secBox Box (BOX part)
9863     *
9864     * An Edje @c BOX part is very similar to the Elementary @ref Box widget. It
9865     * allows one to add objects to the box and have them distributed along its
9866     * area, accordingly to the specified @a layout property (now by @a layout we
9867     * mean the chosen layouting design of the Box, not the Layout widget
9868     * itself).
9869     *
9870     * A similar effect for having a box with its position, size and other things
9871     * controled by the Layout theme would be to create an Elementary @ref Box
9872     * widget and add it as a Content in the @c SWALLOW part.
9873     *
9874     * The main difference of using the Layout Box is that its behavior, the box
9875     * properties like layouting format, padding, align, etc. will be all
9876     * controled by the theme. This means, for example, that a signal could be
9877     * sent to the Layout theme (with elm_object_signal_emit()) and the theme
9878     * handled the signal by changing the box padding, or align, or both. Using
9879     * the Elementary @ref Box widget is not necessarily harder or easier, it
9880     * just depends on the circunstances and requirements.
9881     *
9882     * The Layout Box can be used through the @c elm_layout_box_* set of
9883     * functions.
9884     *
9885     * The following picture demonstrates a Layout widget with many child objects
9886     * added to its @c BOX part:
9887     *
9888     * @image html layout_box.png
9889     * @image latex layout_box.eps width=\textwidth
9890     *
9891     * @section secTable Table (TABLE part)
9892     *
9893     * Just like the @ref secBox, the Layout Table is very similar to the
9894     * Elementary @ref Table widget. It allows one to add objects to the Table
9895     * specifying the row and column where the object should be added, and any
9896     * column or row span if necessary.
9897     *
9898     * Again, we could have this design by adding a @ref Table widget to the @c
9899     * SWALLOW part using elm_object_part_content_set(). The same difference happens
9900     * here when choosing to use the Layout Table (a @c TABLE part) instead of
9901     * the @ref Table plus @c SWALLOW part. It's just a matter of convenience.
9902     *
9903     * The Layout Table can be used through the @c elm_layout_table_* set of
9904     * functions.
9905     *
9906     * The following picture demonstrates a Layout widget with many child objects
9907     * added to its @c TABLE part:
9908     *
9909     * @image html layout_table.png
9910     * @image latex layout_table.eps width=\textwidth
9911     *
9912     * @section secPredef Predefined Layouts
9913     *
9914     * Another interesting thing about the Layout widget is that it offers some
9915     * predefined themes that come with the default Elementary theme. These
9916     * themes can be set by the call elm_layout_theme_set(), and provide some
9917     * basic functionality depending on the theme used.
9918     *
9919     * Most of them already send some signals, some already provide a toolbar or
9920     * back and next buttons.
9921     *
9922     * These are available predefined theme layouts. All of them have class = @c
9923     * layout, group = @c application, and style = one of the following options:
9924     *
9925     * @li @c toolbar-content - application with toolbar and main content area
9926     * @li @c toolbar-content-back - application with toolbar and main content
9927     * area with a back button and title area
9928     * @li @c toolbar-content-back-next - application with toolbar and main
9929     * content area with a back and next buttons and title area
9930     * @li @c content-back - application with a main content area with a back
9931     * button and title area
9932     * @li @c content-back-next - application with a main content area with a
9933     * back and next buttons and title area
9934     * @li @c toolbar-vbox - application with toolbar and main content area as a
9935     * vertical box
9936     * @li @c toolbar-table - application with toolbar and main content area as a
9937     * table
9938     *
9939     * @section secExamples Examples
9940     *
9941     * Some examples of the Layout widget can be found here:
9942     * @li @ref layout_example_01
9943     * @li @ref layout_example_02
9944     * @li @ref layout_example_03
9945     * @li @ref layout_example_edc
9946     *
9947     */
9948
9949    /**
9950     * Add a new layout to the parent
9951     *
9952     * @param parent The parent object
9953     * @return The new object or NULL if it cannot be created
9954     *
9955     * @see elm_layout_file_set()
9956     * @see elm_layout_theme_set()
9957     *
9958     * @ingroup Layout
9959     */
9960    EAPI Evas_Object       *elm_layout_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
9961    /**
9962     * Set the file that will be used as layout
9963     *
9964     * @param obj The layout object
9965     * @param file The path to file (edj) that will be used as layout
9966     * @param group The group that the layout belongs in edje file
9967     *
9968     * @return (1 = success, 0 = error)
9969     *
9970     * @ingroup Layout
9971     */
9972    EAPI Eina_Bool          elm_layout_file_set(Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1);
9973    /**
9974     * Set the edje group from the elementary theme that will be used as layout
9975     *
9976     * @param obj The layout object
9977     * @param clas the clas of the group
9978     * @param group the group
9979     * @param style the style to used
9980     *
9981     * @return (1 = success, 0 = error)
9982     *
9983     * @ingroup Layout
9984     */
9985    EAPI Eina_Bool          elm_layout_theme_set(Evas_Object *obj, const char *clas, const char *group, const char *style) EINA_ARG_NONNULL(1);
9986    /**
9987     * Set the layout content.
9988     *
9989     * @param obj The layout object
9990     * @param swallow The swallow part name in the edje file
9991     * @param content The child that will be added in this layout object
9992     *
9993     * Once the content object is set, a previously set one will be deleted.
9994     * If you want to keep that old content object, use the
9995     * elm_object_part_content_unset() function.
9996     *
9997     * @note In an Edje theme, the part used as a content container is called @c
9998     * SWALLOW. This is why the parameter name is called @p swallow, but it is
9999     * expected to be a part name just like the second parameter of
10000     * elm_layout_box_append().
10001     *
10002     * @see elm_layout_box_append()
10003     * @see elm_object_part_content_get()
10004     * @see elm_object_part_content_unset()
10005     * @see @ref secBox
10006     * @deprecated use elm_object_part_content_set() instead
10007     *
10008     * @ingroup Layout
10009     */
10010    WILL_DEPRECATE EAPI void               elm_layout_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
10011    /**
10012     * Get the child object in the given content part.
10013     *
10014     * @param obj The layout object
10015     * @param swallow The SWALLOW part to get its content
10016     *
10017     * @return The swallowed object or NULL if none or an error occurred
10018     *
10019     * @deprecated use elm_object_part_content_get() instead
10020     *
10021     * @ingroup Layout
10022     */
10023    WILL_DEPRECATE EAPI Evas_Object       *elm_layout_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10024    /**
10025     * Unset the layout content.
10026     *
10027     * @param obj The layout object
10028     * @param swallow The swallow part name in the edje file
10029     * @return The content that was being used
10030     *
10031     * Unparent and return the content object which was set for this part.
10032     *
10033     * @deprecated use elm_object_part_content_unset() instead
10034     *
10035     * @ingroup Layout
10036     */
10037    WILL_DEPRECATE EAPI Evas_Object       *elm_layout_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10038    /**
10039     * Set the text of the given part
10040     *
10041     * @param obj The layout object
10042     * @param part The TEXT part where to set the text
10043     * @param text The text to set
10044     *
10045     * @ingroup Layout
10046     * @deprecated use elm_object_part_text_set() instead.
10047     */
10048    EINA_DEPRECATED EAPI void               elm_layout_text_set(Evas_Object *obj, const char *part, const char *text) EINA_ARG_NONNULL(1);
10049    /**
10050     * Get the text set in the given part
10051     *
10052     * @param obj The layout object
10053     * @param part The TEXT part to retrieve the text off
10054     *
10055     * @return The text set in @p part
10056     *
10057     * @ingroup Layout
10058     * @deprecated use elm_object_part_text_get() instead.
10059     */
10060    EINA_DEPRECATED EAPI const char        *elm_layout_text_get(const Evas_Object *obj, const char *part) EINA_ARG_NONNULL(1);
10061    /**
10062     * Append child to layout box part.
10063     *
10064     * @param obj the layout object
10065     * @param part the box part to which the object will be appended.
10066     * @param child the child object to append to box.
10067     *
10068     * Once the object is appended, it will become child of the layout. Its
10069     * lifetime will be bound to the layout, whenever the layout dies the child
10070     * will be deleted automatically. One should use elm_layout_box_remove() to
10071     * make this layout forget about the object.
10072     *
10073     * @see elm_layout_box_prepend()
10074     * @see elm_layout_box_insert_before()
10075     * @see elm_layout_box_insert_at()
10076     * @see elm_layout_box_remove()
10077     *
10078     * @ingroup Layout
10079     */
10080    EAPI void               elm_layout_box_append(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
10081    /**
10082     * Prepend child to layout box part.
10083     *
10084     * @param obj the layout object
10085     * @param part the box part to prepend.
10086     * @param child the child object to prepend to box.
10087     *
10088     * Once the object is prepended, it will become child of the layout. Its
10089     * lifetime will be bound to the layout, whenever the layout dies the child
10090     * will be deleted automatically. One should use elm_layout_box_remove() to
10091     * make this layout forget about the object.
10092     *
10093     * @see elm_layout_box_append()
10094     * @see elm_layout_box_insert_before()
10095     * @see elm_layout_box_insert_at()
10096     * @see elm_layout_box_remove()
10097     *
10098     * @ingroup Layout
10099     */
10100    EAPI void               elm_layout_box_prepend(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1);
10101    /**
10102     * Insert child to layout box part before a reference object.
10103     *
10104     * @param obj the layout object
10105     * @param part the box part to insert.
10106     * @param child the child object to insert into box.
10107     * @param reference another reference object to insert before in box.
10108     *
10109     * Once the object is inserted, it will become child of the layout. Its
10110     * lifetime will be bound to the layout, whenever the layout dies the child
10111     * will be deleted automatically. One should use elm_layout_box_remove() to
10112     * make this layout forget about the object.
10113     *
10114     * @see elm_layout_box_append()
10115     * @see elm_layout_box_prepend()
10116     * @see elm_layout_box_insert_before()
10117     * @see elm_layout_box_remove()
10118     *
10119     * @ingroup Layout
10120     */
10121    EAPI void               elm_layout_box_insert_before(Evas_Object *obj, const char *part, Evas_Object *child, const Evas_Object *reference) EINA_ARG_NONNULL(1);
10122    /**
10123     * Insert child to layout box part at a given position.
10124     *
10125     * @param obj the layout object
10126     * @param part the box part to insert.
10127     * @param child the child object to insert into box.
10128     * @param pos the numeric position >=0 to insert the child.
10129     *
10130     * Once the object is inserted, it will become child of the layout. Its
10131     * lifetime will be bound to the layout, whenever the layout dies the child
10132     * will be deleted automatically. One should use elm_layout_box_remove() to
10133     * make this layout forget about the object.
10134     *
10135     * @see elm_layout_box_append()
10136     * @see elm_layout_box_prepend()
10137     * @see elm_layout_box_insert_before()
10138     * @see elm_layout_box_remove()
10139     *
10140     * @ingroup Layout
10141     */
10142    EAPI void               elm_layout_box_insert_at(Evas_Object *obj, const char *part, Evas_Object *child, unsigned int pos) EINA_ARG_NONNULL(1);
10143    /**
10144     * Remove a child of the given part box.
10145     *
10146     * @param obj The layout object
10147     * @param part The box part name to remove child.
10148     * @param child The object to remove from box.
10149     * @return The object that was being used, or NULL if not found.
10150     *
10151     * The object will be removed from the box part and its lifetime will
10152     * not be handled by the layout anymore. This is equivalent to
10153     * elm_object_part_content_unset() for box.
10154     *
10155     * @see elm_layout_box_append()
10156     * @see elm_layout_box_remove_all()
10157     *
10158     * @ingroup Layout
10159     */
10160    EAPI Evas_Object       *elm_layout_box_remove(Evas_Object *obj, const char *part, Evas_Object *child) EINA_ARG_NONNULL(1, 2, 3);
10161    /**
10162     * Remove all child of the given part box.
10163     *
10164     * @param obj The layout object
10165     * @param part The box part name to remove child.
10166     * @param clear If EINA_TRUE, then all objects will be deleted as
10167     *        well, otherwise they will just be removed and will be
10168     *        dangling on the canvas.
10169     *
10170     * The objects will be removed from the box part and their lifetime will
10171     * not be handled by the layout anymore. This is equivalent to
10172     * elm_layout_box_remove() for all box children.
10173     *
10174     * @see elm_layout_box_append()
10175     * @see elm_layout_box_remove()
10176     *
10177     * @ingroup Layout
10178     */
10179    EAPI void               elm_layout_box_remove_all(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
10180    /**
10181     * Insert child to layout table part.
10182     *
10183     * @param obj the layout object
10184     * @param part the box part to pack child.
10185     * @param child_obj the child object to pack into table.
10186     * @param col the column to which the child should be added. (>= 0)
10187     * @param row the row to which the child should be added. (>= 0)
10188     * @param colspan how many columns should be used to store this object. (>=
10189     *        1)
10190     * @param rowspan how many rows should be used to store this object. (>= 1)
10191     *
10192     * Once the object is inserted, it will become child of the table. Its
10193     * lifetime will be bound to the layout, and whenever the layout dies the
10194     * child will be deleted automatically. One should use
10195     * elm_layout_table_remove() to make this layout forget about the object.
10196     *
10197     * If @p colspan or @p rowspan are bigger than 1, that object will occupy
10198     * more space than a single cell. For instance, the following code:
10199     * @code
10200     * elm_layout_table_pack(layout, "table_part", child, 0, 1, 3, 1);
10201     * @endcode
10202     *
10203     * Would result in an object being added like the following picture:
10204     *
10205     * @image html layout_colspan.png
10206     * @image latex layout_colspan.eps width=\textwidth
10207     *
10208     * @see elm_layout_table_unpack()
10209     * @see elm_layout_table_clear()
10210     *
10211     * @ingroup Layout
10212     */
10213    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);
10214    /**
10215     * Unpack (remove) a child of the given part table.
10216     *
10217     * @param obj The layout object
10218     * @param part The table part name to remove child.
10219     * @param child_obj The object to remove from table.
10220     * @return The object that was being used, or NULL if not found.
10221     *
10222     * The object will be unpacked from the table part and its lifetime
10223     * will not be handled by the layout anymore. This is equivalent to
10224     * elm_object_part_content_unset() for table.
10225     *
10226     * @see elm_layout_table_pack()
10227     * @see elm_layout_table_clear()
10228     *
10229     * @ingroup Layout
10230     */
10231    EAPI Evas_Object       *elm_layout_table_unpack(Evas_Object *obj, const char *part, Evas_Object *child_obj) EINA_ARG_NONNULL(1, 2, 3);
10232    /**
10233     * Remove all child of the given part table.
10234     *
10235     * @param obj The layout object
10236     * @param part The table part name to remove child.
10237     * @param clear If EINA_TRUE, then all objects will be deleted as
10238     *        well, otherwise they will just be removed and will be
10239     *        dangling on the canvas.
10240     *
10241     * The objects will be removed from the table part and their lifetime will
10242     * not be handled by the layout anymore. This is equivalent to
10243     * elm_layout_table_unpack() for all table children.
10244     *
10245     * @see elm_layout_table_pack()
10246     * @see elm_layout_table_unpack()
10247     *
10248     * @ingroup Layout
10249     */
10250    EAPI void               elm_layout_table_clear(Evas_Object *obj, const char *part, Eina_Bool clear) EINA_ARG_NONNULL(1, 2);
10251    /**
10252     * Get the edje layout
10253     *
10254     * @param obj The layout object
10255     *
10256     * @return A Evas_Object with the edje layout settings loaded
10257     * with function elm_layout_file_set
10258     *
10259     * This returns the edje object. It is not expected to be used to then
10260     * swallow objects via edje_object_part_swallow() for example. Use
10261     * elm_object_part_content_set() instead so child object handling and sizing is
10262     * done properly.
10263     *
10264     * @note This function should only be used if you really need to call some
10265     * low level Edje function on this edje object. All the common stuff (setting
10266     * text, emitting signals, hooking callbacks to signals, etc.) can be done
10267     * with proper elementary functions.
10268     *
10269     * @see elm_object_signal_callback_add()
10270     * @see elm_object_signal_emit()
10271     * @see elm_object_part_text_set()
10272     * @see elm_object_part_content_set()
10273     * @see elm_layout_box_append()
10274     * @see elm_layout_table_pack()
10275     * @see elm_layout_data_get()
10276     *
10277     * @ingroup Layout
10278     */
10279    EAPI Evas_Object       *elm_layout_edje_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10280    /**
10281     * Get the edje data from the given layout
10282     *
10283     * @param obj The layout object
10284     * @param key The data key
10285     *
10286     * @return The edje data string
10287     *
10288     * This function fetches data specified inside the edje theme of this layout.
10289     * This function return NULL if data is not found.
10290     *
10291     * In EDC this comes from a data block within the group block that @p
10292     * obj was loaded from. E.g.
10293     *
10294     * @code
10295     * collections {
10296     *   group {
10297     *     name: "a_group";
10298     *     data {
10299     *       item: "key1" "value1";
10300     *       item: "key2" "value2";
10301     *     }
10302     *   }
10303     * }
10304     * @endcode
10305     *
10306     * @ingroup Layout
10307     */
10308    EAPI const char        *elm_layout_data_get(const Evas_Object *obj, const char *key) EINA_ARG_NONNULL(1, 2);
10309    /**
10310     * Eval sizing
10311     *
10312     * @param obj The layout object
10313     *
10314     * Manually forces a sizing re-evaluation. This is useful when the minimum
10315     * size required by the edje theme of this layout has changed. The change on
10316     * the minimum size required by the edje theme is not immediately reported to
10317     * the elementary layout, so one needs to call this function in order to tell
10318     * the widget (layout) that it needs to reevaluate its own size.
10319     *
10320     * The minimum size of the theme is calculated based on minimum size of
10321     * parts, the size of elements inside containers like box and table, etc. All
10322     * of this can change due to state changes, and that's when this function
10323     * should be called.
10324     *
10325     * Also note that a standard signal of "size,eval" "elm" emitted from the
10326     * edje object will cause this to happen too.
10327     *
10328     * @ingroup Layout
10329     */
10330    EAPI void               elm_layout_sizing_eval(Evas_Object *obj) EINA_ARG_NONNULL(1);
10331
10332    /**
10333     * Sets a specific cursor for an edje part.
10334     *
10335     * @param obj The layout object.
10336     * @param part_name a part from loaded edje group.
10337     * @param cursor cursor name to use, see Elementary_Cursor.h
10338     *
10339     * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10340     *         part not exists or it has "mouse_events: 0".
10341     *
10342     * @ingroup Layout
10343     */
10344    EAPI Eina_Bool          elm_layout_part_cursor_set(Evas_Object *obj, const char *part_name, const char *cursor) EINA_ARG_NONNULL(1, 2);
10345
10346    /**
10347     * Get the cursor to be shown when mouse is over an edje part
10348     *
10349     * @param obj The layout object.
10350     * @param part_name a part from loaded edje group.
10351     * @return the cursor name.
10352     *
10353     * @ingroup Layout
10354     */
10355    EAPI const char        *elm_layout_part_cursor_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10356
10357    /**
10358     * Unsets a cursor previously set with elm_layout_part_cursor_set().
10359     *
10360     * @param obj The layout object.
10361     * @param part_name a part from loaded edje group, that had a cursor set
10362     *        with elm_layout_part_cursor_set().
10363     *
10364     * @ingroup Layout
10365     */
10366    EAPI void               elm_layout_part_cursor_unset(Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10367
10368    /**
10369     * Sets a specific cursor style for an edje part.
10370     *
10371     * @param obj The layout object.
10372     * @param part_name a part from loaded edje group.
10373     * @param style the theme style to use (default, transparent, ...)
10374     *
10375     * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10376     *         part not exists or it did not had a cursor set.
10377     *
10378     * @ingroup Layout
10379     */
10380    EAPI Eina_Bool          elm_layout_part_cursor_style_set(Evas_Object *obj, const char *part_name, const char *style) EINA_ARG_NONNULL(1, 2);
10381
10382    /**
10383     * Gets a specific cursor style for an edje part.
10384     *
10385     * @param obj The layout object.
10386     * @param part_name a part from loaded edje group.
10387     *
10388     * @return the theme style in use, defaults to "default". If the
10389     *         object does not have a cursor set, then NULL is returned.
10390     *
10391     * @ingroup Layout
10392     */
10393    EAPI const char        *elm_layout_part_cursor_style_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10394
10395    /**
10396     * Sets if the cursor set should be searched on the theme or should use
10397     * the provided by the engine, only.
10398     *
10399     * @note before you set if should look on theme you should define a
10400     * cursor with elm_layout_part_cursor_set(). By default it will only
10401     * look for cursors provided by the engine.
10402     *
10403     * @param obj The layout object.
10404     * @param part_name a part from loaded edje group.
10405     * @param engine_only if cursors should be just provided by the engine
10406     *        or should also search on widget's theme as well
10407     *
10408     * @return EINA_TRUE on success or EINA_FALSE on failure, that may be
10409     *         part not exists or it did not had a cursor set.
10410     *
10411     * @ingroup Layout
10412     */
10413    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);
10414
10415    /**
10416     * Gets a specific cursor engine_only for an edje part.
10417     *
10418     * @param obj The layout object.
10419     * @param part_name a part from loaded edje group.
10420     *
10421     * @return whenever the cursor is just provided by engine or also from theme.
10422     *
10423     * @ingroup Layout
10424     */
10425    EAPI Eina_Bool          elm_layout_part_cursor_engine_only_get(const Evas_Object *obj, const char *part_name) EINA_ARG_NONNULL(1, 2);
10426
10427 /**
10428  * @def elm_layout_icon_set
10429  * Convienience macro to set the icon object in a layout that follows the
10430  * Elementary naming convention for its parts.
10431  *
10432  * @ingroup Layout
10433  */
10434 #define elm_layout_icon_set(_ly, _obj) \
10435   do { \
10436     const char *sig; \
10437     elm_object_part_content_set((_ly), "elm.swallow.icon", (_obj)); \
10438     if ((_obj)) sig = "elm,state,icon,visible"; \
10439     else sig = "elm,state,icon,hidden"; \
10440     elm_object_signal_emit((_ly), sig, "elm"); \
10441   } while (0)
10442
10443 /**
10444  * @def elm_layout_icon_get
10445  * Convienience macro to get the icon object from a layout that follows the
10446  * Elementary naming convention for its parts.
10447  *
10448  * @ingroup Layout
10449  */
10450 #define elm_layout_icon_get(_ly) \
10451   elm_object_part_content_get((_ly), "elm.swallow.icon")
10452
10453 /**
10454  * @def elm_layout_end_set
10455  * Convienience macro to set the end object in a layout that follows the
10456  * Elementary naming convention for its parts.
10457  *
10458  * @ingroup Layout
10459  */
10460 #define elm_layout_end_set(_ly, _obj) \
10461   do { \
10462     const char *sig; \
10463     elm_object_part_content_set((_ly), "elm.swallow.end", (_obj)); \
10464     if ((_obj)) sig = "elm,state,end,visible"; \
10465     else sig = "elm,state,end,hidden"; \
10466     elm_object_signal_emit((_ly), sig, "elm"); \
10467   } while (0)
10468
10469 /**
10470  * @def elm_layout_end_get
10471  * Convienience macro to get the end object in a layout that follows the
10472  * Elementary naming convention for its parts.
10473  *
10474  * @ingroup Layout
10475  */
10476 #define elm_layout_end_get(_ly) \
10477   elm_object_part_content_get((_ly), "elm.swallow.end")
10478
10479 /**
10480  * @def elm_layout_label_set
10481  * Convienience macro to set the label in a layout that follows the
10482  * Elementary naming convention for its parts.
10483  *
10484  * @ingroup Layout
10485  * @deprecated use elm_object_text_set() instead.
10486  */
10487 #define elm_layout_label_set(_ly, _txt) \
10488   elm_layout_text_set((_ly), "elm.text", (_txt))
10489
10490 /**
10491  * @def elm_layout_label_get
10492  * Convenience macro to get the label in a layout that follows the
10493  * Elementary naming convention for its parts.
10494  *
10495  * @ingroup Layout
10496  * @deprecated use elm_object_text_set() instead.
10497  */
10498 #define elm_layout_label_get(_ly) \
10499   elm_layout_text_get((_ly), "elm.text")
10500
10501    /* smart callbacks called:
10502     * "theme,changed" - when elm theme is changed.
10503     */
10504
10505    /**
10506     * @defgroup Notify Notify
10507     *
10508     * @image html img/widget/notify/preview-00.png
10509     * @image latex img/widget/notify/preview-00.eps
10510     *
10511     * Display a container in a particular region of the parent(top, bottom,
10512     * etc).  A timeout can be set to automatically hide the notify. This is so
10513     * that, after an evas_object_show() on a notify object, if a timeout was set
10514     * on it, it will @b automatically get hidden after that time.
10515     *
10516     * Signals that you can add callbacks for are:
10517     * @li "timeout" - when timeout happens on notify and it's hidden
10518     * @li "block,clicked" - when a click outside of the notify happens
10519     *
10520     * Default contents parts of the notify widget that you can use for are:
10521     * @li "default" - A content of the notify
10522     *
10523     * @ref tutorial_notify show usage of the API.
10524     *
10525     * @{
10526     */
10527    /**
10528     * @brief Possible orient values for notify.
10529     *
10530     * This values should be used in conjunction to elm_notify_orient_set() to
10531     * set the position in which the notify should appear(relative to its parent)
10532     * and in conjunction with elm_notify_orient_get() to know where the notify
10533     * is appearing.
10534     */
10535    typedef enum _Elm_Notify_Orient
10536      {
10537         ELM_NOTIFY_ORIENT_TOP, /**< Notify should appear in the top of parent, default */
10538         ELM_NOTIFY_ORIENT_CENTER, /**< Notify should appear in the center of parent */
10539         ELM_NOTIFY_ORIENT_BOTTOM, /**< Notify should appear in the bottom of parent */
10540         ELM_NOTIFY_ORIENT_LEFT, /**< Notify should appear in the left of parent */
10541         ELM_NOTIFY_ORIENT_RIGHT, /**< Notify should appear in the right of parent */
10542         ELM_NOTIFY_ORIENT_TOP_LEFT, /**< Notify should appear in the top left of parent */
10543         ELM_NOTIFY_ORIENT_TOP_RIGHT, /**< Notify should appear in the top right of parent */
10544         ELM_NOTIFY_ORIENT_BOTTOM_LEFT, /**< Notify should appear in the bottom left of parent */
10545         ELM_NOTIFY_ORIENT_BOTTOM_RIGHT, /**< Notify should appear in the bottom right of parent */
10546         ELM_NOTIFY_ORIENT_LAST /**< Sentinel value, @b don't use */
10547      } Elm_Notify_Orient;
10548    /**
10549     * @brief Add a new notify to the parent
10550     *
10551     * @param parent The parent object
10552     * @return The new object or NULL if it cannot be created
10553     */
10554    EAPI Evas_Object      *elm_notify_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10555    /**
10556     * @brief Set the content of the notify widget
10557     *
10558     * @param obj The notify object
10559     * @param content The content will be filled in this notify object
10560     *
10561     * Once the content object is set, a previously set one will be deleted. If
10562     * you want to keep that old content object, use the
10563     * elm_notify_content_unset() function.
10564     *
10565     * @deprecated use elm_object_content_set() instead
10566     *
10567     */
10568    WILL_DEPRECATE EAPI void              elm_notify_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
10569    /**
10570     * @brief Unset the content of the notify widget
10571     *
10572     * @param obj The notify object
10573     * @return The content that was being used
10574     *
10575     * Unparent and return the content object which was set for this widget
10576     *
10577     * @see elm_notify_content_set()
10578     * @deprecated use elm_object_content_unset() instead
10579     *
10580     */
10581    WILL_DEPRECATE EAPI Evas_Object      *elm_notify_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
10582    /**
10583     * @brief Return the content of the notify widget
10584     *
10585     * @param obj The notify object
10586     * @return The content that is being used
10587     *
10588     * @see elm_notify_content_set()
10589     * @deprecated use elm_object_content_get() instead
10590     *
10591     */
10592    WILL_DEPRECATE EAPI Evas_Object      *elm_notify_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10593    /**
10594     * @brief Set the notify parent
10595     *
10596     * @param obj The notify object
10597     * @param content The new parent
10598     *
10599     * Once the parent object is set, a previously set one will be disconnected
10600     * and replaced.
10601     */
10602    EAPI void              elm_notify_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10603    /**
10604     * @brief Get the notify parent
10605     *
10606     * @param obj The notify object
10607     * @return The parent
10608     *
10609     * @see elm_notify_parent_set()
10610     */
10611    EAPI Evas_Object      *elm_notify_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10612    /**
10613     * @brief Set the orientation
10614     *
10615     * @param obj The notify object
10616     * @param orient The new orientation
10617     *
10618     * Sets the position in which the notify will appear in its parent.
10619     *
10620     * @see @ref Elm_Notify_Orient for possible values.
10621     */
10622    EAPI void              elm_notify_orient_set(Evas_Object *obj, Elm_Notify_Orient orient) EINA_ARG_NONNULL(1);
10623    /**
10624     * @brief Return the orientation
10625     * @param obj The notify object
10626     * @return The orientation of the notification
10627     *
10628     * @see elm_notify_orient_set()
10629     * @see Elm_Notify_Orient
10630     */
10631    EAPI Elm_Notify_Orient elm_notify_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10632    /**
10633     * @brief Set the time interval after which the notify window is going to be
10634     * hidden.
10635     *
10636     * @param obj The notify object
10637     * @param time The timeout in seconds
10638     *
10639     * This function sets a timeout and starts the timer controlling when the
10640     * notify is hidden. Since calling evas_object_show() on a notify restarts
10641     * the timer controlling when the notify is hidden, setting this before the
10642     * notify is shown will in effect mean starting the timer when the notify is
10643     * shown.
10644     *
10645     * @note Set a value <= 0.0 to disable a running timer.
10646     *
10647     * @note If the value > 0.0 and the notify is previously visible, the
10648     * timer will be started with this value, canceling any running timer.
10649     */
10650    EAPI void              elm_notify_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
10651    /**
10652     * @brief Return the timeout value (in seconds)
10653     * @param obj the notify object
10654     *
10655     * @see elm_notify_timeout_set()
10656     */
10657    EAPI double            elm_notify_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10658    /**
10659     * @brief Sets whether events should be passed to by a click outside
10660     * its area.
10661     *
10662     * @param obj The notify object
10663     * @param repeats EINA_TRUE Events are repeats, else no
10664     *
10665     * When true if the user clicks outside the window the events will be caught
10666     * by the others widgets, else the events are blocked.
10667     *
10668     * @note The default value is EINA_TRUE.
10669     */
10670    EAPI void              elm_notify_repeat_events_set(Evas_Object *obj, Eina_Bool repeat) EINA_ARG_NONNULL(1);
10671    /**
10672     * @brief Return true if events are repeat below the notify object
10673     * @param obj the notify object
10674     *
10675     * @see elm_notify_repeat_events_set()
10676     */
10677    EAPI Eina_Bool         elm_notify_repeat_events_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10678    /**
10679     * @}
10680     */
10681
10682    /**
10683     * @defgroup Hover Hover
10684     *
10685     * @image html img/widget/hover/preview-00.png
10686     * @image latex img/widget/hover/preview-00.eps
10687     *
10688     * A Hover object will hover over its @p parent object at the @p target
10689     * location. Anything in the background will be given a darker coloring to
10690     * indicate that the hover object is on top (at the default theme). When the
10691     * hover is clicked it is dismissed(hidden), if the contents of the hover are
10692     * clicked that @b doesn't cause the hover to be dismissed.
10693     *
10694     * A Hover object has two parents. One parent that owns it during creation
10695     * and the other parent being the one over which the hover object spans.
10696     *
10697     *
10698     * @note The hover object will take up the entire space of @p target
10699     * object.
10700     *
10701     * Elementary has the following styles for the hover widget:
10702     * @li default
10703     * @li popout
10704     * @li menu
10705     * @li hoversel_vertical
10706     *
10707     * The following are the available position for content:
10708     * @li left
10709     * @li top-left
10710     * @li top
10711     * @li top-right
10712     * @li right
10713     * @li bottom-right
10714     * @li bottom
10715     * @li bottom-left
10716     * @li middle
10717     * @li smart
10718     *
10719     * Signals that you can add callbacks for are:
10720     * @li "clicked" - the user clicked the empty space in the hover to dismiss
10721     * @li "smart,changed" - a content object placed under the "smart"
10722     *                   policy was replaced to a new slot direction.
10723     *
10724     * See @ref tutorial_hover for more information.
10725     *
10726     * @{
10727     */
10728    typedef enum _Elm_Hover_Axis
10729      {
10730         ELM_HOVER_AXIS_NONE, /**< ELM_HOVER_AXIS_NONE -- no prefered orientation */
10731         ELM_HOVER_AXIS_HORIZONTAL, /**< ELM_HOVER_AXIS_HORIZONTAL -- horizontal */
10732         ELM_HOVER_AXIS_VERTICAL, /**< ELM_HOVER_AXIS_VERTICAL -- vertical */
10733         ELM_HOVER_AXIS_BOTH /**< ELM_HOVER_AXIS_BOTH -- both */
10734      } Elm_Hover_Axis;
10735    /**
10736     * @brief Adds a hover object to @p parent
10737     *
10738     * @param parent The parent object
10739     * @return The hover object or NULL if one could not be created
10740     */
10741    EAPI Evas_Object *elm_hover_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
10742    /**
10743     * @brief Sets the target object for the hover.
10744     *
10745     * @param obj The hover object
10746     * @param target The object to center the hover onto. The hover
10747     *
10748     * This function will cause the hover to be centered on the target object.
10749     */
10750    EAPI void         elm_hover_target_set(Evas_Object *obj, Evas_Object *target) EINA_ARG_NONNULL(1);
10751    /**
10752     * @brief Gets the target object for the hover.
10753     *
10754     * @param obj The hover object
10755     * @param parent The object to locate the hover over.
10756     *
10757     * @see elm_hover_target_set()
10758     */
10759    EAPI Evas_Object *elm_hover_target_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10760    /**
10761     * @brief Sets the parent object for the hover.
10762     *
10763     * @param obj The hover object
10764     * @param parent The object to locate the hover over.
10765     *
10766     * This function will cause the hover to take up the entire space that the
10767     * parent object fills.
10768     */
10769    EAPI void         elm_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
10770    /**
10771     * @brief Gets the parent object for the hover.
10772     *
10773     * @param obj The hover object
10774     * @return The parent object to locate the hover over.
10775     *
10776     * @see elm_hover_parent_set()
10777     */
10778    EAPI Evas_Object *elm_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
10779    /**
10780     * @brief Sets the content of the hover object and the direction in which it
10781     * will pop out.
10782     *
10783     * @param obj The hover object
10784     * @param swallow The direction that the object will be displayed
10785     * at. Accepted values are "left", "top-left", "top", "top-right",
10786     * "right", "bottom-right", "bottom", "bottom-left", "middle" and
10787     * "smart".
10788     * @param content The content to place at @p swallow
10789     *
10790     * Once the content object is set for a given direction, a previously
10791     * set one (on the same direction) will be deleted. If you want to
10792     * keep that old content object, use the elm_hover_content_unset()
10793     * function.
10794     *
10795     * All directions may have contents at the same time, except for
10796     * "smart". This is a special placement hint and its use case
10797     * independs of the calculations coming from
10798     * elm_hover_best_content_location_get(). Its use is for cases when
10799     * one desires only one hover content, but with a dinamic special
10800     * placement within the hover area. The content's geometry, whenever
10801     * it changes, will be used to decide on a best location not
10802     * extrapolating the hover's parent object view to show it in (still
10803     * being the hover's target determinant of its medium part -- move and
10804     * resize it to simulate finger sizes, for example). If one of the
10805     * directions other than "smart" are used, a previously content set
10806     * using it will be deleted, and vice-versa.
10807     */
10808    EAPI void         elm_hover_content_set(Evas_Object *obj, const char *swallow, Evas_Object *content) EINA_ARG_NONNULL(1);
10809    /**
10810     * @brief Get the content of the hover object, in a given direction.
10811     *
10812     * Return the content object which was set for this widget in the
10813     * @p swallow direction.
10814     *
10815     * @param obj The hover object
10816     * @param swallow The direction that the object was display at.
10817     * @return The content that was being used
10818     *
10819     * @see elm_hover_content_set()
10820     */
10821    EAPI Evas_Object *elm_hover_content_get(const Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10822    /**
10823     * @brief Unset the content of the hover object, in a given direction.
10824     *
10825     * Unparent and return the content object set at @p swallow direction.
10826     *
10827     * @param obj The hover object
10828     * @param swallow The direction that the object was display at.
10829     * @return The content that was being used.
10830     *
10831     * @see elm_hover_content_set()
10832     */
10833    EAPI Evas_Object *elm_hover_content_unset(Evas_Object *obj, const char *swallow) EINA_ARG_NONNULL(1);
10834    /**
10835     * @brief Returns the best swallow location for content in the hover.
10836     *
10837     * @param obj The hover object
10838     * @param pref_axis The preferred orientation axis for the hover object to use
10839     * @return The edje location to place content into the hover or @c
10840     *         NULL, on errors.
10841     *
10842     * Best is defined here as the location at which there is the most available
10843     * space.
10844     *
10845     * @p pref_axis may be one of
10846     * - @c ELM_HOVER_AXIS_NONE -- no prefered orientation
10847     * - @c ELM_HOVER_AXIS_HORIZONTAL -- horizontal
10848     * - @c ELM_HOVER_AXIS_VERTICAL -- vertical
10849     * - @c ELM_HOVER_AXIS_BOTH -- both
10850     *
10851     * If ELM_HOVER_AXIS_HORIZONTAL is choosen the returned position will
10852     * nescessarily be along the horizontal axis("left" or "right"). If
10853     * ELM_HOVER_AXIS_VERTICAL is choosen the returned position will nescessarily
10854     * be along the vertical axis("top" or "bottom"). Chossing
10855     * ELM_HOVER_AXIS_BOTH or ELM_HOVER_AXIS_NONE has the same effect and the
10856     * returned position may be in either axis.
10857     *
10858     * @see elm_hover_content_set()
10859     */
10860    EAPI const char  *elm_hover_best_content_location_get(const Evas_Object *obj, Elm_Hover_Axis pref_axis) EINA_ARG_NONNULL(1);
10861    /**
10862     * @}
10863     */
10864
10865    /* entry */
10866    /**
10867     * @defgroup Entry Entry
10868     *
10869     * @image html img/widget/entry/preview-00.png
10870     * @image latex img/widget/entry/preview-00.eps width=\textwidth
10871     * @image html img/widget/entry/preview-01.png
10872     * @image latex img/widget/entry/preview-01.eps width=\textwidth
10873     * @image html img/widget/entry/preview-02.png
10874     * @image latex img/widget/entry/preview-02.eps width=\textwidth
10875     * @image html img/widget/entry/preview-03.png
10876     * @image latex img/widget/entry/preview-03.eps width=\textwidth
10877     *
10878     * An entry is a convenience widget which shows a box that the user can
10879     * enter text into. Entries by default don't scroll, so they grow to
10880     * accomodate the entire text, resizing the parent window as needed. This
10881     * can be changed with the elm_entry_scrollable_set() function.
10882     *
10883     * They can also be single line or multi line (the default) and when set
10884     * to multi line mode they support text wrapping in any of the modes
10885     * indicated by #Elm_Wrap_Type.
10886     *
10887     * Other features include password mode, filtering of inserted text with
10888     * elm_entry_text_filter_append() and related functions, inline "items" and
10889     * formatted markup text.
10890     *
10891     * @section entry-markup Formatted text
10892     *
10893     * The markup tags supported by the Entry are defined by the theme, but
10894     * even when writing new themes or extensions it's a good idea to stick to
10895     * a sane default, to maintain coherency and avoid application breakages.
10896     * Currently defined by the default theme are the following tags:
10897     * @li \<br\>: Inserts a line break.
10898     * @li \<ps\>: Inserts a paragraph separator. This is preferred over line
10899     * breaks.
10900     * @li \<tab\>: Inserts a tab.
10901     * @li \<em\>...\</em\>: Emphasis. Sets the @em oblique style for the
10902     * enclosed text.
10903     * @li \<b\>...\</b\>: Sets the @b bold style for the enclosed text.
10904     * @li \<link\>...\</link\>: Underlines the enclosed text.
10905     * @li \<hilight\>...\</hilight\>: Hilights the enclosed text.
10906     *
10907     * @section entry-special Special markups
10908     *
10909     * Besides those used to format text, entries support two special markup
10910     * tags used to insert clickable portions of text or items inlined within
10911     * the text.
10912     *
10913     * @subsection entry-anchors Anchors
10914     *
10915     * Anchors are similar to HTML anchors. Text can be surrounded by \<a\> and
10916     * \</a\> tags and an event will be generated when this text is clicked,
10917     * like this:
10918     *
10919     * @code
10920     * This text is outside <a href=anc-01>but this one is an anchor</a>
10921     * @endcode
10922     *
10923     * The @c href attribute in the opening tag gives the name that will be
10924     * used to identify the anchor and it can be any valid utf8 string.
10925     *
10926     * When an anchor is clicked, an @c "anchor,clicked" signal is emitted with
10927     * an #Elm_Entry_Anchor_Info in the @c event_info parameter for the
10928     * callback function. The same applies for "anchor,in" (mouse in), "anchor,out"
10929     * (mouse out), "anchor,down" (mouse down), and "anchor,up" (mouse up) events on
10930     * an anchor.
10931     *
10932     * @subsection entry-items Items
10933     *
10934     * Inlined in the text, any other @c Evas_Object can be inserted by using
10935     * \<item\> tags this way:
10936     *
10937     * @code
10938     * <item size=16x16 vsize=full href=emoticon/haha></item>
10939     * @endcode
10940     *
10941     * Just like with anchors, the @c href identifies each item, but these need,
10942     * in addition, to indicate their size, which is done using any one of
10943     * @c size, @c absize or @c relsize attributes. These attributes take their
10944     * value in the WxH format, where W is the width and H the height of the
10945     * item.
10946     *
10947     * @li absize: Absolute pixel size for the item. Whatever value is set will
10948     * be the item's size regardless of any scale value the object may have
10949     * been set to. The final line height will be adjusted to fit larger items.
10950     * @li size: Similar to @c absize, but it's adjusted to the scale value set
10951     * for the object.
10952     * @li relsize: Size is adjusted for the item to fit within the current
10953     * line height.
10954     *
10955     * Besides their size, items are specificed a @c vsize value that affects
10956     * how their final size and position are calculated. The possible values
10957     * are:
10958     * @li ascent: Item will be placed within the line's baseline and its
10959     * ascent. That is, the height between the line where all characters are
10960     * positioned and the highest point in the line. For @c size and @c absize
10961     * items, the descent value will be added to the total line height to make
10962     * them fit. @c relsize items will be adjusted to fit within this space.
10963     * @li full: Items will be placed between the descent and ascent, or the
10964     * lowest point in the line and its highest.
10965     *
10966     * The next image shows different configurations of items and how they
10967     * are the previously mentioned options affect their sizes. In all cases,
10968     * the green line indicates the ascent, blue for the baseline and red for
10969     * the descent.
10970     *
10971     * @image html entry_item.png
10972     * @image latex entry_item.eps width=\textwidth
10973     *
10974     * And another one to show how size differs from absize. In the first one,
10975     * the scale value is set to 1.0, while the second one is using one of 2.0.
10976     *
10977     * @image html entry_item_scale.png
10978     * @image latex entry_item_scale.eps width=\textwidth
10979     *
10980     * After the size for an item is calculated, the entry will request an
10981     * object to place in its space. For this, the functions set with
10982     * elm_entry_item_provider_append() and related functions will be called
10983     * in order until one of them returns a @c non-NULL value. If no providers
10984     * are available, or all of them return @c NULL, then the entry falls back
10985     * to one of the internal defaults, provided the name matches with one of
10986     * them.
10987     *
10988     * All of the following are currently supported:
10989     *
10990     * - emoticon/angry
10991     * - emoticon/angry-shout
10992     * - emoticon/crazy-laugh
10993     * - emoticon/evil-laugh
10994     * - emoticon/evil
10995     * - emoticon/goggle-smile
10996     * - emoticon/grumpy
10997     * - emoticon/grumpy-smile
10998     * - emoticon/guilty
10999     * - emoticon/guilty-smile
11000     * - emoticon/haha
11001     * - emoticon/half-smile
11002     * - emoticon/happy-panting
11003     * - emoticon/happy
11004     * - emoticon/indifferent
11005     * - emoticon/kiss
11006     * - emoticon/knowing-grin
11007     * - emoticon/laugh
11008     * - emoticon/little-bit-sorry
11009     * - emoticon/love-lots
11010     * - emoticon/love
11011     * - emoticon/minimal-smile
11012     * - emoticon/not-happy
11013     * - emoticon/not-impressed
11014     * - emoticon/omg
11015     * - emoticon/opensmile
11016     * - emoticon/smile
11017     * - emoticon/sorry
11018     * - emoticon/squint-laugh
11019     * - emoticon/surprised
11020     * - emoticon/suspicious
11021     * - emoticon/tongue-dangling
11022     * - emoticon/tongue-poke
11023     * - emoticon/uh
11024     * - emoticon/unhappy
11025     * - emoticon/very-sorry
11026     * - emoticon/what
11027     * - emoticon/wink
11028     * - emoticon/worried
11029     * - emoticon/wtf
11030     *
11031     * Alternatively, an item may reference an image by its path, using
11032     * the URI form @c file:///path/to/an/image.png and the entry will then
11033     * use that image for the item.
11034     *
11035     * @section entry-files Loading and saving files
11036     *
11037     * Entries have convinience functions to load text from a file and save
11038     * changes back to it after a short delay. The automatic saving is enabled
11039     * by default, but can be disabled with elm_entry_autosave_set() and files
11040     * can be loaded directly as plain text or have any markup in them
11041     * recognized. See elm_entry_file_set() for more details.
11042     *
11043     * @section entry-signals Emitted signals
11044     *
11045     * This widget emits the following signals:
11046     *
11047     * @li "changed": The text within the entry was changed.
11048     * @li "changed,user": The text within the entry was changed because of user interaction.
11049     * @li "activated": The enter key was pressed on a single line entry.
11050     * @li "press": A mouse button has been pressed on the entry.
11051     * @li "longpressed": A mouse button has been pressed and held for a couple
11052     * seconds.
11053     * @li "clicked": The entry has been clicked (mouse press and release).
11054     * @li "clicked,double": The entry has been double clicked.
11055     * @li "clicked,triple": The entry has been triple clicked.
11056     * @li "focused": The entry has received focus.
11057     * @li "unfocused": The entry has lost focus.
11058     * @li "selection,paste": A paste of the clipboard contents was requested.
11059     * @li "selection,copy": A copy of the selected text into the clipboard was
11060     * requested.
11061     * @li "selection,cut": A cut of the selected text into the clipboard was
11062     * requested.
11063     * @li "selection,start": A selection has begun and no previous selection
11064     * existed.
11065     * @li "selection,changed": The current selection has changed.
11066     * @li "selection,cleared": The current selection has been cleared.
11067     * @li "cursor,changed": The cursor has changed position.
11068     * @li "anchor,clicked": An anchor has been clicked. The event_info
11069     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11070     * @li "anchor,in": Mouse cursor has moved into an anchor. The event_info
11071     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11072     * @li "anchor,out": Mouse cursor has moved out of an anchor. The event_info
11073     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11074     * @li "anchor,up": Mouse button has been unpressed on an anchor. The event_info
11075     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11076     * @li "anchor,down": Mouse button has been pressed on an anchor. The event_info
11077     * parameter for the callback will be an #Elm_Entry_Anchor_Info.
11078     * @li "preedit,changed": The preedit string has changed.
11079     * @li "language,changed": Program language changed.
11080     *
11081     * @section entry-examples
11082     *
11083     * An overview of the Entry API can be seen in @ref entry_example_01
11084     *
11085     * @{
11086     */
11087    /**
11088     * @typedef Elm_Entry_Anchor_Info
11089     *
11090     * The info sent in the callback for the "anchor,clicked" signals emitted
11091     * by entries.
11092     */
11093    typedef struct _Elm_Entry_Anchor_Info Elm_Entry_Anchor_Info;
11094    /**
11095     * @struct _Elm_Entry_Anchor_Info
11096     *
11097     * The info sent in the callback for the "anchor,clicked" signals emitted
11098     * by entries.
11099     */
11100    struct _Elm_Entry_Anchor_Info
11101      {
11102         const char *name; /**< The name of the anchor, as stated in its href */
11103         int         button; /**< The mouse button used to click on it */
11104         Evas_Coord  x, /**< Anchor geometry, relative to canvas */
11105                     y, /**< Anchor geometry, relative to canvas */
11106                     w, /**< Anchor geometry, relative to canvas */
11107                     h; /**< Anchor geometry, relative to canvas */
11108      };
11109    /**
11110     * @typedef Elm_Entry_Filter_Cb
11111     * This callback type is used by entry filters to modify text.
11112     * @param data The data specified as the last param when adding the filter
11113     * @param entry The entry object
11114     * @param text A pointer to the location of the text being filtered. This data can be modified,
11115     * but any additional allocations must be managed by the user.
11116     * @see elm_entry_text_filter_append
11117     * @see elm_entry_text_filter_prepend
11118     */
11119    typedef void (*Elm_Entry_Filter_Cb)(void *data, Evas_Object *entry, char **text);
11120
11121    /**
11122     * This adds an entry to @p parent object.
11123     *
11124     * By default, entries are:
11125     * @li not scrolled
11126     * @li multi-line
11127     * @li word wrapped
11128     * @li autosave is enabled
11129     *
11130     * @param parent The parent object
11131     * @return The new object or NULL if it cannot be created
11132     */
11133    EAPI Evas_Object *elm_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
11134    /**
11135     * Sets the entry to single line mode.
11136     *
11137     * In single line mode, entries don't ever wrap when the text reaches the
11138     * edge, and instead they keep growing horizontally. Pressing the @c Enter
11139     * key will generate an @c "activate" event instead of adding a new line.
11140     *
11141     * When @p single_line is @c EINA_FALSE, line wrapping takes effect again
11142     * and pressing enter will break the text into a different line
11143     * without generating any events.
11144     *
11145     * @param obj The entry object
11146     * @param single_line If true, the text in the entry
11147     * will be on a single line.
11148     */
11149    EAPI void         elm_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
11150    /**
11151     * Gets whether the entry is set to be single line.
11152     *
11153     * @param obj The entry object
11154     * @return single_line If true, the text in the entry is set to display
11155     * on a single line.
11156     *
11157     * @see elm_entry_single_line_set()
11158     */
11159    EAPI Eina_Bool    elm_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11160    /**
11161     * Sets the entry to password mode.
11162     *
11163     * In password mode, entries are implicitly single line and the display of
11164     * any text in them is replaced with asterisks (*).
11165     *
11166     * @param obj The entry object
11167     * @param password If true, password mode is enabled.
11168     */
11169    EAPI void         elm_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
11170    /**
11171     * Gets whether the entry is set to password mode.
11172     *
11173     * @param obj The entry object
11174     * @return If true, the entry is set to display all characters
11175     * as asterisks (*).
11176     *
11177     * @see elm_entry_password_set()
11178     */
11179    EAPI Eina_Bool    elm_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11180    /**
11181     * This sets the text displayed within the entry to @p entry.
11182     *
11183     * @param obj The entry object
11184     * @param entry The text to be displayed
11185     *
11186     * @deprecated Use elm_object_text_set() instead.
11187     * @note Using this function bypasses text filters
11188     */
11189    EAPI void         elm_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
11190    /**
11191     * This returns the text currently shown in object @p entry.
11192     * See also elm_entry_entry_set().
11193     *
11194     * @param obj The entry object
11195     * @return The currently displayed text or NULL on failure
11196     *
11197     * @deprecated Use elm_object_text_get() instead.
11198     */
11199    EAPI const char  *elm_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11200    /**
11201     * Appends @p entry to the text of the entry.
11202     *
11203     * Adds the text in @p entry to the end of any text already present in the
11204     * widget.
11205     *
11206     * The appended text is subject to any filters set for the widget.
11207     *
11208     * @param obj The entry object
11209     * @param entry The text to be displayed
11210     *
11211     * @see elm_entry_text_filter_append()
11212     */
11213    EAPI void         elm_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
11214    /**
11215     * Gets whether the entry is empty.
11216     *
11217     * Empty means no text at all. If there are any markup tags, like an item
11218     * tag for which no provider finds anything, and no text is displayed, this
11219     * function still returns EINA_FALSE.
11220     *
11221     * @param obj The entry object
11222     * @return EINA_TRUE if the entry is empty, EINA_FALSE otherwise.
11223     */
11224    EAPI Eina_Bool    elm_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11225    /**
11226     * Gets any selected text within the entry.
11227     *
11228     * If there's any selected text in the entry, this function returns it as
11229     * a string in markup format. NULL is returned if no selection exists or
11230     * if an error occurred.
11231     *
11232     * The returned value points to an internal string and should not be freed
11233     * or modified in any way. If the @p entry object is deleted or its
11234     * contents are changed, the returned pointer should be considered invalid.
11235     *
11236     * @param obj The entry object
11237     * @return The selected text within the entry or NULL on failure
11238     */
11239    EAPI const char  *elm_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11240    /**
11241     * Returns the actual textblock object of the entry.
11242     *
11243     * This function exposes the internal textblock object that actually
11244     * contains and draws the text. This should be used for low-level
11245     * manipulations that are otherwise not possible.
11246     *
11247     * Changing the textblock directly from here will not notify edje/elm to
11248     * recalculate the textblock size automatically, so any modifications
11249     * done to the textblock returned by this function should be followed by
11250     * a call to elm_entry_calc_force().
11251     *
11252     * The return value is marked as const as an additional warning.
11253     * One should not use the returned object with any of the generic evas
11254     * functions (geometry_get/resize/move and etc), but only with the textblock
11255     * functions; The former will either not work at all, or break the correct
11256     * functionality.
11257     *
11258     * IMPORTANT: Many functions may change (i.e delete and create a new one)
11259     * the internal textblock object. Do NOT cache the returned object, and try
11260     * not to mix calls on this object with regular elm_entry calls (which may
11261     * change the internal textblock object). This applies to all cursors
11262     * returned from textblock calls, and all the other derivative values.
11263     *
11264     * @param obj The entry object
11265     * @return The textblock object.
11266     */
11267    EAPI const Evas_Object *elm_entry_textblock_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11268    /**
11269     * Forces calculation of the entry size and text layouting.
11270     *
11271     * This should be used after modifying the textblock object directly. See
11272     * elm_entry_textblock_get() for more information.
11273     *
11274     * @param obj The entry object
11275     *
11276     * @see elm_entry_textblock_get()
11277     */
11278    EAPI void elm_entry_calc_force(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11279    /**
11280     * Inserts the given text into the entry at the current cursor position.
11281     *
11282     * This inserts text at the cursor position as if it was typed
11283     * by the user (note that this also allows markup which a user
11284     * can't just "type" as it would be converted to escaped text, so this
11285     * call can be used to insert things like emoticon items or bold push/pop
11286     * tags, other font and color change tags etc.)
11287     *
11288     * If any selection exists, it will be replaced by the inserted text.
11289     *
11290     * The inserted text is subject to any filters set for the widget.
11291     *
11292     * @param obj The entry object
11293     * @param entry The text to insert
11294     *
11295     * @see elm_entry_text_filter_append()
11296     */
11297    EAPI void         elm_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
11298    /**
11299     * Set the line wrap type to use on multi-line entries.
11300     *
11301     * Sets the wrap type used by the entry to any of the specified in
11302     * #Elm_Wrap_Type. This tells how the text will be implicitly cut into a new
11303     * line (without inserting a line break or paragraph separator) when it
11304     * reaches the far edge of the widget.
11305     *
11306     * Note that this only makes sense for multi-line entries. A widget set
11307     * to be single line will never wrap.
11308     *
11309     * @param obj The entry object
11310     * @param wrap The wrap mode to use. See #Elm_Wrap_Type for details on them
11311     */
11312    EAPI void         elm_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
11313    EINA_DEPRECATED EAPI void         elm_entry_line_char_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
11314    /**
11315     * Gets the wrap mode the entry was set to use.
11316     *
11317     * @param obj The entry object
11318     * @return Wrap type
11319     *
11320     * @see also elm_entry_line_wrap_set()
11321     */
11322    EAPI Elm_Wrap_Type elm_entry_line_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11323    /**
11324     * Sets if the entry is to be editable or not.
11325     *
11326     * By default, entries are editable and when focused, any text input by the
11327     * user will be inserted at the current cursor position. But calling this
11328     * function with @p editable as EINA_FALSE will prevent the user from
11329     * inputting text into the entry.
11330     *
11331     * The only way to change the text of a non-editable entry is to use
11332     * elm_object_text_set(), elm_entry_entry_insert() and other related
11333     * functions.
11334     *
11335     * @param obj The entry object
11336     * @param editable If EINA_TRUE, user input will be inserted in the entry,
11337     * if not, the entry is read-only and no user input is allowed.
11338     */
11339    EAPI void         elm_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
11340    /**
11341     * Gets whether the entry is editable or not.
11342     *
11343     * @param obj The entry object
11344     * @return If true, the entry is editable by the user.
11345     * If false, it is not editable by the user
11346     *
11347     * @see elm_entry_editable_set()
11348     */
11349    EAPI Eina_Bool    elm_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11350    /**
11351     * This drops any existing text selection within the entry.
11352     *
11353     * @param obj The entry object
11354     */
11355    EAPI void         elm_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
11356    /**
11357     * This selects all text within the entry.
11358     *
11359     * @param obj The entry object
11360     */
11361    EAPI void         elm_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
11362    /**
11363     * This moves the cursor one place to the right within the entry.
11364     *
11365     * @param obj The entry object
11366     * @return EINA_TRUE upon success, EINA_FALSE upon failure
11367     */
11368    EAPI Eina_Bool    elm_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
11369    /**
11370     * This moves the cursor one place to the left within the entry.
11371     *
11372     * @param obj The entry object
11373     * @return EINA_TRUE upon success, EINA_FALSE upon failure
11374     */
11375    EAPI Eina_Bool    elm_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
11376    /**
11377     * This moves the cursor one line up within the entry.
11378     *
11379     * @param obj The entry object
11380     * @return EINA_TRUE upon success, EINA_FALSE upon failure
11381     */
11382    EAPI Eina_Bool    elm_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
11383    /**
11384     * This moves the cursor one line down within the entry.
11385     *
11386     * @param obj The entry object
11387     * @return EINA_TRUE upon success, EINA_FALSE upon failure
11388     */
11389    EAPI Eina_Bool    elm_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
11390    /**
11391     * This moves the cursor to the beginning of the entry.
11392     *
11393     * @param obj The entry object
11394     */
11395    EAPI void         elm_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11396    /**
11397     * This moves the cursor to the end of the entry.
11398     *
11399     * @param obj The entry object
11400     */
11401    EAPI void         elm_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11402    /**
11403     * This moves the cursor to the beginning of the current line.
11404     *
11405     * @param obj The entry object
11406     */
11407    EAPI void         elm_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11408    /**
11409     * This moves the cursor to the end of the current line.
11410     *
11411     * @param obj The entry object
11412     */
11413    EAPI void         elm_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
11414    /**
11415     * This begins a selection within the entry as though
11416     * the user were holding down the mouse button to make a selection.
11417     *
11418     * @param obj The entry object
11419     */
11420    EAPI void         elm_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
11421    /**
11422     * This ends a selection within the entry as though
11423     * the user had just released the mouse button while making a selection.
11424     *
11425     * @param obj The entry object
11426     */
11427    EAPI void         elm_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
11428    /**
11429     * Gets whether a format node exists at the current cursor position.
11430     *
11431     * A format node is anything that defines how the text is rendered. It can
11432     * be a visible format node, such as a line break or a paragraph separator,
11433     * or an invisible one, such as bold begin or end tag.
11434     * This function returns whether any format node exists at the current
11435     * cursor position.
11436     *
11437     * @param obj The entry object
11438     * @return EINA_TRUE if the current cursor position contains a format node,
11439     * EINA_FALSE otherwise.
11440     *
11441     * @see elm_entry_cursor_is_visible_format_get()
11442     */
11443    EAPI Eina_Bool    elm_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11444    /**
11445     * Gets if the current cursor position holds a visible format node.
11446     *
11447     * @param obj The entry object
11448     * @return EINA_TRUE if the current cursor is a visible format, EINA_FALSE
11449     * if it's an invisible one or no format exists.
11450     *
11451     * @see elm_entry_cursor_is_format_get()
11452     */
11453    EAPI Eina_Bool    elm_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11454    /**
11455     * Gets the character pointed by the cursor at its current position.
11456     *
11457     * This function returns a string with the utf8 character stored at the
11458     * current cursor position.
11459     * Only the text is returned, any format that may exist will not be part
11460     * of the return value.
11461     *
11462     * @param obj The entry object
11463     * @return The text pointed by the cursors.
11464     */
11465    EAPI const char  *elm_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11466    /**
11467     * This function returns the geometry of the cursor.
11468     *
11469     * It's useful if you want to draw something on the cursor (or where it is),
11470     * or for example in the case of scrolled entry where you want to show the
11471     * cursor.
11472     *
11473     * @param obj The entry object
11474     * @param x returned geometry
11475     * @param y returned geometry
11476     * @param w returned geometry
11477     * @param h returned geometry
11478     * @return EINA_TRUE upon success, EINA_FALSE upon failure
11479     */
11480    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);
11481    /**
11482     * Sets the cursor position in the entry to the given value
11483     *
11484     * The value in @p pos is the index of the character position within the
11485     * contents of the string as returned by elm_entry_cursor_pos_get().
11486     *
11487     * @param obj The entry object
11488     * @param pos The position of the cursor
11489     */
11490    EAPI void         elm_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
11491    /**
11492     * Retrieves the current position of the cursor in the entry
11493     *
11494     * @param obj The entry object
11495     * @return The cursor position
11496     */
11497    EAPI int          elm_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11498    /**
11499     * This executes a "cut" action on the selected text in the entry.
11500     *
11501     * @param obj The entry object
11502     */
11503    EAPI void         elm_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
11504    /**
11505     * This executes a "copy" action on the selected text in the entry.
11506     *
11507     * @param obj The entry object
11508     */
11509    EAPI void         elm_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
11510    /**
11511     * This executes a "paste" action in the entry.
11512     *
11513     * @param obj The entry object
11514     */
11515    EAPI void         elm_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
11516    /**
11517     * This clears and frees the items in a entry's contextual (longpress)
11518     * menu.
11519     *
11520     * @param obj The entry object
11521     *
11522     * @see elm_entry_context_menu_item_add()
11523     */
11524    EAPI void         elm_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
11525    /**
11526     * This adds an item to the entry's contextual menu.
11527     *
11528     * A longpress on an entry will make the contextual menu show up, if this
11529     * hasn't been disabled with elm_entry_context_menu_disabled_set().
11530     * By default, this menu provides a few options like enabling selection mode,
11531     * which is useful on embedded devices that need to be explicit about it,
11532     * and when a selection exists it also shows the copy and cut actions.
11533     *
11534     * With this function, developers can add other options to this menu to
11535     * perform any action they deem necessary.
11536     *
11537     * @param obj The entry object
11538     * @param label The item's text label
11539     * @param icon_file The item's icon file
11540     * @param icon_type The item's icon type
11541     * @param func The callback to execute when the item is clicked
11542     * @param data The data to associate with the item for related functions
11543     */
11544    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);
11545    /**
11546     * This disables the entry's contextual (longpress) menu.
11547     *
11548     * @param obj The entry object
11549     * @param disabled If true, the menu is disabled
11550     */
11551    EAPI void         elm_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
11552    /**
11553     * This returns whether the entry's contextual (longpress) menu is
11554     * disabled.
11555     *
11556     * @param obj The entry object
11557     * @return If true, the menu is disabled
11558     */
11559    EAPI Eina_Bool    elm_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11560    /**
11561     * This appends a custom item provider to the list for that entry
11562     *
11563     * This appends the given callback. The list is walked from beginning to end
11564     * with each function called given the item href string in the text. If the
11565     * function returns an object handle other than NULL (it should create an
11566     * object to do this), then this object is used to replace that item. If
11567     * not the next provider is called until one provides an item object, or the
11568     * default provider in entry does.
11569     *
11570     * @param obj The entry object
11571     * @param func The function called to provide the item object
11572     * @param data The data passed to @p func
11573     *
11574     * @see @ref entry-items
11575     */
11576    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);
11577    /**
11578     * This prepends a custom item provider to the list for that entry
11579     *
11580     * This prepends the given callback. See elm_entry_item_provider_append() for
11581     * more information
11582     *
11583     * @param obj The entry object
11584     * @param func The function called to provide the item object
11585     * @param data The data passed to @p func
11586     */
11587    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);
11588    /**
11589     * This removes a custom item provider to the list for that entry
11590     *
11591     * This removes the given callback. See elm_entry_item_provider_append() for
11592     * more information
11593     *
11594     * @param obj The entry object
11595     * @param func The function called to provide the item object
11596     * @param data The data passed to @p func
11597     */
11598    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);
11599    /**
11600     * Append a filter function for text inserted in the entry
11601     *
11602     * Append the given callback to the list. This functions will be called
11603     * whenever any text is inserted into the entry, with the text to be inserted
11604     * as a parameter. The callback function is free to alter the text in any way
11605     * it wants, but it must remember to free the given pointer and update it.
11606     * If the new text is to be discarded, the function can free it and set its
11607     * text parameter to NULL. This will also prevent any following filters from
11608     * being called.
11609     *
11610     * @param obj The entry object
11611     * @param func The function to use as text filter
11612     * @param data User data to pass to @p func
11613     */
11614    EAPI void         elm_entry_text_filter_append(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11615    /**
11616     * Prepend a filter function for text insdrted in the entry
11617     *
11618     * Prepend the given callback to the list. See elm_entry_text_filter_append()
11619     * for more information
11620     *
11621     * @param obj The entry object
11622     * @param func The function to use as text filter
11623     * @param data User data to pass to @p func
11624     */
11625    EAPI void         elm_entry_text_filter_prepend(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11626    /**
11627     * Remove a filter from the list
11628     *
11629     * Removes the given callback from the filter list. See
11630     * elm_entry_text_filter_append() for more information.
11631     *
11632     * @param obj The entry object
11633     * @param func The filter function to remove
11634     * @param data The user data passed when adding the function
11635     */
11636    EAPI void         elm_entry_text_filter_remove(Evas_Object *obj, Elm_Entry_Filter_Cb func, void *data) EINA_ARG_NONNULL(1, 2);
11637    /**
11638     * This converts a markup (HTML-like) string into UTF-8.
11639     *
11640     * The returned string is a malloc'ed buffer and it should be freed when
11641     * not needed anymore.
11642     *
11643     * @param s The string (in markup) to be converted
11644     * @return The converted string (in UTF-8). It should be freed.
11645     */
11646    EAPI char        *elm_entry_markup_to_utf8(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
11647    /**
11648     * This converts a UTF-8 string into markup (HTML-like).
11649     *
11650     * The returned string is a malloc'ed buffer and it should be freed when
11651     * not needed anymore.
11652     *
11653     * @param s The string (in UTF-8) to be converted
11654     * @return The converted string (in markup). It should be freed.
11655     */
11656    EAPI char        *elm_entry_utf8_to_markup(const char *s) EINA_MALLOC EINA_WARN_UNUSED_RESULT;
11657    /**
11658     * This sets the file (and implicitly loads it) for the text to display and
11659     * then edit. All changes are written back to the file after a short delay if
11660     * the entry object is set to autosave (which is the default).
11661     *
11662     * If the entry had any other file set previously, any changes made to it
11663     * will be saved if the autosave feature is enabled, otherwise, the file
11664     * will be silently discarded and any non-saved changes will be lost.
11665     *
11666     * @param obj The entry object
11667     * @param file The path to the file to load and save
11668     * @param format The file format
11669     */
11670    EAPI void         elm_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
11671    /**
11672     * Gets the file being edited by the entry.
11673     *
11674     * This function can be used to retrieve any file set on the entry for
11675     * edition, along with the format used to load and save it.
11676     *
11677     * @param obj The entry object
11678     * @param file The path to the file to load and save
11679     * @param format The file format
11680     */
11681    EAPI void         elm_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
11682    /**
11683     * This function writes any changes made to the file set with
11684     * elm_entry_file_set()
11685     *
11686     * @param obj The entry object
11687     */
11688    EAPI void         elm_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
11689    /**
11690     * This sets the entry object to 'autosave' the loaded text file or not.
11691     *
11692     * @param obj The entry object
11693     * @param autosave Autosave the loaded file or not
11694     *
11695     * @see elm_entry_file_set()
11696     */
11697    EAPI void         elm_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
11698    /**
11699     * This gets the entry object's 'autosave' status.
11700     *
11701     * @param obj The entry object
11702     * @return Autosave the loaded file or not
11703     *
11704     * @see elm_entry_file_set()
11705     */
11706    EAPI Eina_Bool    elm_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11707    /**
11708     * Control pasting of text and images for the widget.
11709     *
11710     * Normally the entry allows both text and images to be pasted.  By setting
11711     * textonly to be true, this prevents images from being pasted.
11712     *
11713     * Note this only changes the behaviour of text.
11714     *
11715     * @param obj The entry object
11716     * @param textonly paste mode - EINA_TRUE is text only, EINA_FALSE is
11717     * text+image+other.
11718     */
11719    EAPI void         elm_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
11720    /**
11721     * Getting elm_entry text paste/drop mode.
11722     *
11723     * In textonly mode, only text may be pasted or dropped into the widget.
11724     *
11725     * @param obj The entry object
11726     * @return If the widget only accepts text from pastes.
11727     */
11728    EAPI Eina_Bool    elm_entry_cnp_textonly_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
11729    /**
11730     * Enable or disable scrolling in entry
11731     *
11732     * Normally the entry is not scrollable unless you enable it with this call.
11733     *
11734     * @param obj The entry object
11735     * @param scroll EINA_TRUE if it is to be scrollable, EINA_FALSE otherwise
11736     */
11737    EAPI void         elm_entry_scrollable_set(Evas_Object *obj, Eina_Bool scroll);
11738    /**
11739     * Get the scrollable state of the entry
11740     *
11741     * Normally the entry is not scrollable. This gets the scrollable state
11742     * of the entry. See elm_entry_scrollable_set() for more information.
11743     *
11744     * @param obj The entry object
11745     * @return The scrollable state
11746     */
11747    EAPI Eina_Bool    elm_entry_scrollable_get(const Evas_Object *obj);
11748    /**
11749     * This sets a widget to be displayed to the left of a scrolled entry.
11750     *
11751     * @param obj The scrolled entry object
11752     * @param icon The widget to display on the left side of the scrolled
11753     * entry.
11754     *
11755     * @note A previously set widget will be destroyed.
11756     * @note If the object being set does not have minimum size hints set,
11757     * it won't get properly displayed.
11758     *
11759     * @see elm_entry_end_set()
11760     */
11761    EAPI void         elm_entry_icon_set(Evas_Object *obj, Evas_Object *icon);
11762    /**
11763     * Gets the leftmost widget of the scrolled entry. This object is
11764     * owned by the scrolled entry and should not be modified.
11765     *
11766     * @param obj The scrolled entry object
11767     * @return the left widget inside the scroller
11768     */
11769    EAPI Evas_Object *elm_entry_icon_get(const Evas_Object *obj);
11770    /**
11771     * Unset the leftmost widget of the scrolled entry, unparenting and
11772     * returning it.
11773     *
11774     * @param obj The scrolled entry object
11775     * @return the previously set icon sub-object of this entry, on
11776     * success.
11777     *
11778     * @see elm_entry_icon_set()
11779     */
11780    EAPI Evas_Object *elm_entry_icon_unset(Evas_Object *obj);
11781    /**
11782     * Sets the visibility of the left-side widget of the scrolled entry,
11783     * set by elm_entry_icon_set().
11784     *
11785     * @param obj The scrolled entry object
11786     * @param setting EINA_TRUE if the object should be displayed,
11787     * EINA_FALSE if not.
11788     */
11789    EAPI void         elm_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting);
11790    /**
11791     * This sets a widget to be displayed to the end of a scrolled entry.
11792     *
11793     * @param obj The scrolled entry object
11794     * @param end The widget to display on the right side of the scrolled
11795     * entry.
11796     *
11797     * @note A previously set widget will be destroyed.
11798     * @note If the object being set does not have minimum size hints set,
11799     * it won't get properly displayed.
11800     *
11801     * @see elm_entry_icon_set
11802     */
11803    EAPI void         elm_entry_end_set(Evas_Object *obj, Evas_Object *end);
11804    /**
11805     * Gets the endmost widget of the scrolled entry. This object is owned
11806     * by the scrolled entry and should not be modified.
11807     *
11808     * @param obj The scrolled entry object
11809     * @return the right widget inside the scroller
11810     */
11811    EAPI Evas_Object *elm_entry_end_get(const Evas_Object *obj);
11812    /**
11813     * Unset the endmost widget of the scrolled entry, unparenting and
11814     * returning it.
11815     *
11816     * @param obj The scrolled entry object
11817     * @return the previously set icon sub-object of this entry, on
11818     * success.
11819     *
11820     * @see elm_entry_icon_set()
11821     */
11822    EAPI Evas_Object *elm_entry_end_unset(Evas_Object *obj);
11823    /**
11824     * Sets the visibility of the end widget of the scrolled entry, set by
11825     * elm_entry_end_set().
11826     *
11827     * @param obj The scrolled entry object
11828     * @param setting EINA_TRUE if the object should be displayed,
11829     * EINA_FALSE if not.
11830     */
11831    EAPI void         elm_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting);
11832    /**
11833     * This sets the scrolled entry's scrollbar policy (ie. enabling/disabling
11834     * them).
11835     *
11836     * Setting an entry to single-line mode with elm_entry_single_line_set()
11837     * will automatically disable the display of scrollbars when the entry
11838     * moves inside its scroller.
11839     *
11840     * @param obj The scrolled entry object
11841     * @param h The horizontal scrollbar policy to apply
11842     * @param v The vertical scrollbar policy to apply
11843     */
11844    EAPI void         elm_entry_scrollbar_policy_set(Evas_Object *obj, Elm_Scroller_Policy h, Elm_Scroller_Policy v);
11845    /**
11846     * This enables/disables bouncing within the entry.
11847     *
11848     * This function sets whether the entry will bounce when scrolling reaches
11849     * the end of the contained entry.
11850     *
11851     * @param obj The scrolled entry object
11852     * @param h The horizontal bounce state
11853     * @param v The vertical bounce state
11854     */
11855    EAPI void         elm_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce);
11856    /**
11857     * Get the bounce mode
11858     *
11859     * @param obj The Entry object
11860     * @param h_bounce Allow bounce horizontally
11861     * @param v_bounce Allow bounce vertically
11862     */
11863    EAPI void         elm_entry_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce);
11864
11865    /* pre-made filters for entries */
11866    /**
11867     * @typedef Elm_Entry_Filter_Limit_Size
11868     *
11869     * Data for the elm_entry_filter_limit_size() entry filter.
11870     */
11871    typedef struct _Elm_Entry_Filter_Limit_Size Elm_Entry_Filter_Limit_Size;
11872    /**
11873     * @struct _Elm_Entry_Filter_Limit_Size
11874     *
11875     * Data for the elm_entry_filter_limit_size() entry filter.
11876     */
11877    struct _Elm_Entry_Filter_Limit_Size
11878      {
11879         int max_char_count; /**< The maximum number of characters allowed. */
11880         int max_byte_count; /**< The maximum number of bytes allowed*/
11881      };
11882    /**
11883     * Filter inserted text based on user defined character and byte limits
11884     *
11885     * Add this filter to an entry to limit the characters that it will accept
11886     * based the the contents of the provided #Elm_Entry_Filter_Limit_Size.
11887     * The funtion works on the UTF-8 representation of the string, converting
11888     * it from the set markup, thus not accounting for any format in it.
11889     *
11890     * The user must create an #Elm_Entry_Filter_Limit_Size structure and pass
11891     * it as data when setting the filter. In it, it's possible to set limits
11892     * by character count or bytes (any of them is disabled if 0), and both can
11893     * be set at the same time. In that case, it first checks for characters,
11894     * then bytes.
11895     *
11896     * The function will cut the inserted text in order to allow only the first
11897     * number of characters that are still allowed. The cut is made in
11898     * characters, even when limiting by bytes, in order to always contain
11899     * valid ones and avoid half unicode characters making it in.
11900     *
11901     * This filter, like any others, does not apply when setting the entry text
11902     * directly with elm_object_text_set() (or the deprecated
11903     * elm_entry_entry_set()).
11904     */
11905    EAPI void         elm_entry_filter_limit_size(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 2, 3);
11906    /**
11907     * @typedef Elm_Entry_Filter_Accept_Set
11908     *
11909     * Data for the elm_entry_filter_accept_set() entry filter.
11910     */
11911    typedef struct _Elm_Entry_Filter_Accept_Set Elm_Entry_Filter_Accept_Set;
11912    /**
11913     * @struct _Elm_Entry_Filter_Accept_Set
11914     *
11915     * Data for the elm_entry_filter_accept_set() entry filter.
11916     */
11917    struct _Elm_Entry_Filter_Accept_Set
11918      {
11919         const char *accepted; /**< Set of characters accepted in the entry. */
11920         const char *rejected; /**< Set of characters rejected from the entry. */
11921      };
11922    /**
11923     * Filter inserted text based on accepted or rejected sets of characters
11924     *
11925     * Add this filter to an entry to restrict the set of accepted characters
11926     * based on the sets in the provided #Elm_Entry_Filter_Accept_Set.
11927     * This structure contains both accepted and rejected sets, but they are
11928     * mutually exclusive.
11929     *
11930     * The @c accepted set takes preference, so if it is set, the filter will
11931     * only work based on the accepted characters, ignoring anything in the
11932     * @c rejected value. If @c accepted is @c NULL, then @c rejected is used.
11933     *
11934     * In both cases, the function filters by matching utf8 characters to the
11935     * raw markup text, so it can be used to remove formatting tags.
11936     *
11937     * This filter, like any others, does not apply when setting the entry text
11938     * directly with elm_object_text_set() (or the deprecated
11939     * elm_entry_entry_set()).
11940     */
11941    EAPI void         elm_entry_filter_accept_set(void *data, Evas_Object *entry, char **text) EINA_ARG_NONNULL(1, 3);
11942    /**
11943     * Set the input panel layout of the entry
11944     *
11945     * @param obj The entry object
11946     * @param layout layout type
11947     */
11948    EAPI void elm_entry_input_panel_layout_set(Evas_Object *obj, Elm_Input_Panel_Layout layout) EINA_ARG_NONNULL(1);
11949    /**
11950     * Get the input panel layout of the entry
11951     *
11952     * @param obj The entry object
11953     * @return layout type
11954     *
11955     * @see elm_entry_input_panel_layout_set
11956     */
11957    EAPI Elm_Input_Panel_Layout elm_entry_input_panel_layout_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
11958    /**
11959     * Set the autocapitalization type on the immodule.
11960     *
11961     * @param obj The entry object
11962     * @param autocapital_type The type of autocapitalization
11963     */
11964    EAPI void         elm_entry_autocapital_type_set(Evas_Object *obj, Elm_Autocapital_Type autocapital_type) EINA_ARG_NONNULL(1);
11965    /**
11966     * Retrieve the autocapitalization type on the immodule.
11967     *
11968     * @param obj The entry object
11969     * @return autocapitalization type
11970     */
11971    EAPI Elm_Autocapital_Type elm_entry_autocapital_type_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
11972    /**
11973     * Sets the attribute to show the input panel automatically.
11974     *
11975     * @param obj The entry object
11976     * @param enabled If true, the input panel is appeared when entry is clicked or has a focus
11977     */
11978    EAPI void elm_entry_input_panel_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
11979    /**
11980     * Retrieve the attribute to show the input panel automatically.
11981     *
11982     * @param obj The entry object
11983     * @return EINA_TRUE if input panel will be appeared when the entry is clicked or has a focus, EINA_FALSE otherwise
11984     */
11985    EAPI Eina_Bool elm_entry_input_panel_enabled_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
11986
11987    EAPI void         elm_entry_background_color_set(Evas_Object *obj, unsigned int r, unsigned int g, unsigned int b, unsigned int a);
11988    EAPI void         elm_entry_autocapitalization_set(Evas_Object *obj, Eina_Bool autocap);
11989    EAPI void         elm_entry_autoperiod_set(Evas_Object *obj, Eina_Bool autoperiod);
11990    EAPI void         elm_entry_autoenable_returnkey_set(Evas_Object *obj, Eina_Bool on);
11991    EAPI Ecore_IMF_Context *elm_entry_imf_context_get(Evas_Object *obj);
11992    EAPI void         elm_entry_matchlist_set(Evas_Object *obj, Eina_List *match_list, Eina_Bool case_sensitive);
11993    EAPI void         elm_entry_magnifier_type_set(Evas_Object *obj, int type) EINA_ARG_NONNULL(1);
11994
11995    EINA_DEPRECATED EAPI void         elm_entry_wrap_width_set(Evas_Object *obj, Evas_Coord w);
11996    EINA_DEPRECATED EAPI Evas_Coord   elm_entry_wrap_width_get(const Evas_Object *obj);
11997    EINA_DEPRECATED EAPI void         elm_entry_fontsize_set(Evas_Object *obj, int fontsize);
11998    EINA_DEPRECATED EAPI void         elm_entry_text_color_set(Evas_Object *obj, unsigned int r, unsigned int g, unsigned int b, unsigned int a);
11999    EINA_DEPRECATED EAPI void         elm_entry_text_align_set(Evas_Object *obj, const char *alignmode);
12000
12001    /**
12002     * @}
12003     */
12004
12005    /* composite widgets - these basically put together basic widgets above
12006     * in convenient packages that do more than basic stuff */
12007
12008    /* anchorview */
12009    /**
12010     * @defgroup Anchorview Anchorview
12011     *
12012     * @image html img/widget/anchorview/preview-00.png
12013     * @image latex img/widget/anchorview/preview-00.eps
12014     *
12015     * Anchorview is for displaying text that contains markup with anchors
12016     * like <c>\<a href=1234\>something\</\></c> in it.
12017     *
12018     * Besides being styled differently, the anchorview widget provides the
12019     * necessary functionality so that clicking on these anchors brings up a
12020     * popup with user defined content such as "call", "add to contacts" or
12021     * "open web page". This popup is provided using the @ref Hover widget.
12022     *
12023     * This widget is very similar to @ref Anchorblock, so refer to that
12024     * widget for an example. The only difference Anchorview has is that the
12025     * widget is already provided with scrolling functionality, so if the
12026     * text set to it is too large to fit in the given space, it will scroll,
12027     * whereas the @ref Anchorblock widget will keep growing to ensure all the
12028     * text can be displayed.
12029     *
12030     * This widget emits the following signals:
12031     * @li "anchor,clicked": will be called when an anchor is clicked. The
12032     * @p event_info parameter on the callback will be a pointer of type
12033     * ::Elm_Entry_Anchorview_Info.
12034     *
12035     * See @ref Anchorblock for an example on how to use both of them.
12036     *
12037     * @see Anchorblock
12038     * @see Entry
12039     * @see Hover
12040     *
12041     * @{
12042     */
12043    /**
12044     * @typedef Elm_Entry_Anchorview_Info
12045     *
12046     * The info sent in the callback for "anchor,clicked" signals emitted by
12047     * the Anchorview widget.
12048     */
12049    typedef struct _Elm_Entry_Anchorview_Info Elm_Entry_Anchorview_Info;
12050    /**
12051     * @struct _Elm_Entry_Anchorview_Info
12052     *
12053     * The info sent in the callback for "anchor,clicked" signals emitted by
12054     * the Anchorview widget.
12055     */
12056    struct _Elm_Entry_Anchorview_Info
12057      {
12058         const char     *name; /**< Name of the anchor, as indicated in its href
12059                                    attribute */
12060         int             button; /**< The mouse button used to click on it */
12061         Evas_Object    *hover; /**< The hover object to use for the popup */
12062         struct {
12063              Evas_Coord    x, y, w, h;
12064         } anchor, /**< Geometry selection of text used as anchor */
12065           hover_parent; /**< Geometry of the object used as parent by the
12066                              hover */
12067         Eina_Bool       hover_left : 1; /**< Hint indicating if there's space
12068                                              for content on the left side of
12069                                              the hover. Before calling the
12070                                              callback, the widget will make the
12071                                              necessary calculations to check
12072                                              which sides are fit to be set with
12073                                              content, based on the position the
12074                                              hover is activated and its distance
12075                                              to the edges of its parent object
12076                                              */
12077         Eina_Bool       hover_right : 1; /**< Hint indicating content fits on
12078                                               the right side of the hover.
12079                                               See @ref hover_left */
12080         Eina_Bool       hover_top : 1; /**< Hint indicating content fits on top
12081                                             of the hover. See @ref hover_left */
12082         Eina_Bool       hover_bottom : 1; /**< Hint indicating content fits
12083                                                below the hover. See @ref
12084                                                hover_left */
12085      };
12086    /**
12087     * Add a new Anchorview object
12088     *
12089     * @param parent The parent object
12090     * @return The new object or NULL if it cannot be created
12091     */
12092    EAPI Evas_Object *elm_anchorview_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12093    /**
12094     * Set the text to show in the anchorview
12095     *
12096     * Sets the text of the anchorview to @p text. This text can include markup
12097     * format tags, including <c>\<a href=anchorname\></c> to begin a segment of
12098     * text that will be specially styled and react to click events, ended with
12099     * either of \</a\> or \</\>. When clicked, the anchor will emit an
12100     * "anchor,clicked" signal that you can attach a callback to with
12101     * evas_object_smart_callback_add(). The name of the anchor given in the
12102     * event info struct will be the one set in the href attribute, in this
12103     * case, anchorname.
12104     *
12105     * Other markup can be used to style the text in different ways, but it's
12106     * up to the style defined in the theme which tags do what.
12107     * @deprecated use elm_object_text_set() instead.
12108     */
12109    EINA_DEPRECATED EAPI void         elm_anchorview_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
12110    /**
12111     * Get the markup text set for the anchorview
12112     *
12113     * Retrieves the text set on the anchorview, with markup tags included.
12114     *
12115     * @param obj The anchorview object
12116     * @return The markup text set or @c NULL if nothing was set or an error
12117     * occurred
12118     * @deprecated use elm_object_text_set() instead.
12119     */
12120    EINA_DEPRECATED EAPI const char  *elm_anchorview_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12121    /**
12122     * Set the parent of the hover popup
12123     *
12124     * Sets the parent object to use by the hover created by the anchorview
12125     * when an anchor is clicked. See @ref Hover for more details on this.
12126     * If no parent is set, the same anchorview object will be used.
12127     *
12128     * @param obj The anchorview object
12129     * @param parent The object to use as parent for the hover
12130     */
12131    EAPI void         elm_anchorview_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
12132    /**
12133     * Get the parent of the hover popup
12134     *
12135     * Get the object used as parent for the hover created by the anchorview
12136     * widget. See @ref Hover for more details on this.
12137     *
12138     * @param obj The anchorview object
12139     * @return The object used as parent for the hover, NULL if none is set.
12140     */
12141    EAPI Evas_Object *elm_anchorview_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12142    /**
12143     * Set the style that the hover should use
12144     *
12145     * When creating the popup hover, anchorview will request that it's
12146     * themed according to @p style.
12147     *
12148     * @param obj The anchorview object
12149     * @param style The style to use for the underlying hover
12150     *
12151     * @see elm_object_style_set()
12152     */
12153    EAPI void         elm_anchorview_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
12154    /**
12155     * Get the style that the hover should use
12156     *
12157     * Get the style the hover created by anchorview will use.
12158     *
12159     * @param obj The anchorview object
12160     * @return The style to use by the hover. NULL means the default is used.
12161     *
12162     * @see elm_object_style_set()
12163     */
12164    EAPI const char  *elm_anchorview_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12165    /**
12166     * Ends the hover popup in the anchorview
12167     *
12168     * When an anchor is clicked, the anchorview widget will create a hover
12169     * object to use as a popup with user provided content. This function
12170     * terminates this popup, returning the anchorview to its normal state.
12171     *
12172     * @param obj The anchorview object
12173     */
12174    EAPI void         elm_anchorview_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
12175    /**
12176     * Set bouncing behaviour when the scrolled content reaches an edge
12177     *
12178     * Tell the internal scroller object whether it should bounce or not
12179     * when it reaches the respective edges for each axis.
12180     *
12181     * @param obj The anchorview object
12182     * @param h_bounce Whether to bounce or not in the horizontal axis
12183     * @param v_bounce Whether to bounce or not in the vertical axis
12184     *
12185     * @see elm_scroller_bounce_set()
12186     */
12187    EAPI void         elm_anchorview_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
12188    /**
12189     * Get the set bouncing behaviour of the internal scroller
12190     *
12191     * Get whether the internal scroller should bounce when the edge of each
12192     * axis is reached scrolling.
12193     *
12194     * @param obj The anchorview object
12195     * @param h_bounce Pointer where to store the bounce state of the horizontal
12196     *                 axis
12197     * @param v_bounce Pointer where to store the bounce state of the vertical
12198     *                 axis
12199     *
12200     * @see elm_scroller_bounce_get()
12201     */
12202    EAPI void         elm_anchorview_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
12203    /**
12204     * Appends a custom item provider to the given anchorview
12205     *
12206     * Appends the given function to the list of items providers. This list is
12207     * called, one function at a time, with the given @p data pointer, the
12208     * anchorview object and, in the @p item parameter, the item name as
12209     * referenced in its href string. Following functions in the list will be
12210     * called in order until one of them returns something different to NULL,
12211     * which should be an Evas_Object which will be used in place of the item
12212     * element.
12213     *
12214     * Items in the markup text take the form \<item relsize=16x16 vsize=full
12215     * href=item/name\>\</item\>
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     * @see elm_entry_item_provider_append()
12222     */
12223    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);
12224    /**
12225     * Prepend a custom item provider to the given anchorview
12226     *
12227     * Like elm_anchorview_item_provider_append(), but it adds the function
12228     * @p func to the beginning of the list, instead of the end.
12229     *
12230     * @param obj The anchorview object
12231     * @param func The function to add to the list of providers
12232     * @param data User data that will be passed to the callback function
12233     */
12234    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);
12235    /**
12236     * Remove a custom item provider from the list of the given anchorview
12237     *
12238     * Removes the function and data pairing that matches @p func and @p data.
12239     * That is, unless the same function and same user data are given, the
12240     * function will not be removed from the list. This allows us to add the
12241     * same callback several times, with different @p data pointers and be
12242     * able to remove them later without conflicts.
12243     *
12244     * @param obj The anchorview object
12245     * @param func The function to remove from the list
12246     * @param data The data matching the function to remove from the list
12247     */
12248    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);
12249    /**
12250     * @}
12251     */
12252
12253    /* anchorblock */
12254    /**
12255     * @defgroup Anchorblock Anchorblock
12256     *
12257     * @image html img/widget/anchorblock/preview-00.png
12258     * @image latex img/widget/anchorblock/preview-00.eps
12259     *
12260     * Anchorblock is for displaying text that contains markup with anchors
12261     * like <c>\<a href=1234\>something\</\></c> in it.
12262     *
12263     * Besides being styled differently, the anchorblock widget provides the
12264     * necessary functionality so that clicking on these anchors brings up a
12265     * popup with user defined content such as "call", "add to contacts" or
12266     * "open web page". This popup is provided using the @ref Hover widget.
12267     *
12268     * This widget emits the following signals:
12269     * @li "anchor,clicked": will be called when an anchor is clicked. The
12270     * @p event_info parameter on the callback will be a pointer of type
12271     * ::Elm_Entry_Anchorblock_Info.
12272     *
12273     * @see Anchorview
12274     * @see Entry
12275     * @see Hover
12276     *
12277     * Since examples are usually better than plain words, we might as well
12278     * try @ref tutorial_anchorblock_example "one".
12279     */
12280    /**
12281     * @addtogroup Anchorblock
12282     * @{
12283     */
12284    /**
12285     * @typedef Elm_Entry_Anchorblock_Info
12286     *
12287     * The info sent in the callback for "anchor,clicked" signals emitted by
12288     * the Anchorblock widget.
12289     */
12290    typedef struct _Elm_Entry_Anchorblock_Info Elm_Entry_Anchorblock_Info;
12291    /**
12292     * @struct _Elm_Entry_Anchorblock_Info
12293     *
12294     * The info sent in the callback for "anchor,clicked" signals emitted by
12295     * the Anchorblock widget.
12296     */
12297    struct _Elm_Entry_Anchorblock_Info
12298      {
12299         const char     *name; /**< Name of the anchor, as indicated in its href
12300                                    attribute */
12301         int             button; /**< The mouse button used to click on it */
12302         Evas_Object    *hover; /**< The hover object to use for the popup */
12303         struct {
12304              Evas_Coord    x, y, w, h;
12305         } anchor, /**< Geometry selection of text used as anchor */
12306           hover_parent; /**< Geometry of the object used as parent by the
12307                              hover */
12308         Eina_Bool       hover_left : 1; /**< Hint indicating if there's space
12309                                              for content on the left side of
12310                                              the hover. Before calling the
12311                                              callback, the widget will make the
12312                                              necessary calculations to check
12313                                              which sides are fit to be set with
12314                                              content, based on the position the
12315                                              hover is activated and its distance
12316                                              to the edges of its parent object
12317                                              */
12318         Eina_Bool       hover_right : 1; /**< Hint indicating content fits on
12319                                               the right side of the hover.
12320                                               See @ref hover_left */
12321         Eina_Bool       hover_top : 1; /**< Hint indicating content fits on top
12322                                             of the hover. See @ref hover_left */
12323         Eina_Bool       hover_bottom : 1; /**< Hint indicating content fits
12324                                                below the hover. See @ref
12325                                                hover_left */
12326      };
12327    /**
12328     * Add a new Anchorblock object
12329     *
12330     * @param parent The parent object
12331     * @return The new object or NULL if it cannot be created
12332     */
12333    EAPI Evas_Object *elm_anchorblock_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12334    /**
12335     * Set the text to show in the anchorblock
12336     *
12337     * Sets the text of the anchorblock to @p text. This text can include markup
12338     * format tags, including <c>\<a href=anchorname\></a></c> to begin a segment
12339     * of text that will be specially styled and react to click events, ended
12340     * with either of \</a\> or \</\>. When clicked, the anchor will emit an
12341     * "anchor,clicked" signal that you can attach a callback to with
12342     * evas_object_smart_callback_add(). The name of the anchor given in the
12343     * event info struct will be the one set in the href attribute, in this
12344     * case, anchorname.
12345     *
12346     * Other markup can be used to style the text in different ways, but it's
12347     * up to the style defined in the theme which tags do what.
12348     * @deprecated use elm_object_text_set() instead.
12349     */
12350    EINA_DEPRECATED EAPI void         elm_anchorblock_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1);
12351    /**
12352     * Get the markup text set for the anchorblock
12353     *
12354     * Retrieves the text set on the anchorblock, with markup tags included.
12355     *
12356     * @param obj The anchorblock object
12357     * @return The markup text set or @c NULL if nothing was set or an error
12358     * occurred
12359     * @deprecated use elm_object_text_set() instead.
12360     */
12361    EINA_DEPRECATED EAPI const char  *elm_anchorblock_text_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12362    /**
12363     * Set the parent of the hover popup
12364     *
12365     * Sets the parent object to use by the hover created by the anchorblock
12366     * when an anchor is clicked. See @ref Hover for more details on this.
12367     *
12368     * @param obj The anchorblock object
12369     * @param parent The object to use as parent for the hover
12370     */
12371    EAPI void         elm_anchorblock_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
12372    /**
12373     * Get the parent of the hover popup
12374     *
12375     * Get the object used as parent for the hover created by the anchorblock
12376     * widget. See @ref Hover for more details on this.
12377     * If no parent is set, the same anchorblock object will be used.
12378     *
12379     * @param obj The anchorblock object
12380     * @return The object used as parent for the hover, NULL if none is set.
12381     */
12382    EAPI Evas_Object *elm_anchorblock_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12383    /**
12384     * Set the style that the hover should use
12385     *
12386     * When creating the popup hover, anchorblock will request that it's
12387     * themed according to @p style.
12388     *
12389     * @param obj The anchorblock object
12390     * @param style The style to use for the underlying hover
12391     *
12392     * @see elm_object_style_set()
12393     */
12394    EAPI void         elm_anchorblock_hover_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
12395    /**
12396     * Get the style that the hover should use
12397     *
12398     * Get the style, the hover created by anchorblock will use.
12399     *
12400     * @param obj The anchorblock object
12401     * @return The style to use by the hover. NULL means the default is used.
12402     *
12403     * @see elm_object_style_set()
12404     */
12405    EAPI const char  *elm_anchorblock_hover_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12406    /**
12407     * Ends the hover popup in the anchorblock
12408     *
12409     * When an anchor is clicked, the anchorblock widget will create a hover
12410     * object to use as a popup with user provided content. This function
12411     * terminates this popup, returning the anchorblock to its normal state.
12412     *
12413     * @param obj The anchorblock object
12414     */
12415    EAPI void         elm_anchorblock_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
12416    /**
12417     * Appends a custom item provider to the given anchorblock
12418     *
12419     * Appends the given function to the list of items providers. This list is
12420     * called, one function at a time, with the given @p data pointer, the
12421     * anchorblock object and, in the @p item parameter, the item name as
12422     * referenced in its href string. Following functions in the list will be
12423     * called in order until one of them returns something different to NULL,
12424     * which should be an Evas_Object which will be used in place of the item
12425     * element.
12426     *
12427     * Items in the markup text take the form \<item relsize=16x16 vsize=full
12428     * href=item/name\>\</item\>
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     * @see elm_entry_item_provider_append()
12435     */
12436    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);
12437    /**
12438     * Prepend a custom item provider to the given anchorblock
12439     *
12440     * Like elm_anchorblock_item_provider_append(), but it adds the function
12441     * @p func to the beginning of the list, instead of the end.
12442     *
12443     * @param obj The anchorblock object
12444     * @param func The function to add to the list of providers
12445     * @param data User data that will be passed to the callback function
12446     */
12447    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);
12448    /**
12449     * Remove a custom item provider from the list of the given anchorblock
12450     *
12451     * Removes the function and data pairing that matches @p func and @p data.
12452     * That is, unless the same function and same user data are given, the
12453     * function will not be removed from the list. This allows us to add the
12454     * same callback several times, with different @p data pointers and be
12455     * able to remove them later without conflicts.
12456     *
12457     * @param obj The anchorblock object
12458     * @param func The function to remove from the list
12459     * @param data The data matching the function to remove from the list
12460     */
12461    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);
12462    /**
12463     * @}
12464     */
12465
12466    /**
12467     * @defgroup Bubble Bubble
12468     *
12469     * @image html img/widget/bubble/preview-00.png
12470     * @image latex img/widget/bubble/preview-00.eps
12471     * @image html img/widget/bubble/preview-01.png
12472     * @image latex img/widget/bubble/preview-01.eps
12473     * @image html img/widget/bubble/preview-02.png
12474     * @image latex img/widget/bubble/preview-02.eps
12475     *
12476     * @brief The Bubble is a widget to show text similar to how speech is
12477     * represented in comics.
12478     *
12479     * The bubble widget contains 5 important visual elements:
12480     * @li The frame is a rectangle with rounded edjes and an "arrow".
12481     * @li The @p icon is an image to which the frame's arrow points to.
12482     * @li The @p label is a text which appears to the right of the icon if the
12483     * corner is "top_left" or "bottom_left" and is right aligned to the frame
12484     * otherwise.
12485     * @li The @p info is a text which appears to the right of the label. Info's
12486     * font is of a ligther color than label.
12487     * @li The @p content is an evas object that is shown inside the frame.
12488     *
12489     * The position of the arrow, icon, label and info depends on which corner is
12490     * selected. The four available corners are:
12491     * @li "top_left" - Default
12492     * @li "top_right"
12493     * @li "bottom_left"
12494     * @li "bottom_right"
12495     *
12496     * Signals that you can add callbacks for are:
12497     * @li "clicked" - This is called when a user has clicked the bubble.
12498     *
12499     * Default contents parts of the bubble that you can use for are:
12500     * @li "default" - A content of the bubble
12501     * @li "icon" - An icon of the bubble
12502     *
12503     * Default text parts of the button widget that you can use for are:
12504     * @li NULL - Label of the bubble
12505     * 
12506          * For an example of using a buble see @ref bubble_01_example_page "this".
12507     *
12508     * @{
12509     */
12510
12511    /**
12512     * Add a new bubble to the parent
12513     *
12514     * @param parent The parent object
12515     * @return The new object or NULL if it cannot be created
12516     *
12517     * This function adds a text bubble to the given parent evas object.
12518     */
12519    EAPI Evas_Object *elm_bubble_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12520    /**
12521     * Set the label of the bubble
12522     *
12523     * @param obj The bubble object
12524     * @param label The string to set in the label
12525     *
12526     * This function sets the title of the bubble. Where this appears depends on
12527     * the selected corner.
12528     * @deprecated use elm_object_text_set() instead.
12529     */
12530    EINA_DEPRECATED EAPI void         elm_bubble_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
12531    /**
12532     * Get the label of the bubble
12533     *
12534     * @param obj The bubble object
12535     * @return The string of set in the label
12536     *
12537     * This function gets the title of the bubble.
12538     * @deprecated use elm_object_text_get() instead.
12539     */
12540    EINA_DEPRECATED EAPI const char  *elm_bubble_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12541    /**
12542     * Set the info of the bubble
12543     *
12544     * @param obj The bubble object
12545     * @param info The given info about the bubble
12546     *
12547     * This function sets the info of the bubble. Where this appears depends on
12548     * the selected corner.
12549     * @deprecated use elm_object_part_text_set() instead. (with "info" as the parameter).
12550     */
12551    EINA_DEPRECATED EAPI void         elm_bubble_info_set(Evas_Object *obj, const char *info) EINA_ARG_NONNULL(1);
12552    /**
12553     * Get the info of the bubble
12554     *
12555     * @param obj The bubble object
12556     *
12557     * @return The "info" string of the bubble
12558     *
12559     * This function gets the info text.
12560     * @deprecated use elm_object_part_text_get() instead. (with "info" as the parameter).
12561     */
12562    EINA_DEPRECATED EAPI const char  *elm_bubble_info_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12563    /**
12564     * Set the content to be shown in the bubble
12565     *
12566     * Once the content object is set, a previously set one will be deleted.
12567     * If you want to keep the old content object, use the
12568     * elm_bubble_content_unset() function.
12569     *
12570     * @param obj The bubble object
12571     * @param content The given content of the bubble
12572     *
12573     * This function sets the content shown on the middle of the bubble.
12574     * 
12575     * @deprecated use elm_object_content_set() instead
12576     *
12577     */
12578    WILL_DEPRECATE  EAPI void         elm_bubble_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
12579    /**
12580     * Get the content shown in the bubble
12581     *
12582     * Return the content object which is set for this widget.
12583     *
12584     * @param obj The bubble object
12585     * @return The content that is being used
12586     *
12587     * @deprecated use elm_object_content_get() instead
12588     *
12589     */
12590    WILL_DEPRECATE  EAPI Evas_Object *elm_bubble_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12591    /**
12592     * Unset the content shown in the bubble
12593     *
12594     * Unparent and return the content object which was set for this widget.
12595     *
12596     * @param obj The bubble object
12597     * @return The content that was being used
12598     *
12599     * @deprecated use elm_object_content_unset() instead
12600     *
12601     */
12602    WILL_DEPRECATE  EAPI Evas_Object *elm_bubble_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12603    /**
12604     * Set the icon of the bubble
12605     *
12606     * Once the icon object is set, a previously set one will be deleted.
12607     * If you want to keep the old content object, use the
12608     * elm_icon_content_unset() function.
12609     *
12610     * @param obj The bubble object
12611     * @param icon The given icon for the bubble
12612     *
12613     * @deprecated use elm_object_part_content_set() instead
12614     *
12615     */
12616    EINA_DEPRECATED EAPI void         elm_bubble_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
12617    /**
12618     * Get the icon of the bubble
12619     *
12620     * @param obj The bubble object
12621     * @return The icon for the bubble
12622     *
12623     * This function gets the icon shown on the top left of bubble.
12624     *
12625     * @deprecated use elm_object_part_content_get() instead
12626     *
12627     */
12628    EINA_DEPRECATED EAPI Evas_Object *elm_bubble_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12629    /**
12630     * Unset the icon of the bubble
12631     *
12632     * Unparent and return the icon object which was set for this widget.
12633     *
12634     * @param obj The bubble object
12635     * @return The icon that was being used
12636     *
12637     * @deprecated use elm_object_part_content_unset() instead
12638     *
12639     */
12640    EINA_DEPRECATED EAPI Evas_Object *elm_bubble_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12641    /**
12642     * Set the corner of the bubble
12643     *
12644     * @param obj The bubble object.
12645     * @param corner The given corner for the bubble.
12646     *
12647     * This function sets the corner of the bubble. The corner will be used to
12648     * determine where the arrow in the frame points to and where label, icon and
12649     * info are shown.
12650     *
12651     * Possible values for corner are:
12652     * @li "top_left" - Default
12653     * @li "top_right"
12654     * @li "bottom_left"
12655     * @li "bottom_right"
12656     */
12657    EAPI void         elm_bubble_corner_set(Evas_Object *obj, const char *corner) EINA_ARG_NONNULL(1, 2);
12658    /**
12659     * Get the corner of the bubble
12660     *
12661     * @param obj The bubble object.
12662     * @return The given corner for the bubble.
12663     *
12664     * This function gets the selected corner of the bubble.
12665     */
12666    EAPI const char  *elm_bubble_corner_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
12667
12668    EINA_DEPRECATED EAPI void         elm_bubble_sweep_layout_set(Evas_Object *obj, Evas_Object *sweep) EINA_ARG_NONNULL(1);
12669    EINA_DEPRECATED EAPI Evas_Object *elm_bubble_sweep_layout_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
12670
12671    /**
12672     * @}
12673     */
12674
12675    /**
12676     * @defgroup Photo Photo
12677     *
12678     * For displaying the photo of a person (contact). Simple, yet
12679     * with a very specific purpose.
12680     *
12681     * Signals that you can add callbacks for are:
12682     *
12683     * "clicked" - This is called when a user has clicked the photo
12684     * "drag,start" - Someone started dragging the image out of the object
12685     * "drag,end" - Dragged item was dropped (somewhere)
12686     *
12687     * @{
12688     */
12689
12690    /**
12691     * Add a new photo to the parent
12692     *
12693     * @param parent The parent object
12694     * @return The new object or NULL if it cannot be created
12695     *
12696     * @ingroup Photo
12697     */
12698    EAPI Evas_Object *elm_photo_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
12699
12700    /**
12701     * Set the file that will be used as photo
12702     *
12703     * @param obj The photo object
12704     * @param file The path to file that will be used as photo
12705     *
12706     * @return (1 = success, 0 = error)
12707     *
12708     * @ingroup Photo
12709     */
12710    EAPI Eina_Bool    elm_photo_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
12711
12712     /**
12713     * Set the file that will be used as thumbnail in the photo.
12714     *
12715     * @param obj The photo object.
12716     * @param file The path to file that will be used as thumb.
12717     * @param group The key used in case of an EET file.
12718     *
12719     * @ingroup Photo
12720     */
12721    EAPI void         elm_photo_thumb_set(const Evas_Object *obj, const char *file, const char *group) EINA_ARG_NONNULL(1, 2);
12722
12723    /**
12724     * Set the size that will be used on the photo
12725     *
12726     * @param obj The photo object
12727     * @param size The size that the photo will be
12728     *
12729     * @ingroup Photo
12730     */
12731    EAPI void         elm_photo_size_set(Evas_Object *obj, int size) EINA_ARG_NONNULL(1);
12732
12733    /**
12734     * Set if the photo should be completely visible or not.
12735     *
12736     * @param obj The photo object
12737     * @param fill if true the photo will be completely visible
12738     *
12739     * @ingroup Photo
12740     */
12741    EAPI void         elm_photo_fill_inside_set(Evas_Object *obj, Eina_Bool fill) EINA_ARG_NONNULL(1);
12742
12743    /**
12744     * Set editability of the photo.
12745     *
12746     * An editable photo can be dragged to or from, and can be cut or
12747     * pasted too.  Note that pasting an image or dropping an item on
12748     * the image will delete the existing content.
12749     *
12750     * @param obj The photo object.
12751     * @param set To set of clear editablity.
12752     */
12753    EAPI void         elm_photo_editable_set(Evas_Object *obj, Eina_Bool set) EINA_ARG_NONNULL(1);
12754
12755    /**
12756     * @}
12757     */
12758
12759    /* gesture layer */
12760    /**
12761     * @defgroup Elm_Gesture_Layer Gesture Layer
12762     * Gesture Layer Usage:
12763     *
12764     * Use Gesture Layer to detect gestures.
12765     * The advantage is that you don't have to implement
12766     * gesture detection, just set callbacks of gesture state.
12767     * By using gesture layer we make standard interface.
12768     *
12769     * In order to use Gesture Layer you start with @ref elm_gesture_layer_add
12770     * with a parent object parameter.
12771     * Next 'activate' gesture layer with a @ref elm_gesture_layer_attach
12772     * call. Usually with same object as target (2nd parameter).
12773     *
12774     * Now you need to tell gesture layer what gestures you follow.
12775     * This is done with @ref elm_gesture_layer_cb_set call.
12776     * By setting the callback you actually saying to gesture layer:
12777     * I would like to know when the gesture @ref Elm_Gesture_Types
12778     * switches to state @ref Elm_Gesture_State.
12779     *
12780     * Next, you need to implement the actual action that follows the input
12781     * in your callback.
12782     *
12783     * Note that if you like to stop being reported about a gesture, just set
12784     * all callbacks referring this gesture to NULL.
12785     * (again with @ref elm_gesture_layer_cb_set)
12786     *
12787     * The information reported by gesture layer to your callback is depending
12788     * on @ref Elm_Gesture_Types:
12789     * @ref Elm_Gesture_Taps_Info is the info reported for tap gestures:
12790     * @ref ELM_GESTURE_N_TAPS, @ref ELM_GESTURE_N_LONG_TAPS,
12791     * @ref ELM_GESTURE_N_DOUBLE_TAPS, @ref ELM_GESTURE_N_TRIPLE_TAPS.
12792     *
12793     * @ref Elm_Gesture_Momentum_Info is info reported for momentum gestures:
12794     * @ref ELM_GESTURE_MOMENTUM.
12795     *
12796     * @ref Elm_Gesture_Line_Info is the info reported for line gestures:
12797     * (this also contains @ref Elm_Gesture_Momentum_Info internal structure)
12798     * @ref ELM_GESTURE_N_LINES, @ref ELM_GESTURE_N_FLICKS.
12799     * Note that we consider a flick as a line-gesture that should be completed
12800     * in flick-time-limit as defined in @ref Config.
12801     *
12802     * @ref Elm_Gesture_Zoom_Info is the info reported for @ref ELM_GESTURE_ZOOM gesture.
12803     *
12804     * @ref Elm_Gesture_Rotate_Info is the info reported for @ref ELM_GESTURE_ROTATE gesture.
12805     *
12806     *
12807     * Gesture Layer Tweaks:
12808     *
12809     * Note that line, flick, gestures can start without the need to remove fingers from surface.
12810     * When user fingers rests on same-spot gesture is ended and starts again when fingers moved.
12811     *
12812     * Setting glayer_continues_enable to false in @ref Config will change this behavior
12813     * so gesture starts when user touches (a *DOWN event) touch-surface
12814     * and ends when no fingers touches surface (a *UP event).
12815     */
12816
12817    /**
12818     * @enum _Elm_Gesture_Types
12819     * Enum of supported gesture types.
12820     * @ingroup Elm_Gesture_Layer
12821     */
12822    enum _Elm_Gesture_Types
12823      {
12824         ELM_GESTURE_FIRST = 0,
12825
12826         ELM_GESTURE_N_TAPS, /**< N fingers single taps */
12827         ELM_GESTURE_N_LONG_TAPS, /**< N fingers single long-taps */
12828         ELM_GESTURE_N_DOUBLE_TAPS, /**< N fingers double-single taps */
12829         ELM_GESTURE_N_TRIPLE_TAPS, /**< N fingers triple-single taps */
12830
12831         ELM_GESTURE_MOMENTUM, /**< Reports momentum in the dircetion of move */
12832
12833         ELM_GESTURE_N_LINES, /**< N fingers line gesture */
12834         ELM_GESTURE_N_FLICKS, /**< N fingers flick gesture */
12835
12836         ELM_GESTURE_ZOOM, /**< Zoom */
12837         ELM_GESTURE_ROTATE, /**< Rotate */
12838
12839         ELM_GESTURE_LAST
12840      };
12841
12842    /**
12843     * @typedef Elm_Gesture_Types
12844     * gesture types enum
12845     * @ingroup Elm_Gesture_Layer
12846     */
12847    typedef enum _Elm_Gesture_Types Elm_Gesture_Types;
12848
12849    /**
12850     * @enum _Elm_Gesture_State
12851     * Enum of gesture states.
12852     * @ingroup Elm_Gesture_Layer
12853     */
12854    enum _Elm_Gesture_State
12855      {
12856         ELM_GESTURE_STATE_UNDEFINED = -1, /**< Gesture not STARTed */
12857         ELM_GESTURE_STATE_START,          /**< Gesture STARTed     */
12858         ELM_GESTURE_STATE_MOVE,           /**< Gesture is ongoing  */
12859         ELM_GESTURE_STATE_END,            /**< Gesture completed   */
12860         ELM_GESTURE_STATE_ABORT    /**< Onging gesture was ABORTed */
12861      };
12862
12863    /**
12864     * @typedef Elm_Gesture_State
12865     * gesture states enum
12866     * @ingroup Elm_Gesture_Layer
12867     */
12868    typedef enum _Elm_Gesture_State Elm_Gesture_State;
12869
12870    /**
12871     * @struct _Elm_Gesture_Taps_Info
12872     * Struct holds taps info for user
12873     * @ingroup Elm_Gesture_Layer
12874     */
12875    struct _Elm_Gesture_Taps_Info
12876      {
12877         Evas_Coord x, y;         /**< Holds center point between fingers */
12878         unsigned int n;          /**< Number of fingers tapped           */
12879         unsigned int timestamp;  /**< event timestamp       */
12880      };
12881
12882    /**
12883     * @typedef Elm_Gesture_Taps_Info
12884     * holds taps info for user
12885     * @ingroup Elm_Gesture_Layer
12886     */
12887    typedef struct _Elm_Gesture_Taps_Info Elm_Gesture_Taps_Info;
12888
12889    /**
12890     * @struct _Elm_Gesture_Momentum_Info
12891     * Struct holds momentum info for user
12892     * x1 and y1 are not necessarily in sync
12893     * x1 holds x value of x direction starting point
12894     * and same holds for y1.
12895     * This is noticeable when doing V-shape movement
12896     * @ingroup Elm_Gesture_Layer
12897     */
12898    struct _Elm_Gesture_Momentum_Info
12899      {  /* Report line ends, timestamps, and momentum computed        */
12900         Evas_Coord x1; /**< Final-swipe direction starting point on X */
12901         Evas_Coord y1; /**< Final-swipe direction starting point on Y */
12902         Evas_Coord x2; /**< Final-swipe direction ending point on X   */
12903         Evas_Coord y2; /**< Final-swipe direction ending point on Y   */
12904
12905         unsigned int tx; /**< Timestamp of start of final x-swipe */
12906         unsigned int ty; /**< Timestamp of start of final y-swipe */
12907
12908         Evas_Coord mx; /**< Momentum on X */
12909         Evas_Coord my; /**< Momentum on Y */
12910
12911         unsigned int n;  /**< Number of fingers */
12912      };
12913
12914    /**
12915     * @typedef Elm_Gesture_Momentum_Info
12916     * holds momentum info for user
12917     * @ingroup Elm_Gesture_Layer
12918     */
12919     typedef struct _Elm_Gesture_Momentum_Info Elm_Gesture_Momentum_Info;
12920
12921    /**
12922     * @struct _Elm_Gesture_Line_Info
12923     * Struct holds line info for user
12924     * @ingroup Elm_Gesture_Layer
12925     */
12926    struct _Elm_Gesture_Line_Info
12927      {  /* Report line ends, timestamps, and momentum computed      */
12928         Elm_Gesture_Momentum_Info momentum; /**< Line momentum info */
12929         double angle;              /**< Angle (direction) of lines  */
12930      };
12931
12932    /**
12933     * @typedef Elm_Gesture_Line_Info
12934     * Holds line info for user
12935     * @ingroup Elm_Gesture_Layer
12936     */
12937     typedef struct  _Elm_Gesture_Line_Info Elm_Gesture_Line_Info;
12938
12939    /**
12940     * @struct _Elm_Gesture_Zoom_Info
12941     * Struct holds zoom info for user
12942     * @ingroup Elm_Gesture_Layer
12943     */
12944    struct _Elm_Gesture_Zoom_Info
12945      {
12946         Evas_Coord x, y;       /**< Holds zoom center point reported to user  */
12947         Evas_Coord radius; /**< Holds radius between fingers reported to user */
12948         double zoom;            /**< Zoom value: 1.0 means no zoom             */
12949         double momentum;        /**< Zoom momentum: zoom growth per second (NOT YET SUPPORTED) */
12950      };
12951
12952    /**
12953     * @typedef Elm_Gesture_Zoom_Info
12954     * Holds zoom info for user
12955     * @ingroup Elm_Gesture_Layer
12956     */
12957    typedef struct _Elm_Gesture_Zoom_Info Elm_Gesture_Zoom_Info;
12958
12959    /**
12960     * @struct _Elm_Gesture_Rotate_Info
12961     * Struct holds rotation info for user
12962     * @ingroup Elm_Gesture_Layer
12963     */
12964    struct _Elm_Gesture_Rotate_Info
12965      {
12966         Evas_Coord x, y;   /**< Holds zoom center point reported to user      */
12967         Evas_Coord radius; /**< Holds radius between fingers reported to user */
12968         double base_angle; /**< Holds start-angle */
12969         double angle;      /**< Rotation value: 0.0 means no rotation         */
12970         double momentum;   /**< Rotation momentum: rotation done per second (NOT YET SUPPORTED) */
12971      };
12972
12973    /**
12974     * @typedef Elm_Gesture_Rotate_Info
12975     * Holds rotation info for user
12976     * @ingroup Elm_Gesture_Layer
12977     */
12978    typedef struct _Elm_Gesture_Rotate_Info Elm_Gesture_Rotate_Info;
12979
12980    /**
12981     * @typedef Elm_Gesture_Event_Cb
12982     * User callback used to stream gesture info from gesture layer
12983     * @param data user data
12984     * @param event_info gesture report info
12985     * Returns a flag field to be applied on the causing event.
12986     * You should probably return EVAS_EVENT_FLAG_ON_HOLD if your widget acted
12987     * upon the event, in an irreversible way.
12988     *
12989     * @ingroup Elm_Gesture_Layer
12990     */
12991    typedef Evas_Event_Flags (*Elm_Gesture_Event_Cb) (void *data, void *event_info);
12992
12993    /**
12994     * Use function to set callbacks to be notified about
12995     * change of state of gesture.
12996     * When a user registers a callback with this function
12997     * this means this gesture has to be tested.
12998     *
12999     * When ALL callbacks for a gesture are set to NULL
13000     * it means user isn't interested in gesture-state
13001     * and it will not be tested.
13002     *
13003     * @param obj Pointer to gesture-layer.
13004     * @param idx The gesture you would like to track its state.
13005     * @param cb callback function pointer.
13006     * @param cb_type what event this callback tracks: START, MOVE, END, ABORT.
13007     * @param data user info to be sent to callback (usually, Smart Data)
13008     *
13009     * @ingroup Elm_Gesture_Layer
13010     */
13011    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);
13012
13013    /**
13014     * Call this function to get repeat-events settings.
13015     *
13016     * @param obj Pointer to gesture-layer.
13017     *
13018     * @return repeat events settings.
13019     * @see elm_gesture_layer_hold_events_set()
13020     * @ingroup Elm_Gesture_Layer
13021     */
13022    EAPI Eina_Bool elm_gesture_layer_hold_events_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
13023
13024    /**
13025     * This function called in order to make gesture-layer repeat events.
13026     * Set this of you like to get the raw events only if gestures were not detected.
13027     * Clear this if you like gesture layer to fwd events as testing gestures.
13028     *
13029     * @param obj Pointer to gesture-layer.
13030     * @param r Repeat: TRUE/FALSE
13031     *
13032     * @ingroup Elm_Gesture_Layer
13033     */
13034    EAPI void elm_gesture_layer_hold_events_set(Evas_Object *obj, Eina_Bool r) EINA_ARG_NONNULL(1);
13035
13036    /**
13037     * This function sets step-value for zoom action.
13038     * Set step to any positive value.
13039     * Cancel step setting by setting to 0.0
13040     *
13041     * @param obj Pointer to gesture-layer.
13042     * @param s new zoom step value.
13043     *
13044     * @ingroup Elm_Gesture_Layer
13045     */
13046    EAPI void elm_gesture_layer_zoom_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
13047
13048    /**
13049     * This function sets step-value for rotate action.
13050     * Set step to any positive value.
13051     * Cancel step setting by setting to 0.0
13052     *
13053     * @param obj Pointer to gesture-layer.
13054     * @param s new roatate step value.
13055     *
13056     * @ingroup Elm_Gesture_Layer
13057     */
13058    EAPI void elm_gesture_layer_rotate_step_set(Evas_Object *obj, double s) EINA_ARG_NONNULL(1);
13059
13060    /**
13061     * This function called to attach gesture-layer to an Evas_Object.
13062     * @param obj Pointer to gesture-layer.
13063     * @param t Pointer to underlying object (AKA Target)
13064     *
13065     * @return TRUE, FALSE on success, failure.
13066     *
13067     * @ingroup Elm_Gesture_Layer
13068     */
13069    EAPI Eina_Bool elm_gesture_layer_attach(Evas_Object *obj, Evas_Object *t) EINA_ARG_NONNULL(1, 2);
13070
13071    /**
13072     * Call this function to construct a new gesture-layer object.
13073     * This does not activate the gesture layer. You have to
13074     * call elm_gesture_layer_attach in order to 'activate' gesture-layer.
13075     *
13076     * @param parent the parent object.
13077     *
13078     * @return Pointer to new gesture-layer object.
13079     *
13080     * @ingroup Elm_Gesture_Layer
13081     */
13082    EAPI Evas_Object *elm_gesture_layer_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13083
13084    /**
13085     * @defgroup Thumb Thumb
13086     *
13087     * @image html img/widget/thumb/preview-00.png
13088     * @image latex img/widget/thumb/preview-00.eps
13089     *
13090     * A thumb object is used for displaying the thumbnail of an image or video.
13091     * You must have compiled Elementary with Ethumb_Client support and the DBus
13092     * service must be present and auto-activated in order to have thumbnails to
13093     * be generated.
13094     *
13095     * Once the thumbnail object becomes visible, it will check if there is a
13096     * previously generated thumbnail image for the file set on it. If not, it
13097     * will start generating this thumbnail.
13098     *
13099     * Different config settings will cause different thumbnails to be generated
13100     * even on the same file.
13101     *
13102     * Generated thumbnails are stored under @c $HOME/.thumbnails/. Check the
13103     * Ethumb documentation to change this path, and to see other configuration
13104     * options.
13105     *
13106     * Signals that you can add callbacks for are:
13107     *
13108     * - "clicked" - This is called when a user has clicked the thumb without dragging
13109     *             around.
13110     * - "clicked,double" - This is called when a user has double-clicked the thumb.
13111     * - "press" - This is called when a user has pressed down the thumb.
13112     * - "generate,start" - The thumbnail generation started.
13113     * - "generate,stop" - The generation process stopped.
13114     * - "generate,error" - The generation failed.
13115     * - "load,error" - The thumbnail image loading failed.
13116     *
13117     * available styles:
13118     * - default
13119     * - noframe
13120     *
13121     * An example of use of thumbnail:
13122     *
13123     * - @ref thumb_example_01
13124     */
13125
13126    /**
13127     * @addtogroup Thumb
13128     * @{
13129     */
13130
13131    /**
13132     * @enum _Elm_Thumb_Animation_Setting
13133     * @typedef Elm_Thumb_Animation_Setting
13134     *
13135     * Used to set if a video thumbnail is animating or not.
13136     *
13137     * @ingroup Thumb
13138     */
13139    typedef enum _Elm_Thumb_Animation_Setting
13140      {
13141         ELM_THUMB_ANIMATION_START = 0, /**< Play animation once */
13142         ELM_THUMB_ANIMATION_LOOP,      /**< Keep playing animation until stop is requested */
13143         ELM_THUMB_ANIMATION_STOP,      /**< Stop playing the animation */
13144         ELM_THUMB_ANIMATION_LAST
13145      } Elm_Thumb_Animation_Setting;
13146
13147    /**
13148     * Add a new thumb object to the parent.
13149     *
13150     * @param parent The parent object.
13151     * @return The new object or NULL if it cannot be created.
13152     *
13153     * @see elm_thumb_file_set()
13154     * @see elm_thumb_ethumb_client_get()
13155     *
13156     * @ingroup Thumb
13157     */
13158    EAPI Evas_Object                 *elm_thumb_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13159    /**
13160     * Reload thumbnail if it was generated before.
13161     *
13162     * @param obj The thumb object to reload
13163     *
13164     * This is useful if the ethumb client configuration changed, like its
13165     * size, aspect or any other property one set in the handle returned
13166     * by elm_thumb_ethumb_client_get().
13167     *
13168     * If the options didn't change, the thumbnail won't be generated again, but
13169     * the old one will still be used.
13170     *
13171     * @see elm_thumb_file_set()
13172     *
13173     * @ingroup Thumb
13174     */
13175    EAPI void                         elm_thumb_reload(Evas_Object *obj) EINA_ARG_NONNULL(1);
13176    /**
13177     * Set the file that will be used as thumbnail.
13178     *
13179     * @param obj The thumb object.
13180     * @param file The path to file that will be used as thumb.
13181     * @param key The key used in case of an EET file.
13182     *
13183     * The file can be an image or a video (in that case, acceptable extensions are:
13184     * avi, mp4, ogv, mov, mpg and wmv). To start the video animation, use the
13185     * function elm_thumb_animate().
13186     *
13187     * @see elm_thumb_file_get()
13188     * @see elm_thumb_reload()
13189     * @see elm_thumb_animate()
13190     *
13191     * @ingroup Thumb
13192     */
13193    EAPI void                         elm_thumb_file_set(Evas_Object *obj, const char *file, const char *key) EINA_ARG_NONNULL(1);
13194    /**
13195     * Get the image or video path and key used to generate the thumbnail.
13196     *
13197     * @param obj The thumb object.
13198     * @param file Pointer to filename.
13199     * @param key Pointer to key.
13200     *
13201     * @see elm_thumb_file_set()
13202     * @see elm_thumb_path_get()
13203     *
13204     * @ingroup Thumb
13205     */
13206    EAPI void                         elm_thumb_file_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
13207    /**
13208     * Get the path and key to the image or video generated by ethumb.
13209     *
13210     * One just need to make sure that the thumbnail was generated before getting
13211     * its path; otherwise, the path will be NULL. One way to do that is by asking
13212     * for the path when/after the "generate,stop" smart callback is called.
13213     *
13214     * @param obj The thumb object.
13215     * @param file Pointer to thumb path.
13216     * @param key Pointer to thumb key.
13217     *
13218     * @see elm_thumb_file_get()
13219     *
13220     * @ingroup Thumb
13221     */
13222    EAPI void                         elm_thumb_path_get(const Evas_Object *obj, const char **file, const char **key) EINA_ARG_NONNULL(1);
13223    /**
13224     * Set the animation state for the thumb object. If its content is an animated
13225     * video, you may start/stop the animation or tell it to play continuously and
13226     * looping.
13227     *
13228     * @param obj The thumb object.
13229     * @param setting The animation setting.
13230     *
13231     * @see elm_thumb_file_set()
13232     *
13233     * @ingroup Thumb
13234     */
13235    EAPI void                         elm_thumb_animate_set(Evas_Object *obj, Elm_Thumb_Animation_Setting s) EINA_ARG_NONNULL(1);
13236    /**
13237     * Get the animation state for the thumb object.
13238     *
13239     * @param obj The thumb object.
13240     * @return getting The animation setting or @c ELM_THUMB_ANIMATION_LAST,
13241     * on errors.
13242     *
13243     * @see elm_thumb_animate_set()
13244     *
13245     * @ingroup Thumb
13246     */
13247    EAPI Elm_Thumb_Animation_Setting  elm_thumb_animate_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13248    /**
13249     * Get the ethumb_client handle so custom configuration can be made.
13250     *
13251     * @return Ethumb_Client instance or NULL.
13252     *
13253     * This must be called before the objects are created to be sure no object is
13254     * visible and no generation started.
13255     *
13256     * Example of usage:
13257     *
13258     * @code
13259     * #include <Elementary.h>
13260     * #ifndef ELM_LIB_QUICKLAUNCH
13261     * EAPI_MAIN int
13262     * elm_main(int argc, char **argv)
13263     * {
13264     *    Ethumb_Client *client;
13265     *
13266     *    elm_need_ethumb();
13267     *
13268     *    // ... your code
13269     *
13270     *    client = elm_thumb_ethumb_client_get();
13271     *    if (!client)
13272     *      {
13273     *         ERR("could not get ethumb_client");
13274     *         return 1;
13275     *      }
13276     *    ethumb_client_size_set(client, 100, 100);
13277     *    ethumb_client_crop_align_set(client, 0.5, 0.5);
13278     *    // ... your code
13279     *
13280     *    // Create elm_thumb objects here
13281     *
13282     *    elm_run();
13283     *    elm_shutdown();
13284     *    return 0;
13285     * }
13286     * #endif
13287     * ELM_MAIN()
13288     * @endcode
13289     *
13290     * @note There's only one client handle for Ethumb, so once a configuration
13291     * change is done to it, any other request for thumbnails (for any thumbnail
13292     * object) will use that configuration. Thus, this configuration is global.
13293     *
13294     * @ingroup Thumb
13295     */
13296    EAPI void                        *elm_thumb_ethumb_client_get(void);
13297    /**
13298     * Get the ethumb_client connection state.
13299     *
13300     * @return EINA_TRUE if the client is connected to the server or EINA_FALSE
13301     * otherwise.
13302     */
13303    EAPI Eina_Bool                    elm_thumb_ethumb_client_connected(void);
13304    /**
13305     * Make the thumbnail 'editable'.
13306     *
13307     * @param obj Thumb object.
13308     * @param set Turn on or off editability. Default is @c EINA_FALSE.
13309     *
13310     * This means the thumbnail is a valid drag target for drag and drop, and can be
13311     * cut or pasted too.
13312     *
13313     * @see elm_thumb_editable_get()
13314     *
13315     * @ingroup Thumb
13316     */
13317    EAPI Eina_Bool                    elm_thumb_editable_set(Evas_Object *obj, Eina_Bool edit) EINA_ARG_NONNULL(1);
13318    EAPI Eina_Bool                    elm_thumb_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13319    /**
13320     * Make the thumbnail 'editable'.
13321     *
13322     * @param obj Thumb object.
13323     * @return Editability.
13324     *
13325     * This means the thumbnail is a valid drag target for drag and drop, and can be
13326     * cut or pasted too.
13327     *
13328     * @see elm_thumb_editable_set()
13329     *
13330     * @ingroup Thumb
13331     */
13332    EAPI Eina_Bool                    elm_thumb_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13333
13334    /**
13335     * @}
13336     */
13337
13338    /**
13339     * @defgroup Web Web
13340     *
13341     * @image html img/widget/web/preview-00.png
13342     * @image latex img/widget/web/preview-00.eps
13343     *
13344     * A web object is used for displaying web pages (HTML/CSS/JS)
13345     * using WebKit-EFL. You must have compiled Elementary with
13346     * ewebkit support.
13347     *
13348     * Signals that you can add callbacks for are:
13349     * @li "download,request": A file download has been requested. Event info is
13350     * a pointer to a Elm_Web_Download
13351     * @li "editorclient,contents,changed": Editor client's contents changed
13352     * @li "editorclient,selection,changed": Editor client's selection changed
13353     * @li "frame,created": A new frame was created. Event info is an
13354     * Evas_Object which can be handled with WebKit's ewk_frame API
13355     * @li "icon,received": An icon was received by the main frame
13356     * @li "inputmethod,changed": Input method changed. Event info is an
13357     * Eina_Bool indicating whether it's enabled or not
13358     * @li "js,windowobject,clear": JS window object has been cleared
13359     * @li "link,hover,in": Mouse cursor is hovering over a link. Event info
13360     * is a char *link[2], where the first string contains the URL the link
13361     * points to, and the second one the title of the link
13362     * @li "link,hover,out": Mouse cursor left the link
13363     * @li "load,document,finished": Loading of a document finished. Event info
13364     * is the frame that finished loading
13365     * @li "load,error": Load failed. Event info is a pointer to
13366     * Elm_Web_Frame_Load_Error
13367     * @li "load,finished": Load finished. Event info is NULL on success, on
13368     * error it's a pointer to Elm_Web_Frame_Load_Error
13369     * @li "load,newwindow,show": A new window was created and is ready to be
13370     * shown
13371     * @li "load,progress": Overall load progress. Event info is a pointer to
13372     * a double containing a value between 0.0 and 1.0
13373     * @li "load,provisional": Started provisional load
13374     * @li "load,started": Loading of a document started
13375     * @li "menubar,visible,get": Queries if the menubar is visible. Event info
13376     * is a pointer to Eina_Bool where the callback should set EINA_TRUE if
13377     * the menubar is visible, or EINA_FALSE in case it's not
13378     * @li "menubar,visible,set": Informs menubar visibility. Event info is
13379     * an Eina_Bool indicating the visibility
13380     * @li "popup,created": A dropdown widget was activated, requesting its
13381     * popup menu to be created. Event info is a pointer to Elm_Web_Menu
13382     * @li "popup,willdelete": The web object is ready to destroy the popup
13383     * object created. Event info is a pointer to Elm_Web_Menu
13384     * @li "ready": Page is fully loaded
13385     * @li "scrollbars,visible,get": Queries visibility of scrollbars. Event
13386     * info is a pointer to Eina_Bool where the visibility state should be set
13387     * @li "scrollbars,visible,set": Informs scrollbars visibility. Event info
13388     * is an Eina_Bool with the visibility state set
13389     * @li "statusbar,text,set": Text of the statusbar changed. Even info is
13390     * a string with the new text
13391     * @li "statusbar,visible,get": Queries visibility of the status bar.
13392     * Event info is a pointer to Eina_Bool where the visibility state should be
13393     * set.
13394     * @li "statusbar,visible,set": Informs statusbar visibility. Event info is
13395     * an Eina_Bool with the visibility value
13396     * @li "title,changed": Title of the main frame changed. Event info is a
13397     * string with the new title
13398     * @li "toolbars,visible,get": Queries visibility of toolbars. Event info
13399     * is a pointer to Eina_Bool where the visibility state should be set
13400     * @li "toolbars,visible,set": Informs the visibility of toolbars. Event
13401     * info is an Eina_Bool with the visibility state
13402     * @li "tooltip,text,set": Show and set text of a tooltip. Event info is
13403     * a string with the text to show
13404     * @li "uri,changed": URI of the main frame changed. Event info is a string
13405     * with the new URI
13406     * @li "view,resized": The web object internal's view changed sized
13407     * @li "windows,close,request": A JavaScript request to close the current
13408     * window was requested
13409     * @li "zoom,animated,end": Animated zoom finished
13410     *
13411     * available styles:
13412     * - default
13413     *
13414     * An example of use of web:
13415     *
13416     * - @ref web_example_01 TBD
13417     */
13418
13419    /**
13420     * @addtogroup Web
13421     * @{
13422     */
13423
13424    /**
13425     * Structure used to report load errors.
13426     *
13427     * Load errors are reported as signal by elm_web. All the strings are
13428     * temporary references and should @b not be used after the signal
13429     * callback returns. If it's required, make copies with strdup() or
13430     * eina_stringshare_add() (they are not even guaranteed to be
13431     * stringshared, so must use eina_stringshare_add() and not
13432     * eina_stringshare_ref()).
13433     */
13434    typedef struct _Elm_Web_Frame_Load_Error Elm_Web_Frame_Load_Error;
13435    /**
13436     * Structure used to report load errors.
13437     *
13438     * Load errors are reported as signal by elm_web. All the strings are
13439     * temporary references and should @b not be used after the signal
13440     * callback returns. If it's required, make copies with strdup() or
13441     * eina_stringshare_add() (they are not even guaranteed to be
13442     * stringshared, so must use eina_stringshare_add() and not
13443     * eina_stringshare_ref()).
13444     */
13445    struct _Elm_Web_Frame_Load_Error
13446      {
13447         int code; /**< Numeric error code */
13448         Eina_Bool is_cancellation; /**< Error produced by cancelling a request */
13449         const char *domain; /**< Error domain name */
13450         const char *description; /**< Error description (already localized) */
13451         const char *failing_url; /**< The URL that failed to load */
13452         Evas_Object *frame; /**< Frame object that produced the error */
13453      };
13454
13455    /**
13456     * The possibles types that the items in a menu can be
13457     */
13458    typedef enum _Elm_Web_Menu_Item_Type
13459      {
13460         ELM_WEB_MENU_SEPARATOR,
13461         ELM_WEB_MENU_GROUP,
13462         ELM_WEB_MENU_OPTION
13463      } Elm_Web_Menu_Item_Type;
13464
13465    /**
13466     * Structure describing the items in a menu
13467     */
13468    typedef struct _Elm_Web_Menu_Item Elm_Web_Menu_Item;
13469    /**
13470     * Structure describing the items in a menu
13471     */
13472    struct _Elm_Web_Menu_Item
13473      {
13474         const char *text; /**< The text for the item */
13475         Elm_Web_Menu_Item_Type type; /**< The type of the item */
13476      };
13477
13478    /**
13479     * Structure describing the menu of a popup
13480     *
13481     * This structure will be passed as the @c event_info for the "popup,create"
13482     * signal, which is emitted when a dropdown menu is opened. Users wanting
13483     * to handle these popups by themselves should listen to this signal and
13484     * set the @c handled property of the struct to @c EINA_TRUE. Leaving this
13485     * property as @c EINA_FALSE means that the user will not handle the popup
13486     * and the default implementation will be used.
13487     *
13488     * When the popup is ready to be dismissed, a "popup,willdelete" signal
13489     * will be emitted to notify the user that it can destroy any objects and
13490     * free all data related to it.
13491     *
13492     * @see elm_web_popup_selected_set()
13493     * @see elm_web_popup_destroy()
13494     */
13495    typedef struct _Elm_Web_Menu Elm_Web_Menu;
13496    /**
13497     * Structure describing the menu of a popup
13498     *
13499     * This structure will be passed as the @c event_info for the "popup,create"
13500     * signal, which is emitted when a dropdown menu is opened. Users wanting
13501     * to handle these popups by themselves should listen to this signal and
13502     * set the @c handled property of the struct to @c EINA_TRUE. Leaving this
13503     * property as @c EINA_FALSE means that the user will not handle the popup
13504     * and the default implementation will be used.
13505     *
13506     * When the popup is ready to be dismissed, a "popup,willdelete" signal
13507     * will be emitted to notify the user that it can destroy any objects and
13508     * free all data related to it.
13509     *
13510     * @see elm_web_popup_selected_set()
13511     * @see elm_web_popup_destroy()
13512     */
13513    struct _Elm_Web_Menu
13514      {
13515         Eina_List *items; /**< List of #Elm_Web_Menu_Item */
13516         int x; /**< The X position of the popup, relative to the elm_web object */
13517         int y; /**< The Y position of the popup, relative to the elm_web object */
13518         int width; /**< Width of the popup menu */
13519         int height; /**< Height of the popup menu */
13520
13521         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. */
13522      };
13523
13524    typedef struct _Elm_Web_Download Elm_Web_Download;
13525    struct _Elm_Web_Download
13526      {
13527         const char *url;
13528      };
13529
13530    /**
13531     * Types of zoom available.
13532     */
13533    typedef enum _Elm_Web_Zoom_Mode
13534      {
13535         ELM_WEB_ZOOM_MODE_MANUAL = 0, /**< Zoom controled normally by elm_web_zoom_set */
13536         ELM_WEB_ZOOM_MODE_AUTO_FIT, /**< Zoom until content fits in web object */
13537         ELM_WEB_ZOOM_MODE_AUTO_FILL, /**< Zoom until content fills web object */
13538         ELM_WEB_ZOOM_MODE_LAST
13539      } Elm_Web_Zoom_Mode;
13540    /**
13541     * Opaque handler containing the features (such as statusbar, menubar, etc)
13542     * that are to be set on a newly requested window.
13543     */
13544    typedef struct _Elm_Web_Window_Features Elm_Web_Window_Features;
13545    /**
13546     * Callback type for the create_window hook.
13547     *
13548     * The function parameters are:
13549     * @li @p data User data pointer set when setting the hook function
13550     * @li @p obj The elm_web object requesting the new window
13551     * @li @p js Set to @c EINA_TRUE if the request was originated from
13552     * JavaScript. @c EINA_FALSE otherwise.
13553     * @li @p window_features A pointer of #Elm_Web_Window_Features indicating
13554     * the features requested for the new window.
13555     *
13556     * The returned value of the function should be the @c elm_web widget where
13557     * the request will be loaded. That is, if a new window or tab is created,
13558     * the elm_web widget in it should be returned, and @b NOT the window
13559     * object.
13560     * Returning @c NULL should cancel the request.
13561     *
13562     * @see elm_web_window_create_hook_set()
13563     */
13564    typedef Evas_Object *(*Elm_Web_Window_Open)(void *data, Evas_Object *obj, Eina_Bool js, const Elm_Web_Window_Features *window_features);
13565    /**
13566     * Callback type for the JS alert hook.
13567     *
13568     * The function parameters are:
13569     * @li @p data User data pointer set when setting the hook function
13570     * @li @p obj The elm_web object requesting the new window
13571     * @li @p message The message to show in the alert dialog
13572     *
13573     * The function should return the object representing the alert dialog.
13574     * Elm_Web will run a second main loop to handle the dialog and normal
13575     * flow of the application will be restored when the object is deleted, so
13576     * the user should handle the popup properly in order to delete the object
13577     * when the action is finished.
13578     * If the function returns @c NULL the popup will be ignored.
13579     *
13580     * @see elm_web_dialog_alert_hook_set()
13581     */
13582    typedef Evas_Object *(*Elm_Web_Dialog_Alert)(void *data, Evas_Object *obj, const char *message);
13583    /**
13584     * Callback type for the JS confirm hook.
13585     *
13586     * The function parameters are:
13587     * @li @p data User data pointer set when setting the hook function
13588     * @li @p obj The elm_web object requesting the new window
13589     * @li @p message The message to show in the confirm dialog
13590     * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13591     * the user selected @c Ok, @c EINA_FALSE otherwise.
13592     *
13593     * The function should return the object representing the confirm dialog.
13594     * Elm_Web will run a second main loop to handle the dialog and normal
13595     * flow of the application will be restored when the object is deleted, so
13596     * the user should handle the popup properly in order to delete the object
13597     * when the action is finished.
13598     * If the function returns @c NULL the popup will be ignored.
13599     *
13600     * @see elm_web_dialog_confirm_hook_set()
13601     */
13602    typedef Evas_Object *(*Elm_Web_Dialog_Confirm)(void *data, Evas_Object *obj, const char *message, Eina_Bool *ret);
13603    /**
13604     * Callback type for the JS prompt hook.
13605     *
13606     * The function parameters are:
13607     * @li @p data User data pointer set when setting the hook function
13608     * @li @p obj The elm_web object requesting the new window
13609     * @li @p message The message to show in the prompt dialog
13610     * @li @p def_value The default value to present the user in the entry
13611     * @li @p value Pointer where to store the value given by the user. Must
13612     * be a malloc'ed string or @c NULL if the user cancelled the popup.
13613     * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13614     * the user selected @c Ok, @c EINA_FALSE otherwise.
13615     *
13616     * The function should return the object representing the prompt dialog.
13617     * Elm_Web will run a second main loop to handle the dialog and normal
13618     * flow of the application will be restored when the object is deleted, so
13619     * the user should handle the popup properly in order to delete the object
13620     * when the action is finished.
13621     * If the function returns @c NULL the popup will be ignored.
13622     *
13623     * @see elm_web_dialog_prompt_hook_set()
13624     */
13625    typedef Evas_Object *(*Elm_Web_Dialog_Prompt)(void *data, Evas_Object *obj, const char *message, const char *def_value, char **value, Eina_Bool *ret);
13626    /**
13627     * Callback type for the JS file selector hook.
13628     *
13629     * The function parameters are:
13630     * @li @p data User data pointer set when setting the hook function
13631     * @li @p obj The elm_web object requesting the new window
13632     * @li @p allows_multiple @c EINA_TRUE if multiple files can be selected.
13633     * @li @p accept_types Mime types accepted
13634     * @li @p selected Pointer where to store the list of malloc'ed strings
13635     * containing the path to each file selected. Must be @c NULL if the file
13636     * dialog is cancelled
13637     * @li @p ret Pointer where to store the user selection. @c EINA_TRUE if
13638     * the user selected @c Ok, @c EINA_FALSE otherwise.
13639     *
13640     * The function should return the object representing the file selector
13641     * dialog.
13642     * Elm_Web will run a second main loop to handle the dialog and normal
13643     * flow of the application will be restored when the object is deleted, so
13644     * the user should handle the popup properly in order to delete the object
13645     * when the action is finished.
13646     * If the function returns @c NULL the popup will be ignored.
13647     *
13648     * @see elm_web_dialog_file selector_hook_set()
13649     */
13650    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);
13651    /**
13652     * Callback type for the JS console message hook.
13653     *
13654     * When a console message is added from JavaScript, any set function to the
13655     * console message hook will be called for the user to handle. There is no
13656     * default implementation of this hook.
13657     *
13658     * The function parameters are:
13659     * @li @p data User data pointer set when setting the hook function
13660     * @li @p obj The elm_web object that originated the message
13661     * @li @p message The message sent
13662     * @li @p line_number The line number
13663     * @li @p source_id Source id
13664     *
13665     * @see elm_web_console_message_hook_set()
13666     */
13667    typedef void (*Elm_Web_Console_Message)(void *data, Evas_Object *obj, const char *message, unsigned int line_number, const char *source_id);
13668    /**
13669     * Add a new web object to the parent.
13670     *
13671     * @param parent The parent object.
13672     * @return The new object or NULL if it cannot be created.
13673     *
13674     * @see elm_web_uri_set()
13675     * @see elm_web_webkit_view_get()
13676     */
13677    EAPI Evas_Object                 *elm_web_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
13678
13679    /**
13680     * Get internal ewk_view object from web object.
13681     *
13682     * Elementary may not provide some low level features of EWebKit,
13683     * instead of cluttering the API with proxy methods we opted to
13684     * return the internal reference. Be careful using it as it may
13685     * interfere with elm_web behavior.
13686     *
13687     * @param obj The web object.
13688     * @return The internal ewk_view object or NULL if it does not
13689     *         exist. (Failure to create or Elementary compiled without
13690     *         ewebkit)
13691     *
13692     * @see elm_web_add()
13693     */
13694    EAPI Evas_Object                 *elm_web_webkit_view_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
13695
13696    /**
13697     * Sets the function to call when a new window is requested
13698     *
13699     * This hook will be called when a request to create a new window is
13700     * issued from the web page loaded.
13701     * There is no default implementation for this feature, so leaving this
13702     * unset or passing @c NULL in @p func will prevent new windows from
13703     * opening.
13704     *
13705     * @param obj The web object where to set the hook function
13706     * @param func The hook function to be called when a window is requested
13707     * @param data User data
13708     */
13709    EAPI void                         elm_web_window_create_hook_set(Evas_Object *obj, Elm_Web_Window_Open func, void *data);
13710    /**
13711     * Sets the function to call when an alert dialog
13712     *
13713     * This hook will be called when a JavaScript alert dialog is requested.
13714     * If no function is set or @c NULL is passed in @p func, the default
13715     * implementation will take place.
13716     *
13717     * @param obj The web object where to set the hook function
13718     * @param func The callback function to be used
13719     * @param data User data
13720     *
13721     * @see elm_web_inwin_mode_set()
13722     */
13723    EAPI void                         elm_web_dialog_alert_hook_set(Evas_Object *obj, Elm_Web_Dialog_Alert func, void *data);
13724    /**
13725     * Sets the function to call when an confirm dialog
13726     *
13727     * This hook will be called when a JavaScript confirm dialog is requested.
13728     * If no function is set or @c NULL is passed in @p func, the default
13729     * implementation will take place.
13730     *
13731     * @param obj The web object where to set the hook function
13732     * @param func The callback function to be used
13733     * @param data User data
13734     *
13735     * @see elm_web_inwin_mode_set()
13736     */
13737    EAPI void                         elm_web_dialog_confirm_hook_set(Evas_Object *obj, Elm_Web_Dialog_Confirm func, void *data);
13738    /**
13739     * Sets the function to call when an prompt dialog
13740     *
13741     * This hook will be called when a JavaScript prompt dialog is requested.
13742     * If no function is set or @c NULL is passed in @p func, the default
13743     * implementation will take place.
13744     *
13745     * @param obj The web object where to set the hook function
13746     * @param func The callback function to be used
13747     * @param data User data
13748     *
13749     * @see elm_web_inwin_mode_set()
13750     */
13751    EAPI void                         elm_web_dialog_prompt_hook_set(Evas_Object *obj, Elm_Web_Dialog_Prompt func, void *data);
13752    /**
13753     * Sets the function to call when an file selector dialog
13754     *
13755     * This hook will be called when a JavaScript file selector dialog is
13756     * requested.
13757     * If no function is set or @c NULL is passed in @p func, the default
13758     * implementation will take place.
13759     *
13760     * @param obj The web object where to set the hook function
13761     * @param func The callback function to be used
13762     * @param data User data
13763     *
13764     * @see elm_web_inwin_mode_set()
13765     */
13766    EAPI void                         elm_web_dialog_file_selector_hook_set(Evas_Object *obj, Elm_Web_Dialog_File_Selector func, void *data);
13767    /**
13768     * Sets the function to call when a console message is emitted from JS
13769     *
13770     * This hook will be called when a console message is emitted from
13771     * JavaScript. There is no default implementation for this feature.
13772     *
13773     * @param obj The web object where to set the hook function
13774     * @param func The callback function to be used
13775     * @param data User data
13776     */
13777    EAPI void                         elm_web_console_message_hook_set(Evas_Object *obj, Elm_Web_Console_Message func, void *data);
13778    /**
13779     * Gets the status of the tab propagation
13780     *
13781     * @param obj The web object to query
13782     * @return EINA_TRUE if tab propagation is enabled, EINA_FALSE otherwise
13783     *
13784     * @see elm_web_tab_propagate_set()
13785     */
13786    EAPI Eina_Bool                    elm_web_tab_propagate_get(const Evas_Object *obj);
13787    /**
13788     * Sets whether to use tab propagation
13789     *
13790     * If tab propagation is enabled, whenever the user presses the Tab key,
13791     * Elementary will handle it and switch focus to the next widget.
13792     * The default value is disabled, where WebKit will handle the Tab key to
13793     * cycle focus though its internal objects, jumping to the next widget
13794     * only when that cycle ends.
13795     *
13796     * @param obj The web object
13797     * @param propagate Whether to propagate Tab keys to Elementary or not
13798     */
13799    EAPI void                         elm_web_tab_propagate_set(Evas_Object *obj, Eina_Bool propagate);
13800    /**
13801     * Sets the URI for the web object
13802     *
13803     * It must be a full URI, with resource included, in the form
13804     * http://www.enlightenment.org or file:///tmp/something.html
13805     *
13806     * @param obj The web object
13807     * @param uri The URI to set
13808     * @return EINA_TRUE if the URI could be, EINA_FALSE if an error occurred
13809     */
13810    EAPI Eina_Bool                    elm_web_uri_set(Evas_Object *obj, const char *uri);
13811    /**
13812     * Gets the current URI for the object
13813     *
13814     * The returned string must not be freed and is guaranteed to be
13815     * stringshared.
13816     *
13817     * @param obj The web object
13818     * @return A stringshared internal string with the current URI, or NULL on
13819     * failure
13820     */
13821    EAPI const char                  *elm_web_uri_get(const Evas_Object *obj);
13822    /**
13823     * Gets the current title
13824     *
13825     * The returned string must not be freed and is guaranteed to be
13826     * stringshared.
13827     *
13828     * @param obj The web object
13829     * @return A stringshared internal string with the current title, or NULL on
13830     * failure
13831     */
13832    EAPI const char                  *elm_web_title_get(const Evas_Object *obj);
13833    /**
13834     * Sets the background color to be used by the web object
13835     *
13836     * This is the color that will be used by default when the loaded page
13837     * does not set it's own. Color values are pre-multiplied.
13838     *
13839     * @param obj The web object
13840     * @param r Red component
13841     * @param g Green component
13842     * @param b Blue component
13843     * @param a Alpha component
13844     */
13845    EAPI void                         elm_web_bg_color_set(Evas_Object *obj, int r, int g, int b, int a);
13846    /**
13847     * Gets the background color to be used by the web object
13848     *
13849     * This is the color that will be used by default when the loaded page
13850     * does not set it's own. Color values are pre-multiplied.
13851     *
13852     * @param obj The web object
13853     * @param r Red component
13854     * @param g Green component
13855     * @param b Blue component
13856     * @param a Alpha component
13857     */
13858    EAPI void                         elm_web_bg_color_get(const Evas_Object *obj, int *r, int *g, int *b, int *a);
13859    /**
13860     * Gets a copy of the currently selected text
13861     *
13862     * The string returned must be freed by the user when it's done with it.
13863     *
13864     * @param obj The web object
13865     * @return A newly allocated string, or NULL if nothing is selected or an
13866     * error occurred
13867     */
13868    EAPI char                        *elm_view_selection_get(const Evas_Object *obj);
13869    /**
13870     * Tells the web object which index in the currently open popup was selected
13871     *
13872     * When the user handles the popup creation from the "popup,created" signal,
13873     * it needs to tell the web object which item was selected by calling this
13874     * function with the index corresponding to the item.
13875     *
13876     * @param obj The web object
13877     * @param index The index selected
13878     *
13879     * @see elm_web_popup_destroy()
13880     */
13881    EAPI void                         elm_web_popup_selected_set(Evas_Object *obj, int index);
13882    /**
13883     * Dismisses an open dropdown popup
13884     *
13885     * When the popup from a dropdown widget is to be dismissed, either after
13886     * selecting an option or to cancel it, this function must be called, which
13887     * will later emit an "popup,willdelete" signal to notify the user that
13888     * any memory and objects related to this popup can be freed.
13889     *
13890     * @param obj The web object
13891     * @return EINA_TRUE if the menu was successfully destroyed, or EINA_FALSE
13892     * if there was no menu to destroy
13893     */
13894    EAPI Eina_Bool                    elm_web_popup_destroy(Evas_Object *obj);
13895    /**
13896     * Searches the given string in a document.
13897     *
13898     * @param obj The web object where to search the text
13899     * @param string String to search
13900     * @param case_sensitive If search should be case sensitive or not
13901     * @param forward If search is from cursor and on or backwards
13902     * @param wrap If search should wrap at the end
13903     *
13904     * @return @c EINA_TRUE if the given string was found, @c EINA_FALSE if not
13905     * or failure
13906     */
13907    EAPI Eina_Bool                    elm_web_text_search(const Evas_Object *obj, const char *string, Eina_Bool case_sensitive, Eina_Bool forward, Eina_Bool wrap);
13908    /**
13909     * Marks matches of the given string in a document.
13910     *
13911     * @param obj The web object where to search text
13912     * @param string String to match
13913     * @param case_sensitive If match should be case sensitive or not
13914     * @param highlight If matches should be highlighted
13915     * @param limit Maximum amount of matches, or zero to unlimited
13916     *
13917     * @return number of matched @a string
13918     */
13919    EAPI unsigned int                 elm_web_text_matches_mark(Evas_Object *obj, const char *string, Eina_Bool case_sensitive, Eina_Bool highlight, unsigned int limit);
13920    /**
13921     * Clears all marked matches in the document
13922     *
13923     * @param obj The web object
13924     *
13925     * @return EINA_TRUE on success, EINA_FALSE otherwise
13926     */
13927    EAPI Eina_Bool                    elm_web_text_matches_unmark_all(Evas_Object *obj);
13928    /**
13929     * Sets whether to highlight the matched marks
13930     *
13931     * If enabled, marks set with elm_web_text_matches_mark() will be
13932     * highlighted.
13933     *
13934     * @param obj The web object
13935     * @param highlight Whether to highlight the marks or not
13936     *
13937     * @return EINA_TRUE on success, EINA_FALSE otherwise
13938     */
13939    EAPI Eina_Bool                    elm_web_text_matches_highlight_set(Evas_Object *obj, Eina_Bool highlight);
13940    /**
13941     * Gets whether highlighting marks is enabled
13942     *
13943     * @param The web object
13944     *
13945     * @return EINA_TRUE is marks are set to be highlighted, EINA_FALSE
13946     * otherwise
13947     */
13948    EAPI Eina_Bool                    elm_web_text_matches_highlight_get(const Evas_Object *obj);
13949    /**
13950     * Gets the overall loading progress of the page
13951     *
13952     * Returns the estimated loading progress of the page, with a value between
13953     * 0.0 and 1.0. This is an estimated progress accounting for all the frames
13954     * included in the page.
13955     *
13956     * @param The web object
13957     *
13958     * @return A value between 0.0 and 1.0 indicating the progress, or -1.0 on
13959     * failure
13960     */
13961    EAPI double                       elm_web_load_progress_get(const Evas_Object *obj);
13962    /**
13963     * Stops loading the current page
13964     *
13965     * Cancels the loading of the current page in the web object. This will
13966     * cause a "load,error" signal to be emitted, with the is_cancellation
13967     * flag set to EINA_TRUE.
13968     *
13969     * @param obj The web object
13970     *
13971     * @return EINA_TRUE if the cancel was successful, EINA_FALSE otherwise
13972     */
13973    EAPI Eina_Bool                    elm_web_stop(Evas_Object *obj);
13974    /**
13975     * Requests a reload of the current document in the object
13976     *
13977     * @param obj The web object
13978     *
13979     * @return EINA_TRUE on success, EINA_FALSE otherwise
13980     */
13981    EAPI Eina_Bool                    elm_web_reload(Evas_Object *obj);
13982    /**
13983     * Requests a reload of the current document, avoiding any existing caches
13984     *
13985     * @param obj The web object
13986     *
13987     * @return EINA_TRUE on success, EINA_FALSE otherwise
13988     */
13989    EAPI Eina_Bool                    elm_web_reload_full(Evas_Object *obj);
13990    /**
13991     * Goes back one step in the browsing history
13992     *
13993     * This is equivalent to calling elm_web_object_navigate(obj, -1);
13994     *
13995     * @param obj The web object
13996     *
13997     * @return EINA_TRUE on success, EINA_FALSE otherwise
13998     *
13999     * @see elm_web_history_enable_set()
14000     * @see elm_web_back_possible()
14001     * @see elm_web_forward()
14002     * @see elm_web_navigate()
14003     */
14004    EAPI Eina_Bool                    elm_web_back(Evas_Object *obj);
14005    /**
14006     * Goes forward one step in the browsing history
14007     *
14008     * This is equivalent to calling elm_web_object_navigate(obj, 1);
14009     *
14010     * @param obj The web object
14011     *
14012     * @return EINA_TRUE on success, EINA_FALSE otherwise
14013     *
14014     * @see elm_web_history_enable_set()
14015     * @see elm_web_forward_possible()
14016     * @see elm_web_back()
14017     * @see elm_web_navigate()
14018     */
14019    EAPI Eina_Bool                    elm_web_forward(Evas_Object *obj);
14020    /**
14021     * Jumps the given number of steps in the browsing history
14022     *
14023     * The @p steps value can be a negative integer to back in history, or a
14024     * positive to move forward.
14025     *
14026     * @param obj The web object
14027     * @param steps The number of steps to jump
14028     *
14029     * @return EINA_TRUE on success, EINA_FALSE on error or if not enough
14030     * history exists to jump the given number of steps
14031     *
14032     * @see elm_web_history_enable_set()
14033     * @see elm_web_navigate_possible()
14034     * @see elm_web_back()
14035     * @see elm_web_forward()
14036     */
14037    EAPI Eina_Bool                    elm_web_navigate(Evas_Object *obj, int steps);
14038    /**
14039     * Queries whether it's possible to go back in history
14040     *
14041     * @param obj The web object
14042     *
14043     * @return EINA_TRUE if it's possible to back in history, EINA_FALSE
14044     * otherwise
14045     */
14046    EAPI Eina_Bool                    elm_web_back_possible(Evas_Object *obj);
14047    /**
14048     * Queries whether it's possible to go forward in history
14049     *
14050     * @param obj The web object
14051     *
14052     * @return EINA_TRUE if it's possible to forward in history, EINA_FALSE
14053     * otherwise
14054     */
14055    EAPI Eina_Bool                    elm_web_forward_possible(Evas_Object *obj);
14056    /**
14057     * Queries whether it's possible to jump the given number of steps
14058     *
14059     * The @p steps value can be a negative integer to back in history, or a
14060     * positive to move forward.
14061     *
14062     * @param obj The web object
14063     * @param steps The number of steps to check for
14064     *
14065     * @return EINA_TRUE if enough history exists to perform the given jump,
14066     * EINA_FALSE otherwise
14067     */
14068    EAPI Eina_Bool                    elm_web_navigate_possible(Evas_Object *obj, int steps);
14069    /**
14070     * Gets whether browsing history is enabled for the given object
14071     *
14072     * @param obj The web object
14073     *
14074     * @return EINA_TRUE if history is enabled, EINA_FALSE otherwise
14075     */
14076    EAPI Eina_Bool                    elm_web_history_enable_get(const Evas_Object *obj);
14077    /**
14078     * Enables or disables the browsing history
14079     *
14080     * @param obj The web object
14081     * @param enable Whether to enable or disable the browsing history
14082     */
14083    EAPI void                         elm_web_history_enable_set(Evas_Object *obj, Eina_Bool enable);
14084    /**
14085     * Sets the zoom level of the web object
14086     *
14087     * Zoom level matches the Webkit API, so 1.0 means normal zoom, with higher
14088     * values meaning zoom in and lower meaning zoom out. This function will
14089     * only affect the zoom level if the mode set with elm_web_zoom_mode_set()
14090     * is ::ELM_WEB_ZOOM_MODE_MANUAL.
14091     *
14092     * @param obj The web object
14093     * @param zoom The zoom level to set
14094     */
14095    EAPI void                         elm_web_zoom_set(Evas_Object *obj, double zoom);
14096    /**
14097     * Gets the current zoom level set on the web object
14098     *
14099     * Note that this is the zoom level set on the web object and not that
14100     * of the underlying Webkit one. In the ::ELM_WEB_ZOOM_MODE_MANUAL mode,
14101     * the two zoom levels should match, but for the other two modes the
14102     * Webkit zoom is calculated internally to match the chosen mode without
14103     * changing the zoom level set for the web object.
14104     *
14105     * @param obj The web object
14106     *
14107     * @return The zoom level set on the object
14108     */
14109    EAPI double                       elm_web_zoom_get(const Evas_Object *obj);
14110    /**
14111     * Sets the zoom mode to use
14112     *
14113     * The modes can be any of those defined in ::Elm_Web_Zoom_Mode, except
14114     * ::ELM_WEB_ZOOM_MODE_LAST. The default is ::ELM_WEB_ZOOM_MODE_MANUAL.
14115     *
14116     * ::ELM_WEB_ZOOM_MODE_MANUAL means the zoom level will be controlled
14117     * with the elm_web_zoom_set() function.
14118     * ::ELM_WEB_ZOOM_MODE_AUTO_FIT will calculate the needed zoom level to
14119     * make sure the entirety of the web object's contents are shown.
14120     * ::ELM_WEB_ZOOM_MODE_AUTO_FILL will calculate the needed zoom level to
14121     * fit the contents in the web object's size, without leaving any space
14122     * unused.
14123     *
14124     * @param obj The web object
14125     * @param mode The mode to set
14126     */
14127    EAPI void                         elm_web_zoom_mode_set(Evas_Object *obj, Elm_Web_Zoom_Mode mode);
14128    /**
14129     * Gets the currently set zoom mode
14130     *
14131     * @param obj The web object
14132     *
14133     * @return The current zoom mode set for the object, or
14134     * ::ELM_WEB_ZOOM_MODE_LAST on error
14135     */
14136    EAPI Elm_Web_Zoom_Mode            elm_web_zoom_mode_get(const Evas_Object *obj);
14137    /**
14138     * Shows the given region in the web object
14139     *
14140     * @param obj The web object
14141     * @param x The x coordinate of the region to show
14142     * @param y The y coordinate of the region to show
14143     * @param w The width of the region to show
14144     * @param h The height of the region to show
14145     */
14146    EAPI void                         elm_web_region_show(Evas_Object *obj, int x, int y, int w, int h);
14147    /**
14148     * Brings in the region to the visible area
14149     *
14150     * Like elm_web_region_show(), but it animates the scrolling of the object
14151     * to show the area
14152     *
14153     * @param obj The web object
14154     * @param x The x coordinate of the region to show
14155     * @param y The y coordinate of the region to show
14156     * @param w The width of the region to show
14157     * @param h The height of the region to show
14158     */
14159    EAPI void                         elm_web_region_bring_in(Evas_Object *obj, int x, int y, int w, int h);
14160    /**
14161     * Sets the default dialogs to use an Inwin instead of a normal window
14162     *
14163     * If set, then the default implementation for the JavaScript dialogs and
14164     * file selector will be opened in an Inwin. Otherwise they will use a
14165     * normal separated window.
14166     *
14167     * @param obj The web object
14168     * @param value EINA_TRUE to use Inwin, EINA_FALSE to use a normal window
14169     */
14170    EAPI void                         elm_web_inwin_mode_set(Evas_Object *obj, Eina_Bool value);
14171    /**
14172     * Gets whether Inwin mode is set for the current object
14173     *
14174     * @param obj The web object
14175     *
14176     * @return EINA_TRUE if Inwin mode is set, EINA_FALSE otherwise
14177     */
14178    EAPI Eina_Bool                    elm_web_inwin_mode_get(const Evas_Object *obj);
14179
14180    EAPI void                         elm_web_window_features_ref(Elm_Web_Window_Features *wf);
14181    EAPI void                         elm_web_window_features_unref(Elm_Web_Window_Features *wf);
14182    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);
14183    EAPI void                         elm_web_window_features_int_property_get(const Elm_Web_Window_Features *wf, int *x, int *y, int *w, int *h);
14184
14185    /**
14186     * @}
14187     */
14188
14189    /**
14190     * @defgroup Hoversel Hoversel
14191     *
14192     * @image html img/widget/hoversel/preview-00.png
14193     * @image latex img/widget/hoversel/preview-00.eps
14194     *
14195     * A hoversel is a button that pops up a list of items (automatically
14196     * choosing the direction to display) that have a label and, optionally, an
14197     * icon to select from. It is a convenience widget to avoid the need to do
14198     * all the piecing together yourself. It is intended for a small number of
14199     * items in the hoversel menu (no more than 8), though is capable of many
14200     * more.
14201     *
14202     * Signals that you can add callbacks for are:
14203     * "clicked" - the user clicked the hoversel button and popped up the sel
14204     * "selected" - an item in the hoversel list is selected. event_info is the item
14205     * "dismissed" - the hover is dismissed
14206     *
14207     * See @ref tutorial_hoversel for an example.
14208     * @{
14209     */
14210    typedef struct _Elm_Hoversel_Item Elm_Hoversel_Item; /**< Item of Elm_Hoversel. Sub-type of Elm_Widget_Item */
14211    /**
14212     * @brief Add a new Hoversel object
14213     *
14214     * @param parent The parent object
14215     * @return The new object or NULL if it cannot be created
14216     */
14217    EAPI Evas_Object       *elm_hoversel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14218    /**
14219     * @brief This sets the hoversel to expand horizontally.
14220     *
14221     * @param obj The hoversel object
14222     * @param horizontal If true, the hover will expand horizontally to the
14223     * right.
14224     *
14225     * @note The initial button will display horizontally regardless of this
14226     * setting.
14227     */
14228    EAPI void               elm_hoversel_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
14229    /**
14230     * @brief This returns whether the hoversel is set to expand horizontally.
14231     *
14232     * @param obj The hoversel object
14233     * @return If true, the hover will expand horizontally to the right.
14234     *
14235     * @see elm_hoversel_horizontal_set()
14236     */
14237    EAPI Eina_Bool          elm_hoversel_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14238    /**
14239     * @brief Set the Hover parent
14240     *
14241     * @param obj The hoversel object
14242     * @param parent The parent to use
14243     *
14244     * Sets the hover parent object, the area that will be darkened when the
14245     * hoversel is clicked. Should probably be the window that the hoversel is
14246     * in. See @ref Hover objects for more information.
14247     */
14248    EAPI void               elm_hoversel_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
14249    /**
14250     * @brief Get the Hover parent
14251     *
14252     * @param obj The hoversel object
14253     * @return The used parent
14254     *
14255     * Gets the hover parent object.
14256     *
14257     * @see elm_hoversel_hover_parent_set()
14258     */
14259    EAPI Evas_Object       *elm_hoversel_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14260    /**
14261     * @brief Set the hoversel button label
14262     *
14263     * @param obj The hoversel object
14264     * @param label The label text.
14265     *
14266     * This sets the label of the button that is always visible (before it is
14267     * clicked and expanded).
14268     *
14269     * @deprecated elm_object_text_set()
14270     */
14271    EINA_DEPRECATED EAPI void               elm_hoversel_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
14272    /**
14273     * @brief Get the hoversel button label
14274     *
14275     * @param obj The hoversel object
14276     * @return The label text.
14277     *
14278     * @deprecated elm_object_text_get()
14279     */
14280    EINA_DEPRECATED EAPI const char        *elm_hoversel_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14281    /**
14282     * @brief Set the icon of the hoversel button
14283     *
14284     * @param obj The hoversel object
14285     * @param icon The icon object
14286     *
14287     * Sets the icon of the button that is always visible (before it is clicked
14288     * and expanded).  Once the icon object is set, a previously set one will be
14289     * deleted, if you want to keep that old content object, use the
14290     * elm_hoversel_icon_unset() function.
14291     *
14292     * @see elm_object_content_set() for the button widget
14293     */
14294    EAPI void               elm_hoversel_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
14295    /**
14296     * @brief Get the icon of the hoversel button
14297     *
14298     * @param obj The hoversel object
14299     * @return The icon object
14300     *
14301     * Get the icon of the button that is always visible (before it is clicked
14302     * and expanded). Also see elm_object_content_get() for the button widget.
14303     *
14304     * @see elm_hoversel_icon_set()
14305     */
14306    EAPI Evas_Object       *elm_hoversel_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14307    /**
14308     * @brief Get and unparent the icon of the hoversel button
14309     *
14310     * @param obj The hoversel object
14311     * @return The icon object that was being used
14312     *
14313     * Unparent and return the icon of the button that is always visible
14314     * (before it is clicked and expanded).
14315     *
14316     * @see elm_hoversel_icon_set()
14317     * @see elm_object_content_unset() for the button widget
14318     */
14319    EAPI Evas_Object       *elm_hoversel_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
14320    /**
14321     * @brief This triggers the hoversel popup from code, the same as if the user
14322     * had clicked the button.
14323     *
14324     * @param obj The hoversel object
14325     */
14326    EAPI void               elm_hoversel_hover_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
14327    /**
14328     * @brief This dismisses the hoversel popup as if the user had clicked
14329     * outside the hover.
14330     *
14331     * @param obj The hoversel object
14332     */
14333    EAPI void               elm_hoversel_hover_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
14334    /**
14335     * @brief Returns whether the hoversel is expanded.
14336     *
14337     * @param obj The hoversel object
14338     * @return  This will return EINA_TRUE if the hoversel is expanded or
14339     * EINA_FALSE if it is not expanded.
14340     */
14341    EAPI Eina_Bool          elm_hoversel_expanded_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14342    /**
14343     * @brief This will remove all the children items from the hoversel.
14344     *
14345     * @param obj The hoversel object
14346     *
14347     * @warning Should @b not be called while the hoversel is active; use
14348     * elm_hoversel_expanded_get() to check first.
14349     *
14350     * @see elm_hoversel_item_del_cb_set()
14351     * @see elm_hoversel_item_del()
14352     */
14353    EAPI void               elm_hoversel_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
14354    /**
14355     * @brief Get the list of items within the given hoversel.
14356     *
14357     * @param obj The hoversel object
14358     * @return Returns a list of Elm_Hoversel_Item*
14359     *
14360     * @see elm_hoversel_item_add()
14361     */
14362    EAPI const Eina_List   *elm_hoversel_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14363    /**
14364     * @brief Add an item to the hoversel button
14365     *
14366     * @param obj The hoversel object
14367     * @param label The text label to use for the item (NULL if not desired)
14368     * @param icon_file An image file path on disk to use for the icon or standard
14369     * icon name (NULL if not desired)
14370     * @param icon_type The icon type if relevant
14371     * @param func Convenience function to call when this item is selected
14372     * @param data Data to pass to item-related functions
14373     * @return A handle to the item added.
14374     *
14375     * This adds an item to the hoversel to show when it is clicked. Note: if you
14376     * need to use an icon from an edje file then use
14377     * elm_hoversel_item_icon_set() right after the this function, and set
14378     * icon_file to NULL here.
14379     *
14380     * For more information on what @p icon_file and @p icon_type are see the
14381     * @ref Icon "icon documentation".
14382     */
14383    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);
14384    /**
14385     * @brief Delete an item from the hoversel
14386     *
14387     * @param item The item to delete
14388     *
14389     * This deletes the item from the hoversel (should not be called while the
14390     * hoversel is active; use elm_hoversel_expanded_get() to check first).
14391     *
14392     * @see elm_hoversel_item_add()
14393     * @see elm_hoversel_item_del_cb_set()
14394     */
14395    EAPI void               elm_hoversel_item_del(Elm_Hoversel_Item *item) EINA_ARG_NONNULL(1);
14396    /**
14397     * @brief Set the function to be called when an item from the hoversel is
14398     * freed.
14399     *
14400     * @param item The item to set the callback on
14401     * @param func The function called
14402     *
14403     * That function will receive these parameters:
14404     * @li void *item_data
14405     * @li Evas_Object *the_item_object
14406     * @li Elm_Hoversel_Item *the_object_struct
14407     *
14408     * @see elm_hoversel_item_add()
14409     */
14410    EAPI void               elm_hoversel_item_del_cb_set(Elm_Hoversel_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
14411    /**
14412     * @brief This returns the data pointer supplied with elm_hoversel_item_add()
14413     * that will be passed to associated function callbacks.
14414     *
14415     * @param item The item to get the data from
14416     * @return The data pointer set with elm_hoversel_item_add()
14417     *
14418     * @see elm_hoversel_item_add()
14419     */
14420    EAPI void              *elm_hoversel_item_data_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
14421    /**
14422     * @brief This returns the label text of the given hoversel item.
14423     *
14424     * @param item The item to get the label
14425     * @return The label text of the hoversel item
14426     *
14427     * @see elm_hoversel_item_add()
14428     */
14429    EAPI const char        *elm_hoversel_item_label_get(const Elm_Hoversel_Item *it) EINA_ARG_NONNULL(1);
14430    /**
14431     * @brief This sets the icon for the given hoversel item.
14432     *
14433     * @param item The item to set the icon
14434     * @param icon_file An image file path on disk to use for the icon or standard
14435     * icon name
14436     * @param icon_group The edje group to use if @p icon_file is an edje file. Set this
14437     * to NULL if the icon is not an edje file
14438     * @param icon_type The icon type
14439     *
14440     * The icon can be loaded from the standard set, from an image file, or from
14441     * an edje file.
14442     *
14443     * @see elm_hoversel_item_add()
14444     */
14445    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);
14446    /**
14447     * @brief Get the icon object of the hoversel item
14448     *
14449     * @param item The item to get the icon from
14450     * @param icon_file The image file path on disk used for the icon or standard
14451     * icon name
14452     * @param icon_group The edje group used if @p icon_file is an edje file. NULL
14453     * if the icon is not an edje file
14454     * @param icon_type The icon type
14455     *
14456     * @see elm_hoversel_item_icon_set()
14457     * @see elm_hoversel_item_add()
14458     */
14459    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);
14460    /**
14461     * @}
14462     */
14463
14464    /**
14465     * @defgroup Toolbar Toolbar
14466     * @ingroup Elementary
14467     *
14468     * @image html img/widget/toolbar/preview-00.png
14469     * @image latex img/widget/toolbar/preview-00.eps width=\textwidth
14470     *
14471     * @image html img/toolbar.png
14472     * @image latex img/toolbar.eps width=\textwidth
14473     *
14474     * A toolbar is a widget that displays a list of items inside
14475     * a box. It can be scrollable, show a menu with items that don't fit
14476     * to toolbar size or even crop them.
14477     *
14478     * Only one item can be selected at a time.
14479     *
14480     * Items can have multiple states, or show menus when selected by the user.
14481     *
14482     * Smart callbacks one can listen to:
14483     * - "clicked" - when the user clicks on a toolbar item and becomes selected.
14484     * - "language,changed" - when the program language changes
14485     *
14486     * Available styles for it:
14487     * - @c "default"
14488     * - @c "transparent" - no background or shadow, just show the content
14489     *
14490     * List of examples:
14491     * @li @ref toolbar_example_01
14492     * @li @ref toolbar_example_02
14493     * @li @ref toolbar_example_03
14494     */
14495
14496    /**
14497     * @addtogroup Toolbar
14498     * @{
14499     */
14500
14501    /**
14502     * @enum _Elm_Toolbar_Shrink_Mode
14503     * @typedef Elm_Toolbar_Shrink_Mode
14504     *
14505     * Set toolbar's items display behavior, it can be scrollabel,
14506     * show a menu with exceeding items, or simply hide them.
14507     *
14508     * @note Default value is #ELM_TOOLBAR_SHRINK_MENU. It reads value
14509     * from elm config.
14510     *
14511     * Values <b> don't </b> work as bitmask, only one can be choosen.
14512     *
14513     * @see elm_toolbar_mode_shrink_set()
14514     * @see elm_toolbar_mode_shrink_get()
14515     *
14516     * @ingroup Toolbar
14517     */
14518    typedef enum _Elm_Toolbar_Shrink_Mode
14519      {
14520         ELM_TOOLBAR_SHRINK_NONE,   /**< Set toolbar minimun size to fit all the items. */
14521         ELM_TOOLBAR_SHRINK_HIDE,   /**< Hide exceeding items. */
14522         ELM_TOOLBAR_SHRINK_SCROLL, /**< Allow accessing exceeding items through a scroller. */
14523         ELM_TOOLBAR_SHRINK_MENU,   /**< Inserts a button to pop up a menu with exceeding items. */
14524         ELM_TOOLBAR_SHRINK_LAST    /**< Indicates error if returned by elm_toolbar_shrink_mode_get() */
14525      } Elm_Toolbar_Shrink_Mode;
14526
14527    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(). */
14528
14529    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(). */
14530
14531    /**
14532     * Add a new toolbar widget to the given parent Elementary
14533     * (container) object.
14534     *
14535     * @param parent The parent object.
14536     * @return a new toolbar widget handle or @c NULL, on errors.
14537     *
14538     * This function inserts a new toolbar widget on the canvas.
14539     *
14540     * @ingroup Toolbar
14541     */
14542    EAPI Evas_Object            *elm_toolbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
14543
14544    /**
14545     * Set the icon size, in pixels, to be used by toolbar items.
14546     *
14547     * @param obj The toolbar object
14548     * @param icon_size The icon size in pixels
14549     *
14550     * @note Default value is @c 32. It reads value from elm config.
14551     *
14552     * @see elm_toolbar_icon_size_get()
14553     *
14554     * @ingroup Toolbar
14555     */
14556    EAPI void                    elm_toolbar_icon_size_set(Evas_Object *obj, int icon_size) EINA_ARG_NONNULL(1);
14557
14558    /**
14559     * Get the icon size, in pixels, to be used by toolbar items.
14560     *
14561     * @param obj The toolbar object.
14562     * @return The icon size in pixels.
14563     *
14564     * @see elm_toolbar_icon_size_set() for details.
14565     *
14566     * @ingroup Toolbar
14567     */
14568    EAPI int                     elm_toolbar_icon_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14569
14570    /**
14571     * Sets icon lookup order, for toolbar items' icons.
14572     *
14573     * @param obj The toolbar object.
14574     * @param order The icon lookup order.
14575     *
14576     * Icons added before calling this function will not be affected.
14577     * The default lookup order is #ELM_ICON_LOOKUP_THEME_FDO.
14578     *
14579     * @see elm_toolbar_icon_order_lookup_get()
14580     *
14581     * @ingroup Toolbar
14582     */
14583    EAPI void                    elm_toolbar_icon_order_lookup_set(Evas_Object *obj, Elm_Icon_Lookup_Order order) EINA_ARG_NONNULL(1);
14584
14585    /**
14586     * Gets the icon lookup order.
14587     *
14588     * @param obj The toolbar object.
14589     * @return The icon lookup order.
14590     *
14591     * @see elm_toolbar_icon_order_lookup_set() for details.
14592     *
14593     * @ingroup Toolbar
14594     */
14595    EAPI Elm_Icon_Lookup_Order   elm_toolbar_icon_order_lookup_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14596
14597    /**
14598     * Set whether the toolbar should always have an item selected.
14599     *
14600     * @param obj The toolbar object.
14601     * @param wrap @c EINA_TRUE to enable always-select mode or @c EINA_FALSE to
14602     * disable it.
14603     *
14604     * This will cause the toolbar to always have an item selected, and clicking
14605     * the selected item will not cause a selected event to be emitted. Enabling this mode
14606     * will immediately select the first toolbar item.
14607     *
14608     * Always-selected is disabled by default.
14609     *
14610     * @see elm_toolbar_always_select_mode_get().
14611     *
14612     * @ingroup Toolbar
14613     */
14614    EAPI void                    elm_toolbar_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
14615
14616    /**
14617     * Get whether the toolbar should always have an item selected.
14618     *
14619     * @param obj The toolbar object.
14620     * @return @c EINA_TRUE means an item will always be selected, @c EINA_FALSE indicates
14621     * that it is possible to have no items selected. If @p obj is @c NULL, @c EINA_FALSE is returned.
14622     *
14623     * @see elm_toolbar_always_select_mode_set() for details.
14624     *
14625     * @ingroup Toolbar
14626     */
14627    EAPI Eina_Bool               elm_toolbar_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14628
14629    /**
14630     * Set whether the toolbar items' should be selected by the user or not.
14631     *
14632     * @param obj The toolbar object.
14633     * @param wrap @c EINA_TRUE to disable selection or @c EINA_FALSE to
14634     * enable it.
14635     *
14636     * This will turn off the ability to select items entirely and they will
14637     * neither appear selected nor emit selected signals. The clicked
14638     * callback function will still be called.
14639     *
14640     * Selection is enabled by default.
14641     *
14642     * @see elm_toolbar_no_select_mode_get().
14643     *
14644     * @ingroup Toolbar
14645     */
14646    EAPI void                    elm_toolbar_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
14647
14648    /**
14649     * Set whether the toolbar items' should be selected by the user or not.
14650     *
14651     * @param obj The toolbar object.
14652     * @return @c EINA_TRUE means items can be selected. @c EINA_FALSE indicates
14653     * they can't. If @p obj is @c NULL, @c EINA_FALSE is returned.
14654     *
14655     * @see elm_toolbar_no_select_mode_set() for details.
14656     *
14657     * @ingroup Toolbar
14658     */
14659    EAPI Eina_Bool               elm_toolbar_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14660
14661    /**
14662     * Append item to the toolbar.
14663     *
14664     * @param obj The toolbar object.
14665     * @param icon A string with icon name or the absolute path of an image file.
14666     * @param label The label of the item.
14667     * @param func The function to call when the item is clicked.
14668     * @param data The data to associate with the item for related callbacks.
14669     * @return The created item or @c NULL upon failure.
14670     *
14671     * A new item will be created and appended to the toolbar, i.e., will
14672     * be set as @b last item.
14673     *
14674     * Items created with this method can be deleted with
14675     * elm_toolbar_item_del().
14676     *
14677     * Associated @p data can be properly freed when item is deleted if a
14678     * callback function is set with elm_toolbar_item_del_cb_set().
14679     *
14680     * If a function is passed as argument, it will be called everytime this item
14681     * is selected, i.e., the user clicks over an unselected item.
14682     * If such function isn't needed, just passing
14683     * @c NULL as @p func is enough. The same should be done for @p data.
14684     *
14685     * Toolbar will load icon image from fdo or current theme.
14686     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14687     * If an absolute path is provided it will load it direct from a file.
14688     *
14689     * @see elm_toolbar_item_icon_set()
14690     * @see elm_toolbar_item_del()
14691     * @see elm_toolbar_item_del_cb_set()
14692     *
14693     * @ingroup Toolbar
14694     */
14695    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);
14696
14697    /**
14698     * Prepend item to the toolbar.
14699     *
14700     * @param obj The toolbar object.
14701     * @param icon A string with icon name or the absolute path of an image file.
14702     * @param label The label of the item.
14703     * @param func The function to call when the item is clicked.
14704     * @param data The data to associate with the item for related callbacks.
14705     * @return The created item or @c NULL upon failure.
14706     *
14707     * A new item will be created and prepended to the toolbar, i.e., will
14708     * be set as @b first item.
14709     *
14710     * Items created with this method can be deleted with
14711     * elm_toolbar_item_del().
14712     *
14713     * Associated @p data can be properly freed when item is deleted if a
14714     * callback function is set with elm_toolbar_item_del_cb_set().
14715     *
14716     * If a function is passed as argument, it will be called everytime this item
14717     * is selected, i.e., the user clicks over an unselected item.
14718     * If such function isn't needed, just passing
14719     * @c NULL as @p func is enough. The same should be done for @p data.
14720     *
14721     * Toolbar will load icon image from fdo or current theme.
14722     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14723     * If an absolute path is provided it will load it direct from a file.
14724     *
14725     * @see elm_toolbar_item_icon_set()
14726     * @see elm_toolbar_item_del()
14727     * @see elm_toolbar_item_del_cb_set()
14728     *
14729     * @ingroup Toolbar
14730     */
14731    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);
14732
14733    /**
14734     * Insert a new item into the toolbar object before item @p before.
14735     *
14736     * @param obj The toolbar object.
14737     * @param before The toolbar item to insert before.
14738     * @param icon A string with icon name or the absolute path of an image file.
14739     * @param label The label of the item.
14740     * @param func The function to call when the item is clicked.
14741     * @param data The data to associate with the item for related callbacks.
14742     * @return The created item or @c NULL upon failure.
14743     *
14744     * A new item will be created and added to the toolbar. Its position in
14745     * this toolbar will be just before item @p before.
14746     *
14747     * Items created with this method can be deleted with
14748     * elm_toolbar_item_del().
14749     *
14750     * Associated @p data can be properly freed when item is deleted if a
14751     * callback function is set with elm_toolbar_item_del_cb_set().
14752     *
14753     * If a function is passed as argument, it will be called everytime this item
14754     * is selected, i.e., the user clicks over an unselected item.
14755     * If such function isn't needed, just passing
14756     * @c NULL as @p func is enough. The same should be done for @p data.
14757     *
14758     * Toolbar will load icon image from fdo or current theme.
14759     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14760     * If an absolute path is provided it will load it direct from a file.
14761     *
14762     * @see elm_toolbar_item_icon_set()
14763     * @see elm_toolbar_item_del()
14764     * @see elm_toolbar_item_del_cb_set()
14765     *
14766     * @ingroup Toolbar
14767     */
14768    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);
14769
14770    /**
14771     * Insert a new item into the toolbar object after item @p after.
14772     *
14773     * @param obj The toolbar object.
14774     * @param after The toolbar item to insert after.
14775     * @param icon A string with icon name or the absolute path of an image file.
14776     * @param label The label of the item.
14777     * @param func The function to call when the item is clicked.
14778     * @param data The data to associate with the item for related callbacks.
14779     * @return The created item or @c NULL upon failure.
14780     *
14781     * A new item will be created and added to the toolbar. Its position in
14782     * this toolbar will be just after item @p after.
14783     *
14784     * Items created with this method can be deleted with
14785     * elm_toolbar_item_del().
14786     *
14787     * Associated @p data can be properly freed when item is deleted if a
14788     * callback function is set with elm_toolbar_item_del_cb_set().
14789     *
14790     * If a function is passed as argument, it will be called everytime this item
14791     * is selected, i.e., the user clicks over an unselected item.
14792     * If such function isn't needed, just passing
14793     * @c NULL as @p func is enough. The same should be done for @p data.
14794     *
14795     * Toolbar will load icon image from fdo or current theme.
14796     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
14797     * If an absolute path is provided it will load it direct from a file.
14798     *
14799     * @see elm_toolbar_item_icon_set()
14800     * @see elm_toolbar_item_del()
14801     * @see elm_toolbar_item_del_cb_set()
14802     *
14803     * @ingroup Toolbar
14804     */
14805    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);
14806
14807    /**
14808     * Get the first item in the given toolbar widget's list of
14809     * items.
14810     *
14811     * @param obj The toolbar object
14812     * @return The first item or @c NULL, if it has no items (and on
14813     * errors)
14814     *
14815     * @see elm_toolbar_item_append()
14816     * @see elm_toolbar_last_item_get()
14817     *
14818     * @ingroup Toolbar
14819     */
14820    EAPI Elm_Toolbar_Item       *elm_toolbar_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14821
14822    /**
14823     * Get the last item in the given toolbar widget's list of
14824     * items.
14825     *
14826     * @param obj The toolbar object
14827     * @return The last item or @c NULL, if it has no items (and on
14828     * errors)
14829     *
14830     * @see elm_toolbar_item_prepend()
14831     * @see elm_toolbar_first_item_get()
14832     *
14833     * @ingroup Toolbar
14834     */
14835    EAPI Elm_Toolbar_Item       *elm_toolbar_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
14836
14837    /**
14838     * Get the item after @p item in toolbar.
14839     *
14840     * @param item The toolbar item.
14841     * @return The item after @p item, or @c NULL if none or on failure.
14842     *
14843     * @note If it is the last item, @c NULL will be returned.
14844     *
14845     * @see elm_toolbar_item_append()
14846     *
14847     * @ingroup Toolbar
14848     */
14849    EAPI Elm_Toolbar_Item       *elm_toolbar_item_next_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14850
14851    /**
14852     * Get the item before @p item in toolbar.
14853     *
14854     * @param item The toolbar item.
14855     * @return The item before @p item, or @c NULL if none or on failure.
14856     *
14857     * @note If it is the first item, @c NULL will be returned.
14858     *
14859     * @see elm_toolbar_item_prepend()
14860     *
14861     * @ingroup Toolbar
14862     */
14863    EAPI Elm_Toolbar_Item       *elm_toolbar_item_prev_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14864
14865    /**
14866     * Get the toolbar object from an item.
14867     *
14868     * @param item The item.
14869     * @return The toolbar object.
14870     *
14871     * This returns the toolbar object itself that an item belongs to.
14872     *
14873     * @ingroup Toolbar
14874     */
14875    EAPI Evas_Object            *elm_toolbar_item_toolbar_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14876
14877    /**
14878     * Set the priority of a toolbar item.
14879     *
14880     * @param item The toolbar item.
14881     * @param priority The item priority. The default is zero.
14882     *
14883     * This is used only when the toolbar shrink mode is set to
14884     * #ELM_TOOLBAR_SHRINK_MENU or #ELM_TOOLBAR_SHRINK_HIDE.
14885     * When space is less than required, items with low priority
14886     * will be removed from the toolbar and added to a dynamically-created menu,
14887     * while items with higher priority will remain on the toolbar,
14888     * with the same order they were added.
14889     *
14890     * @see elm_toolbar_item_priority_get()
14891     *
14892     * @ingroup Toolbar
14893     */
14894    EAPI void                    elm_toolbar_item_priority_set(Elm_Toolbar_Item *item, int priority) EINA_ARG_NONNULL(1);
14895
14896    /**
14897     * Get the priority of a toolbar item.
14898     *
14899     * @param item The toolbar item.
14900     * @return The @p item priority, or @c 0 on failure.
14901     *
14902     * @see elm_toolbar_item_priority_set() for details.
14903     *
14904     * @ingroup Toolbar
14905     */
14906    EAPI int                     elm_toolbar_item_priority_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14907
14908    /**
14909     * Get the label of item.
14910     *
14911     * @param item The item of toolbar.
14912     * @return The label of item.
14913     *
14914     * The return value is a pointer to the label associated to @p item when
14915     * it was created, with function elm_toolbar_item_append() or similar,
14916     * or later,
14917     * with function elm_toolbar_item_label_set. If no label
14918     * was passed as argument, it will return @c NULL.
14919     *
14920     * @see elm_toolbar_item_label_set() for more details.
14921     * @see elm_toolbar_item_append()
14922     *
14923     * @ingroup Toolbar
14924     */
14925    EAPI const char             *elm_toolbar_item_label_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14926
14927    /**
14928     * Set the label of item.
14929     *
14930     * @param item The item of toolbar.
14931     * @param text The label of item.
14932     *
14933     * The label to be displayed by the item.
14934     * Label will be placed at icons bottom (if set).
14935     *
14936     * If a label was passed as argument on item creation, with function
14937     * elm_toolbar_item_append() or similar, it will be already
14938     * displayed by the item.
14939     *
14940     * @see elm_toolbar_item_label_get()
14941     * @see elm_toolbar_item_append()
14942     *
14943     * @ingroup Toolbar
14944     */
14945    EAPI void                    elm_toolbar_item_label_set(Elm_Toolbar_Item *item, const char *label) EINA_ARG_NONNULL(1);
14946
14947    /**
14948     * Return the data associated with a given toolbar widget item.
14949     *
14950     * @param item The toolbar widget item handle.
14951     * @return The data associated with @p item.
14952     *
14953     * @see elm_toolbar_item_data_set()
14954     *
14955     * @ingroup Toolbar
14956     */
14957    EAPI void                   *elm_toolbar_item_data_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
14958
14959    /**
14960     * Set the data associated with a given toolbar widget item.
14961     *
14962     * @param item The toolbar widget item handle.
14963     * @param data The new data pointer to set to @p item.
14964     *
14965     * This sets new item data on @p item.
14966     *
14967     * @warning The old data pointer won't be touched by this function, so
14968     * the user had better to free that old data himself/herself.
14969     *
14970     * @ingroup Toolbar
14971     */
14972    EAPI void                    elm_toolbar_item_data_set(Elm_Toolbar_Item *item, const void *data) EINA_ARG_NONNULL(1);
14973
14974    /**
14975     * Returns a pointer to a toolbar item by its label.
14976     *
14977     * @param obj The toolbar object.
14978     * @param label The label of the item to find.
14979     *
14980     * @return The pointer to the toolbar item matching @p label or @c NULL
14981     * on failure.
14982     *
14983     * @ingroup Toolbar
14984     */
14985    EAPI Elm_Toolbar_Item       *elm_toolbar_item_find_by_label(const Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
14986
14987    /*
14988     * Get whether the @p item is selected or not.
14989     *
14990     * @param item The toolbar item.
14991     * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
14992     * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
14993     *
14994     * @see elm_toolbar_selected_item_set() for details.
14995     * @see elm_toolbar_item_selected_get()
14996     *
14997     * @ingroup Toolbar
14998     */
14999    EAPI Eina_Bool               elm_toolbar_item_selected_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15000
15001    /**
15002     * Set the selected state of an item.
15003     *
15004     * @param item The toolbar item
15005     * @param selected The selected state
15006     *
15007     * This sets the selected state of the given item @p it.
15008     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
15009     *
15010     * If a new item is selected the previosly selected will be unselected.
15011     * Previoulsy selected item can be get with function
15012     * elm_toolbar_selected_item_get().
15013     *
15014     * Selected items will be highlighted.
15015     *
15016     * @see elm_toolbar_item_selected_get()
15017     * @see elm_toolbar_selected_item_get()
15018     *
15019     * @ingroup Toolbar
15020     */
15021    EAPI void                    elm_toolbar_item_selected_set(Elm_Toolbar_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
15022
15023    /**
15024     * Get the selected item.
15025     *
15026     * @param obj The toolbar object.
15027     * @return The selected toolbar item.
15028     *
15029     * The selected item can be unselected with function
15030     * elm_toolbar_item_selected_set().
15031     *
15032     * The selected item always will be highlighted on toolbar.
15033     *
15034     * @see elm_toolbar_selected_items_get()
15035     *
15036     * @ingroup Toolbar
15037     */
15038    EAPI Elm_Toolbar_Item       *elm_toolbar_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15039
15040    /**
15041     * Set the icon associated with @p item.
15042     *
15043     * @param obj The parent of this item.
15044     * @param item The toolbar item.
15045     * @param icon A string with icon name or the absolute path of an image file.
15046     *
15047     * Toolbar will load icon image from fdo or current theme.
15048     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
15049     * If an absolute path is provided it will load it direct from a file.
15050     *
15051     * @see elm_toolbar_icon_order_lookup_set()
15052     * @see elm_toolbar_icon_order_lookup_get()
15053     *
15054     * @ingroup Toolbar
15055     */
15056    EAPI void                    elm_toolbar_item_icon_set(Elm_Toolbar_Item *item, const char *icon) EINA_ARG_NONNULL(1);
15057
15058    /**
15059     * Get the string used to set the icon of @p item.
15060     *
15061     * @param item The toolbar item.
15062     * @return The string associated with the icon object.
15063     *
15064     * @see elm_toolbar_item_icon_set() for details.
15065     *
15066     * @ingroup Toolbar
15067     */
15068    EAPI const char             *elm_toolbar_item_icon_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15069
15070    /**
15071     * Get the object of @p item.
15072     *
15073     * @param item The toolbar item.
15074     * @return The object
15075     *
15076     * @ingroup Toolbar
15077     */
15078    EAPI Evas_Object            *elm_toolbar_item_object_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15079
15080    /**
15081     * Get the icon object of @p item.
15082     *
15083     * @param item The toolbar item.
15084     * @return The icon object
15085     *
15086     * @see elm_toolbar_item_icon_set() or elm_toolbar_item_icon_memfile_set() for details.
15087     *
15088     * @ingroup Toolbar
15089     */
15090    EAPI Evas_Object            *elm_toolbar_item_icon_object_get(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15091
15092    /**
15093     * Set the icon associated with @p item to an image in a binary buffer.
15094     *
15095     * @param item The toolbar item.
15096     * @param img The binary data that will be used as an image
15097     * @param size The size of binary data @p img
15098     * @param format Optional format of @p img to pass to the image loader
15099     * @param key Optional key of @p img to pass to the image loader (eg. if @p img is an edje file)
15100     *
15101     * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
15102     *
15103     * @note The icon image set by this function can be changed by
15104     * elm_toolbar_item_icon_set().
15105     * 
15106     * @ingroup Toolbar
15107     */
15108    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);
15109
15110    /**
15111     * Delete them item from the toolbar.
15112     *
15113     * @param item The item of toolbar to be deleted.
15114     *
15115     * @see elm_toolbar_item_append()
15116     * @see elm_toolbar_item_del_cb_set()
15117     *
15118     * @ingroup Toolbar
15119     */
15120    EAPI void                    elm_toolbar_item_del(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15121
15122    /**
15123     * Set the function called when a toolbar item is freed.
15124     *
15125     * @param item The item to set the callback on.
15126     * @param func The function called.
15127     *
15128     * If there is a @p func, then it will be called prior item's memory release.
15129     * That will be called with the following arguments:
15130     * @li item's data;
15131     * @li item's Evas object;
15132     * @li item itself;
15133     *
15134     * This way, a data associated to a toolbar item could be properly freed.
15135     *
15136     * @ingroup Toolbar
15137     */
15138    EAPI void                    elm_toolbar_item_del_cb_set(Elm_Toolbar_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
15139
15140    /**
15141     * Get a value whether toolbar item is disabled or not.
15142     *
15143     * @param item The item.
15144     * @return The disabled state.
15145     *
15146     * @see elm_toolbar_item_disabled_set() for more details.
15147     *
15148     * @ingroup Toolbar
15149     */
15150    EAPI Eina_Bool               elm_toolbar_item_disabled_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15151
15152    /**
15153     * Sets the disabled/enabled state of a toolbar item.
15154     *
15155     * @param item The item.
15156     * @param disabled The disabled state.
15157     *
15158     * A disabled item cannot be selected or unselected. It will also
15159     * change its appearance (generally greyed out). This sets the
15160     * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
15161     * enabled).
15162     *
15163     * @ingroup Toolbar
15164     */
15165    EAPI void                    elm_toolbar_item_disabled_set(Elm_Toolbar_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
15166
15167    /**
15168     * Set or unset item as a separator.
15169     *
15170     * @param item The toolbar item.
15171     * @param setting @c EINA_TRUE to set item @p item as separator or
15172     * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
15173     *
15174     * Items aren't set as separator by default.
15175     *
15176     * If set as separator it will display separator theme, so won't display
15177     * icons or label.
15178     *
15179     * @see elm_toolbar_item_separator_get()
15180     *
15181     * @ingroup Toolbar
15182     */
15183    EAPI void                    elm_toolbar_item_separator_set(Elm_Toolbar_Item *item, Eina_Bool separator) EINA_ARG_NONNULL(1);
15184
15185    /**
15186     * Get a value whether item is a separator or not.
15187     *
15188     * @param item The toolbar item.
15189     * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
15190     * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
15191     *
15192     * @see elm_toolbar_item_separator_set() for details.
15193     *
15194     * @ingroup Toolbar
15195     */
15196    EAPI Eina_Bool               elm_toolbar_item_separator_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15197
15198    /**
15199     * Set the shrink state of toolbar @p obj.
15200     *
15201     * @param obj The toolbar object.
15202     * @param shrink_mode Toolbar's items display behavior.
15203     *
15204     * The toolbar won't scroll if #ELM_TOOLBAR_SHRINK_NONE,
15205     * but will enforce a minimun size so all the items will fit, won't scroll
15206     * and won't show the items that don't fit if #ELM_TOOLBAR_SHRINK_HIDE,
15207     * will scroll if #ELM_TOOLBAR_SHRINK_SCROLL, and will create a button to
15208     * pop up excess elements with #ELM_TOOLBAR_SHRINK_MENU.
15209     *
15210     * @ingroup Toolbar
15211     */
15212    EAPI void                    elm_toolbar_mode_shrink_set(Evas_Object *obj, Elm_Toolbar_Shrink_Mode shrink_mode) EINA_ARG_NONNULL(1);
15213
15214    /**
15215     * Get the shrink mode of toolbar @p obj.
15216     *
15217     * @param obj The toolbar object.
15218     * @return Toolbar's items display behavior.
15219     *
15220     * @see elm_toolbar_mode_shrink_set() for details.
15221     *
15222     * @ingroup Toolbar
15223     */
15224    EAPI Elm_Toolbar_Shrink_Mode elm_toolbar_mode_shrink_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15225
15226    /**
15227     * Enable/disable homogenous mode.
15228     *
15229     * @param obj The toolbar object
15230     * @param homogeneous Assume the items within the toolbar are of the
15231     * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
15232     *
15233     * This will enable the homogeneous mode where items are of the same size.
15234     * @see elm_toolbar_homogeneous_get()
15235     *
15236     * @ingroup Toolbar
15237     */
15238    EAPI void                    elm_toolbar_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
15239
15240    /**
15241     * Get whether the homogenous mode is enabled.
15242     *
15243     * @param obj The toolbar object.
15244     * @return Assume the items within the toolbar are of the same height
15245     * and width (EINA_TRUE = on, EINA_FALSE = off).
15246     *
15247     * @see elm_toolbar_homogeneous_set()
15248     *
15249     * @ingroup Toolbar
15250     */
15251    EAPI Eina_Bool               elm_toolbar_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15252
15253    /**
15254     * Enable/disable homogenous mode.
15255     *
15256     * @param obj The toolbar object
15257     * @param homogeneous Assume the items within the toolbar are of the
15258     * same size (EINA_TRUE = on, EINA_FALSE = off). Default is @c EINA_FALSE.
15259     *
15260     * This will enable the homogeneous mode where items are of the same size.
15261     * @see elm_toolbar_homogeneous_get()
15262     *
15263     * @deprecated use elm_toolbar_homogeneous_set() instead.
15264     *
15265     * @ingroup Toolbar
15266     */
15267    EINA_DEPRECATED EAPI void    elm_toolbar_homogenous_set(Evas_Object *obj, Eina_Bool homogenous) EINA_ARG_NONNULL(1);
15268
15269    /**
15270     * Get whether the homogenous mode is enabled.
15271     *
15272     * @param obj The toolbar object.
15273     * @return Assume the items within the toolbar are of the same height
15274     * and width (EINA_TRUE = on, EINA_FALSE = off).
15275     *
15276     * @see elm_toolbar_homogeneous_set()
15277     * @deprecated use elm_toolbar_homogeneous_get() instead.
15278     *
15279     * @ingroup Toolbar
15280     */
15281    EINA_DEPRECATED EAPI Eina_Bool elm_toolbar_homogenous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15282
15283    /**
15284     * Set the parent object of the toolbar items' menus.
15285     *
15286     * @param obj The toolbar object.
15287     * @param parent The parent of the menu objects.
15288     *
15289     * Each item can be set as item menu, with elm_toolbar_item_menu_set().
15290     *
15291     * For more details about setting the parent for toolbar menus, see
15292     * elm_menu_parent_set().
15293     *
15294     * @see elm_menu_parent_set() for details.
15295     * @see elm_toolbar_item_menu_set() for details.
15296     *
15297     * @ingroup Toolbar
15298     */
15299    EAPI void                    elm_toolbar_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
15300
15301    /**
15302     * Get the parent object of the toolbar items' menus.
15303     *
15304     * @param obj The toolbar object.
15305     * @return The parent of the menu objects.
15306     *
15307     * @see elm_toolbar_menu_parent_set() for details.
15308     *
15309     * @ingroup Toolbar
15310     */
15311    EAPI Evas_Object            *elm_toolbar_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15312
15313    /**
15314     * Set the alignment of the items.
15315     *
15316     * @param obj The toolbar object.
15317     * @param align The new alignment, a float between <tt> 0.0 </tt>
15318     * and <tt> 1.0 </tt>.
15319     *
15320     * Alignment of toolbar items, from <tt> 0.0 </tt> to indicates to align
15321     * left, to <tt> 1.0 </tt>, to align to right. <tt> 0.5 </tt> centralize
15322     * items.
15323     *
15324     * Centered items by default.
15325     *
15326     * @see elm_toolbar_align_get()
15327     *
15328     * @ingroup Toolbar
15329     */
15330    EAPI void                    elm_toolbar_align_set(Evas_Object *obj, double align) EINA_ARG_NONNULL(1);
15331
15332    /**
15333     * Get the alignment of the items.
15334     *
15335     * @param obj The toolbar object.
15336     * @return toolbar items alignment, a float between <tt> 0.0 </tt> and
15337     * <tt> 1.0 </tt>.
15338     *
15339     * @see elm_toolbar_align_set() for details.
15340     *
15341     * @ingroup Toolbar
15342     */
15343    EAPI double                  elm_toolbar_align_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15344
15345    /**
15346     * Set whether the toolbar item opens a menu.
15347     *
15348     * @param item The toolbar item.
15349     * @param menu If @c EINA_TRUE, @p item will opens a menu when selected.
15350     *
15351     * A toolbar item can be set to be a menu, using this function.
15352     *
15353     * Once it is set to be a menu, it can be manipulated through the
15354     * menu-like function elm_toolbar_menu_parent_set() and the other
15355     * elm_menu functions, using the Evas_Object @c menu returned by
15356     * elm_toolbar_item_menu_get().
15357     *
15358     * So, items to be displayed in this item's menu should be added with
15359     * elm_menu_item_add().
15360     *
15361     * The following code exemplifies the most basic usage:
15362     * @code
15363     * tb = elm_toolbar_add(win)
15364     * item = elm_toolbar_item_append(tb, "refresh", "Menu", NULL, NULL);
15365     * elm_toolbar_item_menu_set(item, EINA_TRUE);
15366     * elm_toolbar_menu_parent_set(tb, win);
15367     * menu = elm_toolbar_item_menu_get(item);
15368     * elm_menu_item_add(menu, NULL, "edit-cut", "Cut", NULL, NULL);
15369     * menu_item = elm_menu_item_add(menu, NULL, "edit-copy", "Copy", NULL,
15370     * NULL);
15371     * @endcode
15372     *
15373     * @see elm_toolbar_item_menu_get()
15374     *
15375     * @ingroup Toolbar
15376     */
15377    EAPI void                    elm_toolbar_item_menu_set(Elm_Toolbar_Item *item, Eina_Bool menu) EINA_ARG_NONNULL(1);
15378
15379    /**
15380     * Get toolbar item's menu.
15381     *
15382     * @param item The toolbar item.
15383     * @return Item's menu object or @c NULL on failure.
15384     *
15385     * If @p item wasn't set as menu item with elm_toolbar_item_menu_set(),
15386     * this function will set it.
15387     *
15388     * @see elm_toolbar_item_menu_set() for details.
15389     *
15390     * @ingroup Toolbar
15391     */
15392    EAPI Evas_Object            *elm_toolbar_item_menu_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15393
15394    /**
15395     * Add a new state to @p item.
15396     *
15397     * @param item The item.
15398     * @param icon A string with icon name or the absolute path of an image file.
15399     * @param label The label of the new state.
15400     * @param func The function to call when the item is clicked when this
15401     * state is selected.
15402     * @param data The data to associate with the state.
15403     * @return The toolbar item state, or @c NULL upon failure.
15404     *
15405     * Toolbar will load icon image from fdo or current theme.
15406     * This behavior can be set by elm_toolbar_icon_order_lookup_set() function.
15407     * If an absolute path is provided it will load it direct from a file.
15408     *
15409     * States created with this function can be removed with
15410     * elm_toolbar_item_state_del().
15411     *
15412     * @see elm_toolbar_item_state_del()
15413     * @see elm_toolbar_item_state_sel()
15414     * @see elm_toolbar_item_state_get()
15415     *
15416     * @ingroup Toolbar
15417     */
15418    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);
15419
15420    /**
15421     * Delete a previoulsy added state to @p item.
15422     *
15423     * @param item The toolbar item.
15424     * @param state The state to be deleted.
15425     * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
15426     *
15427     * @see elm_toolbar_item_state_add()
15428     */
15429    EAPI Eina_Bool               elm_toolbar_item_state_del(Elm_Toolbar_Item *item, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
15430
15431    /**
15432     * Set @p state as the current state of @p it.
15433     *
15434     * @param it The item.
15435     * @param state The state to use.
15436     * @return @c EINA_TRUE on success or @c EINA_FALSE on failure.
15437     *
15438     * If @p state is @c NULL, it won't select any state and the default item's
15439     * icon and label will be used. It's the same behaviour than
15440     * elm_toolbar_item_state_unser().
15441     *
15442     * @see elm_toolbar_item_state_unset()
15443     *
15444     * @ingroup Toolbar
15445     */
15446    EAPI Eina_Bool               elm_toolbar_item_state_set(Elm_Toolbar_Item *it, Elm_Toolbar_Item_State *state) EINA_ARG_NONNULL(1);
15447
15448    /**
15449     * Unset the state of @p it.
15450     *
15451     * @param it The item.
15452     *
15453     * The default icon and label from this item will be displayed.
15454     *
15455     * @see elm_toolbar_item_state_set() for more details.
15456     *
15457     * @ingroup Toolbar
15458     */
15459    EAPI void                    elm_toolbar_item_state_unset(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15460
15461    /**
15462     * Get the current state of @p it.
15463     *
15464     * @param item The item.
15465     * @return The selected state or @c NULL if none is selected or on failure.
15466     *
15467     * @see elm_toolbar_item_state_set() for details.
15468     * @see elm_toolbar_item_state_unset()
15469     * @see elm_toolbar_item_state_add()
15470     *
15471     * @ingroup Toolbar
15472     */
15473    EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_get(const Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15474
15475    /**
15476     * Get the state after selected state in toolbar's @p item.
15477     *
15478     * @param it The toolbar item to change state.
15479     * @return The state after current state, or @c NULL on failure.
15480     *
15481     * If last state is selected, this function will return first state.
15482     *
15483     * @see elm_toolbar_item_state_set()
15484     * @see elm_toolbar_item_state_add()
15485     *
15486     * @ingroup Toolbar
15487     */
15488    EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_next(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15489
15490    /**
15491     * Get the state before selected state in toolbar's @p item.
15492     *
15493     * @param it The toolbar item to change state.
15494     * @return The state before current state, or @c NULL on failure.
15495     *
15496     * If first state is selected, this function will return last state.
15497     *
15498     * @see elm_toolbar_item_state_set()
15499     * @see elm_toolbar_item_state_add()
15500     *
15501     * @ingroup Toolbar
15502     */
15503    EAPI Elm_Toolbar_Item_State *elm_toolbar_item_state_prev(Elm_Toolbar_Item *it) EINA_ARG_NONNULL(1);
15504
15505    /**
15506     * Set the text to be shown in a given toolbar item's tooltips.
15507     *
15508     * @param item Target item.
15509     * @param text The text to set in the content.
15510     *
15511     * Setup the text as tooltip to object. The item can have only one tooltip,
15512     * so any previous tooltip data - set with this function or
15513     * elm_toolbar_item_tooltip_content_cb_set() - is removed.
15514     *
15515     * @see elm_object_tooltip_text_set() for more details.
15516     *
15517     * @ingroup Toolbar
15518     */
15519    EAPI void             elm_toolbar_item_tooltip_text_set(Elm_Toolbar_Item *item, const char *text) EINA_ARG_NONNULL(1);
15520
15521    /**
15522     * Set the content to be shown in the tooltip item.
15523     *
15524     * Setup the tooltip to item. The item can have only one tooltip,
15525     * so any previous tooltip data is removed. @p func(with @p data) will
15526     * be called every time that need show the tooltip and it should
15527     * return a valid Evas_Object. This object is then managed fully by
15528     * tooltip system and is deleted when the tooltip is gone.
15529     *
15530     * @param item the toolbar item being attached a tooltip.
15531     * @param func the function used to create the tooltip contents.
15532     * @param data what to provide to @a func as callback data/context.
15533     * @param del_cb called when data is not needed anymore, either when
15534     *        another callback replaces @a func, the tooltip is unset with
15535     *        elm_toolbar_item_tooltip_unset() or the owner @a item
15536     *        dies. This callback receives as the first parameter the
15537     *        given @a data, and @c event_info is the item.
15538     *
15539     * @see elm_object_tooltip_content_cb_set() for more details.
15540     *
15541     * @ingroup Toolbar
15542     */
15543    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);
15544
15545    /**
15546     * Unset tooltip from item.
15547     *
15548     * @param item toolbar item to remove previously set tooltip.
15549     *
15550     * Remove tooltip from item. The callback provided as del_cb to
15551     * elm_toolbar_item_tooltip_content_cb_set() will be called to notify
15552     * it is not used anymore.
15553     *
15554     * @see elm_object_tooltip_unset() for more details.
15555     * @see elm_toolbar_item_tooltip_content_cb_set()
15556     *
15557     * @ingroup Toolbar
15558     */
15559    EAPI void             elm_toolbar_item_tooltip_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15560
15561    /**
15562     * Sets a different style for this item tooltip.
15563     *
15564     * @note before you set a style you should define a tooltip with
15565     *       elm_toolbar_item_tooltip_content_cb_set() or
15566     *       elm_toolbar_item_tooltip_text_set()
15567     *
15568     * @param item toolbar item with tooltip already set.
15569     * @param style the theme style to use (default, transparent, ...)
15570     *
15571     * @see elm_object_tooltip_style_set() for more details.
15572     *
15573     * @ingroup Toolbar
15574     */
15575    EAPI void             elm_toolbar_item_tooltip_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
15576
15577    /**
15578     * Get the style for this item tooltip.
15579     *
15580     * @param item toolbar item with tooltip already set.
15581     * @return style the theme style in use, defaults to "default". If the
15582     *         object does not have a tooltip set, then NULL is returned.
15583     *
15584     * @see elm_object_tooltip_style_get() for more details.
15585     * @see elm_toolbar_item_tooltip_style_set()
15586     *
15587     * @ingroup Toolbar
15588     */
15589    EAPI const char      *elm_toolbar_item_tooltip_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15590
15591    /**
15592     * Set the type of mouse pointer/cursor decoration to be shown,
15593     * when the mouse pointer is over the given toolbar widget item
15594     *
15595     * @param item toolbar item to customize cursor on
15596     * @param cursor the cursor type's name
15597     *
15598     * This function works analogously as elm_object_cursor_set(), but
15599     * here the cursor's changing area is restricted to the item's
15600     * area, and not the whole widget's. Note that that item cursors
15601     * have precedence over widget cursors, so that a mouse over an
15602     * item with custom cursor set will always show @b that cursor.
15603     *
15604     * If this function is called twice for an object, a previously set
15605     * cursor will be unset on the second call.
15606     *
15607     * @see elm_object_cursor_set()
15608     * @see elm_toolbar_item_cursor_get()
15609     * @see elm_toolbar_item_cursor_unset()
15610     *
15611     * @ingroup Toolbar
15612     */
15613    EAPI void             elm_toolbar_item_cursor_set(Elm_Toolbar_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
15614
15615    /*
15616     * Get the type of mouse pointer/cursor decoration set to be shown,
15617     * when the mouse pointer is over the given toolbar widget item
15618     *
15619     * @param item toolbar item with custom cursor set
15620     * @return the cursor type's name or @c NULL, if no custom cursors
15621     * were set to @p item (and on errors)
15622     *
15623     * @see elm_object_cursor_get()
15624     * @see elm_toolbar_item_cursor_set()
15625     * @see elm_toolbar_item_cursor_unset()
15626     *
15627     * @ingroup Toolbar
15628     */
15629    EAPI const char      *elm_toolbar_item_cursor_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15630
15631    /**
15632     * Unset any custom mouse pointer/cursor decoration set to be
15633     * shown, when the mouse pointer is over the given toolbar widget
15634     * item, thus making it show the @b default cursor again.
15635     *
15636     * @param item a toolbar item
15637     *
15638     * Use this call to undo any custom settings on this item's cursor
15639     * decoration, bringing it back to defaults (no custom style set).
15640     *
15641     * @see elm_object_cursor_unset()
15642     * @see elm_toolbar_item_cursor_set()
15643     *
15644     * @ingroup Toolbar
15645     */
15646    EAPI void             elm_toolbar_item_cursor_unset(Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15647
15648    /**
15649     * Set a different @b style for a given custom cursor set for a
15650     * toolbar item.
15651     *
15652     * @param item toolbar item with custom cursor set
15653     * @param style the <b>theme style</b> to use (e.g. @c "default",
15654     * @c "transparent", etc)
15655     *
15656     * This function only makes sense when one is using custom mouse
15657     * cursor decorations <b>defined in a theme file</b>, which can have,
15658     * given a cursor name/type, <b>alternate styles</b> on it. It
15659     * works analogously as elm_object_cursor_style_set(), but here
15660     * applyed only to toolbar item objects.
15661     *
15662     * @warning Before you set a cursor style you should have definen a
15663     *       custom cursor previously on the item, with
15664     *       elm_toolbar_item_cursor_set()
15665     *
15666     * @see elm_toolbar_item_cursor_engine_only_set()
15667     * @see elm_toolbar_item_cursor_style_get()
15668     *
15669     * @ingroup Toolbar
15670     */
15671    EAPI void             elm_toolbar_item_cursor_style_set(Elm_Toolbar_Item *item, const char *style) EINA_ARG_NONNULL(1);
15672
15673    /**
15674     * Get the current @b style set for a given toolbar item's custom
15675     * cursor
15676     *
15677     * @param item toolbar item with custom cursor set.
15678     * @return style the cursor style in use. If the object does not
15679     *         have a cursor set, then @c NULL is returned.
15680     *
15681     * @see elm_toolbar_item_cursor_style_set() for more details
15682     *
15683     * @ingroup Toolbar
15684     */
15685    EAPI const char      *elm_toolbar_item_cursor_style_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15686
15687    /**
15688     * Set if the (custom)cursor for a given toolbar item should be
15689     * searched in its theme, also, or should only rely on the
15690     * rendering engine.
15691     *
15692     * @param item item with custom (custom) cursor already set on
15693     * @param engine_only Use @c EINA_TRUE to have cursors looked for
15694     * only on those provided by the rendering engine, @c EINA_FALSE to
15695     * have them searched on the widget's theme, as well.
15696     *
15697     * @note This call is of use only if you've set a custom cursor
15698     * for toolbar items, with elm_toolbar_item_cursor_set().
15699     *
15700     * @note By default, cursors will only be looked for between those
15701     * provided by the rendering engine.
15702     *
15703     * @ingroup Toolbar
15704     */
15705    EAPI void             elm_toolbar_item_cursor_engine_only_set(Elm_Toolbar_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
15706
15707    /**
15708     * Get if the (custom) cursor for a given toolbar item is being
15709     * searched in its theme, also, or is only relying on the rendering
15710     * engine.
15711     *
15712     * @param item a toolbar item
15713     * @return @c EINA_TRUE, if cursors are being looked for only on
15714     * those provided by the rendering engine, @c EINA_FALSE if they
15715     * are being searched on the widget's theme, as well.
15716     *
15717     * @see elm_toolbar_item_cursor_engine_only_set(), for more details
15718     *
15719     * @ingroup Toolbar
15720     */
15721    EAPI Eina_Bool        elm_toolbar_item_cursor_engine_only_get(const Elm_Toolbar_Item *item) EINA_ARG_NONNULL(1);
15722
15723    /**
15724     * Change a toolbar's orientation
15725     * @param obj The toolbar object
15726     * @param vertical If @c EINA_TRUE, the toolbar is vertical
15727     * By default, a toolbar will be horizontal. Use this function to create a vertical toolbar.
15728     * @ingroup Toolbar
15729     * @deprecated use elm_toolbar_horizontal_set() instead.
15730     */
15731    EINA_DEPRECATED EAPI void             elm_toolbar_orientation_set(Evas_Object *obj, Eina_Bool vertical) EINA_ARG_NONNULL(1);
15732
15733    /**
15734     * Change a toolbar's orientation
15735     * @param obj The toolbar object
15736     * @param horizontal If @c EINA_TRUE, the toolbar is horizontal
15737     * By default, a toolbar will be horizontal. Use this function to create a vertical toolbar.
15738     * @ingroup Toolbar
15739     */
15740    EAPI void             elm_toolbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
15741
15742    /**
15743     * Get a toolbar's orientation
15744     * @param obj The toolbar object
15745     * @return If @c EINA_TRUE, the toolbar is vertical
15746     * By default, a toolbar will be horizontal. Use this function to determine whether a toolbar is vertical.
15747     * @ingroup Toolbar
15748     * @deprecated use elm_toolbar_horizontal_get() instead.
15749     */
15750    EINA_DEPRECATED EAPI Eina_Bool        elm_toolbar_orientation_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15751
15752    /**
15753     * Get a toolbar's orientation
15754     * @param obj The toolbar object
15755     * @return If @c EINA_TRUE, the toolbar is horizontal
15756     * By default, a toolbar will be horizontal. Use this function to determine whether a toolbar is vertical.
15757     * @ingroup Toolbar
15758     */
15759    EAPI Eina_Bool elm_toolbar_horizontal_get(const Evas_Object *obj);
15760    /**
15761     * @}
15762     */
15763
15764    /**
15765     * @defgroup Tooltips Tooltips
15766     *
15767     * The Tooltip is an (internal, for now) smart object used to show a
15768     * content in a frame on mouse hover of objects(or widgets), with
15769     * tips/information about them.
15770     *
15771     * @{
15772     */
15773
15774    EAPI double       elm_tooltip_delay_get(void);
15775    EAPI Eina_Bool    elm_tooltip_delay_set(double delay);
15776    EAPI void         elm_object_tooltip_show(Evas_Object *obj) EINA_ARG_NONNULL(1);
15777    EAPI void         elm_object_tooltip_hide(Evas_Object *obj) EINA_ARG_NONNULL(1);
15778    EAPI void         elm_object_tooltip_text_set(Evas_Object *obj, const char *text) EINA_ARG_NONNULL(1, 2);
15779    EAPI void         elm_object_tooltip_domain_translatable_text_set(Evas_Object *obj, const char *domain, const char *text) EINA_ARG_NONNULL(1, 3);
15780 #define elm_object_tooltip_translatable_text_set(obj, text) elm_object_tooltip_domain_translatable_text_set((obj), NULL, (text))
15781    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);
15782    EAPI void         elm_object_tooltip_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15783    EAPI void         elm_object_tooltip_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
15784    EAPI const char  *elm_object_tooltip_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15785    EAPI Eina_Bool    elm_tooltip_size_restrict_disable(Evas_Object *obj, Eina_Bool disable) EINA_ARG_NONNULL(1);
15786    EAPI Eina_Bool    elm_tooltip_size_restrict_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15787
15788    /**
15789     * @}
15790     */
15791
15792    /**
15793     * @defgroup Cursors Cursors
15794     *
15795     * The Elementary cursor is an internal smart object used to
15796     * customize the mouse cursor displayed over objects (or
15797     * widgets). In the most common scenario, the cursor decoration
15798     * comes from the graphical @b engine Elementary is running
15799     * on. Those engines may provide different decorations for cursors,
15800     * and Elementary provides functions to choose them (think of X11
15801     * cursors, as an example).
15802     *
15803     * There's also the possibility of, besides using engine provided
15804     * cursors, also use ones coming from Edje theming files. Both
15805     * globally and per widget, Elementary makes it possible for one to
15806     * make the cursors lookup to be held on engines only or on
15807     * Elementary's theme file, too. To set cursor's hot spot,
15808     * two data items should be added to cursor's theme: "hot_x" and
15809     * "hot_y", that are the offset from upper-left corner of the cursor
15810     * (coordinates 0,0).
15811     *
15812     * @{
15813     */
15814
15815    /**
15816     * Set the cursor to be shown when mouse is over the object
15817     *
15818     * Set the cursor that will be displayed when mouse is over the
15819     * object. The object can have only one cursor set to it, so if
15820     * this function is called twice for an object, the previous set
15821     * will be unset.
15822     * If using X cursors, a definition of all the valid cursor names
15823     * is listed on Elementary_Cursors.h. If an invalid name is set
15824     * the default cursor will be used.
15825     *
15826     * @param obj the object being set a cursor.
15827     * @param cursor the cursor name to be used.
15828     *
15829     * @ingroup Cursors
15830     */
15831    EAPI void         elm_object_cursor_set(Evas_Object *obj, const char *cursor) EINA_ARG_NONNULL(1);
15832
15833    /**
15834     * Get the cursor to be shown when mouse is over the object
15835     *
15836     * @param obj an object with cursor already set.
15837     * @return the cursor name.
15838     *
15839     * @ingroup Cursors
15840     */
15841    EAPI const char  *elm_object_cursor_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15842
15843    /**
15844     * Unset cursor for object
15845     *
15846     * Unset cursor for object, and set the cursor to default if the mouse
15847     * was over this object.
15848     *
15849     * @param obj Target object
15850     * @see elm_object_cursor_set()
15851     *
15852     * @ingroup Cursors
15853     */
15854    EAPI void         elm_object_cursor_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
15855
15856    /**
15857     * Sets a different style for this object cursor.
15858     *
15859     * @note before you set a style you should define a cursor with
15860     *       elm_object_cursor_set()
15861     *
15862     * @param obj an object with cursor already set.
15863     * @param style the theme style to use (default, transparent, ...)
15864     *
15865     * @ingroup Cursors
15866     */
15867    EAPI void         elm_object_cursor_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
15868
15869    /**
15870     * Get the style for this object cursor.
15871     *
15872     * @param obj an object with cursor already set.
15873     * @return style the theme style in use, defaults to "default". If the
15874     *         object does not have a cursor set, then NULL is returned.
15875     *
15876     * @ingroup Cursors
15877     */
15878    EAPI const char  *elm_object_cursor_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15879
15880    /**
15881     * Set if the cursor set should be searched on the theme or should use
15882     * the provided by the engine, only.
15883     *
15884     * @note before you set if should look on theme you should define a cursor
15885     * with elm_object_cursor_set(). By default it will only look for cursors
15886     * provided by the engine.
15887     *
15888     * @param obj an object with cursor already set.
15889     * @param engine_only boolean to define it cursors should be looked only
15890     * between the provided by the engine or searched on widget's theme as well.
15891     *
15892     * @ingroup Cursors
15893     */
15894    EAPI void         elm_object_cursor_engine_only_set(Evas_Object *obj, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
15895
15896    /**
15897     * Get the cursor engine only usage for this object cursor.
15898     *
15899     * @param obj an object with cursor already set.
15900     * @return engine_only boolean to define it cursors should be
15901     * looked only between the provided by the engine or searched on
15902     * widget's theme as well. If the object does not have a cursor
15903     * set, then EINA_FALSE is returned.
15904     *
15905     * @ingroup Cursors
15906     */
15907    EAPI Eina_Bool    elm_object_cursor_engine_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15908
15909    /**
15910     * Get the configured cursor engine only usage
15911     *
15912     * This gets the globally configured exclusive usage of engine cursors.
15913     *
15914     * @return 1 if only engine cursors should be used
15915     * @ingroup Cursors
15916     */
15917    EAPI int          elm_cursor_engine_only_get(void);
15918
15919    /**
15920     * Set the configured cursor engine only usage
15921     *
15922     * This sets the globally configured exclusive usage of engine cursors.
15923     * It won't affect cursors set before changing this value.
15924     *
15925     * @param engine_only If 1 only engine cursors will be enabled, if 0 will
15926     * look for them on theme before.
15927     * @return EINA_TRUE if value is valid and setted (0 or 1)
15928     * @ingroup Cursors
15929     */
15930    EAPI Eina_Bool    elm_cursor_engine_only_set(int engine_only);
15931
15932    /**
15933     * @}
15934     */
15935
15936    /**
15937     * @defgroup Menu Menu
15938     *
15939     * @image html img/widget/menu/preview-00.png
15940     * @image latex img/widget/menu/preview-00.eps
15941     *
15942     * A menu is a list of items displayed above its parent. When the menu is
15943     * showing its parent is darkened. Each item can have a sub-menu. The menu
15944     * object can be used to display a menu on a right click event, in a toolbar,
15945     * anywhere.
15946     *
15947     * Signals that you can add callbacks for are:
15948     * @li "clicked" - the user clicked the empty space in the menu to dismiss.
15949     *             event_info is NULL.
15950     *
15951     * @see @ref tutorial_menu
15952     * @{
15953     */
15954    typedef struct _Elm_Menu_Item Elm_Menu_Item; /**< Item of Elm_Menu. Sub-type of Elm_Widget_Item */
15955    /**
15956     * @brief Add a new menu to the parent
15957     *
15958     * @param parent The parent object.
15959     * @return The new object or NULL if it cannot be created.
15960     */
15961    EAPI Evas_Object       *elm_menu_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
15962    /**
15963     * @brief Set the parent for the given menu widget
15964     *
15965     * @param obj The menu object.
15966     * @param parent The new parent.
15967     */
15968    EAPI void               elm_menu_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1);
15969    /**
15970     * @brief Get the parent for the given menu widget
15971     *
15972     * @param obj The menu object.
15973     * @return The parent.
15974     *
15975     * @see elm_menu_parent_set()
15976     */
15977    EAPI Evas_Object       *elm_menu_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
15978    /**
15979     * @brief Move the menu to a new position
15980     *
15981     * @param obj The menu object.
15982     * @param x The new position.
15983     * @param y The new position.
15984     *
15985     * Sets the top-left position of the menu to (@p x,@p y).
15986     *
15987     * @note @p x and @p y coordinates are relative to parent.
15988     */
15989    EAPI void               elm_menu_move(Evas_Object *obj, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
15990    /**
15991     * @brief Close a opened menu
15992     *
15993     * @param obj the menu object
15994     * @return void
15995     *
15996     * Hides the menu and all it's sub-menus.
15997     */
15998    EAPI void               elm_menu_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
15999    /**
16000     * @brief Returns a list of @p item's items.
16001     *
16002     * @param obj The menu object
16003     * @return An Eina_List* of @p item's items
16004     */
16005    EAPI const Eina_List   *elm_menu_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16006    /**
16007     * @brief Get the Evas_Object of an Elm_Menu_Item
16008     *
16009     * @param item The menu item object.
16010     * @return The edje object containing the swallowed content
16011     *
16012     * @warning Don't manipulate this object!
16013     */
16014    EAPI Evas_Object       *elm_menu_item_object_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
16015    /**
16016     * @brief Add an item at the end of the given menu widget
16017     *
16018     * @param obj The menu object.
16019     * @param parent The parent menu item (optional)
16020     * @param icon A icon display on the item. The icon will be destryed by the menu.
16021     * @param label The label of the item.
16022     * @param func Function called when the user select the item.
16023     * @param data Data sent by the callback.
16024     * @return Returns the new item.
16025     */
16026    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);
16027    /**
16028     * @brief Add an object swallowed in an item at the end of the given menu
16029     * widget
16030     *
16031     * @param obj The menu object.
16032     * @param parent The parent menu item (optional)
16033     * @param subobj The object to swallow
16034     * @param func Function called when the user select the item.
16035     * @param data Data sent by the callback.
16036     * @return Returns the new item.
16037     *
16038     * Add an evas object as an item to the menu.
16039     */
16040    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);
16041    /**
16042     * @brief Set the label of a menu item
16043     *
16044     * @param item The menu item object.
16045     * @param label The label to set for @p item
16046     *
16047     * @warning Don't use this funcion on items created with
16048     * elm_menu_item_add_object() or elm_menu_item_separator_add().
16049     */
16050    EAPI void               elm_menu_item_label_set(Elm_Menu_Item *item, const char *label) EINA_ARG_NONNULL(1);
16051    /**
16052     * @brief Get the label of a menu item
16053     *
16054     * @param item The menu item object.
16055     * @return The label of @p item
16056     */
16057    EAPI const char        *elm_menu_item_label_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
16058    /**
16059     * @brief Set the icon of a menu item to the standard icon with name @p icon
16060     *
16061     * @param item The menu item object.
16062     * @param icon The icon object to set for the content of @p item
16063     *
16064     * Once this icon is set, any previously set icon will be deleted.
16065     */
16066    EAPI void               elm_menu_item_object_icon_name_set(Elm_Menu_Item *item, const char *icon) EINA_ARG_NONNULL(1, 2);
16067    /**
16068     * @brief Get the string representation from the icon of a menu item
16069     *
16070     * @param item The menu item object.
16071     * @return The string representation of @p item's icon or NULL
16072     *
16073     * @see elm_menu_item_object_icon_name_set()
16074     */
16075    EAPI const char        *elm_menu_item_object_icon_name_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
16076    /**
16077     * @brief Set the content object of a menu item
16078     *
16079     * @param item The menu item object
16080     * @param The content object or NULL
16081     * @return EINA_TRUE on success, else EINA_FALSE
16082     *
16083     * Use this function to change the object swallowed by a menu item, deleting
16084     * any previously swallowed object.
16085     */
16086    EAPI Eina_Bool          elm_menu_item_object_content_set(Elm_Menu_Item *item, Evas_Object *obj) EINA_ARG_NONNULL(1);
16087    /**
16088     * @brief Get the content object of a menu item
16089     *
16090     * @param item The menu item object
16091     * @return The content object or NULL
16092     * @note If @p item was added with elm_menu_item_add_object, this
16093     * function will return the object passed, else it will return the
16094     * icon object.
16095     *
16096     * @see elm_menu_item_object_content_set()
16097     */
16098    EAPI Evas_Object *elm_menu_item_object_content_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
16099
16100    EINA_DEPRECATED extern inline void elm_menu_item_icon_set(Elm_Menu_Item *item, const char *icon) EINA_ARG_NONNULL(1, 2)
16101      {
16102         elm_menu_item_object_icon_name_set(item, icon);
16103      }
16104
16105    EINA_DEPRECATED extern inline Evas_Object *elm_menu_item_object_icon_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1)
16106      {
16107         return elm_menu_item_object_content_get(item);
16108      }
16109
16110    EINA_DEPRECATED extern inline const char *elm_menu_item_icon_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1)
16111      {
16112         return elm_menu_item_object_icon_name_get(item);
16113      }
16114
16115    /**
16116     * @brief Set the selected state of @p item.
16117     *
16118     * @param item The menu item object.
16119     * @param selected The selected/unselected state of the item
16120     */
16121    EAPI void               elm_menu_item_selected_set(Elm_Menu_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
16122    /**
16123     * @brief Get the selected state of @p item.
16124     *
16125     * @param item The menu item object.
16126     * @return The selected/unselected state of the item
16127     *
16128     * @see elm_menu_item_selected_set()
16129     */
16130    EAPI Eina_Bool          elm_menu_item_selected_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
16131    /**
16132     * @brief Set the disabled state of @p item.
16133     *
16134     * @param item The menu item object.
16135     * @param disabled The enabled/disabled state of the item
16136     */
16137    EAPI void               elm_menu_item_disabled_set(Elm_Menu_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
16138    /**
16139     * @brief Get the disabled state of @p item.
16140     *
16141     * @param item The menu item object.
16142     * @return The enabled/disabled state of the item
16143     *
16144     * @see elm_menu_item_disabled_set()
16145     */
16146    EAPI Eina_Bool          elm_menu_item_disabled_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
16147    /**
16148     * @brief Add a separator item to menu @p obj under @p parent.
16149     *
16150     * @param obj The menu object
16151     * @param parent The item to add the separator under
16152     * @return The created item or NULL on failure
16153     *
16154     * This is item is a @ref Separator.
16155     */
16156    EAPI Elm_Menu_Item     *elm_menu_item_separator_add(Evas_Object *obj, Elm_Menu_Item *parent) EINA_ARG_NONNULL(1);
16157    /**
16158     * @brief Returns whether @p item is a separator.
16159     *
16160     * @param item The item to check
16161     * @return If true, @p item is a separator
16162     *
16163     * @see elm_menu_item_separator_add()
16164     */
16165    EAPI Eina_Bool          elm_menu_item_is_separator(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
16166    /**
16167     * @brief Deletes an item from the menu.
16168     *
16169     * @param item The item to delete.
16170     *
16171     * @see elm_menu_item_add()
16172     */
16173    EAPI void               elm_menu_item_del(Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
16174    /**
16175     * @brief Set the function called when a menu item is deleted.
16176     *
16177     * @param item The item to set the callback on
16178     * @param func The function called
16179     *
16180     * @see elm_menu_item_add()
16181     * @see elm_menu_item_del()
16182     */
16183    EAPI void               elm_menu_item_del_cb_set(Elm_Menu_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
16184    /**
16185     * @brief Returns the data associated with menu item @p item.
16186     *
16187     * @param item The item
16188     * @return The data associated with @p item or NULL if none was set.
16189     *
16190     * This is the data set with elm_menu_add() or elm_menu_item_data_set().
16191     */
16192    EAPI void              *elm_menu_item_data_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
16193    /**
16194     * @brief Sets the data to be associated with menu item @p item.
16195     *
16196     * @param item The item
16197     * @param data The data to be associated with @p item
16198     */
16199    EAPI void               elm_menu_item_data_set(Elm_Menu_Item *item, const void *data) EINA_ARG_NONNULL(1);
16200    /**
16201     * @brief Returns a list of @p item's subitems.
16202     *
16203     * @param item The item
16204     * @return An Eina_List* of @p item's subitems
16205     *
16206     * @see elm_menu_add()
16207     */
16208    EAPI const Eina_List   *elm_menu_item_subitems_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1);
16209    /**
16210     * @brief Get the position of a menu item
16211     *
16212     * @param item The menu item
16213     * @return The item's index
16214     *
16215     * This function returns the index position of a menu item in a menu.
16216     * For a sub-menu, this number is relative to the first item in the sub-menu.
16217     *
16218     * @note Index values begin with 0
16219     */
16220    EAPI unsigned int       elm_menu_item_index_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
16221    /**
16222     * @brief @brief Return a menu item's owner menu
16223     *
16224     * @param item The menu item
16225     * @return The menu object owning @p item, or NULL on failure
16226     *
16227     * Use this function to get the menu object owning an item.
16228     */
16229    EAPI Evas_Object       *elm_menu_item_menu_get(const Elm_Menu_Item *item) EINA_ARG_NONNULL(1) EINA_PURE;
16230    /**
16231     * @brief Get the selected item in the menu
16232     *
16233     * @param obj The menu object
16234     * @return The selected item, or NULL if none
16235     *
16236     * @see elm_menu_item_selected_get()
16237     * @see elm_menu_item_selected_set()
16238     */
16239    EAPI Elm_Menu_Item *elm_menu_selected_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
16240    /**
16241     * @brief Get the last item in the menu
16242     *
16243     * @param obj The menu object
16244     * @return The last item, or NULL if none
16245     */
16246    EAPI Elm_Menu_Item *elm_menu_last_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
16247    /**
16248     * @brief Get the first item in the menu
16249     *
16250     * @param obj The menu object
16251     * @return The first item, or NULL if none
16252     */
16253    EAPI Elm_Menu_Item *elm_menu_first_item_get(const Evas_Object * obj) EINA_ARG_NONNULL(1);
16254    /**
16255     * @brief Get the next item in the menu.
16256     *
16257     * @param item The menu item object.
16258     * @return The item after it, or NULL if none
16259     */
16260    EAPI Elm_Menu_Item *elm_menu_item_next_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
16261    /**
16262     * @brief Get the previous item in the menu.
16263     *
16264     * @param item The menu item object.
16265     * @return The item before it, or NULL if none
16266     */
16267    EAPI Elm_Menu_Item *elm_menu_item_prev_get(const Elm_Menu_Item *it) EINA_ARG_NONNULL(1);
16268    /**
16269     * @}
16270     */
16271
16272    /**
16273     * @defgroup List List
16274     * @ingroup Elementary
16275     *
16276     * @image html img/widget/list/preview-00.png
16277     * @image latex img/widget/list/preview-00.eps width=\textwidth
16278     *
16279     * @image html img/list.png
16280     * @image latex img/list.eps width=\textwidth
16281     *
16282     * A list widget is a container whose children are displayed vertically or
16283     * horizontally, in order, and can be selected.
16284     * The list can accept only one or multiple items selection. Also has many
16285     * modes of items displaying.
16286     *
16287     * A list is a very simple type of list widget.  For more robust
16288     * lists, @ref Genlist should probably be used.
16289     *
16290     * Smart callbacks one can listen to:
16291     * - @c "activated" - The user has double-clicked or pressed
16292     *   (enter|return|spacebar) on an item. The @c event_info parameter
16293     *   is the item that was activated.
16294     * - @c "clicked,double" - The user has double-clicked an item.
16295     *   The @c event_info parameter is the item that was double-clicked.
16296     * - "selected" - when the user selected an item
16297     * - "unselected" - when the user unselected an item
16298     * - "longpressed" - an item in the list is long-pressed
16299     * - "edge,top" - the list is scrolled until the top edge
16300     * - "edge,bottom" - the list is scrolled until the bottom edge
16301     * - "edge,left" - the list is scrolled until the left edge
16302     * - "edge,right" - the list is scrolled until the right edge
16303     * - "language,changed" - the program's language changed
16304     *
16305     * Available styles for it:
16306     * - @c "default"
16307     *
16308     * List of examples:
16309     * @li @ref list_example_01
16310     * @li @ref list_example_02
16311     * @li @ref list_example_03
16312     */
16313
16314    /**
16315     * @addtogroup List
16316     * @{
16317     */
16318
16319    /**
16320     * @enum _Elm_List_Mode
16321     * @typedef Elm_List_Mode
16322     *
16323     * Set list's resize behavior, transverse axis scroll and
16324     * items cropping. See each mode's description for more details.
16325     *
16326     * @note Default value is #ELM_LIST_SCROLL.
16327     *
16328     * Values <b> don't </b> work as bitmask, only one can be choosen.
16329     *
16330     * @see elm_list_mode_set()
16331     * @see elm_list_mode_get()
16332     *
16333     * @ingroup List
16334     */
16335    typedef enum _Elm_List_Mode
16336      {
16337         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. */
16338         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). */
16339         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. */
16340         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. */
16341         ELM_LIST_LAST /**< Indicates error if returned by elm_list_mode_get() */
16342      } Elm_List_Mode;
16343
16344    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().  */
16345
16346    /**
16347     * Add a new list widget to the given parent Elementary
16348     * (container) object.
16349     *
16350     * @param parent The parent object.
16351     * @return a new list widget handle or @c NULL, on errors.
16352     *
16353     * This function inserts a new list widget on the canvas.
16354     *
16355     * @ingroup List
16356     */
16357    EAPI Evas_Object     *elm_list_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
16358
16359    /**
16360     * Starts the list.
16361     *
16362     * @param obj The list object
16363     *
16364     * @note Call before running show() on the list object.
16365     * @warning If not called, it won't display the list properly.
16366     *
16367     * @code
16368     * li = elm_list_add(win);
16369     * elm_list_item_append(li, "First", NULL, NULL, NULL, NULL);
16370     * elm_list_item_append(li, "Second", NULL, NULL, NULL, NULL);
16371     * elm_list_go(li);
16372     * evas_object_show(li);
16373     * @endcode
16374     *
16375     * @ingroup List
16376     */
16377    EAPI void             elm_list_go(Evas_Object *obj) EINA_ARG_NONNULL(1);
16378
16379    /**
16380     * Enable or disable multiple items selection on the list object.
16381     *
16382     * @param obj The list object
16383     * @param multi @c EINA_TRUE to enable multi selection or @c EINA_FALSE to
16384     * disable it.
16385     *
16386     * Disabled by default. If disabled, the user can select a single item of
16387     * the list each time. Selected items are highlighted on list.
16388     * If enabled, many items can be selected.
16389     *
16390     * If a selected item is selected again, it will be unselected.
16391     *
16392     * @see elm_list_multi_select_get()
16393     *
16394     * @ingroup List
16395     */
16396    EAPI void             elm_list_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
16397
16398    /**
16399     * Get a value whether multiple items selection is enabled or not.
16400     *
16401     * @see elm_list_multi_select_set() for details.
16402     *
16403     * @param obj The list object.
16404     * @return @c EINA_TRUE means multiple items selection is enabled.
16405     * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
16406     * @c EINA_FALSE is returned.
16407     *
16408     * @ingroup List
16409     */
16410    EAPI Eina_Bool        elm_list_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16411
16412    /**
16413     * Set which mode to use for the list object.
16414     *
16415     * @param obj The list object
16416     * @param mode One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
16417     * #ELM_LIST_LIMIT or #ELM_LIST_EXPAND.
16418     *
16419     * Set list's resize behavior, transverse axis scroll and
16420     * items cropping. See each mode's description for more details.
16421     *
16422     * @note Default value is #ELM_LIST_SCROLL.
16423     *
16424     * Only one can be set, if a previous one was set, it will be changed
16425     * by the new mode set. Bitmask won't work as well.
16426     *
16427     * @see elm_list_mode_get()
16428     *
16429     * @ingroup List
16430     */
16431    EAPI void             elm_list_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
16432
16433    /**
16434     * Get the mode the list is at.
16435     *
16436     * @param obj The list object
16437     * @return One of #Elm_List_Mode: #ELM_LIST_COMPRESS, #ELM_LIST_SCROLL,
16438     * #ELM_LIST_LIMIT, #ELM_LIST_EXPAND or #ELM_LIST_LAST on errors.
16439     *
16440     * @note see elm_list_mode_set() for more information.
16441     *
16442     * @ingroup List
16443     */
16444    EAPI Elm_List_Mode    elm_list_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16445
16446    /**
16447     * Enable or disable horizontal mode on the list object.
16448     *
16449     * @param obj The list object.
16450     * @param horizontal @c EINA_TRUE to enable horizontal or @c EINA_FALSE to
16451     * disable it, i.e., to enable vertical mode.
16452     *
16453     * @note Vertical mode is set by default.
16454     *
16455     * On horizontal mode items are displayed on list from left to right,
16456     * instead of from top to bottom. Also, the list will scroll horizontally.
16457     * Each item will presents left icon on top and right icon, or end, at
16458     * the bottom.
16459     *
16460     * @see elm_list_horizontal_get()
16461     *
16462     * @ingroup List
16463     */
16464    EAPI void             elm_list_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
16465
16466    /**
16467     * Get a value whether horizontal mode is enabled or not.
16468     *
16469     * @param obj The list object.
16470     * @return @c EINA_TRUE means horizontal mode selection is enabled.
16471     * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
16472     * @c EINA_FALSE is returned.
16473     *
16474     * @see elm_list_horizontal_set() for details.
16475     *
16476     * @ingroup List
16477     */
16478    EAPI Eina_Bool        elm_list_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16479
16480    /**
16481     * Enable or disable always select mode on the list object.
16482     *
16483     * @param obj The list object
16484     * @param always_select @c EINA_TRUE to enable always select mode or
16485     * @c EINA_FALSE to disable it.
16486     *
16487     * @note Always select mode is disabled by default.
16488     *
16489     * Default behavior of list items is to only call its callback function
16490     * the first time it's pressed, i.e., when it is selected. If a selected
16491     * item is pressed again, and multi-select is disabled, it won't call
16492     * this function (if multi-select is enabled it will unselect the item).
16493     *
16494     * If always select is enabled, it will call the callback function
16495     * everytime a item is pressed, so it will call when the item is selected,
16496     * and again when a selected item is pressed.
16497     *
16498     * @see elm_list_always_select_mode_get()
16499     * @see elm_list_multi_select_set()
16500     *
16501     * @ingroup List
16502     */
16503    EAPI void             elm_list_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
16504
16505    /**
16506     * Get a value whether always select mode is enabled or not, meaning that
16507     * an item will always call its callback function, even if already selected.
16508     *
16509     * @param obj The list object
16510     * @return @c EINA_TRUE means horizontal mode selection is enabled.
16511     * @c EINA_FALSE indicates it's disabled. If @p obj is @c NULL,
16512     * @c EINA_FALSE is returned.
16513     *
16514     * @see elm_list_always_select_mode_set() for details.
16515     *
16516     * @ingroup List
16517     */
16518    EAPI Eina_Bool        elm_list_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16519
16520    /**
16521     * Set bouncing behaviour when the scrolled content reaches an edge.
16522     *
16523     * Tell the internal scroller object whether it should bounce or not
16524     * when it reaches the respective edges for each axis.
16525     *
16526     * @param obj The list object
16527     * @param h_bounce Whether to bounce or not in the horizontal axis.
16528     * @param v_bounce Whether to bounce or not in the vertical axis.
16529     *
16530     * @see elm_scroller_bounce_set()
16531     *
16532     * @ingroup List
16533     */
16534    EAPI void             elm_list_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
16535
16536    /**
16537     * Get the bouncing behaviour of the internal scroller.
16538     *
16539     * Get whether the internal scroller should bounce when the edge of each
16540     * axis is reached scrolling.
16541     *
16542     * @param obj The list object.
16543     * @param h_bounce Pointer where to store the bounce state of the horizontal
16544     * axis.
16545     * @param v_bounce Pointer where to store the bounce state of the vertical
16546     * axis.
16547     *
16548     * @see elm_scroller_bounce_get()
16549     * @see elm_list_bounce_set()
16550     *
16551     * @ingroup List
16552     */
16553    EAPI void             elm_list_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
16554
16555    /**
16556     * Set the scrollbar policy.
16557     *
16558     * @param obj The list object
16559     * @param policy_h Horizontal scrollbar policy.
16560     * @param policy_v Vertical scrollbar policy.
16561     *
16562     * This sets the scrollbar visibility policy for the given scroller.
16563     * #ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it
16564     * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
16565     * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
16566     * This applies respectively for the horizontal and vertical scrollbars.
16567     *
16568     * The both are disabled by default, i.e., are set to
16569     * #ELM_SCROLLER_POLICY_OFF.
16570     *
16571     * @ingroup List
16572     */
16573    EAPI void             elm_list_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
16574
16575    /**
16576     * Get the scrollbar policy.
16577     *
16578     * @see elm_list_scroller_policy_get() for details.
16579     *
16580     * @param obj The list object.
16581     * @param policy_h Pointer where to store horizontal scrollbar policy.
16582     * @param policy_v Pointer where to store vertical scrollbar policy.
16583     *
16584     * @ingroup List
16585     */
16586    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);
16587
16588    /**
16589     * Append a new item to the list object.
16590     *
16591     * @param obj The list object.
16592     * @param label The label of the list item.
16593     * @param icon The icon object to use for the left side of the item. An
16594     * icon can be any Evas object, but usually it is an icon created
16595     * with elm_icon_add().
16596     * @param end The icon object to use for the right side of the item. An
16597     * icon can be any Evas object.
16598     * @param func The function to call when the item is clicked.
16599     * @param data The data to associate with the item for related callbacks.
16600     *
16601     * @return The created item or @c NULL upon failure.
16602     *
16603     * A new item will be created and appended to the list, i.e., will
16604     * be set as @b last item.
16605     *
16606     * Items created with this method can be deleted with
16607     * elm_list_item_del().
16608     *
16609     * Associated @p data can be properly freed when item is deleted if a
16610     * callback function is set with elm_list_item_del_cb_set().
16611     *
16612     * If a function is passed as argument, it will be called everytime this item
16613     * is selected, i.e., the user clicks over an unselected item.
16614     * If always select is enabled it will call this function every time
16615     * user clicks over an item (already selected or not).
16616     * If such function isn't needed, just passing
16617     * @c NULL as @p func is enough. The same should be done for @p data.
16618     *
16619     * Simple example (with no function callback or data associated):
16620     * @code
16621     * li = elm_list_add(win);
16622     * ic = elm_icon_add(win);
16623     * elm_icon_file_set(ic, "path/to/image", NULL);
16624     * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
16625     * elm_list_item_append(li, "label", ic, NULL, NULL, NULL);
16626     * elm_list_go(li);
16627     * evas_object_show(li);
16628     * @endcode
16629     *
16630     * @see elm_list_always_select_mode_set()
16631     * @see elm_list_item_del()
16632     * @see elm_list_item_del_cb_set()
16633     * @see elm_list_clear()
16634     * @see elm_icon_add()
16635     *
16636     * @ingroup List
16637     */
16638    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);
16639
16640    /**
16641     * Prepend a new item to the list object.
16642     *
16643     * @param obj The list object.
16644     * @param label The label of the list item.
16645     * @param icon The icon object to use for the left side of the item. An
16646     * icon can be any Evas object, but usually it is an icon created
16647     * with elm_icon_add().
16648     * @param end The icon object to use for the right side of the item. An
16649     * icon can be any Evas object.
16650     * @param func The function to call when the item is clicked.
16651     * @param data The data to associate with the item for related callbacks.
16652     *
16653     * @return The created item or @c NULL upon failure.
16654     *
16655     * A new item will be created and prepended to the list, i.e., will
16656     * be set as @b first item.
16657     *
16658     * Items created with this method can be deleted with
16659     * elm_list_item_del().
16660     *
16661     * Associated @p data can be properly freed when item is deleted if a
16662     * callback function is set with elm_list_item_del_cb_set().
16663     *
16664     * If a function is passed as argument, it will be called everytime this item
16665     * is selected, i.e., the user clicks over an unselected item.
16666     * If always select is enabled it will call this function every time
16667     * user clicks over an item (already selected or not).
16668     * If such function isn't needed, just passing
16669     * @c NULL as @p func is enough. The same should be done for @p data.
16670     *
16671     * @see elm_list_item_append() for a simple code example.
16672     * @see elm_list_always_select_mode_set()
16673     * @see elm_list_item_del()
16674     * @see elm_list_item_del_cb_set()
16675     * @see elm_list_clear()
16676     * @see elm_icon_add()
16677     *
16678     * @ingroup List
16679     */
16680    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);
16681
16682    /**
16683     * Insert a new item into the list object before item @p before.
16684     *
16685     * @param obj The list object.
16686     * @param before The list item to insert before.
16687     * @param label The label of the list item.
16688     * @param icon The icon object to use for the left side of the item. An
16689     * icon can be any Evas object, but usually it is an icon created
16690     * with elm_icon_add().
16691     * @param end The icon object to use for the right side of the item. An
16692     * icon can be any Evas object.
16693     * @param func The function to call when the item is clicked.
16694     * @param data The data to associate with the item for related callbacks.
16695     *
16696     * @return The created item or @c NULL upon failure.
16697     *
16698     * A new item will be created and added to the list. Its position in
16699     * this list will be just before item @p before.
16700     *
16701     * Items created with this method can be deleted with
16702     * elm_list_item_del().
16703     *
16704     * Associated @p data can be properly freed when item is deleted if a
16705     * callback function is set with elm_list_item_del_cb_set().
16706     *
16707     * If a function is passed as argument, it will be called everytime this item
16708     * is selected, i.e., the user clicks over an unselected item.
16709     * If always select is enabled it will call this function every time
16710     * user clicks over an item (already selected or not).
16711     * If such function isn't needed, just passing
16712     * @c NULL as @p func is enough. The same should be done for @p data.
16713     *
16714     * @see elm_list_item_append() for a simple code example.
16715     * @see elm_list_always_select_mode_set()
16716     * @see elm_list_item_del()
16717     * @see elm_list_item_del_cb_set()
16718     * @see elm_list_clear()
16719     * @see elm_icon_add()
16720     *
16721     * @ingroup List
16722     */
16723    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);
16724
16725    /**
16726     * Insert a new item into the list object after item @p after.
16727     *
16728     * @param obj The list object.
16729     * @param after The list item to insert after.
16730     * @param label The label of the list item.
16731     * @param icon The icon object to use for the left side of the item. An
16732     * icon can be any Evas object, but usually it is an icon created
16733     * with elm_icon_add().
16734     * @param end The icon object to use for the right side of the item. An
16735     * icon can be any Evas object.
16736     * @param func The function to call when the item is clicked.
16737     * @param data The data to associate with the item for related callbacks.
16738     *
16739     * @return The created item or @c NULL upon failure.
16740     *
16741     * A new item will be created and added to the list. Its position in
16742     * this list will be just after item @p after.
16743     *
16744     * Items created with this method can be deleted with
16745     * elm_list_item_del().
16746     *
16747     * Associated @p data can be properly freed when item is deleted if a
16748     * callback function is set with elm_list_item_del_cb_set().
16749     *
16750     * If a function is passed as argument, it will be called everytime this item
16751     * is selected, i.e., the user clicks over an unselected item.
16752     * If always select is enabled it will call this function every time
16753     * user clicks over an item (already selected or not).
16754     * If such function isn't needed, just passing
16755     * @c NULL as @p func is enough. The same should be done for @p data.
16756     *
16757     * @see elm_list_item_append() for a simple code example.
16758     * @see elm_list_always_select_mode_set()
16759     * @see elm_list_item_del()
16760     * @see elm_list_item_del_cb_set()
16761     * @see elm_list_clear()
16762     * @see elm_icon_add()
16763     *
16764     * @ingroup List
16765     */
16766    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);
16767
16768    /**
16769     * Insert a new item into the sorted list object.
16770     *
16771     * @param obj The list object.
16772     * @param label The label of the list item.
16773     * @param icon The icon object to use for the left side of the item. An
16774     * icon can be any Evas object, but usually it is an icon created
16775     * with elm_icon_add().
16776     * @param end The icon object to use for the right side of the item. An
16777     * icon can be any Evas object.
16778     * @param func The function to call when the item is clicked.
16779     * @param data The data to associate with the item for related callbacks.
16780     * @param cmp_func The comparing function to be used to sort list
16781     * items <b>by #Elm_List_Item item handles</b>. This function will
16782     * receive two items and compare them, returning a non-negative integer
16783     * if the second item should be place after the first, or negative value
16784     * if should be placed before.
16785     *
16786     * @return The created item or @c NULL upon failure.
16787     *
16788     * @note This function inserts values into a list object assuming it was
16789     * sorted and the result will be sorted.
16790     *
16791     * A new item will be created and added to the list. Its position in
16792     * this list will be found comparing the new item with previously inserted
16793     * items using function @p cmp_func.
16794     *
16795     * Items created with this method can be deleted with
16796     * elm_list_item_del().
16797     *
16798     * Associated @p data can be properly freed when item is deleted if a
16799     * callback function is set with elm_list_item_del_cb_set().
16800     *
16801     * If a function is passed as argument, it will be called everytime this item
16802     * is selected, i.e., the user clicks over an unselected item.
16803     * If always select is enabled it will call this function every time
16804     * user clicks over an item (already selected or not).
16805     * If such function isn't needed, just passing
16806     * @c NULL as @p func is enough. The same should be done for @p data.
16807     *
16808     * @see elm_list_item_append() for a simple code example.
16809     * @see elm_list_always_select_mode_set()
16810     * @see elm_list_item_del()
16811     * @see elm_list_item_del_cb_set()
16812     * @see elm_list_clear()
16813     * @see elm_icon_add()
16814     *
16815     * @ingroup List
16816     */
16817    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);
16818
16819    /**
16820     * Remove all list's items.
16821     *
16822     * @param obj The list object
16823     *
16824     * @see elm_list_item_del()
16825     * @see elm_list_item_append()
16826     *
16827     * @ingroup List
16828     */
16829    EAPI void             elm_list_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
16830
16831    /**
16832     * Get a list of all the 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     * @see elm_list_item_append()
16839     * @see elm_list_item_del()
16840     * @see elm_list_clear()
16841     *
16842     * @ingroup List
16843     */
16844    EAPI const Eina_List *elm_list_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16845
16846    /**
16847     * Get the selected item.
16848     *
16849     * @param obj The list object.
16850     * @return The selected list item.
16851     *
16852     * The selected item can be unselected with function
16853     * elm_list_item_selected_set().
16854     *
16855     * The selected item always will be highlighted on list.
16856     *
16857     * @see elm_list_selected_items_get()
16858     *
16859     * @ingroup List
16860     */
16861    EAPI Elm_List_Item   *elm_list_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16862
16863    /**
16864     * Return a list of the currently selected list items.
16865     *
16866     * @param obj The list object.
16867     * @return An @c Eina_List of list items, #Elm_List_Item,
16868     * or @c NULL on failure.
16869     *
16870     * Multiple items can be selected if multi select is enabled. It can be
16871     * done with elm_list_multi_select_set().
16872     *
16873     * @see elm_list_selected_item_get()
16874     * @see elm_list_multi_select_set()
16875     *
16876     * @ingroup List
16877     */
16878    EAPI const Eina_List *elm_list_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
16879
16880    /**
16881     * Set the selected state of an item.
16882     *
16883     * @param item The list item
16884     * @param selected The selected state
16885     *
16886     * This sets the selected state of the given item @p it.
16887     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
16888     *
16889     * If a new item is selected the previosly selected will be unselected,
16890     * unless multiple selection is enabled with elm_list_multi_select_set().
16891     * Previoulsy selected item can be get with function
16892     * elm_list_selected_item_get().
16893     *
16894     * Selected items will be highlighted.
16895     *
16896     * @see elm_list_item_selected_get()
16897     * @see elm_list_selected_item_get()
16898     * @see elm_list_multi_select_set()
16899     *
16900     * @ingroup List
16901     */
16902    EAPI void             elm_list_item_selected_set(Elm_List_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
16903
16904    /*
16905     * Get whether the @p item is selected or not.
16906     *
16907     * @param item The list item.
16908     * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
16909     * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
16910     *
16911     * @see elm_list_selected_item_set() for details.
16912     * @see elm_list_item_selected_get()
16913     *
16914     * @ingroup List
16915     */
16916    EAPI Eina_Bool        elm_list_item_selected_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
16917
16918    /**
16919     * Set or unset item as a separator.
16920     *
16921     * @param it The list item.
16922     * @param setting @c EINA_TRUE to set item @p it as separator or
16923     * @c EINA_FALSE to unset, i.e., item will be used as a regular item.
16924     *
16925     * Items aren't set as separator by default.
16926     *
16927     * If set as separator it will display separator theme, so won't display
16928     * icons or label.
16929     *
16930     * @see elm_list_item_separator_get()
16931     *
16932     * @ingroup List
16933     */
16934    EAPI void             elm_list_item_separator_set(Elm_List_Item *it, Eina_Bool setting) EINA_ARG_NONNULL(1);
16935
16936    /**
16937     * Get a value whether item is a separator or not.
16938     *
16939     * @see elm_list_item_separator_set() for details.
16940     *
16941     * @param it The list item.
16942     * @return @c EINA_TRUE means item @p it is a separator. @c EINA_FALSE
16943     * indicates it's not. If @p it is @c NULL, @c EINA_FALSE is returned.
16944     *
16945     * @ingroup List
16946     */
16947    EAPI Eina_Bool        elm_list_item_separator_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
16948
16949    /**
16950     * Show @p item in the list view.
16951     *
16952     * @param item The list item to be shown.
16953     *
16954     * It won't animate list until item is visible. If such behavior is wanted,
16955     * use elm_list_bring_in() intead.
16956     *
16957     * @ingroup List
16958     */
16959    EAPI void             elm_list_item_show(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16960
16961    /**
16962     * Bring in the given item to list view.
16963     *
16964     * @param item The item.
16965     *
16966     * This causes list to jump to the given item @p item and show it
16967     * (by scrolling), if it is not fully visible.
16968     *
16969     * This may use animation to do so and take a period of time.
16970     *
16971     * If animation isn't wanted, elm_list_item_show() can be used.
16972     *
16973     * @ingroup List
16974     */
16975    EAPI void             elm_list_item_bring_in(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16976
16977    /**
16978     * Delete them item from the list.
16979     *
16980     * @param item The item of list to be deleted.
16981     *
16982     * If deleting all list items is required, elm_list_clear()
16983     * should be used instead of getting items list and deleting each one.
16984     *
16985     * @see elm_list_clear()
16986     * @see elm_list_item_append()
16987     * @see elm_list_item_del_cb_set()
16988     *
16989     * @ingroup List
16990     */
16991    EAPI void             elm_list_item_del(Elm_List_Item *item) EINA_ARG_NONNULL(1);
16992
16993    /**
16994     * Set the function called when a list item is freed.
16995     *
16996     * @param item The item to set the callback on
16997     * @param func The function called
16998     *
16999     * If there is a @p func, then it will be called prior item's memory release.
17000     * That will be called with the following arguments:
17001     * @li item's data;
17002     * @li item's Evas object;
17003     * @li item itself;
17004     *
17005     * This way, a data associated to a list item could be properly freed.
17006     *
17007     * @ingroup List
17008     */
17009    EAPI void             elm_list_item_del_cb_set(Elm_List_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
17010
17011    /**
17012     * Get the data associated to the item.
17013     *
17014     * @param item The list item
17015     * @return The data associated to @p item
17016     *
17017     * The return value is a pointer to data associated to @p item when it was
17018     * created, with function elm_list_item_append() or similar. If no data
17019     * was passed as argument, it will return @c NULL.
17020     *
17021     * @see elm_list_item_append()
17022     *
17023     * @ingroup List
17024     */
17025    EAPI void            *elm_list_item_data_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17026
17027    /**
17028     * Get the left side icon associated to the item.
17029     *
17030     * @param item The list item
17031     * @return The left side icon associated to @p item
17032     *
17033     * The return value is a pointer to the icon associated to @p item when
17034     * it was
17035     * created, with function elm_list_item_append() or similar, or later
17036     * with function elm_list_item_icon_set(). If no icon
17037     * was passed as argument, it will return @c NULL.
17038     *
17039     * @see elm_list_item_append()
17040     * @see elm_list_item_icon_set()
17041     *
17042     * @ingroup List
17043     */
17044    EAPI Evas_Object     *elm_list_item_icon_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17045
17046    /**
17047     * Set the left side icon associated to the item.
17048     *
17049     * @param item The list item
17050     * @param icon The left side icon object to associate with @p item
17051     *
17052     * The icon object to use at left side of the item. An
17053     * icon can be any Evas object, but usually it is an icon created
17054     * with elm_icon_add().
17055     *
17056     * Once the icon object is set, a previously set one will be deleted.
17057     * @warning Setting the same icon for two items will cause the icon to
17058     * dissapear from the first item.
17059     *
17060     * If an icon was passed as argument on item creation, with function
17061     * elm_list_item_append() or similar, it will be already
17062     * associated to the item.
17063     *
17064     * @see elm_list_item_append()
17065     * @see elm_list_item_icon_get()
17066     *
17067     * @ingroup List
17068     */
17069    EAPI void             elm_list_item_icon_set(Elm_List_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
17070
17071    /**
17072     * Get the right side icon associated to the item.
17073     *
17074     * @param item The list item
17075     * @return The right side icon associated to @p item
17076     *
17077     * The return value is a pointer to the icon associated to @p item when
17078     * it was
17079     * created, with function elm_list_item_append() or similar, or later
17080     * with function elm_list_item_icon_set(). If no icon
17081     * was passed as argument, it will return @c NULL.
17082     *
17083     * @see elm_list_item_append()
17084     * @see elm_list_item_icon_set()
17085     *
17086     * @ingroup List
17087     */
17088    EAPI Evas_Object     *elm_list_item_end_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17089
17090    /**
17091     * Set the right side icon associated to the item.
17092     *
17093     * @param item The list item
17094     * @param end The right side icon object to associate with @p item
17095     *
17096     * The icon object to use at right side of the item. An
17097     * icon can be any Evas object, but usually it is an icon created
17098     * with elm_icon_add().
17099     *
17100     * Once the icon object is set, a previously set one will be deleted.
17101     * @warning Setting the same icon for two items will cause the icon to
17102     * dissapear from the first item.
17103     *
17104     * If an icon was passed as argument on item creation, with function
17105     * elm_list_item_append() or similar, it will be already
17106     * associated to the item.
17107     *
17108     * @see elm_list_item_append()
17109     * @see elm_list_item_end_get()
17110     *
17111     * @ingroup List
17112     */
17113    EAPI void             elm_list_item_end_set(Elm_List_Item *item, Evas_Object *end) EINA_ARG_NONNULL(1);
17114
17115    /**
17116     * Gets the base object of the item.
17117     *
17118     * @param item The list item
17119     * @return The base object associated with @p item
17120     *
17121     * Base object is the @c Evas_Object that represents that item.
17122     *
17123     * @ingroup List
17124     */
17125    EAPI Evas_Object     *elm_list_item_object_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17126    EINA_DEPRECATED EAPI Evas_Object     *elm_list_item_base_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17127
17128    /**
17129     * Get the label of item.
17130     *
17131     * @param item The item of list.
17132     * @return The label of item.
17133     *
17134     * The return value is a pointer to the label associated to @p item when
17135     * it was created, with function elm_list_item_append(), or later
17136     * with function elm_list_item_label_set. If no label
17137     * was passed as argument, it will return @c NULL.
17138     *
17139     * @see elm_list_item_label_set() for more details.
17140     * @see elm_list_item_append()
17141     *
17142     * @ingroup List
17143     */
17144    EAPI const char      *elm_list_item_label_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17145
17146    /**
17147     * Set the label of item.
17148     *
17149     * @param item The item of list.
17150     * @param text The label of item.
17151     *
17152     * The label to be displayed by the item.
17153     * Label will be placed between left and right side icons (if set).
17154     *
17155     * If a label was passed as argument on item creation, with function
17156     * elm_list_item_append() or similar, it will be already
17157     * displayed by the item.
17158     *
17159     * @see elm_list_item_label_get()
17160     * @see elm_list_item_append()
17161     *
17162     * @ingroup List
17163     */
17164    EAPI void             elm_list_item_label_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
17165
17166
17167    /**
17168     * Get the item before @p it in list.
17169     *
17170     * @param it The list item.
17171     * @return The item before @p it, or @c NULL if none or on failure.
17172     *
17173     * @note If it is the first item, @c NULL will be returned.
17174     *
17175     * @see elm_list_item_append()
17176     * @see elm_list_items_get()
17177     *
17178     * @ingroup List
17179     */
17180    EAPI Elm_List_Item   *elm_list_item_prev(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
17181
17182    /**
17183     * Get the item after @p it in list.
17184     *
17185     * @param it The list item.
17186     * @return The item after @p it, or @c NULL if none or on failure.
17187     *
17188     * @note If it is the last item, @c NULL will be returned.
17189     *
17190     * @see elm_list_item_append()
17191     * @see elm_list_items_get()
17192     *
17193     * @ingroup List
17194     */
17195    EAPI Elm_List_Item   *elm_list_item_next(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
17196
17197    /**
17198     * Sets the disabled/enabled state of a list item.
17199     *
17200     * @param it The item.
17201     * @param disabled The disabled state.
17202     *
17203     * A disabled item cannot be selected or unselected. It will also
17204     * change its appearance (generally greyed out). This sets the
17205     * disabled state (@c EINA_TRUE for disabled, @c EINA_FALSE for
17206     * enabled).
17207     *
17208     * @ingroup List
17209     */
17210    EAPI void             elm_list_item_disabled_set(Elm_List_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
17211
17212    /**
17213     * Get a value whether list item is disabled or not.
17214     *
17215     * @param it The item.
17216     * @return The disabled state.
17217     *
17218     * @see elm_list_item_disabled_set() for more details.
17219     *
17220     * @ingroup List
17221     */
17222    EAPI Eina_Bool        elm_list_item_disabled_get(const Elm_List_Item *it) EINA_ARG_NONNULL(1);
17223
17224    /**
17225     * Set the text to be shown in a given list item's tooltips.
17226     *
17227     * @param item Target item.
17228     * @param text The text to set in the content.
17229     *
17230     * Setup the text as tooltip to object. The item can have only one tooltip,
17231     * so any previous tooltip data - set with this function or
17232     * elm_list_item_tooltip_content_cb_set() - is removed.
17233     *
17234     * @see elm_object_tooltip_text_set() for more details.
17235     *
17236     * @ingroup List
17237     */
17238    EAPI void             elm_list_item_tooltip_text_set(Elm_List_Item *item, const char *text) EINA_ARG_NONNULL(1);
17239
17240
17241    /**
17242     * @brief Disable size restrictions on an object's tooltip
17243     * @param item The tooltip's anchor object
17244     * @param disable If EINA_TRUE, size restrictions are disabled
17245     * @return EINA_FALSE on failure, EINA_TRUE on success
17246     *
17247     * This function allows a tooltip to expand beyond its parant window's canvas.
17248     * It will instead be limited only by the size of the display.
17249     */
17250    EAPI Eina_Bool        elm_list_item_tooltip_size_restrict_disable(Elm_List_Item *item, Eina_Bool disable) EINA_ARG_NONNULL(1);
17251    /**
17252     * @brief Retrieve size restriction state of an object's tooltip
17253     * @param obj The tooltip's anchor object
17254     * @return If EINA_TRUE, size restrictions are disabled
17255     *
17256     * This function returns whether a tooltip is allowed to expand beyond
17257     * its parant window's canvas.
17258     * It will instead be limited only by the size of the display.
17259     */
17260    EAPI Eina_Bool        elm_list_item_tooltip_size_restrict_disabled_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17261
17262    /**
17263     * Set the content to be shown in the tooltip item.
17264     *
17265     * Setup the tooltip to item. The item can have only one tooltip,
17266     * so any previous tooltip data is removed. @p func(with @p data) will
17267     * be called every time that need show the tooltip and it should
17268     * return a valid Evas_Object. This object is then managed fully by
17269     * tooltip system and is deleted when the tooltip is gone.
17270     *
17271     * @param item the list item being attached a tooltip.
17272     * @param func the function used to create the tooltip contents.
17273     * @param data what to provide to @a func as callback data/context.
17274     * @param del_cb called when data is not needed anymore, either when
17275     *        another callback replaces @a func, the tooltip is unset with
17276     *        elm_list_item_tooltip_unset() or the owner @a item
17277     *        dies. This callback receives as the first parameter the
17278     *        given @a data, and @c event_info is the item.
17279     *
17280     * @see elm_object_tooltip_content_cb_set() for more details.
17281     *
17282     * @ingroup List
17283     */
17284    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);
17285
17286    /**
17287     * Unset tooltip from item.
17288     *
17289     * @param item list item to remove previously set tooltip.
17290     *
17291     * Remove tooltip from item. The callback provided as del_cb to
17292     * elm_list_item_tooltip_content_cb_set() will be called to notify
17293     * it is not used anymore.
17294     *
17295     * @see elm_object_tooltip_unset() for more details.
17296     * @see elm_list_item_tooltip_content_cb_set()
17297     *
17298     * @ingroup List
17299     */
17300    EAPI void             elm_list_item_tooltip_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
17301
17302    /**
17303     * Sets a different style for this item tooltip.
17304     *
17305     * @note before you set a style you should define a tooltip with
17306     *       elm_list_item_tooltip_content_cb_set() or
17307     *       elm_list_item_tooltip_text_set()
17308     *
17309     * @param item list item with tooltip already set.
17310     * @param style the theme style to use (default, transparent, ...)
17311     *
17312     * @see elm_object_tooltip_style_set() for more details.
17313     *
17314     * @ingroup List
17315     */
17316    EAPI void             elm_list_item_tooltip_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
17317
17318    /**
17319     * Get the style for this item tooltip.
17320     *
17321     * @param item list item with tooltip already set.
17322     * @return style the theme style in use, defaults to "default". If the
17323     *         object does not have a tooltip set, then NULL is returned.
17324     *
17325     * @see elm_object_tooltip_style_get() for more details.
17326     * @see elm_list_item_tooltip_style_set()
17327     *
17328     * @ingroup List
17329     */
17330    EAPI const char      *elm_list_item_tooltip_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17331
17332    /**
17333     * Set the type of mouse pointer/cursor decoration to be shown,
17334     * when the mouse pointer is over the given list widget item
17335     *
17336     * @param item list item to customize cursor on
17337     * @param cursor the cursor type's name
17338     *
17339     * This function works analogously as elm_object_cursor_set(), but
17340     * here the cursor's changing area is restricted to the item's
17341     * area, and not the whole widget's. Note that that item cursors
17342     * have precedence over widget cursors, so that a mouse over an
17343     * item with custom cursor set will always show @b that cursor.
17344     *
17345     * If this function is called twice for an object, a previously set
17346     * cursor will be unset on the second call.
17347     *
17348     * @see elm_object_cursor_set()
17349     * @see elm_list_item_cursor_get()
17350     * @see elm_list_item_cursor_unset()
17351     *
17352     * @ingroup List
17353     */
17354    EAPI void             elm_list_item_cursor_set(Elm_List_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
17355
17356    /*
17357     * Get the type of mouse pointer/cursor decoration set to be shown,
17358     * when the mouse pointer is over the given list widget item
17359     *
17360     * @param item list item with custom cursor set
17361     * @return the cursor type's name or @c NULL, if no custom cursors
17362     * were set to @p item (and on errors)
17363     *
17364     * @see elm_object_cursor_get()
17365     * @see elm_list_item_cursor_set()
17366     * @see elm_list_item_cursor_unset()
17367     *
17368     * @ingroup List
17369     */
17370    EAPI const char      *elm_list_item_cursor_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17371
17372    /**
17373     * Unset any custom mouse pointer/cursor decoration set to be
17374     * shown, when the mouse pointer is over the given list widget
17375     * item, thus making it show the @b default cursor again.
17376     *
17377     * @param item a list item
17378     *
17379     * Use this call to undo any custom settings on this item's cursor
17380     * decoration, bringing it back to defaults (no custom style set).
17381     *
17382     * @see elm_object_cursor_unset()
17383     * @see elm_list_item_cursor_set()
17384     *
17385     * @ingroup List
17386     */
17387    EAPI void             elm_list_item_cursor_unset(Elm_List_Item *item) EINA_ARG_NONNULL(1);
17388
17389    /**
17390     * Set a different @b style for a given custom cursor set for a
17391     * list item.
17392     *
17393     * @param item list item with custom cursor set
17394     * @param style the <b>theme style</b> to use (e.g. @c "default",
17395     * @c "transparent", etc)
17396     *
17397     * This function only makes sense when one is using custom mouse
17398     * cursor decorations <b>defined in a theme file</b>, which can have,
17399     * given a cursor name/type, <b>alternate styles</b> on it. It
17400     * works analogously as elm_object_cursor_style_set(), but here
17401     * applyed only to list item objects.
17402     *
17403     * @warning Before you set a cursor style you should have definen a
17404     *       custom cursor previously on the item, with
17405     *       elm_list_item_cursor_set()
17406     *
17407     * @see elm_list_item_cursor_engine_only_set()
17408     * @see elm_list_item_cursor_style_get()
17409     *
17410     * @ingroup List
17411     */
17412    EAPI void             elm_list_item_cursor_style_set(Elm_List_Item *item, const char *style) EINA_ARG_NONNULL(1);
17413
17414    /**
17415     * Get the current @b style set for a given list item's custom
17416     * cursor
17417     *
17418     * @param item list item with custom cursor set.
17419     * @return style the cursor style in use. If the object does not
17420     *         have a cursor set, then @c NULL is returned.
17421     *
17422     * @see elm_list_item_cursor_style_set() for more details
17423     *
17424     * @ingroup List
17425     */
17426    EAPI const char      *elm_list_item_cursor_style_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17427
17428    /**
17429     * Set if the (custom)cursor for a given list item should be
17430     * searched in its theme, also, or should only rely on the
17431     * rendering engine.
17432     *
17433     * @param item item with custom (custom) cursor already set on
17434     * @param engine_only Use @c EINA_TRUE to have cursors looked for
17435     * only on those provided by the rendering engine, @c EINA_FALSE to
17436     * have them searched on the widget's theme, as well.
17437     *
17438     * @note This call is of use only if you've set a custom cursor
17439     * for list items, with elm_list_item_cursor_set().
17440     *
17441     * @note By default, cursors will only be looked for between those
17442     * provided by the rendering engine.
17443     *
17444     * @ingroup List
17445     */
17446    EAPI void             elm_list_item_cursor_engine_only_set(Elm_List_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
17447
17448    /**
17449     * Get if the (custom) cursor for a given list item is being
17450     * searched in its theme, also, or is only relying on the rendering
17451     * engine.
17452     *
17453     * @param item a list item
17454     * @return @c EINA_TRUE, if cursors are being looked for only on
17455     * those provided by the rendering engine, @c EINA_FALSE if they
17456     * are being searched on the widget's theme, as well.
17457     *
17458     * @see elm_list_item_cursor_engine_only_set(), for more details
17459     *
17460     * @ingroup List
17461     */
17462    EAPI Eina_Bool        elm_list_item_cursor_engine_only_get(const Elm_List_Item *item) EINA_ARG_NONNULL(1);
17463
17464    /**
17465     * @}
17466     */
17467
17468    /**
17469     * @defgroup Slider Slider
17470     * @ingroup Elementary
17471     *
17472     * @image html img/widget/slider/preview-00.png
17473     * @image latex img/widget/slider/preview-00.eps width=\textwidth
17474     *
17475     * The slider adds a dragable “slider” widget for selecting the value of
17476     * something within a range.
17477     *
17478     * A slider can be horizontal or vertical. It can contain an Icon and has a
17479     * primary label as well as a units label (that is formatted with floating
17480     * point values and thus accepts a printf-style format string, like
17481     * “%1.2f units”. There is also an indicator string that may be somewhere
17482     * else (like on the slider itself) that also accepts a format string like
17483     * units. Label, Icon Unit and Indicator strings/objects are optional.
17484     *
17485     * A slider may be inverted which means values invert, with high vales being
17486     * on the left or top and low values on the right or bottom (as opposed to
17487     * normally being low on the left or top and high on the bottom and right).
17488     *
17489     * The slider should have its minimum and maximum values set by the
17490     * application with  elm_slider_min_max_set() and value should also be set by
17491     * the application before use with  elm_slider_value_set(). The span of the
17492     * slider is its length (horizontally or vertically). This will be scaled by
17493     * the object or applications scaling factor. At any point code can query the
17494     * slider for its value with elm_slider_value_get().
17495     *
17496     * Smart callbacks one can listen to:
17497     * - "changed" - Whenever the slider value is changed by the user.
17498     * - "slider,drag,start" - dragging the slider indicator around has started.
17499     * - "slider,drag,stop" - dragging the slider indicator around has stopped.
17500     * - "delay,changed" - A short time after the value is changed by the user.
17501     * This will be called only when the user stops dragging for
17502     * a very short period or when they release their
17503     * finger/mouse, so it avoids possibly expensive reactions to
17504     * the value change.
17505     *
17506     * Available styles for it:
17507     * - @c "default"
17508     *
17509     * Default contents parts of the slider widget that you can use for are:
17510     * @li "icon" - A icon of the slider
17511     * @li "end" - A end part content of the slider
17512     * 
17513     * Default text parts of the silder widget that you can use for are:
17514     * @li "default" - Label of the silder
17515     * Here is an example on its usage:
17516     * @li @ref slider_example
17517     */
17518
17519    /**
17520     * @addtogroup Slider
17521     * @{
17522     */
17523
17524    /**
17525     * Add a new slider widget to the given parent Elementary
17526     * (container) object.
17527     *
17528     * @param parent The parent object.
17529     * @return a new slider widget handle or @c NULL, on errors.
17530     *
17531     * This function inserts a new slider widget on the canvas.
17532     *
17533     * @ingroup Slider
17534     */
17535    EAPI Evas_Object       *elm_slider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
17536
17537    /**
17538     * Set the label of a given slider widget
17539     *
17540     * @param obj The progress bar object
17541     * @param label The text label string, in UTF-8
17542     *
17543     * @ingroup Slider
17544     * @deprecated use elm_object_text_set() instead.
17545     */
17546    EINA_DEPRECATED EAPI void               elm_slider_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
17547
17548    /**
17549     * Get the label of a given slider widget
17550     *
17551     * @param obj The progressbar object
17552     * @return The text label string, in UTF-8
17553     *
17554     * @ingroup Slider
17555     * @deprecated use elm_object_text_get() instead.
17556     */
17557    WILL_DEPRECATE  EAPI const char        *elm_slider_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17558
17559    /**
17560     * Set the icon object of the slider object.
17561     *
17562     * @param obj The slider object.
17563     * @param icon The icon object.
17564     *
17565     * On horizontal mode, icon is placed at left, and on vertical mode,
17566     * placed at top.
17567     *
17568     * @note Once the icon object is set, a previously set one will be deleted.
17569     * If you want to keep that old content object, use the
17570     * elm_slider_icon_unset() function.
17571     *
17572     * @warning If the object being set does not have minimum size hints set,
17573     * it won't get properly displayed.
17574     *
17575     * @ingroup Slider
17576     * @deprecated use elm_object_part_content_set() instead.
17577     */
17578    WILL_DEPRECATE  EAPI void               elm_slider_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
17579
17580    /**
17581     * Unset an icon set on a given slider widget.
17582     *
17583     * @param obj The slider object.
17584     * @return The icon object that was being used, if any was set, or
17585     * @c NULL, otherwise (and on errors).
17586     *
17587     * On horizontal mode, icon is placed at left, and on vertical mode,
17588     * placed at top.
17589     *
17590     * This call will unparent and return the icon object which was set
17591     * for this widget, previously, on success.
17592     *
17593     * @see elm_slider_icon_set() for more details
17594     * @see elm_slider_icon_get()
17595     * @deprecated use elm_object_part_content_unset() instead.
17596     *
17597     * @ingroup Slider
17598     */
17599    WILL_DEPRECATE  EAPI Evas_Object       *elm_slider_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
17600
17601    /**
17602     * Retrieve the icon object set for a given slider widget.
17603     *
17604     * @param obj The slider object.
17605     * @return The icon object's handle, if @p obj had one set, or @c NULL,
17606     * otherwise (and on errors).
17607     *
17608     * On horizontal mode, icon is placed at left, and on vertical mode,
17609     * placed at top.
17610     *
17611     * @see elm_slider_icon_set() for more details
17612     * @see elm_slider_icon_unset()
17613     *
17614     * @deprecated use elm_object_part_content_get() instead.
17615     *
17616     * @ingroup Slider
17617     */
17618    WILL_DEPRECATE  EAPI Evas_Object       *elm_slider_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17619
17620    /**
17621     * Set the end object of the slider object.
17622     *
17623     * @param obj The slider object.
17624     * @param end The end object.
17625     *
17626     * On horizontal mode, end is placed at left, and on vertical mode,
17627     * placed at bottom.
17628     *
17629     * @note Once the icon object is set, a previously set one will be deleted.
17630     * If you want to keep that old content object, use the
17631     * elm_slider_end_unset() function.
17632     *
17633     * @warning If the object being set does not have minimum size hints set,
17634     * it won't get properly displayed.
17635     *
17636     * @deprecated use elm_object_part_content_set() instead.
17637     *
17638     * @ingroup Slider
17639     */
17640    WILL_DEPRECATE  EAPI void               elm_slider_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1);
17641
17642    /**
17643     * Unset an end object set on a given slider widget.
17644     *
17645     * @param obj The slider object.
17646     * @return The end object that was being used, if any was set, or
17647     * @c NULL, otherwise (and on errors).
17648     *
17649     * On horizontal mode, end is placed at left, and on vertical mode,
17650     * placed at bottom.
17651     *
17652     * This call will unparent and return the icon object which was set
17653     * for this widget, previously, on success.
17654     *
17655     * @see elm_slider_end_set() for more details.
17656     * @see elm_slider_end_get()
17657     *
17658     * @deprecated use elm_object_part_content_unset() instead
17659     * instead.
17660     *
17661     * @ingroup Slider
17662     */
17663    WILL_DEPRECATE  EAPI Evas_Object       *elm_slider_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
17664
17665    /**
17666     * Retrieve the end object set for a given slider widget.
17667     *
17668     * @param obj The slider object.
17669     * @return The end object's handle, if @p obj had one set, or @c NULL,
17670     * otherwise (and on errors).
17671     *
17672     * On horizontal mode, icon is placed at right, and on vertical mode,
17673     * placed at bottom.
17674     *
17675     * @see elm_slider_end_set() for more details.
17676     * @see elm_slider_end_unset()
17677     *
17678     *
17679     * @deprecated use elm_object_part_content_get() instead 
17680     * instead.
17681     *
17682     * @ingroup Slider
17683     */
17684    WILL_DEPRECATE  EAPI Evas_Object       *elm_slider_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17685
17686    /**
17687     * Set the (exact) length of the bar region of a given slider widget.
17688     *
17689     * @param obj The slider object.
17690     * @param size The length of the slider's bar region.
17691     *
17692     * This sets the minimum width (when in horizontal mode) or height
17693     * (when in vertical mode) of the actual bar area of the slider
17694     * @p obj. This in turn affects the object's minimum size. Use
17695     * this when you're not setting other size hints expanding on the
17696     * given direction (like weight and alignment hints) and you would
17697     * like it to have a specific size.
17698     *
17699     * @note Icon, end, label, indicator and unit text around @p obj
17700     * will require their
17701     * own space, which will make @p obj to require more the @p size,
17702     * actually.
17703     *
17704     * @see elm_slider_span_size_get()
17705     *
17706     * @ingroup Slider
17707     */
17708    EAPI void               elm_slider_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
17709
17710    /**
17711     * Get the length set for the bar region of a given slider widget
17712     *
17713     * @param obj The slider object.
17714     * @return The length of the slider's bar region.
17715     *
17716     * If that size was not set previously, with
17717     * elm_slider_span_size_set(), this call will return @c 0.
17718     *
17719     * @ingroup Slider
17720     */
17721    EAPI Evas_Coord         elm_slider_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17722
17723    /**
17724     * Set the format string for the unit label.
17725     *
17726     * @param obj The slider object.
17727     * @param format The format string for the unit display.
17728     *
17729     * Unit label is displayed all the time, if set, after slider's bar.
17730     * In horizontal mode, at right and in vertical mode, at bottom.
17731     *
17732     * If @c NULL, unit label won't be visible. If not it sets the format
17733     * string for the label text. To the label text is provided a floating point
17734     * value, so the label text can display up to 1 floating point value.
17735     * Note that this is optional.
17736     *
17737     * Use a format string such as "%1.2f meters" for example, and it will
17738     * display values like: "3.14 meters" for a value equal to 3.14159.
17739     *
17740     * Default is unit label disabled.
17741     *
17742     * @see elm_slider_indicator_format_get()
17743     *
17744     * @ingroup Slider
17745     */
17746    EAPI void               elm_slider_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
17747
17748    /**
17749     * Get the unit label format of the slider.
17750     *
17751     * @param obj The slider object.
17752     * @return The unit label format string in UTF-8.
17753     *
17754     * Unit label is displayed all the time, if set, after slider's bar.
17755     * In horizontal mode, at right and in vertical mode, at bottom.
17756     *
17757     * @see elm_slider_unit_format_set() for more
17758     * information on how this works.
17759     *
17760     * @ingroup Slider
17761     */
17762    EAPI const char        *elm_slider_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17763
17764    /**
17765     * Set the format string for the indicator label.
17766     *
17767     * @param obj The slider object.
17768     * @param indicator The format string for the indicator display.
17769     *
17770     * The slider may display its value somewhere else then unit label,
17771     * for example, above the slider knob that is dragged around. This function
17772     * sets the format string used for this.
17773     *
17774     * If @c NULL, indicator label won't be visible. If not it sets the format
17775     * string for the label text. To the label text is provided a floating point
17776     * value, so the label text can display up to 1 floating point value.
17777     * Note that this is optional.
17778     *
17779     * Use a format string such as "%1.2f meters" for example, and it will
17780     * display values like: "3.14 meters" for a value equal to 3.14159.
17781     *
17782     * Default is indicator label disabled.
17783     *
17784     * @see elm_slider_indicator_format_get()
17785     *
17786     * @ingroup Slider
17787     */
17788    EAPI void               elm_slider_indicator_format_set(Evas_Object *obj, const char *indicator) EINA_ARG_NONNULL(1);
17789
17790    /**
17791     * Get the indicator label format of the slider.
17792     *
17793     * @param obj The slider object.
17794     * @return The indicator label format string in UTF-8.
17795     *
17796     * The slider may display its value somewhere else then unit label,
17797     * for example, above the slider knob that is dragged around. This function
17798     * gets the format string used for this.
17799     *
17800     * @see elm_slider_indicator_format_set() for more
17801     * information on how this works.
17802     *
17803     * @ingroup Slider
17804     */
17805    EAPI const char        *elm_slider_indicator_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17806
17807    /**
17808     * Set the format function pointer for the indicator label
17809     *
17810     * @param obj The slider object.
17811     * @param func The indicator format function.
17812     * @param free_func The freeing function for the format string.
17813     *
17814     * Set the callback function to format the indicator string.
17815     *
17816     * @see elm_slider_indicator_format_set() for more info on how this works.
17817     *
17818     * @ingroup Slider
17819     */
17820   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);
17821
17822   /**
17823    * Set the format function pointer for the units label
17824    *
17825    * @param obj The slider object.
17826    * @param func The units format function.
17827    * @param free_func The freeing function for the format string.
17828    *
17829    * Set the callback function to format the indicator string.
17830    *
17831    * @see elm_slider_units_format_set() for more info on how this works.
17832    *
17833    * @ingroup Slider
17834    */
17835   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);
17836
17837   /**
17838    * Set the orientation of a given slider widget.
17839    *
17840    * @param obj The slider object.
17841    * @param horizontal Use @c EINA_TRUE to make @p obj to be
17842    * @b horizontal, @c EINA_FALSE to make it @b vertical.
17843    *
17844    * Use this function to change how your slider is to be
17845    * disposed: vertically or horizontally.
17846    *
17847    * By default it's displayed horizontally.
17848    *
17849    * @see elm_slider_horizontal_get()
17850    *
17851    * @ingroup Slider
17852    */
17853    EAPI void               elm_slider_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
17854
17855    /**
17856     * Retrieve the orientation of a given slider widget
17857     *
17858     * @param obj The slider object.
17859     * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
17860     * @c EINA_FALSE if it's @b vertical (and on errors).
17861     *
17862     * @see elm_slider_horizontal_set() for more details.
17863     *
17864     * @ingroup Slider
17865     */
17866    EAPI Eina_Bool          elm_slider_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17867
17868    /**
17869     * Set the minimum and maximum values for the slider.
17870     *
17871     * @param obj The slider object.
17872     * @param min The minimum value.
17873     * @param max The maximum value.
17874     *
17875     * Define the allowed range of values to be selected by the user.
17876     *
17877     * If actual value is less than @p min, it will be updated to @p min. If it
17878     * is bigger then @p max, will be updated to @p max. Actual value can be
17879     * get with elm_slider_value_get().
17880     *
17881     * By default, min is equal to 0.0, and max is equal to 1.0.
17882     *
17883     * @warning Maximum must be greater than minimum, otherwise behavior
17884     * is undefined.
17885     *
17886     * @see elm_slider_min_max_get()
17887     *
17888     * @ingroup Slider
17889     */
17890    EAPI void               elm_slider_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
17891
17892    /**
17893     * Get the minimum and maximum values of the slider.
17894     *
17895     * @param obj The slider object.
17896     * @param min Pointer where to store the minimum value.
17897     * @param max Pointer where to store the maximum value.
17898     *
17899     * @note If only one value is needed, the other pointer can be passed
17900     * as @c NULL.
17901     *
17902     * @see elm_slider_min_max_set() for details.
17903     *
17904     * @ingroup Slider
17905     */
17906    EAPI void               elm_slider_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
17907
17908    /**
17909     * Set the value the slider displays.
17910     *
17911     * @param obj The slider object.
17912     * @param val The value to be displayed.
17913     *
17914     * Value will be presented on the unit label following format specified with
17915     * elm_slider_unit_format_set() and on indicator with
17916     * elm_slider_indicator_format_set().
17917     *
17918     * @warning The value must to be between min and max values. This values
17919     * are set by elm_slider_min_max_set().
17920     *
17921     * @see elm_slider_value_get()
17922     * @see elm_slider_unit_format_set()
17923     * @see elm_slider_indicator_format_set()
17924     * @see elm_slider_min_max_set()
17925     *
17926     * @ingroup Slider
17927     */
17928    EAPI void               elm_slider_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
17929
17930    /**
17931     * Get the value displayed by the spinner.
17932     *
17933     * @param obj The spinner object.
17934     * @return The value displayed.
17935     *
17936     * @see elm_spinner_value_set() for details.
17937     *
17938     * @ingroup Slider
17939     */
17940    EAPI double             elm_slider_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17941
17942    /**
17943     * Invert a given slider widget's displaying values order
17944     *
17945     * @param obj The slider object.
17946     * @param inverted Use @c EINA_TRUE to make @p obj inverted,
17947     * @c EINA_FALSE to bring it back to default, non-inverted values.
17948     *
17949     * A slider may be @b inverted, in which state it gets its
17950     * values inverted, with high vales being on the left or top and
17951     * low values on the right or bottom, as opposed to normally have
17952     * the low values on the former and high values on the latter,
17953     * respectively, for horizontal and vertical modes.
17954     *
17955     * @see elm_slider_inverted_get()
17956     *
17957     * @ingroup Slider
17958     */
17959    EAPI void               elm_slider_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
17960
17961    /**
17962     * Get whether a given slider widget's displaying values are
17963     * inverted or not.
17964     *
17965     * @param obj The slider object.
17966     * @return @c EINA_TRUE, if @p obj has inverted values,
17967     * @c EINA_FALSE otherwise (and on errors).
17968     *
17969     * @see elm_slider_inverted_set() for more details.
17970     *
17971     * @ingroup Slider
17972     */
17973    EAPI Eina_Bool          elm_slider_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
17974
17975    /**
17976     * Set whether to enlarge slider indicator (augmented knob) or not.
17977     *
17978     * @param obj The slider object.
17979     * @param show @c EINA_TRUE will make it enlarge, @c EINA_FALSE will
17980     * let the knob always at default size.
17981     *
17982     * By default, indicator will be bigger while dragged by the user.
17983     *
17984     * @warning It won't display values set with
17985     * elm_slider_indicator_format_set() if you disable indicator.
17986     *
17987     * @ingroup Slider
17988     */
17989    EAPI void               elm_slider_indicator_show_set(Evas_Object *obj, Eina_Bool show) EINA_ARG_NONNULL(1);
17990
17991    /**
17992     * Get whether a given slider widget's enlarging indicator or not.
17993     *
17994     * @param obj The slider object.
17995     * @return @c EINA_TRUE, if @p obj is enlarging indicator, or
17996     * @c EINA_FALSE otherwise (and on errors).
17997     *
17998     * @see elm_slider_indicator_show_set() for details.
17999     *
18000     * @ingroup Slider
18001     */
18002    EAPI Eina_Bool          elm_slider_indicator_show_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18003
18004    /**
18005     * @}
18006     */
18007
18008    /**
18009     * @addtogroup Actionslider Actionslider
18010     *
18011     * @image html img/widget/actionslider/preview-00.png
18012     * @image latex img/widget/actionslider/preview-00.eps
18013     *
18014     * An actionslider is a switcher for 2 or 3 labels with customizable magnet
18015     * properties. The user drags and releases the indicator, to choose a label.
18016     *
18017     * Labels occupy the following positions.
18018     * a. Left
18019     * b. Right
18020     * c. Center
18021     *
18022     * Positions can be enabled or disabled.
18023     *
18024     * Magnets can be set on the above positions.
18025     *
18026     * When the indicator is released, it will move to its nearest "enabled and magnetized" position.
18027     *
18028     * @note By default all positions are set as enabled.
18029     *
18030     * Signals that you can add callbacks for are:
18031     *
18032     * "selected" - when user selects an enabled position (the label is passed
18033     *              as event info)".
18034     * @n
18035     * "pos_changed" - when the indicator reaches any of the positions("left",
18036     *                 "right" or "center").
18037     *
18038     * See an example of actionslider usage @ref actionslider_example_page "here"
18039     * @{
18040     */
18041
18042    typedef enum _Elm_Actionslider_Indicator_Pos
18043      {
18044         ELM_ACTIONSLIDER_INDICATOR_NONE,
18045         ELM_ACTIONSLIDER_INDICATOR_LEFT,
18046         ELM_ACTIONSLIDER_INDICATOR_RIGHT,
18047         ELM_ACTIONSLIDER_INDICATOR_CENTER
18048      } Elm_Actionslider_Indicator_Pos;
18049
18050    typedef enum _Elm_Actionslider_Magnet_Pos
18051      {
18052         ELM_ACTIONSLIDER_MAGNET_NONE = 0,
18053         ELM_ACTIONSLIDER_MAGNET_LEFT = 1 << 0,
18054         ELM_ACTIONSLIDER_MAGNET_CENTER = 1 << 1,
18055         ELM_ACTIONSLIDER_MAGNET_RIGHT= 1 << 2,
18056         ELM_ACTIONSLIDER_MAGNET_ALL = (1 << 3) -1,
18057         ELM_ACTIONSLIDER_MAGNET_BOTH = (1 << 3)
18058      } Elm_Actionslider_Magnet_Pos;
18059
18060    typedef enum _Elm_Actionslider_Label_Pos
18061      {
18062         ELM_ACTIONSLIDER_LABEL_LEFT,
18063         ELM_ACTIONSLIDER_LABEL_RIGHT,
18064         ELM_ACTIONSLIDER_LABEL_CENTER,
18065         ELM_ACTIONSLIDER_LABEL_BUTTON
18066      } Elm_Actionslider_Label_Pos;
18067
18068    /* smart callbacks called:
18069     * "indicator,position" - when a button reaches to the special position like "left", "right" and "center".
18070     */
18071
18072    /**
18073     * Add a new actionslider to the parent.
18074     *
18075     * @param parent The parent object
18076     * @return The new actionslider object or NULL if it cannot be created
18077     */
18078    EAPI Evas_Object          *elm_actionslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18079
18080    /**
18081    * Set actionslider label.
18082    *
18083    * @param[in] obj The actionslider object
18084    * @param[in] pos The position of the label.
18085    * (ELM_ACTIONSLIDER_LABEL_LEFT, ELM_ACTIONSLIDER_LABEL_RIGHT)
18086    * @param label The label which is going to be set.
18087    */
18088    EAPI void               elm_actionslider_label_set(Evas_Object *obj, Elm_Actionslider_Label_Pos pos, const char *label) EINA_ARG_NONNULL(1);
18089    /**
18090     * Get actionslider labels.
18091     *
18092     * @param obj The actionslider object
18093     * @param left_label A char** to place the left_label of @p obj into.
18094     * @param center_label A char** to place the center_label of @p obj into.
18095     * @param right_label A char** to place the right_label of @p obj into.
18096     */
18097    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);
18098    /**
18099     * Get actionslider selected label.
18100     *
18101     * @param obj The actionslider object
18102     * @return The selected label
18103     */
18104    EAPI const char           *elm_actionslider_selected_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18105    /**
18106     * Set actionslider indicator position.
18107     *
18108     * @param obj The actionslider object.
18109     * @param pos The position of the indicator.
18110     */
18111    EAPI void                elm_actionslider_indicator_pos_set(Evas_Object *obj, Elm_Actionslider_Indicator_Pos pos) EINA_ARG_NONNULL(1);
18112    /**
18113     * Get actionslider indicator position.
18114     *
18115     * @param obj The actionslider object.
18116     * @return The position of the indicator.
18117     */
18118    EAPI Elm_Actionslider_Indicator_Pos  elm_actionslider_indicator_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18119    /**
18120     * Set actionslider magnet position. To make multiple positions magnets @c or
18121     * them together(e.g.: ELM_ACTIONSLIDER_MAGNET_LEFT | ELM_ACTIONSLIDER_MAGNET_RIGHT)
18122     *
18123     * @param obj The actionslider object.
18124     * @param pos Bit mask indicating the magnet positions.
18125     */
18126    EAPI void                elm_actionslider_magnet_pos_set(Evas_Object *obj, Elm_Actionslider_Magnet_Pos pos) EINA_ARG_NONNULL(1);
18127    /**
18128     * Get actionslider magnet position.
18129     *
18130     * @param obj The actionslider object.
18131     * @return The positions with magnet property.
18132     */
18133    EAPI Elm_Actionslider_Magnet_Pos  elm_actionslider_magnet_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18134    /**
18135     * Set actionslider enabled position. To set multiple positions as enabled @c or
18136     * them together(e.g.: ELM_ACTIONSLIDER_MAGNET_LEFT | ELM_ACTIONSLIDER_MAGNET_RIGHT).
18137     *
18138     * @note All the positions are enabled by default.
18139     *
18140     * @param obj The actionslider object.
18141     * @param pos Bit mask indicating the enabled positions.
18142     */
18143    EAPI void                  elm_actionslider_enabled_pos_set(Evas_Object *obj, Elm_Actionslider_Magnet_Pos pos) EINA_ARG_NONNULL(1);
18144    /**
18145     * Get actionslider enabled position.
18146     *
18147     * @param obj The actionslider object.
18148     * @return The enabled positions.
18149     */
18150    EAPI Elm_Actionslider_Magnet_Pos  elm_actionslider_enabled_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18151    /**
18152     * Set the label used on the indicator.
18153     *
18154     * @param obj The actionslider object
18155     * @param label The label to be set on the indicator.
18156     * @deprecated use elm_object_text_set() instead.
18157     */
18158    EINA_DEPRECATED EAPI void                  elm_actionslider_indicator_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
18159    /**
18160     * Get the label used on the indicator object.
18161     *
18162     * @param obj The actionslider object
18163     * @return The indicator label
18164     * @deprecated use elm_object_text_get() instead.
18165     */
18166    EINA_DEPRECATED EAPI const char           *elm_actionslider_indicator_label_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
18167
18168    /**
18169    * Hold actionslider object movement.
18170    *
18171    * @param[in] obj The actionslider object
18172    * @param[in] flag Actionslider hold/release
18173    * (EINA_TURE = hold/EIN_FALSE = release)
18174    *
18175    * @ingroup Actionslider
18176    */
18177    EAPI void                             elm_actionslider_hold(Evas_Object *obj, Eina_Bool flag) EINA_ARG_NONNULL(1);
18178
18179
18180    /**
18181     * @}
18182     */
18183
18184    /**
18185     * @defgroup Genlist Genlist
18186     *
18187     * @image html img/widget/genlist/preview-00.png
18188     * @image latex img/widget/genlist/preview-00.eps
18189     * @image html img/genlist.png
18190     * @image latex img/genlist.eps
18191     *
18192     * This widget aims to have more expansive list than the simple list in
18193     * Elementary that could have more flexible items and allow many more entries
18194     * while still being fast and low on memory usage. At the same time it was
18195     * also made to be able to do tree structures. But the price to pay is more
18196     * complexity when it comes to usage. If all you want is a simple list with
18197     * icons and a single label, use the normal @ref List object.
18198     *
18199     * Genlist has a fairly large API, mostly because it's relatively complex,
18200     * trying to be both expansive, powerful and efficient. First we will begin
18201     * an overview on the theory behind genlist.
18202     *
18203     * @section Genlist_Item_Class Genlist item classes - creating items
18204     *
18205     * In order to have the ability to add and delete items on the fly, genlist
18206     * implements a class (callback) system where the application provides a
18207     * structure with information about that type of item (genlist may contain
18208     * multiple different items with different classes, states and styles).
18209     * Genlist will call the functions in this struct (methods) when an item is
18210     * "realized" (i.e., created dynamically, while the user is scrolling the
18211     * grid). All objects will simply be deleted when no longer needed with
18212     * evas_object_del(). The #Elm_Genlist_Item_Class structure contains the
18213     * following members:
18214     * - @c item_style - This is a constant string and simply defines the name
18215     *   of the item style. It @b must be specified and the default should be @c
18216     *   "default".
18217     *
18218     * - @c func - A struct with pointers to functions that will be called when
18219     *   an item is going to be actually created. All of them receive a @c data
18220     *   parameter that will point to the same data passed to
18221     *   elm_genlist_item_append() and related item creation functions, and a @c
18222     *   obj parameter that points to the genlist object itself.
18223     *
18224     * The function pointers inside @c func are @c label_get, @c icon_get, @c
18225     * state_get and @c del. The 3 first functions also receive a @c part
18226     * parameter described below. A brief description of these functions follows:
18227     *
18228     * - @c label_get - The @c part parameter is the name string of one of the
18229     *   existing text parts in the Edje group implementing the item's theme.
18230     *   This function @b must return a strdup'()ed string, as the caller will
18231     *   free() it when done. See #Elm_Genlist_Item_Label_Get_Cb.
18232     * - @c content_get - The @c part parameter is the name string of one of the
18233     *   existing (content) swallow parts in the Edje group implementing the item's
18234     *   theme. It must return @c NULL, when no content is desired, or a valid
18235     *   object handle, otherwise.  The object will be deleted by the genlist on
18236     *   its deletion or when the item is "unrealized".  See
18237     *   #Elm_Genlist_Item_Content_Get_Cb.
18238     * - @c func.state_get - The @c part parameter is the name string of one of
18239     *   the state parts in the Edje group implementing the item's theme. Return
18240     *   @c EINA_FALSE for false/off or @c EINA_TRUE for true/on. Genlists will
18241     *   emit a signal to its theming Edje object with @c "elm,state,XXX,active"
18242     *   and @c "elm" as "emission" and "source" arguments, respectively, when
18243     *   the state is true (the default is false), where @c XXX is the name of
18244     *   the (state) part.  See #Elm_Genlist_Item_State_Get_Cb.
18245     * - @c func.del - This is intended for use when genlist items are deleted,
18246     *   so any data attached to the item (e.g. its data parameter on creation)
18247     *   can be deleted. See #Elm_Genlist_Item_Del_Cb.
18248     *
18249     * available item styles:
18250     * - default
18251     * - default_style - The text part is a textblock
18252     *
18253     * @image html img/widget/genlist/preview-04.png
18254     * @image latex img/widget/genlist/preview-04.eps
18255     *
18256     * - double_label
18257     *
18258     * @image html img/widget/genlist/preview-01.png
18259     * @image latex img/widget/genlist/preview-01.eps
18260     *
18261     * - icon_top_text_bottom
18262     *
18263     * @image html img/widget/genlist/preview-02.png
18264     * @image latex img/widget/genlist/preview-02.eps
18265     *
18266     * - group_index
18267     *
18268     * @image html img/widget/genlist/preview-03.png
18269     * @image latex img/widget/genlist/preview-03.eps
18270     *
18271     * @section Genlist_Items Structure of items
18272     *
18273     * An item in a genlist can have 0 or more text labels (they can be regular
18274     * text or textblock Evas objects - that's up to the style to determine), 0
18275     * or more contents (which are simply objects swallowed into the genlist item's
18276     * theming Edje object) and 0 or more <b>boolean states</b>, which have the
18277     * behavior left to the user to define. The Edje part names for each of
18278     * these properties will be looked up, in the theme file for the genlist,
18279     * under the Edje (string) data items named @c "labels", @c "contents" and @c
18280     * "states", respectively. For each of those properties, if more than one
18281     * part is provided, they must have names listed separated by spaces in the
18282     * data fields. For the default genlist item theme, we have @b one label
18283     * part (@c "elm.text"), @b two content parts (@c "elm.swalllow.icon" and @c
18284     * "elm.swallow.end") and @b no state parts.
18285     *
18286     * A genlist item may be at one of several styles. Elementary provides one
18287     * by default - "default", but this can be extended by system or application
18288     * custom themes/overlays/extensions (see @ref Theme "themes" for more
18289     * details).
18290     *
18291     * @section Genlist_Manipulation Editing and Navigating
18292     *
18293     * Items can be added by several calls. All of them return a @ref
18294     * Elm_Genlist_Item handle that is an internal member inside the genlist.
18295     * They all take a data parameter that is meant to be used for a handle to
18296     * the applications internal data (eg the struct with the original item
18297     * data). The parent parameter is the parent genlist item this belongs to if
18298     * it is a tree or an indexed group, and NULL if there is no parent. The
18299     * flags can be a bitmask of #ELM_GENLIST_ITEM_NONE,
18300     * #ELM_GENLIST_ITEM_SUBITEMS and #ELM_GENLIST_ITEM_GROUP. If
18301     * #ELM_GENLIST_ITEM_SUBITEMS is set then this item is displayed as an item
18302     * that is able to expand and have child items.  If ELM_GENLIST_ITEM_GROUP
18303     * is set then this item is group index item that is displayed at the top
18304     * until the next group comes. The func parameter is a convenience callback
18305     * that is called when the item is selected and the data parameter will be
18306     * the func_data parameter, obj be the genlist object and event_info will be
18307     * the genlist item.
18308     *
18309     * elm_genlist_item_append() adds an item to the end of the list, or if
18310     * there is a parent, to the end of all the child items of the parent.
18311     * elm_genlist_item_prepend() is the same but adds to the beginning of
18312     * the list or children list. elm_genlist_item_insert_before() inserts at
18313     * item before another item and elm_genlist_item_insert_after() inserts after
18314     * the indicated item.
18315     *
18316     * The application can clear the list with elm_gen_clear() which deletes
18317     * all the items in the list and elm_genlist_item_del() will delete a specific
18318     * item. elm_genlist_item_subitems_clear() will clear all items that are
18319     * children of the indicated parent item.
18320     *
18321     * To help inspect list items you can jump to the item at the top of the list
18322     * with elm_genlist_first_item_get() which will return the item pointer, and
18323     * similarly elm_genlist_last_item_get() gets the item at the end of the list.
18324     * elm_genlist_item_next_get() and elm_genlist_item_prev_get() get the next
18325     * and previous items respectively relative to the indicated item. Using
18326     * these calls you can walk the entire item list/tree. Note that as a tree
18327     * the items are flattened in the list, so elm_genlist_item_parent_get() will
18328     * let you know which item is the parent (and thus know how to skip them if
18329     * wanted).
18330     *
18331     * @section Genlist_Muti_Selection Multi-selection
18332     *
18333     * If the application wants multiple items to be able to be selected,
18334     * elm_genlist_multi_select_set() can enable this. If the list is
18335     * single-selection only (the default), then elm_genlist_selected_item_get()
18336     * will return the selected item, if any, or NULL if none is selected. If the
18337     * list is multi-select then elm_genlist_selected_items_get() will return a
18338     * list (that is only valid as long as no items are modified (added, deleted,
18339     * selected or unselected)).
18340     *
18341     * @section Genlist_Usage_Hints Usage hints
18342     *
18343     * There are also convenience functions. elm_gen_item_genlist_get() will
18344     * return the genlist object the item belongs to. elm_genlist_item_show()
18345     * will make the scroller scroll to show that specific item so its visible.
18346     * elm_genlist_item_data_get() returns the data pointer set by the item
18347     * creation functions.
18348     *
18349     * If an item changes (state of boolean changes, label or contents change),
18350     * then use elm_genlist_item_update() to have genlist update the item with
18351     * the new state. Genlist will re-realize the item thus call the functions
18352     * in the _Elm_Genlist_Item_Class for that item.
18353     *
18354     * To programmatically (un)select an item use elm_genlist_item_selected_set().
18355     * To get its selected state use elm_genlist_item_selected_get(). Similarly
18356     * to expand/contract an item and get its expanded state, use
18357     * elm_genlist_item_expanded_set() and elm_genlist_item_expanded_get(). And
18358     * again to make an item disabled (unable to be selected and appear
18359     * differently) use elm_genlist_item_disabled_set() to set this and
18360     * elm_genlist_item_disabled_get() to get the disabled state.
18361     *
18362     * In general to indicate how the genlist should expand items horizontally to
18363     * fill the list area, use elm_genlist_horizontal_set(). Valid modes are
18364     * ELM_LIST_LIMIT and ELM_LIST_SCROLL. The default is ELM_LIST_SCROLL. This
18365     * mode means that if items are too wide to fit, the scroller will scroll
18366     * horizontally. Otherwise items are expanded to fill the width of the
18367     * viewport of the scroller. If it is ELM_LIST_LIMIT, items will be expanded
18368     * to the viewport width and limited to that size. This can be combined with
18369     * a different style that uses edjes' ellipsis feature (cutting text off like
18370     * this: "tex...").
18371     *
18372     * Items will only call their selection func and callback when first becoming
18373     * selected. Any further clicks will do nothing, unless you enable always
18374     * select with elm_gen_always_select_mode_set(). This means even if
18375     * selected, every click will make the selected callbacks be called.
18376     * elm_genlist_no_select_mode_set() will turn off the ability to select
18377     * items entirely and they will neither appear selected nor call selected
18378     * callback functions.
18379     *
18380     * Remember that you can create new styles and add your own theme augmentation
18381     * per application with elm_theme_extension_add(). If you absolutely must
18382     * have a specific style that overrides any theme the user or system sets up
18383     * you can use elm_theme_overlay_add() to add such a file.
18384     *
18385     * @section Genlist_Implementation Implementation
18386     *
18387     * Evas tracks every object you create. Every time it processes an event
18388     * (mouse move, down, up etc.) it needs to walk through objects and find out
18389     * what event that affects. Even worse every time it renders display updates,
18390     * in order to just calculate what to re-draw, it needs to walk through many
18391     * many many objects. Thus, the more objects you keep active, the more
18392     * overhead Evas has in just doing its work. It is advisable to keep your
18393     * active objects to the minimum working set you need. Also remember that
18394     * object creation and deletion carries an overhead, so there is a
18395     * middle-ground, which is not easily determined. But don't keep massive lists
18396     * of objects you can't see or use. Genlist does this with list objects. It
18397     * creates and destroys them dynamically as you scroll around. It groups them
18398     * into blocks so it can determine the visibility etc. of a whole block at
18399     * once as opposed to having to walk the whole list. This 2-level list allows
18400     * for very large numbers of items to be in the list (tests have used up to
18401     * 2,000,000 items). Also genlist employs a queue for adding items. As items
18402     * may be different sizes, every item added needs to be calculated as to its
18403     * size and thus this presents a lot of overhead on populating the list, this
18404     * genlist employs a queue. Any item added is queued and spooled off over
18405     * time, actually appearing some time later, so if your list has many members
18406     * you may find it takes a while for them to all appear, with your process
18407     * consuming a lot of CPU while it is busy spooling.
18408     *
18409     * Genlist also implements a tree structure, but it does so with callbacks to
18410     * the application, with the application filling in tree structures when
18411     * requested (allowing for efficient building of a very deep tree that could
18412     * even be used for file-management). See the above smart signal callbacks for
18413     * details.
18414     *
18415     * @section Genlist_Smart_Events Genlist smart events
18416     *
18417     * Signals that you can add callbacks for are:
18418     * - @c "activated" - The user has double-clicked or pressed
18419     *   (enter|return|spacebar) on an item. The @c event_info parameter is the
18420     *   item that was activated.
18421     * - @c "clicked,double" - The user has double-clicked an item.  The @c
18422     *   event_info parameter is the item that was double-clicked.
18423     * - @c "selected" - This is called when a user has made an item selected.
18424     *   The event_info parameter is the genlist item that was selected.
18425     * - @c "unselected" - This is called when a user has made an item
18426     *   unselected. The event_info parameter is the genlist item that was
18427     *   unselected.
18428     * - @c "expanded" - This is called when elm_genlist_item_expanded_set() is
18429     *   called and the item is now meant to be expanded. The event_info
18430     *   parameter is the genlist item that was indicated to expand.  It is the
18431     *   job of this callback to then fill in the child items.
18432     * - @c "contracted" - This is called when elm_genlist_item_expanded_set() is
18433     *   called and the item is now meant to be contracted. The event_info
18434     *   parameter is the genlist item that was indicated to contract. It is the
18435     *   job of this callback to then delete the child items.
18436     * - @c "expand,request" - This is called when a user has indicated they want
18437     *   to expand a tree branch item. The callback should decide if the item can
18438     *   expand (has any children) and then call elm_genlist_item_expanded_set()
18439     *   appropriately to set the state. The event_info parameter is the genlist
18440     *   item that was indicated to expand.
18441     * - @c "contract,request" - This is called when a user has indicated they
18442     *   want to contract a tree branch item. The callback should decide if the
18443     *   item can contract (has any children) and then call
18444     *   elm_genlist_item_expanded_set() appropriately to set the state. The
18445     *   event_info parameter is the genlist item that was indicated to contract.
18446     * - @c "realized" - This is called when the item in the list is created as a
18447     *   real evas object. event_info parameter is the genlist item that was
18448     *   created. The object may be deleted at any time, so it is up to the
18449     *   caller to not use the object pointer from elm_genlist_item_object_get()
18450     *   in a way where it may point to freed objects.
18451     * - @c "unrealized" - This is called just before an item is unrealized.
18452     *   After this call content objects provided will be deleted and the item
18453     *   object itself delete or be put into a floating cache.
18454     * - @c "drag,start,up" - This is called when the item in the list has been
18455     *   dragged (not scrolled) up.
18456     * - @c "drag,start,down" - This is called when the item in the list has been
18457     *   dragged (not scrolled) down.
18458     * - @c "drag,start,left" - This is called when the item in the list has been
18459     *   dragged (not scrolled) left.
18460     * - @c "drag,start,right" - This is called when the item in the list has
18461     *   been dragged (not scrolled) right.
18462     * - @c "drag,stop" - This is called when the item in the list has stopped
18463     *   being dragged.
18464     * - @c "drag" - This is called when the item in the list is being dragged.
18465     * - @c "longpressed" - This is called when the item is pressed for a certain
18466     *   amount of time. By default it's 1 second.
18467     * - @c "scroll,anim,start" - This is called when scrolling animation has
18468     *   started.
18469     * - @c "scroll,anim,stop" - This is called when scrolling animation has
18470     *   stopped.
18471     * - @c "scroll,drag,start" - This is called when dragging the content has
18472     *   started.
18473     * - @c "scroll,drag,stop" - This is called when dragging the content has
18474     *   stopped.
18475     * - @c "edge,top" - This is called when the genlist is scrolled until
18476     *   the top edge.
18477     * - @c "edge,bottom" - This is called when the genlist is scrolled
18478     *   until the bottom edge.
18479     * - @c "edge,left" - This is called when the genlist is scrolled
18480     *   until the left edge.
18481     * - @c "edge,right" - This is called when the genlist is scrolled
18482     *   until the right edge.
18483     * - @c "multi,swipe,left" - This is called when the genlist is multi-touch
18484     *   swiped left.
18485     * - @c "multi,swipe,right" - This is called when the genlist is multi-touch
18486     *   swiped right.
18487     * - @c "multi,swipe,up" - This is called when the genlist is multi-touch
18488     *   swiped up.
18489     * - @c "multi,swipe,down" - This is called when the genlist is multi-touch
18490     *   swiped down.
18491     * - @c "multi,pinch,out" - This is called when the genlist is multi-touch
18492     *   pinched out.  "- @c multi,pinch,in" - This is called when the genlist is
18493     *   multi-touch pinched in.
18494     * - @c "swipe" - This is called when the genlist is swiped.
18495     * - @c "moved" - This is called when a genlist item is moved.
18496     * - @c "language,changed" - This is called when the program's language is
18497     *   changed.
18498     *
18499     * @section Genlist_Examples Examples
18500     *
18501     * Here is a list of examples that use the genlist, trying to show some of
18502     * its capabilities:
18503     * - @ref genlist_example_01
18504     * - @ref genlist_example_02
18505     * - @ref genlist_example_03
18506     * - @ref genlist_example_04
18507     * - @ref genlist_example_05
18508     */
18509
18510    /**
18511     * @addtogroup Genlist
18512     * @{
18513     */
18514
18515    /**
18516     * @enum _Elm_Genlist_Item_Flags
18517     * @typedef Elm_Genlist_Item_Flags
18518     *
18519     * Defines if the item is of any special type (has subitems or it's the
18520     * index of a group), or is just a simple item.
18521     *
18522     * @ingroup Genlist
18523     */
18524    typedef enum _Elm_Genlist_Item_Flags
18525      {
18526         ELM_GENLIST_ITEM_NONE = 0, /**< simple item */
18527         ELM_GENLIST_ITEM_SUBITEMS = (1 << 0), /**< may expand and have child items */
18528         ELM_GENLIST_ITEM_GROUP = (1 << 1) /**< index of a group of items */
18529      } Elm_Genlist_Item_Flags;
18530    typedef enum _Elm_Genlist_Item_Field_Flags
18531      {
18532         ELM_GENLIST_ITEM_FIELD_ALL = 0,
18533         ELM_GENLIST_ITEM_FIELD_LABEL = (1 << 0),
18534         ELM_GENLIST_ITEM_FIELD_ICON = (1 << 1),
18535         ELM_GENLIST_ITEM_FIELD_STATE = (1 << 2)
18536      } Elm_Genlist_Item_Field_Flags;
18537    typedef struct _Elm_Genlist_Item_Class Elm_Genlist_Item_Class;  /**< Genlist item class definition structs */
18538    typedef struct _Elm_Genlist_Item       Elm_Genlist_Item; /**< Item of Elm_Genlist. Sub-type of Elm_Widget_Item */
18539    typedef struct _Elm_Genlist_Item_Class_Func Elm_Genlist_Item_Class_Func;
18540    typedef char        *(*GenlistItemLabelGetFunc) (void *data, Evas_Object *obj, const char *part);
18541    typedef Evas_Object *(*GenlistItemIconGetFunc)  (void *data, Evas_Object *obj, const char *part);
18542    typedef Eina_Bool    (*GenlistItemStateGetFunc) (void *data, Evas_Object *obj, const char *part);
18543    typedef void         (*GenlistItemDelFunc)      (void *data, Evas_Object *obj);
18544    typedef void         (*GenlistItemMovedFunc)    ( Evas_Object *genlist, Elm_Genlist_Item *item, Elm_Genlist_Item *rel_item, Eina_Bool move_after);
18545
18546    /**
18547     * @struct _Elm_Genlist_Item_Class
18548     *
18549     * Genlist item class definition structs.
18550     *
18551     * This struct contains the style and fetching functions that will define the
18552     * contents of each item.
18553     *
18554     * @see @ref Genlist_Item_Class
18555     */
18556    struct _Elm_Genlist_Item_Class
18557      {
18558         const char                *item_style;
18559         struct {
18560           GenlistItemLabelGetFunc  label_get;
18561           GenlistItemIconGetFunc   icon_get;
18562           GenlistItemStateGetFunc  state_get;
18563           GenlistItemDelFunc       del;
18564           GenlistItemMovedFunc     moved;
18565         } func;
18566         const char *edit_item_style;
18567         const char                *mode_item_style;
18568      };
18569    #define Elm_Genlist_Item_Class_Func Elm_Gen_Item_Class_Func
18570    /**
18571     * Add a new genlist widget to the given parent Elementary
18572     * (container) object
18573     *
18574     * @param parent The parent object
18575     * @return a new genlist widget handle or @c NULL, on errors
18576     *
18577     * This function inserts a new genlist widget on the canvas.
18578     *
18579     * @see elm_genlist_item_append()
18580     * @see elm_genlist_item_del()
18581     * @see elm_gen_clear()
18582     *
18583     * @ingroup Genlist
18584     */
18585    EAPI Evas_Object      *elm_genlist_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
18586    /**
18587     * Remove all items from a given genlist widget.
18588     *
18589     * @param obj The genlist object
18590     *
18591     * This removes (and deletes) all items in @p obj, leaving it empty.
18592     *
18593     * This is deprecated. Please use elm_gen_clear() instead.
18594     * 
18595     * @see elm_genlist_item_del(), to remove just one item.
18596     *
18597     * @ingroup Genlist
18598     */
18599    WILL_DEPRECATE  EAPI void elm_genlist_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
18600    /**
18601     * Enable or disable multi-selection in the genlist
18602     *
18603     * @param obj The genlist object
18604     * @param multi Multi-select enable/disable. Default is disabled.
18605     *
18606     * This enables (@c EINA_TRUE) or disables (@c EINA_FALSE) multi-selection in
18607     * the list. This allows more than 1 item to be selected. To retrieve the list
18608     * of selected items, use elm_genlist_selected_items_get().
18609     *
18610     * @see elm_genlist_selected_items_get()
18611     * @see elm_genlist_multi_select_get()
18612     *
18613     * @ingroup Genlist
18614     */
18615    EAPI void              elm_genlist_multi_select_set(Evas_Object *obj, Eina_Bool multi) EINA_ARG_NONNULL(1);
18616    /**
18617     * Gets if multi-selection in genlist is enabled or disabled.
18618     *
18619     * @param obj The genlist object
18620     * @return Multi-select enabled/disabled
18621     * (@c EINA_TRUE = enabled/@c EINA_FALSE = disabled). Default is @c EINA_FALSE.
18622     *
18623     * @see elm_genlist_multi_select_set()
18624     *
18625     * @ingroup Genlist
18626     */
18627    EAPI Eina_Bool         elm_genlist_multi_select_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18628    /**
18629     * This sets the horizontal stretching mode.
18630     *
18631     * @param obj The genlist object
18632     * @param mode The mode to use (one of #ELM_LIST_SCROLL or #ELM_LIST_LIMIT).
18633     *
18634     * This sets the mode used for sizing items horizontally. Valid modes
18635     * are #ELM_LIST_LIMIT and #ELM_LIST_SCROLL. The default is
18636     * ELM_LIST_SCROLL. This mode means that if items are too wide to fit,
18637     * the scroller will scroll horizontally. Otherwise items are expanded
18638     * to fill the width of the viewport of the scroller. If it is
18639     * ELM_LIST_LIMIT, items will be expanded to the viewport width and
18640     * limited to that size.
18641     *
18642     * @see elm_genlist_horizontal_get()
18643     *
18644     * @ingroup Genlist
18645     */
18646    EAPI void              elm_genlist_horizontal_mode_set(Evas_Object *obj, Elm_List_Mode mode) EINA_ARG_NONNULL(1);
18647    /**
18648     * Gets the horizontal stretching mode.
18649     *
18650     * @param obj The genlist object
18651     * @return The mode to use
18652     * (#ELM_LIST_LIMIT, #ELM_LIST_SCROLL)
18653     *
18654     * @see elm_genlist_horizontal_set()
18655     *
18656     * @ingroup Genlist
18657     */
18658    EAPI Elm_List_Mode     elm_genlist_horizontal_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18659    /**
18660     * Set the always select mode.
18661     *
18662     * @param obj The genlist object
18663     * @param always_select The always select mode (@c EINA_TRUE = on, @c
18664     * EINA_FALSE = off). Default is @c EINA_FALSE.
18665     *
18666     * Items will only call their selection func and callback when first
18667     * becoming selected. Any further clicks will do nothing, unless you
18668     * enable always select with elm_gen_always_select_mode_set().
18669     * This means that, even if selected, every click will make the selected
18670     * callbacks be called.
18671     * 
18672     * This function is deprecated. please see elm_gen_always_select_mode_set()
18673     *
18674     * @see elm_genlist_always_select_mode_get()
18675     *
18676     * @ingroup Genlist
18677     */
18678    WILL_DEPRECATE  EAPI void              elm_genlist_always_select_mode_set(Evas_Object *obj, Eina_Bool always_select) EINA_ARG_NONNULL(1);
18679    /**
18680     * Get the always select mode.
18681     *
18682     * @param obj The genlist object
18683     * @return The always select mode
18684     * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18685     *
18686     * @see elm_genlist_always_select_mode_set()
18687     *
18688     * @ingroup Genlist
18689     */
18690    WILL_DEPRECATE  EAPI Eina_Bool         elm_genlist_always_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18691    /**
18692     * Enable/disable the no select mode.
18693     *
18694     * @param obj The genlist object
18695     * @param no_select The no select mode
18696     * (EINA_TRUE = on, EINA_FALSE = off)
18697     *
18698     * This will turn off the ability to select items entirely and they
18699     * will neither appear selected nor call selected callback functions.
18700     *
18701     * @see elm_genlist_no_select_mode_get()
18702     *
18703     * @ingroup Genlist
18704     */
18705    WILL_DEPRECATE  EAPI void              elm_genlist_no_select_mode_set(Evas_Object *obj, Eina_Bool no_select) EINA_ARG_NONNULL(1);
18706    /**
18707     * Gets whether the no select mode is enabled.
18708     *
18709     * @param obj The genlist object
18710     * @return The no select mode
18711     * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18712     *
18713     * @see elm_genlist_no_select_mode_set()
18714     *
18715     * @ingroup Genlist
18716     */
18717    WILL_DEPRECATE  EAPI Eina_Bool         elm_genlist_no_select_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18718    /**
18719     * Enable/disable compress mode.
18720     *
18721     * @param obj The genlist object
18722     * @param compress The compress mode
18723     * (@c EINA_TRUE = on, @c EINA_FALSE = off). Default is @c EINA_FALSE.
18724     *
18725     * This will enable the compress mode where items are "compressed"
18726     * horizontally to fit the genlist scrollable viewport width. This is
18727     * special for genlist.  Do not rely on
18728     * elm_genlist_horizontal_set() being set to @c ELM_LIST_COMPRESS to
18729     * work as genlist needs to handle it specially.
18730     *
18731     * @see elm_genlist_compress_mode_get()
18732     *
18733     * @ingroup Genlist
18734     */
18735    EAPI void              elm_genlist_compress_mode_set(Evas_Object *obj, Eina_Bool compress) EINA_ARG_NONNULL(1);
18736    /**
18737     * Get whether the compress mode is enabled.
18738     *
18739     * @param obj The genlist object
18740     * @return The compress mode
18741     * (@c EINA_TRUE = on, @c EINA_FALSE = off)
18742     *
18743     * @see elm_genlist_compress_mode_set()
18744     *
18745     * @ingroup Genlist
18746     */
18747    EAPI Eina_Bool         elm_genlist_compress_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18748    /**
18749     * Enable/disable height-for-width mode.
18750     *
18751     * @param obj The genlist object
18752     * @param setting The height-for-width mode (@c EINA_TRUE = on,
18753     * @c EINA_FALSE = off). Default is @c EINA_FALSE.
18754     *
18755     * With height-for-width mode the item width will be fixed (restricted
18756     * to a minimum of) to the list width when calculating its size in
18757     * order to allow the height to be calculated based on it. This allows,
18758     * for instance, text block to wrap lines if the Edje part is
18759     * configured with "text.min: 0 1".
18760     *
18761     * @note This mode will make list resize slower as it will have to
18762     *       recalculate every item height again whenever the list width
18763     *       changes!
18764     *
18765     * @note When height-for-width mode is enabled, it also enables
18766     *       compress mode (see elm_genlist_compress_mode_set()) and
18767     *       disables homogeneous (see elm_genlist_homogeneous_set()).
18768     *
18769     * @ingroup Genlist
18770     */
18771    EAPI void              elm_genlist_height_for_width_mode_set(Evas_Object *obj, Eina_Bool height_for_width) EINA_ARG_NONNULL(1);
18772    /**
18773     * Get whether the height-for-width mode is enabled.
18774     *
18775     * @param obj The genlist object
18776     * @return The height-for-width mode (@c EINA_TRUE = on, @c EINA_FALSE =
18777     * off)
18778     *
18779     * @ingroup Genlist
18780     */
18781    EAPI Eina_Bool         elm_genlist_height_for_width_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18782    /**
18783     * Enable/disable horizontal and vertical bouncing effect.
18784     *
18785     * @param obj The genlist object
18786     * @param h_bounce Allow bounce horizontally (@c EINA_TRUE = on, @c
18787     * EINA_FALSE = off). Default is @c EINA_FALSE.
18788     * @param v_bounce Allow bounce vertically (@c EINA_TRUE = on, @c
18789     * EINA_FALSE = off). Default is @c EINA_TRUE.
18790     *
18791     * This will enable or disable the scroller bouncing effect for the
18792     * genlist. See elm_scroller_bounce_set() for details.
18793     *
18794     * @see elm_scroller_bounce_set()
18795     * @see elm_genlist_bounce_get()
18796     *
18797     * @ingroup Genlist
18798     */
18799    WILL_DEPRECATE  EAPI void              elm_genlist_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
18800    /**
18801     * Get whether the horizontal and vertical bouncing effect is enabled.
18802     *
18803     * @param obj The genlist object
18804     * @param h_bounce Pointer to a bool to receive if the bounce horizontally
18805     * option is set.
18806     * @param v_bounce Pointer to a bool to receive if the bounce vertically
18807     * option is set.
18808     *
18809     * @see elm_genlist_bounce_set()
18810     *
18811     * @ingroup Genlist
18812     */
18813    WILL_DEPRECATE  EAPI void              elm_genlist_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
18814    /**
18815     * Enable/disable homogenous mode.
18816     *
18817     * @param obj The genlist object
18818     * @param homogeneous Assume the items within the genlist are of the
18819     * same height and width (EINA_TRUE = on, EINA_FALSE = off). Default is @c
18820     * EINA_FALSE.
18821     *
18822     * This will enable the homogeneous mode where items are of the same
18823     * height and width so that genlist may do the lazy-loading at its
18824     * maximum (which increases the performance for scrolling the list). This
18825     * implies 'compressed' mode.
18826     *
18827     * @see elm_genlist_compress_mode_set()
18828     * @see elm_genlist_homogeneous_get()
18829     *
18830     * @ingroup Genlist
18831     */
18832    EAPI void              elm_genlist_homogeneous_set(Evas_Object *obj, Eina_Bool homogeneous) EINA_ARG_NONNULL(1);
18833    /**
18834     * Get whether the homogenous mode is enabled.
18835     *
18836     * @param obj The genlist object
18837     * @return Assume the items within the genlist are of the same height
18838     * and width (EINA_TRUE = on, EINA_FALSE = off)
18839     *
18840     * @see elm_genlist_homogeneous_set()
18841     *
18842     * @ingroup Genlist
18843     */
18844    EAPI Eina_Bool         elm_genlist_homogeneous_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18845    /**
18846     * Set the maximum number of items within an item block
18847     *
18848     * @param obj The genlist object
18849     * @param n   Maximum number of items within an item block. Default is 32.
18850     *
18851     * This will configure the block count to tune to the target with
18852     * particular performance matrix.
18853     *
18854     * A block of objects will be used to reduce the number of operations due to
18855     * many objects in the screen. It can determine the visibility, or if the
18856     * object has changed, it theme needs to be updated, etc. doing this kind of
18857     * calculation to the entire block, instead of per object.
18858     *
18859     * The default value for the block count is enough for most lists, so unless
18860     * you know you will have a lot of objects visible in the screen at the same
18861     * time, don't try to change this.
18862     *
18863     * @see elm_genlist_block_count_get()
18864     * @see @ref Genlist_Implementation
18865     *
18866     * @ingroup Genlist
18867     */
18868    EAPI void              elm_genlist_block_count_set(Evas_Object *obj, int n) EINA_ARG_NONNULL(1);
18869    /**
18870     * Get the maximum number of items within an item block
18871     *
18872     * @param obj The genlist object
18873     * @return Maximum number of items within an item block
18874     *
18875     * @see elm_genlist_block_count_set()
18876     *
18877     * @ingroup Genlist
18878     */
18879    EAPI int               elm_genlist_block_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18880    /**
18881     * Set the timeout in seconds for the longpress event.
18882     *
18883     * @param obj The genlist object
18884     * @param timeout timeout in seconds. Default is 1.
18885     *
18886     * This option will change how long it takes to send an event "longpressed"
18887     * after the mouse down signal is sent to the list. If this event occurs, no
18888     * "clicked" event will be sent.
18889     *
18890     * @see elm_genlist_longpress_timeout_set()
18891     *
18892     * @ingroup Genlist
18893     */
18894    EAPI void              elm_genlist_longpress_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
18895    /**
18896     * Get the timeout in seconds for the longpress event.
18897     *
18898     * @param obj The genlist object
18899     * @return timeout in seconds
18900     *
18901     * @see elm_genlist_longpress_timeout_get()
18902     *
18903     * @ingroup Genlist
18904     */
18905    EAPI double            elm_genlist_longpress_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
18906    /**
18907     * Append a new item in a given genlist widget.
18908     *
18909     * @param obj The genlist object
18910     * @param itc The item class for the item
18911     * @param data The item data
18912     * @param parent The parent item, or NULL if none
18913     * @param flags Item flags
18914     * @param func Convenience function called when the item is selected
18915     * @param func_data Data passed to @p func above.
18916     * @return A handle to the item added or @c NULL if not possible
18917     *
18918     * This adds the given item to the end of the list or the end of
18919     * the children list if the @p parent is given.
18920     *
18921     * @see elm_genlist_item_prepend()
18922     * @see elm_genlist_item_insert_before()
18923     * @see elm_genlist_item_insert_after()
18924     * @see elm_genlist_item_del()
18925     *
18926     * @ingroup Genlist
18927     */
18928    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);
18929    /**
18930     * Prepend a new item in a given genlist widget.
18931     *
18932     * @param obj The genlist object
18933     * @param itc The item class for the item
18934     * @param data The item data
18935     * @param parent The parent item, or NULL if none
18936     * @param flags Item flags
18937     * @param func Convenience function called when the item is selected
18938     * @param func_data Data passed to @p func above.
18939     * @return A handle to the item added or NULL if not possible
18940     *
18941     * This adds an item to the beginning of the list or beginning of the
18942     * children of the parent if given.
18943     *
18944     * @see elm_genlist_item_append()
18945     * @see elm_genlist_item_insert_before()
18946     * @see elm_genlist_item_insert_after()
18947     * @see elm_genlist_item_del()
18948     *
18949     * @ingroup Genlist
18950     */
18951    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);
18952    /**
18953     * Insert an item before another in a genlist widget
18954     *
18955     * @param obj The genlist object
18956     * @param itc The item class for the item
18957     * @param data The item data
18958     * @param before The item to place this new one before.
18959     * @param flags Item flags
18960     * @param func Convenience function called when the item is selected
18961     * @param func_data Data passed to @p func above.
18962     * @return A handle to the item added or @c NULL if not possible
18963     *
18964     * This inserts an item before another in the list. It will be in the
18965     * same tree level or group as the item it is inserted before.
18966     *
18967     * @see elm_genlist_item_append()
18968     * @see elm_genlist_item_prepend()
18969     * @see elm_genlist_item_insert_after()
18970     * @see elm_genlist_item_del()
18971     *
18972     * @ingroup Genlist
18973     */
18974    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);
18975    /**
18976     * Insert an item after another in a genlist widget
18977     *
18978     * @param obj The genlist object
18979     * @param itc The item class for the item
18980     * @param data The item data
18981     * @param after The item to place this new one after.
18982     * @param flags Item flags
18983     * @param func Convenience function called when the item is selected
18984     * @param func_data Data passed to @p func above.
18985     * @return A handle to the item added or @c NULL if not possible
18986     *
18987     * This inserts an item after another in the list. It will be in the
18988     * same tree level or group as the item it is inserted after.
18989     *
18990     * @see elm_genlist_item_append()
18991     * @see elm_genlist_item_prepend()
18992     * @see elm_genlist_item_insert_before()
18993     * @see elm_genlist_item_del()
18994     *
18995     * @ingroup Genlist
18996     */
18997    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);
18998    /**
18999     * Insert a new item into the sorted genlist object
19000     *
19001     * @param obj The genlist object
19002     * @param itc The item class for the item
19003     * @param data The item data
19004     * @param parent The parent item, or NULL if none
19005     * @param flags Item flags
19006     * @param comp The function called for the sort
19007     * @param func Convenience function called when item selected
19008     * @param func_data Data passed to @p func above.
19009     * @return A handle to the item added or NULL if not possible
19010     *
19011     * @ingroup Genlist
19012     */
19013    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);
19014    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);
19015    /* operations to retrieve existing items */
19016    /**
19017     * Get the selectd item in the genlist.
19018     *
19019     * @param obj The genlist object
19020     * @return The selected item, or NULL if none is selected.
19021     *
19022     * This gets the selected item in the list (if multi-selection is enabled, only
19023     * the item that was first selected in the list is returned - which is not very
19024     * useful, so see elm_genlist_selected_items_get() for when multi-selection is
19025     * used).
19026     *
19027     * If no item is selected, NULL is returned.
19028     *
19029     * @see elm_genlist_selected_items_get()
19030     *
19031     * @ingroup Genlist
19032     */
19033    EAPI Elm_Genlist_Item *elm_genlist_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19034    /**
19035     * Get a list of selected items in the genlist.
19036     *
19037     * @param obj The genlist object
19038     * @return The list of selected items, or NULL if none are selected.
19039     *
19040     * It returns a list of the selected items. This list pointer is only valid so
19041     * long as the selection doesn't change (no items are selected or unselected, or
19042     * unselected implicitly by deletion). The list contains Elm_Genlist_Item
19043     * pointers. The order of the items in this list is the order which they were
19044     * selected, i.e. the first item in this list is the first item that was
19045     * selected, and so on.
19046     *
19047     * @note If not in multi-select mode, consider using function
19048     * elm_genlist_selected_item_get() instead.
19049     *
19050     * @see elm_genlist_multi_select_set()
19051     * @see elm_genlist_selected_item_get()
19052     *
19053     * @ingroup Genlist
19054     */
19055    EAPI const Eina_List  *elm_genlist_selected_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19056    /**
19057     * Get the mode item style of items in the genlist
19058     * @param obj The genlist object
19059     * @return The mode item style string, or NULL if none is specified
19060     * 
19061     * This is a constant string and simply defines the name of the
19062     * style that will be used for mode animations. It can be
19063     * @c NULL if you don't plan to use Genlist mode. See
19064     * elm_genlist_item_mode_set() for more info.
19065     * 
19066     * @ingroup Genlist
19067     */
19068    EAPI const char       *elm_genlist_mode_item_style_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19069    /**
19070     * Set the mode item style of items in the genlist
19071     * @param obj The genlist object
19072     * @param style The mode item style string, or NULL if none is desired
19073     * 
19074     * This is a constant string and simply defines the name of the
19075     * style that will be used for mode animations. It can be
19076     * @c NULL if you don't plan to use Genlist mode. See
19077     * elm_genlist_item_mode_set() for more info.
19078     * 
19079     * @ingroup Genlist
19080     */
19081    EAPI void              elm_genlist_mode_item_style_set(Evas_Object *obj, const char *style) EINA_ARG_NONNULL(1);
19082    /**
19083     * Get a list of realized items in genlist
19084     *
19085     * @param obj The genlist object
19086     * @return The list of realized items, nor NULL if none are realized.
19087     *
19088     * This returns a list of the realized items in the genlist. The list
19089     * contains Elm_Genlist_Item pointers. The list must be freed by the
19090     * caller when done with eina_list_free(). The item pointers in the
19091     * list are only valid so long as those items are not deleted or the
19092     * genlist is not deleted.
19093     *
19094     * @see elm_genlist_realized_items_update()
19095     *
19096     * @ingroup Genlist
19097     */
19098    EAPI Eina_List        *elm_genlist_realized_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19099    /**
19100     * Get the item that is at the x, y canvas coords.
19101     *
19102     * @param obj The gelinst object.
19103     * @param x The input x coordinate
19104     * @param y The input y coordinate
19105     * @param posret The position relative to the item returned here
19106     * @return The item at the coordinates or NULL if none
19107     *
19108     * This returns the item at the given coordinates (which are canvas
19109     * relative, not object-relative). If an item is at that coordinate,
19110     * that item handle is returned, and if @p posret is not NULL, the
19111     * integer pointed to is set to a value of -1, 0 or 1, depending if
19112     * the coordinate is on the upper portion of that item (-1), on the
19113     * middle section (0) or on the lower part (1). If NULL is returned as
19114     * an item (no item found there), then posret may indicate -1 or 1
19115     * based if the coordinate is above or below all items respectively in
19116     * the genlist.
19117     *
19118     * @ingroup Genlist
19119     */
19120    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);
19121    /**
19122     * Get the first item in the genlist
19123     *
19124     * This returns the first item in the list.
19125     *
19126     * @param obj The genlist object
19127     * @return The first item, or NULL if none
19128     *
19129     * @ingroup Genlist
19130     */
19131    WILL_DEPRECATE  EAPI Elm_Genlist_Item *elm_genlist_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19132    /**
19133     * Get the last item in the genlist
19134     *
19135     * This returns the last item in the list.
19136     *
19137     * @return The last item, or NULL if none
19138     *
19139     * @ingroup Genlist
19140     */
19141    WILL_DEPRECATE  EAPI Elm_Genlist_Item *elm_genlist_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19142    /**
19143     * Set the scrollbar policy
19144     *
19145     * @param obj The genlist object
19146     * @param policy_h Horizontal scrollbar policy.
19147     * @param policy_v Vertical scrollbar policy.
19148     *
19149     * This sets the scrollbar visibility policy for the given genlist
19150     * scroller. #ELM_SMART_SCROLLER_POLICY_AUTO means the scrollbar is
19151     * made visible if it is needed, and otherwise kept hidden.
19152     * #ELM_SMART_SCROLLER_POLICY_ON turns it on all the time, and
19153     * #ELM_SMART_SCROLLER_POLICY_OFF always keeps it off. This applies
19154     * respectively for the horizontal and vertical scrollbars. Default is
19155     * #ELM_SMART_SCROLLER_POLICY_AUTO
19156     *
19157     * @see elm_genlist_scroller_policy_get()
19158     *
19159     * @ingroup Genlist
19160     */
19161    EAPI void              elm_genlist_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
19162    /**
19163     * Get the scrollbar policy
19164     *
19165     * @param obj The genlist object
19166     * @param policy_h Pointer to store the horizontal scrollbar policy.
19167     * @param policy_v Pointer to store the vertical scrollbar policy.
19168     *
19169     * @see elm_genlist_scroller_policy_set()
19170     *
19171     * @ingroup Genlist
19172     */
19173    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);
19174    /**
19175     * Get the @b next item in a genlist widget's internal list of items,
19176     * given a handle to one of those items.
19177     *
19178     * @param item The genlist item to fetch next from
19179     * @return The item after @p item, or @c NULL if there's none (and
19180     * on errors)
19181     *
19182     * This returns the item placed after the @p item, on the container
19183     * genlist.
19184     *
19185     * @see elm_genlist_item_prev_get()
19186     *
19187     * @ingroup Genlist
19188     */
19189    WILL_DEPRECATE  EAPI Elm_Genlist_Item  *elm_genlist_item_next_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19190    /**
19191     * Get the @b previous item in a genlist widget's internal list of items,
19192     * given a handle to one of those items.
19193     *
19194     * @param item The genlist item to fetch previous from
19195     * @return The item before @p item, or @c NULL if there's none (and
19196     * on errors)
19197     *
19198     * This returns the item placed before the @p item, on the container
19199     * genlist.
19200     *
19201     * @see elm_genlist_item_next_get()
19202     *
19203     * @ingroup Genlist
19204     */
19205    WILL_DEPRECATE  EAPI Elm_Genlist_Item  *elm_genlist_item_prev_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19206    /**
19207     * Get the genlist object's handle which contains a given genlist
19208     * item
19209     *
19210     * @param item The item to fetch the container from
19211     * @return The genlist (parent) object
19212     *
19213     * This returns the genlist object itself that an item belongs to.
19214     *
19215     * This function is deprecated. Please use elm_gen_item_widget_get()
19216     * 
19217     * @ingroup Genlist
19218     */
19219    WILL_DEPRECATE  EAPI Evas_Object       *elm_genlist_item_genlist_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19220    /**
19221     * Get the parent item of the given item
19222     *
19223     * @param it The item
19224     * @return The parent of the item or @c NULL if it has no parent.
19225     *
19226     * This returns the item that was specified as parent of the item @p it on
19227     * elm_genlist_item_append() and insertion related functions.
19228     *
19229     * @ingroup Genlist
19230     */
19231    EAPI Elm_Genlist_Item  *elm_genlist_item_parent_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19232    /**
19233     * Remove all sub-items (children) of the given item
19234     *
19235     * @param it The item
19236     *
19237     * This removes all items that are children (and their descendants) of the
19238     * given item @p it.
19239     *
19240     * @see elm_genlist_clear()
19241     * @see elm_genlist_item_del()
19242     *
19243     * @ingroup Genlist
19244     */
19245    EAPI void               elm_genlist_item_subitems_clear(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19246    /**
19247     * Set whether a given genlist item is selected or not
19248     *
19249     * @param it The item
19250     * @param selected Use @c EINA_TRUE, to make it selected, @c
19251     * EINA_FALSE to make it unselected
19252     *
19253     * This sets the selected state of an item. If multi selection is
19254     * not enabled on the containing genlist and @p selected is @c
19255     * EINA_TRUE, any other previously selected items will get
19256     * unselected in favor of this new one.
19257     *
19258     * @see elm_genlist_item_selected_get()
19259     *
19260     * @ingroup Genlist
19261     */
19262    WILL_DEPRECATE  EAPI void elm_genlist_item_selected_set(Elm_Genlist_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
19263    /**
19264     * Get whether a given genlist item is selected or not
19265     *
19266     * @param it The item
19267     * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
19268     *
19269     * @see elm_genlist_item_selected_set() for more details
19270     *
19271     * @ingroup Genlist
19272     */
19273    WILL_DEPRECATE  EAPI Eina_Bool elm_genlist_item_selected_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19274    /**
19275     * Sets the expanded state of an item.
19276     *
19277     * @param it The item
19278     * @param expanded The expanded state (@c EINA_TRUE expanded, @c EINA_FALSE not expanded).
19279     *
19280     * This function flags the item of type #ELM_GENLIST_ITEM_SUBITEMS as
19281     * expanded or not.
19282     *
19283     * The theme will respond to this change visually, and a signal "expanded" or
19284     * "contracted" will be sent from the genlist with a pointer to the item that
19285     * has been expanded/contracted.
19286     *
19287     * Calling this function won't show or hide any child of this item (if it is
19288     * a parent). You must manually delete and create them on the callbacks fo
19289     * the "expanded" or "contracted" signals.
19290     *
19291     * @see elm_genlist_item_expanded_get()
19292     *
19293     * @ingroup Genlist
19294     */
19295    EAPI void               elm_genlist_item_expanded_set(Elm_Genlist_Item *item, Eina_Bool expanded) EINA_ARG_NONNULL(1);
19296    /**
19297     * Get the expanded state of an item
19298     *
19299     * @param it The item
19300     * @return The expanded state
19301     *
19302     * This gets the expanded state of an item.
19303     *
19304     * @see elm_genlist_item_expanded_set()
19305     *
19306     * @ingroup Genlist
19307     */
19308    EAPI Eina_Bool          elm_genlist_item_expanded_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19309    /**
19310     * Get the depth of expanded item
19311     *
19312     * @param it The genlist item object
19313     * @return The depth of expanded item
19314     *
19315     * @ingroup Genlist
19316     */
19317    EAPI int                elm_genlist_item_expanded_depth_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19318    /**
19319     * Set whether a given genlist item is disabled or not.
19320     *
19321     * @param it The item
19322     * @param disabled Use @c EINA_TRUE, true disable it, @c EINA_FALSE
19323     * to enable it back.
19324     *
19325     * A disabled item cannot be selected or unselected. It will also
19326     * change its appearance, to signal the user it's disabled.
19327     *
19328     * @see elm_genlist_item_disabled_get()
19329     *
19330     * @ingroup Genlist
19331     */
19332    EAPI void               elm_genlist_item_disabled_set(Elm_Genlist_Item *item, Eina_Bool disabled) EINA_ARG_NONNULL(1);
19333    /**
19334     * Get whether a given genlist item is disabled or not.
19335     *
19336     * @param it The item
19337     * @return @c EINA_TRUE, if it's disabled, @c EINA_FALSE otherwise
19338     * (and on errors).
19339     *
19340     * @see elm_genlist_item_disabled_set() for more details
19341     *
19342     * @ingroup Genlist
19343     */
19344    EAPI Eina_Bool          elm_genlist_item_disabled_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19345    /**
19346     * Sets the display only state of an item.
19347     *
19348     * @param it The item
19349     * @param display_only @c EINA_TRUE if the item is display only, @c
19350     * EINA_FALSE otherwise.
19351     *
19352     * A display only item cannot be selected or unselected. It is for
19353     * display only and not selecting or otherwise clicking, dragging
19354     * etc. by the user, thus finger size rules will not be applied to
19355     * this item.
19356     *
19357     * It's good to set group index items to display only state.
19358     *
19359     * @see elm_genlist_item_display_only_get()
19360     *
19361     * @ingroup Genlist
19362     */
19363    EAPI void               elm_genlist_item_display_only_set(Elm_Genlist_Item *it, Eina_Bool display_only) EINA_ARG_NONNULL(1);
19364    /**
19365     * Get the display only state of an item
19366     *
19367     * @param it The item
19368     * @return @c EINA_TRUE if the item is display only, @c
19369     * EINA_FALSE otherwise.
19370     *
19371     * @see elm_genlist_item_display_only_set()
19372     *
19373     * @ingroup Genlist
19374     */
19375    EAPI Eina_Bool          elm_genlist_item_display_only_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19376    /**
19377     * Show the portion of a genlist's internal list containing a given
19378     * item, immediately.
19379     *
19380     * @param it The item to display
19381     *
19382     * This causes genlist to jump to the given item @p it and show it (by
19383     * immediately scrolling to that position), if it is not fully visible.
19384     *
19385     * @see elm_genlist_item_bring_in()
19386     * @see elm_genlist_item_top_show()
19387     * @see elm_genlist_item_middle_show()
19388     *
19389     * @ingroup Genlist
19390     */
19391    EAPI void               elm_genlist_item_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19392    /**
19393     * Animatedly bring in, to the visible are of a genlist, a given
19394     * item on it.
19395     *
19396     * @param it The item to display
19397     *
19398     * This causes genlist to jump to the given item @p it and show it (by
19399     * animatedly scrolling), if it is not fully visible. This may use animation
19400     * to do so and take a period of time
19401     *
19402     * @see elm_genlist_item_show()
19403     * @see elm_genlist_item_top_bring_in()
19404     * @see elm_genlist_item_middle_bring_in()
19405     *
19406     * @ingroup Genlist
19407     */
19408    EAPI void               elm_genlist_item_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19409    /**
19410     * Show the portion of a genlist's internal list containing a given
19411     * item, immediately.
19412     *
19413     * @param it The item to display
19414     *
19415     * This causes genlist to jump to the given item @p it and show it (by
19416     * immediately scrolling to that position), if it is not fully visible.
19417     *
19418     * The item will be positioned at the top of the genlist viewport.
19419     *
19420     * @see elm_genlist_item_show()
19421     * @see elm_genlist_item_top_bring_in()
19422     *
19423     * @ingroup Genlist
19424     */
19425    EAPI void               elm_genlist_item_top_show(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19426    /**
19427     * Animatedly bring in, to the visible are of a genlist, a given
19428     * item on it.
19429     *
19430     * @param it The item
19431     *
19432     * This causes genlist to jump to the given item @p it and show it (by
19433     * animatedly scrolling), if it is not fully visible. This may use animation
19434     * to do so and take a period of time
19435     *
19436     * The item will be positioned at the top of the genlist viewport.
19437     *
19438     * @see elm_genlist_item_bring_in()
19439     * @see elm_genlist_item_top_show()
19440     *
19441     * @ingroup Genlist
19442     */
19443    EAPI void               elm_genlist_item_top_bring_in(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19444    /**
19445     * Show the portion of a genlist's internal list containing a given
19446     * item, immediately.
19447     *
19448     * @param it The item to display
19449     *
19450     * This causes genlist to jump to the given item @p it and show it (by
19451     * immediately scrolling to that position), if it is not fully visible.
19452     *
19453     * The item will be positioned at the middle of the genlist viewport.
19454     *
19455     * @see elm_genlist_item_show()
19456     * @see elm_genlist_item_middle_bring_in()
19457     *
19458     * @ingroup Genlist
19459     */
19460    EAPI void               elm_genlist_item_middle_show(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19461    /**
19462     * Animatedly bring in, to the visible are of a genlist, a given
19463     * item on it.
19464     *
19465     * @param it The item
19466     *
19467     * This causes genlist to jump to the given item @p it and show it (by
19468     * animatedly scrolling), if it is not fully visible. This may use animation
19469     * to do so and take a period of time
19470     *
19471     * The item will be positioned at the middle of the genlist viewport.
19472     *
19473     * @see elm_genlist_item_bring_in()
19474     * @see elm_genlist_item_middle_show()
19475     *
19476     * @ingroup Genlist
19477     */
19478    EAPI void               elm_genlist_item_middle_bring_in(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19479    /**
19480     * Remove a genlist item from the its parent, deleting it.
19481     *
19482     * @param item The item to be removed.
19483     * @return @c EINA_TRUE on success or @c EINA_FALSE, otherwise.
19484     *
19485     * @see elm_genlist_clear(), to remove all items in a genlist at
19486     * once.
19487     *
19488     * @ingroup Genlist
19489     */
19490    EAPI void               elm_genlist_item_del(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19491    /**
19492     * Return the data associated to a given genlist item
19493     *
19494     * @param item The genlist item.
19495     * @return the data associated to this item.
19496     *
19497     * This returns the @c data value passed on the
19498     * elm_genlist_item_append() and related item addition calls.
19499     *
19500     * @see elm_genlist_item_append()
19501     * @see elm_genlist_item_data_set()
19502     *
19503     * @ingroup Genlist
19504     */
19505    EAPI void              *elm_genlist_item_data_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19506    /**
19507     * Set the data associated to a given genlist item
19508     *
19509     * @param item The genlist item
19510     * @param data The new data pointer to set on it
19511     *
19512     * This @b overrides the @c data value passed on the
19513     * elm_genlist_item_append() and related item addition calls. This
19514     * function @b won't call elm_genlist_item_update() automatically,
19515     * so you'd issue it afterwards if you want to hove the item
19516     * updated to reflect the that new data.
19517     *
19518     * @see elm_genlist_item_data_get()
19519     *
19520     * @ingroup Genlist
19521     */
19522    EAPI void               elm_genlist_item_data_set(Elm_Genlist_Item *it, const void *data) EINA_ARG_NONNULL(1);
19523    /**
19524     * Tells genlist to "orphan" icons fetchs by the item class
19525     *
19526     * @param it The item
19527     *
19528     * This instructs genlist to release references to icons in the item,
19529     * meaning that they will no longer be managed by genlist and are
19530     * floating "orphans" that can be re-used elsewhere if the user wants
19531     * to.
19532     *
19533     * @ingroup Genlist
19534     */
19535    EAPI void               elm_genlist_item_contents_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19536    WILL_DEPRECATE  EAPI void               elm_genlist_item_icons_orphan(Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19537    /**
19538     * Get the real Evas object created to implement the view of a
19539     * given genlist item
19540     *
19541     * @param item The genlist item.
19542     * @return the Evas object implementing this item's view.
19543     *
19544     * This returns the actual Evas object used to implement the
19545     * specified genlist item's view. This may be @c NULL, as it may
19546     * not have been created or may have been deleted, at any time, by
19547     * the genlist. <b>Do not modify this object</b> (move, resize,
19548     * show, hide, etc.), as the genlist is controlling it. This
19549     * function is for querying, emitting custom signals or hooking
19550     * lower level callbacks for events on that object. Do not delete
19551     * this object under any circumstances.
19552     *
19553     * @see elm_genlist_item_data_get()
19554     *
19555     * @ingroup Genlist
19556     */
19557    EAPI const Evas_Object *elm_genlist_item_object_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19558    /**
19559     * Update the contents of an item
19560     *
19561     * @param it The item
19562     *
19563     * This updates an item by calling all the item class functions again
19564     * to get the icons, labels and states. Use this when the original
19565     * item data has changed and the changes are desired to be reflected.
19566     *
19567     * Use elm_genlist_realized_items_update() to update all already realized
19568     * items.
19569     *
19570     * @see elm_genlist_realized_items_update()
19571     *
19572     * @ingroup Genlist
19573     */
19574    EAPI void               elm_genlist_item_update(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19575    EAPI void               elm_genlist_item_fields_update(Elm_Genlist_Item *it, const char *parts, Elm_Genlist_Item_Field_Flags itf) EINA_ARG_NONNULL(1);
19576    /**
19577     * Update the item class of an item
19578     *
19579     * @param it The item
19580     * @param itc The item class for the item
19581     *
19582     * This sets another class fo the item, changing the way that it is
19583     * displayed. After changing the item class, elm_genlist_item_update() is
19584     * called on the item @p it.
19585     *
19586     * @ingroup Genlist
19587     */
19588    EAPI void               elm_genlist_item_item_class_update(Elm_Genlist_Item *it, const Elm_Genlist_Item_Class *itc) EINA_ARG_NONNULL(1, 2);
19589    EAPI const Elm_Genlist_Item_Class *elm_genlist_item_item_class_get(const Elm_Genlist_Item *it) EINA_ARG_NONNULL(1);
19590    /**
19591     * Set the text to be shown in a given genlist item's tooltips.
19592     *
19593     * @param item The genlist item
19594     * @param text The text to set in the content
19595     *
19596     * This call will setup the text to be used as tooltip to that item
19597     * (analogous to elm_object_tooltip_text_set(), but being item
19598     * tooltips with higher precedence than object tooltips). It can
19599     * have only one tooltip at a time, so any previous tooltip data
19600     * will get removed.
19601     *
19602     * In order to set an icon or something else as a tooltip, look at
19603     * elm_genlist_item_tooltip_content_cb_set().
19604     *
19605     * @ingroup Genlist
19606     */
19607    EAPI void               elm_genlist_item_tooltip_text_set(Elm_Genlist_Item *item, const char *text) EINA_ARG_NONNULL(1);
19608    /**
19609     * Set the content to be shown in a given genlist item's tooltips
19610     *
19611     * @param item The genlist item.
19612     * @param func The function returning the tooltip contents.
19613     * @param data What to provide to @a func as callback data/context.
19614     * @param del_cb Called when data is not needed anymore, either when
19615     *        another callback replaces @p func, the tooltip is unset with
19616     *        elm_genlist_item_tooltip_unset() or the owner @p item
19617     *        dies. This callback receives as its first parameter the
19618     *        given @p data, being @c event_info the item handle.
19619     *
19620     * This call will setup the tooltip's contents to @p item
19621     * (analogous to elm_object_tooltip_content_cb_set(), but being
19622     * item tooltips with higher precedence than object tooltips). It
19623     * can have only one tooltip at a time, so any previous tooltip
19624     * content will get removed. @p func (with @p data) will be called
19625     * every time Elementary needs to show the tooltip and it should
19626     * return a valid Evas object, which will be fully managed by the
19627     * tooltip system, getting deleted when the tooltip is gone.
19628     *
19629     * In order to set just a text as a tooltip, look at
19630     * elm_genlist_item_tooltip_text_set().
19631     *
19632     * @ingroup Genlist
19633     */
19634    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);
19635    /**
19636     * Unset a tooltip from a given genlist item
19637     *
19638     * @param item genlist item to remove a previously set tooltip from.
19639     *
19640     * This call removes any tooltip set on @p item. The callback
19641     * provided as @c del_cb to
19642     * elm_genlist_item_tooltip_content_cb_set() will be called to
19643     * notify it is not used anymore (and have resources cleaned, if
19644     * need be).
19645     *
19646     * @see elm_genlist_item_tooltip_content_cb_set()
19647     *
19648     * @ingroup Genlist
19649     */
19650    EAPI void               elm_genlist_item_tooltip_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19651    /**
19652     * Set a different @b style for a given genlist item's tooltip.
19653     *
19654     * @param item genlist item with tooltip set
19655     * @param style the <b>theme style</b> to use on tooltips (e.g. @c
19656     * "default", @c "transparent", etc)
19657     *
19658     * Tooltips can have <b>alternate styles</b> to be displayed on,
19659     * which are defined by the theme set on Elementary. This function
19660     * works analogously as elm_object_tooltip_style_set(), but here
19661     * applied only to genlist item objects. The default style for
19662     * tooltips is @c "default".
19663     *
19664     * @note before you set a style you should define a tooltip with
19665     *       elm_genlist_item_tooltip_content_cb_set() or
19666     *       elm_genlist_item_tooltip_text_set()
19667     *
19668     * @see elm_genlist_item_tooltip_style_get()
19669     *
19670     * @ingroup Genlist
19671     */
19672    EAPI void               elm_genlist_item_tooltip_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
19673    /**
19674     * Get the style set a given genlist item's tooltip.
19675     *
19676     * @param item genlist item with tooltip already set on.
19677     * @return style the theme style in use, which defaults to
19678     *         "default". If the object does not have a tooltip set,
19679     *         then @c NULL is returned.
19680     *
19681     * @see elm_genlist_item_tooltip_style_set() for more details
19682     *
19683     * @ingroup Genlist
19684     */
19685    EAPI const char        *elm_genlist_item_tooltip_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19686    /**
19687     * @brief Disable size restrictions on an object's tooltip
19688     * @param item The tooltip's anchor object
19689     * @param disable If EINA_TRUE, size restrictions are disabled
19690     * @return EINA_FALSE on failure, EINA_TRUE on success
19691     *
19692     * This function allows a tooltip to expand beyond its parant window's canvas.
19693     * It will instead be limited only by the size of the display.
19694     */
19695    EAPI Eina_Bool          elm_genlist_item_tooltip_size_restrict_disable(Elm_Genlist_Item *item, Eina_Bool disable);
19696    /**
19697     * @brief Retrieve size restriction state of an object's tooltip
19698     * @param item The tooltip's anchor object
19699     * @return If EINA_TRUE, size restrictions are disabled
19700     *
19701     * This function returns whether a tooltip is allowed to expand beyond
19702     * its parant window's canvas.
19703     * It will instead be limited only by the size of the display.
19704     */
19705    EAPI Eina_Bool          elm_genlist_item_tooltip_size_restrict_disabled_get(const Elm_Genlist_Item *item);
19706    /**
19707     * Set the type of mouse pointer/cursor decoration to be shown,
19708     * when the mouse pointer is over the given genlist widget item
19709     *
19710     * @param item genlist item to customize cursor on
19711     * @param cursor the cursor type's name
19712     *
19713     * This function works analogously as elm_object_cursor_set(), but
19714     * here the cursor's changing area is restricted to the item's
19715     * area, and not the whole widget's. Note that that item cursors
19716     * have precedence over widget cursors, so that a mouse over @p
19717     * item will always show cursor @p type.
19718     *
19719     * If this function is called twice for an object, a previously set
19720     * cursor will be unset on the second call.
19721     *
19722     * @see elm_object_cursor_set()
19723     * @see elm_genlist_item_cursor_get()
19724     * @see elm_genlist_item_cursor_unset()
19725     *
19726     * @ingroup Genlist
19727     */
19728    EAPI void               elm_genlist_item_cursor_set(Elm_Genlist_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
19729    /**
19730     * Get the type of mouse pointer/cursor decoration set to be shown,
19731     * when the mouse pointer is over the given genlist widget item
19732     *
19733     * @param item genlist item with custom cursor set
19734     * @return the cursor type's name or @c NULL, if no custom cursors
19735     * were set to @p item (and on errors)
19736     *
19737     * @see elm_object_cursor_get()
19738     * @see elm_genlist_item_cursor_set() for more details
19739     * @see elm_genlist_item_cursor_unset()
19740     *
19741     * @ingroup Genlist
19742     */
19743    EAPI const char        *elm_genlist_item_cursor_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19744    /**
19745     * Unset any custom mouse pointer/cursor decoration set to be
19746     * shown, when the mouse pointer is over the given genlist widget
19747     * item, thus making it show the @b default cursor again.
19748     *
19749     * @param item a genlist item
19750     *
19751     * Use this call to undo any custom settings on this item's cursor
19752     * decoration, bringing it back to defaults (no custom style set).
19753     *
19754     * @see elm_object_cursor_unset()
19755     * @see elm_genlist_item_cursor_set() for more details
19756     *
19757     * @ingroup Genlist
19758     */
19759    EAPI void               elm_genlist_item_cursor_unset(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19760    /**
19761     * Set a different @b style for a given custom cursor set for a
19762     * genlist item.
19763     *
19764     * @param item genlist item with custom cursor set
19765     * @param style the <b>theme style</b> to use (e.g. @c "default",
19766     * @c "transparent", etc)
19767     *
19768     * This function only makes sense when one is using custom mouse
19769     * cursor decorations <b>defined in a theme file</b> , which can
19770     * have, given a cursor name/type, <b>alternate styles</b> on
19771     * it. It works analogously as elm_object_cursor_style_set(), but
19772     * here applied only to genlist item objects.
19773     *
19774     * @warning Before you set a cursor style you should have defined a
19775     *       custom cursor previously on the item, with
19776     *       elm_genlist_item_cursor_set()
19777     *
19778     * @see elm_genlist_item_cursor_engine_only_set()
19779     * @see elm_genlist_item_cursor_style_get()
19780     *
19781     * @ingroup Genlist
19782     */
19783    EAPI void               elm_genlist_item_cursor_style_set(Elm_Genlist_Item *item, const char *style) EINA_ARG_NONNULL(1);
19784    /**
19785     * Get the current @b style set for a given genlist item's custom
19786     * cursor
19787     *
19788     * @param item genlist item with custom cursor set.
19789     * @return style the cursor style in use. If the object does not
19790     *         have a cursor set, then @c NULL is returned.
19791     *
19792     * @see elm_genlist_item_cursor_style_set() for more details
19793     *
19794     * @ingroup Genlist
19795     */
19796    EAPI const char        *elm_genlist_item_cursor_style_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19797    /**
19798     * Set if the (custom) cursor for a given genlist item should be
19799     * searched in its theme, also, or should only rely on the
19800     * rendering engine.
19801     *
19802     * @param item item with custom (custom) cursor already set on
19803     * @param engine_only Use @c EINA_TRUE to have cursors looked for
19804     * only on those provided by the rendering engine, @c EINA_FALSE to
19805     * have them searched on the widget's theme, as well.
19806     *
19807     * @note This call is of use only if you've set a custom cursor
19808     * for genlist items, with elm_genlist_item_cursor_set().
19809     *
19810     * @note By default, cursors will only be looked for between those
19811     * provided by the rendering engine.
19812     *
19813     * @ingroup Genlist
19814     */
19815    EAPI void               elm_genlist_item_cursor_engine_only_set(Elm_Genlist_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
19816    /**
19817     * Get if the (custom) cursor for a given genlist item is being
19818     * searched in its theme, also, or is only relying on the rendering
19819     * engine.
19820     *
19821     * @param item a genlist item
19822     * @return @c EINA_TRUE, if cursors are being looked for only on
19823     * those provided by the rendering engine, @c EINA_FALSE if they
19824     * are being searched on the widget's theme, as well.
19825     *
19826     * @see elm_genlist_item_cursor_engine_only_set(), for more details
19827     *
19828     * @ingroup Genlist
19829     */
19830    EAPI Eina_Bool          elm_genlist_item_cursor_engine_only_get(const Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19831    /**
19832     * Update the contents of all realized items.
19833     *
19834     * @param obj The genlist object.
19835     *
19836     * This updates all realized items by calling all the item class functions again
19837     * to get the icons, labels and states. Use this when the original
19838     * item data has changed and the changes are desired to be reflected.
19839     *
19840     * To update just one item, use elm_genlist_item_update().
19841     *
19842     * @see elm_genlist_realized_items_get()
19843     * @see elm_genlist_item_update()
19844     *
19845     * @ingroup Genlist
19846     */
19847    EAPI void               elm_genlist_realized_items_update(Evas_Object *obj) EINA_ARG_NONNULL(1);
19848    /**
19849     * Activate a genlist mode on an item
19850     *
19851     * @param item The genlist item
19852     * @param mode Mode name
19853     * @param mode_set Boolean to define set or unset mode.
19854     *
19855     * A genlist mode is a different way of selecting an item. Once a mode is
19856     * activated on an item, any other selected item is immediately unselected.
19857     * This feature provides an easy way of implementing a new kind of animation
19858     * for selecting an item, without having to entirely rewrite the item style
19859     * theme. However, the elm_genlist_selected_* API can't be used to get what
19860     * item is activate for a mode.
19861     *
19862     * The current item style will still be used, but applying a genlist mode to
19863     * an item will select it using a different kind of animation.
19864     *
19865     * The current active item for a mode can be found by
19866     * elm_genlist_mode_item_get().
19867     *
19868     * The characteristics of genlist mode are:
19869     * - Only one mode can be active at any time, and for only one item.
19870     * - Genlist handles deactivating other items when one item is activated.
19871     * - A mode is defined in the genlist theme (edc), and more modes can easily
19872     *   be added.
19873     * - A mode style and the genlist item style are different things. They
19874     *   can be combined to provide a default style to the item, with some kind
19875     *   of animation for that item when the mode is activated.
19876     *
19877     * When a mode is activated on an item, a new view for that item is created.
19878     * The theme of this mode defines the animation that will be used to transit
19879     * the item from the old view to the new view. This second (new) view will be
19880     * active for that item while the mode is active on the item, and will be
19881     * destroyed after the mode is totally deactivated from that item.
19882     *
19883     * @see elm_genlist_mode_get()
19884     * @see elm_genlist_mode_item_get()
19885     *
19886     * @ingroup Genlist
19887     */
19888    EAPI void               elm_genlist_item_mode_set(Elm_Genlist_Item *it, const char *mode_type, Eina_Bool mode_set) EINA_ARG_NONNULL(1, 2);
19889    /**
19890     * Get the last (or current) genlist mode used.
19891     *
19892     * @param obj The genlist object
19893     *
19894     * This function just returns the name of the last used genlist mode. It will
19895     * be the current mode if it's still active.
19896     *
19897     * @see elm_genlist_item_mode_set()
19898     * @see elm_genlist_mode_item_get()
19899     *
19900     * @ingroup Genlist
19901     */
19902    EAPI const char        *elm_genlist_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19903    /**
19904     * Get active genlist mode item
19905     *
19906     * @param obj The genlist object
19907     * @return The active item for that current mode. Or @c NULL if no item is
19908     * activated with any mode.
19909     *
19910     * This function returns the item that was activated with a mode, by the
19911     * function elm_genlist_item_mode_set().
19912     *
19913     * @see elm_genlist_item_mode_set()
19914     * @see elm_genlist_mode_get()
19915     *
19916     * @ingroup Genlist
19917     */
19918    EAPI const Elm_Genlist_Item *elm_genlist_mode_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19919
19920    /**
19921     * Set reorder mode
19922     *
19923     * @param obj The genlist object
19924     * @param reorder_mode The reorder mode
19925     * (EINA_TRUE = on, EINA_FALSE = off)
19926     *
19927     * @ingroup Genlist
19928     */
19929    EAPI void               elm_genlist_reorder_mode_set(Evas_Object *obj, Eina_Bool reorder_mode) EINA_ARG_NONNULL(1);
19930
19931    /**
19932     * Get the reorder mode
19933     *
19934     * @param obj The genlist object
19935     * @return The reorder mode
19936     * (EINA_TRUE = on, EINA_FALSE = off)
19937     *
19938     * @ingroup Genlist
19939     */
19940    EAPI Eina_Bool          elm_genlist_reorder_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19941
19942    EAPI void               elm_genlist_edit_mode_set(Evas_Object *obj, Eina_Bool edit_mode) EINA_ARG_NONNULL(1);
19943    EAPI Eina_Bool          elm_genlist_edit_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19944    EAPI void               elm_genlist_item_rename_mode_set(Elm_Genlist_Item *it, Eina_Bool renamed) EINA_ARG_NONNULL(1);
19945    EAPI Eina_Bool          elm_genlist_item_rename_mode_get(Elm_Genlist_Item *item) EINA_ARG_NONNULL(1);
19946    EAPI void               elm_genlist_item_move_after(Elm_Genlist_Item *it, Elm_Genlist_Item *after ) EINA_ARG_NONNULL(1, 2);
19947    EAPI void               elm_genlist_item_move_before(Elm_Genlist_Item *it, Elm_Genlist_Item *before) EINA_ARG_NONNULL(1, 2);
19948    EAPI void               elm_genlist_effect_set(const Evas_Object *obj, Eina_Bool emode) EINA_ARG_NONNULL(1);
19949    EAPI void               elm_genlist_pinch_zoom_set(Evas_Object *obj, Eina_Bool emode) EINA_ARG_NONNULL(1);
19950    EAPI void               elm_genlist_pinch_zoom_mode_set(Evas_Object *obj, Eina_Bool emode) EINA_ARG_NONNULL(1);
19951    EAPI Eina_Bool          elm_genlist_pinch_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
19952
19953    /**
19954     * @}
19955     */
19956
19957    /**
19958     * @defgroup Check Check
19959     *
19960     * @image html img/widget/check/preview-00.png
19961     * @image latex img/widget/check/preview-00.eps
19962     * @image html img/widget/check/preview-01.png
19963     * @image latex img/widget/check/preview-01.eps
19964     * @image html img/widget/check/preview-02.png
19965     * @image latex img/widget/check/preview-02.eps
19966     *
19967     * @brief The check widget allows for toggling a value between true and
19968     * false.
19969     *
19970     * Check objects are a lot like radio objects in layout and functionality
19971     * except they do not work as a group, but independently and only toggle the
19972     * value of a boolean from false to true (0 or 1). elm_check_state_set() sets
19973     * the boolean state (1 for true, 0 for false), and elm_check_state_get()
19974     * returns the current state. For convenience, like the radio objects, you
19975     * can set a pointer to a boolean directly with elm_check_state_pointer_set()
19976     * for it to modify.
19977     *
19978     * Signals that you can add callbacks for are:
19979     * "changed" - This is called whenever the user changes the state of one of
19980     *             the check object(event_info is NULL).
19981     *
19982     * Default contents parts of the check widget that you can use for are:
19983     * @li "icon" - A icon of the check
19984     *
19985     * Default text parts of the check widget that you can use for are:
19986     * @li "elm.text" - Label of the check
19987     *
19988     * @ref tutorial_check should give you a firm grasp of how to use this widget
19989     * .
19990     * @{
19991     */
19992    /**
19993     * @brief Add a new Check object
19994     *
19995     * @param parent The parent object
19996     * @return The new object or NULL if it cannot be created
19997     */
19998    EAPI Evas_Object *elm_check_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
19999    /**
20000     * @brief Set the text label of the check object
20001     *
20002     * @param obj The check object
20003     * @param label The text label string in UTF-8
20004     *
20005     * @deprecated use elm_object_text_set() instead.
20006     */
20007    EINA_DEPRECATED EAPI void         elm_check_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
20008    /**
20009     * @brief Get the text label of the check object
20010     *
20011     * @param obj The check object
20012     * @return The text label string in UTF-8
20013     *
20014     * @deprecated use elm_object_text_get() instead.
20015     */
20016    EINA_DEPRECATED EAPI const char  *elm_check_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20017    /**
20018     * @brief Set the icon object of the check object
20019     *
20020     * @param obj The check object
20021     * @param icon The icon object
20022     *
20023     * Once the icon object is set, a previously set one will be deleted.
20024     * If you want to keep that old content object, use the
20025     * elm_object_content_unset() function.
20026     *
20027     * @deprecated use elm_object_part_content_set() instead.
20028     *
20029     */
20030    EINA_DEPRECATED EAPI void         elm_check_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
20031    /**
20032     * @brief Get the icon object of the check object
20033     *
20034     * @param obj The check object
20035     * @return The icon object
20036     *
20037     * @deprecated use elm_object_part_content_get() instead.
20038     *  
20039     */
20040    EINA_DEPRECATED EAPI Evas_Object *elm_check_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20041    /**
20042     * @brief Unset the icon used for the check object
20043     *
20044     * @param obj The check object
20045     * @return The icon object that was being used
20046     *
20047     * Unparent and return the icon object which was set for this widget.
20048     *
20049     * @deprecated use elm_object_part_content_unset() instead.
20050     *
20051     */
20052    EINA_DEPRECATED EAPI Evas_Object *elm_check_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20053    /**
20054     * @brief Set the on/off state of the check object
20055     *
20056     * @param obj The check object
20057     * @param state The state to use (1 == on, 0 == off)
20058     *
20059     * This sets the state of the check. If set
20060     * with elm_check_state_pointer_set() the state of that variable is also
20061     * changed. Calling this @b doesn't cause the "changed" signal to be emited.
20062     */
20063    EAPI void         elm_check_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
20064    /**
20065     * @brief Get the state of the check object
20066     *
20067     * @param obj The check object
20068     * @return The boolean state
20069     */
20070    EAPI Eina_Bool    elm_check_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20071    /**
20072     * @brief Set a convenience pointer to a boolean to change
20073     *
20074     * @param obj The check object
20075     * @param statep Pointer to the boolean to modify
20076     *
20077     * This sets a pointer to a boolean, that, in addition to the check objects
20078     * state will also be modified directly. To stop setting the object pointed
20079     * to simply use NULL as the @p statep parameter. If @p statep is not NULL,
20080     * then when this is called, the check objects state will also be modified to
20081     * reflect the value of the boolean @p statep points to, just like calling
20082     * elm_check_state_set().
20083     */
20084    EAPI void         elm_check_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1);
20085    /**
20086     * @}
20087     */
20088
20089    /* compatibility code for toggle controls */
20090
20091    EINA_DEPRECATED EAPI extern inline Evas_Object *elm_toggle_add(Evas_Object *parent) EINA_ARG_NONNULL(1)
20092      {
20093         Evas_Object *obj;
20094
20095         obj = elm_check_add(parent);
20096         elm_object_style_set(obj, "toggle");
20097         elm_object_part_text_set(obj, "on", "ON");
20098         elm_object_part_text_set(obj, "off", "OFF");
20099         return obj;
20100      }
20101
20102    EINA_DEPRECATED EAPI extern inline void elm_toggle_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1)
20103      {
20104         elm_object_text_set(obj, label);
20105      }
20106
20107    EINA_DEPRECATED EAPI extern inline const char  *elm_toggle_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1)
20108      {
20109         return elm_object_text_get(obj);
20110      }
20111
20112    EINA_DEPRECATED EAPI extern inline void elm_toggle_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1)
20113      {
20114         elm_object_content_set(obj, icon);
20115      }
20116
20117    EINA_DEPRECATED EAPI extern inline Evas_Object *elm_toggle_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1)
20118      {
20119         return elm_object_content_get(obj);
20120      }
20121
20122    EINA_DEPRECATED EAPI extern inline Evas_Object *elm_toggle_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1)
20123      {
20124         return elm_object_content_unset(obj);
20125      }
20126
20127    EINA_DEPRECATED EAPI extern inline void elm_toggle_states_labels_set(Evas_Object *obj, const char *onlabel, const char *offlabel) EINA_ARG_NONNULL(1)
20128      {
20129         elm_object_part_text_set(obj, "on", onlabel);
20130         elm_object_part_text_set(obj, "off", offlabel);
20131      }
20132
20133    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)
20134      {
20135         if (onlabel) *onlabel = elm_object_part_text_get(obj, "on");
20136         if (offlabel) *offlabel = elm_object_part_text_get(obj, "off");
20137      }
20138
20139    EINA_DEPRECATED EAPI extern inline void elm_toggle_state_set(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1)
20140      {
20141         elm_check_state_set(obj, state);
20142      }
20143
20144    EINA_DEPRECATED EAPI extern inline Eina_Bool elm_toggle_state_get(const Evas_Object *obj) EINA_ARG_NONNULL(1)
20145      {
20146         return elm_check_state_get(obj);
20147      }
20148
20149    EINA_DEPRECATED EAPI extern inline void elm_toggle_state_pointer_set(Evas_Object *obj, Eina_Bool *statep) EINA_ARG_NONNULL(1)
20150      {
20151         elm_check_state_pointer_set(obj, statep);
20152      }
20153
20154    /**
20155     * @defgroup Radio Radio
20156     *
20157     * @image html img/widget/radio/preview-00.png
20158     * @image latex img/widget/radio/preview-00.eps
20159     *
20160     * @brief Radio is a widget that allows for 1 or more options to be displayed
20161     * and have the user choose only 1 of them.
20162     *
20163     * A radio object contains an indicator, an optional Label and an optional
20164     * icon object. While it's possible to have a group of only one radio they,
20165     * are normally used in groups of 2 or more. To add a radio to a group use
20166     * elm_radio_group_add(). The radio object(s) will select from one of a set
20167     * of integer values, so any value they are configuring needs to be mapped to
20168     * a set of integers. To configure what value that radio object represents,
20169     * use  elm_radio_state_value_set() to set the integer it represents. To set
20170     * the value the whole group(which one is currently selected) is to indicate
20171     * use elm_radio_value_set() on any group member, and to get the groups value
20172     * use elm_radio_value_get(). For convenience the radio objects are also able
20173     * to directly set an integer(int) to the value that is selected. To specify
20174     * the pointer to this integer to modify, use elm_radio_value_pointer_set().
20175     * The radio objects will modify this directly. That implies the pointer must
20176     * point to valid memory for as long as the radio objects exist.
20177     *
20178     * Signals that you can add callbacks for are:
20179     * @li changed - This is called whenever the user changes the state of one of
20180     * the radio objects within the group of radio objects that work together.
20181     *
20182     * Default contents parts of the radio widget that you can use for are:
20183     * @li "icon" - A icon of the radio
20184     *
20185     * @ref tutorial_radio show most of this API in action.
20186     * @{
20187     */
20188    /**
20189     * @brief Add a new radio to the parent
20190     *
20191     * @param parent The parent object
20192     * @return The new object or NULL if it cannot be created
20193     */
20194    EAPI Evas_Object *elm_radio_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20195    /**
20196     * @brief Set the text label of the radio object
20197     *
20198     * @param obj The radio object
20199     * @param label The text label string in UTF-8
20200     *
20201     * @deprecated use elm_object_text_set() instead.
20202     */
20203    EINA_DEPRECATED EAPI void         elm_radio_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
20204    /**
20205     * @brief Get the text label of the radio object
20206     *
20207     * @param obj The radio object
20208     * @return The text label string in UTF-8
20209     *
20210     * @deprecated use elm_object_text_set() instead.
20211     */
20212    EINA_DEPRECATED EAPI const char  *elm_radio_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20213    /**
20214     * @brief Set the icon object of the radio object
20215     *
20216     * @param obj The radio object
20217     * @param icon The icon object
20218     *
20219     * Once the icon object is set, a previously set one will be deleted. If you
20220     * want to keep that old content object, use the elm_radio_icon_unset()
20221     * function.
20222     *
20223     * @deprecated use elm_object_part_content_set() instead.
20224     *
20225     */
20226    WILL_DEPRECATE  EAPI void         elm_radio_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
20227    /**
20228     * @brief Get the icon object of the radio object
20229     *
20230     * @param obj The radio object
20231     * @return The icon object
20232     *
20233     * @see elm_radio_icon_set()
20234     *
20235     * @deprecated use elm_object_part_content_get() instead.
20236     *
20237     */
20238    WILL_DEPRECATE  EAPI Evas_Object *elm_radio_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20239    /**
20240     * @brief Unset the icon used for the radio object
20241     *
20242     * @param obj The radio object
20243     * @return The icon object that was being used
20244     *
20245     * Unparent and return the icon object which was set for this widget.
20246     *
20247     * @see elm_radio_icon_set()
20248     * @deprecated use elm_object_part_content_unset() instead.
20249     *
20250     */
20251    WILL_DEPRECATE  EAPI Evas_Object *elm_radio_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
20252    /**
20253     * @brief Add this radio to a group of other radio objects
20254     *
20255     * @param obj The radio object
20256     * @param group Any object whose group the @p obj is to join.
20257     *
20258     * Radio objects work in groups. Each member should have a different integer
20259     * value assigned. In order to have them work as a group, they need to know
20260     * about each other. This adds the given radio object to the group of which
20261     * the group object indicated is a member.
20262     */
20263    EAPI void         elm_radio_group_add(Evas_Object *obj, Evas_Object *group) EINA_ARG_NONNULL(1);
20264    /**
20265     * @brief Set the integer value that this radio object represents
20266     *
20267     * @param obj The radio object
20268     * @param value The value to use if this radio object is selected
20269     *
20270     * This sets the value of the radio.
20271     */
20272    EAPI void         elm_radio_state_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
20273    /**
20274     * @brief Get the integer value that this radio object represents
20275     *
20276     * @param obj The radio object
20277     * @return The value used if this radio object is selected
20278     *
20279     * This gets the value of the radio.
20280     *
20281     * @see elm_radio_value_set()
20282     */
20283    EAPI int          elm_radio_state_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20284    /**
20285     * @brief Set the value of the radio.
20286     *
20287     * @param obj The radio object
20288     * @param value The value to use for the group
20289     *
20290     * This sets the value of the radio group and will also set the value if
20291     * pointed to, to the value supplied, but will not call any callbacks.
20292     */
20293    EAPI void         elm_radio_value_set(Evas_Object *obj, int value) EINA_ARG_NONNULL(1);
20294    /**
20295     * @brief Get the state of the radio object
20296     *
20297     * @param obj The radio object
20298     * @return The integer state
20299     */
20300    EAPI int          elm_radio_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20301    /**
20302     * @brief Set a convenience pointer to a integer to change
20303     *
20304     * @param obj The radio object
20305     * @param valuep Pointer to the integer to modify
20306     *
20307     * This sets a pointer to a integer, that, in addition to the radio objects
20308     * state will also be modified directly. To stop setting the object pointed
20309     * to simply use NULL as the @p valuep argument. If valuep is not NULL, then
20310     * when this is called, the radio objects state will also be modified to
20311     * reflect the value of the integer valuep points to, just like calling
20312     * elm_radio_value_set().
20313     */
20314    EAPI void         elm_radio_value_pointer_set(Evas_Object *obj, int *valuep) EINA_ARG_NONNULL(1);
20315    /**
20316     * @}
20317     */
20318
20319    /**
20320     * @defgroup Pager Pager
20321     *
20322     * @image html img/widget/pager/preview-00.png
20323     * @image latex img/widget/pager/preview-00.eps
20324     *
20325     * @brief Widget that allows flipping between one or more “pages”
20326     * of objects.
20327     *
20328     * The flipping between pages of objects is animated. All content
20329     * in the pager is kept in a stack, being the last content added
20330     * (visible one) on the top of that stack.
20331     *
20332     * Objects can be pushed or popped from the stack or deleted as
20333     * well. Pushes and pops will animate the widget accordingly to its
20334     * style (a pop will also delete the child object once the
20335     * animation is finished). Any object already in the pager can be
20336     * promoted to the top (from its current stacking position) through
20337     * the use of elm_pager_content_promote(). New objects are pushed
20338     * to the top with elm_pager_content_push(). When the top item is
20339     * no longer wanted, simply pop it with elm_pager_content_pop() and
20340     * it will also be deleted. If an object is no longer needed and is
20341     * not the top item, just delete it as normal. You can query which
20342     * objects are the top and bottom with
20343     * elm_pager_content_bottom_get() and elm_pager_content_top_get().
20344     *
20345     * Signals that you can add callbacks for are:
20346     * - @c "show,finished" - when a new page is actually shown on the top
20347     * - @c "hide,finished" - when a previous page is hidden
20348     *
20349     * Only after the first of that signals the child object is
20350     * guaranteed to be visible, as in @c evas_object_visible_get().
20351     *
20352     * This widget has the following styles available:
20353     * - @c "default"
20354     * - @c "fade"
20355     * - @c "fade_translucide"
20356     * - @c "fade_invisible"
20357     *
20358     * @note These styles affect only the flipping animations on the
20359     * default theme; the appearance when not animating is unaffected
20360     * by them.
20361     *
20362     * @ref tutorial_pager gives a good overview of the usage of the API.
20363     * @{
20364     */
20365
20366    /**
20367     * Add a new pager to the parent
20368     *
20369     * @param parent The parent object
20370     * @return The new object or NULL if it cannot be created
20371     *
20372     * @ingroup Pager
20373     */
20374    EAPI Evas_Object *elm_pager_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20375
20376    /**
20377     * @brief Push an object to the top of the pager stack (and show it).
20378     *
20379     * @param obj The pager object
20380     * @param content The object to push
20381     *
20382     * The object pushed becomes a child of the pager, it will be controlled and
20383     * deleted when the pager is deleted.
20384     *
20385     * @note If the content is already in the stack use
20386     * elm_pager_content_promote().
20387     * @warning Using this function on @p content already in the stack results in
20388     * undefined behavior.
20389     */
20390    EAPI void         elm_pager_content_push(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20391
20392    /**
20393     * @brief Pop the object that is on top of the stack
20394     *
20395     * @param obj The pager object
20396     *
20397     * This pops the object that is on the top(visible) of the pager, makes it
20398     * disappear, then deletes the object. The object that was underneath it on
20399     * the stack will become visible.
20400     */
20401    EAPI void         elm_pager_content_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
20402
20403    /**
20404     * @brief Moves an object already in the pager stack to the top of the stack.
20405     *
20406     * @param obj The pager object
20407     * @param content The object to promote
20408     *
20409     * This will take the @p content and move it to the top of the stack as
20410     * if it had been pushed there.
20411     *
20412     * @note If the content isn't already in the stack use
20413     * elm_pager_content_push().
20414     * @warning Using this function on @p content not already in the stack
20415     * results in undefined behavior.
20416     */
20417    EAPI void         elm_pager_content_promote(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
20418
20419    /**
20420     * @brief Return the object at the bottom of the pager stack
20421     *
20422     * @param obj The pager object
20423     * @return The bottom object or NULL if none
20424     */
20425    EAPI Evas_Object *elm_pager_content_bottom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20426
20427    /**
20428     * @brief  Return the object at the top of the pager stack
20429     *
20430     * @param obj The pager object
20431     * @return The top object or NULL if none
20432     */
20433    EAPI Evas_Object *elm_pager_content_top_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20434
20435    EAPI void         elm_pager_to_content_pop(Evas_Object *obj, Evas_Object *content); EINA_ARG_NONNULL(1);
20436    EINA_DEPRECATED    EAPI void         elm_pager_animation_disabled_set(Evas_Object *obj, Eina_Bool disable); EINA_ARG_NONNULL(1);
20437
20438    /**
20439     * @}
20440     */
20441
20442    /**
20443     * @defgroup Slideshow Slideshow
20444     *
20445     * @image html img/widget/slideshow/preview-00.png
20446     * @image latex img/widget/slideshow/preview-00.eps
20447     *
20448     * This widget, as the name indicates, is a pre-made image
20449     * slideshow panel, with API functions acting on (child) image
20450     * items presentation. Between those actions, are:
20451     * - advance to next/previous image
20452     * - select the style of image transition animation
20453     * - set the exhibition time for each image
20454     * - start/stop the slideshow
20455     *
20456     * The transition animations are defined in the widget's theme,
20457     * consequently new animations can be added without having to
20458     * update the widget's code.
20459     *
20460     * @section Slideshow_Items Slideshow items
20461     *
20462     * For slideshow items, just like for @ref Genlist "genlist" ones,
20463     * the user defines a @b classes, specifying functions that will be
20464     * called on the item's creation and deletion times.
20465     *
20466     * The #Elm_Slideshow_Item_Class structure contains the following
20467     * members:
20468     *
20469     * - @c func.get - When an item is displayed, this function is
20470     *   called, and it's where one should create the item object, de
20471     *   facto. For example, the object can be a pure Evas image object
20472     *   or an Elementary @ref Photocam "photocam" widget. See
20473     *   #SlideshowItemGetFunc.
20474     * - @c func.del - When an item is no more displayed, this function
20475     *   is called, where the user must delete any data associated to
20476     *   the item. See #SlideshowItemDelFunc.
20477     *
20478     * @section Slideshow_Caching Slideshow caching
20479     *
20480     * The slideshow provides facilities to have items adjacent to the
20481     * one being displayed <b>already "realized"</b> (i.e. loaded) for
20482     * you, so that the system does not have to decode image data
20483     * anymore at the time it has to actually switch images on its
20484     * viewport. The user is able to set the numbers of items to be
20485     * cached @b before and @b after the current item, in the widget's
20486     * item list.
20487     *
20488     * Smart events one can add callbacks for are:
20489     *
20490     * - @c "changed" - when the slideshow switches its view to a new
20491     *   item
20492     *
20493     * List of examples for the slideshow widget:
20494     * @li @ref slideshow_example
20495     */
20496
20497    /**
20498     * @addtogroup Slideshow
20499     * @{
20500     */
20501
20502    typedef struct _Elm_Slideshow_Item_Class Elm_Slideshow_Item_Class; /**< Slideshow item class definition struct */
20503    typedef struct _Elm_Slideshow_Item_Class_Func Elm_Slideshow_Item_Class_Func; /**< Class functions for slideshow item classes. */
20504    typedef struct _Elm_Slideshow_Item       Elm_Slideshow_Item; /**< Slideshow item handle */
20505    typedef Evas_Object *(*SlideshowItemGetFunc) (void *data, Evas_Object *obj); /**< Image fetching class function for slideshow item classes. */
20506    typedef void         (*SlideshowItemDelFunc) (void *data, Evas_Object *obj); /**< Deletion class function for slideshow item classes. */
20507
20508    /**
20509     * @struct _Elm_Slideshow_Item_Class
20510     *
20511     * Slideshow item class definition. See @ref Slideshow_Items for
20512     * field details.
20513     */
20514    struct _Elm_Slideshow_Item_Class
20515      {
20516         struct _Elm_Slideshow_Item_Class_Func
20517           {
20518              SlideshowItemGetFunc get;
20519              SlideshowItemDelFunc del;
20520           } func;
20521      }; /**< #Elm_Slideshow_Item_Class member definitions */
20522
20523    /**
20524     * Add a new slideshow widget to the given parent Elementary
20525     * (container) object
20526     *
20527     * @param parent The parent object
20528     * @return A new slideshow widget handle or @c NULL, on errors
20529     *
20530     * This function inserts a new slideshow widget on the canvas.
20531     *
20532     * @ingroup Slideshow
20533     */
20534    EAPI Evas_Object        *elm_slideshow_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
20535
20536    /**
20537     * Add (append) a new item in a given slideshow widget.
20538     *
20539     * @param obj The slideshow object
20540     * @param itc The item class for the item
20541     * @param data The item's data
20542     * @return A handle to the item added or @c NULL, on errors
20543     *
20544     * Add a new item to @p obj's internal list of items, appending it.
20545     * The item's class must contain the function really fetching the
20546     * image object to show for this item, which could be an Evas image
20547     * object or an Elementary photo, for example. The @p data
20548     * parameter is going to be passed to both class functions of the
20549     * item.
20550     *
20551     * @see #Elm_Slideshow_Item_Class
20552     * @see elm_slideshow_item_sorted_insert()
20553     *
20554     * @ingroup Slideshow
20555     */
20556    EAPI Elm_Slideshow_Item *elm_slideshow_item_add(Evas_Object *obj, const Elm_Slideshow_Item_Class *itc, const void *data) EINA_ARG_NONNULL(1);
20557
20558    /**
20559     * Insert a new item into the given slideshow widget, using the @p func
20560     * function to sort items (by item handles).
20561     *
20562     * @param obj The slideshow object
20563     * @param itc The item class for the item
20564     * @param data The item's data
20565     * @param func The comparing function to be used to sort slideshow
20566     * items <b>by #Elm_Slideshow_Item item handles</b>
20567     * @return Returns The slideshow item handle, on success, or
20568     * @c NULL, on errors
20569     *
20570     * Add a new item to @p obj's internal list of items, in a position
20571     * determined by the @p func comparing function. The item's class
20572     * must contain the function really fetching the image object to
20573     * show for this item, which could be an Evas image object or an
20574     * Elementary photo, for example. The @p data parameter is going to
20575     * be passed to both class functions of the item.
20576     *
20577     * @see #Elm_Slideshow_Item_Class
20578     * @see elm_slideshow_item_add()
20579     *
20580     * @ingroup Slideshow
20581     */
20582    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);
20583
20584    /**
20585     * Display a given slideshow widget's item, programmatically.
20586     *
20587     * @param obj The slideshow object
20588     * @param item The item to display on @p obj's viewport
20589     *
20590     * The change between the current item and @p item will use the
20591     * transition @p obj is set to use (@see
20592     * elm_slideshow_transition_set()).
20593     *
20594     * @ingroup Slideshow
20595     */
20596    EAPI void                elm_slideshow_show(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
20597
20598    /**
20599     * Slide to the @b next item, in a given slideshow widget
20600     *
20601     * @param obj The slideshow object
20602     *
20603     * The sliding animation @p obj is set to use will be the
20604     * transition effect used, after this call is issued.
20605     *
20606     * @note If the end of the slideshow's internal list of items is
20607     * reached, it'll wrap around to the list's beginning, again.
20608     *
20609     * @ingroup Slideshow
20610     */
20611    EAPI void                elm_slideshow_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
20612
20613    /**
20614     * Slide to the @b previous item, in a given slideshow widget
20615     *
20616     * @param obj The slideshow object
20617     *
20618     * The sliding animation @p obj is set to use will be the
20619     * transition effect used, after this call is issued.
20620     *
20621     * @note If the beginning of the slideshow's internal list of items
20622     * is reached, it'll wrap around to the list's end, again.
20623     *
20624     * @ingroup Slideshow
20625     */
20626    EAPI void                elm_slideshow_previous(Evas_Object *obj) EINA_ARG_NONNULL(1);
20627
20628    /**
20629     * Returns the list of sliding transition/effect names available, for a
20630     * given slideshow widget.
20631     *
20632     * @param obj The slideshow object
20633     * @return The list of transitions (list of @b stringshared strings
20634     * as data)
20635     *
20636     * The transitions, which come from @p obj's theme, must be an EDC
20637     * data item named @c "transitions" on the theme file, with (prefix)
20638     * names of EDC programs actually implementing them.
20639     *
20640     * The available transitions for slideshows on the default theme are:
20641     * - @c "fade" - the current item fades out, while the new one
20642     *   fades in to the slideshow's viewport.
20643     * - @c "black_fade" - the current item fades to black, and just
20644     *   then, the new item will fade in.
20645     * - @c "horizontal" - the current item slides horizontally, until
20646     *   it gets out of the slideshow's viewport, while the new item
20647     *   comes from the left to take its place.
20648     * - @c "vertical" - the current item slides vertically, until it
20649     *   gets out of the slideshow's viewport, while the new item comes
20650     *   from the bottom to take its place.
20651     * - @c "square" - the new item starts to appear from the middle of
20652     *   the current one, but with a tiny size, growing until its
20653     *   target (full) size and covering the old one.
20654     *
20655     * @warning The stringshared strings get no new references
20656     * exclusive to the user grabbing the list, here, so if you'd like
20657     * to use them out of this call's context, you'd better @c
20658     * eina_stringshare_ref() them.
20659     *
20660     * @see elm_slideshow_transition_set()
20661     *
20662     * @ingroup Slideshow
20663     */
20664    EAPI const Eina_List    *elm_slideshow_transitions_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20665
20666    /**
20667     * Set the current slide transition/effect in use for a given
20668     * slideshow widget
20669     *
20670     * @param obj The slideshow object
20671     * @param transition The new transition's name string
20672     *
20673     * If @p transition is implemented in @p obj's theme (i.e., is
20674     * contained in the list returned by
20675     * elm_slideshow_transitions_get()), this new sliding effect will
20676     * be used on the widget.
20677     *
20678     * @see elm_slideshow_transitions_get() for more details
20679     *
20680     * @ingroup Slideshow
20681     */
20682    EAPI void                elm_slideshow_transition_set(Evas_Object *obj, const char *transition) EINA_ARG_NONNULL(1);
20683
20684    /**
20685     * Get the current slide transition/effect in use for a given
20686     * slideshow widget
20687     *
20688     * @param obj The slideshow object
20689     * @return The current transition's name
20690     *
20691     * @see elm_slideshow_transition_set() for more details
20692     *
20693     * @ingroup Slideshow
20694     */
20695    EAPI const char         *elm_slideshow_transition_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20696
20697    /**
20698     * Set the interval between each image transition on a given
20699     * slideshow widget, <b>and start the slideshow, itself</b>
20700     *
20701     * @param obj The slideshow object
20702     * @param timeout The new displaying timeout for images
20703     *
20704     * After this call, the slideshow widget will start cycling its
20705     * view, sequentially and automatically, with the images of the
20706     * items it has. The time between each new image displayed is going
20707     * to be @p timeout, in @b seconds. If a different timeout was set
20708     * previously and an slideshow was in progress, it will continue
20709     * with the new time between transitions, after this call.
20710     *
20711     * @note A value less than or equal to 0 on @p timeout will disable
20712     * the widget's internal timer, thus halting any slideshow which
20713     * could be happening on @p obj.
20714     *
20715     * @see elm_slideshow_timeout_get()
20716     *
20717     * @ingroup Slideshow
20718     */
20719    EAPI void                elm_slideshow_timeout_set(Evas_Object *obj, double timeout) EINA_ARG_NONNULL(1);
20720
20721    /**
20722     * Get the interval set for image transitions on a given slideshow
20723     * widget.
20724     *
20725     * @param obj The slideshow object
20726     * @return Returns the timeout set on it
20727     *
20728     * @see elm_slideshow_timeout_set() for more details
20729     *
20730     * @ingroup Slideshow
20731     */
20732    EAPI double              elm_slideshow_timeout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20733
20734    /**
20735     * Set if, after a slideshow is started, for a given slideshow
20736     * widget, its items should be displayed cyclically or not.
20737     *
20738     * @param obj The slideshow object
20739     * @param loop Use @c EINA_TRUE to make it cycle through items or
20740     * @c EINA_FALSE for it to stop at the end of @p obj's internal
20741     * list of items
20742     *
20743     * @note elm_slideshow_next() and elm_slideshow_previous() will @b
20744     * ignore what is set by this functions, i.e., they'll @b always
20745     * cycle through items. This affects only the "automatic"
20746     * slideshow, as set by elm_slideshow_timeout_set().
20747     *
20748     * @see elm_slideshow_loop_get()
20749     *
20750     * @ingroup Slideshow
20751     */
20752    EAPI void                elm_slideshow_loop_set(Evas_Object *obj, Eina_Bool loop) EINA_ARG_NONNULL(1);
20753
20754    /**
20755     * Get if, after a slideshow is started, for a given slideshow
20756     * widget, its items are to be displayed cyclically or not.
20757     *
20758     * @param obj The slideshow object
20759     * @return @c EINA_TRUE, if the items in @p obj will be cycled
20760     * through or @c EINA_FALSE, otherwise
20761     *
20762     * @see elm_slideshow_loop_set() for more details
20763     *
20764     * @ingroup Slideshow
20765     */
20766    EAPI Eina_Bool           elm_slideshow_loop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20767
20768    /**
20769     * Remove all items from a given slideshow widget
20770     *
20771     * @param obj The slideshow object
20772     *
20773     * This removes (and deletes) all items in @p obj, leaving it
20774     * empty.
20775     *
20776     * @see elm_slideshow_item_del(), to remove just one item.
20777     *
20778     * @ingroup Slideshow
20779     */
20780    EAPI void                elm_slideshow_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
20781
20782    /**
20783     * Get the internal list of items in a given slideshow widget.
20784     *
20785     * @param obj The slideshow object
20786     * @return The list of items (#Elm_Slideshow_Item as data) or
20787     * @c NULL on errors.
20788     *
20789     * This list is @b not to be modified in any way and must not be
20790     * freed. Use the list members with functions like
20791     * elm_slideshow_item_del(), elm_slideshow_item_data_get().
20792     *
20793     * @warning This list is only valid until @p obj object's internal
20794     * items list is changed. It should be fetched again with another
20795     * call to this function when changes happen.
20796     *
20797     * @ingroup Slideshow
20798     */
20799    EAPI const Eina_List    *elm_slideshow_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20800
20801    /**
20802     * Delete a given item from a slideshow widget.
20803     *
20804     * @param item The slideshow item
20805     *
20806     * @ingroup Slideshow
20807     */
20808    EAPI void                elm_slideshow_item_del(Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
20809
20810    /**
20811     * Return the data associated with a given slideshow item
20812     *
20813     * @param item The slideshow item
20814     * @return Returns the data associated to this item
20815     *
20816     * @ingroup Slideshow
20817     */
20818    EAPI void               *elm_slideshow_item_data_get(const Elm_Slideshow_Item *item) EINA_ARG_NONNULL(1);
20819
20820    /**
20821     * Returns the currently displayed item, in a given slideshow widget
20822     *
20823     * @param obj The slideshow object
20824     * @return A handle to the item being displayed in @p obj or
20825     * @c NULL, if none is (and on errors)
20826     *
20827     * @ingroup Slideshow
20828     */
20829    EAPI Elm_Slideshow_Item *elm_slideshow_item_current_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20830
20831    /**
20832     * Get the real Evas object created to implement the view of a
20833     * given slideshow item
20834     *
20835     * @param item The slideshow item.
20836     * @return the Evas object implementing this item's view.
20837     *
20838     * This returns the actual Evas object used to implement the
20839     * specified slideshow item's view. This may be @c NULL, as it may
20840     * not have been created or may have been deleted, at any time, by
20841     * the slideshow. <b>Do not modify this object</b> (move, resize,
20842     * show, hide, etc.), as the slideshow is controlling it. This
20843     * function is for querying, emitting custom signals or hooking
20844     * lower level callbacks for events on that object. Do not delete
20845     * this object under any circumstances.
20846     *
20847     * @see elm_slideshow_item_data_get()
20848     *
20849     * @ingroup Slideshow
20850     */
20851    EAPI Evas_Object*        elm_slideshow_item_object_get(const Elm_Slideshow_Item* item) EINA_ARG_NONNULL(1);
20852
20853    /**
20854     * Get the the item, in a given slideshow widget, placed at
20855     * position @p nth, in its internal items list
20856     *
20857     * @param obj The slideshow object
20858     * @param nth The number of the item to grab a handle to (0 being
20859     * the first)
20860     * @return The item stored in @p obj at position @p nth or @c NULL,
20861     * if there's no item with that index (and on errors)
20862     *
20863     * @ingroup Slideshow
20864     */
20865    EAPI Elm_Slideshow_Item *elm_slideshow_item_nth_get(const Evas_Object *obj, unsigned int nth) EINA_ARG_NONNULL(1);
20866
20867    /**
20868     * Set the current slide layout in use for a given slideshow widget
20869     *
20870     * @param obj The slideshow object
20871     * @param layout The new layout's name string
20872     *
20873     * If @p layout is implemented in @p obj's theme (i.e., is contained
20874     * in the list returned by elm_slideshow_layouts_get()), this new
20875     * images layout will be used on the widget.
20876     *
20877     * @see elm_slideshow_layouts_get() for more details
20878     *
20879     * @ingroup Slideshow
20880     */
20881    EAPI void                elm_slideshow_layout_set(Evas_Object *obj, const char *layout) EINA_ARG_NONNULL(1);
20882
20883    /**
20884     * Get the current slide layout in use for a given slideshow widget
20885     *
20886     * @param obj The slideshow object
20887     * @return The current layout's name
20888     *
20889     * @see elm_slideshow_layout_set() for more details
20890     *
20891     * @ingroup Slideshow
20892     */
20893    EAPI const char         *elm_slideshow_layout_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20894
20895    /**
20896     * Returns the list of @b layout names available, for a given
20897     * slideshow widget.
20898     *
20899     * @param obj The slideshow object
20900     * @return The list of layouts (list of @b stringshared strings
20901     * as data)
20902     *
20903     * Slideshow layouts will change how the widget is to dispose each
20904     * image item in its viewport, with regard to cropping, scaling,
20905     * etc.
20906     *
20907     * The layouts, which come from @p obj's theme, must be an EDC
20908     * data item name @c "layouts" on the theme file, with (prefix)
20909     * names of EDC programs actually implementing them.
20910     *
20911     * The available layouts for slideshows on the default theme are:
20912     * - @c "fullscreen" - item images with original aspect, scaled to
20913     *   touch top and down slideshow borders or, if the image's heigh
20914     *   is not enough, left and right slideshow borders.
20915     * - @c "not_fullscreen" - the same behavior as the @c "fullscreen"
20916     *   one, but always leaving 10% of the slideshow's dimensions of
20917     *   distance between the item image's borders and the slideshow
20918     *   borders, for each axis.
20919     *
20920     * @warning The stringshared strings get no new references
20921     * exclusive to the user grabbing the list, here, so if you'd like
20922     * to use them out of this call's context, you'd better @c
20923     * eina_stringshare_ref() them.
20924     *
20925     * @see elm_slideshow_layout_set()
20926     *
20927     * @ingroup Slideshow
20928     */
20929    EAPI const Eina_List    *elm_slideshow_layouts_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20930
20931    /**
20932     * Set the number of items to cache, on a given slideshow widget,
20933     * <b>before the current item</b>
20934     *
20935     * @param obj The slideshow object
20936     * @param count Number of items to cache before the current one
20937     *
20938     * The default value for this property is @c 2. See
20939     * @ref Slideshow_Caching "slideshow caching" for more details.
20940     *
20941     * @see elm_slideshow_cache_before_get()
20942     *
20943     * @ingroup Slideshow
20944     */
20945    EAPI void                elm_slideshow_cache_before_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
20946
20947    /**
20948     * Retrieve the number of items to cache, on a given slideshow widget,
20949     * <b>before the current item</b>
20950     *
20951     * @param obj The slideshow object
20952     * @return The number of items set to be cached before the current one
20953     *
20954     * @see elm_slideshow_cache_before_set() for more details
20955     *
20956     * @ingroup Slideshow
20957     */
20958    EAPI int                 elm_slideshow_cache_before_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20959
20960    /**
20961     * Set the number of items to cache, on a given slideshow widget,
20962     * <b>after the current item</b>
20963     *
20964     * @param obj The slideshow object
20965     * @param count Number of items to cache after the current one
20966     *
20967     * The default value for this property is @c 2. See
20968     * @ref Slideshow_Caching "slideshow caching" for more details.
20969     *
20970     * @see elm_slideshow_cache_after_get()
20971     *
20972     * @ingroup Slideshow
20973     */
20974    EAPI void                elm_slideshow_cache_after_set(Evas_Object *obj, int count) EINA_ARG_NONNULL(1);
20975
20976    /**
20977     * Retrieve the number of items to cache, on a given slideshow widget,
20978     * <b>after the current item</b>
20979     *
20980     * @param obj The slideshow object
20981     * @return The number of items set to be cached after the current one
20982     *
20983     * @see elm_slideshow_cache_after_set() for more details
20984     *
20985     * @ingroup Slideshow
20986     */
20987    EAPI int                 elm_slideshow_cache_after_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20988
20989    /**
20990     * Get the number of items stored in a given slideshow widget
20991     *
20992     * @param obj The slideshow object
20993     * @return The number of items on @p obj, at the moment of this call
20994     *
20995     * @ingroup Slideshow
20996     */
20997    EAPI unsigned int        elm_slideshow_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
20998
20999    /**
21000     * @}
21001     */
21002
21003    /**
21004     * @defgroup Fileselector File Selector
21005     *
21006     * @image html img/widget/fileselector/preview-00.png
21007     * @image latex img/widget/fileselector/preview-00.eps
21008     *
21009     * A file selector is a widget that allows a user to navigate
21010     * through a file system, reporting file selections back via its
21011     * API.
21012     *
21013     * It contains shortcut buttons for home directory (@c ~) and to
21014     * jump one directory upwards (..), as well as cancel/ok buttons to
21015     * confirm/cancel a given selection. After either one of those two
21016     * former actions, the file selector will issue its @c "done" smart
21017     * callback.
21018     *
21019     * There's a text entry on it, too, showing the name of the current
21020     * selection. There's the possibility of making it editable, so it
21021     * is useful on file saving dialogs on applications, where one
21022     * gives a file name to save contents to, in a given directory in
21023     * the system. This custom file name will be reported on the @c
21024     * "done" smart callback (explained in sequence).
21025     *
21026     * Finally, it has a view to display file system items into in two
21027     * possible forms:
21028     * - list
21029     * - grid
21030     *
21031     * If Elementary is built with support of the Ethumb thumbnailing
21032     * library, the second form of view will display preview thumbnails
21033     * of files which it supports.
21034     *
21035     * Smart callbacks one can register to:
21036     *
21037     * - @c "selected" - the user has clicked on a file (when not in
21038     *      folders-only mode) or directory (when in folders-only mode)
21039     * - @c "directory,open" - the list has been populated with new
21040     *      content (@c event_info is a pointer to the directory's
21041     *      path, a @b stringshared string)
21042     * - @c "done" - the user has clicked on the "ok" or "cancel"
21043     *      buttons (@c event_info is a pointer to the selection's
21044     *      path, a @b stringshared string)
21045     *
21046     * Here is an example on its usage:
21047     * @li @ref fileselector_example
21048     */
21049
21050    /**
21051     * @addtogroup Fileselector
21052     * @{
21053     */
21054
21055    /**
21056     * Defines how a file selector widget is to layout its contents
21057     * (file system entries).
21058     */
21059    typedef enum _Elm_Fileselector_Mode
21060      {
21061         ELM_FILESELECTOR_LIST = 0, /**< layout as a list */
21062         ELM_FILESELECTOR_GRID, /**< layout as a grid */
21063         ELM_FILESELECTOR_LAST /**< sentinel (helper) value, not used */
21064      } Elm_Fileselector_Mode;
21065
21066    /**
21067     * Add a new file selector widget to the given parent Elementary
21068     * (container) object
21069     *
21070     * @param parent The parent object
21071     * @return a new file selector widget handle or @c NULL, on errors
21072     *
21073     * This function inserts a new file selector widget on the canvas.
21074     *
21075     * @ingroup Fileselector
21076     */
21077    EAPI Evas_Object          *elm_fileselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21078
21079    /**
21080     * Enable/disable the file name entry box where the user can type
21081     * in a name for a file, in a given file selector widget
21082     *
21083     * @param obj The file selector object
21084     * @param is_save @c EINA_TRUE to make the file selector a "saving
21085     * dialog", @c EINA_FALSE otherwise
21086     *
21087     * Having the entry editable is useful on file saving dialogs on
21088     * applications, where one gives a file name to save contents to,
21089     * in a given directory in the system. This custom file name will
21090     * be reported on the @c "done" smart callback.
21091     *
21092     * @see elm_fileselector_is_save_get()
21093     *
21094     * @ingroup Fileselector
21095     */
21096    EAPI void                  elm_fileselector_is_save_set(Evas_Object *obj, Eina_Bool is_save) EINA_ARG_NONNULL(1);
21097
21098    /**
21099     * Get whether the given file selector is in "saving dialog" mode
21100     *
21101     * @param obj The file selector object
21102     * @return @c EINA_TRUE, if the file selector is in "saving dialog"
21103     * mode, @c EINA_FALSE otherwise (and on errors)
21104     *
21105     * @see elm_fileselector_is_save_set() for more details
21106     *
21107     * @ingroup Fileselector
21108     */
21109    EAPI Eina_Bool             elm_fileselector_is_save_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21110
21111    /**
21112     * Enable/disable folder-only view for a given file selector widget
21113     *
21114     * @param obj The file selector object
21115     * @param only @c EINA_TRUE to make @p obj only display
21116     * directories, @c EINA_FALSE to make files to be displayed in it
21117     * too
21118     *
21119     * If enabled, the widget's view will only display folder items,
21120     * naturally.
21121     *
21122     * @see elm_fileselector_folder_only_get()
21123     *
21124     * @ingroup Fileselector
21125     */
21126    EAPI void                  elm_fileselector_folder_only_set(Evas_Object *obj, Eina_Bool only) EINA_ARG_NONNULL(1);
21127
21128    /**
21129     * Get whether folder-only view is set for a given file selector
21130     * widget
21131     *
21132     * @param obj The file selector object
21133     * @return only @c EINA_TRUE if @p obj is only displaying
21134     * directories, @c EINA_FALSE if files are being displayed in it
21135     * too (and on errors)
21136     *
21137     * @see elm_fileselector_folder_only_get()
21138     *
21139     * @ingroup Fileselector
21140     */
21141    EAPI Eina_Bool             elm_fileselector_folder_only_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21142
21143    /**
21144     * Enable/disable the "ok" and "cancel" buttons on a given file
21145     * selector widget
21146     *
21147     * @param obj The file selector object
21148     * @param only @c EINA_TRUE to show them, @c EINA_FALSE to hide.
21149     *
21150     * @note A file selector without those buttons will never emit the
21151     * @c "done" smart event, and is only usable if one is just hooking
21152     * to the other two events.
21153     *
21154     * @see elm_fileselector_buttons_ok_cancel_get()
21155     *
21156     * @ingroup Fileselector
21157     */
21158    EAPI void                  elm_fileselector_buttons_ok_cancel_set(Evas_Object *obj, Eina_Bool buttons) EINA_ARG_NONNULL(1);
21159
21160    /**
21161     * Get whether the "ok" and "cancel" buttons on a given file
21162     * selector widget are being shown.
21163     *
21164     * @param obj The file selector object
21165     * @return @c EINA_TRUE if they are being shown, @c EINA_FALSE
21166     * otherwise (and on errors)
21167     *
21168     * @see elm_fileselector_buttons_ok_cancel_set() for more details
21169     *
21170     * @ingroup Fileselector
21171     */
21172    EAPI Eina_Bool             elm_fileselector_buttons_ok_cancel_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21173
21174    /**
21175     * Enable/disable a tree view in the given file selector widget,
21176     * <b>if it's in @c #ELM_FILESELECTOR_LIST mode</b>
21177     *
21178     * @param obj The file selector object
21179     * @param expand @c EINA_TRUE to enable tree view, @c EINA_FALSE to
21180     * disable
21181     *
21182     * In a tree view, arrows are created on the sides of directories,
21183     * allowing them to expand in place.
21184     *
21185     * @note If it's in other mode, the changes made by this function
21186     * will only be visible when one switches back to "list" mode.
21187     *
21188     * @see elm_fileselector_expandable_get()
21189     *
21190     * @ingroup Fileselector
21191     */
21192    EAPI void                  elm_fileselector_expandable_set(Evas_Object *obj, Eina_Bool expand) EINA_ARG_NONNULL(1);
21193
21194    /**
21195     * Get whether tree view is enabled for the given file selector
21196     * widget
21197     *
21198     * @param obj The file selector object
21199     * @return @c EINA_TRUE if @p obj is in tree view, @c EINA_FALSE
21200     * otherwise (and or errors)
21201     *
21202     * @see elm_fileselector_expandable_set() for more details
21203     *
21204     * @ingroup Fileselector
21205     */
21206    EAPI Eina_Bool             elm_fileselector_expandable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21207
21208    /**
21209     * Set, programmatically, the @b directory that a given file
21210     * selector widget will display contents from
21211     *
21212     * @param obj The file selector object
21213     * @param path The path to display in @p obj
21214     *
21215     * This will change the @b directory that @p obj is displaying. It
21216     * will also clear the text entry area on the @p obj object, which
21217     * displays select files' names.
21218     *
21219     * @see elm_fileselector_path_get()
21220     *
21221     * @ingroup Fileselector
21222     */
21223    EAPI void                  elm_fileselector_path_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
21224
21225    /**
21226     * Get the parent directory's path that a given file selector
21227     * widget is displaying
21228     *
21229     * @param obj The file selector object
21230     * @return The (full) path of the directory the file selector is
21231     * displaying, a @b stringshared string
21232     *
21233     * @see elm_fileselector_path_set()
21234     *
21235     * @ingroup Fileselector
21236     */
21237    EAPI const char           *elm_fileselector_path_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21238
21239    /**
21240     * Set, programmatically, the currently selected file/directory in
21241     * the given file selector widget
21242     *
21243     * @param obj The file selector object
21244     * @param path The (full) path to a file or directory
21245     * @return @c EINA_TRUE on success, @c EINA_FALSE on failure. The
21246     * latter case occurs if the directory or file pointed to do not
21247     * exist.
21248     *
21249     * @see elm_fileselector_selected_get()
21250     *
21251     * @ingroup Fileselector
21252     */
21253    EAPI Eina_Bool             elm_fileselector_selected_set(Evas_Object *obj, const char *path) EINA_ARG_NONNULL(1);
21254
21255    /**
21256     * Get the currently selected item's (full) path, in the given file
21257     * selector widget
21258     *
21259     * @param obj The file selector object
21260     * @return The absolute path of the selected item, a @b
21261     * stringshared string
21262     *
21263     * @note Custom editions on @p obj object's text entry, if made,
21264     * will appear on the return string of this function, naturally.
21265     *
21266     * @see elm_fileselector_selected_set() for more details
21267     *
21268     * @ingroup Fileselector
21269     */
21270    EAPI const char           *elm_fileselector_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21271
21272    /**
21273     * Set the mode in which a given file selector widget will display
21274     * (layout) file system entries in its view
21275     *
21276     * @param obj The file selector object
21277     * @param mode The mode of the fileselector, being it one of
21278     * #ELM_FILESELECTOR_LIST (default) or #ELM_FILESELECTOR_GRID. The
21279     * first one, naturally, will display the files in a list. The
21280     * latter will make the widget to display its entries in a grid
21281     * form.
21282     *
21283     * @note By using elm_fileselector_expandable_set(), the user may
21284     * trigger a tree view for that list.
21285     *
21286     * @note If Elementary is built with support of the Ethumb
21287     * thumbnailing library, the second form of view will display
21288     * preview thumbnails of files which it supports. You must have
21289     * elm_need_ethumb() called in your Elementary for thumbnailing to
21290     * work, though.
21291     *
21292     * @see elm_fileselector_expandable_set().
21293     * @see elm_fileselector_mode_get().
21294     *
21295     * @ingroup Fileselector
21296     */
21297    EAPI void                  elm_fileselector_mode_set(Evas_Object *obj, Elm_Fileselector_Mode mode) EINA_ARG_NONNULL(1);
21298
21299    /**
21300     * Get the mode in which a given file selector widget is displaying
21301     * (layouting) file system entries in its view
21302     *
21303     * @param obj The fileselector object
21304     * @return The mode in which the fileselector is at
21305     *
21306     * @see elm_fileselector_mode_set() for more details
21307     *
21308     * @ingroup Fileselector
21309     */
21310    EAPI Elm_Fileselector_Mode elm_fileselector_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21311
21312    /**
21313     * @}
21314     */
21315
21316    /**
21317     * @defgroup Progressbar Progress bar
21318     *
21319     * The progress bar is a widget for visually representing the
21320     * progress status of a given job/task.
21321     *
21322     * A progress bar may be horizontal or vertical. It may display an
21323     * icon besides it, as well as primary and @b units labels. The
21324     * former is meant to label the widget as a whole, while the
21325     * latter, which is formatted with floating point values (and thus
21326     * accepts a <c>printf</c>-style format string, like <c>"%1.2f
21327     * units"</c>), is meant to label the widget's <b>progress
21328     * value</b>. Label, icon and unit strings/objects are @b optional
21329     * for progress bars.
21330     *
21331     * A progress bar may be @b inverted, in which state it gets its
21332     * values inverted, with high values being on the left or top and
21333     * low values on the right or bottom, as opposed to normally have
21334     * the low values on the former and high values on the latter,
21335     * respectively, for horizontal and vertical modes.
21336     *
21337     * The @b span of the progress, as set by
21338     * elm_progressbar_span_size_set(), is its length (horizontally or
21339     * vertically), unless one puts size hints on the widget to expand
21340     * on desired directions, by any container. That length will be
21341     * scaled by the object or applications scaling factor. At any
21342     * point code can query the progress bar for its value with
21343     * elm_progressbar_value_get().
21344     *
21345     * Available widget styles for progress bars:
21346     * - @c "default"
21347     * - @c "wheel" (simple style, no text, no progression, only
21348     *      "pulse" effect is available)
21349     *
21350     * Default contents parts of the progressbar widget that you can use for are:
21351     * @li "icon" - A icon of the progressbar
21352     * 
21353     * Here is an example on its usage:
21354     * @li @ref progressbar_example
21355     */
21356
21357    /**
21358     * Add a new progress bar widget to the given parent Elementary
21359     * (container) object
21360     *
21361     * @param parent The parent object
21362     * @return a new progress bar widget handle or @c NULL, on errors
21363     *
21364     * This function inserts a new progress bar widget on the canvas.
21365     *
21366     * @ingroup Progressbar
21367     */
21368    EAPI Evas_Object *elm_progressbar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21369
21370    /**
21371     * Set whether a given progress bar widget is at "pulsing mode" or
21372     * not.
21373     *
21374     * @param obj The progress bar object
21375     * @param pulse @c EINA_TRUE to put @p obj in pulsing mode,
21376     * @c EINA_FALSE to put it back to its default one
21377     *
21378     * By default, progress bars will display values from the low to
21379     * high value boundaries. There are, though, contexts in which the
21380     * state of progression of a given task is @b unknown.  For those,
21381     * one can set a progress bar widget to a "pulsing state", to give
21382     * the user an idea that some computation is being held, but
21383     * without exact progress values. In the default theme it will
21384     * animate its bar with the contents filling in constantly and back
21385     * to non-filled, in a loop. To start and stop this pulsing
21386     * animation, one has to explicitly call elm_progressbar_pulse().
21387     *
21388     * @see elm_progressbar_pulse_get()
21389     * @see elm_progressbar_pulse()
21390     *
21391     * @ingroup Progressbar
21392     */
21393    EAPI void         elm_progressbar_pulse_set(Evas_Object *obj, Eina_Bool pulse) EINA_ARG_NONNULL(1);
21394
21395    /**
21396     * Get whether a given progress bar widget is at "pulsing mode" or
21397     * not.
21398     *
21399     * @param obj The progress bar object
21400     * @return @c EINA_TRUE, if @p obj is in pulsing mode, @c EINA_FALSE
21401     * if it's in the default one (and on errors)
21402     *
21403     * @ingroup Progressbar
21404     */
21405    EAPI Eina_Bool    elm_progressbar_pulse_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21406
21407    /**
21408     * Start/stop a given progress bar "pulsing" animation, if its
21409     * under that mode
21410     *
21411     * @param obj The progress bar object
21412     * @param state @c EINA_TRUE, to @b start the pulsing animation,
21413     * @c EINA_FALSE to @b stop it
21414     *
21415     * @note This call won't do anything if @p obj is not under "pulsing mode".
21416     *
21417     * @see elm_progressbar_pulse_set() for more details.
21418     *
21419     * @ingroup Progressbar
21420     */
21421    EAPI void         elm_progressbar_pulse(Evas_Object *obj, Eina_Bool state) EINA_ARG_NONNULL(1);
21422
21423    /**
21424     * Set the progress value (in percentage) on a given progress bar
21425     * widget
21426     *
21427     * @param obj The progress bar object
21428     * @param val The progress value (@b must be between @c 0.0 and @c
21429     * 1.0)
21430     *
21431     * Use this call to set progress bar levels.
21432     *
21433     * @note If you passes a value out of the specified range for @p
21434     * val, it will be interpreted as the @b closest of the @b boundary
21435     * values in the range.
21436     *
21437     * @ingroup Progressbar
21438     */
21439    EAPI void         elm_progressbar_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
21440
21441    /**
21442     * Get the progress value (in percentage) on a given progress bar
21443     * widget
21444     *
21445     * @param obj The progress bar object
21446     * @return The value of the progressbar
21447     *
21448     * @see elm_progressbar_value_set() for more details
21449     *
21450     * @ingroup Progressbar
21451     */
21452    EAPI double       elm_progressbar_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21453
21454    /**
21455     * Set the label of a given progress bar widget
21456     *
21457     * @param obj The progress bar object
21458     * @param label The text label string, in UTF-8
21459     *
21460     * @ingroup Progressbar
21461     * @deprecated use elm_object_text_set() instead.
21462     */
21463    EINA_DEPRECATED EAPI void         elm_progressbar_label_set(Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
21464
21465    /**
21466     * Get the label of a given progress bar widget
21467     *
21468     * @param obj The progressbar object
21469     * @return The text label string, in UTF-8
21470     *
21471     * @ingroup Progressbar
21472     * @deprecated use elm_object_text_set() instead.
21473     */
21474    EINA_DEPRECATED EAPI const char  *elm_progressbar_label_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21475
21476    /**
21477     * Set the icon object of a given progress bar widget
21478     *
21479     * @param obj The progress bar object
21480     * @param icon The icon object
21481     *
21482     * Use this call to decorate @p obj with an icon next to it.
21483     *
21484     * @note Once the icon object is set, a previously set one will be
21485     * deleted. If you want to keep that old content object, use the
21486     * elm_progressbar_icon_unset() function.
21487     *
21488     * @see elm_progressbar_icon_get()
21489     * @deprecated use elm_object_part_content_set() instead.
21490     *
21491     * @ingroup Progressbar
21492     */
21493    WILL_DEPRECATE  EAPI void         elm_progressbar_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
21494
21495    /**
21496     * Retrieve the icon object set for a given progress bar widget
21497     *
21498     * @param obj The progress bar object
21499     * @return The icon object's handle, if @p obj had one set, or @c NULL,
21500     * otherwise (and on errors)
21501     *
21502     * @see elm_progressbar_icon_set() for more details
21503     * @deprecated use elm_object_part_content_get() instead.
21504     *
21505     * @ingroup Progressbar
21506     */
21507    WILL_DEPRECATE  EAPI Evas_Object *elm_progressbar_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21508
21509    /**
21510     * Unset an icon set on a given progress bar widget
21511     *
21512     * @param obj The progress bar object
21513     * @return The icon object that was being used, if any was set, or
21514     * @c NULL, otherwise (and on errors)
21515     *
21516     * This call will unparent and return the icon object which was set
21517     * for this widget, previously, on success.
21518     *
21519     * @see elm_progressbar_icon_set() for more details
21520     * @deprecated use elm_object_part_content_unset() instead.
21521     *
21522     * @ingroup Progressbar
21523     */
21524    WILL_DEPRECATE  EAPI Evas_Object *elm_progressbar_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
21525
21526    /**
21527     * Set the (exact) length of the bar region of a given progress bar
21528     * widget
21529     *
21530     * @param obj The progress bar object
21531     * @param size The length of the progress bar's bar region
21532     *
21533     * This sets the minimum width (when in horizontal mode) or height
21534     * (when in vertical mode) of the actual bar area of the progress
21535     * bar @p obj. This in turn affects the object's minimum size. Use
21536     * this when you're not setting other size hints expanding on the
21537     * given direction (like weight and alignment hints) and you would
21538     * like it to have a specific size.
21539     *
21540     * @note Icon, label and unit text around @p obj will require their
21541     * own space, which will make @p obj to require more the @p size,
21542     * actually.
21543     *
21544     * @see elm_progressbar_span_size_get()
21545     *
21546     * @ingroup Progressbar
21547     */
21548    EAPI void         elm_progressbar_span_size_set(Evas_Object *obj, Evas_Coord size) EINA_ARG_NONNULL(1);
21549
21550    /**
21551     * Get the length set for the bar region of a given progress bar
21552     * widget
21553     *
21554     * @param obj The progress bar object
21555     * @return The length of the progress bar's bar region
21556     *
21557     * If that size was not set previously, with
21558     * elm_progressbar_span_size_set(), this call will return @c 0.
21559     *
21560     * @ingroup Progressbar
21561     */
21562    EAPI Evas_Coord   elm_progressbar_span_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21563
21564    /**
21565     * Set the format string for a given progress bar widget's units
21566     * label
21567     *
21568     * @param obj The progress bar object
21569     * @param format The format string for @p obj's units label
21570     *
21571     * If @c NULL is passed on @p format, it will make @p obj's units
21572     * area to be hidden completely. If not, it'll set the <b>format
21573     * string</b> for the units label's @b text. The units label is
21574     * provided a floating point value, so the units text is up display
21575     * at most one floating point falue. Note that the units label is
21576     * optional. Use a format string such as "%1.2f meters" for
21577     * example.
21578     *
21579     * @note The default format string for a progress bar is an integer
21580     * percentage, as in @c "%.0f %%".
21581     *
21582     * @see elm_progressbar_unit_format_get()
21583     *
21584     * @ingroup Progressbar
21585     */
21586    EAPI void         elm_progressbar_unit_format_set(Evas_Object *obj, const char *format) EINA_ARG_NONNULL(1);
21587
21588    /**
21589     * Retrieve the format string set for a given progress bar widget's
21590     * units label
21591     *
21592     * @param obj The progress bar object
21593     * @return The format set string for @p obj's units label or
21594     * @c NULL, if none was set (and on errors)
21595     *
21596     * @see elm_progressbar_unit_format_set() for more details
21597     *
21598     * @ingroup Progressbar
21599     */
21600    EAPI const char  *elm_progressbar_unit_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21601
21602    /**
21603     * Set the orientation of a given progress bar widget
21604     *
21605     * @param obj The progress bar object
21606     * @param horizontal Use @c EINA_TRUE to make @p obj to be
21607     * @b horizontal, @c EINA_FALSE to make it @b vertical
21608     *
21609     * Use this function to change how your progress bar is to be
21610     * disposed: vertically or horizontally.
21611     *
21612     * @see elm_progressbar_horizontal_get()
21613     *
21614     * @ingroup Progressbar
21615     */
21616    EAPI void         elm_progressbar_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
21617
21618    /**
21619     * Retrieve the orientation of a given progress bar widget
21620     *
21621     * @param obj The progress bar object
21622     * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
21623     * @c EINA_FALSE if it's @b vertical (and on errors)
21624     *
21625     * @see elm_progressbar_horizontal_set() for more details
21626     *
21627     * @ingroup Progressbar
21628     */
21629    EAPI Eina_Bool    elm_progressbar_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21630
21631    /**
21632     * Invert a given progress bar widget's displaying values order
21633     *
21634     * @param obj The progress bar object
21635     * @param inverted Use @c EINA_TRUE to make @p obj inverted,
21636     * @c EINA_FALSE to bring it back to default, non-inverted values.
21637     *
21638     * A progress bar may be @b inverted, in which state it gets its
21639     * values inverted, with high values being on the left or top and
21640     * low values on the right or bottom, as opposed to normally have
21641     * the low values on the former and high values on the latter,
21642     * respectively, for horizontal and vertical modes.
21643     *
21644     * @see elm_progressbar_inverted_get()
21645     *
21646     * @ingroup Progressbar
21647     */
21648    EAPI void         elm_progressbar_inverted_set(Evas_Object *obj, Eina_Bool inverted) EINA_ARG_NONNULL(1);
21649
21650    /**
21651     * Get whether a given progress bar widget's displaying values are
21652     * inverted or not
21653     *
21654     * @param obj The progress bar object
21655     * @return @c EINA_TRUE, if @p obj has inverted values,
21656     * @c EINA_FALSE otherwise (and on errors)
21657     *
21658     * @see elm_progressbar_inverted_set() for more details
21659     *
21660     * @ingroup Progressbar
21661     */
21662    EAPI Eina_Bool    elm_progressbar_inverted_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21663
21664    /**
21665     * @defgroup Separator Separator
21666     *
21667     * @brief Separator is a very thin object used to separate other objects.
21668     *
21669     * A separator can be vertical or horizontal.
21670     *
21671     * @ref tutorial_separator is a good example of how to use a separator.
21672     * @{
21673     */
21674    /**
21675     * @brief Add a separator object to @p parent
21676     *
21677     * @param parent The parent object
21678     *
21679     * @return The separator object, or NULL upon failure
21680     */
21681    EAPI Evas_Object *elm_separator_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21682    /**
21683     * @brief Set the horizontal mode of a separator object
21684     *
21685     * @param obj The separator object
21686     * @param horizontal If true, the separator is horizontal
21687     */
21688    EAPI void         elm_separator_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
21689    /**
21690     * @brief Get the horizontal mode of a separator object
21691     *
21692     * @param obj The separator object
21693     * @return If true, the separator is horizontal
21694     *
21695     * @see elm_separator_horizontal_set()
21696     */
21697    EAPI Eina_Bool    elm_separator_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21698    /**
21699     * @}
21700     */
21701
21702    /**
21703     * @defgroup Spinner Spinner
21704     * @ingroup Elementary
21705     *
21706     * @image html img/widget/spinner/preview-00.png
21707     * @image latex img/widget/spinner/preview-00.eps
21708     *
21709     * A spinner is a widget which allows the user to increase or decrease
21710     * numeric values using arrow buttons, or edit values directly, clicking
21711     * over it and typing the new value.
21712     *
21713     * By default the spinner will not wrap and has a label
21714     * of "%.0f" (just showing the integer value of the double).
21715     *
21716     * A spinner has a label that is formatted with floating
21717     * point values and thus accepts a printf-style format string, like
21718     * “%1.2f units”.
21719     *
21720     * It also allows specific values to be replaced by pre-defined labels.
21721     *
21722     * Smart callbacks one can register to:
21723     *
21724     * - "changed" - Whenever the spinner value is changed.
21725     * - "delay,changed" - A short time after the value is changed by the user.
21726     *    This will be called only when the user stops dragging for a very short
21727     *    period or when they release their finger/mouse, so it avoids possibly
21728     *    expensive reactions to the value change.
21729     *
21730     * Available styles for it:
21731     * - @c "default";
21732     * - @c "vertical": up/down buttons at the right side and text left aligned.
21733     *
21734     * Here is an example on its usage:
21735     * @ref spinner_example
21736     */
21737
21738    /**
21739     * @addtogroup Spinner
21740     * @{
21741     */
21742
21743    /**
21744     * Add a new spinner widget to the given parent Elementary
21745     * (container) object.
21746     *
21747     * @param parent The parent object.
21748     * @return a new spinner widget handle or @c NULL, on errors.
21749     *
21750     * This function inserts a new spinner widget on the canvas.
21751     *
21752     * @ingroup Spinner
21753     *
21754     */
21755    EAPI Evas_Object *elm_spinner_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
21756
21757    /**
21758     * Set the format string of the displayed label.
21759     *
21760     * @param obj The spinner object.
21761     * @param fmt The format string for the label display.
21762     *
21763     * If @c NULL, this sets the format to "%.0f". If not it sets the format
21764     * string for the label text. The label text is provided a floating point
21765     * value, so the label text can display up to 1 floating point value.
21766     * Note that this is optional.
21767     *
21768     * Use a format string such as "%1.2f meters" for example, and it will
21769     * display values like: "3.14 meters" for a value equal to 3.14159.
21770     *
21771     * Default is "%0.f".
21772     *
21773     * @see elm_spinner_label_format_get()
21774     *
21775     * @ingroup Spinner
21776     */
21777    EAPI void         elm_spinner_label_format_set(Evas_Object *obj, const char *fmt) EINA_ARG_NONNULL(1);
21778
21779    /**
21780     * Get the label format of the spinner.
21781     *
21782     * @param obj The spinner object.
21783     * @return The text label format string in UTF-8.
21784     *
21785     * @see elm_spinner_label_format_set() for details.
21786     *
21787     * @ingroup Spinner
21788     */
21789    EAPI const char  *elm_spinner_label_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21790
21791    /**
21792     * Set the minimum and maximum values for the spinner.
21793     *
21794     * @param obj The spinner object.
21795     * @param min The minimum value.
21796     * @param max The maximum value.
21797     *
21798     * Define the allowed range of values to be selected by the user.
21799     *
21800     * If actual value is less than @p min, it will be updated to @p min. If it
21801     * is bigger then @p max, will be updated to @p max. Actual value can be
21802     * get with elm_spinner_value_get().
21803     *
21804     * By default, min is equal to 0, and max is equal to 100.
21805     *
21806     * @warning Maximum must be greater than minimum.
21807     *
21808     * @see elm_spinner_min_max_get()
21809     *
21810     * @ingroup Spinner
21811     */
21812    EAPI void         elm_spinner_min_max_set(Evas_Object *obj, double min, double max) EINA_ARG_NONNULL(1);
21813
21814    /**
21815     * Get the minimum and maximum values of the spinner.
21816     *
21817     * @param obj The spinner object.
21818     * @param min Pointer where to store the minimum value.
21819     * @param max Pointer where to store the maximum value.
21820     *
21821     * @note If only one value is needed, the other pointer can be passed
21822     * as @c NULL.
21823     *
21824     * @see elm_spinner_min_max_set() for details.
21825     *
21826     * @ingroup Spinner
21827     */
21828    EAPI void         elm_spinner_min_max_get(const Evas_Object *obj, double *min, double *max) EINA_ARG_NONNULL(1);
21829
21830    /**
21831     * Set the step used to increment or decrement the spinner value.
21832     *
21833     * @param obj The spinner object.
21834     * @param step The step value.
21835     *
21836     * This value will be incremented or decremented to the displayed value.
21837     * It will be incremented while the user keep right or top arrow pressed,
21838     * and will be decremented while the user keep left or bottom arrow pressed.
21839     *
21840     * The interval to increment / decrement can be set with
21841     * elm_spinner_interval_set().
21842     *
21843     * By default step value is equal to 1.
21844     *
21845     * @see elm_spinner_step_get()
21846     *
21847     * @ingroup Spinner
21848     */
21849    EAPI void         elm_spinner_step_set(Evas_Object *obj, double step) EINA_ARG_NONNULL(1);
21850
21851    /**
21852     * Get the step used to increment or decrement the spinner value.
21853     *
21854     * @param obj The spinner object.
21855     * @return The step value.
21856     *
21857     * @see elm_spinner_step_get() for more details.
21858     *
21859     * @ingroup Spinner
21860     */
21861    EAPI double       elm_spinner_step_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21862
21863    /**
21864     * Set the value the spinner displays.
21865     *
21866     * @param obj The spinner object.
21867     * @param val The value to be displayed.
21868     *
21869     * Value will be presented on the label following format specified with
21870     * elm_spinner_format_set().
21871     *
21872     * @warning The value must to be between min and max values. This values
21873     * are set by elm_spinner_min_max_set().
21874     *
21875     * @see elm_spinner_value_get().
21876     * @see elm_spinner_format_set().
21877     * @see elm_spinner_min_max_set().
21878     *
21879     * @ingroup Spinner
21880     */
21881    EAPI void         elm_spinner_value_set(Evas_Object *obj, double val) EINA_ARG_NONNULL(1);
21882
21883    /**
21884     * Get the value displayed by the spinner.
21885     *
21886     * @param obj The spinner object.
21887     * @return The value displayed.
21888     *
21889     * @see elm_spinner_value_set() for details.
21890     *
21891     * @ingroup Spinner
21892     */
21893    EAPI double       elm_spinner_value_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21894
21895    /**
21896     * Set whether the spinner should wrap when it reaches its
21897     * minimum or maximum value.
21898     *
21899     * @param obj The spinner object.
21900     * @param wrap @c EINA_TRUE to enable wrap or @c EINA_FALSE to
21901     * disable it.
21902     *
21903     * Disabled by default. If disabled, when the user tries to increment the
21904     * value,
21905     * but displayed value plus step value is bigger than maximum value,
21906     * the spinner
21907     * won't allow it. The same happens when the user tries to decrement it,
21908     * but the value less step is less than minimum value.
21909     *
21910     * When wrap is enabled, in such situations it will allow these changes,
21911     * but will get the value that would be less than minimum and subtracts
21912     * from maximum. Or add the value that would be more than maximum to
21913     * the minimum.
21914     *
21915     * E.g.:
21916     * @li min value = 10
21917     * @li max value = 50
21918     * @li step value = 20
21919     * @li displayed value = 20
21920     *
21921     * When the user decrement value (using left or bottom arrow), it will
21922     * displays @c 40, because max - (min - (displayed - step)) is
21923     * @c 50 - (@c 10 - (@c 20 - @c 20)) = @c 40.
21924     *
21925     * @see elm_spinner_wrap_get().
21926     *
21927     * @ingroup Spinner
21928     */
21929    EAPI void         elm_spinner_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
21930
21931    /**
21932     * Get whether the spinner should wrap when it reaches its
21933     * minimum or maximum value.
21934     *
21935     * @param obj The spinner object
21936     * @return @c EINA_TRUE means wrap is enabled. @c EINA_FALSE indicates
21937     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
21938     *
21939     * @see elm_spinner_wrap_set() for details.
21940     *
21941     * @ingroup Spinner
21942     */
21943    EAPI Eina_Bool    elm_spinner_wrap_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21944
21945    /**
21946     * Set whether the spinner can be directly edited by the user or not.
21947     *
21948     * @param obj The spinner object.
21949     * @param editable @c EINA_TRUE to allow users to edit it or @c EINA_FALSE to
21950     * don't allow users to edit it directly.
21951     *
21952     * Spinner objects can have edition @b disabled, in which state they will
21953     * be changed only by arrows.
21954     * Useful for contexts
21955     * where you don't want your users to interact with it writting the value.
21956     * Specially
21957     * when using special values, the user can see real value instead
21958     * of special label on edition.
21959     *
21960     * It's enabled by default.
21961     *
21962     * @see elm_spinner_editable_get()
21963     *
21964     * @ingroup Spinner
21965     */
21966    EAPI void         elm_spinner_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
21967
21968    /**
21969     * Get whether the spinner can be directly edited by the user or not.
21970     *
21971     * @param obj The spinner object.
21972     * @return @c EINA_TRUE means edition is enabled. @c EINA_FALSE indicates
21973     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
21974     *
21975     * @see elm_spinner_editable_set() for details.
21976     *
21977     * @ingroup Spinner
21978     */
21979    EAPI Eina_Bool    elm_spinner_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
21980
21981    /**
21982     * Set a special string to display in the place of the numerical value.
21983     *
21984     * @param obj The spinner object.
21985     * @param value The value to be replaced.
21986     * @param label The label to be used.
21987     *
21988     * It's useful for cases when a user should select an item that is
21989     * better indicated by a label than a value. For example, weekdays or months.
21990     *
21991     * E.g.:
21992     * @code
21993     * sp = elm_spinner_add(win);
21994     * elm_spinner_min_max_set(sp, 1, 3);
21995     * elm_spinner_special_value_add(sp, 1, "January");
21996     * elm_spinner_special_value_add(sp, 2, "February");
21997     * elm_spinner_special_value_add(sp, 3, "March");
21998     * evas_object_show(sp);
21999     * @endcode
22000     *
22001     * @ingroup Spinner
22002     */
22003    EAPI void         elm_spinner_special_value_add(Evas_Object *obj, double value, const char *label) EINA_ARG_NONNULL(1);
22004
22005    /**
22006     * Set the interval on time updates for an user mouse button hold
22007     * on spinner widgets' arrows.
22008     *
22009     * @param obj The spinner object.
22010     * @param interval The (first) interval value in seconds.
22011     *
22012     * This interval value is @b decreased while the user holds the
22013     * mouse pointer either incrementing or decrementing spinner's value.
22014     *
22015     * This helps the user to get to a given value distant from the
22016     * current one easier/faster, as it will start to change quicker and
22017     * quicker on mouse button holds.
22018     *
22019     * The calculation for the next change interval value, starting from
22020     * the one set with this call, is the previous interval divided by
22021     * @c 1.05, so it decreases a little bit.
22022     *
22023     * The default starting interval value for automatic changes is
22024     * @c 0.85 seconds.
22025     *
22026     * @see elm_spinner_interval_get()
22027     *
22028     * @ingroup Spinner
22029     */
22030    EAPI void         elm_spinner_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
22031
22032    /**
22033     * Get the interval on time updates for an user mouse button hold
22034     * on spinner widgets' arrows.
22035     *
22036     * @param obj The spinner object.
22037     * @return The (first) interval value, in seconds, set on it.
22038     *
22039     * @see elm_spinner_interval_set() for more details.
22040     *
22041     * @ingroup Spinner
22042     */
22043    EAPI double       elm_spinner_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22044
22045    /**
22046     * @}
22047     */
22048
22049    /**
22050     * @defgroup Index Index
22051     *
22052     * @image html img/widget/index/preview-00.png
22053     * @image latex img/widget/index/preview-00.eps
22054     *
22055     * An index widget gives you an index for fast access to whichever
22056     * group of other UI items one might have. It's a list of text
22057     * items (usually letters, for alphabetically ordered access).
22058     *
22059     * Index widgets are by default hidden and just appear when the
22060     * user clicks over it's reserved area in the canvas. In its
22061     * default theme, it's an area one @ref Fingers "finger" wide on
22062     * the right side of the index widget's container.
22063     *
22064     * When items on the index are selected, smart callbacks get
22065     * called, so that its user can make other container objects to
22066     * show a given area or child object depending on the index item
22067     * selected. You'd probably be using an index together with @ref
22068     * List "lists", @ref Genlist "generic lists" or @ref Gengrid
22069     * "general grids".
22070     *
22071     * Smart events one  can add callbacks for are:
22072     * - @c "changed" - When the selected index item changes. @c
22073     *      event_info is the selected item's data pointer.
22074     * - @c "delay,changed" - When the selected index item changes, but
22075     *      after a small idling period. @c event_info is the selected
22076     *      item's data pointer.
22077     * - @c "selected" - When the user releases a mouse button and
22078     *      selects an item. @c event_info is the selected item's data
22079     *      pointer.
22080     * - @c "level,up" - when the user moves a finger from the first
22081     *      level to the second level
22082     * - @c "level,down" - when the user moves a finger from the second
22083     *      level to the first level
22084     *
22085     * The @c "delay,changed" event is so that it'll wait a small time
22086     * before actually reporting those events and, moreover, just the
22087     * last event happening on those time frames will actually be
22088     * reported.
22089     *
22090     * Here are some examples on its usage:
22091     * @li @ref index_example_01
22092     * @li @ref index_example_02
22093     */
22094
22095    /**
22096     * @addtogroup Index
22097     * @{
22098     */
22099
22100    typedef struct _Elm_Index_Item Elm_Index_Item; /**< Opaque handle for items of Elementary index widgets */
22101
22102    /**
22103     * Add a new index widget to the given parent Elementary
22104     * (container) object
22105     *
22106     * @param parent The parent object
22107     * @return a new index widget handle or @c NULL, on errors
22108     *
22109     * This function inserts a new index widget on the canvas.
22110     *
22111     * @ingroup Index
22112     */
22113    EAPI Evas_Object    *elm_index_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22114
22115    /**
22116     * Set whether a given index widget is or not visible,
22117     * programatically.
22118     *
22119     * @param obj The index object
22120     * @param active @c EINA_TRUE to show it, @c EINA_FALSE to hide it
22121     *
22122     * Not to be confused with visible as in @c evas_object_show() --
22123     * visible with regard to the widget's auto hiding feature.
22124     *
22125     * @see elm_index_active_get()
22126     *
22127     * @ingroup Index
22128     */
22129    EAPI void            elm_index_active_set(Evas_Object *obj, Eina_Bool active) EINA_ARG_NONNULL(1);
22130
22131    /**
22132     * Get whether a given index widget is currently visible or not.
22133     *
22134     * @param obj The index object
22135     * @return @c EINA_TRUE, if it's shown, @c EINA_FALSE otherwise
22136     *
22137     * @see elm_index_active_set() for more details
22138     *
22139     * @ingroup Index
22140     */
22141    EAPI Eina_Bool       elm_index_active_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22142
22143    /**
22144     * Set the items level for a given index widget.
22145     *
22146     * @param obj The index object.
22147     * @param level @c 0 or @c 1, the currently implemented levels.
22148     *
22149     * @see elm_index_item_level_get()
22150     *
22151     * @ingroup Index
22152     */
22153    EAPI void            elm_index_item_level_set(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
22154
22155    /**
22156     * Get the items level set for a given index widget.
22157     *
22158     * @param obj The index object.
22159     * @return @c 0 or @c 1, which are the levels @p obj might be at.
22160     *
22161     * @see elm_index_item_level_set() for more information
22162     *
22163     * @ingroup Index
22164     */
22165    EAPI int             elm_index_item_level_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22166
22167    /**
22168     * Returns the last selected item's data, for a given index widget.
22169     *
22170     * @param obj The index object.
22171     * @return The item @b data associated to the last selected item on
22172     * @p obj (or @c NULL, on errors).
22173     *
22174     * @warning The returned value is @b not an #Elm_Index_Item item
22175     * handle, but the data associated to it (see the @c item parameter
22176     * in elm_index_item_append(), as an example).
22177     *
22178     * @ingroup Index
22179     */
22180    EAPI void           *elm_index_item_selected_get(const Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
22181
22182    /**
22183     * Append a new item on a given index widget.
22184     *
22185     * @param obj The index object.
22186     * @param letter Letter under which the item should be indexed
22187     * @param item The item data to set for the index's item
22188     *
22189     * Despite the most common usage of the @p letter argument is for
22190     * single char strings, one could use arbitrary strings as index
22191     * entries.
22192     *
22193     * @c item will be the pointer returned back on @c "changed", @c
22194     * "delay,changed" and @c "selected" smart events.
22195     *
22196     * @ingroup Index
22197     */
22198    EAPI void            elm_index_item_append(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
22199
22200    /**
22201     * Prepend a new item on a given index widget.
22202     *
22203     * @param obj The index object.
22204     * @param letter Letter under which the item should be indexed
22205     * @param item The item data to set for the index's item
22206     *
22207     * Despite the most common usage of the @p letter argument is for
22208     * single char strings, one could use arbitrary strings as index
22209     * entries.
22210     *
22211     * @c item will be the pointer returned back on @c "changed", @c
22212     * "delay,changed" and @c "selected" smart events.
22213     *
22214     * @ingroup Index
22215     */
22216    EAPI void            elm_index_item_prepend(Evas_Object *obj, const char *letter, const void *item) EINA_ARG_NONNULL(1);
22217
22218    /**
22219     * Append a new item, on a given index widget, <b>after the item
22220     * having @p relative as data</b>.
22221     *
22222     * @param obj The index object.
22223     * @param letter Letter under which the item should be indexed
22224     * @param item The item data to set for the index's item
22225     * @param relative The item data of the index item to be the
22226     * predecessor of this new one
22227     *
22228     * Despite the most common usage of the @p letter argument is for
22229     * single char strings, one could use arbitrary strings as index
22230     * entries.
22231     *
22232     * @c item will be the pointer returned back on @c "changed", @c
22233     * "delay,changed" and @c "selected" smart events.
22234     *
22235     * @note If @p relative is @c NULL or if it's not found to be data
22236     * set on any previous item on @p obj, this function will behave as
22237     * elm_index_item_append().
22238     *
22239     * @ingroup Index
22240     */
22241    EAPI void            elm_index_item_append_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
22242
22243    /**
22244     * Prepend a new item, on a given index widget, <b>after the item
22245     * having @p relative as data</b>.
22246     *
22247     * @param obj The index object.
22248     * @param letter Letter under which the item should be indexed
22249     * @param item The item data to set for the index's item
22250     * @param relative The item data of the index item to be the
22251     * successor of this new one
22252     *
22253     * Despite the most common usage of the @p letter argument is for
22254     * single char strings, one could use arbitrary strings as index
22255     * entries.
22256     *
22257     * @c item will be the pointer returned back on @c "changed", @c
22258     * "delay,changed" and @c "selected" smart events.
22259     *
22260     * @note If @p relative is @c NULL or if it's not found to be data
22261     * set on any previous item on @p obj, this function will behave as
22262     * elm_index_item_prepend().
22263     *
22264     * @ingroup Index
22265     */
22266    EAPI void            elm_index_item_prepend_relative(Evas_Object *obj, const char *letter, const void *item, const void *relative) EINA_ARG_NONNULL(1);
22267
22268    /**
22269     * Insert a new item into the given index widget, using @p cmp_func
22270     * function to sort items (by item handles).
22271     *
22272     * @param obj The index object.
22273     * @param letter Letter under which the item should be indexed
22274     * @param item The item data to set for the index's item
22275     * @param cmp_func The comparing function to be used to sort index
22276     * items <b>by #Elm_Index_Item item handles</b>
22277     * @param cmp_data_func A @b fallback function to be called for the
22278     * sorting of index items <b>by item data</b>). It will be used
22279     * when @p cmp_func returns @c 0 (equality), which means an index
22280     * item with provided item data already exists. To decide which
22281     * data item should be pointed to by the index item in question, @p
22282     * cmp_data_func will be used. If @p cmp_data_func returns a
22283     * non-negative value, the previous index item data will be
22284     * replaced by the given @p item pointer. If the previous data need
22285     * to be freed, it should be done by the @p cmp_data_func function,
22286     * because all references to it will be lost. If this function is
22287     * not provided (@c NULL is given), index items will be @b
22288     * duplicated, if @p cmp_func returns @c 0.
22289     *
22290     * Despite the most common usage of the @p letter argument is for
22291     * single char strings, one could use arbitrary strings as index
22292     * entries.
22293     *
22294     * @c item will be the pointer returned back on @c "changed", @c
22295     * "delay,changed" and @c "selected" smart events.
22296     *
22297     * @ingroup Index
22298     */
22299    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);
22300
22301    /**
22302     * Remove an item from a given index widget, <b>to be referenced by
22303     * it's data value</b>.
22304     *
22305     * @param obj The index object
22306     * @param item The item's data pointer for the item to be removed
22307     * from @p obj
22308     *
22309     * If a deletion callback is set, via elm_index_item_del_cb_set(),
22310     * that callback function will be called by this one.
22311     *
22312     * @warning The item to be removed from @p obj will be found via
22313     * its item data pointer, and not by an #Elm_Index_Item handle.
22314     *
22315     * @ingroup Index
22316     */
22317    EAPI void            elm_index_item_del(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
22318
22319    /**
22320     * Find a given index widget's item, <b>using item data</b>.
22321     *
22322     * @param obj The index object
22323     * @param item The item data pointed to by the desired index item
22324     * @return The index item handle, if found, or @c NULL otherwise
22325     *
22326     * @ingroup Index
22327     */
22328    EAPI Elm_Index_Item *elm_index_item_find(Evas_Object *obj, const void *item) EINA_ARG_NONNULL(1);
22329
22330    /**
22331     * Removes @b all items from a given index widget.
22332     *
22333     * @param obj The index object.
22334     *
22335     * If deletion callbacks are set, via elm_index_item_del_cb_set(),
22336     * that callback function will be called for each item in @p obj.
22337     *
22338     * @ingroup Index
22339     */
22340    EAPI void            elm_index_item_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
22341
22342    /**
22343     * Go to a given items level on a index widget
22344     *
22345     * @param obj The index object
22346     * @param level The index level (one of @c 0 or @c 1)
22347     *
22348     * @ingroup Index
22349     */
22350    EAPI void            elm_index_item_go(Evas_Object *obj, int level) EINA_ARG_NONNULL(1);
22351
22352    /**
22353     * Return the data associated with a given index widget item
22354     *
22355     * @param it The index widget item handle
22356     * @return The data associated with @p it
22357     *
22358     * @see elm_index_item_data_set()
22359     *
22360     * @ingroup Index
22361     */
22362    EAPI void           *elm_index_item_data_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
22363
22364    /**
22365     * Set the data associated with a given index widget item
22366     *
22367     * @param it The index widget item handle
22368     * @param data The new data pointer to set to @p it
22369     *
22370     * This sets new item data on @p it.
22371     *
22372     * @warning The old data pointer won't be touched by this function, so
22373     * the user had better to free that old data himself/herself.
22374     *
22375     * @ingroup Index
22376     */
22377    EAPI void            elm_index_item_data_set(Elm_Index_Item *it, const void *data) EINA_ARG_NONNULL(1);
22378
22379    /**
22380     * Set the function to be called when a given index widget item is freed.
22381     *
22382     * @param it The item to set the callback on
22383     * @param func The function to call on the item's deletion
22384     *
22385     * When called, @p func will have both @c data and @c event_info
22386     * arguments with the @p it item's data value and, naturally, the
22387     * @c obj argument with a handle to the parent index widget.
22388     *
22389     * @ingroup Index
22390     */
22391    EAPI void            elm_index_item_del_cb_set(Elm_Index_Item *it, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
22392
22393    /**
22394     * Get the letter (string) set on a given index widget item.
22395     *
22396     * @param it The index item handle
22397     * @return The letter string set on @p it
22398     *
22399     * @ingroup Index
22400     */
22401    EAPI const char     *elm_index_item_letter_get(const Elm_Index_Item *item) EINA_ARG_NONNULL(1);
22402
22403    /**
22404     */
22405    EAPI void            elm_index_button_image_invisible_set(Evas_Object *obj, Eina_Bool invisible) EINA_ARG_NONNULL(1);
22406
22407    /**
22408     * @}
22409     */
22410
22411    /**
22412     * @defgroup Photocam Photocam
22413     *
22414     * @image html img/widget/photocam/preview-00.png
22415     * @image latex img/widget/photocam/preview-00.eps
22416     *
22417     * This is a widget specifically for displaying high-resolution digital
22418     * camera photos giving speedy feedback (fast load), low memory footprint
22419     * and zooming and panning as well as fitting logic. It is entirely focused
22420     * on jpeg images, and takes advantage of properties of the jpeg format (via
22421     * evas loader features in the jpeg loader).
22422     *
22423     * Signals that you can add callbacks for are:
22424     * @li "clicked" - This is called when a user has clicked the photo without
22425     *                 dragging around.
22426     * @li "press" - This is called when a user has pressed down on the photo.
22427     * @li "longpressed" - This is called when a user has pressed down on the
22428     *                     photo for a long time without dragging around.
22429     * @li "clicked,double" - This is called when a user has double-clicked the
22430     *                        photo.
22431     * @li "load" - Photo load begins.
22432     * @li "loaded" - This is called when the image file load is complete for the
22433     *                first view (low resolution blurry version).
22434     * @li "load,detail" - Photo detailed data load begins.
22435     * @li "loaded,detail" - This is called when the image file load is complete
22436     *                      for the detailed image data (full resolution needed).
22437     * @li "zoom,start" - Zoom animation started.
22438     * @li "zoom,stop" - Zoom animation stopped.
22439     * @li "zoom,change" - Zoom changed when using an auto zoom mode.
22440     * @li "scroll" - the content has been scrolled (moved)
22441     * @li "scroll,anim,start" - scrolling animation has started
22442     * @li "scroll,anim,stop" - scrolling animation has stopped
22443     * @li "scroll,drag,start" - dragging the contents around has started
22444     * @li "scroll,drag,stop" - dragging the contents around has stopped
22445     *
22446     * @ref tutorial_photocam shows the API in action.
22447     * @{
22448     */
22449    /**
22450     * @brief Types of zoom available.
22451     */
22452    typedef enum _Elm_Photocam_Zoom_Mode
22453      {
22454         ELM_PHOTOCAM_ZOOM_MODE_MANUAL = 0, /**< Zoom controled normally by elm_photocam_zoom_set */
22455         ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT, /**< Zoom until photo fits in photocam */
22456         ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL, /**< Zoom until photo fills photocam */
22457         ELM_PHOTOCAM_ZOOM_MODE_LAST
22458      } Elm_Photocam_Zoom_Mode;
22459    /**
22460     * @brief Add a new Photocam object
22461     *
22462     * @param parent The parent object
22463     * @return The new object or NULL if it cannot be created
22464     */
22465    EAPI Evas_Object           *elm_photocam_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22466    /**
22467     * @brief Set the photo file to be shown
22468     *
22469     * @param obj The photocam object
22470     * @param file The photo file
22471     * @return The return error (see EVAS_LOAD_ERROR_NONE, EVAS_LOAD_ERROR_GENERIC etc.)
22472     *
22473     * This sets (and shows) the specified file (with a relative or absolute
22474     * path) and will return a load error (same error that
22475     * evas_object_image_load_error_get() will return). The image will change and
22476     * adjust its size at this point and begin a background load process for this
22477     * photo that at some time in the future will be displayed at the full
22478     * quality needed.
22479     */
22480    EAPI Evas_Load_Error        elm_photocam_file_set(Evas_Object *obj, const char *file) EINA_ARG_NONNULL(1);
22481    /**
22482     * @brief Returns the path of the current image file
22483     *
22484     * @param obj The photocam object
22485     * @return Returns the path
22486     *
22487     * @see elm_photocam_file_set()
22488     */
22489    EAPI const char            *elm_photocam_file_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22490    /**
22491     * @brief Set the zoom level of the photo
22492     *
22493     * @param obj The photocam object
22494     * @param zoom The zoom level to set
22495     *
22496     * This sets the zoom level. 1 will be 1:1 pixel for pixel. 2 will be 2:1
22497     * (that is 2x2 photo pixels will display as 1 on-screen pixel). 4:1 will be
22498     * 4x4 photo pixels as 1 screen pixel, and so on. The @p zoom parameter must
22499     * be greater than 0. It is usggested to stick to powers of 2. (1, 2, 4, 8,
22500     * 16, 32, etc.).
22501     */
22502    EAPI void                   elm_photocam_zoom_set(Evas_Object *obj, double zoom) EINA_ARG_NONNULL(1);
22503    /**
22504     * @brief Get the zoom level of the photo
22505     *
22506     * @param obj The photocam object
22507     * @return The current zoom level
22508     *
22509     * This returns the current zoom level of the photocam object. Note that if
22510     * you set the fill mode to other than ELM_PHOTOCAM_ZOOM_MODE_MANUAL
22511     * (which is the default), the zoom level may be changed at any time by the
22512     * photocam object itself to account for photo size and photocam viewpoer
22513     * size.
22514     *
22515     * @see elm_photocam_zoom_set()
22516     * @see elm_photocam_zoom_mode_set()
22517     */
22518    EAPI double                 elm_photocam_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22519    /**
22520     * @brief Set the zoom mode
22521     *
22522     * @param obj The photocam object
22523     * @param mode The desired mode
22524     *
22525     * This sets the zoom mode to manual or one of several automatic levels.
22526     * Manual (ELM_PHOTOCAM_ZOOM_MODE_MANUAL) means that zoom is set manually by
22527     * elm_photocam_zoom_set() and will stay at that level until changed by code
22528     * or until zoom mode is changed. This is the default mode. The Automatic
22529     * modes will allow the photocam object to automatically adjust zoom mode
22530     * based on properties. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT) will adjust zoom so
22531     * the photo fits EXACTLY inside the scroll frame with no pixels outside this
22532     * area. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL will be similar but ensure no
22533     * pixels within the frame are left unfilled.
22534     */
22535    EAPI void                   elm_photocam_zoom_mode_set(Evas_Object *obj, Elm_Photocam_Zoom_Mode mode) EINA_ARG_NONNULL(1);
22536    /**
22537     * @brief Get the zoom mode
22538     *
22539     * @param obj The photocam object
22540     * @return The current zoom mode
22541     *
22542     * This gets the current zoom mode of the photocam object.
22543     *
22544     * @see elm_photocam_zoom_mode_set()
22545     */
22546    EAPI Elm_Photocam_Zoom_Mode elm_photocam_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22547    /**
22548     * @brief Get the current image pixel width and height
22549     *
22550     * @param obj The photocam object
22551     * @param w A pointer to the width return
22552     * @param h A pointer to the height return
22553     *
22554     * This gets the current photo pixel width and height (for the original).
22555     * The size will be returned in the integers @p w and @p h that are pointed
22556     * to.
22557     */
22558    EAPI void                   elm_photocam_image_size_get(const Evas_Object *obj, int *w, int *h) EINA_ARG_NONNULL(1);
22559    /**
22560     * @brief Get the area of the image that is currently shown
22561     *
22562     * @param obj
22563     * @param x A pointer to the X-coordinate of region
22564     * @param y A pointer to the Y-coordinate of region
22565     * @param w A pointer to the width
22566     * @param h A pointer to the height
22567     *
22568     * @see elm_photocam_image_region_show()
22569     * @see elm_photocam_image_region_bring_in()
22570     */
22571    EAPI void                   elm_photocam_region_get(const Evas_Object *obj, int *x, int *y, int *w, int *h) EINA_ARG_NONNULL(1);
22572    /**
22573     * @brief Set the viewed portion of the image
22574     *
22575     * @param obj The photocam object
22576     * @param x X-coordinate of region in image original pixels
22577     * @param y Y-coordinate of region in image original pixels
22578     * @param w Width of region in image original pixels
22579     * @param h Height of region in image original pixels
22580     *
22581     * This shows the region of the image without using animation.
22582     */
22583    EAPI void                   elm_photocam_image_region_show(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
22584    /**
22585     * @brief Bring in the viewed portion of the image
22586     *
22587     * @param obj The photocam object
22588     * @param x X-coordinate of region in image original pixels
22589     * @param y Y-coordinate of region in image original pixels
22590     * @param w Width of region in image original pixels
22591     * @param h Height of region in image original pixels
22592     *
22593     * This shows the region of the image using animation.
22594     */
22595    EAPI void                   elm_photocam_image_region_bring_in(Evas_Object *obj, int x, int y, int w, int h) EINA_ARG_NONNULL(1);
22596    /**
22597     * @brief Set the paused state for photocam
22598     *
22599     * @param obj The photocam object
22600     * @param paused The pause state to set
22601     *
22602     * This sets the paused state to on(EINA_TRUE) or off (EINA_FALSE) for
22603     * photocam. The default is off. This will stop zooming using animation on
22604     * zoom levels changes and change instantly. This will stop any existing
22605     * animations that are running.
22606     */
22607    EAPI void                   elm_photocam_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
22608    /**
22609     * @brief Get the paused state for photocam
22610     *
22611     * @param obj The photocam object
22612     * @return The current paused state
22613     *
22614     * This gets the current paused state for the photocam object.
22615     *
22616     * @see elm_photocam_paused_set()
22617     */
22618    EAPI Eina_Bool              elm_photocam_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22619    /**
22620     * @brief Get the internal low-res image used for photocam
22621     *
22622     * @param obj The photocam object
22623     * @return The internal image object handle, or NULL if none exists
22624     *
22625     * This gets the internal image object inside photocam. Do not modify it. It
22626     * is for inspection only, and hooking callbacks to. Nothing else. It may be
22627     * deleted at any time as well.
22628     */
22629    EAPI Evas_Object           *elm_photocam_internal_image_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22630    /**
22631     * @brief Set the photocam scrolling bouncing.
22632     *
22633     * @param obj The photocam object
22634     * @param h_bounce bouncing for horizontal
22635     * @param v_bounce bouncing for vertical
22636     */
22637    EAPI void                   elm_photocam_bounce_set(Evas_Object *obj,  Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
22638    /**
22639     * @brief Get the photocam scrolling bouncing.
22640     *
22641     * @param obj The photocam object
22642     * @param h_bounce bouncing for horizontal
22643     * @param v_bounce bouncing for vertical
22644     *
22645     * @see elm_photocam_bounce_set()
22646     */
22647    EAPI void                   elm_photocam_bounce_get(const Evas_Object *obj,  Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
22648    /**
22649     * @}
22650     */
22651
22652    /**
22653     * @defgroup Map Map
22654     * @ingroup Elementary
22655     *
22656     * @image html img/widget/map/preview-00.png
22657     * @image latex img/widget/map/preview-00.eps
22658     *
22659     * This is a widget specifically for displaying a map. It uses basically
22660     * OpenStreetMap provider http://www.openstreetmap.org/,
22661     * but custom providers can be added.
22662     *
22663     * It supports some basic but yet nice features:
22664     * @li zoom and scroll
22665     * @li markers with content to be displayed when user clicks over it
22666     * @li group of markers
22667     * @li routes
22668     *
22669     * Smart callbacks one can listen to:
22670     *
22671     * - "clicked" - This is called when a user has clicked the map without
22672     *   dragging around.
22673     * - "press" - This is called when a user has pressed down on the map.
22674     * - "longpressed" - This is called when a user has pressed down on the map
22675     *   for a long time without dragging around.
22676     * - "clicked,double" - This is called when a user has double-clicked
22677     *   the map.
22678     * - "load,detail" - Map detailed data load begins.
22679     * - "loaded,detail" - This is called when all currently visible parts of
22680     *   the map are loaded.
22681     * - "zoom,start" - Zoom animation started.
22682     * - "zoom,stop" - Zoom animation stopped.
22683     * - "zoom,change" - Zoom changed when using an auto zoom mode.
22684     * - "scroll" - the content has been scrolled (moved).
22685     * - "scroll,anim,start" - scrolling animation has started.
22686     * - "scroll,anim,stop" - scrolling animation has stopped.
22687     * - "scroll,drag,start" - dragging the contents around has started.
22688     * - "scroll,drag,stop" - dragging the contents around has stopped.
22689     * - "downloaded" - This is called when all currently required map images
22690     *   are downloaded.
22691     * - "route,load" - This is called when route request begins.
22692     * - "route,loaded" - This is called when route request ends.
22693     * - "name,load" - This is called when name request begins.
22694     * - "name,loaded- This is called when name request ends.
22695     *
22696     * Available style for map widget:
22697     * - @c "default"
22698     *
22699     * Available style for markers:
22700     * - @c "radio"
22701     * - @c "radio2"
22702     * - @c "empty"
22703     *
22704     * Available style for marker bubble:
22705     * - @c "default"
22706     *
22707     * List of examples:
22708     * @li @ref map_example_01
22709     * @li @ref map_example_02
22710     * @li @ref map_example_03
22711     */
22712
22713    /**
22714     * @addtogroup Map
22715     * @{
22716     */
22717
22718    /**
22719     * @enum _Elm_Map_Zoom_Mode
22720     * @typedef Elm_Map_Zoom_Mode
22721     *
22722     * Set map's zoom behavior. It can be set to manual or automatic.
22723     *
22724     * Default value is #ELM_MAP_ZOOM_MODE_MANUAL.
22725     *
22726     * Values <b> don't </b> work as bitmask, only one can be choosen.
22727     *
22728     * @note Valid sizes are 2^zoom, consequently the map may be smaller
22729     * than the scroller view.
22730     *
22731     * @see elm_map_zoom_mode_set()
22732     * @see elm_map_zoom_mode_get()
22733     *
22734     * @ingroup Map
22735     */
22736    typedef enum _Elm_Map_Zoom_Mode
22737      {
22738         ELM_MAP_ZOOM_MODE_MANUAL, /**< Zoom controled manually by elm_map_zoom_set(). It's set by default. */
22739         ELM_MAP_ZOOM_MODE_AUTO_FIT, /**< Zoom until map fits inside the scroll frame with no pixels outside this area. */
22740         ELM_MAP_ZOOM_MODE_AUTO_FILL, /**< Zoom until map fills scroll, ensuring no pixels are left unfilled. */
22741         ELM_MAP_ZOOM_MODE_LAST
22742      } Elm_Map_Zoom_Mode;
22743
22744    /**
22745     * @enum _Elm_Map_Route_Sources
22746     * @typedef Elm_Map_Route_Sources
22747     *
22748     * Set route service to be used. By default used source is
22749     * #ELM_MAP_ROUTE_SOURCE_YOURS.
22750     *
22751     * @see elm_map_route_source_set()
22752     * @see elm_map_route_source_get()
22753     *
22754     * @ingroup Map
22755     */
22756    typedef enum _Elm_Map_Route_Sources
22757      {
22758         ELM_MAP_ROUTE_SOURCE_YOURS, /**< Routing service http://www.yournavigation.org/ . Set by default.*/
22759         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. */
22760         ELM_MAP_ROUTE_SOURCE_ORS, /**< Open Route Service: http://www.openrouteservice.org/ . It's not working with Map yet. */
22761         ELM_MAP_ROUTE_SOURCE_LAST
22762      } Elm_Map_Route_Sources;
22763
22764    typedef enum _Elm_Map_Name_Sources
22765      {
22766         ELM_MAP_NAME_SOURCE_NOMINATIM,
22767         ELM_MAP_NAME_SOURCE_LAST
22768      } Elm_Map_Name_Sources;
22769
22770    /**
22771     * @enum _Elm_Map_Route_Type
22772     * @typedef Elm_Map_Route_Type
22773     *
22774     * Set type of transport used on route.
22775     *
22776     * @see elm_map_route_add()
22777     *
22778     * @ingroup Map
22779     */
22780    typedef enum _Elm_Map_Route_Type
22781      {
22782         ELM_MAP_ROUTE_TYPE_MOTOCAR, /**< Route should consider an automobile will be used. */
22783         ELM_MAP_ROUTE_TYPE_BICYCLE, /**< Route should consider a bicycle will be used by the user. */
22784         ELM_MAP_ROUTE_TYPE_FOOT, /**< Route should consider user will be walking. */
22785         ELM_MAP_ROUTE_TYPE_LAST
22786      } Elm_Map_Route_Type;
22787
22788    /**
22789     * @enum _Elm_Map_Route_Method
22790     * @typedef Elm_Map_Route_Method
22791     *
22792     * Set the routing method, what should be priorized, time or distance.
22793     *
22794     * @see elm_map_route_add()
22795     *
22796     * @ingroup Map
22797     */
22798    typedef enum _Elm_Map_Route_Method
22799      {
22800         ELM_MAP_ROUTE_METHOD_FASTEST, /**< Route should priorize time. */
22801         ELM_MAP_ROUTE_METHOD_SHORTEST, /**< Route should priorize distance. */
22802         ELM_MAP_ROUTE_METHOD_LAST
22803      } Elm_Map_Route_Method;
22804
22805    typedef enum _Elm_Map_Name_Method
22806      {
22807         ELM_MAP_NAME_METHOD_SEARCH,
22808         ELM_MAP_NAME_METHOD_REVERSE,
22809         ELM_MAP_NAME_METHOD_LAST
22810      } Elm_Map_Name_Method;
22811
22812    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(). */
22813    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(). */
22814    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(). */
22815    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(). */
22816    typedef struct _Elm_Map_Name            Elm_Map_Name; /**< A handle for specific coordinates. */
22817    typedef struct _Elm_Map_Track           Elm_Map_Track;
22818
22819    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. */
22820    typedef void         (*ElmMapMarkerDelFunc)      (Evas_Object *obj, Elm_Map_Marker *marker, void *data, Evas_Object *o); /**< Function to delete bubble content for marker classes. */
22821    typedef Evas_Object *(*ElmMapMarkerIconGetFunc)  (Evas_Object *obj, Elm_Map_Marker *marker, void *data); /**< Icon fetching class function for marker classes. */
22822    typedef Evas_Object *(*ElmMapGroupIconGetFunc)   (Evas_Object *obj, void *data); /**< Icon fetching class function for markers group classes. */
22823
22824    typedef char        *(*ElmMapModuleSourceFunc) (void);
22825    typedef int          (*ElmMapModuleZoomMinFunc) (void);
22826    typedef int          (*ElmMapModuleZoomMaxFunc) (void);
22827    typedef char        *(*ElmMapModuleUrlFunc) (Evas_Object *obj, int x, int y, int zoom);
22828    typedef int          (*ElmMapModuleRouteSourceFunc) (void);
22829    typedef char        *(*ElmMapModuleRouteUrlFunc) (Evas_Object *obj, char *type_name, int method, double flon, double flat, double tlon, double tlat);
22830    typedef char        *(*ElmMapModuleNameUrlFunc) (Evas_Object *obj, int method, char *name, double lon, double lat);
22831    typedef Eina_Bool    (*ElmMapModuleGeoIntoCoordFunc) (const Evas_Object *obj, int zoom, double lon, double lat, int size, int *x, int *y);
22832    typedef Eina_Bool    (*ElmMapModuleCoordIntoGeoFunc) (const Evas_Object *obj, int zoom, int x, int y, int size, double *lon, double *lat);
22833
22834    /**
22835     * Add a new map widget to the given parent Elementary (container) object.
22836     *
22837     * @param parent The parent object.
22838     * @return a new map widget handle or @c NULL, on errors.
22839     *
22840     * This function inserts a new map widget on the canvas.
22841     *
22842     * @ingroup Map
22843     */
22844    EAPI Evas_Object          *elm_map_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
22845
22846    /**
22847     * Set the zoom level of the map.
22848     *
22849     * @param obj The map object.
22850     * @param zoom The zoom level to set.
22851     *
22852     * This sets the zoom level.
22853     *
22854     * It will respect limits defined by elm_map_source_zoom_min_set() and
22855     * elm_map_source_zoom_max_set().
22856     *
22857     * By default these values are 0 (world map) and 18 (maximum zoom).
22858     *
22859     * This function should be used when zoom mode is set to
22860     * #ELM_MAP_ZOOM_MODE_MANUAL. This is the default mode, and can be set
22861     * with elm_map_zoom_mode_set().
22862     *
22863     * @see elm_map_zoom_mode_set().
22864     * @see elm_map_zoom_get().
22865     *
22866     * @ingroup Map
22867     */
22868    EAPI void                  elm_map_zoom_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
22869
22870    /**
22871     * Get the zoom level of the map.
22872     *
22873     * @param obj The map object.
22874     * @return The current zoom level.
22875     *
22876     * This returns the current zoom level of the map object.
22877     *
22878     * Note that if you set the fill mode to other than #ELM_MAP_ZOOM_MODE_MANUAL
22879     * (which is the default), the zoom level may be changed at any time by the
22880     * map object itself to account for map size and map viewport size.
22881     *
22882     * @see elm_map_zoom_set() for details.
22883     *
22884     * @ingroup Map
22885     */
22886    EAPI int                   elm_map_zoom_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22887
22888    /**
22889     * Set the zoom mode used by the map object.
22890     *
22891     * @param obj The map object.
22892     * @param mode The zoom mode of the map, being it one of
22893     * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
22894     * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
22895     *
22896     * This sets the zoom mode to manual or one of the automatic levels.
22897     * Manual (#ELM_MAP_ZOOM_MODE_MANUAL) means that zoom is set manually by
22898     * elm_map_zoom_set() and will stay at that level until changed by code
22899     * or until zoom mode is changed. This is the default mode.
22900     *
22901     * The Automatic modes will allow the map object to automatically
22902     * adjust zoom mode based on properties. #ELM_MAP_ZOOM_MODE_AUTO_FIT will
22903     * adjust zoom so the map fits inside the scroll frame with no pixels
22904     * outside this area. #ELM_MAP_ZOOM_MODE_AUTO_FILL will be similar but
22905     * ensure no pixels within the frame are left unfilled. Do not forget that
22906     * the valid sizes are 2^zoom, consequently the map may be smaller than
22907     * the scroller view.
22908     *
22909     * @see elm_map_zoom_set()
22910     *
22911     * @ingroup Map
22912     */
22913    EAPI void                  elm_map_zoom_mode_set(Evas_Object *obj, Elm_Map_Zoom_Mode mode) EINA_ARG_NONNULL(1);
22914
22915    /**
22916     * Get the zoom mode used by the map object.
22917     *
22918     * @param obj The map object.
22919     * @return The zoom mode of the map, being it one of
22920     * #ELM_MAP_ZOOM_MODE_MANUAL (default), #ELM_MAP_ZOOM_MODE_AUTO_FIT,
22921     * or #ELM_MAP_ZOOM_MODE_AUTO_FILL.
22922     *
22923     * This function returns the current zoom mode used by the map object.
22924     *
22925     * @see elm_map_zoom_mode_set() for more details.
22926     *
22927     * @ingroup Map
22928     */
22929    EAPI Elm_Map_Zoom_Mode     elm_map_zoom_mode_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
22930
22931    /**
22932     * Get the current coordinates of the map.
22933     *
22934     * @param obj The map object.
22935     * @param lon Pointer where to store longitude.
22936     * @param lat Pointer where to store latitude.
22937     *
22938     * This gets the current center coordinates of the map object. It can be
22939     * set by elm_map_geo_region_bring_in() and elm_map_geo_region_show().
22940     *
22941     * @see elm_map_geo_region_bring_in()
22942     * @see elm_map_geo_region_show()
22943     *
22944     * @ingroup Map
22945     */
22946    EAPI void                  elm_map_geo_region_get(const Evas_Object *obj, double *lon, double *lat) EINA_ARG_NONNULL(1);
22947
22948    /**
22949     * Animatedly bring in given coordinates to the center of the map.
22950     *
22951     * @param obj The map object.
22952     * @param lon Longitude to center at.
22953     * @param lat Latitude to center at.
22954     *
22955     * This causes map to jump to the given @p lat and @p lon coordinates
22956     * and show it (by scrolling) in the center of the viewport, if it is not
22957     * already centered. This will use animation to do so and take a period
22958     * of time to complete.
22959     *
22960     * @see elm_map_geo_region_show() for a function to avoid animation.
22961     * @see elm_map_geo_region_get()
22962     *
22963     * @ingroup Map
22964     */
22965    EAPI void                  elm_map_geo_region_bring_in(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
22966
22967    /**
22968     * Show the given coordinates at the center of the map, @b immediately.
22969     *
22970     * @param obj The map object.
22971     * @param lon Longitude to center at.
22972     * @param lat Latitude to center at.
22973     *
22974     * This causes map to @b redraw its viewport's contents to the
22975     * region contining the given @p lat and @p lon, that will be moved to the
22976     * center of the map.
22977     *
22978     * @see elm_map_geo_region_bring_in() for a function to move with animation.
22979     * @see elm_map_geo_region_get()
22980     *
22981     * @ingroup Map
22982     */
22983    EAPI void                  elm_map_geo_region_show(Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
22984
22985    /**
22986     * Pause or unpause the map.
22987     *
22988     * @param obj The map object.
22989     * @param paused Use @c EINA_TRUE to pause the map @p obj or @c EINA_FALSE
22990     * to unpause it.
22991     *
22992     * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
22993     * for map.
22994     *
22995     * The default is off.
22996     *
22997     * This will stop zooming using animation, changing zoom levels will
22998     * change instantly. This will stop any existing animations that are running.
22999     *
23000     * @see elm_map_paused_get()
23001     *
23002     * @ingroup Map
23003     */
23004    EAPI void                  elm_map_paused_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
23005
23006    /**
23007     * Get a value whether map is paused or not.
23008     *
23009     * @param obj The map object.
23010     * @return @c EINA_TRUE means map is pause. @c EINA_FALSE indicates
23011     * it is not. If @p obj is @c NULL, @c EINA_FALSE is returned.
23012     *
23013     * This gets the current paused state for the map object.
23014     *
23015     * @see elm_map_paused_set() for details.
23016     *
23017     * @ingroup Map
23018     */
23019    EAPI Eina_Bool             elm_map_paused_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23020
23021    /**
23022     * Set to show markers during zoom level changes or not.
23023     *
23024     * @param obj The map object.
23025     * @param paused Use @c EINA_TRUE to @b not show markers or @c EINA_FALSE
23026     * to show them.
23027     *
23028     * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
23029     * for map.
23030     *
23031     * The default is off.
23032     *
23033     * This will stop zooming using animation, changing zoom levels will
23034     * change instantly. This will stop any existing animations that are running.
23035     *
23036     * This sets the paused state to on (@c EINA_TRUE) or off (@c EINA_FALSE)
23037     * for the markers.
23038     *
23039     * The default  is off.
23040     *
23041     * Enabling it will force the map to stop displaying the markers during
23042     * zoom level changes. Set to on if you have a large number of markers.
23043     *
23044     * @see elm_map_paused_markers_get()
23045     *
23046     * @ingroup Map
23047     */
23048    EAPI void                  elm_map_paused_markers_set(Evas_Object *obj, Eina_Bool paused) EINA_ARG_NONNULL(1);
23049
23050    /**
23051     * Get a value whether markers will be displayed on zoom level changes or not
23052     *
23053     * @param obj The map object.
23054     * @return @c EINA_TRUE means map @b won't display markers or @c EINA_FALSE
23055     * indicates it will. If @p obj is @c NULL, @c EINA_FALSE is returned.
23056     *
23057     * This gets the current markers paused state for the map object.
23058     *
23059     * @see elm_map_paused_markers_set() for details.
23060     *
23061     * @ingroup Map
23062     */
23063    EAPI Eina_Bool             elm_map_paused_markers_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23064
23065    /**
23066     * Get the information of downloading status.
23067     *
23068     * @param obj The map object.
23069     * @param try_num Pointer where to store number of tiles being downloaded.
23070     * @param finish_num Pointer where to store number of tiles successfully
23071     * downloaded.
23072     *
23073     * This gets the current downloading status for the map object, the number
23074     * of tiles being downloaded and the number of tiles already downloaded.
23075     *
23076     * @ingroup Map
23077     */
23078    EAPI void                  elm_map_utils_downloading_status_get(const Evas_Object *obj, int *try_num, int *finish_num) EINA_ARG_NONNULL(1, 2, 3);
23079
23080    /**
23081     * Convert a pixel coordinate (x,y) into a geographic coordinate
23082     * (longitude, latitude).
23083     *
23084     * @param obj The map object.
23085     * @param x the coordinate.
23086     * @param y the coordinate.
23087     * @param size the size in pixels of the map.
23088     * The map is a square and generally his size is : pow(2.0, zoom)*256.
23089     * @param lon Pointer where to store the longitude that correspond to x.
23090     * @param lat Pointer where to store the latitude that correspond to y.
23091     *
23092     * @note Origin pixel point is the top left corner of the viewport.
23093     * Map zoom and size are taken on account.
23094     *
23095     * @see elm_map_utils_convert_geo_into_coord() if you need the inverse.
23096     *
23097     * @ingroup Map
23098     */
23099    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);
23100
23101    /**
23102     * Convert a geographic coordinate (longitude, latitude) into a pixel
23103     * coordinate (x, y).
23104     *
23105     * @param obj The map object.
23106     * @param lon the longitude.
23107     * @param lat the latitude.
23108     * @param size the size in pixels of the map. The map is a square
23109     * and generally his size is : pow(2.0, zoom)*256.
23110     * @param x Pointer where to store the horizontal pixel coordinate that
23111     * correspond to the longitude.
23112     * @param y Pointer where to store the vertical pixel coordinate that
23113     * correspond to the latitude.
23114     *
23115     * @note Origin pixel point is the top left corner of the viewport.
23116     * Map zoom and size are taken on account.
23117     *
23118     * @see elm_map_utils_convert_coord_into_geo() if you need the inverse.
23119     *
23120     * @ingroup Map
23121     */
23122    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);
23123
23124    /**
23125     * Convert a geographic coordinate (longitude, latitude) into a name
23126     * (address).
23127     *
23128     * @param obj The map object.
23129     * @param lon the longitude.
23130     * @param lat the latitude.
23131     * @return name A #Elm_Map_Name handle for this coordinate.
23132     *
23133     * To get the string for this address, elm_map_name_address_get()
23134     * should be used.
23135     *
23136     * @see elm_map_utils_convert_name_into_coord() if you need the inverse.
23137     *
23138     * @ingroup Map
23139     */
23140    EAPI Elm_Map_Name         *elm_map_utils_convert_coord_into_name(const Evas_Object *obj, double lon, double lat) EINA_ARG_NONNULL(1);
23141
23142    /**
23143     * Convert a name (address) into a geographic coordinate
23144     * (longitude, latitude).
23145     *
23146     * @param obj The map object.
23147     * @param name The address.
23148     * @return name A #Elm_Map_Name handle for this address.
23149     *
23150     * To get the longitude and latitude, elm_map_name_region_get()
23151     * should be used.
23152     *
23153     * @see elm_map_utils_convert_coord_into_name() if you need the inverse.
23154     *
23155     * @ingroup Map
23156     */
23157    EAPI Elm_Map_Name         *elm_map_utils_convert_name_into_coord(const Evas_Object *obj, char *address) EINA_ARG_NONNULL(1, 2);
23158
23159    /**
23160     * Convert a pixel coordinate into a rotated pixel coordinate.
23161     *
23162     * @param obj The map object.
23163     * @param x horizontal coordinate of the point to rotate.
23164     * @param y vertical coordinate of the point to rotate.
23165     * @param cx rotation's center horizontal position.
23166     * @param cy rotation's center vertical position.
23167     * @param degree amount of degrees from 0.0 to 360.0 to rotate arount Z axis.
23168     * @param xx Pointer where to store rotated x.
23169     * @param yy Pointer where to store rotated y.
23170     *
23171     * @ingroup Map
23172     */
23173    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);
23174
23175    /**
23176     * Add a new marker to the map object.
23177     *
23178     * @param obj The map object.
23179     * @param lon The longitude of the marker.
23180     * @param lat The latitude of the marker.
23181     * @param clas The class, to use when marker @b isn't grouped to others.
23182     * @param clas_group The class group, to use when marker is grouped to others
23183     * @param data The data passed to the callbacks.
23184     *
23185     * @return The created marker or @c NULL upon failure.
23186     *
23187     * A marker will be created and shown in a specific point of the map, defined
23188     * by @p lon and @p lat.
23189     *
23190     * It will be displayed using style defined by @p class when this marker
23191     * is displayed alone (not grouped). A new class can be created with
23192     * elm_map_marker_class_new().
23193     *
23194     * If the marker is grouped to other markers, it will be displayed with
23195     * style defined by @p class_group. Markers with the same group are grouped
23196     * if they are close. A new group class can be created with
23197     * elm_map_marker_group_class_new().
23198     *
23199     * Markers created with this method can be deleted with
23200     * elm_map_marker_remove().
23201     *
23202     * A marker can have associated content to be displayed by a bubble,
23203     * when a user click over it, as well as an icon. These objects will
23204     * be fetch using class' callback functions.
23205     *
23206     * @see elm_map_marker_class_new()
23207     * @see elm_map_marker_group_class_new()
23208     * @see elm_map_marker_remove()
23209     *
23210     * @ingroup Map
23211     */
23212    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);
23213
23214    /**
23215     * Set the maximum numbers of markers' content to be displayed in a group.
23216     *
23217     * @param obj The map object.
23218     * @param max The maximum numbers of items displayed in a bubble.
23219     *
23220     * A bubble will be displayed when the user clicks over the group,
23221     * and will place the content of markers that belong to this group
23222     * inside it.
23223     *
23224     * A group can have a long list of markers, consequently the creation
23225     * of the content of the bubble can be very slow.
23226     *
23227     * In order to avoid this, a maximum number of items is displayed
23228     * in a bubble.
23229     *
23230     * By default this number is 30.
23231     *
23232     * Marker with the same group class are grouped if they are close.
23233     *
23234     * @see elm_map_marker_add()
23235     *
23236     * @ingroup Map
23237     */
23238    EAPI void                  elm_map_max_marker_per_group_set(Evas_Object *obj, int max) EINA_ARG_NONNULL(1);
23239
23240    /**
23241     * Remove a marker from the map.
23242     *
23243     * @param marker The marker to remove.
23244     *
23245     * @see elm_map_marker_add()
23246     *
23247     * @ingroup Map
23248     */
23249    EAPI void                  elm_map_marker_remove(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
23250
23251    /**
23252     * Get the current coordinates of the marker.
23253     *
23254     * @param marker marker.
23255     * @param lat Pointer where to store the marker's latitude.
23256     * @param lon Pointer where to store the marker's longitude.
23257     *
23258     * These values are set when adding markers, with function
23259     * elm_map_marker_add().
23260     *
23261     * @see elm_map_marker_add()
23262     *
23263     * @ingroup Map
23264     */
23265    EAPI void                  elm_map_marker_region_get(const Elm_Map_Marker *marker, double *lon, double *lat) EINA_ARG_NONNULL(1);
23266
23267    /**
23268     * Animatedly bring in given marker to the center of the map.
23269     *
23270     * @param marker The marker to center at.
23271     *
23272     * This causes map to jump to the given @p marker's coordinates
23273     * and show it (by scrolling) in the center of the viewport, if it is not
23274     * already centered. This will use animation to do so and take a period
23275     * of time to complete.
23276     *
23277     * @see elm_map_marker_show() for a function to avoid animation.
23278     * @see elm_map_marker_region_get()
23279     *
23280     * @ingroup Map
23281     */
23282    EAPI void                  elm_map_marker_bring_in(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
23283
23284    /**
23285     * Show the given marker at the center of the map, @b immediately.
23286     *
23287     * @param marker The marker to center at.
23288     *
23289     * This causes map to @b redraw its viewport's contents to the
23290     * region contining the given @p marker's coordinates, that will be
23291     * moved to the center of the map.
23292     *
23293     * @see elm_map_marker_bring_in() for a function to move with animation.
23294     * @see elm_map_markers_list_show() if more than one marker need to be
23295     * displayed.
23296     * @see elm_map_marker_region_get()
23297     *
23298     * @ingroup Map
23299     */
23300    EAPI void                  elm_map_marker_show(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
23301
23302    /**
23303     * Move and zoom the map to display a list of markers.
23304     *
23305     * @param markers A list of #Elm_Map_Marker handles.
23306     *
23307     * The map will be centered on the center point of the markers in the list.
23308     * Then the map will be zoomed in order to fit the markers using the maximum
23309     * zoom which allows display of all the markers.
23310     *
23311     * @warning All the markers should belong to the same map object.
23312     *
23313     * @see elm_map_marker_show() to show a single marker.
23314     * @see elm_map_marker_bring_in()
23315     *
23316     * @ingroup Map
23317     */
23318    EAPI void                  elm_map_markers_list_show(Eina_List *markers) EINA_ARG_NONNULL(1);
23319
23320    /**
23321     * Get the Evas object returned by the ElmMapMarkerGetFunc callback
23322     *
23323     * @param marker The marker wich content should be returned.
23324     * @return Return the evas object if it exists, else @c NULL.
23325     *
23326     * To set callback function #ElmMapMarkerGetFunc for the marker class,
23327     * elm_map_marker_class_get_cb_set() should be used.
23328     *
23329     * This content is what will be inside the bubble that will be displayed
23330     * when an user clicks over the marker.
23331     *
23332     * This returns the actual Evas object used to be placed inside
23333     * the bubble. This may be @c NULL, as it may
23334     * not have been created or may have been deleted, at any time, by
23335     * the map. <b>Do not modify this object</b> (move, resize,
23336     * show, hide, etc.), as the map is controlling it. This
23337     * function is for querying, emitting custom signals or hooking
23338     * lower level callbacks for events on that object. Do not delete
23339     * this object under any circumstances.
23340     *
23341     * @ingroup Map
23342     */
23343    EAPI Evas_Object          *elm_map_marker_object_get(const Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
23344
23345    /**
23346     * Update the marker
23347     *
23348     * @param marker The marker to be updated.
23349     *
23350     * If a content is set to this marker, it will call function to delete it,
23351     * #ElmMapMarkerDelFunc, and then will fetch the content again with
23352     * #ElmMapMarkerGetFunc.
23353     *
23354     * These functions are set for the marker class with
23355     * elm_map_marker_class_get_cb_set() and elm_map_marker_class_del_cb_set().
23356     *
23357     * @ingroup Map
23358     */
23359    EAPI void                  elm_map_marker_update(Elm_Map_Marker *marker) EINA_ARG_NONNULL(1);
23360
23361    /**
23362     * Close all the bubbles opened by the user.
23363     *
23364     * @param obj The map object.
23365     *
23366     * A bubble is displayed with a content fetched with #ElmMapMarkerGetFunc
23367     * when the user clicks on a marker.
23368     *
23369     * This functions is set for the marker class with
23370     * elm_map_marker_class_get_cb_set().
23371     *
23372     * @ingroup Map
23373     */
23374    EAPI void                  elm_map_bubbles_close(Evas_Object *obj) EINA_ARG_NONNULL(1);
23375
23376    /**
23377     * Create a new group class.
23378     *
23379     * @param obj The map object.
23380     * @return Returns the new group class.
23381     *
23382     * Each marker must be associated to a group class. Markers in the same
23383     * group are grouped if they are close.
23384     *
23385     * The group class defines the style of the marker when a marker is grouped
23386     * to others markers. When it is alone, another class will be used.
23387     *
23388     * A group class will need to be provided when creating a marker with
23389     * elm_map_marker_add().
23390     *
23391     * Some properties and functions can be set by class, as:
23392     * - style, with elm_map_group_class_style_set()
23393     * - data - to be associated to the group class. It can be set using
23394     *   elm_map_group_class_data_set().
23395     * - min zoom to display markers, set with
23396     *   elm_map_group_class_zoom_displayed_set().
23397     * - max zoom to group markers, set using
23398     *   elm_map_group_class_zoom_grouped_set().
23399     * - visibility - set if markers will be visible or not, set with
23400     *   elm_map_group_class_hide_set().
23401     * - #ElmMapGroupIconGetFunc - used to fetch icon for markers group classes.
23402     *   It can be set using elm_map_group_class_icon_cb_set().
23403     *
23404     * @see elm_map_marker_add()
23405     * @see elm_map_group_class_style_set()
23406     * @see elm_map_group_class_data_set()
23407     * @see elm_map_group_class_zoom_displayed_set()
23408     * @see elm_map_group_class_zoom_grouped_set()
23409     * @see elm_map_group_class_hide_set()
23410     * @see elm_map_group_class_icon_cb_set()
23411     *
23412     * @ingroup Map
23413     */
23414    EAPI Elm_Map_Group_Class  *elm_map_group_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
23415
23416    /**
23417     * Set the marker's style of a group class.
23418     *
23419     * @param clas The group class.
23420     * @param style The style to be used by markers.
23421     *
23422     * Each marker must be associated to a group class, and will use the style
23423     * defined by such class when grouped to other markers.
23424     *
23425     * The following styles are provided by default theme:
23426     * @li @c radio - blue circle
23427     * @li @c radio2 - green circle
23428     * @li @c empty
23429     *
23430     * @see elm_map_group_class_new() for more details.
23431     * @see elm_map_marker_add()
23432     *
23433     * @ingroup Map
23434     */
23435    EAPI void                  elm_map_group_class_style_set(Elm_Map_Group_Class *clas, const char *style) EINA_ARG_NONNULL(1);
23436
23437    /**
23438     * Set the icon callback function of a group class.
23439     *
23440     * @param clas The group class.
23441     * @param icon_get The callback function that will return the icon.
23442     *
23443     * Each marker must be associated to a group class, and it can display a
23444     * custom icon. The function @p icon_get must return this icon.
23445     *
23446     * @see elm_map_group_class_new() for more details.
23447     * @see elm_map_marker_add()
23448     *
23449     * @ingroup Map
23450     */
23451    EAPI void                  elm_map_group_class_icon_cb_set(Elm_Map_Group_Class *clas, ElmMapGroupIconGetFunc icon_get) EINA_ARG_NONNULL(1);
23452
23453    /**
23454     * Set the data associated to the group class.
23455     *
23456     * @param clas The group class.
23457     * @param data The new user data.
23458     *
23459     * This data will be passed for callback functions, like icon get callback,
23460     * that can be set with elm_map_group_class_icon_cb_set().
23461     *
23462     * If a data was previously set, the object will lose the pointer for it,
23463     * so if needs to be freed, you must do it yourself.
23464     *
23465     * @see elm_map_group_class_new() for more details.
23466     * @see elm_map_group_class_icon_cb_set()
23467     * @see elm_map_marker_add()
23468     *
23469     * @ingroup Map
23470     */
23471    EAPI void                  elm_map_group_class_data_set(Elm_Map_Group_Class *clas, void *data) EINA_ARG_NONNULL(1);
23472
23473    /**
23474     * Set the minimum zoom from where the markers are displayed.
23475     *
23476     * @param clas The group class.
23477     * @param zoom The minimum zoom.
23478     *
23479     * Markers only will be displayed when the map is displayed at @p zoom
23480     * or bigger.
23481     *
23482     * @see elm_map_group_class_new() for more details.
23483     * @see elm_map_marker_add()
23484     *
23485     * @ingroup Map
23486     */
23487    EAPI void                  elm_map_group_class_zoom_displayed_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
23488
23489    /**
23490     * Set the zoom from where the markers are no more grouped.
23491     *
23492     * @param clas The group class.
23493     * @param zoom The maximum zoom.
23494     *
23495     * Markers only will be grouped when the map is displayed at
23496     * less than @p zoom.
23497     *
23498     * @see elm_map_group_class_new() for more details.
23499     * @see elm_map_marker_add()
23500     *
23501     * @ingroup Map
23502     */
23503    EAPI void                  elm_map_group_class_zoom_grouped_set(Elm_Map_Group_Class *clas, int zoom) EINA_ARG_NONNULL(1);
23504
23505    /**
23506     * Set if the markers associated to the group class @clas are hidden or not.
23507     *
23508     * @param clas The group class.
23509     * @param hide Use @c EINA_TRUE to hide markers or @c EINA_FALSE
23510     * to show them.
23511     *
23512     * If @p hide is @c EINA_TRUE the markers will be hidden, but default
23513     * is to show them.
23514     *
23515     * @ingroup Map
23516     */
23517    EAPI void                  elm_map_group_class_hide_set(Evas_Object *obj, Elm_Map_Group_Class *clas, Eina_Bool hide) EINA_ARG_NONNULL(1, 2);
23518
23519    /**
23520     * Create a new marker class.
23521     *
23522     * @param obj The map object.
23523     * @return Returns the new group class.
23524     *
23525     * Each marker must be associated to a class.
23526     *
23527     * The marker class defines the style of the marker when a marker is
23528     * displayed alone, i.e., not grouped to to others markers. When grouped
23529     * it will use group class style.
23530     *
23531     * A marker class will need to be provided when creating a marker with
23532     * elm_map_marker_add().
23533     *
23534     * Some properties and functions can be set by class, as:
23535     * - style, with elm_map_marker_class_style_set()
23536     * - #ElmMapMarkerIconGetFunc - used to fetch icon for markers classes.
23537     *   It can be set using elm_map_marker_class_icon_cb_set().
23538     * - #ElmMapMarkerGetFunc - used to fetch bubble content for marker classes.
23539     *   Set using elm_map_marker_class_get_cb_set().
23540     * - #ElmMapMarkerDelFunc - used to delete bubble content for marker classes.
23541     *   Set using elm_map_marker_class_del_cb_set().
23542     *
23543     * @see elm_map_marker_add()
23544     * @see elm_map_marker_class_style_set()
23545     * @see elm_map_marker_class_icon_cb_set()
23546     * @see elm_map_marker_class_get_cb_set()
23547     * @see elm_map_marker_class_del_cb_set()
23548     *
23549     * @ingroup Map
23550     */
23551    EAPI Elm_Map_Marker_Class *elm_map_marker_class_new(Evas_Object *obj) EINA_ARG_NONNULL(1);
23552
23553    /**
23554     * Set the marker's style of a marker class.
23555     *
23556     * @param clas The marker class.
23557     * @param style The style to be used by markers.
23558     *
23559     * Each marker must be associated to a marker class, and will use the style
23560     * defined by such class when alone, i.e., @b not grouped to other markers.
23561     *
23562     * The following styles are provided by default theme:
23563     * @li @c radio
23564     * @li @c radio2
23565     * @li @c empty
23566     *
23567     * @see elm_map_marker_class_new() for more details.
23568     * @see elm_map_marker_add()
23569     *
23570     * @ingroup Map
23571     */
23572    EAPI void                  elm_map_marker_class_style_set(Elm_Map_Marker_Class *clas, const char *style) EINA_ARG_NONNULL(1);
23573
23574    /**
23575     * Set the icon callback function of a marker class.
23576     *
23577     * @param clas The marker class.
23578     * @param icon_get The callback function that will return the icon.
23579     *
23580     * Each marker must be associated to a marker class, and it can display a
23581     * custom icon. The function @p icon_get must return this icon.
23582     *
23583     * @see elm_map_marker_class_new() for more details.
23584     * @see elm_map_marker_add()
23585     *
23586     * @ingroup Map
23587     */
23588    EAPI void                  elm_map_marker_class_icon_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerIconGetFunc icon_get) EINA_ARG_NONNULL(1);
23589
23590    /**
23591     * Set the bubble content callback function of a marker class.
23592     *
23593     * @param clas The marker class.
23594     * @param get The callback function that will return the content.
23595     *
23596     * Each marker must be associated to a marker class, and it can display a
23597     * a content on a bubble that opens when the user click over the marker.
23598     * The function @p get must return this content object.
23599     *
23600     * If this content will need to be deleted, elm_map_marker_class_del_cb_set()
23601     * can be used.
23602     *
23603     * @see elm_map_marker_class_new() for more details.
23604     * @see elm_map_marker_class_del_cb_set()
23605     * @see elm_map_marker_add()
23606     *
23607     * @ingroup Map
23608     */
23609    EAPI void                  elm_map_marker_class_get_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerGetFunc get) EINA_ARG_NONNULL(1);
23610
23611    /**
23612     * Set the callback function used to delete bubble content of a marker class.
23613     *
23614     * @param clas The marker class.
23615     * @param del The callback function that will delete the content.
23616     *
23617     * Each marker must be associated to a marker class, and it can display a
23618     * a content on a bubble that opens when the user click over the marker.
23619     * The function to return such content can be set with
23620     * elm_map_marker_class_get_cb_set().
23621     *
23622     * If this content must be freed, a callback function need to be
23623     * set for that task with this function.
23624     *
23625     * If this callback is defined it will have to delete (or not) the
23626     * object inside, but if the callback is not defined the object will be
23627     * destroyed with evas_object_del().
23628     *
23629     * @see elm_map_marker_class_new() for more details.
23630     * @see elm_map_marker_class_get_cb_set()
23631     * @see elm_map_marker_add()
23632     *
23633     * @ingroup Map
23634     */
23635    EAPI void                  elm_map_marker_class_del_cb_set(Elm_Map_Marker_Class *clas, ElmMapMarkerDelFunc del) EINA_ARG_NONNULL(1);
23636
23637    /**
23638     * Get the list of available sources.
23639     *
23640     * @param obj The map object.
23641     * @return The source names list.
23642     *
23643     * It will provide a list with all available sources, that can be set as
23644     * current source with elm_map_source_name_set(), or get with
23645     * elm_map_source_name_get().
23646     *
23647     * Available sources:
23648     * @li "Mapnik"
23649     * @li "Osmarender"
23650     * @li "CycleMap"
23651     * @li "Maplint"
23652     *
23653     * @see elm_map_source_name_set() for more details.
23654     * @see elm_map_source_name_get()
23655     *
23656     * @ingroup Map
23657     */
23658    EAPI const char          **elm_map_source_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23659
23660    /**
23661     * Set the source of the map.
23662     *
23663     * @param obj The map object.
23664     * @param source The source to be used.
23665     *
23666     * Map widget retrieves images that composes the map from a web service.
23667     * This web service can be set with this method.
23668     *
23669     * A different service can return a different maps with different
23670     * information and it can use different zoom values.
23671     *
23672     * The @p source_name need to match one of the names provided by
23673     * elm_map_source_names_get().
23674     *
23675     * The current source can be get using elm_map_source_name_get().
23676     *
23677     * @see elm_map_source_names_get()
23678     * @see elm_map_source_name_get()
23679     *
23680     *
23681     * @ingroup Map
23682     */
23683    EAPI void                  elm_map_source_name_set(Evas_Object *obj, const char *source_name) EINA_ARG_NONNULL(1);
23684
23685    /**
23686     * Get the name of currently used source.
23687     *
23688     * @param obj The map object.
23689     * @return Returns the name of the source in use.
23690     *
23691     * @see elm_map_source_name_set() for more details.
23692     *
23693     * @ingroup Map
23694     */
23695    EAPI const char           *elm_map_source_name_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23696
23697    /**
23698     * Set the source of the route service to be used by the map.
23699     *
23700     * @param obj The map object.
23701     * @param source The route service to be used, being it one of
23702     * #ELM_MAP_ROUTE_SOURCE_YOURS (default), #ELM_MAP_ROUTE_SOURCE_MONAV,
23703     * and #ELM_MAP_ROUTE_SOURCE_ORS.
23704     *
23705     * Each one has its own algorithm, so the route retrieved may
23706     * differ depending on the source route. Now, only the default is working.
23707     *
23708     * #ELM_MAP_ROUTE_SOURCE_YOURS is the routing service provided at
23709     * http://www.yournavigation.org/.
23710     *
23711     * #ELM_MAP_ROUTE_SOURCE_MONAV, offers exact routing without heuristic
23712     * assumptions. Its routing core is based on Contraction Hierarchies.
23713     *
23714     * #ELM_MAP_ROUTE_SOURCE_ORS, is provided at http://www.openrouteservice.org/
23715     *
23716     * @see elm_map_route_source_get().
23717     *
23718     * @ingroup Map
23719     */
23720    EAPI void                  elm_map_route_source_set(Evas_Object *obj, Elm_Map_Route_Sources source) EINA_ARG_NONNULL(1);
23721
23722    /**
23723     * Get the current route source.
23724     *
23725     * @param obj The map object.
23726     * @return The source of the route service used by the map.
23727     *
23728     * @see elm_map_route_source_set() for details.
23729     *
23730     * @ingroup Map
23731     */
23732    EAPI Elm_Map_Route_Sources elm_map_route_source_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23733
23734    /**
23735     * Set the minimum zoom of the source.
23736     *
23737     * @param obj The map object.
23738     * @param zoom New minimum zoom value to be used.
23739     *
23740     * By default, it's 0.
23741     *
23742     * @ingroup Map
23743     */
23744    EAPI void                  elm_map_source_zoom_min_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
23745
23746    /**
23747     * Get the minimum zoom of the source.
23748     *
23749     * @param obj The map object.
23750     * @return Returns the minimum zoom of the source.
23751     *
23752     * @see elm_map_source_zoom_min_set() for details.
23753     *
23754     * @ingroup Map
23755     */
23756    EAPI int                   elm_map_source_zoom_min_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23757
23758    /**
23759     * Set the maximum zoom of the source.
23760     *
23761     * @param obj The map object.
23762     * @param zoom New maximum zoom value to be used.
23763     *
23764     * By default, it's 18.
23765     *
23766     * @ingroup Map
23767     */
23768    EAPI void                  elm_map_source_zoom_max_set(Evas_Object *obj, int zoom) EINA_ARG_NONNULL(1);
23769
23770    /**
23771     * Get the maximum zoom of the source.
23772     *
23773     * @param obj The map object.
23774     * @return Returns the maximum zoom of the source.
23775     *
23776     * @see elm_map_source_zoom_min_set() for details.
23777     *
23778     * @ingroup Map
23779     */
23780    EAPI int                   elm_map_source_zoom_max_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23781
23782    /**
23783     * Set the user agent used by the map object to access routing services.
23784     *
23785     * @param obj The map object.
23786     * @param user_agent The user agent to be used by the map.
23787     *
23788     * User agent is a client application implementing a network protocol used
23789     * in communications within a client–server distributed computing system
23790     *
23791     * The @p user_agent identification string will transmitted in a header
23792     * field @c User-Agent.
23793     *
23794     * @see elm_map_user_agent_get()
23795     *
23796     * @ingroup Map
23797     */
23798    EAPI void                  elm_map_user_agent_set(Evas_Object *obj, const char *user_agent) EINA_ARG_NONNULL(1, 2);
23799
23800    /**
23801     * Get the user agent used by the map object.
23802     *
23803     * @param obj The map object.
23804     * @return The user agent identification string used by the map.
23805     *
23806     * @see elm_map_user_agent_set() for details.
23807     *
23808     * @ingroup Map
23809     */
23810    EAPI const char           *elm_map_user_agent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
23811
23812    /**
23813     * Add a new route to the map object.
23814     *
23815     * @param obj The map object.
23816     * @param type The type of transport to be considered when tracing a route.
23817     * @param method The routing method, what should be priorized.
23818     * @param flon The start longitude.
23819     * @param flat The start latitude.
23820     * @param tlon The destination longitude.
23821     * @param tlat The destination latitude.
23822     *
23823     * @return The created route or @c NULL upon failure.
23824     *
23825     * A route will be traced by point on coordinates (@p flat, @p flon)
23826     * to point on coordinates (@p tlat, @p tlon), using the route service
23827     * set with elm_map_route_source_set().
23828     *
23829     * It will take @p type on consideration to define the route,
23830     * depending if the user will be walking or driving, the route may vary.
23831     * One of #ELM_MAP_ROUTE_TYPE_MOTOCAR, #ELM_MAP_ROUTE_TYPE_BICYCLE, or
23832     * #ELM_MAP_ROUTE_TYPE_FOOT need to be used.
23833     *
23834     * Another parameter is what the route should priorize, the minor distance
23835     * or the less time to be spend on the route. So @p method should be one
23836     * of #ELM_MAP_ROUTE_METHOD_SHORTEST or #ELM_MAP_ROUTE_METHOD_FASTEST.
23837     *
23838     * Routes created with this method can be deleted with
23839     * elm_map_route_remove(), colored with elm_map_route_color_set(),
23840     * and distance can be get with elm_map_route_distance_get().
23841     *
23842     * @see elm_map_route_remove()
23843     * @see elm_map_route_color_set()
23844     * @see elm_map_route_distance_get()
23845     * @see elm_map_route_source_set()
23846     *
23847     * @ingroup Map
23848     */
23849    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);
23850
23851    /**
23852     * Remove a route from the map.
23853     *
23854     * @param route The route to remove.
23855     *
23856     * @see elm_map_route_add()
23857     *
23858     * @ingroup Map
23859     */
23860    EAPI void                  elm_map_route_remove(Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23861
23862    /**
23863     * Set the route color.
23864     *
23865     * @param route The route object.
23866     * @param r Red channel value, from 0 to 255.
23867     * @param g Green channel value, from 0 to 255.
23868     * @param b Blue channel value, from 0 to 255.
23869     * @param a Alpha channel value, from 0 to 255.
23870     *
23871     * It uses an additive color model, so each color channel represents
23872     * how much of each primary colors must to be used. 0 represents
23873     * ausence of this color, so if all of the three are set to 0,
23874     * the color will be black.
23875     *
23876     * These component values should be integers in the range 0 to 255,
23877     * (single 8-bit byte).
23878     *
23879     * This sets the color used for the route. By default, it is set to
23880     * solid red (r = 255, g = 0, b = 0, a = 255).
23881     *
23882     * For alpha channel, 0 represents completely transparent, and 255, opaque.
23883     *
23884     * @see elm_map_route_color_get()
23885     *
23886     * @ingroup Map
23887     */
23888    EAPI void                  elm_map_route_color_set(Elm_Map_Route *route, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
23889
23890    /**
23891     * Get the route color.
23892     *
23893     * @param route The route object.
23894     * @param r Pointer where to store the red channel value.
23895     * @param g Pointer where to store the green channel value.
23896     * @param b Pointer where to store the blue channel value.
23897     * @param a Pointer where to store the alpha channel value.
23898     *
23899     * @see elm_map_route_color_set() for details.
23900     *
23901     * @ingroup Map
23902     */
23903    EAPI void                  elm_map_route_color_get(const Elm_Map_Route *route, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
23904
23905    /**
23906     * Get the route distance in kilometers.
23907     *
23908     * @param route The route object.
23909     * @return The distance of route (unit : km).
23910     *
23911     * @ingroup Map
23912     */
23913    EAPI double                elm_map_route_distance_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23914
23915    /**
23916     * Get the information of route nodes.
23917     *
23918     * @param route The route object.
23919     * @return Returns a string with the nodes of route.
23920     *
23921     * @ingroup Map
23922     */
23923    EAPI const char           *elm_map_route_node_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23924
23925    /**
23926     * Get the information of route waypoint.
23927     *
23928     * @param route the route object.
23929     * @return Returns a string with information about waypoint of route.
23930     *
23931     * @ingroup Map
23932     */
23933    EAPI const char           *elm_map_route_waypoint_get(const Elm_Map_Route *route) EINA_ARG_NONNULL(1);
23934
23935    /**
23936     * Get the address of the name.
23937     *
23938     * @param name The name handle.
23939     * @return Returns the address string of @p name.
23940     *
23941     * This gets the coordinates of the @p name, created with one of the
23942     * conversion functions.
23943     *
23944     * @see elm_map_utils_convert_name_into_coord()
23945     * @see elm_map_utils_convert_coord_into_name()
23946     *
23947     * @ingroup Map
23948     */
23949    EAPI const char           *elm_map_name_address_get(const Elm_Map_Name *name) EINA_ARG_NONNULL(1);
23950
23951    /**
23952     * Get the current coordinates of the name.
23953     *
23954     * @param name The name handle.
23955     * @param lat Pointer where to store the latitude.
23956     * @param lon Pointer where to store The longitude.
23957     *
23958     * This gets the coordinates of the @p name, created with one of the
23959     * conversion functions.
23960     *
23961     * @see elm_map_utils_convert_name_into_coord()
23962     * @see elm_map_utils_convert_coord_into_name()
23963     *
23964     * @ingroup Map
23965     */
23966    EAPI void                  elm_map_name_region_get(const Elm_Map_Name *name, double *lon, double *lat) EINA_ARG_NONNULL(1);
23967
23968    /**
23969     * Remove a name from the map.
23970     *
23971     * @param name The name to remove.
23972     *
23973     * Basically the struct handled by @p name will be freed, so convertions
23974     * between address and coordinates will be lost.
23975     *
23976     * @see elm_map_utils_convert_name_into_coord()
23977     * @see elm_map_utils_convert_coord_into_name()
23978     *
23979     * @ingroup Map
23980     */
23981    EAPI void                  elm_map_name_remove(Elm_Map_Name *name) EINA_ARG_NONNULL(1);
23982
23983    /**
23984     * Rotate the map.
23985     *
23986     * @param obj The map object.
23987     * @param degree Angle from 0.0 to 360.0 to rotate arount Z axis.
23988     * @param cx Rotation's center horizontal position.
23989     * @param cy Rotation's center vertical position.
23990     *
23991     * @see elm_map_rotate_get()
23992     *
23993     * @ingroup Map
23994     */
23995    EAPI void                  elm_map_rotate_set(Evas_Object *obj, double degree, Evas_Coord cx, Evas_Coord cy) EINA_ARG_NONNULL(1);
23996
23997    /**
23998     * Get the rotate degree of the map
23999     *
24000     * @param obj The map object
24001     * @param degree Pointer where to store degrees from 0.0 to 360.0
24002     * to rotate arount Z axis.
24003     * @param cx Pointer where to store rotation's center horizontal position.
24004     * @param cy Pointer where to store rotation's center vertical position.
24005     *
24006     * @see elm_map_rotate_set() to set map rotation.
24007     *
24008     * @ingroup Map
24009     */
24010    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);
24011
24012    /**
24013     * Enable or disable mouse wheel to be used to zoom in / out the map.
24014     *
24015     * @param obj The map object.
24016     * @param disabled Use @c EINA_TRUE to disable mouse wheel or @c EINA_FALSE
24017     * to enable it.
24018     *
24019     * Mouse wheel can be used for the user to zoom in or zoom out the map.
24020     *
24021     * It's disabled by default.
24022     *
24023     * @see elm_map_wheel_disabled_get()
24024     *
24025     * @ingroup Map
24026     */
24027    EAPI void                  elm_map_wheel_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
24028
24029    /**
24030     * Get a value whether mouse wheel is enabled or not.
24031     *
24032     * @param obj The map object.
24033     * @return @c EINA_TRUE means map is disabled. @c EINA_FALSE indicates
24034     * it is enabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
24035     *
24036     * Mouse wheel can be used for the user to zoom in or zoom out the map.
24037     *
24038     * @see elm_map_wheel_disabled_set() for details.
24039     *
24040     * @ingroup Map
24041     */
24042    EAPI Eina_Bool             elm_map_wheel_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24043
24044 #ifdef ELM_EMAP
24045    /**
24046     * Add a track on the map
24047     *
24048     * @param obj The map object.
24049     * @param emap The emap route object.
24050     * @return The route object. This is an elm object of type Route.
24051     *
24052     * @see elm_route_add() for details.
24053     *
24054     * @ingroup Map
24055     */
24056    EAPI Evas_Object          *elm_map_track_add(Evas_Object *obj, EMap_Route *emap) EINA_ARG_NONNULL(1);
24057 #endif
24058
24059    /**
24060     * Remove a track from the map
24061     *
24062     * @param obj The map object.
24063     * @param route The track to remove.
24064     *
24065     * @ingroup Map
24066     */
24067    EAPI void                  elm_map_track_remove(Evas_Object *obj, Evas_Object *route) EINA_ARG_NONNULL(1);
24068
24069    /**
24070     * @}
24071     */
24072
24073    /* Route */
24074    EAPI Evas_Object *elm_route_add(Evas_Object *parent);
24075 #ifdef ELM_EMAP
24076    EAPI void elm_route_emap_set(Evas_Object *obj, EMap_Route *emap);
24077 #endif
24078    EAPI double elm_route_lon_min_get(Evas_Object *obj);
24079    EAPI double elm_route_lat_min_get(Evas_Object *obj);
24080    EAPI double elm_route_lon_max_get(Evas_Object *obj);
24081    EAPI double elm_route_lat_max_get(Evas_Object *obj);
24082
24083
24084    /**
24085     * @defgroup Panel Panel
24086     *
24087     * @image html img/widget/panel/preview-00.png
24088     * @image latex img/widget/panel/preview-00.eps
24089     *
24090     * @brief A panel is a type of animated container that contains subobjects.
24091     * It can be expanded or contracted by clicking the button on it's edge.
24092     *
24093     * Orientations are as follows:
24094     * @li ELM_PANEL_ORIENT_TOP
24095     * @li ELM_PANEL_ORIENT_LEFT
24096     * @li ELM_PANEL_ORIENT_RIGHT
24097     *
24098     * Default contents parts of the panel widget that you can use for are:
24099     * @li "default" - A content of the panel
24100     *
24101     * @ref tutorial_panel shows one way to use this widget.
24102     * @{
24103     */
24104    typedef enum _Elm_Panel_Orient
24105      {
24106         ELM_PANEL_ORIENT_TOP, /**< Panel (dis)appears from the top */
24107         ELM_PANEL_ORIENT_BOTTOM, /**< Not implemented */
24108         ELM_PANEL_ORIENT_LEFT, /**< Panel (dis)appears from the left */
24109         ELM_PANEL_ORIENT_RIGHT, /**< Panel (dis)appears from the right */
24110      } Elm_Panel_Orient;
24111    /**
24112     * @brief Adds a panel object
24113     *
24114     * @param parent The parent object
24115     *
24116     * @return The panel object, or NULL on failure
24117     */
24118    EAPI Evas_Object          *elm_panel_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24119    /**
24120     * @brief Sets the orientation of the panel
24121     *
24122     * @param parent The parent object
24123     * @param orient The panel orientation. Can be one of the following:
24124     * @li ELM_PANEL_ORIENT_TOP
24125     * @li ELM_PANEL_ORIENT_LEFT
24126     * @li ELM_PANEL_ORIENT_RIGHT
24127     *
24128     * Sets from where the panel will (dis)appear.
24129     */
24130    EAPI void                  elm_panel_orient_set(Evas_Object *obj, Elm_Panel_Orient orient) EINA_ARG_NONNULL(1);
24131    /**
24132     * @brief Get the orientation of the panel.
24133     *
24134     * @param obj The panel object
24135     * @return The Elm_Panel_Orient, or ELM_PANEL_ORIENT_LEFT on failure.
24136     */
24137    EAPI Elm_Panel_Orient      elm_panel_orient_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24138    /**
24139     * @brief Set the content of the panel.
24140     *
24141     * @param obj The panel object
24142     * @param content The panel content
24143     *
24144     * Once the content object is set, a previously set one will be deleted.
24145     * If you want to keep that old content object, use the
24146     * elm_panel_content_unset() function.
24147     *
24148     * @deprecated use elm_object_content_set() instead
24149     *
24150     */
24151    WILL_DEPRECATE  EAPI void                  elm_panel_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24152    /**
24153     * @brief Get the content of the panel.
24154     *
24155     * @param obj The panel object
24156     * @return The content that is being used
24157     *
24158     * Return the content object which is set for this widget.
24159     *
24160     * @see elm_panel_content_set()
24161     * 
24162     * @deprecated use elm_object_content_get() instead
24163     *
24164     */
24165    WILL_DEPRECATE  EAPI Evas_Object          *elm_panel_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24166    /**
24167     * @brief Unset the content of the panel.
24168     *
24169     * @param obj The panel object
24170     * @return The content that was being used
24171     *
24172     * Unparent and return the content object which was set for this widget.
24173     *
24174     * @see elm_panel_content_set()
24175     *
24176     * @deprecated use elm_object_content_unset() instead
24177     *
24178     */
24179    WILL_DEPRECATE  EAPI Evas_Object          *elm_panel_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24180    /**
24181     * @brief Set the state of the panel.
24182     *
24183     * @param obj The panel object
24184     * @param hidden If true, the panel will run the animation to contract
24185     */
24186    EAPI void                  elm_panel_hidden_set(Evas_Object *obj, Eina_Bool hidden) EINA_ARG_NONNULL(1);
24187    /**
24188     * @brief Get the state of the panel.
24189     *
24190     * @param obj The panel object
24191     * @param hidden If true, the panel is in the "hide" state
24192     */
24193    EAPI Eina_Bool             elm_panel_hidden_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24194    /**
24195     * @brief Toggle the hidden state of the panel from code
24196     *
24197     * @param obj The panel object
24198     */
24199    EAPI void                  elm_panel_toggle(Evas_Object *obj) EINA_ARG_NONNULL(1);
24200    /**
24201     * @}
24202     */
24203
24204    /**
24205     * @defgroup Panes Panes
24206     * @ingroup Elementary
24207     *
24208     * @image html img/widget/panes/preview-00.png
24209     * @image latex img/widget/panes/preview-00.eps width=\textwidth
24210     *
24211     * @image html img/panes.png
24212     * @image latex img/panes.eps width=\textwidth
24213     *
24214     * The panes adds a dragable bar between two contents. When dragged
24215     * this bar will resize contents size.
24216     *
24217     * Panes can be displayed vertically or horizontally, and contents
24218     * size proportion can be customized (homogeneous by default).
24219     *
24220     * Smart callbacks one can listen to:
24221     * - "press" - The panes has been pressed (button wasn't released yet).
24222     * - "unpressed" - The panes was released after being pressed.
24223     * - "clicked" - The panes has been clicked>
24224     * - "clicked,double" - The panes has been double clicked
24225     *
24226     * Available styles for it:
24227     * - @c "default"
24228     *
24229     * Default contents parts of the panes widget that you can use for are:
24230     * @li "left" - A leftside content of the panes
24231     * @li "right" - A rightside content of the panes
24232     *
24233     * If panes is displayed vertically, left content will be displayed at
24234     * top.
24235     * 
24236     * Here is an example on its usage:
24237     * @li @ref panes_example
24238     */
24239
24240    /**
24241     * @addtogroup Panes
24242     * @{
24243     */
24244
24245    /**
24246     * Add a new panes widget to the given parent Elementary
24247     * (container) object.
24248     *
24249     * @param parent The parent object.
24250     * @return a new panes widget handle or @c NULL, on errors.
24251     *
24252     * This function inserts a new panes widget on the canvas.
24253     *
24254     * @ingroup Panes
24255     */
24256    EAPI Evas_Object          *elm_panes_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24257
24258    /**
24259     * Set the left content of the panes widget.
24260     *
24261     * @param obj The panes object.
24262     * @param content The new left content object.
24263     *
24264     * Once the content object is set, a previously set one will be deleted.
24265     * If you want to keep that old content object, use the
24266     * elm_panes_content_left_unset() function.
24267     *
24268     * If panes is displayed vertically, left content will be displayed at
24269     * top.
24270     *
24271     * @see elm_panes_content_left_get()
24272     * @see elm_panes_content_right_set() to set content on the other side.
24273     *
24274     * @deprecated use elm_object_part_content_set() instead
24275     *
24276     * @ingroup Panes
24277     */
24278    EINA_DEPRECATED EAPI void                  elm_panes_content_left_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24279
24280    /**
24281     * Set the right content of the panes widget.
24282     *
24283     * @param obj The panes object.
24284     * @param content The new right content object.
24285     *
24286     * Once the content object is set, a previously set one will be deleted.
24287     * If you want to keep that old content object, use the
24288     * elm_panes_content_right_unset() function.
24289     *
24290     * If panes is displayed vertically, left content will be displayed at
24291     * bottom.
24292     *
24293     * @see elm_panes_content_right_get()
24294     * @see elm_panes_content_left_set() to set content on the other side.
24295     *
24296     * @deprecated use elm_object_part_content_set() instead
24297     *
24298     * @ingroup Panes
24299     */
24300    EINA_DEPRECATED EAPI void                  elm_panes_content_right_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24301
24302    /**
24303     * Get the left content of the panes.
24304     *
24305     * @param obj The panes object.
24306     * @return The left content object that is being used.
24307     *
24308     * Return the left content object which is set for this widget.
24309     *
24310     * @see elm_panes_content_left_set() for details.
24311     *
24312     * @deprecated use elm_object_part_content_get() instead
24313     *
24314     * @ingroup Panes
24315     */
24316    EINA_DEPRECATED EAPI Evas_Object          *elm_panes_content_left_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24317
24318    /**
24319     * Get the right content of the panes.
24320     *
24321     * @param obj The panes object
24322     * @return The right content object that is being used
24323     *
24324     * Return the right content object which is set for this widget.
24325     *
24326     * @see elm_panes_content_right_set() for details.
24327     *
24328     * @deprecated use elm_object_part_content_get() instead
24329     *
24330     * @ingroup Panes
24331     */
24332    EINA_DEPRECATED EAPI Evas_Object          *elm_panes_content_right_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24333
24334    /**
24335     * Unset the left content used for the panes.
24336     *
24337     * @param obj The panes object.
24338     * @return The left content object that was being used.
24339     *
24340     * Unparent and return the left content object which was set for this widget.
24341     *
24342     * @see elm_panes_content_left_set() for details.
24343     * @see elm_panes_content_left_get().
24344     *
24345     * @deprecated use elm_object_part_content_unset() instead
24346     *
24347     * @ingroup Panes
24348     */
24349    EINA_DEPRECATED EAPI Evas_Object          *elm_panes_content_left_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24350
24351    /**
24352     * Unset the right content used for the panes.
24353     *
24354     * @param obj The panes object.
24355     * @return The right content object that was being used.
24356     *
24357     * Unparent and return the right content object which was set for this
24358     * widget.
24359     *
24360     * @see elm_panes_content_right_set() for details.
24361     * @see elm_panes_content_right_get().
24362     *
24363     * @deprecated use elm_object_part_content_unset() instead
24364     *
24365     * @ingroup Panes
24366     */
24367    WILL_DEPRECATE  EAPI Evas_Object          *elm_panes_content_right_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24368
24369    /**
24370     * Get the size proportion of panes widget's left side.
24371     *
24372     * @param obj The panes object.
24373     * @return float value between 0.0 and 1.0 representing size proportion
24374     * of left side.
24375     *
24376     * @see elm_panes_content_left_size_set() for more details.
24377     *
24378     * @ingroup Panes
24379     */
24380    EAPI double                elm_panes_content_left_size_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24381
24382    /**
24383     * Set the size proportion of panes widget's left side.
24384     *
24385     * @param obj The panes object.
24386     * @param size Value between 0.0 and 1.0 representing size proportion
24387     * of left side.
24388     *
24389     * By default it's homogeneous, i.e., both sides have the same size.
24390     *
24391     * If something different is required, it can be set with this function.
24392     * For example, if the left content should be displayed over
24393     * 75% of the panes size, @p size should be passed as @c 0.75.
24394     * This way, right content will be resized to 25% of panes size.
24395     *
24396     * If displayed vertically, left content is displayed at top, and
24397     * right content at bottom.
24398     *
24399     * @note This proportion will change when user drags the panes bar.
24400     *
24401     * @see elm_panes_content_left_size_get()
24402     *
24403     * @ingroup Panes
24404     */
24405    EAPI void                  elm_panes_content_left_size_set(Evas_Object *obj, double size) EINA_ARG_NONNULL(1);
24406
24407   /**
24408    * Set the orientation of a given panes widget.
24409    *
24410    * @param obj The panes object.
24411    * @param horizontal Use @c EINA_TRUE to make @p obj to be
24412    * @b horizontal, @c EINA_FALSE to make it @b vertical.
24413    *
24414    * Use this function to change how your panes is to be
24415    * disposed: vertically or horizontally.
24416    *
24417    * By default it's displayed horizontally.
24418    *
24419    * @see elm_panes_horizontal_get()
24420    *
24421    * @ingroup Panes
24422    */
24423    EAPI void                  elm_panes_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
24424
24425    /**
24426     * Retrieve the orientation of a given panes widget.
24427     *
24428     * @param obj The panes object.
24429     * @return @c EINA_TRUE, if @p obj is set to be @b horizontal,
24430     * @c EINA_FALSE if it's @b vertical (and on errors).
24431     *
24432     * @see elm_panes_horizontal_set() for more details.
24433     *
24434     * @ingroup Panes
24435     */
24436    EAPI Eina_Bool             elm_panes_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24437    EAPI void                  elm_panes_fixed_set(Evas_Object *obj, Eina_Bool fixed) EINA_ARG_NONNULL(1);
24438    EAPI Eina_Bool             elm_panes_fixed_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24439
24440    /**
24441     * @}
24442     */
24443
24444    /**
24445     * @defgroup Flip Flip
24446     *
24447     * @image html img/widget/flip/preview-00.png
24448     * @image latex img/widget/flip/preview-00.eps
24449     *
24450     * This widget holds 2 content objects(Evas_Object): one on the front and one
24451     * on the back. It allows you to flip from front to back and vice-versa using
24452     * various animations.
24453     *
24454     * If either the front or back contents are not set the flip will treat that
24455     * as transparent. So if you wore to set the front content but not the back,
24456     * and then call elm_flip_go() you would see whatever is below the flip.
24457     *
24458     * For a list of supported animations see elm_flip_go().
24459     *
24460     * Signals that you can add callbacks for are:
24461     * "animate,begin" - when a flip animation was started
24462     * "animate,done" - when a flip animation is finished
24463     *
24464     * @ref tutorial_flip show how to use most of the API.
24465     *
24466     * @{
24467     */
24468    typedef enum _Elm_Flip_Mode
24469      {
24470         ELM_FLIP_ROTATE_Y_CENTER_AXIS,
24471         ELM_FLIP_ROTATE_X_CENTER_AXIS,
24472         ELM_FLIP_ROTATE_XZ_CENTER_AXIS,
24473         ELM_FLIP_ROTATE_YZ_CENTER_AXIS,
24474         ELM_FLIP_CUBE_LEFT,
24475         ELM_FLIP_CUBE_RIGHT,
24476         ELM_FLIP_CUBE_UP,
24477         ELM_FLIP_CUBE_DOWN,
24478         ELM_FLIP_PAGE_LEFT,
24479         ELM_FLIP_PAGE_RIGHT,
24480         ELM_FLIP_PAGE_UP,
24481         ELM_FLIP_PAGE_DOWN
24482      } Elm_Flip_Mode;
24483    typedef enum _Elm_Flip_Interaction
24484      {
24485         ELM_FLIP_INTERACTION_NONE,
24486         ELM_FLIP_INTERACTION_ROTATE,
24487         ELM_FLIP_INTERACTION_CUBE,
24488         ELM_FLIP_INTERACTION_PAGE
24489      } Elm_Flip_Interaction;
24490    typedef enum _Elm_Flip_Direction
24491      {
24492         ELM_FLIP_DIRECTION_UP, /**< Allows interaction with the top of the widget */
24493         ELM_FLIP_DIRECTION_DOWN, /**< Allows interaction with the bottom of the widget */
24494         ELM_FLIP_DIRECTION_LEFT, /**< Allows interaction with the left portion of the widget */
24495         ELM_FLIP_DIRECTION_RIGHT /**< Allows interaction with the right portion of the widget */
24496      } Elm_Flip_Direction;
24497    /**
24498     * @brief Add a new flip to the parent
24499     *
24500     * @param parent The parent object
24501     * @return The new object or NULL if it cannot be created
24502     */
24503    EAPI Evas_Object *elm_flip_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24504    /**
24505     * @brief Set the front content of the flip widget.
24506     *
24507     * @param obj The flip object
24508     * @param content The new front content object
24509     *
24510     * Once the content object is set, a previously set one will be deleted.
24511     * If you want to keep that old content object, use the
24512     * elm_flip_content_front_unset() function.
24513     */
24514    EAPI void         elm_flip_content_front_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24515    /**
24516     * @brief Set the back content of the flip widget.
24517     *
24518     * @param obj The flip object
24519     * @param content The new back content object
24520     *
24521     * Once the content object is set, a previously set one will be deleted.
24522     * If you want to keep that old content object, use the
24523     * elm_flip_content_back_unset() function.
24524     */
24525    EAPI void         elm_flip_content_back_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24526    /**
24527     * @brief Get the front content used for the flip
24528     *
24529     * @param obj The flip object
24530     * @return The front content object that is being used
24531     *
24532     * Return the front content object which is set for this widget.
24533     */
24534    EAPI Evas_Object *elm_flip_content_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24535    /**
24536     * @brief Get the back content used for the flip
24537     *
24538     * @param obj The flip object
24539     * @return The back content object that is being used
24540     *
24541     * Return the back content object which is set for this widget.
24542     */
24543    EAPI Evas_Object *elm_flip_content_back_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24544    /**
24545     * @brief Unset the front content used for the flip
24546     *
24547     * @param obj The flip object
24548     * @return The front content object that was being used
24549     *
24550     * Unparent and return the front content object which was set for this widget.
24551     */
24552    EAPI Evas_Object *elm_flip_content_front_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24553    /**
24554     * @brief Unset the back content used for the flip
24555     *
24556     * @param obj The flip object
24557     * @return The back content object that was being used
24558     *
24559     * Unparent and return the back content object which was set for this widget.
24560     */
24561    EAPI Evas_Object *elm_flip_content_back_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24562    /**
24563     * @brief Get flip front visibility state
24564     *
24565     * @param obj The flip objct
24566     * @return EINA_TRUE if front front is showing, EINA_FALSE if the back is
24567     * showing.
24568     */
24569    EAPI Eina_Bool    elm_flip_front_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24570    /**
24571     * @brief Set flip perspective
24572     *
24573     * @param obj The flip object
24574     * @param foc The coordinate to set the focus on
24575     * @param x The X coordinate
24576     * @param y The Y coordinate
24577     *
24578     * @warning This function currently does nothing.
24579     */
24580    EAPI void         elm_flip_perspective_set(Evas_Object *obj, Evas_Coord foc, Evas_Coord x, Evas_Coord y) EINA_ARG_NONNULL(1);
24581    /**
24582     * @brief Runs the flip animation
24583     *
24584     * @param obj The flip object
24585     * @param mode The mode type
24586     *
24587     * Flips the front and back contents using the @p mode animation. This
24588     * efectively hides the currently visible content and shows the hidden one.
24589     *
24590     * There a number of possible animations to use for the flipping:
24591     * @li ELM_FLIP_ROTATE_X_CENTER_AXIS - Rotate the currently visible content
24592     * around a horizontal axis in the middle of its height, the other content
24593     * is shown as the other side of the flip.
24594     * @li ELM_FLIP_ROTATE_Y_CENTER_AXIS - Rotate the currently visible content
24595     * around a vertical axis in the middle of its width, the other content is
24596     * shown as the other side of the flip.
24597     * @li ELM_FLIP_ROTATE_XZ_CENTER_AXIS - Rotate the currently visible content
24598     * around a diagonal axis in the middle of its width, the other content is
24599     * shown as the other side of the flip.
24600     * @li ELM_FLIP_ROTATE_YZ_CENTER_AXIS - Rotate the currently visible content
24601     * around a diagonal axis in the middle of its height, the other content is
24602     * shown as the other side of the flip.
24603     * @li ELM_FLIP_CUBE_LEFT - Rotate the currently visible content to the left
24604     * as if the flip was a cube, the other content is show as the right face of
24605     * the cube.
24606     * @li ELM_FLIP_CUBE_RIGHT - Rotate the currently visible content to the
24607     * right as if the flip was a cube, the other content is show as the left
24608     * face of the cube.
24609     * @li ELM_FLIP_CUBE_UP - Rotate the currently visible content up as if the
24610     * flip was a cube, the other content is show as the bottom face of the cube.
24611     * @li ELM_FLIP_CUBE_DOWN - Rotate the currently visible content down as if
24612     * the flip was a cube, the other content is show as the upper face of the
24613     * cube.
24614     * @li ELM_FLIP_PAGE_LEFT - Move the currently visible content to the left as
24615     * if the flip was a book, the other content is shown as the page below that.
24616     * @li ELM_FLIP_PAGE_RIGHT - Move the currently visible content to the right
24617     * as if the flip was a book, the other content is shown as the page below
24618     * that.
24619     * @li ELM_FLIP_PAGE_UP - Move the currently visible content up as if the
24620     * flip was a book, the other content is shown as the page below that.
24621     * @li ELM_FLIP_PAGE_DOWN - Move the currently visible content down as if the
24622     * flip was a book, the other content is shown as the page below that.
24623     *
24624     * @image html elm_flip.png
24625     * @image latex elm_flip.eps width=\textwidth
24626     */
24627    EAPI void         elm_flip_go(Evas_Object *obj, Elm_Flip_Mode mode) EINA_ARG_NONNULL(1);
24628    /**
24629     * @brief Set the interactive flip mode
24630     *
24631     * @param obj The flip object
24632     * @param mode The interactive flip mode to use
24633     *
24634     * This sets if the flip should be interactive (allow user to click and
24635     * drag a side of the flip to reveal the back page and cause it to flip).
24636     * By default a flip is not interactive. You may also need to set which
24637     * sides of the flip are "active" for flipping and how much space they use
24638     * (a minimum of a finger size) with elm_flip_interacton_direction_enabled_set()
24639     * and elm_flip_interacton_direction_hitsize_set()
24640     *
24641     * The four avilable mode of interaction are:
24642     * @li ELM_FLIP_INTERACTION_NONE - No interaction is allowed
24643     * @li ELM_FLIP_INTERACTION_ROTATE - Interaction will cause rotate animation
24644     * @li ELM_FLIP_INTERACTION_CUBE - Interaction will cause cube animation
24645     * @li ELM_FLIP_INTERACTION_PAGE - Interaction will cause page animation
24646     *
24647     * @note ELM_FLIP_INTERACTION_ROTATE won't cause
24648     * ELM_FLIP_ROTATE_XZ_CENTER_AXIS or ELM_FLIP_ROTATE_YZ_CENTER_AXIS to
24649     * happen, those can only be acheived with elm_flip_go();
24650     */
24651    EAPI void         elm_flip_interaction_set(Evas_Object *obj, Elm_Flip_Interaction mode);
24652    /**
24653     * @brief Get the interactive flip mode
24654     *
24655     * @param obj The flip object
24656     * @return The interactive flip mode
24657     *
24658     * Returns the interactive flip mode set by elm_flip_interaction_set()
24659     */
24660    EAPI Elm_Flip_Interaction elm_flip_interaction_get(const Evas_Object *obj);
24661    /**
24662     * @brief Set which directions of the flip respond to interactive flip
24663     *
24664     * @param obj The flip object
24665     * @param dir The direction to change
24666     * @param enabled If that direction is enabled or not
24667     *
24668     * By default all directions are disabled, so you may want to enable the
24669     * desired directions for flipping if you need interactive flipping. You must
24670     * call this function once for each direction that should be enabled.
24671     *
24672     * @see elm_flip_interaction_set()
24673     */
24674    EAPI void         elm_flip_interacton_direction_enabled_set(Evas_Object *obj, Elm_Flip_Direction dir, Eina_Bool enabled);
24675    /**
24676     * @brief Get the enabled state of that flip direction
24677     *
24678     * @param obj The flip object
24679     * @param dir The direction to check
24680     * @return If that direction is enabled or not
24681     *
24682     * Gets the enabled state set by elm_flip_interacton_direction_enabled_set()
24683     *
24684     * @see elm_flip_interaction_set()
24685     */
24686    EAPI Eina_Bool    elm_flip_interacton_direction_enabled_get(Evas_Object *obj, Elm_Flip_Direction dir);
24687    /**
24688     * @brief Set the amount of the flip that is sensitive to interactive flip
24689     *
24690     * @param obj The flip object
24691     * @param dir The direction to modify
24692     * @param hitsize The amount of that dimension (0.0 to 1.0) to use
24693     *
24694     * Set the amount of the flip that is sensitive to interactive flip, with 0
24695     * representing no area in the flip and 1 representing the entire flip. There
24696     * is however a consideration to be made in that the area will never be
24697     * smaller than the finger size set(as set in your Elementary configuration).
24698     *
24699     * @see elm_flip_interaction_set()
24700     */
24701    EAPI void         elm_flip_interacton_direction_hitsize_set(Evas_Object *obj, Elm_Flip_Direction dir, double hitsize);
24702    /**
24703     * @brief Get the amount of the flip that is sensitive to interactive flip
24704     *
24705     * @param obj The flip object
24706     * @param dir The direction to check
24707     * @return The size set for that direction
24708     *
24709     * Returns the amount os sensitive area set by
24710     * elm_flip_interacton_direction_hitsize_set().
24711     */
24712    EAPI double       elm_flip_interacton_direction_hitsize_get(Evas_Object *obj, Elm_Flip_Direction dir);
24713    /**
24714     * @}
24715     */
24716
24717    /* scrolledentry */
24718    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24719    EINA_DEPRECATED EAPI void         elm_scrolled_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line) EINA_ARG_NONNULL(1);
24720    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_single_line_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24721    EINA_DEPRECATED EAPI void         elm_scrolled_entry_password_set(Evas_Object *obj, Eina_Bool password) EINA_ARG_NONNULL(1);
24722    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_password_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24723    EINA_DEPRECATED EAPI void         elm_scrolled_entry_entry_set(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
24724    EINA_DEPRECATED EAPI const char  *elm_scrolled_entry_entry_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24725    EINA_DEPRECATED EAPI void         elm_scrolled_entry_entry_append(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
24726    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_is_empty(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24727    EINA_DEPRECATED EAPI const char  *elm_scrolled_entry_selection_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24728    EINA_DEPRECATED EAPI void         elm_scrolled_entry_entry_insert(Evas_Object *obj, const char *entry) EINA_ARG_NONNULL(1);
24729    EINA_DEPRECATED EAPI void         elm_scrolled_entry_line_wrap_set(Evas_Object *obj, Elm_Wrap_Type wrap) EINA_ARG_NONNULL(1);
24730    EINA_DEPRECATED EAPI void         elm_scrolled_entry_editable_set(Evas_Object *obj, Eina_Bool editable) EINA_ARG_NONNULL(1);
24731    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_editable_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24732    EINA_DEPRECATED EAPI void         elm_scrolled_entry_select_none(Evas_Object *obj) EINA_ARG_NONNULL(1);
24733    EINA_DEPRECATED EAPI void         elm_scrolled_entry_select_all(Evas_Object *obj) EINA_ARG_NONNULL(1);
24734    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
24735    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
24736    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_up(Evas_Object *obj) EINA_ARG_NONNULL(1);
24737    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_down(Evas_Object *obj) EINA_ARG_NONNULL(1);
24738    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24739    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24740    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_line_begin_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24741    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_line_end_set(Evas_Object *obj) EINA_ARG_NONNULL(1);
24742    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_selection_begin(Evas_Object *obj) EINA_ARG_NONNULL(1);
24743    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_selection_end(Evas_Object *obj) EINA_ARG_NONNULL(1);
24744    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_is_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24745    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cursor_is_visible_format_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24746    EINA_DEPRECATED EAPI const char  *elm_scrolled_entry_cursor_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24747    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cursor_pos_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
24748    EINA_DEPRECATED EAPI int          elm_scrolled_entry_cursor_pos_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24749    EINA_DEPRECATED EAPI void         elm_scrolled_entry_selection_cut(Evas_Object *obj) EINA_ARG_NONNULL(1);
24750    EINA_DEPRECATED EAPI void         elm_scrolled_entry_selection_copy(Evas_Object *obj) EINA_ARG_NONNULL(1);
24751    EINA_DEPRECATED EAPI void         elm_scrolled_entry_selection_paste(Evas_Object *obj) EINA_ARG_NONNULL(1);
24752    EINA_DEPRECATED EAPI void         elm_scrolled_entry_context_menu_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
24753    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);
24754    EINA_DEPRECATED EAPI void         elm_scrolled_entry_context_menu_disabled_set(Evas_Object *obj, Eina_Bool disabled) EINA_ARG_NONNULL(1);
24755    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_context_menu_disabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24756    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);
24757    EINA_DEPRECATED EAPI void         elm_scrolled_entry_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
24758    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);
24759    EINA_DEPRECATED EAPI void         elm_scrolled_entry_icon_set(Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1, 2);
24760    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24761    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_icon_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24762    EINA_DEPRECATED EAPI void         elm_scrolled_entry_icon_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
24763    EINA_DEPRECATED EAPI void         elm_scrolled_entry_end_set(Evas_Object *obj, Evas_Object *end) EINA_ARG_NONNULL(1, 2);
24764    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24765    EINA_DEPRECATED EAPI Evas_Object *elm_scrolled_entry_end_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24766    EINA_DEPRECATED EAPI void         elm_scrolled_entry_end_visible_set(Evas_Object *obj, Eina_Bool setting) EINA_ARG_NONNULL(1);
24767    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);
24768    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);
24769    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);
24770    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);
24771    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);
24772    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);
24773    EINA_DEPRECATED EAPI void         elm_scrolled_entry_file_set(Evas_Object *obj, const char *file, Elm_Text_Format format) EINA_ARG_NONNULL(1);
24774    EINA_DEPRECATED EAPI void         elm_scrolled_entry_file_get(const Evas_Object *obj, const char **file, Elm_Text_Format *format) EINA_ARG_NONNULL(1);
24775    EINA_DEPRECATED EAPI void         elm_scrolled_entry_file_save(Evas_Object *obj) EINA_ARG_NONNULL(1);
24776    EINA_DEPRECATED EAPI void         elm_scrolled_entry_autosave_set(Evas_Object *obj, Eina_Bool autosave) EINA_ARG_NONNULL(1);
24777    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_autosave_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24778    EINA_DEPRECATED EAPI void         elm_scrolled_entry_cnp_textonly_set(Evas_Object *obj, Eina_Bool textonly) EINA_ARG_NONNULL(1);
24779    EINA_DEPRECATED EAPI Eina_Bool    elm_scrolled_entry_cnp_textonly_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
24780    EINA_DEPRECATED EAPI void         elm_scrolled_entry_line_char_wrap_set(Evas_Object *obj, Eina_Bool wrap) EINA_ARG_NONNULL(1);
24781    EINA_DEPRECATED EAPI void         elm_scrolled_entry_input_panel_enabled_set(Evas_Object *obj, Eina_Bool enabled);
24782    EINA_DEPRECATED EAPI void         elm_scrolled_entry_input_panel_layout_set(Evas_Object *obj, Elm_Input_Panel_Layout layout);
24783    EINA_DEPRECATED EAPI Ecore_IMF_Context *elm_scrolled_entry_imf_context_get(Evas_Object *obj);
24784    EINA_DEPRECATED EAPI void         elm_scrolled_entry_autocapitalization_set(Evas_Object *obj, Eina_Bool autocap);
24785    EINA_DEPRECATED EAPI void         elm_scrolled_entry_autoperiod_set(Evas_Object *obj, Eina_Bool autoperiod);
24786
24787    /**
24788     * @defgroup Conformant Conformant
24789     * @ingroup Elementary
24790     *
24791     * @image html img/widget/conformant/preview-00.png
24792     * @image latex img/widget/conformant/preview-00.eps width=\textwidth
24793     *
24794     * @image html img/conformant.png
24795     * @image latex img/conformant.eps width=\textwidth
24796     *
24797     * The aim is to provide a widget that can be used in elementary apps to
24798     * account for space taken up by the indicator, virtual keypad & softkey
24799     * windows when running the illume2 module of E17.
24800     *
24801     * So conformant content will be sized and positioned considering the
24802     * space required for such stuff, and when they popup, as a keyboard
24803     * shows when an entry is selected, conformant content won't change.
24804     *
24805     * Available styles for it:
24806     * - @c "default"
24807     *
24808     * Default contents parts of the conformant widget that you can use for are:
24809     * @li "default" - A content of the conformant
24810     *
24811     * See how to use this widget in this example:
24812     * @ref conformant_example
24813     */
24814
24815    /**
24816     * @addtogroup Conformant
24817     * @{
24818     */
24819
24820    /**
24821     * Add a new conformant widget to the given parent Elementary
24822     * (container) object.
24823     *
24824     * @param parent The parent object.
24825     * @return A new conformant widget handle or @c NULL, on errors.
24826     *
24827     * This function inserts a new conformant widget on the canvas.
24828     *
24829     * @ingroup Conformant
24830     */
24831    EAPI Evas_Object *elm_conformant_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24832
24833    /**
24834     * Set the content of the conformant widget.
24835     *
24836     * @param obj The conformant object.
24837     * @param content The content to be displayed by the conformant.
24838     *
24839     * Content will be sized and positioned considering the space required
24840     * to display a virtual keyboard. So it won't fill all the conformant
24841     * size. This way is possible to be sure that content won't resize
24842     * or be re-positioned after the keyboard is displayed.
24843     *
24844     * Once the content object is set, a previously set one will be deleted.
24845     * If you want to keep that old content object, use the
24846     * elm_object_content_unset() function.
24847     *
24848     * @see elm_object_content_unset()
24849     * @see elm_object_content_get()
24850     *
24851     * @deprecated use elm_object_content_set() instead
24852     *
24853     * @ingroup Conformant
24854     */
24855    WILL_DEPRECATE  EAPI void         elm_conformant_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24856
24857    /**
24858     * Get the content of the conformant widget.
24859     *
24860     * @param obj The conformant object.
24861     * @return The content that is being used.
24862     *
24863     * Return the content object which is set for this widget.
24864     * It won't be unparent from conformant. For that, use
24865     * elm_object_content_unset().
24866     *
24867     * @see elm_object_content_set().
24868     * @see elm_object_content_unset()
24869     *
24870     * @deprecated use elm_object_content_get() instead
24871     *
24872     * @ingroup Conformant
24873     */
24874    WILL_DEPRECATE  EAPI Evas_Object *elm_conformant_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24875
24876    /**
24877     * Unset the content of the conformant widget.
24878     *
24879     * @param obj The conformant object.
24880     * @return The content that was being used.
24881     *
24882     * Unparent and return the content object which was set for this widget.
24883     *
24884     * @see elm_object_content_set().
24885     *
24886     * @deprecated use elm_object_content_unset() instead
24887     *
24888     * @ingroup Conformant
24889     */
24890    EINA_DEPRECATED EAPI Evas_Object *elm_conformant_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24891
24892    /**
24893     * Returns the Evas_Object that represents the content area.
24894     *
24895     * @param obj The conformant object.
24896     * @return The content area of the widget.
24897     *
24898     * @ingroup Conformant
24899     */
24900    EAPI Evas_Object *elm_conformant_content_area_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24901
24902    /**
24903     * @}
24904     */
24905
24906    /**
24907     * @defgroup Mapbuf Mapbuf
24908     * @ingroup Elementary
24909     *
24910     * @image html img/widget/mapbuf/preview-00.png
24911     * @image latex img/widget/mapbuf/preview-00.eps width=\textwidth
24912     *
24913     * This holds one content object and uses an Evas Map of transformation
24914     * points to be later used with this content. So the content will be
24915     * moved, resized, etc as a single image. So it will improve performance
24916     * when you have a complex interafce, with a lot of elements, and will
24917     * need to resize or move it frequently (the content object and its
24918     * children).
24919     *
24920     * Default contents parts of the mapbuf widget that you can use for are:
24921     * @li "default" - A content of the mapbuf
24922     *
24923     * To enable map, elm_mapbuf_enabled_set() should be used.
24924     * 
24925     * See how to use this widget in this example:
24926     * @ref mapbuf_example
24927     */
24928
24929    /**
24930     * @addtogroup Mapbuf
24931     * @{
24932     */
24933
24934    /**
24935     * Add a new mapbuf widget to the given parent Elementary
24936     * (container) object.
24937     *
24938     * @param parent The parent object.
24939     * @return A new mapbuf widget handle or @c NULL, on errors.
24940     *
24941     * This function inserts a new mapbuf widget on the canvas.
24942     *
24943     * @ingroup Mapbuf
24944     */
24945    EAPI Evas_Object *elm_mapbuf_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
24946
24947    /**
24948     * Set the content of the mapbuf.
24949     *
24950     * @param obj The mapbuf object.
24951     * @param content The content that will be filled in this mapbuf object.
24952     *
24953     * Once the content object is set, a previously set one will be deleted.
24954     * If you want to keep that old content object, use the
24955     * elm_mapbuf_content_unset() function.
24956     *
24957     * To enable map, elm_mapbuf_enabled_set() should be used.
24958     *
24959     * @deprecated use elm_object_content_set() instead
24960     *
24961     * @ingroup Mapbuf
24962     */
24963    WILL_DEPRECATE  EAPI void         elm_mapbuf_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1);
24964
24965    /**
24966     * Get the content of the mapbuf.
24967     *
24968     * @param obj The mapbuf object.
24969     * @return The content that is being used.
24970     *
24971     * Return the content object which is set for this widget.
24972     *
24973     * @see elm_mapbuf_content_set() for details.
24974     *
24975     * @deprecated use elm_object_content_get() instead
24976     *
24977     * @ingroup Mapbuf
24978     */
24979    WILL_DEPRECATE  EAPI Evas_Object *elm_mapbuf_content_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
24980
24981    /**
24982     * Unset the content of the mapbuf.
24983     *
24984     * @param obj The mapbuf object.
24985     * @return The content that was being used.
24986     *
24987     * Unparent and return the content object which was set for this widget.
24988     *
24989     * @see elm_mapbuf_content_set() for details.
24990     *
24991     * @deprecated use elm_object_content_unset() instead
24992     *
24993     * @ingroup Mapbuf
24994     */
24995    WILL_DEPRECATE  EAPI Evas_Object *elm_mapbuf_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
24996
24997    /**
24998     * Enable or disable the map.
24999     *
25000     * @param obj The mapbuf object.
25001     * @param enabled @c EINA_TRUE to enable map or @c EINA_FALSE to disable it.
25002     *
25003     * This enables the map that is set or disables it. On enable, the object
25004     * geometry will be saved, and the new geometry will change (position and
25005     * size) to reflect the map geometry set.
25006     *
25007     * Also, when enabled, alpha and smooth states will be used, so if the
25008     * content isn't solid, alpha should be enabled, for example, otherwise
25009     * a black retangle will fill the content.
25010     *
25011     * When disabled, the stored map will be freed and geometry prior to
25012     * enabling the map will be restored.
25013     *
25014     * It's disabled by default.
25015     *
25016     * @see elm_mapbuf_alpha_set()
25017     * @see elm_mapbuf_smooth_set()
25018     *
25019     * @ingroup Mapbuf
25020     */
25021    EAPI void         elm_mapbuf_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
25022
25023    /**
25024     * Get a value whether map is enabled or not.
25025     *
25026     * @param obj The mapbuf object.
25027     * @return @c EINA_TRUE means map is enabled. @c EINA_FALSE indicates
25028     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
25029     *
25030     * @see elm_mapbuf_enabled_set() for details.
25031     *
25032     * @ingroup Mapbuf
25033     */
25034    EAPI Eina_Bool    elm_mapbuf_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25035
25036    /**
25037     * Enable or disable smooth map rendering.
25038     *
25039     * @param obj The mapbuf object.
25040     * @param smooth @c EINA_TRUE to enable smooth map rendering or @c EINA_FALSE
25041     * to disable it.
25042     *
25043     * This sets smoothing for map rendering. If the object is a type that has
25044     * its own smoothing settings, then both the smooth settings for this object
25045     * and the map must be turned off.
25046     *
25047     * By default smooth maps are enabled.
25048     *
25049     * @ingroup Mapbuf
25050     */
25051    EAPI void         elm_mapbuf_smooth_set(Evas_Object *obj, Eina_Bool smooth) EINA_ARG_NONNULL(1);
25052
25053    /**
25054     * Get a value whether smooth map rendering is enabled or not.
25055     *
25056     * @param obj The mapbuf object.
25057     * @return @c EINA_TRUE means smooth map rendering is enabled. @c EINA_FALSE
25058     * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
25059     *
25060     * @see elm_mapbuf_smooth_set() for details.
25061     *
25062     * @ingroup Mapbuf
25063     */
25064    EAPI Eina_Bool    elm_mapbuf_smooth_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25065
25066    /**
25067     * Set or unset alpha flag for map rendering.
25068     *
25069     * @param obj The mapbuf object.
25070     * @param alpha @c EINA_TRUE to enable alpha blending or @c EINA_FALSE
25071     * to disable it.
25072     *
25073     * This sets alpha flag for map rendering. If the object is a type that has
25074     * its own alpha settings, then this will take precedence. Only image objects
25075     * have this currently. It stops alpha blending of the map area, and is
25076     * useful if you know the object and/or all sub-objects is 100% solid.
25077     *
25078     * Alpha is enabled by default.
25079     *
25080     * @ingroup Mapbuf
25081     */
25082    EAPI void         elm_mapbuf_alpha_set(Evas_Object *obj, Eina_Bool alpha) EINA_ARG_NONNULL(1);
25083
25084    /**
25085     * Get a value whether alpha blending is enabled or not.
25086     *
25087     * @param obj The mapbuf object.
25088     * @return @c EINA_TRUE means alpha blending is enabled. @c EINA_FALSE
25089     * indicates it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
25090     *
25091     * @see elm_mapbuf_alpha_set() for details.
25092     *
25093     * @ingroup Mapbuf
25094     */
25095    EAPI Eina_Bool    elm_mapbuf_alpha_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25096
25097    /**
25098     * @}
25099     */
25100
25101    /**
25102     * @defgroup Flipselector Flip Selector
25103     *
25104     * @image html img/widget/flipselector/preview-00.png
25105     * @image latex img/widget/flipselector/preview-00.eps
25106     *
25107     * A flip selector is a widget to show a set of @b text items, one
25108     * at a time, with the same sheet switching style as the @ref Clock
25109     * "clock" widget, when one changes the current displaying sheet
25110     * (thus, the "flip" in the name).
25111     *
25112     * User clicks to flip sheets which are @b held for some time will
25113     * make the flip selector to flip continuosly and automatically for
25114     * the user. The interval between flips will keep growing in time,
25115     * so that it helps the user to reach an item which is distant from
25116     * the current selection.
25117     *
25118     * Smart callbacks one can register to:
25119     * - @c "selected" - when the widget's selected text item is changed
25120     * - @c "overflowed" - when the widget's current selection is changed
25121     *   from the first item in its list to the last
25122     * - @c "underflowed" - when the widget's current selection is changed
25123     *   from the last item in its list to the first
25124     *
25125     * Available styles for it:
25126     * - @c "default"
25127     *
25128          * To set/get the label of the flipselector item, you can use
25129          * elm_object_item_text_set/get APIs.
25130          * Once the text is set, a previously set one will be deleted.
25131          * 
25132     * Here is an example on its usage:
25133     * @li @ref flipselector_example
25134     */
25135
25136    /**
25137     * @addtogroup Flipselector
25138     * @{
25139     */
25140
25141    /**
25142     * Add a new flip selector widget to the given parent Elementary
25143     * (container) widget
25144     *
25145     * @param parent The parent object
25146     * @return a new flip selector widget handle or @c NULL, on errors
25147     *
25148     * This function inserts a new flip selector widget on the canvas.
25149     *
25150     * @ingroup Flipselector
25151     */
25152    EAPI Evas_Object               *elm_flipselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25153
25154    /**
25155     * Programmatically select the next item of a flip selector widget
25156     *
25157     * @param obj The flipselector object
25158     *
25159     * @note The selection will be animated. Also, if it reaches the
25160     * end of its list of member items, it will continue with the first
25161     * one onwards.
25162     *
25163     * @ingroup Flipselector
25164     */
25165    EAPI void                       elm_flipselector_flip_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
25166
25167    /**
25168     * Programmatically select the previous item of a flip selector
25169     * widget
25170     *
25171     * @param obj The flipselector object
25172     *
25173     * @note The selection will be animated.  Also, if it reaches the
25174     * beginning of its list of member items, it will continue with the
25175     * last one backwards.
25176     *
25177     * @ingroup Flipselector
25178     */
25179    EAPI void                       elm_flipselector_flip_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
25180
25181    /**
25182     * Append a (text) item to a flip selector widget
25183     *
25184     * @param obj The flipselector object
25185     * @param label The (text) label of the new item
25186     * @param func Convenience callback function to take place when
25187     * item is selected
25188     * @param data Data passed to @p func, above
25189     * @return A handle to the item added or @c NULL, on errors
25190     *
25191     * The widget's list of labels to show will be appended with the
25192     * given value. If the user wishes so, a callback function pointer
25193     * can be passed, which will get called when this same item is
25194     * selected.
25195     *
25196     * @note The current selection @b won't be modified by appending an
25197     * element to the list.
25198     *
25199     * @note The maximum length of the text label is going to be
25200     * determined <b>by the widget's theme</b>. Strings larger than
25201     * that value are going to be @b truncated.
25202     *
25203     * @ingroup Flipselector
25204     */
25205    EAPI Elm_Object_Item     *elm_flipselector_item_append(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
25206
25207    /**
25208     * Prepend a (text) item to a flip selector widget
25209     *
25210     * @param obj The flipselector object
25211     * @param label The (text) label of the new item
25212     * @param func Convenience callback function to take place when
25213     * item is selected
25214     * @param data Data passed to @p func, above
25215     * @return A handle to the item added or @c NULL, on errors
25216     *
25217     * The widget's list of labels to show will be prepended with the
25218     * given value. If the user wishes so, a callback function pointer
25219     * can be passed, which will get called when this same item is
25220     * selected.
25221     *
25222     * @note The current selection @b won't be modified by prepending
25223     * an element to the list.
25224     *
25225     * @note The maximum length of the text label is going to be
25226     * determined <b>by the widget's theme</b>. Strings larger than
25227     * that value are going to be @b truncated.
25228     *
25229     * @ingroup Flipselector
25230     */
25231    EAPI Elm_Object_Item     *elm_flipselector_item_prepend(Evas_Object *obj, const char *label, Evas_Smart_Cb func, void *data) EINA_ARG_NONNULL(1);
25232
25233    /**
25234     * Get the internal list of items in a given flip selector widget.
25235     *
25236     * @param obj The flipselector object
25237     * @return The list of items (#Elm_Object_Item as data) or
25238     * @c NULL on errors.
25239     *
25240     * This list is @b not to be modified in any way and must not be
25241     * freed. Use the list members with functions like
25242     * elm_object_item_text_set(),
25243     * elm_object_item_text_get(),
25244     * elm_flipselector_item_del(),
25245     * elm_flipselector_item_selected_get(),
25246     * elm_flipselector_item_selected_set().
25247     *
25248     * @warning This list is only valid until @p obj object's internal
25249     * items list is changed. It should be fetched again with another
25250     * call to this function when changes happen.
25251     *
25252     * @ingroup Flipselector
25253     */
25254    EAPI const Eina_List           *elm_flipselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25255
25256    /**
25257     * Get the first item in the given flip selector widget's list of
25258     * items.
25259     *
25260     * @param obj The flipselector object
25261     * @return The first item or @c NULL, if it has no items (and on
25262     * errors)
25263     *
25264     * @see elm_flipselector_item_append()
25265     * @see elm_flipselector_last_item_get()
25266     *
25267     * @ingroup Flipselector
25268     */
25269    EAPI Elm_Object_Item     *elm_flipselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25270
25271    /**
25272     * Get the last item in the given flip selector widget's list of
25273     * items.
25274     *
25275     * @param obj The flipselector object
25276     * @return The last item or @c NULL, if it has no items (and on
25277     * errors)
25278     *
25279     * @see elm_flipselector_item_prepend()
25280     * @see elm_flipselector_first_item_get()
25281     *
25282     * @ingroup Flipselector
25283     */
25284    EAPI Elm_Object_Item     *elm_flipselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25285
25286    /**
25287     * Get the currently selected item in a flip selector widget.
25288     *
25289     * @param obj The flipselector object
25290     * @return The selected item or @c NULL, if the widget has no items
25291     * (and on erros)
25292     *
25293     * @ingroup Flipselector
25294     */
25295    EAPI Elm_Object_Item     *elm_flipselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25296
25297    /**
25298     * Set whether a given flip selector widget's item should be the
25299     * currently selected one.
25300     *
25301     * @param it The flip selector item
25302     * @param selected @c EINA_TRUE to select it, @c EINA_FALSE to unselect.
25303     *
25304     * This sets whether @p item is or not the selected (thus, under
25305     * display) one. If @p item is different than one under display,
25306     * the latter will be unselected. If the @p item is set to be
25307     * unselected, on the other hand, the @b first item in the widget's
25308     * internal members list will be the new selected one.
25309     *
25310     * @see elm_flipselector_item_selected_get()
25311     *
25312     * @ingroup Flipselector
25313     */
25314    EAPI void                       elm_flipselector_item_selected_set(Elm_Object_Item *it, Eina_Bool selected) EINA_ARG_NONNULL(1);
25315
25316    /**
25317     * Get whether a given flip selector widget's item is the currently
25318     * selected one.
25319     *
25320     * @param it The flip selector item
25321     * @return @c EINA_TRUE, if it's selected, @c EINA_FALSE otherwise
25322     * (or on errors).
25323     *
25324     * @see elm_flipselector_item_selected_set()
25325     *
25326     * @ingroup Flipselector
25327     */
25328    EAPI Eina_Bool                  elm_flipselector_item_selected_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
25329
25330    /**
25331     * Delete a given item from a flip selector widget.
25332     *
25333     * @param it The item to delete
25334     *
25335     * @ingroup Flipselector
25336     */
25337    EAPI void                       elm_flipselector_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
25338
25339    /**
25340     * Get the label of a given flip selector widget's item.
25341     *
25342     * @param it The item to get label from
25343     * @return The text label of @p item or @c NULL, on errors
25344     *
25345     * @see elm_object_item_text_set()
25346     *
25347     * @deprecated see elm_object_item_text_get() instead
25348     * @ingroup Flipselector
25349     */
25350    EINA_DEPRECATED EAPI const char                *elm_flipselector_item_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
25351
25352    /**
25353     * Set the label of a given flip selector widget's item.
25354     *
25355     * @param it The item to set label on
25356     * @param label The text label string, in UTF-8 encoding
25357     *
25358     * @see elm_object_item_text_get()
25359     *
25360          * @deprecated see elm_object_item_text_set() instead
25361     * @ingroup Flipselector
25362     */
25363    EINA_DEPRECATED EAPI void                       elm_flipselector_item_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
25364
25365    /**
25366     * Gets the item before @p item in a flip selector widget's
25367     * internal list of items.
25368     *
25369     * @param it The item to fetch previous from
25370     * @return The item before the @p item, in its parent's list. If
25371     *         there is no previous item for @p item or there's an
25372     *         error, @c NULL is returned.
25373     *
25374     * @see elm_flipselector_item_next_get()
25375     *
25376     * @ingroup Flipselector
25377     */
25378    EAPI Elm_Object_Item     *elm_flipselector_item_prev_get(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
25379
25380    /**
25381     * Gets the item after @p item in a flip selector widget's
25382     * internal list of items.
25383     *
25384     * @param it The item to fetch next from
25385     * @return The item after the @p item, in its parent's list. If
25386     *         there is no next item for @p item or there's an
25387     *         error, @c NULL is returned.
25388     *
25389     * @see elm_flipselector_item_next_get()
25390     *
25391     * @ingroup Flipselector
25392     */
25393    EAPI Elm_Object_Item     *elm_flipselector_item_next_get(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
25394
25395    /**
25396     * Set the interval on time updates for an user mouse button hold
25397     * on a flip selector widget.
25398     *
25399     * @param obj The flip selector object
25400     * @param interval The (first) interval value in seconds
25401     *
25402     * This interval value is @b decreased while the user holds the
25403     * mouse pointer either flipping up or flipping doww a given flip
25404     * selector.
25405     *
25406     * This helps the user to get to a given item distant from the
25407     * current one easier/faster, as it will start to flip quicker and
25408     * quicker on mouse button holds.
25409     *
25410     * The calculation for the next flip interval value, starting from
25411     * the one set with this call, is the previous interval divided by
25412     * 1.05, so it decreases a little bit.
25413     *
25414     * The default starting interval value for automatic flips is
25415     * @b 0.85 seconds.
25416     *
25417     * @see elm_flipselector_interval_get()
25418     *
25419     * @ingroup Flipselector
25420     */
25421    EAPI void                       elm_flipselector_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
25422
25423    /**
25424     * Get the interval on time updates for an user mouse button hold
25425     * on a flip selector widget.
25426     *
25427     * @param obj The flip selector object
25428     * @return The (first) interval value, in seconds, set on it
25429     *
25430     * @see elm_flipselector_interval_set() for more details
25431     *
25432     * @ingroup Flipselector
25433     */
25434    EAPI double                     elm_flipselector_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25435    /**
25436     * @}
25437     */
25438
25439    /**
25440     * @addtogroup Calendar
25441     * @{
25442     */
25443
25444    /**
25445     * @enum _Elm_Calendar_Mark_Repeat
25446     * @typedef Elm_Calendar_Mark_Repeat
25447     *
25448     * Event periodicity, used to define if a mark should be repeated
25449     * @b beyond event's day. It's set when a mark is added.
25450     *
25451     * So, for a mark added to 13th May with periodicity set to WEEKLY,
25452     * there will be marks every week after this date. Marks will be displayed
25453     * at 13th, 20th, 27th, 3rd June ...
25454     *
25455     * Values don't work as bitmask, only one can be choosen.
25456     *
25457     * @see elm_calendar_mark_add()
25458     *
25459     * @ingroup Calendar
25460     */
25461    typedef enum _Elm_Calendar_Mark_Repeat
25462      {
25463         ELM_CALENDAR_UNIQUE, /**< Default value. Marks will be displayed only on event day. */
25464         ELM_CALENDAR_DAILY, /**< Marks will be displayed everyday after event day (inclusive). */
25465         ELM_CALENDAR_WEEKLY, /**< Marks will be displayed every week after event day (inclusive) - i.e. each seven days. */
25466         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*/
25467         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. */
25468      } Elm_Calendar_Mark_Repeat;
25469
25470    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(). */
25471
25472    /**
25473     * Add a new calendar widget to the given parent Elementary
25474     * (container) object.
25475     *
25476     * @param parent The parent object.
25477     * @return a new calendar widget handle or @c NULL, on errors.
25478     *
25479     * This function inserts a new calendar widget on the canvas.
25480     *
25481     * @ref calendar_example_01
25482     *
25483     * @ingroup Calendar
25484     */
25485    EAPI Evas_Object       *elm_calendar_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25486
25487    /**
25488     * Get weekdays names displayed by the calendar.
25489     *
25490     * @param obj The calendar object.
25491     * @return Array of seven strings to be used as weekday names.
25492     *
25493     * By default, weekdays abbreviations get from system are displayed:
25494     * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
25495     * The first string is related to Sunday, the second to Monday...
25496     *
25497     * @see elm_calendar_weekdays_name_set()
25498     *
25499     * @ref calendar_example_05
25500     *
25501     * @ingroup Calendar
25502     */
25503    EAPI const char       **elm_calendar_weekdays_names_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25504
25505    /**
25506     * Set weekdays names to be displayed by the calendar.
25507     *
25508     * @param obj The calendar object.
25509     * @param weekdays Array of seven strings to be used as weekday names.
25510     * @warning It must have 7 elements, or it will access invalid memory.
25511     * @warning The strings must be NULL terminated ('@\0').
25512     *
25513     * By default, weekdays abbreviations get from system are displayed:
25514     * E.g. for an en_US locale: "Sun, Mon, Tue, Wed, Thu, Fri, Sat"
25515     *
25516     * The first string should be related to Sunday, the second to Monday...
25517     *
25518     * The usage should be like this:
25519     * @code
25520     *   const char *weekdays[] =
25521     *   {
25522     *      "Sunday", "Monday", "Tuesday", "Wednesday",
25523     *      "Thursday", "Friday", "Saturday"
25524     *   };
25525     *   elm_calendar_weekdays_names_set(calendar, weekdays);
25526     * @endcode
25527     *
25528     * @see elm_calendar_weekdays_name_get()
25529     *
25530     * @ref calendar_example_02
25531     *
25532     * @ingroup Calendar
25533     */
25534    EAPI void               elm_calendar_weekdays_names_set(Evas_Object *obj, const char *weekdays[]) EINA_ARG_NONNULL(1, 2);
25535
25536    /**
25537     * Set the minimum and maximum values for the year
25538     *
25539     * @param obj The calendar object
25540     * @param min The minimum year, greater than 1901;
25541     * @param max The maximum year;
25542     *
25543     * Maximum must be greater than minimum, except if you don't wan't to set
25544     * maximum year.
25545     * Default values are 1902 and -1.
25546     *
25547     * If the maximum year is a negative value, it will be limited depending
25548     * on the platform architecture (year 2037 for 32 bits);
25549     *
25550     * @see elm_calendar_min_max_year_get()
25551     *
25552     * @ref calendar_example_03
25553     *
25554     * @ingroup Calendar
25555     */
25556    EAPI void               elm_calendar_min_max_year_set(Evas_Object *obj, int min, int max) EINA_ARG_NONNULL(1);
25557
25558    /**
25559     * Get the minimum and maximum values for the year
25560     *
25561     * @param obj The calendar object.
25562     * @param min The minimum year.
25563     * @param max The maximum year.
25564     *
25565     * Default values are 1902 and -1.
25566     *
25567     * @see elm_calendar_min_max_year_get() for more details.
25568     *
25569     * @ref calendar_example_05
25570     *
25571     * @ingroup Calendar
25572     */
25573    EAPI void               elm_calendar_min_max_year_get(const Evas_Object *obj, int *min, int *max) EINA_ARG_NONNULL(1);
25574
25575    /**
25576     * Enable or disable day selection
25577     *
25578     * @param obj The calendar object.
25579     * @param enabled @c EINA_TRUE to enable selection or @c EINA_FALSE to
25580     * disable it.
25581     *
25582     * Enabled by default. If disabled, the user still can select months,
25583     * but not days. Selected days are highlighted on calendar.
25584     * It should be used if you won't need such selection for the widget usage.
25585     *
25586     * When a day is selected, or month is changed, smart callbacks for
25587     * signal "changed" will be called.
25588     *
25589     * @see elm_calendar_day_selection_enable_get()
25590     *
25591     * @ref calendar_example_04
25592     *
25593     * @ingroup Calendar
25594     */
25595    EAPI void               elm_calendar_day_selection_enabled_set(Evas_Object *obj, Eina_Bool enabled) EINA_ARG_NONNULL(1);
25596
25597    /**
25598     * Get a value whether day selection is enabled or not.
25599     *
25600     * @see elm_calendar_day_selection_enable_set() for details.
25601     *
25602     * @param obj The calendar object.
25603     * @return EINA_TRUE means day selection is enabled. EINA_FALSE indicates
25604     * it's disabled. If @p obj is NULL, EINA_FALSE is returned.
25605     *
25606     * @ref calendar_example_05
25607     *
25608     * @ingroup Calendar
25609     */
25610    EAPI Eina_Bool          elm_calendar_day_selection_enabled_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25611
25612
25613    /**
25614     * Set selected date to be highlighted on calendar.
25615     *
25616     * @param obj The calendar object.
25617     * @param selected_time A @b tm struct to represent the selected date.
25618     *
25619     * Set the selected date, changing the displayed month if needed.
25620     * Selected date changes when the user goes to next/previous month or
25621     * select a day pressing over it on calendar.
25622     *
25623     * @see elm_calendar_selected_time_get()
25624     *
25625     * @ref calendar_example_04
25626     *
25627     * @ingroup Calendar
25628     */
25629    EAPI void               elm_calendar_selected_time_set(Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1);
25630
25631    /**
25632     * Get selected date.
25633     *
25634     * @param obj The calendar object
25635     * @param selected_time A @b tm struct to point to selected date
25636     * @return EINA_FALSE means an error ocurred and returned time shouldn't
25637     * be considered.
25638     *
25639     * Get date selected by the user or set by function
25640     * elm_calendar_selected_time_set().
25641     * Selected date changes when the user goes to next/previous month or
25642     * select a day pressing over it on calendar.
25643     *
25644     * @see elm_calendar_selected_time_get()
25645     *
25646     * @ref calendar_example_05
25647     *
25648     * @ingroup Calendar
25649     */
25650    EAPI Eina_Bool          elm_calendar_selected_time_get(const Evas_Object *obj, struct tm *selected_time) EINA_ARG_NONNULL(1, 2);
25651
25652    /**
25653     * Set a function to format the string that will be used to display
25654     * month and year;
25655     *
25656     * @param obj The calendar object
25657     * @param format_function Function to set the month-year string given
25658     * the selected date
25659     *
25660     * By default it uses strftime with "%B %Y" format string.
25661     * It should allocate the memory that will be used by the string,
25662     * that will be freed by the widget after usage.
25663     * A pointer to the string and a pointer to the time struct will be provided.
25664     *
25665     * Example:
25666     * @code
25667     * static char *
25668     * _format_month_year(struct tm *selected_time)
25669     * {
25670     *    char buf[32];
25671     *    if (!strftime(buf, sizeof(buf), "%B %Y", selected_time)) return NULL;
25672     *    return strdup(buf);
25673     * }
25674     *
25675     * elm_calendar_format_function_set(calendar, _format_month_year);
25676     * @endcode
25677     *
25678     * @ref calendar_example_02
25679     *
25680     * @ingroup Calendar
25681     */
25682    EAPI void               elm_calendar_format_function_set(Evas_Object *obj, char * (*format_function) (struct tm *stime)) EINA_ARG_NONNULL(1);
25683
25684    /**
25685     * Add a new mark to the calendar
25686     *
25687     * @param obj The calendar object
25688     * @param mark_type A string used to define the type of mark. It will be
25689     * emitted to the theme, that should display a related modification on these
25690     * days representation.
25691     * @param mark_time A time struct to represent the date of inclusion of the
25692     * mark. For marks that repeats it will just be displayed after the inclusion
25693     * date in the calendar.
25694     * @param repeat Repeat the event following this periodicity. Can be a unique
25695     * mark (that don't repeat), daily, weekly, monthly or annually.
25696     * @return The created mark or @p NULL upon failure.
25697     *
25698     * Add a mark that will be drawn in the calendar respecting the insertion
25699     * time and periodicity. It will emit the type as signal to the widget theme.
25700     * Default theme supports "holiday" and "checked", but it can be extended.
25701     *
25702     * It won't immediately update the calendar, drawing the marks.
25703     * For this, call elm_calendar_marks_draw(). However, when user selects
25704     * next or previous month calendar forces marks drawn.
25705     *
25706     * Marks created with this method can be deleted with
25707     * elm_calendar_mark_del().
25708     *
25709     * Example
25710     * @code
25711     * struct tm selected_time;
25712     * time_t current_time;
25713     *
25714     * current_time = time(NULL) + 5 * 84600;
25715     * localtime_r(&current_time, &selected_time);
25716     * elm_calendar_mark_add(cal, "holiday", selected_time,
25717     *     ELM_CALENDAR_ANNUALLY);
25718     *
25719     * current_time = time(NULL) + 1 * 84600;
25720     * localtime_r(&current_time, &selected_time);
25721     * elm_calendar_mark_add(cal, "checked", selected_time, ELM_CALENDAR_UNIQUE);
25722     *
25723     * elm_calendar_marks_draw(cal);
25724     * @endcode
25725     *
25726     * @see elm_calendar_marks_draw()
25727     * @see elm_calendar_mark_del()
25728     *
25729     * @ref calendar_example_06
25730     *
25731     * @ingroup Calendar
25732     */
25733    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);
25734
25735    /**
25736     * Delete mark from the calendar.
25737     *
25738     * @param mark The mark to be deleted.
25739     *
25740     * If deleting all calendar marks is required, elm_calendar_marks_clear()
25741     * should be used instead of getting marks list and deleting each one.
25742     *
25743     * @see elm_calendar_mark_add()
25744     *
25745     * @ref calendar_example_06
25746     *
25747     * @ingroup Calendar
25748     */
25749    EAPI void               elm_calendar_mark_del(Elm_Calendar_Mark *mark) EINA_ARG_NONNULL(1);
25750
25751    /**
25752     * Remove all calendar's marks
25753     *
25754     * @param obj The calendar object.
25755     *
25756     * @see elm_calendar_mark_add()
25757     * @see elm_calendar_mark_del()
25758     *
25759     * @ingroup Calendar
25760     */
25761    EAPI void               elm_calendar_marks_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
25762
25763
25764    /**
25765     * Get a list of all the calendar marks.
25766     *
25767     * @param obj The calendar object.
25768     * @return An @c Eina_List of calendar marks objects, or @c NULL on failure.
25769     *
25770     * @see elm_calendar_mark_add()
25771     * @see elm_calendar_mark_del()
25772     * @see elm_calendar_marks_clear()
25773     *
25774     * @ingroup Calendar
25775     */
25776    EAPI const Eina_List   *elm_calendar_marks_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25777
25778    /**
25779     * Draw calendar marks.
25780     *
25781     * @param obj The calendar object.
25782     *
25783     * Should be used after adding, removing or clearing marks.
25784     * It will go through the entire marks list updating the calendar.
25785     * If lots of marks will be added, add all the marks and then call
25786     * this function.
25787     *
25788     * When the month is changed, i.e. user selects next or previous month,
25789     * marks will be drawed.
25790     *
25791     * @see elm_calendar_mark_add()
25792     * @see elm_calendar_mark_del()
25793     * @see elm_calendar_marks_clear()
25794     *
25795     * @ref calendar_example_06
25796     *
25797     * @ingroup Calendar
25798     */
25799    EAPI void               elm_calendar_marks_draw(Evas_Object *obj) EINA_ARG_NONNULL(1);
25800
25801    /**
25802     * Set a day text color to the same that represents Saturdays.
25803     *
25804     * @param obj The calendar object.
25805     * @param pos The text position. Position is the cell counter, from left
25806     * to right, up to down. It starts on 0 and ends on 41.
25807     *
25808     * @deprecated use elm_calendar_mark_add() instead like:
25809     *
25810     * @code
25811     * struct tm t = { 0, 0, 12, 6, 0, 0, 6, 6, -1 };
25812     * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
25813     * @endcode
25814     *
25815     * @see elm_calendar_mark_add()
25816     *
25817     * @ingroup Calendar
25818     */
25819    EINA_DEPRECATED EAPI void               elm_calendar_text_saturday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25820
25821    /**
25822     * Set a day text color to the same that represents Sundays.
25823     *
25824     * @param obj The calendar object.
25825     * @param pos The text position. Position is the cell counter, from left
25826     * to right, up to down. It starts on 0 and ends on 41.
25827
25828     * @deprecated use elm_calendar_mark_add() instead like:
25829     *
25830     * @code
25831     * struct tm t = { 0, 0, 12, 7, 0, 0, 0, 0, -1 };
25832     * elm_calendar_mark_add(obj, "sat", &t, ELM_CALENDAR_WEEKLY);
25833     * @endcode
25834     *
25835     * @see elm_calendar_mark_add()
25836     *
25837     * @ingroup Calendar
25838     */
25839    EINA_DEPRECATED EAPI void               elm_calendar_text_sunday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25840
25841    /**
25842     * Set a day text color to the same that represents Weekdays.
25843     *
25844     * @param obj The calendar object
25845     * @param pos The text position. Position is the cell counter, from left
25846     * to right, up to down. It starts on 0 and ends on 41.
25847     *
25848     * @deprecated use elm_calendar_mark_add() instead like:
25849     *
25850     * @code
25851     * struct tm t = { 0, 0, 12, 1, 0, 0, 0, 0, -1 };
25852     *
25853     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // monday
25854     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25855     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // tuesday
25856     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25857     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // wednesday
25858     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25859     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // thursday
25860     * t.tm_tm_mday++; t.tm_wday++; t.tm_yday++;
25861     * elm_calendar_mark_add(obj, "week", &t, ELM_CALENDAR_WEEKLY); // friday
25862     * @endcode
25863     *
25864     * @see elm_calendar_mark_add()
25865     *
25866     * @ingroup Calendar
25867     */
25868    EINA_DEPRECATED EAPI void               elm_calendar_text_weekday_color_set(Evas_Object *obj, int pos) EINA_ARG_NONNULL(1);
25869
25870    /**
25871     * Set the interval on time updates for an user mouse button hold
25872     * on calendar widgets' month selection.
25873     *
25874     * @param obj The calendar object
25875     * @param interval The (first) interval value in seconds
25876     *
25877     * This interval value is @b decreased while the user holds the
25878     * mouse pointer either selecting next or previous month.
25879     *
25880     * This helps the user to get to a given month distant from the
25881     * current one easier/faster, as it will start to change quicker and
25882     * quicker on mouse button holds.
25883     *
25884     * The calculation for the next change interval value, starting from
25885     * the one set with this call, is the previous interval divided by
25886     * 1.05, so it decreases a little bit.
25887     *
25888     * The default starting interval value for automatic changes is
25889     * @b 0.85 seconds.
25890     *
25891     * @see elm_calendar_interval_get()
25892     *
25893     * @ingroup Calendar
25894     */
25895    EAPI void               elm_calendar_interval_set(Evas_Object *obj, double interval) EINA_ARG_NONNULL(1);
25896
25897    /**
25898     * Get the interval on time updates for an user mouse button hold
25899     * on calendar widgets' month selection.
25900     *
25901     * @param obj The calendar object
25902     * @return The (first) interval value, in seconds, set on it
25903     *
25904     * @see elm_calendar_interval_set() for more details
25905     *
25906     * @ingroup Calendar
25907     */
25908    EAPI double             elm_calendar_interval_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25909
25910    /**
25911     * @}
25912     */
25913
25914    /**
25915     * @defgroup Diskselector Diskselector
25916     * @ingroup Elementary
25917     *
25918     * @image html img/widget/diskselector/preview-00.png
25919     * @image latex img/widget/diskselector/preview-00.eps
25920     *
25921     * A diskselector is a kind of list widget. It scrolls horizontally,
25922     * and can contain label and icon objects. Three items are displayed
25923     * with the selected one in the middle.
25924     *
25925     * It can act like a circular list with round mode and labels can be
25926     * reduced for a defined length for side items.
25927     *
25928     * Smart callbacks one can listen to:
25929     * - "selected" - when item is selected, i.e. scroller stops.
25930     *
25931     * Available styles for it:
25932     * - @c "default"
25933     *
25934     * List of examples:
25935     * @li @ref diskselector_example_01
25936     * @li @ref diskselector_example_02
25937     */
25938
25939    /**
25940     * @addtogroup Diskselector
25941     * @{
25942     */
25943
25944    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(). */
25945
25946    /**
25947     * Add a new diskselector widget to the given parent Elementary
25948     * (container) object.
25949     *
25950     * @param parent The parent object.
25951     * @return a new diskselector widget handle or @c NULL, on errors.
25952     *
25953     * This function inserts a new diskselector widget on the canvas.
25954     *
25955     * @ingroup Diskselector
25956     */
25957    EAPI Evas_Object           *elm_diskselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
25958
25959    /**
25960     * Enable or disable round mode.
25961     *
25962     * @param obj The diskselector object.
25963     * @param round @c EINA_TRUE to enable round mode or @c EINA_FALSE to
25964     * disable it.
25965     *
25966     * Disabled by default. If round mode is enabled the items list will
25967     * work like a circle list, so when the user reaches the last item,
25968     * the first one will popup.
25969     *
25970     * @see elm_diskselector_round_get()
25971     *
25972     * @ingroup Diskselector
25973     */
25974    EAPI void                   elm_diskselector_round_set(Evas_Object *obj, Eina_Bool round) EINA_ARG_NONNULL(1);
25975
25976    /**
25977     * Get a value whether round mode is enabled or not.
25978     *
25979     * @see elm_diskselector_round_set() for details.
25980     *
25981     * @param obj The diskselector object.
25982     * @return @c EINA_TRUE means round mode is enabled. @c EINA_FALSE indicates
25983     * it's disabled. If @p obj is @c NULL, @c EINA_FALSE is returned.
25984     *
25985     * @ingroup Diskselector
25986     */
25987    EAPI Eina_Bool              elm_diskselector_round_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
25988
25989    /**
25990     * Get the side labels max length.
25991     *
25992     * @deprecated use elm_diskselector_side_label_length_get() instead:
25993     *
25994     * @param obj The diskselector object.
25995     * @return The max length defined for side labels, or 0 if not a valid
25996     * diskselector.
25997     *
25998     * @ingroup Diskselector
25999     */
26000    EINA_DEPRECATED EAPI int    elm_diskselector_side_label_lenght_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26001
26002    /**
26003     * Set the side labels max length.
26004     *
26005     * @deprecated use elm_diskselector_side_label_length_set() instead:
26006     *
26007     * @param obj The diskselector object.
26008     * @param len The max length defined for side labels.
26009     *
26010     * @ingroup Diskselector
26011     */
26012    EINA_DEPRECATED EAPI void   elm_diskselector_side_label_lenght_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
26013
26014    /**
26015     * Get the side labels max length.
26016     *
26017     * @see elm_diskselector_side_label_length_set() for details.
26018     *
26019     * @param obj The diskselector object.
26020     * @return The max length defined for side labels, or 0 if not a valid
26021     * diskselector.
26022     *
26023     * @ingroup Diskselector
26024     */
26025    EAPI int                    elm_diskselector_side_label_length_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26026
26027    /**
26028     * Set the side labels max length.
26029     *
26030     * @param obj The diskselector object.
26031     * @param len The max length defined for side labels.
26032     *
26033     * Length is the number of characters of items' label that will be
26034     * visible when it's set on side positions. It will just crop
26035     * the string after defined size. E.g.:
26036     *
26037     * An item with label "January" would be displayed on side position as
26038     * "Jan" if max length is set to 3, or "Janu", if this property
26039     * is set to 4.
26040     *
26041     * When it's selected, the entire label will be displayed, except for
26042     * width restrictions. In this case label will be cropped and "..."
26043     * will be concatenated.
26044     *
26045     * Default side label max length is 3.
26046     *
26047     * This property will be applyed over all items, included before or
26048     * later this function call.
26049     *
26050     * @ingroup Diskselector
26051     */
26052    EAPI void                   elm_diskselector_side_label_length_set(Evas_Object *obj, int len) EINA_ARG_NONNULL(1);
26053
26054    /**
26055     * Set the number of items to be displayed.
26056     *
26057     * @param obj The diskselector object.
26058     * @param num The number of items the diskselector will display.
26059     *
26060     * Default value is 3, and also it's the minimun. If @p num is less
26061     * than 3, it will be set to 3.
26062     *
26063     * Also, it can be set on theme, using data item @c display_item_num
26064     * on group "elm/diskselector/item/X", where X is style set.
26065     * E.g.:
26066     *
26067     * group { name: "elm/diskselector/item/X";
26068     * data {
26069     *     item: "display_item_num" "5";
26070     *     }
26071     *
26072     * @ingroup Diskselector
26073     */
26074    EAPI void                   elm_diskselector_display_item_num_set(Evas_Object *obj, int num) EINA_ARG_NONNULL(1);
26075
26076    /**
26077     * Get the number of items in the diskselector object.
26078     *
26079     * @param obj The diskselector object.
26080     *
26081     * @ingroup Diskselector
26082     */
26083    EAPI int                   elm_diskselector_display_item_num_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26084
26085    /**
26086     * Set bouncing behaviour when the scrolled content reaches an edge.
26087     *
26088     * Tell the internal scroller object whether it should bounce or not
26089     * when it reaches the respective edges for each axis.
26090     *
26091     * @param obj The diskselector object.
26092     * @param h_bounce Whether to bounce or not in the horizontal axis.
26093     * @param v_bounce Whether to bounce or not in the vertical axis.
26094     *
26095     * @see elm_scroller_bounce_set()
26096     *
26097     * @ingroup Diskselector
26098     */
26099    EAPI void                   elm_diskselector_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
26100
26101    /**
26102     * Get the bouncing behaviour of the internal scroller.
26103     *
26104     * Get whether the internal scroller should bounce when the edge of each
26105     * axis is reached scrolling.
26106     *
26107     * @param obj The diskselector object.
26108     * @param h_bounce Pointer where to store the bounce state of the horizontal
26109     * axis.
26110     * @param v_bounce Pointer where to store the bounce state of the vertical
26111     * axis.
26112     *
26113     * @see elm_scroller_bounce_get()
26114     * @see elm_diskselector_bounce_set()
26115     *
26116     * @ingroup Diskselector
26117     */
26118    EAPI void                   elm_diskselector_bounce_get(const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce) EINA_ARG_NONNULL(1);
26119
26120    /**
26121     * Get the scrollbar policy.
26122     *
26123     * @see elm_diskselector_scroller_policy_get() for details.
26124     *
26125     * @param obj The diskselector object.
26126     * @param policy_h Pointer where to store horizontal scrollbar policy.
26127     * @param policy_v Pointer where to store vertical scrollbar policy.
26128     *
26129     * @ingroup Diskselector
26130     */
26131    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);
26132
26133    /**
26134     * Set the scrollbar policy.
26135     *
26136     * @param obj The diskselector object.
26137     * @param policy_h Horizontal scrollbar policy.
26138     * @param policy_v Vertical scrollbar policy.
26139     *
26140     * This sets the scrollbar visibility policy for the given scroller.
26141     * #ELM_SCROLLER_POLICY_AUTO means the scrollbar is made visible if it
26142     * is needed, and otherwise kept hidden. #ELM_SCROLLER_POLICY_ON turns
26143     * it on all the time, and #ELM_SCROLLER_POLICY_OFF always keeps it off.
26144     * This applies respectively for the horizontal and vertical scrollbars.
26145     *
26146     * The both are disabled by default, i.e., are set to
26147     * #ELM_SCROLLER_POLICY_OFF.
26148     *
26149     * @ingroup Diskselector
26150     */
26151    EAPI void                   elm_diskselector_scroller_policy_set(Evas_Object *obj, Elm_Scroller_Policy policy_h, Elm_Scroller_Policy policy_v) EINA_ARG_NONNULL(1);
26152
26153    /**
26154     * Remove all diskselector's items.
26155     *
26156     * @param obj The diskselector object.
26157     *
26158     * @see elm_diskselector_item_del()
26159     * @see elm_diskselector_item_append()
26160     *
26161     * @ingroup Diskselector
26162     */
26163    EAPI void                   elm_diskselector_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
26164
26165    /**
26166     * Get a list of all the diskselector items.
26167     *
26168     * @param obj The diskselector object.
26169     * @return An @c Eina_List of diskselector items, #Elm_Diskselector_Item,
26170     * or @c NULL on failure.
26171     *
26172     * @see elm_diskselector_item_append()
26173     * @see elm_diskselector_item_del()
26174     * @see elm_diskselector_clear()
26175     *
26176     * @ingroup Diskselector
26177     */
26178    EAPI const Eina_List       *elm_diskselector_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26179
26180    /**
26181     * Appends a new item to the diskselector object.
26182     *
26183     * @param obj The diskselector object.
26184     * @param label The label of the diskselector item.
26185     * @param icon The icon object to use at left side of the item. An
26186     * icon can be any Evas object, but usually it is an icon created
26187     * with elm_icon_add().
26188     * @param func The function to call when the item is selected.
26189     * @param data The data to associate with the item for related callbacks.
26190     *
26191     * @return The created item or @c NULL upon failure.
26192     *
26193     * A new item will be created and appended to the diskselector, i.e., will
26194     * be set as last item. Also, if there is no selected item, it will
26195     * be selected. This will always happens for the first appended item.
26196     *
26197     * If no icon is set, label will be centered on item position, otherwise
26198     * the icon will be placed at left of the label, that will be shifted
26199     * to the right.
26200     *
26201     * Items created with this method can be deleted with
26202     * elm_diskselector_item_del().
26203     *
26204     * Associated @p data can be properly freed when item is deleted if a
26205     * callback function is set with elm_diskselector_item_del_cb_set().
26206     *
26207     * If a function is passed as argument, it will be called everytime this item
26208     * is selected, i.e., the user stops the diskselector with this
26209     * item on center position. If such function isn't needed, just passing
26210     * @c NULL as @p func is enough. The same should be done for @p data.
26211     *
26212     * Simple example (with no function callback or data associated):
26213     * @code
26214     * disk = elm_diskselector_add(win);
26215     * ic = elm_icon_add(win);
26216     * elm_icon_file_set(ic, "path/to/image", NULL);
26217     * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
26218     * elm_diskselector_item_append(disk, "label", ic, NULL, NULL);
26219     * @endcode
26220     *
26221     * @see elm_diskselector_item_del()
26222     * @see elm_diskselector_item_del_cb_set()
26223     * @see elm_diskselector_clear()
26224     * @see elm_icon_add()
26225     *
26226     * @ingroup Diskselector
26227     */
26228    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);
26229
26230
26231    /**
26232     * Delete them item from the diskselector.
26233     *
26234     * @param it The item of diskselector to be deleted.
26235     *
26236     * If deleting all diskselector items is required, elm_diskselector_clear()
26237     * should be used instead of getting items list and deleting each one.
26238     *
26239     * @see elm_diskselector_clear()
26240     * @see elm_diskselector_item_append()
26241     * @see elm_diskselector_item_del_cb_set()
26242     *
26243     * @ingroup Diskselector
26244     */
26245    EAPI void                   elm_diskselector_item_del(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26246
26247    /**
26248     * Set the function called when a diskselector item is freed.
26249     *
26250     * @param it The item to set the callback on
26251     * @param func The function called
26252     *
26253     * If there is a @p func, then it will be called prior item's memory release.
26254     * That will be called with the following arguments:
26255     * @li item's data;
26256     * @li item's Evas object;
26257     * @li item itself;
26258     *
26259     * This way, a data associated to a diskselector item could be properly
26260     * freed.
26261     *
26262     * @ingroup Diskselector
26263     */
26264    EAPI void                   elm_diskselector_item_del_cb_set(Elm_Diskselector_Item *item, Evas_Smart_Cb func) EINA_ARG_NONNULL(1);
26265
26266    /**
26267     * Get the data associated to the item.
26268     *
26269     * @param it The diskselector item
26270     * @return The data associated to @p it
26271     *
26272     * The return value is a pointer to data associated to @p item when it was
26273     * created, with function elm_diskselector_item_append(). If no data
26274     * was passed as argument, it will return @c NULL.
26275     *
26276     * @see elm_diskselector_item_append()
26277     *
26278     * @ingroup Diskselector
26279     */
26280    EAPI void                  *elm_diskselector_item_data_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26281
26282    /**
26283     * Set the icon associated to the item.
26284     *
26285     * @param it The diskselector item
26286     * @param icon The icon object to associate with @p it
26287     *
26288     * The icon object to use at left side of the item. An
26289     * icon can be any Evas object, but usually it is an icon created
26290     * with elm_icon_add().
26291     *
26292     * Once the icon object is set, a previously set one will be deleted.
26293     * @warning Setting the same icon for two items will cause the icon to
26294     * dissapear from the first item.
26295     *
26296     * If an icon was passed as argument on item creation, with function
26297     * elm_diskselector_item_append(), it will be already
26298     * associated to the item.
26299     *
26300     * @see elm_diskselector_item_append()
26301     * @see elm_diskselector_item_icon_get()
26302     *
26303     * @ingroup Diskselector
26304     */
26305    EAPI void                   elm_diskselector_item_icon_set(Elm_Diskselector_Item *item, Evas_Object *icon) EINA_ARG_NONNULL(1);
26306
26307    /**
26308     * Get the icon associated to the item.
26309     *
26310     * @param it The diskselector item
26311     * @return The icon associated to @p it
26312     *
26313     * The return value is a pointer to the icon associated to @p item when it was
26314     * created, with function elm_diskselector_item_append(), or later
26315     * with function elm_diskselector_item_icon_set. If no icon
26316     * was passed as argument, it will return @c NULL.
26317     *
26318     * @see elm_diskselector_item_append()
26319     * @see elm_diskselector_item_icon_set()
26320     *
26321     * @ingroup Diskselector
26322     */
26323    EAPI Evas_Object           *elm_diskselector_item_icon_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26324
26325    /**
26326     * Set the label of item.
26327     *
26328     * @param it The item of diskselector.
26329     * @param label The label of item.
26330     *
26331     * The label to be displayed by the item.
26332     *
26333     * If no icon is set, label will be centered on item position, otherwise
26334     * the icon will be placed at left of the label, that will be shifted
26335     * to the right.
26336     *
26337     * An item with label "January" would be displayed on side position as
26338     * "Jan" if max length is set to 3 with function
26339     * elm_diskselector_side_label_lenght_set(), or "Janu", if this property
26340     * is set to 4.
26341     *
26342     * When this @p item is selected, the entire label will be displayed,
26343     * except for width restrictions.
26344     * In this case label will be cropped and "..." will be concatenated,
26345     * but only for display purposes. It will keep the entire string, so
26346     * if diskselector is resized the remaining characters will be displayed.
26347     *
26348     * If a label was passed as argument on item creation, with function
26349     * elm_diskselector_item_append(), it will be already
26350     * displayed by the item.
26351     *
26352     * @see elm_diskselector_side_label_lenght_set()
26353     * @see elm_diskselector_item_label_get()
26354     * @see elm_diskselector_item_append()
26355     *
26356     * @ingroup Diskselector
26357     */
26358    EAPI void                   elm_diskselector_item_label_set(Elm_Diskselector_Item *item, const char *label) EINA_ARG_NONNULL(1);
26359
26360    /**
26361     * Get the label of item.
26362     *
26363     * @param it The item of diskselector.
26364     * @return The label of item.
26365     *
26366     * The return value is a pointer to the label associated to @p item when it was
26367     * created, with function elm_diskselector_item_append(), or later
26368     * with function elm_diskselector_item_label_set. If no label
26369     * was passed as argument, it will return @c NULL.
26370     *
26371     * @see elm_diskselector_item_label_set() for more details.
26372     * @see elm_diskselector_item_append()
26373     *
26374     * @ingroup Diskselector
26375     */
26376    EAPI const char            *elm_diskselector_item_label_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26377
26378    /**
26379     * Get the selected item.
26380     *
26381     * @param obj The diskselector object.
26382     * @return The selected diskselector item.
26383     *
26384     * The selected item can be unselected with function
26385     * elm_diskselector_item_selected_set(), and the first item of
26386     * diskselector will be selected.
26387     *
26388     * The selected item always will be centered on diskselector, with
26389     * full label displayed, i.e., max lenght set to side labels won't
26390     * apply on the selected item. More details on
26391     * elm_diskselector_side_label_length_set().
26392     *
26393     * @ingroup Diskselector
26394     */
26395    EAPI Elm_Diskselector_Item *elm_diskselector_selected_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26396
26397    /**
26398     * Set the selected state of an item.
26399     *
26400     * @param it The diskselector item
26401     * @param selected The selected state
26402     *
26403     * This sets the selected state of the given item @p it.
26404     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
26405     *
26406     * If a new item is selected the previosly selected will be unselected.
26407     * Previoulsy selected item can be get with function
26408     * elm_diskselector_selected_item_get().
26409     *
26410     * If the item @p it is unselected, the first item of diskselector will
26411     * be selected.
26412     *
26413     * Selected items will be visible on center position of diskselector.
26414     * So if it was on another position before selected, or was invisible,
26415     * diskselector will animate items until the selected item reaches center
26416     * position.
26417     *
26418     * @see elm_diskselector_item_selected_get()
26419     * @see elm_diskselector_selected_item_get()
26420     *
26421     * @ingroup Diskselector
26422     */
26423    EAPI void                   elm_diskselector_item_selected_set(Elm_Diskselector_Item *item, Eina_Bool selected) EINA_ARG_NONNULL(1);
26424
26425    /*
26426     * Get whether the @p item is selected or not.
26427     *
26428     * @param it The diskselector item.
26429     * @return @c EINA_TRUE means item is selected. @c EINA_FALSE indicates
26430     * it's not. If @p obj is @c NULL, @c EINA_FALSE is returned.
26431     *
26432     * @see elm_diskselector_selected_item_set() for details.
26433     * @see elm_diskselector_item_selected_get()
26434     *
26435     * @ingroup Diskselector
26436     */
26437    EAPI Eina_Bool              elm_diskselector_item_selected_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26438
26439    /**
26440     * Get the first item of the diskselector.
26441     *
26442     * @param obj The diskselector object.
26443     * @return The first item, or @c NULL if none.
26444     *
26445     * The list of items follows append order. So it will return the first
26446     * item appended to the widget that wasn't deleted.
26447     *
26448     * @see elm_diskselector_item_append()
26449     * @see elm_diskselector_items_get()
26450     *
26451     * @ingroup Diskselector
26452     */
26453    EAPI Elm_Diskselector_Item *elm_diskselector_first_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26454
26455    /**
26456     * Get the last item of the diskselector.
26457     *
26458     * @param obj The diskselector object.
26459     * @return The last item, or @c NULL if none.
26460     *
26461     * The list of items follows append order. So it will return last first
26462     * item appended to the widget that wasn't deleted.
26463     *
26464     * @see elm_diskselector_item_append()
26465     * @see elm_diskselector_items_get()
26466     *
26467     * @ingroup Diskselector
26468     */
26469    EAPI Elm_Diskselector_Item *elm_diskselector_last_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26470
26471    /**
26472     * Get the item before @p item in diskselector.
26473     *
26474     * @param it The diskselector item.
26475     * @return The item before @p item, or @c NULL if none or on failure.
26476     *
26477     * The list of items follows append order. So it will return item appended
26478     * just before @p item and that wasn't deleted.
26479     *
26480     * If it is the first item, @c NULL will be returned.
26481     * First item can be get by elm_diskselector_first_item_get().
26482     *
26483     * @see elm_diskselector_item_append()
26484     * @see elm_diskselector_items_get()
26485     *
26486     * @ingroup Diskselector
26487     */
26488    EAPI Elm_Diskselector_Item *elm_diskselector_item_prev_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26489
26490    /**
26491     * Get the item after @p item in diskselector.
26492     *
26493     * @param it The diskselector item.
26494     * @return The item after @p item, or @c NULL if none or on failure.
26495     *
26496     * The list of items follows append order. So it will return item appended
26497     * just after @p item and that wasn't deleted.
26498     *
26499     * If it is the last item, @c NULL will be returned.
26500     * Last item can be get by elm_diskselector_last_item_get().
26501     *
26502     * @see elm_diskselector_item_append()
26503     * @see elm_diskselector_items_get()
26504     *
26505     * @ingroup Diskselector
26506     */
26507    EAPI Elm_Diskselector_Item *elm_diskselector_item_next_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26508
26509    /**
26510     * Set the text to be shown in the diskselector item.
26511     *
26512     * @param item Target item
26513     * @param text The text to set in the content
26514     *
26515     * Setup the text as tooltip to object. The item can have only one tooltip,
26516     * so any previous tooltip data is removed.
26517     *
26518     * @see elm_object_tooltip_text_set() for more details.
26519     *
26520     * @ingroup Diskselector
26521     */
26522    EAPI void                   elm_diskselector_item_tooltip_text_set(Elm_Diskselector_Item *item, const char *text) EINA_ARG_NONNULL(1);
26523
26524    /**
26525     * Set the content to be shown in the tooltip item.
26526     *
26527     * Setup the tooltip to item. The item can have only one tooltip,
26528     * so any previous tooltip data is removed. @p func(with @p data) will
26529     * be called every time that need show the tooltip and it should
26530     * return a valid Evas_Object. This object is then managed fully by
26531     * tooltip system and is deleted when the tooltip is gone.
26532     *
26533     * @param item the diskselector item being attached a tooltip.
26534     * @param func the function used to create the tooltip contents.
26535     * @param data what to provide to @a func as callback data/context.
26536     * @param del_cb called when data is not needed anymore, either when
26537     *        another callback replaces @p func, the tooltip is unset with
26538     *        elm_diskselector_item_tooltip_unset() or the owner @a item
26539     *        dies. This callback receives as the first parameter the
26540     *        given @a data, and @c event_info is the item.
26541     *
26542     * @see elm_object_tooltip_content_cb_set() for more details.
26543     *
26544     * @ingroup Diskselector
26545     */
26546    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);
26547
26548    /**
26549     * Unset tooltip from item.
26550     *
26551     * @param item diskselector item to remove previously set tooltip.
26552     *
26553     * Remove tooltip from item. The callback provided as del_cb to
26554     * elm_diskselector_item_tooltip_content_cb_set() will be called to notify
26555     * it is not used anymore.
26556     *
26557     * @see elm_object_tooltip_unset() for more details.
26558     * @see elm_diskselector_item_tooltip_content_cb_set()
26559     *
26560     * @ingroup Diskselector
26561     */
26562    EAPI void                   elm_diskselector_item_tooltip_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26563
26564
26565    /**
26566     * Sets a different style for this item tooltip.
26567     *
26568     * @note before you set a style you should define a tooltip with
26569     *       elm_diskselector_item_tooltip_content_cb_set() or
26570     *       elm_diskselector_item_tooltip_text_set()
26571     *
26572     * @param item diskselector item with tooltip already set.
26573     * @param style the theme style to use (default, transparent, ...)
26574     *
26575     * @see elm_object_tooltip_style_set() for more details.
26576     *
26577     * @ingroup Diskselector
26578     */
26579    EAPI void                   elm_diskselector_item_tooltip_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
26580
26581    /**
26582     * Get the style for this item tooltip.
26583     *
26584     * @param item diskselector item with tooltip already set.
26585     * @return style the theme style in use, defaults to "default". If the
26586     *         object does not have a tooltip set, then NULL is returned.
26587     *
26588     * @see elm_object_tooltip_style_get() for more details.
26589     * @see elm_diskselector_item_tooltip_style_set()
26590     *
26591     * @ingroup Diskselector
26592     */
26593    EAPI const char            *elm_diskselector_item_tooltip_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26594
26595    /**
26596     * Set the cursor to be shown when mouse is over the diskselector item
26597     *
26598     * @param item Target item
26599     * @param cursor the cursor name to be used.
26600     *
26601     * @see elm_object_cursor_set() for more details.
26602     *
26603     * @ingroup Diskselector
26604     */
26605    EAPI void                   elm_diskselector_item_cursor_set(Elm_Diskselector_Item *item, const char *cursor) EINA_ARG_NONNULL(1);
26606
26607    /**
26608     * Get the cursor to be shown when mouse is over the diskselector item
26609     *
26610     * @param item diskselector item with cursor already set.
26611     * @return the cursor name.
26612     *
26613     * @see elm_object_cursor_get() for more details.
26614     * @see elm_diskselector_cursor_set()
26615     *
26616     * @ingroup Diskselector
26617     */
26618    EAPI const char            *elm_diskselector_item_cursor_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26619
26620
26621    /**
26622     * Unset the cursor to be shown when mouse is over the diskselector item
26623     *
26624     * @param item Target item
26625     *
26626     * @see elm_object_cursor_unset() for more details.
26627     * @see elm_diskselector_cursor_set()
26628     *
26629     * @ingroup Diskselector
26630     */
26631    EAPI void                   elm_diskselector_item_cursor_unset(Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26632
26633    /**
26634     * Sets a different style for this item cursor.
26635     *
26636     * @note before you set a style you should define a cursor with
26637     *       elm_diskselector_item_cursor_set()
26638     *
26639     * @param item diskselector item with cursor already set.
26640     * @param style the theme style to use (default, transparent, ...)
26641     *
26642     * @see elm_object_cursor_style_set() for more details.
26643     *
26644     * @ingroup Diskselector
26645     */
26646    EAPI void                   elm_diskselector_item_cursor_style_set(Elm_Diskselector_Item *item, const char *style) EINA_ARG_NONNULL(1);
26647
26648
26649    /**
26650     * Get the style for this item cursor.
26651     *
26652     * @param item diskselector item with cursor already set.
26653     * @return style the theme style in use, defaults to "default". If the
26654     *         object does not have a cursor set, then @c NULL is returned.
26655     *
26656     * @see elm_object_cursor_style_get() for more details.
26657     * @see elm_diskselector_item_cursor_style_set()
26658     *
26659     * @ingroup Diskselector
26660     */
26661    EAPI const char            *elm_diskselector_item_cursor_style_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26662
26663
26664    /**
26665     * Set if the cursor set should be searched on the theme or should use
26666     * the provided by the engine, only.
26667     *
26668     * @note before you set if should look on theme you should define a cursor
26669     * with elm_diskselector_item_cursor_set().
26670     * By default it will only look for cursors provided by the engine.
26671     *
26672     * @param item widget item with cursor already set.
26673     * @param engine_only boolean to define if cursors set with
26674     * elm_diskselector_item_cursor_set() should be searched only
26675     * between cursors provided by the engine or searched on widget's
26676     * theme as well.
26677     *
26678     * @see elm_object_cursor_engine_only_set() for more details.
26679     *
26680     * @ingroup Diskselector
26681     */
26682    EAPI void                   elm_diskselector_item_cursor_engine_only_set(Elm_Diskselector_Item *item, Eina_Bool engine_only) EINA_ARG_NONNULL(1);
26683
26684    /**
26685     * Get the cursor engine only usage for this item cursor.
26686     *
26687     * @param item widget item with cursor already set.
26688     * @return engine_only boolean to define it cursors should be looked only
26689     * between the provided by the engine or searched on widget's theme as well.
26690     * If the item does not have a cursor set, then @c EINA_FALSE is returned.
26691     *
26692     * @see elm_object_cursor_engine_only_get() for more details.
26693     * @see elm_diskselector_item_cursor_engine_only_set()
26694     *
26695     * @ingroup Diskselector
26696     */
26697    EAPI Eina_Bool              elm_diskselector_item_cursor_engine_only_get(const Elm_Diskselector_Item *item) EINA_ARG_NONNULL(1);
26698
26699    /**
26700     * @}
26701     */
26702
26703    /**
26704     * @defgroup Colorselector Colorselector
26705     *
26706     * @{
26707     *
26708     * @image html img/widget/colorselector/preview-00.png
26709     * @image latex img/widget/colorselector/preview-00.eps
26710     *
26711     * @brief Widget for user to select a color.
26712     *
26713     * Signals that you can add callbacks for are:
26714     * "changed" - When the color value changes(event_info is NULL).
26715     *
26716     * See @ref tutorial_colorselector.
26717     */
26718    /**
26719     * @brief Add a new colorselector to the parent
26720     *
26721     * @param parent The parent object
26722     * @return The new object or NULL if it cannot be created
26723     *
26724     * @ingroup Colorselector
26725     */
26726    EAPI Evas_Object *elm_colorselector_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26727    /**
26728     * Set a color for the colorselector
26729     *
26730     * @param obj   Colorselector object
26731     * @param r     r-value of color
26732     * @param g     g-value of color
26733     * @param b     b-value of color
26734     * @param a     a-value of color
26735     *
26736     * @ingroup Colorselector
26737     */
26738    EAPI void         elm_colorselector_color_set(Evas_Object *obj, int r, int g , int b, int a) EINA_ARG_NONNULL(1);
26739    /**
26740     * Get a color from the colorselector
26741     *
26742     * @param obj   Colorselector object
26743     * @param r     integer pointer for r-value of color
26744     * @param g     integer pointer for g-value of color
26745     * @param b     integer pointer for b-value of color
26746     * @param a     integer pointer for a-value of color
26747     *
26748     * @ingroup Colorselector
26749     */
26750    EAPI void         elm_colorselector_color_get(const Evas_Object *obj, int *r, int *g , int *b, int *a) EINA_ARG_NONNULL(1);
26751    /**
26752     * @}
26753     */
26754
26755    /**
26756     * @defgroup Ctxpopup Ctxpopup
26757     *
26758     * @image html img/widget/ctxpopup/preview-00.png
26759     * @image latex img/widget/ctxpopup/preview-00.eps
26760     *
26761     * @brief Context popup widet.
26762     *
26763     * A ctxpopup is a widget that, when shown, pops up a list of items.
26764     * It automatically chooses an area inside its parent object's view
26765     * (set via elm_ctxpopup_add() and elm_ctxpopup_hover_parent_set()) to
26766     * optimally fit into it. In the default theme, it will also point an
26767     * arrow to it's top left position at the time one shows it. Ctxpopup
26768     * items have a label and/or an icon. It is intended for a small
26769     * number of items (hence the use of list, not genlist).
26770     *
26771     * @note Ctxpopup is a especialization of @ref Hover.
26772     *
26773     * Signals that you can add callbacks for are:
26774     * "dismissed" - the ctxpopup was dismissed
26775     *
26776     * Default contents parts of the ctxpopup widget that you can use for are:
26777     * @li "default" - A content of the ctxpopup
26778     *
26779     * Default contents parts of the naviframe items that you can use for are:
26780     * @li "icon" - A icon in the title area
26781     * 
26782     * Default text parts of the naviframe items that you can use for are:
26783     * @li "default" - Title label in the title area
26784     *
26785     * @ref tutorial_ctxpopup shows the usage of a good deal of the API.
26786     * @{
26787     */
26788    typedef enum _Elm_Ctxpopup_Direction
26789      {
26790         ELM_CTXPOPUP_DIRECTION_DOWN, /**< ctxpopup show appear below clicked
26791                                           area */
26792         ELM_CTXPOPUP_DIRECTION_RIGHT, /**< ctxpopup show appear to the right of
26793                                            the clicked area */
26794         ELM_CTXPOPUP_DIRECTION_LEFT, /**< ctxpopup show appear to the left of
26795                                           the clicked area */
26796         ELM_CTXPOPUP_DIRECTION_UP, /**< ctxpopup show appear above the clicked
26797                                         area */
26798         ELM_CTXPOPUP_DIRECTION_UNKNOWN, /**< ctxpopup does not determine it's direction yet*/
26799      } Elm_Ctxpopup_Direction;
26800 #define Elm_Ctxpopup_Item Elm_Object_Item
26801
26802    /**
26803     * @brief Add a new Ctxpopup object to the parent.
26804     *
26805     * @param parent Parent object
26806     * @return New object or @c NULL, if it cannot be created
26807     */
26808    EAPI Evas_Object  *elm_ctxpopup_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
26809    /**
26810     * @brief Set the Ctxpopup's parent
26811     *
26812     * @param obj The ctxpopup object
26813     * @param area The parent to use
26814     *
26815     * Set the parent object.
26816     *
26817     * @note elm_ctxpopup_add() will automatically call this function
26818     * with its @c parent argument.
26819     *
26820     * @see elm_ctxpopup_add()
26821     * @see elm_hover_parent_set()
26822     */
26823    EAPI void          elm_ctxpopup_hover_parent_set(Evas_Object *obj, Evas_Object *parent) EINA_ARG_NONNULL(1, 2);
26824    /**
26825     * @brief Get the Ctxpopup's parent
26826     *
26827     * @param obj The ctxpopup object
26828     *
26829     * @see elm_ctxpopup_hover_parent_set() for more information
26830     */
26831    EAPI Evas_Object  *elm_ctxpopup_hover_parent_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26832    /**
26833     * @brief Clear all items in the given ctxpopup object.
26834     *
26835     * @param obj Ctxpopup object
26836     */
26837    EAPI void          elm_ctxpopup_clear(Evas_Object *obj) EINA_ARG_NONNULL(1);
26838    /**
26839     * @brief Change the ctxpopup's orientation to horizontal or vertical.
26840     *
26841     * @param obj Ctxpopup object
26842     * @param horizontal @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical
26843     */
26844    EAPI void          elm_ctxpopup_horizontal_set(Evas_Object *obj, Eina_Bool horizontal) EINA_ARG_NONNULL(1);
26845    /**
26846     * @brief Get the value of current ctxpopup object's orientation.
26847     *
26848     * @param obj Ctxpopup object
26849     * @return @c EINA_TRUE for horizontal mode, @c EINA_FALSE for vertical mode (or errors)
26850     *
26851     * @see elm_ctxpopup_horizontal_set()
26852     */
26853    EAPI Eina_Bool     elm_ctxpopup_horizontal_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
26854    /**
26855     * @brief Add a new item to a ctxpopup object.
26856     *
26857     * @param obj Ctxpopup object
26858     * @param icon Icon to be set on new item
26859     * @param label The Label of the new item
26860     * @param func Convenience function called when item selected
26861     * @param data Data passed to @p func
26862     * @return A handle to the item added or @c NULL, on errors
26863     *
26864     * @warning Ctxpopup can't hold both an item list and a content at the same
26865     * time. When an item is added, any previous content will be removed.
26866     *
26867     * @see elm_ctxpopup_content_set()
26868     */
26869    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);
26870    /**
26871     * @brief Delete the given item in a ctxpopup object.
26872     *
26873     * @param it Ctxpopup item to be deleted
26874     *
26875     * @see elm_ctxpopup_item_append()
26876     */
26877    EAPI void          elm_ctxpopup_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26878    /**
26879     * @brief Set the ctxpopup item's state as disabled or enabled.
26880     *
26881     * @param it Ctxpopup item to be enabled/disabled
26882     * @param disabled @c EINA_TRUE to disable it, @c EINA_FALSE to enable it
26883     *
26884     * When disabled the item is greyed out to indicate it's state.
26885     * @deprecated use elm_object_item_disabled_set() instead
26886     */
26887    WILL_DEPRECATE  EAPI void          elm_ctxpopup_item_disabled_set(Elm_Object_Item *it, Eina_Bool disabled) EINA_ARG_NONNULL(1);
26888    /**
26889     * @brief Get the ctxpopup item's disabled/enabled state.
26890     *
26891     * @param it Ctxpopup item to be enabled/disabled
26892     * @return disabled @c EINA_TRUE, if disabled, @c EINA_FALSE otherwise
26893     *
26894     * @see elm_ctxpopup_item_disabled_set()
26895     * @deprecated use elm_object_item_disabled_get() instead
26896     */
26897    EAPI Eina_Bool     elm_ctxpopup_item_disabled_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26898    /**
26899     * @brief Get the icon object for the given ctxpopup item.
26900     *
26901     * @param it Ctxpopup item
26902     * @return icon object or @c NULL, if the item does not have icon or an error
26903     * occurred
26904     *
26905     * @see elm_ctxpopup_item_append()
26906     * @see elm_ctxpopup_item_icon_set()
26907     *
26908     * @deprecated use elm_object_item_part_content_get() instead
26909     */
26910    WILL_DEPRECATE  EAPI Evas_Object  *elm_ctxpopup_item_icon_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26911    /**
26912     * @brief Sets the side icon associated with the ctxpopup item
26913     *
26914     * @param it Ctxpopup item
26915     * @param icon Icon object to be set
26916     *
26917     * Once the icon object is set, a previously set one will be deleted.
26918     * @warning Setting the same icon for two items will cause the icon to
26919     * dissapear from the first item.
26920     *
26921     * @see elm_ctxpopup_item_append()
26922     *  
26923     * @deprecated use elm_object_item_part_content_set() instead
26924     *
26925     */
26926    WILL_DEPRECATE  EAPI void          elm_ctxpopup_item_icon_set(Elm_Object_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
26927    /**
26928     * @brief Get the label for the given ctxpopup item.
26929     *
26930     * @param it Ctxpopup item
26931     * @return label string or @c NULL, if the item does not have label or an
26932     * error occured
26933     *
26934     * @see elm_ctxpopup_item_append()
26935     * @see elm_ctxpopup_item_label_set()
26936     *
26937     * @deprecated use elm_object_item_text_get() instead
26938     */
26939    WILL_DEPRECATE  EAPI const char   *elm_ctxpopup_item_label_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
26940    /**
26941     * @brief (Re)set the label on the given ctxpopup item.
26942     *
26943     * @param it Ctxpopup item
26944     * @param label String to set as label
26945     *
26946     * @deprecated use elm_object_item_text_set() instead
26947     */
26948    WILL_DEPRECATE  EAPI void          elm_ctxpopup_item_label_set(Elm_Object_Item *it, const char *label) EINA_ARG_NONNULL(1);
26949    /**
26950     * @brief Set an elm widget as the content of the ctxpopup.
26951     *
26952     * @param obj Ctxpopup object
26953     * @param content Content to be swallowed
26954     *
26955     * If the content object is already set, a previous one will bedeleted. If
26956     * you want to keep that old content object, use the
26957     * elm_ctxpopup_content_unset() function.
26958     *
26959     * @warning Ctxpopup can't hold both a item list and a content at the same
26960     * time. When a content is set, any previous items will be removed.
26961     * 
26962     * @deprecated use elm_object_content_set() instead
26963     *
26964     */
26965    WILL_DEPRECATE  EAPI void          elm_ctxpopup_content_set(Evas_Object *obj, Evas_Object *content) EINA_ARG_NONNULL(1, 2);
26966    /**
26967     * @brief Unset the ctxpopup content
26968     *
26969     * @param obj Ctxpopup object
26970     * @return The content that was being used
26971     *
26972     * Unparent and return the content object which was set for this widget.
26973     *
26974     * @deprecated use elm_object_content_unset()
26975     *
26976     * @see elm_ctxpopup_content_set()
26977     *
26978     * @deprecated use elm_object_content_unset() instead
26979     *
26980     */
26981    WILL_DEPRECATE  EAPI Evas_Object  *elm_ctxpopup_content_unset(Evas_Object *obj) EINA_ARG_NONNULL(1);
26982    /**
26983     * @brief Set the direction priority of a ctxpopup.
26984     *
26985     * @param obj Ctxpopup object
26986     * @param first 1st priority of direction
26987     * @param second 2nd priority of direction
26988     * @param third 3th priority of direction
26989     * @param fourth 4th priority of direction
26990     *
26991     * This functions gives a chance to user to set the priority of ctxpopup
26992     * showing direction. This doesn't guarantee the ctxpopup will appear in the
26993     * requested direction.
26994     *
26995     * @see Elm_Ctxpopup_Direction
26996     */
26997    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);
26998    /**
26999     * @brief Get the direction priority of a ctxpopup.
27000     *
27001     * @param obj Ctxpopup object
27002     * @param first 1st priority of direction to be returned
27003     * @param second 2nd priority of direction to be returned
27004     * @param third 3th priority of direction to be returned
27005     * @param fourth 4th priority of direction to be returned
27006     *
27007     * @see elm_ctxpopup_direction_priority_set() for more information.
27008     */
27009    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);
27010
27011    /**
27012     * @brief Get the current direction of a ctxpopup.
27013     *
27014     * @param obj Ctxpopup object
27015     * @return current direction of a ctxpopup
27016     *
27017     * @warning Once the ctxpopup showed up, the direction would be determined
27018     */
27019    EAPI Elm_Ctxpopup_Direction elm_ctxpopup_direction_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
27020
27021    /**
27022     * @}
27023     */
27024
27025    /* transit */
27026    /**
27027     *
27028     * @defgroup Transit Transit
27029     * @ingroup Elementary
27030     *
27031     * Transit is designed to apply various animated transition effects to @c
27032     * Evas_Object, such like translation, rotation, etc. For using these
27033     * effects, create an @ref Elm_Transit and add the desired transition effects.
27034     *
27035     * Once the effects are added into transit, they will be automatically
27036     * managed (their callback will be called until the duration is ended, and
27037     * they will be deleted on completion).
27038     *
27039     * Example:
27040     * @code
27041     * Elm_Transit *trans = elm_transit_add();
27042     * elm_transit_object_add(trans, obj);
27043     * elm_transit_effect_translation_add(trans, 0, 0, 280, 280
27044     * elm_transit_duration_set(transit, 1);
27045     * elm_transit_auto_reverse_set(transit, EINA_TRUE);
27046     * elm_transit_tween_mode_set(transit, ELM_TRANSIT_TWEEN_MODE_DECELERATE);
27047     * elm_transit_repeat_times_set(transit, 3);
27048     * @endcode
27049     *
27050     * Some transition effects are used to change the properties of objects. They
27051     * are:
27052     * @li @ref elm_transit_effect_translation_add
27053     * @li @ref elm_transit_effect_color_add
27054     * @li @ref elm_transit_effect_rotation_add
27055     * @li @ref elm_transit_effect_wipe_add
27056     * @li @ref elm_transit_effect_zoom_add
27057     * @li @ref elm_transit_effect_resizing_add
27058     *
27059     * Other transition effects are used to make one object disappear and another
27060     * object appear on its old place. These effects are:
27061     *
27062     * @li @ref elm_transit_effect_flip_add
27063     * @li @ref elm_transit_effect_resizable_flip_add
27064     * @li @ref elm_transit_effect_fade_add
27065     * @li @ref elm_transit_effect_blend_add
27066     *
27067     * It's also possible to make a transition chain with @ref
27068     * elm_transit_chain_transit_add.
27069     *
27070     * @warning We strongly recommend to use elm_transit just when edje can not do
27071     * the trick. Edje has more advantage than Elm_Transit, it has more flexibility and
27072     * animations can be manipulated inside the theme.
27073     *
27074     * List of examples:
27075     * @li @ref transit_example_01_explained
27076     * @li @ref transit_example_02_explained
27077     * @li @ref transit_example_03_c
27078     * @li @ref transit_example_04_c
27079     *
27080     * @{
27081     */
27082
27083    /**
27084     * @enum Elm_Transit_Tween_Mode
27085     *
27086     * The type of acceleration used in the transition.
27087     */
27088    typedef enum
27089      {
27090         ELM_TRANSIT_TWEEN_MODE_LINEAR, /**< Constant speed */
27091         ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL, /**< Starts slow, increase speed
27092                                              over time, then decrease again
27093                                              and stop slowly */
27094         ELM_TRANSIT_TWEEN_MODE_DECELERATE, /**< Starts fast and decrease
27095                                              speed over time */
27096         ELM_TRANSIT_TWEEN_MODE_ACCELERATE /**< Starts slow and increase speed
27097                                             over time */
27098      } Elm_Transit_Tween_Mode;
27099
27100    /**
27101     * @enum Elm_Transit_Effect_Flip_Axis
27102     *
27103     * The axis where flip effect should be applied.
27104     */
27105    typedef enum
27106      {
27107         ELM_TRANSIT_EFFECT_FLIP_AXIS_X, /**< Flip on X axis */
27108         ELM_TRANSIT_EFFECT_FLIP_AXIS_Y /**< Flip on Y axis */
27109      } Elm_Transit_Effect_Flip_Axis;
27110    /**
27111     * @enum Elm_Transit_Effect_Wipe_Dir
27112     *
27113     * The direction where the wipe effect should occur.
27114     */
27115    typedef enum
27116      {
27117         ELM_TRANSIT_EFFECT_WIPE_DIR_LEFT, /**< Wipe to the left */
27118         ELM_TRANSIT_EFFECT_WIPE_DIR_RIGHT, /**< Wipe to the right */
27119         ELM_TRANSIT_EFFECT_WIPE_DIR_UP, /**< Wipe up */
27120         ELM_TRANSIT_EFFECT_WIPE_DIR_DOWN /**< Wipe down */
27121      } Elm_Transit_Effect_Wipe_Dir;
27122    /** @enum Elm_Transit_Effect_Wipe_Type
27123     *
27124     * Whether the wipe effect should show or hide the object.
27125     */
27126    typedef enum
27127      {
27128         ELM_TRANSIT_EFFECT_WIPE_TYPE_HIDE, /**< Hide the object during the
27129                                              animation */
27130         ELM_TRANSIT_EFFECT_WIPE_TYPE_SHOW /**< Show the object during the
27131                                             animation */
27132      } Elm_Transit_Effect_Wipe_Type;
27133
27134    /**
27135     * @typedef Elm_Transit
27136     *
27137     * The Transit created with elm_transit_add(). This type has the information
27138     * about the objects which the transition will be applied, and the
27139     * transition effects that will be used. It also contains info about
27140     * duration, number of repetitions, auto-reverse, etc.
27141     */
27142    typedef struct _Elm_Transit Elm_Transit;
27143    typedef void Elm_Transit_Effect;
27144    /**
27145     * @typedef Elm_Transit_Effect_Transition_Cb
27146     *
27147     * Transition callback called for this effect on each transition iteration.
27148     */
27149    typedef void (*Elm_Transit_Effect_Transition_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit, double progress);
27150    /**
27151     * Elm_Transit_Effect_End_Cb
27152     *
27153     * Transition callback called for this effect when the transition is over.
27154     */
27155    typedef void (*Elm_Transit_Effect_End_Cb) (Elm_Transit_Effect *effect, Elm_Transit *transit);
27156
27157    /**
27158     * Elm_Transit_Del_Cb
27159     *
27160     * A callback called when the transit is deleted.
27161     */
27162    typedef void (*Elm_Transit_Del_Cb) (void *data, Elm_Transit *transit);
27163
27164    /**
27165     * Add new transit.
27166     *
27167     * @note Is not necessary to delete the transit object, it will be deleted at
27168     * the end of its operation.
27169     * @note The transit will start playing when the program enter in the main loop, is not
27170     * necessary to give a start to the transit.
27171     *
27172     * @return The transit object.
27173     *
27174     * @ingroup Transit
27175     */
27176    EAPI Elm_Transit                *elm_transit_add(void);
27177
27178    /**
27179     * Stops the animation and delete the @p transit object.
27180     *
27181     * Call this function if you wants to stop the animation before the duration
27182     * time. Make sure the @p transit object is still alive with
27183     * elm_transit_del_cb_set() function.
27184     * All added effects will be deleted, calling its repective data_free_cb
27185     * functions. The function setted by elm_transit_del_cb_set() will be called.
27186     *
27187     * @see elm_transit_del_cb_set()
27188     *
27189     * @param transit The transit object to be deleted.
27190     *
27191     * @ingroup Transit
27192     * @warning Just call this function if you are sure the transit is alive.
27193     */
27194    EAPI void                        elm_transit_del(Elm_Transit *transit) EINA_ARG_NONNULL(1);
27195
27196    /**
27197     * Add a new effect to the transit.
27198     *
27199     * @note The cb function and the data are the key to the effect. If you try to
27200     * add an already added effect, nothing is done.
27201     * @note After the first addition of an effect in @p transit, if its
27202     * effect list become empty again, the @p transit will be killed by
27203     * elm_transit_del(transit) function.
27204     *
27205     * Exemple:
27206     * @code
27207     * Elm_Transit *transit = elm_transit_add();
27208     * elm_transit_effect_add(transit,
27209     *                        elm_transit_effect_blend_op,
27210     *                        elm_transit_effect_blend_context_new(),
27211     *                        elm_transit_effect_blend_context_free);
27212     * @endcode
27213     *
27214     * @param transit The transit object.
27215     * @param transition_cb The operation function. It is called when the
27216     * animation begins, it is the function that actually performs the animation.
27217     * It is called with the @p data, @p transit and the time progression of the
27218     * animation (a double value between 0.0 and 1.0).
27219     * @param effect The context data of the effect.
27220     * @param end_cb The function to free the context data, it will be called
27221     * at the end of the effect, it must finalize the animation and free the
27222     * @p data.
27223     *
27224     * @ingroup Transit
27225     * @warning The transit free the context data at the and of the transition with
27226     * the data_free_cb function, do not use the context data in another transit.
27227     */
27228    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);
27229
27230    /**
27231     * Delete an added effect.
27232     *
27233     * This function will remove the effect from the @p transit, calling the
27234     * data_free_cb to free the @p data.
27235     *
27236     * @see elm_transit_effect_add()
27237     *
27238     * @note If the effect is not found, nothing is done.
27239     * @note If the effect list become empty, this function will call
27240     * elm_transit_del(transit), that is, it will kill the @p transit.
27241     *
27242     * @param transit The transit object.
27243     * @param transition_cb The operation function.
27244     * @param effect The context data of the effect.
27245     *
27246     * @ingroup Transit
27247     */
27248    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);
27249
27250    /**
27251     * Add new object to apply the effects.
27252     *
27253     * @note After the first addition of an object in @p transit, if its
27254     * object list become empty again, the @p transit will be killed by
27255     * elm_transit_del(transit) function.
27256     * @note If the @p obj belongs to another transit, the @p obj will be
27257     * removed from it and it will only belong to the @p transit. If the old
27258     * transit stays without objects, it will die.
27259     * @note When you add an object into the @p transit, its state from
27260     * evas_object_pass_events_get(obj) is saved, and it is applied when the
27261     * transit ends, if you change this state whith evas_object_pass_events_set()
27262     * after add the object, this state will change again when @p transit stops to
27263     * run.
27264     *
27265     * @param transit The transit object.
27266     * @param obj Object to be animated.
27267     *
27268     * @ingroup Transit
27269     * @warning It is not allowed to add a new object after transit begins to go.
27270     */
27271    EAPI void                        elm_transit_object_add(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
27272
27273    /**
27274     * Removes an added object from the transit.
27275     *
27276     * @note If the @p obj is not in the @p transit, nothing is done.
27277     * @note If the list become empty, this function will call
27278     * elm_transit_del(transit), that is, it will kill the @p transit.
27279     *
27280     * @param transit The transit object.
27281     * @param obj Object to be removed from @p transit.
27282     *
27283     * @ingroup Transit
27284     * @warning It is not allowed to remove objects after transit begins to go.
27285     */
27286    EAPI void                        elm_transit_object_remove(Elm_Transit *transit, Evas_Object *obj) EINA_ARG_NONNULL(1, 2);
27287
27288    /**
27289     * Get the objects of the transit.
27290     *
27291     * @param transit The transit object.
27292     * @return a Eina_List with the objects from the transit.
27293     *
27294     * @ingroup Transit
27295     */
27296    EAPI const Eina_List            *elm_transit_objects_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27297
27298    /**
27299     * Enable/disable keeping up the objects states.
27300     * If it is not kept, the objects states will be reset when transition ends.
27301     *
27302     * @note @p transit can not be NULL.
27303     * @note One state includes geometry, color, map data.
27304     *
27305     * @param transit The transit object.
27306     * @param state_keep Keeping or Non Keeping.
27307     *
27308     * @ingroup Transit
27309     */
27310    EAPI void                        elm_transit_objects_final_state_keep_set(Elm_Transit *transit, Eina_Bool state_keep) EINA_ARG_NONNULL(1);
27311
27312    /**
27313     * Get a value whether the objects states will be reset or not.
27314     *
27315     * @note @p transit can not be NULL
27316     *
27317     * @see elm_transit_objects_final_state_keep_set()
27318     *
27319     * @param transit The transit object.
27320     * @return EINA_TRUE means the states of the objects will be reset.
27321     * If @p transit is NULL, EINA_FALSE is returned
27322     *
27323     * @ingroup Transit
27324     */
27325    EAPI Eina_Bool                   elm_transit_objects_final_state_keep_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27326
27327    /**
27328     * Set the event enabled when transit is operating.
27329     *
27330     * If @p enabled is EINA_TRUE, the objects of the transit will receives
27331     * events from mouse and keyboard during the animation.
27332     * @note When you add an object with elm_transit_object_add(), its state from
27333     * evas_object_pass_events_get(obj) is saved, and it is applied when the
27334     * transit ends, if you change this state with evas_object_pass_events_set()
27335     * after adding the object, this state will change again when @p transit stops
27336     * to run.
27337     *
27338     * @param transit The transit object.
27339     * @param enabled Events are received when enabled is @c EINA_TRUE, and
27340     * ignored otherwise.
27341     *
27342     * @ingroup Transit
27343     */
27344    EAPI void                        elm_transit_event_enabled_set(Elm_Transit *transit, Eina_Bool enabled) EINA_ARG_NONNULL(1);
27345
27346    /**
27347     * Get the value of event enabled status.
27348     *
27349     * @see elm_transit_event_enabled_set()
27350     *
27351     * @param transit The Transit object
27352     * @return EINA_TRUE, when event is enabled. If @p transit is NULL
27353     * EINA_FALSE is returned
27354     *
27355     * @ingroup Transit
27356     */
27357    EAPI Eina_Bool                   elm_transit_event_enabled_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27358
27359    /**
27360     * Set the user-callback function when the transit is deleted.
27361     *
27362     * @note Using this function twice will overwrite the first function setted.
27363     * @note the @p transit object will be deleted after call @p cb function.
27364     *
27365     * @param transit The transit object.
27366     * @param cb Callback function pointer. This function will be called before
27367     * the deletion of the transit.
27368     * @param data Callback funtion user data. It is the @p op parameter.
27369     *
27370     * @ingroup Transit
27371     */
27372    EAPI void                        elm_transit_del_cb_set(Elm_Transit *transit, Elm_Transit_Del_Cb cb, void *data) EINA_ARG_NONNULL(1);
27373
27374    /**
27375     * Set reverse effect automatically.
27376     *
27377     * If auto reverse is setted, after running the effects with the progress
27378     * parameter from 0 to 1, it will call the effecs again with the progress
27379     * from 1 to 0. The transit will last for a time iqual to (2 * duration * repeat),
27380     * where the duration was setted with the function elm_transit_add and
27381     * the repeat with the function elm_transit_repeat_times_set().
27382     *
27383     * @param transit The transit object.
27384     * @param reverse EINA_TRUE means the auto_reverse is on.
27385     *
27386     * @ingroup Transit
27387     */
27388    EAPI void                        elm_transit_auto_reverse_set(Elm_Transit *transit, Eina_Bool reverse) EINA_ARG_NONNULL(1);
27389
27390    /**
27391     * Get if the auto reverse is on.
27392     *
27393     * @see elm_transit_auto_reverse_set()
27394     *
27395     * @param transit The transit object.
27396     * @return EINA_TRUE means auto reverse is on. If @p transit is NULL
27397     * EINA_FALSE is returned
27398     *
27399     * @ingroup Transit
27400     */
27401    EAPI Eina_Bool                   elm_transit_auto_reverse_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27402
27403    /**
27404     * Set the transit repeat count. Effect will be repeated by repeat count.
27405     *
27406     * This function sets the number of repetition the transit will run after
27407     * the first one, that is, if @p repeat is 1, the transit will run 2 times.
27408     * If the @p repeat is a negative number, it will repeat infinite times.
27409     *
27410     * @note If this function is called during the transit execution, the transit
27411     * will run @p repeat times, ignoring the times it already performed.
27412     *
27413     * @param transit The transit object
27414     * @param repeat Repeat count
27415     *
27416     * @ingroup Transit
27417     */
27418    EAPI void                        elm_transit_repeat_times_set(Elm_Transit *transit, int repeat) EINA_ARG_NONNULL(1);
27419
27420    /**
27421     * Get the transit repeat count.
27422     *
27423     * @see elm_transit_repeat_times_set()
27424     *
27425     * @param transit The Transit object.
27426     * @return The repeat count. If @p transit is NULL
27427     * 0 is returned
27428     *
27429     * @ingroup Transit
27430     */
27431    EAPI int                         elm_transit_repeat_times_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27432
27433    /**
27434     * Set the transit animation acceleration type.
27435     *
27436     * This function sets the tween mode of the transit that can be:
27437     * ELM_TRANSIT_TWEEN_MODE_LINEAR - The default mode.
27438     * ELM_TRANSIT_TWEEN_MODE_SINUSOIDAL - Starts in accelerate mode and ends decelerating.
27439     * ELM_TRANSIT_TWEEN_MODE_DECELERATE - The animation will be slowed over time.
27440     * ELM_TRANSIT_TWEEN_MODE_ACCELERATE - The animation will accelerate over time.
27441     *
27442     * @param transit The transit object.
27443     * @param tween_mode The tween type.
27444     *
27445     * @ingroup Transit
27446     */
27447    EAPI void                        elm_transit_tween_mode_set(Elm_Transit *transit, Elm_Transit_Tween_Mode tween_mode) EINA_ARG_NONNULL(1);
27448
27449    /**
27450     * Get the transit animation acceleration type.
27451     *
27452     * @note @p transit can not be NULL
27453     *
27454     * @param transit The transit object.
27455     * @return The tween type. If @p transit is NULL
27456     * ELM_TRANSIT_TWEEN_MODE_LINEAR is returned.
27457     *
27458     * @ingroup Transit
27459     */
27460    EAPI Elm_Transit_Tween_Mode      elm_transit_tween_mode_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27461
27462    /**
27463     * Set the transit animation time
27464     *
27465     * @note @p transit can not be NULL
27466     *
27467     * @param transit The transit object.
27468     * @param duration The animation time.
27469     *
27470     * @ingroup Transit
27471     */
27472    EAPI void                        elm_transit_duration_set(Elm_Transit *transit, double duration) EINA_ARG_NONNULL(1);
27473
27474    /**
27475     * Get the transit animation time
27476     *
27477     * @note @p transit can not be NULL
27478     *
27479     * @param transit The transit object.
27480     *
27481     * @return The transit animation time.
27482     *
27483     * @ingroup Transit
27484     */
27485    EAPI double                      elm_transit_duration_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27486
27487    /**
27488     * Starts the transition.
27489     * Once this API is called, the transit begins to measure the time.
27490     *
27491     * @note @p transit can not be NULL
27492     *
27493     * @param transit The transit object.
27494     *
27495     * @ingroup Transit
27496     */
27497    EAPI void                        elm_transit_go(Elm_Transit *transit) EINA_ARG_NONNULL(1);
27498
27499    /**
27500     * Pause/Resume the transition.
27501     *
27502     * If you call elm_transit_go again, the transit will be started from the
27503     * beginning, and will be unpaused.
27504     *
27505     * @note @p transit can not be NULL
27506     *
27507     * @param transit The transit object.
27508     * @param paused Whether the transition should be paused or not.
27509     *
27510     * @ingroup Transit
27511     */
27512    EAPI void                        elm_transit_paused_set(Elm_Transit *transit, Eina_Bool paused) EINA_ARG_NONNULL(1);
27513
27514    /**
27515     * Get the value of paused status.
27516     *
27517     * @see elm_transit_paused_set()
27518     *
27519     * @note @p transit can not be NULL
27520     *
27521     * @param transit The transit object.
27522     * @return EINA_TRUE means transition is paused. If @p transit is NULL
27523     * EINA_FALSE is returned
27524     *
27525     * @ingroup Transit
27526     */
27527    EAPI Eina_Bool                   elm_transit_paused_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27528
27529    /**
27530     * Get the time progression of the animation (a double value between 0.0 and 1.0).
27531     *
27532     * The value returned is a fraction (current time / total time). It
27533     * represents the progression position relative to the total.
27534     *
27535     * @note @p transit can not be NULL
27536     *
27537     * @param transit The transit object.
27538     *
27539     * @return The time progression value. If @p transit is NULL
27540     * 0 is returned
27541     *
27542     * @ingroup Transit
27543     */
27544    EAPI double                      elm_transit_progress_value_get(const Elm_Transit *transit) EINA_ARG_NONNULL(1);
27545
27546    /**
27547     * Makes the chain relationship between two transits.
27548     *
27549     * @note @p transit can not be NULL. Transit would have multiple chain transits.
27550     * @note @p chain_transit can not be NULL. Chain transits could be chained to the only one transit.
27551     *
27552     * @param transit The transit object.
27553     * @param chain_transit The chain transit object. This transit will be operated
27554     *        after transit is done.
27555     *
27556     * This function adds @p chain_transit transition to a chain after the @p
27557     * transit, and will be started as soon as @p transit ends. See @ref
27558     * transit_example_02_explained for a full example.
27559     *
27560     * @ingroup Transit
27561     */
27562    EAPI void                        elm_transit_chain_transit_add(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1, 2);
27563
27564    /**
27565     * Cut off the chain relationship between two transits.
27566     *
27567     * @note @p transit can not be NULL. Transit would have the chain relationship with @p chain transit.
27568     * @note @p chain_transit can not be NULL. Chain transits should be chained to the @p transit.
27569     *
27570     * @param transit The transit object.
27571     * @param chain_transit The chain transit object.
27572     *
27573     * This function remove the @p chain_transit transition from the @p transit.
27574     *
27575     * @ingroup Transit
27576     */
27577    EAPI void                        elm_transit_chain_transit_del(Elm_Transit *transit, Elm_Transit *chain_transit) EINA_ARG_NONNULL(1,2);
27578
27579    /**
27580     * Get the current chain transit list.
27581     *
27582     * @note @p transit can not be NULL.
27583     *
27584     * @param transit The transit object.
27585     * @return chain transit list.
27586     *
27587     * @ingroup Transit
27588     */
27589    EAPI Eina_List                  *elm_transit_chain_transits_get(const Elm_Transit *transit);
27590
27591    /**
27592     * Add the Resizing Effect to Elm_Transit.
27593     *
27594     * @note This API is one of the facades. It creates resizing effect context
27595     * and add it's required APIs to elm_transit_effect_add.
27596     *
27597     * @see elm_transit_effect_add()
27598     *
27599     * @param transit Transit object.
27600     * @param from_w Object width size when effect begins.
27601     * @param from_h Object height size when effect begins.
27602     * @param to_w Object width size when effect ends.
27603     * @param to_h Object height size when effect ends.
27604     * @return Resizing effect context data.
27605     *
27606     * @ingroup Transit
27607     */
27608    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);
27609
27610    /**
27611     * Add the Translation Effect to Elm_Transit.
27612     *
27613     * @note This API is one of the facades. It creates translation effect context
27614     * and add it's required APIs to elm_transit_effect_add.
27615     *
27616     * @see elm_transit_effect_add()
27617     *
27618     * @param transit Transit object.
27619     * @param from_dx X Position variation when effect begins.
27620     * @param from_dy Y Position variation when effect begins.
27621     * @param to_dx X Position variation when effect ends.
27622     * @param to_dy Y Position variation when effect ends.
27623     * @return Translation effect context data.
27624     *
27625     * @ingroup Transit
27626     * @warning It is highly recommended just create a transit with this effect when
27627     * the window that the objects of the transit belongs has already been created.
27628     * This is because this effect needs the geometry information about the objects,
27629     * and if the window was not created yet, it can get a wrong information.
27630     */
27631    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);
27632
27633    /**
27634     * Add the Zoom Effect to Elm_Transit.
27635     *
27636     * @note This API is one of the facades. It creates zoom effect context
27637     * and add it's required APIs to elm_transit_effect_add.
27638     *
27639     * @see elm_transit_effect_add()
27640     *
27641     * @param transit Transit object.
27642     * @param from_rate Scale rate when effect begins (1 is current rate).
27643     * @param to_rate Scale rate when effect ends.
27644     * @return Zoom effect context data.
27645     *
27646     * @ingroup Transit
27647     * @warning It is highly recommended just create a transit with this effect when
27648     * the window that the objects of the transit belongs has already been created.
27649     * This is because this effect needs the geometry information about the objects,
27650     * and if the window was not created yet, it can get a wrong information.
27651     */
27652    EAPI Elm_Transit_Effect *elm_transit_effect_zoom_add(Elm_Transit *transit, float from_rate, float to_rate);
27653
27654    /**
27655     * Add the Flip Effect to Elm_Transit.
27656     *
27657     * @note This API is one of the facades. It creates flip effect context
27658     * and add it's required APIs to elm_transit_effect_add.
27659     * @note This effect is applied to each pair of objects in the order they are listed
27660     * in the transit list of objects. The first object in the pair will be the
27661     * "front" object and the second will be the "back" object.
27662     *
27663     * @see elm_transit_effect_add()
27664     *
27665     * @param transit Transit object.
27666     * @param axis Flipping Axis(X or Y).
27667     * @param cw Flipping Direction. EINA_TRUE is clock-wise.
27668     * @return Flip effect context data.
27669     *
27670     * @ingroup Transit
27671     * @warning It is highly recommended just create a transit with this effect when
27672     * the window that the objects of the transit belongs has already been created.
27673     * This is because this effect needs the geometry information about the objects,
27674     * and if the window was not created yet, it can get a wrong information.
27675     */
27676    EAPI Elm_Transit_Effect *elm_transit_effect_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
27677
27678    /**
27679     * Add the Resizable Flip Effect to Elm_Transit.
27680     *
27681     * @note This API is one of the facades. It creates resizable flip effect context
27682     * and add it's required APIs to elm_transit_effect_add.
27683     * @note This effect is applied to each pair of objects in the order they are listed
27684     * in the transit list of objects. The first object in the pair will be the
27685     * "front" object and the second will be the "back" object.
27686     *
27687     * @see elm_transit_effect_add()
27688     *
27689     * @param transit Transit object.
27690     * @param axis Flipping Axis(X or Y).
27691     * @param cw Flipping Direction. EINA_TRUE is clock-wise.
27692     * @return Resizable flip effect context data.
27693     *
27694     * @ingroup Transit
27695     * @warning It is highly recommended just create a transit with this effect when
27696     * the window that the objects of the transit belongs has already been created.
27697     * This is because this effect needs the geometry information about the objects,
27698     * and if the window was not created yet, it can get a wrong information.
27699     */
27700    EAPI Elm_Transit_Effect *elm_transit_effect_resizable_flip_add(Elm_Transit *transit, Elm_Transit_Effect_Flip_Axis axis, Eina_Bool cw);
27701
27702    /**
27703     * Add the Wipe Effect to Elm_Transit.
27704     *
27705     * @note This API is one of the facades. It creates wipe effect context
27706     * and add it's required APIs to elm_transit_effect_add.
27707     *
27708     * @see elm_transit_effect_add()
27709     *
27710     * @param transit Transit object.
27711     * @param type Wipe type. Hide or show.
27712     * @param dir Wipe Direction.
27713     * @return Wipe effect context data.
27714     *
27715     * @ingroup Transit
27716     * @warning It is highly recommended just create a transit with this effect when
27717     * the window that the objects of the transit belongs has already been created.
27718     * This is because this effect needs the geometry information about the objects,
27719     * and if the window was not created yet, it can get a wrong information.
27720     */
27721    EAPI Elm_Transit_Effect *elm_transit_effect_wipe_add(Elm_Transit *transit, Elm_Transit_Effect_Wipe_Type type, Elm_Transit_Effect_Wipe_Dir dir);
27722
27723    /**
27724     * Add the Color Effect to Elm_Transit.
27725     *
27726     * @note This API is one of the facades. It creates color effect context
27727     * and add it's required APIs to elm_transit_effect_add.
27728     *
27729     * @see elm_transit_effect_add()
27730     *
27731     * @param transit        Transit object.
27732     * @param  from_r        RGB R when effect begins.
27733     * @param  from_g        RGB G when effect begins.
27734     * @param  from_b        RGB B when effect begins.
27735     * @param  from_a        RGB A when effect begins.
27736     * @param  to_r          RGB R when effect ends.
27737     * @param  to_g          RGB G when effect ends.
27738     * @param  to_b          RGB B when effect ends.
27739     * @param  to_a          RGB A when effect ends.
27740     * @return               Color effect context data.
27741     *
27742     * @ingroup Transit
27743     */
27744    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);
27745
27746    /**
27747     * Add the Fade Effect to Elm_Transit.
27748     *
27749     * @note This API is one of the facades. It creates fade effect context
27750     * and add it's required APIs to elm_transit_effect_add.
27751     * @note This effect is applied to each pair of objects in the order they are listed
27752     * in the transit list of objects. The first object in the pair will be the
27753     * "before" object and the second will be the "after" object.
27754     *
27755     * @see elm_transit_effect_add()
27756     *
27757     * @param transit Transit object.
27758     * @return Fade effect context data.
27759     *
27760     * @ingroup Transit
27761     * @warning It is highly recommended just create a transit with this effect when
27762     * the window that the objects of the transit belongs has already been created.
27763     * This is because this effect needs the color information about the objects,
27764     * and if the window was not created yet, it can get a wrong information.
27765     */
27766    EAPI Elm_Transit_Effect *elm_transit_effect_fade_add(Elm_Transit *transit);
27767
27768    /**
27769     * Add the Blend Effect to Elm_Transit.
27770     *
27771     * @note This API is one of the facades. It creates blend effect context
27772     * and add it's required APIs to elm_transit_effect_add.
27773     * @note This effect is applied to each pair of objects in the order they are listed
27774     * in the transit list of objects. The first object in the pair will be the
27775     * "before" object and the second will be the "after" object.
27776     *
27777     * @see elm_transit_effect_add()
27778     *
27779     * @param transit Transit object.
27780     * @return Blend effect context data.
27781     *
27782     * @ingroup Transit
27783     * @warning It is highly recommended just create a transit with this effect when
27784     * the window that the objects of the transit belongs has already been created.
27785     * This is because this effect needs the color information about the objects,
27786     * and if the window was not created yet, it can get a wrong information.
27787     */
27788    EAPI Elm_Transit_Effect *elm_transit_effect_blend_add(Elm_Transit *transit);
27789
27790    /**
27791     * Add the Rotation Effect to Elm_Transit.
27792     *
27793     * @note This API is one of the facades. It creates rotation effect context
27794     * and add it's required APIs to elm_transit_effect_add.
27795     *
27796     * @see elm_transit_effect_add()
27797     *
27798     * @param transit Transit object.
27799     * @param from_degree Degree when effect begins.
27800     * @param to_degree Degree when effect is ends.
27801     * @return Rotation effect context data.
27802     *
27803     * @ingroup Transit
27804     * @warning It is highly recommended just create a transit with this effect when
27805     * the window that the objects of the transit belongs has already been created.
27806     * This is because this effect needs the geometry information about the objects,
27807     * and if the window was not created yet, it can get a wrong information.
27808     */
27809    EAPI Elm_Transit_Effect *elm_transit_effect_rotation_add(Elm_Transit *transit, float from_degree, float to_degree);
27810
27811    /**
27812     * Add the ImageAnimation Effect to Elm_Transit.
27813     *
27814     * @note This API is one of the facades. It creates image animation effect context
27815     * and add it's required APIs to elm_transit_effect_add.
27816     * The @p images parameter is a list images paths. This list and
27817     * its contents will be deleted at the end of the effect by
27818     * elm_transit_effect_image_animation_context_free() function.
27819     *
27820     * Example:
27821     * @code
27822     * char buf[PATH_MAX];
27823     * Eina_List *images = NULL;
27824     * Elm_Transit *transi = elm_transit_add();
27825     *
27826     * snprintf(buf, sizeof(buf), "%s/images/icon_11.png", PACKAGE_DATA_DIR);
27827     * images = eina_list_append(images, eina_stringshare_add(buf));
27828     *
27829     * snprintf(buf, sizeof(buf), "%s/images/logo_small.png", PACKAGE_DATA_DIR);
27830     * images = eina_list_append(images, eina_stringshare_add(buf));
27831     * elm_transit_effect_image_animation_add(transi, images);
27832     *
27833     * @endcode
27834     *
27835     * @see elm_transit_effect_add()
27836     *
27837     * @param transit Transit object.
27838     * @param images Eina_List of images file paths. This list and
27839     * its contents will be deleted at the end of the effect by
27840     * elm_transit_effect_image_animation_context_free() function.
27841     * @return Image Animation effect context data.
27842     *
27843     * @ingroup Transit
27844     */
27845    EAPI Elm_Transit_Effect *elm_transit_effect_image_animation_add(Elm_Transit *transit, Eina_List *images);
27846    /**
27847     * @}
27848     */
27849
27850    /* Store */
27851    typedef struct _Elm_Store                      Elm_Store;
27852    typedef struct _Elm_Store_DBsystem             Elm_Store_DBsystem;
27853    typedef struct _Elm_Store_Filesystem           Elm_Store_Filesystem;
27854    typedef struct _Elm_Store_Item                 Elm_Store_Item;
27855    typedef struct _Elm_Store_Item_DBsystem        Elm_Store_Item_DBsystem;
27856    typedef struct _Elm_Store_Item_Filesystem      Elm_Store_Item_Filesystem;
27857    typedef struct _Elm_Store_Item_Info            Elm_Store_Item_Info;
27858    typedef struct _Elm_Store_Item_Info_Filesystem Elm_Store_Item_Info_Filesystem;
27859    typedef struct _Elm_Store_Item_Mapping         Elm_Store_Item_Mapping;
27860    typedef struct _Elm_Store_Item_Mapping_Empty   Elm_Store_Item_Mapping_Empty;
27861    typedef struct _Elm_Store_Item_Mapping_Icon    Elm_Store_Item_Mapping_Icon;
27862    typedef struct _Elm_Store_Item_Mapping_Photo   Elm_Store_Item_Mapping_Photo;
27863    typedef struct _Elm_Store_Item_Mapping_Custom  Elm_Store_Item_Mapping_Custom;
27864
27865    typedef Eina_Bool (*Elm_Store_Item_List_Cb) (void *data, Elm_Store_Item_Info *info);
27866    typedef void      (*Elm_Store_Item_Fetch_Cb) (void *data, Elm_Store_Item *sti, Elm_Store_Item_Info *info);
27867    typedef void      (*Elm_Store_Item_Unfetch_Cb) (void *data, Elm_Store_Item *sti, Elm_Store_Item_Info *info);
27868    typedef void      (*Elm_Store_Item_Select_Cb) (void *data, Elm_Store_Item *sti);
27869    typedef int       (*Elm_Store_Item_Sort_Cb) (void *data, Elm_Store_Item_Info *info1, Elm_Store_Item_Info *info2);
27870    typedef void      (*Elm_Store_Item_Free_Cb) (void *data, Elm_Store_Item_Info *info);
27871    typedef void     *(*Elm_Store_Item_Mapping_Cb) (void *data, Elm_Store_Item *sti, const char *part);
27872
27873    typedef enum
27874      {
27875         ELM_STORE_ITEM_MAPPING_NONE = 0,
27876         ELM_STORE_ITEM_MAPPING_LABEL, // const char * -> label
27877         ELM_STORE_ITEM_MAPPING_STATE, // Eina_Bool -> state
27878         ELM_STORE_ITEM_MAPPING_ICON, // char * -> icon path
27879         ELM_STORE_ITEM_MAPPING_PHOTO, // char * -> photo path
27880         ELM_STORE_ITEM_MAPPING_CUSTOM, // item->custom(it->data, it, part) -> void * (-> any)
27881         // can add more here as needed by common apps
27882         ELM_STORE_ITEM_MAPPING_LAST
27883      } Elm_Store_Item_Mapping_Type;
27884
27885    struct _Elm_Store_Item_Mapping_Icon
27886      {
27887         // FIXME: allow edje file icons
27888         int                   w, h;
27889         Elm_Icon_Lookup_Order lookup_order;
27890         Eina_Bool             standard_name : 1;
27891         Eina_Bool             no_scale : 1;
27892         Eina_Bool             smooth : 1;
27893         Eina_Bool             scale_up : 1;
27894         Eina_Bool             scale_down : 1;
27895      };
27896
27897    struct _Elm_Store_Item_Mapping_Empty
27898      {
27899         Eina_Bool             dummy;
27900      };
27901
27902    struct _Elm_Store_Item_Mapping_Photo
27903      {
27904         int                   size;
27905      };
27906
27907    struct _Elm_Store_Item_Mapping_Custom
27908      {
27909         Elm_Store_Item_Mapping_Cb func;
27910      };
27911
27912    struct _Elm_Store_Item_Mapping
27913      {
27914         Elm_Store_Item_Mapping_Type     type;
27915         const char                     *part;
27916         int                             offset;
27917         union
27918           {
27919              Elm_Store_Item_Mapping_Empty  empty;
27920              Elm_Store_Item_Mapping_Icon   icon;
27921              Elm_Store_Item_Mapping_Photo  photo;
27922              Elm_Store_Item_Mapping_Custom custom;
27923              // add more types here
27924           } details;
27925      };
27926
27927    struct _Elm_Store_Item_Info
27928      {
27929         int                           index;
27930         int                           item_type;
27931         int                           group_index;
27932         Eina_Bool                     rec_item;
27933         int                           pre_group_index;
27934
27935         Elm_Genlist_Item_Class       *item_class;
27936         const Elm_Store_Item_Mapping *mapping;
27937         void                         *data;
27938         char                         *sort_id;
27939      };
27940
27941    struct _Elm_Store_Item_Info_Filesystem
27942      {
27943         Elm_Store_Item_Info  base;
27944         char                *path;
27945      };
27946
27947 #define ELM_STORE_ITEM_MAPPING_END { ELM_STORE_ITEM_MAPPING_NONE, NULL, 0, { .empty = { EINA_TRUE } } }
27948 #define ELM_STORE_ITEM_MAPPING_OFFSET(st, it) offsetof(st, it)
27949
27950    EAPI Elm_Store              *elm_store_dbsystem_new(void);
27951    EAPI void                    elm_store_item_count_set(Elm_Store *st, int count) EINA_ARG_NONNULL(1);
27952    EAPI void                    elm_store_item_select_func_set(Elm_Store *st, Elm_Store_Item_Select_Cb func, const void *data) EINA_ARG_NONNULL(1);
27953    EAPI void                    elm_store_item_sort_func_set(Elm_Store *st, Elm_Store_Item_Sort_Cb func, const void *data) EINA_ARG_NONNULL(1);
27954    EAPI void                    elm_store_item_free_func_set(Elm_Store *st, Elm_Store_Item_Free_Cb func, const void *data) EINA_ARG_NONNULL(1);
27955    EAPI int                     elm_store_item_data_index_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27956    EAPI void                   *elm_store_dbsystem_db_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27957    EAPI void                    elm_store_dbsystem_db_set(Elm_Store *store, void *pDB) EINA_ARG_NONNULL(1);
27958    EAPI int                     elm_store_item_index_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27959    EAPI Elm_Store_Item         *elm_store_item_add(Elm_Store *st, Elm_Store_Item_Info *info) EINA_ARG_NONNULL(1);
27960    EAPI void                    elm_store_item_update(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27961    EAPI void                    elm_store_visible_items_update(Elm_Store *st) EINA_ARG_NONNULL(1);
27962    EAPI void                    elm_store_item_del(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27963    EAPI void                    elm_store_free(Elm_Store *st);
27964    EAPI Elm_Store              *elm_store_filesystem_new(void);
27965    EAPI void                    elm_store_filesystem_directory_set(Elm_Store *st, const char *dir) EINA_ARG_NONNULL(1);
27966    EAPI const char             *elm_store_filesystem_directory_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27967    EAPI const char             *elm_store_item_filesystem_path_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27968
27969    EAPI void                    elm_store_target_genlist_set(Elm_Store *st, Evas_Object *obj) EINA_ARG_NONNULL(1);
27970
27971    EAPI void                    elm_store_cache_set(Elm_Store *st, int max) EINA_ARG_NONNULL(1);
27972    EAPI int                     elm_store_cache_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27973    EAPI void                    elm_store_list_func_set(Elm_Store *st, Elm_Store_Item_List_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
27974    EAPI void                    elm_store_fetch_func_set(Elm_Store *st, Elm_Store_Item_Fetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
27975    EAPI void                    elm_store_fetch_thread_set(Elm_Store *st, Eina_Bool use_thread) EINA_ARG_NONNULL(1);
27976    EAPI Eina_Bool               elm_store_fetch_thread_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27977
27978    EAPI void                    elm_store_unfetch_func_set(Elm_Store *st, Elm_Store_Item_Unfetch_Cb func, const void *data) EINA_ARG_NONNULL(1, 2);
27979    EAPI void                    elm_store_sorted_set(Elm_Store *st, Eina_Bool sorted) EINA_ARG_NONNULL(1);
27980    EAPI Eina_Bool               elm_store_sorted_get(const Elm_Store *st) EINA_ARG_NONNULL(1);
27981    EAPI void                    elm_store_item_data_set(Elm_Store_Item *sti, void *data) EINA_ARG_NONNULL(1);
27982    EAPI void                   *elm_store_item_data_get(Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27983    EAPI const Elm_Store        *elm_store_item_store_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27984    EAPI const Elm_Genlist_Item *elm_store_item_genlist_item_get(const Elm_Store_Item *sti) EINA_ARG_NONNULL(1);
27985
27986    /**
27987     * @defgroup SegmentControl SegmentControl
27988     * @ingroup Elementary
27989     *
27990     * @image html img/widget/segment_control/preview-00.png
27991     * @image latex img/widget/segment_control/preview-00.eps width=\textwidth
27992     *
27993     * @image html img/segment_control.png
27994     * @image latex img/segment_control.eps width=\textwidth
27995     *
27996     * Segment control widget is a horizontal control made of multiple segment
27997     * items, each segment item functioning similar to discrete two state button.
27998     * A segment control groups the items together and provides compact
27999     * single button with multiple equal size segments.
28000     *
28001     * Segment item size is determined by base widget
28002     * size and the number of items added.
28003     * Only one segment item can be at selected state. A segment item can display
28004     * combination of Text and any Evas_Object like Images or other widget.
28005     *
28006     * Smart callbacks one can listen to:
28007     * - "changed" - When the user clicks on a segment item which is not
28008     *   previously selected and get selected. The event_info parameter is the
28009     *   segment item pointer.
28010     *
28011     * Available styles for it:
28012     * - @c "default"
28013     *
28014     * Here is an example on its usage:
28015     * @li @ref segment_control_example
28016     */
28017
28018    /**
28019     * @addtogroup SegmentControl
28020     * @{
28021     */
28022
28023    typedef struct _Elm_Segment_Item Elm_Segment_Item; /**< Item handle for a segment control widget. */
28024
28025    /**
28026     * Add a new segment control widget to the given parent Elementary
28027     * (container) object.
28028     *
28029     * @param parent The parent object.
28030     * @return a new segment control widget handle or @c NULL, on errors.
28031     *
28032     * This function inserts a new segment control widget on the canvas.
28033     *
28034     * @ingroup SegmentControl
28035     */
28036    EAPI Evas_Object      *elm_segment_control_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
28037
28038    /**
28039     * Append a new item to the segment control object.
28040     *
28041     * @param obj The segment control object.
28042     * @param icon The icon object to use for the left side of the item. An
28043     * icon can be any Evas object, but usually it is an icon created
28044     * with elm_icon_add().
28045     * @param label The label of the item.
28046     *        Note that, NULL is different from empty string "".
28047     * @return The created item or @c NULL upon failure.
28048     *
28049     * A new item will be created and appended to the segment control, i.e., will
28050     * be set as @b last item.
28051     *
28052     * If it should be inserted at another position,
28053     * elm_segment_control_item_insert_at() should be used instead.
28054     *
28055     * Items created with this function can be deleted with function
28056     * elm_segment_control_item_del() or elm_segment_control_item_del_at().
28057     *
28058     * @note @p label set to @c NULL is different from empty string "".
28059     * If an item
28060     * only has icon, it will be displayed bigger and centered. If it has
28061     * icon and label, even that an empty string, icon will be smaller and
28062     * positioned at left.
28063     *
28064     * Simple example:
28065     * @code
28066     * sc = elm_segment_control_add(win);
28067     * ic = elm_icon_add(win);
28068     * elm_icon_file_set(ic, "path/to/image", NULL);
28069     * elm_icon_scale_set(ic, EINA_TRUE, EINA_TRUE);
28070     * elm_segment_control_item_add(sc, ic, "label");
28071     * evas_object_show(sc);
28072     * @endcode
28073     *
28074     * @see elm_segment_control_item_insert_at()
28075     * @see elm_segment_control_item_del()
28076     *
28077     * @ingroup SegmentControl
28078     */
28079    EAPI Elm_Segment_Item *elm_segment_control_item_add(Evas_Object *obj, Evas_Object *icon, const char *label) EINA_ARG_NONNULL(1);
28080
28081    /**
28082     * Insert a new item to the segment control object at specified position.
28083     *
28084     * @param obj The segment control object.
28085     * @param icon The icon object to use for the left side of the item. An
28086     * icon can be any Evas object, but usually it is an icon created
28087     * with elm_icon_add().
28088     * @param label The label of the item.
28089     * @param index Item position. Value should be between 0 and items count.
28090     * @return The created item or @c NULL upon failure.
28091
28092     * Index values must be between @c 0, when item will be prepended to
28093     * segment control, and items count, that can be get with
28094     * elm_segment_control_item_count_get(), case when item will be appended
28095     * to segment control, just like elm_segment_control_item_add().
28096     *
28097     * Items created with this function can be deleted with function
28098     * elm_segment_control_item_del() or elm_segment_control_item_del_at().
28099     *
28100     * @note @p label set to @c NULL is different from empty string "".
28101     * If an item
28102     * only has icon, it will be displayed bigger and centered. If it has
28103     * icon and label, even that an empty string, icon will be smaller and
28104     * positioned at left.
28105     *
28106     * @see elm_segment_control_item_add()
28107     * @see elm_segment_control_item_count_get()
28108     * @see elm_segment_control_item_del()
28109     *
28110     * @ingroup SegmentControl
28111     */
28112    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);
28113
28114    /**
28115     * Remove a segment control item from its parent, deleting it.
28116     *
28117     * @param it The item to be removed.
28118     *
28119     * Items can be added with elm_segment_control_item_add() or
28120     * elm_segment_control_item_insert_at().
28121     *
28122     * @ingroup SegmentControl
28123     */
28124    EAPI void              elm_segment_control_item_del(Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
28125
28126    /**
28127     * Remove a segment control item at given index from its parent,
28128     * deleting it.
28129     *
28130     * @param obj The segment control object.
28131     * @param index The position of the segment control item to be deleted.
28132     *
28133     * Items can be added with elm_segment_control_item_add() or
28134     * elm_segment_control_item_insert_at().
28135     *
28136     * @ingroup SegmentControl
28137     */
28138    EAPI void              elm_segment_control_item_del_at(Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
28139
28140    /**
28141     * Get the Segment items count from segment control.
28142     *
28143     * @param obj The segment control object.
28144     * @return Segment items count.
28145     *
28146     * It will just return the number of items added to segment control @p obj.
28147     *
28148     * @ingroup SegmentControl
28149     */
28150    EAPI int               elm_segment_control_item_count_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28151
28152    /**
28153     * Get the item placed at specified index.
28154     *
28155     * @param obj The segment control object.
28156     * @param index The index of the segment item.
28157     * @return The segment control item or @c NULL on failure.
28158     *
28159     * Index is the position of an item in segment control widget. Its
28160     * range is from @c 0 to <tt> count - 1 </tt>.
28161     * Count is the number of items, that can be get with
28162     * elm_segment_control_item_count_get().
28163     *
28164     * @ingroup SegmentControl
28165     */
28166    EAPI Elm_Segment_Item *elm_segment_control_item_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
28167
28168    /**
28169     * Get the label of item.
28170     *
28171     * @param obj The segment control object.
28172     * @param index The index of the segment item.
28173     * @return The label of the item at @p index.
28174     *
28175     * The return value is a pointer to the label associated to the item when
28176     * it was created, with function elm_segment_control_item_add(), or later
28177     * with function elm_segment_control_item_label_set. If no label
28178     * was passed as argument, it will return @c NULL.
28179     *
28180     * @see elm_segment_control_item_label_set() for more details.
28181     * @see elm_segment_control_item_add()
28182     *
28183     * @ingroup SegmentControl
28184     */
28185    EAPI const char       *elm_segment_control_item_label_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
28186
28187    /**
28188     * Set the label of item.
28189     *
28190     * @param it The item of segment control.
28191     * @param text The label of item.
28192     *
28193     * The label to be displayed by the item.
28194     * Label will be at right of the icon (if set).
28195     *
28196     * If a label was passed as argument on item creation, with function
28197     * elm_control_segment_item_add(), it will be already
28198     * displayed by the item.
28199     *
28200     * @see elm_segment_control_item_label_get()
28201     * @see elm_segment_control_item_add()
28202     *
28203     * @ingroup SegmentControl
28204     */
28205    EAPI void              elm_segment_control_item_label_set(Elm_Segment_Item* it, const char* label) EINA_ARG_NONNULL(1);
28206
28207    /**
28208     * Get the icon associated to the item.
28209     *
28210     * @param obj The segment control object.
28211     * @param index The index of the segment item.
28212     * @return The left side icon associated to the item at @p index.
28213     *
28214     * The return value is a pointer to the icon associated to the item when
28215     * it was created, with function elm_segment_control_item_add(), or later
28216     * with function elm_segment_control_item_icon_set(). If no icon
28217     * was passed as argument, it will return @c NULL.
28218     *
28219     * @see elm_segment_control_item_add()
28220     * @see elm_segment_control_item_icon_set()
28221     *
28222     * @ingroup SegmentControl
28223     */
28224    EAPI Evas_Object      *elm_segment_control_item_icon_get(const Evas_Object *obj, int index) EINA_ARG_NONNULL(1);
28225
28226    /**
28227     * Set the icon associated to the item.
28228     *
28229     * @param it The segment control item.
28230     * @param icon The icon object to associate with @p it.
28231     *
28232     * The icon object to use at left side of the item. An
28233     * icon can be any Evas object, but usually it is an icon created
28234     * with elm_icon_add().
28235     *
28236     * Once the icon object is set, a previously set one will be deleted.
28237     * @warning Setting the same icon for two items will cause the icon to
28238     * dissapear from the first item.
28239     *
28240     * If an icon was passed as argument on item creation, with function
28241     * elm_segment_control_item_add(), it will be already
28242     * associated to the item.
28243     *
28244     * @see elm_segment_control_item_add()
28245     * @see elm_segment_control_item_icon_get()
28246     *
28247     * @ingroup SegmentControl
28248     */
28249    EAPI void              elm_segment_control_item_icon_set(Elm_Segment_Item *it, Evas_Object *icon) EINA_ARG_NONNULL(1);
28250
28251    /**
28252     * Get the index of an item.
28253     *
28254     * @param it The segment control item.
28255     * @return The position of item in segment control widget.
28256     *
28257     * Index is the position of an item in segment control widget. Its
28258     * range is from @c 0 to <tt> count - 1 </tt>.
28259     * Count is the number of items, that can be get with
28260     * elm_segment_control_item_count_get().
28261     *
28262     * @ingroup SegmentControl
28263     */
28264    EAPI int               elm_segment_control_item_index_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
28265
28266    /**
28267     * Get the base object of the item.
28268     *
28269     * @param it The segment control item.
28270     * @return The base object associated with @p it.
28271     *
28272     * Base object is the @c Evas_Object that represents that item.
28273     *
28274     * @ingroup SegmentControl
28275     */
28276    EAPI Evas_Object      *elm_segment_control_item_object_get(const Elm_Segment_Item *it) EINA_ARG_NONNULL(1);
28277
28278    /**
28279     * Get the selected item.
28280     *
28281     * @param obj The segment control object.
28282     * @return The selected item or @c NULL if none of segment items is
28283     * selected.
28284     *
28285     * The selected item can be unselected with function
28286     * elm_segment_control_item_selected_set().
28287     *
28288     * The selected item always will be highlighted on segment control.
28289     *
28290     * @ingroup SegmentControl
28291     */
28292    EAPI Elm_Segment_Item *elm_segment_control_item_selected_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
28293
28294    /**
28295     * Set the selected state of an item.
28296     *
28297     * @param it The segment control item
28298     * @param select The selected state
28299     *
28300     * This sets the selected state of the given item @p it.
28301     * @c EINA_TRUE for selected, @c EINA_FALSE for not selected.
28302     *
28303     * If a new item is selected the previosly selected will be unselected.
28304     * Previoulsy selected item can be get with function
28305     * elm_segment_control_item_selected_get().
28306     *
28307     * The selected item always will be highlighted on segment control.
28308     *
28309     * @see elm_segment_control_item_selected_get()
28310     *
28311     * @ingroup SegmentControl
28312     */
28313    EAPI void              elm_segment_control_item_selected_set(Elm_Segment_Item *it, Eina_Bool select) EINA_ARG_NONNULL(1);
28314
28315    /**
28316     * @}
28317     */
28318
28319    /**
28320     * @defgroup Grid Grid
28321     *
28322     * The grid is a grid layout widget that lays out a series of children as a
28323     * fixed "grid" of widgets using a given percentage of the grid width and
28324     * height each using the child object.
28325     *
28326     * The Grid uses a "Virtual resolution" that is stretched to fill the grid
28327     * widgets size itself. The default is 100 x 100, so that means the
28328     * position and sizes of children will effectively be percentages (0 to 100)
28329     * of the width or height of the grid widget
28330     *
28331     * @{
28332     */
28333
28334    /**
28335     * Add a new grid to the parent
28336     *
28337     * @param parent The parent object
28338     * @return The new object or NULL if it cannot be created
28339     *
28340     * @ingroup Grid
28341     */
28342    EAPI Evas_Object *elm_grid_add(Evas_Object *parent);
28343
28344    /**
28345     * Set the virtual size of the grid
28346     *
28347     * @param obj The grid object
28348     * @param w The virtual width of the grid
28349     * @param h The virtual height of the grid
28350     *
28351     * @ingroup Grid
28352     */
28353    EAPI void         elm_grid_size_set(Evas_Object *obj, int w, int h);
28354
28355    /**
28356     * Get the virtual size of the grid
28357     *
28358     * @param obj The grid object
28359     * @param w Pointer to integer to store the virtual width of the grid
28360     * @param h Pointer to integer to store the virtual height of the grid
28361     *
28362     * @ingroup Grid
28363     */
28364    EAPI void         elm_grid_size_get(Evas_Object *obj, int *w, int *h);
28365
28366    /**
28367     * Pack child at given position and size
28368     *
28369     * @param obj The grid object
28370     * @param subobj The child to pack
28371     * @param x The virtual x coord at which to pack it
28372     * @param y The virtual y coord at which to pack it
28373     * @param w The virtual width at which to pack it
28374     * @param h The virtual height at which to pack it
28375     *
28376     * @ingroup Grid
28377     */
28378    EAPI void         elm_grid_pack(Evas_Object *obj, Evas_Object *subobj, int x, int y, int w, int h);
28379
28380    /**
28381     * Unpack a child from a grid object
28382     *
28383     * @param obj The grid object
28384     * @param subobj The child to unpack
28385     *
28386     * @ingroup Grid
28387     */
28388    EAPI void         elm_grid_unpack(Evas_Object *obj, Evas_Object *subobj);
28389
28390    /**
28391     * Faster way to remove all child objects from a grid object.
28392     *
28393     * @param obj The grid object
28394     * @param clear If true, it will delete just removed children
28395     *
28396     * @ingroup Grid
28397     */
28398    EAPI void         elm_grid_clear(Evas_Object *obj, Eina_Bool clear);
28399
28400    /**
28401     * Set packing of an existing child at to position and size
28402     *
28403     * @param subobj The child to set packing of
28404     * @param x The virtual x coord at which to pack it
28405     * @param y The virtual y coord at which to pack it
28406     * @param w The virtual width at which to pack it
28407     * @param h The virtual height at which to pack it
28408     *
28409     * @ingroup Grid
28410     */
28411    EAPI void         elm_grid_pack_set(Evas_Object *subobj, int x, int y, int w, int h);
28412
28413    /**
28414     * get packing of a child
28415     *
28416     * @param subobj The child to query
28417     * @param x Pointer to integer to store the virtual x coord
28418     * @param y Pointer to integer to store the virtual y coord
28419     * @param w Pointer to integer to store the virtual width
28420     * @param h Pointer to integer to store the virtual height
28421     *
28422     * @ingroup Grid
28423     */
28424    EAPI void         elm_grid_pack_get(Evas_Object *subobj, int *x, int *y, int *w, int *h);
28425
28426    /**
28427     * @}
28428     */
28429
28430    EAPI Evas_Object *elm_factory_add(Evas_Object *parent);
28431    EINA_DEPRECATED EAPI void         elm_factory_content_set(Evas_Object *obj, Evas_Object *content);
28432    EINA_DEPRECATED EAPI Evas_Object *elm_factory_content_get(const Evas_Object *obj);
28433    EAPI void         elm_factory_maxmin_mode_set(Evas_Object *obj, Eina_Bool enabled);
28434    EAPI Eina_Bool    elm_factory_maxmin_mode_get(const Evas_Object *obj);
28435    EAPI void         elm_factory_maxmin_reset_set(Evas_Object *obj);
28436
28437    /**
28438     * @defgroup Video Video
28439     *
28440     * @addtogroup Video
28441     * @{
28442     *
28443     * Elementary comes with two object that help design application that need
28444     * to display video. The main one, Elm_Video, display a video by using Emotion.
28445     * It does embedded the video inside an Edje object, so you can do some
28446     * animation depending on the video state change. It does also implement a
28447     * ressource management policy to remove this burden from the application writer.
28448     *
28449     * The second one, Elm_Player is a video player that need to be linked with and Elm_Video.
28450     * It take care of updating its content according to Emotion event and provide a
28451     * way to theme itself. It also does automatically raise the priority of the
28452     * linked Elm_Video so it will use the video decoder if available. It also does
28453     * activate the remember function on the linked Elm_Video object.
28454     *
28455     * Signals that you can add callback for are :
28456     *
28457     * "forward,clicked" - the user clicked the forward button.
28458     * "info,clicked" - the user clicked the info button.
28459     * "next,clicked" - the user clicked the next button.
28460     * "pause,clicked" - the user clicked the pause button.
28461     * "play,clicked" - the user clicked the play button.
28462     * "prev,clicked" - the user clicked the prev button.
28463     * "rewind,clicked" - the user clicked the rewind button.
28464     * "stop,clicked" - the user clicked the stop button.
28465     * 
28466     * Default contents parts of the player widget that you can use for are:
28467     * @li "video" - A video of the player
28468     * 
28469     */
28470
28471    /**
28472     * @brief Add a new Elm_Player object to the given parent Elementary (container) object.
28473     *
28474     * @param parent The parent object
28475     * @return a new player widget handle or @c NULL, on errors.
28476     *
28477     * This function inserts a new player widget on the canvas.
28478     *
28479     * @see elm_object_part_content_set()
28480     *
28481     * @ingroup Video
28482     */
28483    EAPI Evas_Object *elm_player_add(Evas_Object *parent);
28484
28485    /**
28486     * @brief Link a Elm_Payer with an Elm_Video object.
28487     *
28488     * @param player the Elm_Player object.
28489     * @param video The Elm_Video object.
28490     *
28491     * This mean that action on the player widget will affect the
28492     * video object and the state of the video will be reflected in
28493     * the player itself.
28494     *
28495     * @see elm_player_add()
28496     * @see elm_video_add()
28497     * @deprecated use elm_object_part_content_set() instead
28498     *
28499     * @ingroup Video
28500     */
28501    EINA_DEPRECATED EAPI void elm_player_video_set(Evas_Object *player, Evas_Object *video);
28502
28503    /**
28504     * @brief Add a new Elm_Video object to the given parent Elementary (container) object.
28505     *
28506     * @param parent The parent object
28507     * @return a new video widget handle or @c NULL, on errors.
28508     *
28509     * This function inserts a new video widget on the canvas.
28510     *
28511     * @seeelm_video_file_set()
28512     * @see elm_video_uri_set()
28513     *
28514     * @ingroup Video
28515     */
28516    EAPI Evas_Object *elm_video_add(Evas_Object *parent);
28517
28518    /**
28519     * @brief Define the file that will be the video source.
28520     *
28521     * @param video The video object to define the file for.
28522     * @param filename The file to target.
28523     *
28524     * This function will explicitly define a filename as a source
28525     * for the video of the Elm_Video object.
28526     *
28527     * @see elm_video_uri_set()
28528     * @see elm_video_add()
28529     * @see elm_player_add()
28530     *
28531     * @ingroup Video
28532     */
28533    EAPI void elm_video_file_set(Evas_Object *video, const char *filename);
28534
28535    /**
28536     * @brief Define the uri that will be the video source.
28537     *
28538     * @param video The video object to define the file for.
28539     * @param uri The uri to target.
28540     *
28541     * This function will define an uri as a source for the video of the
28542     * Elm_Video object. URI could be remote source of video, like http:// or local source
28543     * like for example WebCam who are most of the time v4l2:// (but that depend and
28544     * you should use Emotion API to request and list the available Webcam on your system).
28545     *
28546     * @see elm_video_file_set()
28547     * @see elm_video_add()
28548     * @see elm_player_add()
28549     *
28550     * @ingroup Video
28551     */
28552    EAPI void elm_video_uri_set(Evas_Object *video, const char *uri);
28553
28554    /**
28555     * @brief Get the underlying Emotion object.
28556     *
28557     * @param video The video object to proceed the request on.
28558     * @return the underlying Emotion object.
28559     *
28560     * @ingroup Video
28561     */
28562    EAPI Evas_Object *elm_video_emotion_get(const Evas_Object *video);
28563
28564    /**
28565     * @brief Start to play the video
28566     *
28567     * @param video The video object to proceed the request on.
28568     *
28569     * Start to play the video and cancel all suspend state.
28570     *
28571     * @ingroup Video
28572     */
28573    EAPI void elm_video_play(Evas_Object *video);
28574
28575    /**
28576     * @brief Pause the video
28577     *
28578     * @param video The video object to proceed the request on.
28579     *
28580     * Pause the video and start a timer to trigger suspend mode.
28581     *
28582     * @ingroup Video
28583     */
28584    EAPI void elm_video_pause(Evas_Object *video);
28585
28586    /**
28587     * @brief Stop the video
28588     *
28589     * @param video The video object to proceed the request on.
28590     *
28591     * Stop the video and put the emotion in deep sleep mode.
28592     *
28593     * @ingroup Video
28594     */
28595    EAPI void elm_video_stop(Evas_Object *video);
28596
28597    /**
28598     * @brief Is the video actually playing.
28599     *
28600     * @param video The video object to proceed the request on.
28601     * @return EINA_TRUE if the video is actually playing.
28602     *
28603     * You should consider watching event on the object instead of polling
28604     * the object state.
28605     *
28606     * @ingroup Video
28607     */
28608    EAPI Eina_Bool elm_video_is_playing(const Evas_Object *video);
28609
28610    /**
28611     * @brief Is it possible to seek inside the video.
28612     *
28613     * @param video The video object to proceed the request on.
28614     * @return EINA_TRUE if is possible to seek inside the video.
28615     *
28616     * @ingroup Video
28617     */
28618    EAPI Eina_Bool elm_video_is_seekable(const Evas_Object *video);
28619
28620    /**
28621     * @brief Is the audio muted.
28622     *
28623     * @param video The video object to proceed the request on.
28624     * @return EINA_TRUE if the audio is muted.
28625     *
28626     * @ingroup Video
28627     */
28628    EAPI Eina_Bool elm_video_audio_mute_get(const Evas_Object *video);
28629
28630    /**
28631     * @brief Change the mute state of the Elm_Video object.
28632     *
28633     * @param video The video object to proceed the request on.
28634     * @param mute The new mute state.
28635     *
28636     * @ingroup Video
28637     */
28638    EAPI void elm_video_audio_mute_set(Evas_Object *video, Eina_Bool mute);
28639
28640    /**
28641     * @brief Get the audio level of the current video.
28642     *
28643     * @param video The video object to proceed the request on.
28644     * @return the current audio level.
28645     *
28646     * @ingroup Video
28647     */
28648    EAPI double elm_video_audio_level_get(const Evas_Object *video);
28649
28650    /**
28651     * @brief Set the audio level of anElm_Video object.
28652     *
28653     * @param video The video object to proceed the request on.
28654     * @param volume The new audio volume.
28655     *
28656     * @ingroup Video
28657     */
28658    EAPI void elm_video_audio_level_set(Evas_Object *video, double volume);
28659
28660    EAPI double elm_video_play_position_get(const Evas_Object *video);
28661    EAPI void elm_video_play_position_set(Evas_Object *video, double position);
28662    EAPI double elm_video_play_length_get(const Evas_Object *video);
28663    EAPI void elm_video_remember_position_set(Evas_Object *video, Eina_Bool remember);
28664    EAPI Eina_Bool elm_video_remember_position_get(const Evas_Object *video);
28665    EAPI const char *elm_video_title_get(const Evas_Object *video);
28666    /**
28667     * @}
28668     */
28669
28670    // FIXME: incomplete - carousel. don't use this until this comment is removed
28671    typedef struct _Elm_Carousel_Item Elm_Carousel_Item;
28672    EAPI Evas_Object       *elm_carousel_add(Evas_Object *parent);
28673    EAPI Elm_Carousel_Item *elm_carousel_item_add(Evas_Object *obj, Evas_Object *icon, const char *label, Evas_Smart_Cb func, const void *data);
28674    EAPI void               elm_carousel_item_del(Elm_Carousel_Item *item);
28675    EAPI void               elm_carousel_item_select(Elm_Carousel_Item *item);
28676    /* smart callbacks called:
28677     * "clicked" - when the user clicks on a carousel item and becomes selected
28678     */
28679
28680    /* datefield */
28681
28682    typedef enum _Elm_Datefield_ItemType
28683      {
28684         ELM_DATEFIELD_YEAR = 0,
28685         ELM_DATEFIELD_MONTH,
28686         ELM_DATEFIELD_DATE,
28687         ELM_DATEFIELD_HOUR,
28688         ELM_DATEFIELD_MINUTE,
28689         ELM_DATEFIELD_AMPM
28690      } Elm_Datefield_ItemType;
28691
28692    EAPI Evas_Object *elm_datefield_add(Evas_Object *parent);
28693    EAPI void         elm_datefield_format_set(Evas_Object *obj, const char *fmt);
28694    EAPI char        *elm_datefield_format_get(const Evas_Object *obj);
28695    EAPI void         elm_datefield_item_enabled_set(Evas_Object *obj, Elm_Datefield_ItemType itemtype, Eina_Bool enable);
28696    EAPI Eina_Bool    elm_datefield_item_enabled_get(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
28697    EAPI void         elm_datefield_item_value_set(Evas_Object *obj, Elm_Datefield_ItemType itemtype, int value);
28698    EAPI int          elm_datefield_item_value_get(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
28699    EAPI void         elm_datefield_item_min_set(Evas_Object *obj, Elm_Datefield_ItemType itemtype, int value, Eina_Bool abs_limit);
28700    EAPI int          elm_datefield_item_min_get(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
28701    EAPI Eina_Bool    elm_datefield_item_min_is_absolute(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
28702    EAPI void         elm_datefield_item_max_set(Evas_Object *obj, Elm_Datefield_ItemType itemtype, int value, Eina_Bool abs_limit);
28703    EAPI int          elm_datefield_item_max_get(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
28704    EAPI Eina_Bool    elm_datefield_item_max_is_absolute(const Evas_Object *obj, Elm_Datefield_ItemType itemtype);
28705  
28706    /* smart callbacks called:
28707    * "changed" - when datefield value is changed, this signal is sent.
28708    */
28709
28710 ////////////////////// DEPRECATED ///////////////////////////////////
28711
28712    typedef enum _Elm_Datefield_Layout
28713      {
28714         ELM_DATEFIELD_LAYOUT_TIME,
28715         ELM_DATEFIELD_LAYOUT_DATE,
28716         ELM_DATEFIELD_LAYOUT_DATEANDTIME
28717      } Elm_Datefield_Layout;
28718
28719    EINA_DEPRECATED EAPI void         elm_datefield_layout_set(Evas_Object *obj, Elm_Datefield_Layout layout);
28720    EINA_DEPRECATED EAPI Elm_Datefield_Layout elm_datefield_layout_get(const Evas_Object *obj);
28721    EINA_DEPRECATED EAPI void         elm_datefield_date_format_set(Evas_Object *obj, const char *fmt);
28722    EINA_DEPRECATED EAPI const char  *elm_datefield_date_format_get(const Evas_Object *obj);
28723    EINA_DEPRECATED EAPI void         elm_datefield_time_mode_set(Evas_Object *obj, Eina_Bool mode);
28724    EINA_DEPRECATED EAPI Eina_Bool    elm_datefield_time_mode_get(const Evas_Object *obj);
28725    EINA_DEPRECATED EAPI void         elm_datefield_date_set(Evas_Object *obj, int year, int month, int day, int hour, int min);
28726    EINA_DEPRECATED EAPI void         elm_datefield_date_get(const Evas_Object *obj, int *year, int *month, int *day, int *hour, int *min);
28727    EINA_DEPRECATED EAPI Eina_Bool    elm_datefield_date_max_set(Evas_Object *obj, int year, int month, int day);
28728    EINA_DEPRECATED EAPI void         elm_datefield_date_max_get(const Evas_Object *obj, int *year, int *month, int *day);
28729    EINA_DEPRECATED EAPI Eina_Bool    elm_datefield_date_min_set(Evas_Object *obj, int year, int month, int day);
28730    EINA_DEPRECATED EAPI void         elm_datefield_date_min_get(const Evas_Object *obj, int *year, int *month, int *day);
28731    EINA_DEPRECATED EAPI void         elm_datefield_input_panel_state_callback_add(Evas_Object *obj, void (*pEventCallbackFunc) (void *data, Evas_Object *obj, int value), void *data);
28732    EINA_DEPRECATED EAPI void         elm_datefield_input_panel_state_callback_del(Evas_Object *obj, void (*pEventCallbackFunc) (void *data, Evas_Object *obj, int value));
28733 /////////////////////////////////////////////////////////////////////
28734
28735    /* popup */
28736    typedef enum _Elm_Popup_Response
28737      {
28738         ELM_POPUP_RESPONSE_NONE = -1,
28739         ELM_POPUP_RESPONSE_TIMEOUT = -2,
28740         ELM_POPUP_RESPONSE_OK = -3,
28741         ELM_POPUP_RESPONSE_CANCEL = -4,
28742         ELM_POPUP_RESPONSE_CLOSE = -5
28743      } Elm_Popup_Response;
28744
28745    typedef enum _Elm_Popup_Mode
28746      {
28747         ELM_POPUP_TYPE_NONE = 0,
28748         ELM_POPUP_TYPE_ALERT = (1 << 0)
28749      } Elm_Popup_Mode;
28750
28751    typedef enum _Elm_Popup_Orient
28752      {
28753         ELM_POPUP_ORIENT_TOP,
28754         ELM_POPUP_ORIENT_CENTER,
28755         ELM_POPUP_ORIENT_BOTTOM,
28756         ELM_POPUP_ORIENT_LEFT,
28757         ELM_POPUP_ORIENT_RIGHT,
28758         ELM_POPUP_ORIENT_TOP_LEFT,
28759         ELM_POPUP_ORIENT_TOP_RIGHT,
28760         ELM_POPUP_ORIENT_BOTTOM_LEFT,
28761         ELM_POPUP_ORIENT_BOTTOM_RIGHT
28762      } Elm_Popup_Orient;
28763
28764    /* smart callbacks called:
28765     * "response" - when ever popup is closed, this signal is sent with appropriate response id.".
28766     */
28767
28768    EAPI Evas_Object *elm_popup_add(Evas_Object *parent);
28769    EAPI void         elm_popup_desc_set(Evas_Object *obj, const char *text);
28770    EAPI const char  *elm_popup_desc_get(Evas_Object *obj);
28771    EAPI void         elm_popup_title_label_set(Evas_Object *obj, const char *text);
28772    EAPI const char  *elm_popup_title_label_get(Evas_Object *obj);
28773    EAPI void         elm_popup_title_icon_set(Evas_Object *obj, Evas_Object *icon);
28774    EAPI Evas_Object *elm_popup_title_icon_get(Evas_Object *obj);
28775    EAPI void         elm_popup_content_set(Evas_Object *obj, Evas_Object *content);
28776    EAPI Evas_Object *elm_popup_content_get(Evas_Object *obj);
28777    EAPI void         elm_popup_buttons_add(Evas_Object *obj,int no_of_buttons, const char *first_button_text,  ...);
28778    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, ... );
28779    EAPI void         elm_popup_timeout_set(Evas_Object *obj, double timeout);
28780    EAPI void         elm_popup_mode_set(Evas_Object *obj, Elm_Popup_Mode mode);
28781    EAPI void         elm_popup_response(Evas_Object *obj, int  response_id);
28782    EAPI void         elm_popup_orient_set(Evas_Object *obj, Elm_Popup_Orient orient);
28783    EAPI int          elm_popup_run(Evas_Object *obj);
28784
28785    /* NavigationBar */
28786    #define NAVIBAR_EX_TITLEOBJ_INSTANT_HIDE "elm,state,hide,noanimate,title", "elm"
28787    #define NAVIBAR_EX_TITLEOBJ_INSTANT_SHOW "elm,state,show,noanimate,title", "elm"
28788
28789    typedef enum
28790      {
28791         ELM_NAVIGATIONBAR_EX_BACK_BUTTON,
28792         ELM_NAVIGATIONBAR_EX_FUNCTION_BUTTON1,
28793         ELM_NAVIGATIONBAR_EX_FUNCTION_BUTTON2,
28794         ELM_NAVIGATIONBAR_EX_FUNCTION_BUTTON3,
28795         ELM_NAVIGATIONBAR_EX_MAX
28796      } Elm_Navi_ex_Button_Type;
28797    typedef struct _Elm_Navigationbar_ex_Item Elm_Navigationbar_ex_Item;
28798
28799    EINA_DEPRECATED    EAPI Evas_Object *elm_navigationbar_ex_add(Evas_Object *parent);
28800    EINA_DEPRECATED    EAPI Elm_Navigationbar_ex_Item *elm_navigationbar_ex_item_push(Evas_Object *obj, Evas_Object *content, const char *item_style);
28801    EINA_DEPRECATED    EAPI void         elm_navigationbar_ex_item_pop(Evas_Object *obj);
28802    EINA_DEPRECATED    EAPI void         elm_navigationbar_ex_item_promote(Elm_Navigationbar_ex_Item* item);
28803    EINA_DEPRECATED    EAPI void         elm_navigationbar_ex_to_item_pop(Elm_Navigationbar_ex_Item* item);
28804    EINA_DEPRECATED    EAPI void         elm_navigationbar_ex_item_title_label_set(Elm_Navigationbar_ex_Item *item, const char *title);
28805    EINA_DEPRECATED    EAPI const char  *elm_navigationbar_ex_item_title_label_get(Elm_Navigationbar_ex_Item* item);
28806    EINA_DEPRECATED    EAPI Elm_Navigationbar_ex_Item *elm_navigationbar_ex_item_top_get(const Evas_Object *obj);
28807    EINA_DEPRECATED    EAPI Elm_Navigationbar_ex_Item *elm_navigationbar_ex_item_bottom_get(const Evas_Object *obj);
28808    EINA_DEPRECATED    EAPI void         elm_navigationbar_ex_item_title_button_set(Elm_Navigationbar_ex_Item* item, char *btn_label, Evas_Object *icon, int button_type, Evas_Smart_Cb func, const void *data);
28809    EINA_DEPRECATED    EAPI Evas_Object *elm_navigationbar_ex_item_title_button_get(Elm_Navigationbar_ex_Item* item, int button_type);
28810    EINA_DEPRECATED    EAPI void         elm_navigationbar_ex_item_title_object_set(Elm_Navigationbar_ex_Item* item, Evas_Object *title_obj);
28811    EINA_DEPRECATED    EAPI Evas_Object *elm_navigationbar_ex_item_title_object_unset(Elm_Navigationbar_ex_Item* item);
28812    EINA_DEPRECATED    EAPI void         elm_navigationbar_ex_item_title_hidden_set(Elm_Navigationbar_ex_Item* item, Eina_Bool hidden);
28813    EINA_DEPRECATED    EAPI Evas_Object *elm_navigationbar_ex_item_title_object_get(Elm_Navigationbar_ex_Item* item);
28814    EINA_DEPRECATED    EAPI const char  *elm_navigationbar_ex_item_subtitle_label_get(Elm_Navigationbar_ex_Item* item);
28815    EINA_DEPRECATED    EAPI void         elm_navigationbar_ex_item_subtitle_label_set( Elm_Navigationbar_ex_Item* item, const char *subtitle);
28816    EINA_DEPRECATED    EAPI void         elm_navigationbar_ex_item_style_set(Elm_Navigationbar_ex_Item* item, const char* item_style);
28817    EINA_DEPRECATED    EAPI const char  *elm_navigationbar_ex_item_style_get(Elm_Navigationbar_ex_Item* item);
28818    EINA_DEPRECATED    EAPI Evas_Object *elm_navigationbar_ex_item_content_unset(Elm_Navigationbar_ex_Item* item);
28819    EINA_DEPRECATED    EAPI Evas_Object *elm_navigationbar_ex_item_content_get(Elm_Navigationbar_ex_Item* item);
28820    EINA_DEPRECATED    EAPI void         elm_navigationbar_ex_delete_on_pop_set(Evas_Object *obj, Eina_Bool del_on_pop);
28821    EINA_DEPRECATED    EAPI Evas_Object *elm_navigationbar_ex_item_icon_get(Elm_Navigationbar_ex_Item* item);
28822    EINA_DEPRECATED    EAPI void         elm_navigationbar_ex_item_icon_set(Elm_Navigationbar_ex_Item* item, Evas_Object *icon);
28823    EINA_DEPRECATED    EAPI Evas_Object *elm_navigationbar_ex_item_title_button_unset(Elm_Navigationbar_ex_Item* item, int button_type);
28824    EINA_DEPRECATED    EAPI void         elm_navigationbar_ex_animation_disable_set(Evas_Object *obj, Eina_Bool disable);
28825    EINA_DEPRECATED    EAPI void         elm_navigationbar_ex_title_object_visible_set(Elm_Navigationbar_ex_Item* item, Eina_Bool visible);
28826    EINA_DEPRECATED    Eina_Bool         elm_navigationbar_ex_title_object_visible_get(Elm_Navigationbar_ex_Item* item);
28827
28828    /**
28829     * @defgroup Naviframe Naviframe
28830     * @ingroup Elementary
28831     *
28832     * @brief Naviframe is a kind of view manager for the applications.
28833     *
28834     * Naviframe provides functions to switch different pages with stack
28835     * mechanism. It means if one page(item) needs to be changed to the new one,
28836     * then naviframe would push the new page to it's internal stack. Of course,
28837     * it can be back to the previous page by popping the top page. Naviframe
28838     * provides some transition effect while the pages are switching (same as
28839     * pager).
28840     *
28841     * Since each item could keep the different styles, users could keep the
28842     * same look & feel for the pages or different styles for the items in it's
28843     * application.
28844     *
28845     * Signals that you can add callback for are:
28846     * @li "transition,finished" - When the transition is finished in changing
28847     *     the item
28848     * @li "title,clicked" - User clicked title area
28849     *
28850     * Default contents parts of the naviframe items that you can use for are:
28851     * @li "default" - A main content of the page
28852     * @li "icon" - A icon in the title area
28853     * @li "prev_btn" - A button to go to the previous page
28854     * @li "next_btn" - A button to go to the next page
28855     *
28856     * Default text parts of the naviframe items that you can use for are:
28857     * @li "default" - Title label in the title area
28858     * @li "subtitle" - Sub-title label in the title area
28859     *
28860     * @ref tutorial_naviframe gives a good overview of the usage of the API.
28861     */
28862
28863   //Available commonly
28864   #define ELM_NAVIFRAME_ITEM_CONTENT "elm.swallow.content"
28865   #define ELM_NAVIFRAME_ITEM_ICON "elm.swallow.icon"
28866   #define ELM_NAVIFRAME_ITEM_OPTIONHEADER "elm.swallow.optionheader"
28867   #define ELM_NAVIFRAME_ITEM_TITLE_LABEL "elm.text.title"
28868   #define ELM_NAVIFRAME_ITEM_PREV_BTN "elm.swallow.prev_btn"
28869   #define ELM_NAVIFRAME_ITEM_TITLE_LEFT_BTN "elm.swallow.left_btn"
28870   #define ELM_NAVIFRAME_ITEM_TITLE_RIGHT_BTN "elm.swallow.right_btn"
28871   #define ELM_NAVIFRAME_ITEM_TITLE_MORE_BTN "elm.swallow.more_btn"
28872   #define ELM_NAVIFRAME_ITEM_CONTROLBAR "elm.swallow.controlbar"
28873   #define ELM_NAVIFRAME_ITEM_SIGNAL_OPTIONHEADER_CLOSE "elm,state,optionheader,close", ""
28874   #define ELM_NAVIFRAME_ITEM_SIGNAL_OPTIONHEADER_OPEN "elm,state,optionheader,open", ""
28875   #define ELM_NAVIFRAME_ITEM_SIGNAL_OPTIONHEADER_INSTANT_CLOSE "elm,state,optionheader,instant_close", ""
28876   #define ELM_NAVIFRAME_ITEM_SIGNAL_OPTIONHEADER_INSTANT_OPEN "elm,state,optionheader,instant_open", ""
28877   #define ELM_NAVIFRAME_ITEM_SIGNAL_CONTROLBAR_CLOSE "elm,state,controlbar,close", ""
28878   #define ELM_NAVIFRAME_ITEM_SIGNAL_CONTROLBAR_OPEN "elm,state,controlbar,open", ""
28879   #define ELM_NAVIFRAME_ITEM_SIGNAL_CONTROLBAR_INSTANT_CLOSE "elm,state,controlbar,instant_close", ""
28880   #define ELM_NAVIFRAME_ITEM_SIGNAL_CONTROLBAR_INSTANT_OPEN "elm,state,controlbar,instant_open", ""
28881
28882    //Available only in a style - "2line"
28883   #define ELM_NAVIFRAME_ITEM_OPTIONHEADER2 "elm.swallow.optionheader2"
28884
28885   //Available only in a style - "segment"
28886   #define ELM_NAVIFRAME_ITEM_SEGMENT2 "elm.swallow.segment2"
28887   #define ELM_NAVIFRAME_ITEM_SEGMENT3 "elm.swallow.segment3"
28888
28889    /**
28890     * @addtogroup Naviframe
28891     * @{
28892     */
28893
28894    /**
28895     * @brief Add a new Naviframe object to the parent.
28896     *
28897     * @param parent Parent object
28898     * @return New object or @c NULL, if it cannot be created
28899     *
28900     * @ingroup Naviframe
28901     */
28902    EAPI Evas_Object        *elm_naviframe_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
28903    /**
28904     * @brief Push a new item to the top of the naviframe stack (and show it).
28905     *
28906     * @param obj The naviframe object
28907     * @param title_label The label in the title area. The name of the title
28908     *        label part is "elm.text.title"
28909     * @param prev_btn The button to go to the previous item. If it is NULL,
28910     *        then naviframe will create a back button automatically. The name of
28911     *        the prev_btn part is "elm.swallow.prev_btn"
28912     * @param next_btn The button to go to the next item. Or It could be just an
28913     *        extra function button. The name of the next_btn part is
28914     *        "elm.swallow.next_btn"
28915     * @param content The main content object. The name of content part is
28916     *        "elm.swallow.content"
28917     * @param item_style The current item style name. @c NULL would be default.
28918     * @return The created item or @c NULL upon failure.
28919     *
28920     * The item pushed becomes one page of the naviframe, this item will be
28921     * deleted when it is popped.
28922     *
28923     * @see also elm_naviframe_item_style_set()
28924     * @see also elm_naviframe_item_insert_before()
28925     * @see also elm_naviframe_item_insert_after()
28926     *
28927     * The following styles are available for this item:
28928     * @li @c "default"
28929     *
28930     * @ingroup Naviframe
28931     */
28932    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);
28933     /**
28934     * @brief Insert a new item into the naviframe before item @p before.
28935     *
28936     * @param before The naviframe item to insert before.
28937     * @param title_label The label in the title area. The name of the title
28938     *        label part is "elm.text.title"
28939     * @param prev_btn The button to go to the previous item. If it is NULL,
28940     *        then naviframe will create a back button automatically. The name of
28941     *        the prev_btn part is "elm.swallow.prev_btn"
28942     * @param next_btn The button to go to the next item. Or It could be just an
28943     *        extra function button. The name of the next_btn part is
28944     *        "elm.swallow.next_btn"
28945     * @param content The main content object. The name of content part is
28946     *        "elm.swallow.content"
28947     * @param item_style The current item style name. @c NULL would be default.
28948     * @return The created item or @c NULL upon failure.
28949     *
28950     * The item is inserted into the naviframe straight away without any
28951     * transition operations. This item will be deleted when it is popped.
28952     *
28953     * @see also elm_naviframe_item_style_set()
28954     * @see also elm_naviframe_item_push()
28955     * @see also elm_naviframe_item_insert_after()
28956     *
28957     * The following styles are available for this item:
28958     * @li @c "default"
28959     *
28960     * @ingroup Naviframe
28961     */
28962    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);
28963    /**
28964     * @brief Insert a new item into the naviframe after item @p after.
28965     *
28966     * @param after The naviframe item to insert after.
28967     * @param title_label The label in the title area. The name of the title
28968     *        label part is "elm.text.title"
28969     * @param prev_btn The button to go to the previous item. If it is NULL,
28970     *        then naviframe will create a back button automatically. The name of
28971     *        the prev_btn part is "elm.swallow.prev_btn"
28972     * @param next_btn The button to go to the next item. Or It could be just an
28973     *        extra function button. The name of the next_btn part is
28974     *        "elm.swallow.next_btn"
28975     * @param content The main content object. The name of content part is
28976     *        "elm.swallow.content"
28977     * @param item_style The current item style name. @c NULL would be default.
28978     * @return The created item or @c NULL upon failure.
28979     *
28980     * The item is inserted into the naviframe straight away without any
28981     * transition operations. This item will be deleted when it is popped.
28982     *
28983     * @see also elm_naviframe_item_style_set()
28984     * @see also elm_naviframe_item_push()
28985     * @see also elm_naviframe_item_insert_before()
28986     *
28987     * The following styles are available for this item:
28988     * @li @c "default"
28989     *
28990     * @ingroup Naviframe
28991     */
28992    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);
28993    /**
28994     * @brief Pop an item that is on top of the stack
28995     *
28996     * @param obj The naviframe object
28997     * @return @c NULL or the content object(if the
28998     *         elm_naviframe_content_preserve_on_pop_get is true).
28999     *
29000     * This pops an item that is on the top(visible) of the naviframe, makes it
29001     * disappear, then deletes the item. The item that was underneath it on the
29002     * stack will become visible.
29003     *
29004     * @see also elm_naviframe_content_preserve_on_pop_get()
29005     *
29006     * @ingroup Naviframe
29007     */
29008    EAPI Evas_Object        *elm_naviframe_item_pop(Evas_Object *obj) EINA_ARG_NONNULL(1);
29009    /**
29010     * @brief Pop the items between the top and the above one on the given item.
29011     *
29012     * @param it The naviframe item
29013     *
29014     * @ingroup Naviframe
29015     */
29016    EAPI void                elm_naviframe_item_pop_to(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
29017    /**
29018    * Promote an item already in the naviframe stack to the top of the stack
29019    *
29020    * @param it The naviframe item
29021    *
29022    * This will take the indicated item and promote it to the top of the stack
29023    * as if it had been pushed there. The item must already be inside the
29024    * naviframe stack to work.
29025    *
29026    */
29027    EAPI void                elm_naviframe_item_promote(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
29028    /**
29029     * @brief Delete the given item instantly.
29030     *
29031     * @param it The naviframe item
29032     *
29033     * This just deletes the given item from the naviframe item list instantly.
29034     * So this would not emit any signals for view transitions but just change
29035     * the current view if the given item is a top one.
29036     *
29037     * @ingroup Naviframe
29038     */
29039    EAPI void                elm_naviframe_item_del(Elm_Object_Item *it) EINA_ARG_NONNULL(1);
29040    /**
29041     * @brief preserve the content objects when items are popped.
29042     *
29043     * @param obj The naviframe object
29044     * @param preserve Enable the preserve mode if EINA_TRUE, disable otherwise
29045     *
29046     * @see also elm_naviframe_content_preserve_on_pop_get()
29047     *
29048     * @ingroup Naviframe
29049     */
29050    EAPI void                elm_naviframe_content_preserve_on_pop_set(Evas_Object *obj, Eina_Bool preserve) EINA_ARG_NONNULL(1);
29051    /**
29052     * @brief Get a value whether preserve mode is enabled or not.
29053     *
29054     * @param obj The naviframe object
29055     * @return If @c EINA_TRUE, preserve mode is enabled
29056     *
29057     * @see also elm_naviframe_content_preserve_on_pop_set()
29058     *
29059     * @ingroup Naviframe
29060     */
29061    EAPI Eina_Bool           elm_naviframe_content_preserve_on_pop_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
29062    /**
29063     * @brief Get a top item on the naviframe stack
29064     *
29065     * @param obj The naviframe object
29066     * @return The top item on the naviframe stack or @c NULL, if the stack is
29067     *         empty
29068     *
29069     * @ingroup Naviframe
29070     */
29071    EAPI Elm_Object_Item    *elm_naviframe_top_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
29072    /**
29073     * @brief Get a bottom item on the naviframe stack
29074     *
29075     * @param obj The naviframe object
29076     * @return The bottom item on the naviframe stack or @c NULL, if the stack is
29077     *         empty
29078     *
29079     * @ingroup Naviframe
29080     */
29081    EAPI Elm_Object_Item    *elm_naviframe_bottom_item_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
29082    /**
29083     * @brief Set an item style
29084     *
29085     * @param obj The naviframe item
29086     * @param item_style The current item style name. @c NULL would be default
29087     *
29088     * The following styles are available for this item:
29089     * @li @c "default"
29090     *
29091     * @see also elm_naviframe_item_style_get()
29092     *
29093     * @ingroup Naviframe
29094     */
29095    EAPI void                elm_naviframe_item_style_set(Elm_Object_Item *it, const char *item_style) EINA_ARG_NONNULL(1);
29096    /**
29097     * @brief Get an item style
29098     *
29099     * @param obj The naviframe item
29100     * @return The current item style name
29101     *
29102     * @see also elm_naviframe_item_style_set()
29103     *
29104     * @ingroup Naviframe
29105     */
29106    EAPI const char         *elm_naviframe_item_style_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
29107    /**
29108     * @brief Show/Hide the title area
29109     *
29110     * @param it The naviframe item
29111     * @param visible If @c EINA_TRUE, title area will be visible, hidden
29112     *        otherwise
29113     *
29114     * When the title area is invisible, then the controls would be hidden so as     * to expand the content area to full-size.
29115     *
29116     * @see also elm_naviframe_item_title_visible_get()
29117     *
29118     * @ingroup Naviframe
29119     */
29120    EAPI void                elm_naviframe_item_title_visible_set(Elm_Object_Item *it, Eina_Bool visible) EINA_ARG_NONNULL(1);
29121    /**
29122     * @brief Get a value whether title area is visible or not.
29123     *
29124     * @param it The naviframe item
29125     * @return If @c EINA_TRUE, title area is visible
29126     *
29127     * @see also elm_naviframe_item_title_visible_set()
29128     *
29129     * @ingroup Naviframe
29130     */
29131    EAPI Eina_Bool           elm_naviframe_item_title_visible_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
29132
29133    /**
29134     * @brief Set creating prev button automatically or not
29135     *
29136     * @param obj The naviframe object
29137     * @param auto_pushed If @c EINA_TRUE, the previous button(back button) will
29138     *        be created internally when you pass the @c NULL to the prev_btn
29139     *        parameter in elm_naviframe_item_push
29140     *
29141     * @see also elm_naviframe_item_push()
29142     */
29143    EAPI void                elm_naviframe_prev_btn_auto_pushed_set(Evas_Object *obj, Eina_Bool auto_pushed) EINA_ARG_NONNULL(1);
29144    /**
29145     * @brief Get a value whether prev button(back button) will be auto pushed or
29146     *        not.
29147     *
29148     * @param obj The naviframe object
29149     * @return If @c EINA_TRUE, prev button will be auto pushed.
29150     *
29151     * @see also elm_naviframe_item_push()
29152     *           elm_naviframe_prev_btn_auto_pushed_set()
29153     */
29154    EAPI Eina_Bool           elm_naviframe_prev_btn_auto_pushed_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
29155    /**
29156     * @brief Get a list of all the naviframe items.
29157     *
29158     * @param obj The naviframe object
29159     * @return An Eina_Inlist* of naviframe items, #Elm_Object_Item,
29160     * or @c NULL on failure.
29161     */
29162    EAPI Eina_Inlist        *elm_naviframe_items_get(const Evas_Object *obj) EINA_ARG_NONNULL(1);
29163
29164    /**
29165     * @}
29166     */
29167
29168    /* Control Bar */
29169    #define CONTROLBAR_SYSTEM_ICON_ALBUMS "controlbar_albums"
29170    #define CONTROLBAR_SYSTEM_ICON_ARTISTS "controlbar_artists"
29171    #define CONTROLBAR_SYSTEM_ICON_SONGS "controlbar_songs"
29172    #define CONTROLBAR_SYSTEM_ICON_PLAYLIST "controlbar_playlist"
29173    #define CONTROLBAR_SYSTEM_ICON_MORE "controlbar_more"
29174    #define CONTROLBAR_SYSTEM_ICON_CONTACTS "controlbar_contacts"
29175    #define CONTROLBAR_SYSTEM_ICON_DIALER "controlbar_dialer"
29176    #define CONTROLBAR_SYSTEM_ICON_FAVORITES "controlbar_favorites"
29177    #define CONTROLBAR_SYSTEM_ICON_LOGS "controlbar_logs"
29178
29179    typedef enum _Elm_Controlbar_Mode_Type
29180      {
29181         ELM_CONTROLBAR_MODE_DEFAULT = 0,
29182         ELM_CONTROLBAR_MODE_TRANSLUCENCE,
29183         ELM_CONTROLBAR_MODE_TRANSPARENCY,
29184         ELM_CONTROLBAR_MODE_LARGE,
29185         ELM_CONTROLBAR_MODE_SMALL,
29186         ELM_CONTROLBAR_MODE_LEFT,
29187         ELM_CONTROLBAR_MODE_RIGHT
29188      } Elm_Controlbar_Mode_Type;
29189
29190    typedef struct _Elm_Controlbar_Item Elm_Controlbar_Item;
29191    EAPI Evas_Object *elm_controlbar_add(Evas_Object *parent);
29192    EAPI Elm_Controlbar_Item *elm_controlbar_tab_item_append(Evas_Object *obj, const char *icon_path, const char *label, Evas_Object *view);
29193    EAPI Elm_Controlbar_Item *elm_controlbar_tab_item_prepend(Evas_Object *obj, const char *icon_path, const char *label, Evas_Object *view);
29194    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);
29195    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);
29196    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);
29197    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);
29198    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);
29199    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);
29200    EAPI Elm_Controlbar_Item *elm_controlbar_object_item_append(Evas_Object *obj, Evas_Object *obj_item, const int sel);
29201    EAPI Elm_Controlbar_Item *elm_controlbar_object_item_prepend(Evas_Object *obj, Evas_Object *obj_item, const int sel);
29202    EAPI Elm_Controlbar_Item *elm_controlbar_object_item_insert_before(Evas_Object *obj, Elm_Controlbar_Item *before, Evas_Object *obj_item, const int sel);
29203    EAPI Elm_Controlbar_Item *elm_controlbar_object_item_insert_after(Evas_Object *obj, Elm_Controlbar_Item *after, Evas_Object *obj_item, const int sel);
29204    EAPI Evas_Object *elm_controlbar_object_item_object_get(const Elm_Controlbar_Item *it);
29205    EAPI void         elm_controlbar_item_del(Elm_Controlbar_Item *it);
29206    EAPI void         elm_controlbar_item_select(Elm_Controlbar_Item *it);
29207    EAPI void         elm_controlbar_item_visible_set(Elm_Controlbar_Item *it, Eina_Bool bar);
29208    EAPI Eina_Bool    elm_controlbar_item_visible_get(const Elm_Controlbar_Item * it);
29209    EAPI void         elm_controlbar_item_disabled_set(Elm_Controlbar_Item * it, Eina_Bool disabled);
29210    EAPI Eina_Bool    elm_controlbar_item_disabled_get(const Elm_Controlbar_Item * it);
29211    EAPI void         elm_controlbar_item_icon_set(Elm_Controlbar_Item *it, const char *icon_path);
29212    EAPI Evas_Object *elm_controlbar_item_icon_get(const Elm_Controlbar_Item *it);
29213    EAPI void         elm_controlbar_item_label_set(Elm_Controlbar_Item *it, const char *label);
29214    EAPI const char  *elm_controlbar_item_label_get(const Elm_Controlbar_Item *it);
29215    EAPI Elm_Controlbar_Item *elm_controlbar_selected_item_get(const Evas_Object *obj);
29216    EAPI Elm_Controlbar_Item *elm_controlbar_first_item_get(const Evas_Object *obj);
29217    EAPI Elm_Controlbar_Item *elm_controlbar_last_item_get(const Evas_Object *obj);
29218    EAPI const Eina_List   *elm_controlbar_items_get(const Evas_Object *obj);
29219    EAPI Elm_Controlbar_Item *elm_controlbar_item_prev(Elm_Controlbar_Item *it);
29220    EAPI Elm_Controlbar_Item *elm_controlbar_item_next(Elm_Controlbar_Item *it);
29221    EAPI void         elm_controlbar_item_view_set(Elm_Controlbar_Item *it, Evas_Object * view);
29222    EAPI Evas_Object *elm_controlbar_item_view_get(const Elm_Controlbar_Item *it);
29223    EAPI Evas_Object *elm_controlbar_item_view_unset(Elm_Controlbar_Item *it);
29224    EAPI Evas_Object *elm_controlbar_item_button_get(const Elm_Controlbar_Item *it);
29225    EAPI void         elm_controlbar_mode_set(Evas_Object *obj, int mode);
29226    EAPI void         elm_controlbar_alpha_set(Evas_Object *obj, int alpha);
29227    EAPI void         elm_controlbar_item_auto_align_set(Evas_Object *obj, Eina_Bool auto_align);
29228    EAPI void         elm_controlbar_vertical_set(Evas_Object *obj, Eina_Bool vertical);
29229
29230    /* SearchBar */
29231    EAPI Evas_Object *elm_searchbar_add(Evas_Object *parent);
29232    EAPI void         elm_searchbar_text_set(Evas_Object *obj, const char *entry);
29233    EAPI const char  *elm_searchbar_text_get(Evas_Object *obj);
29234    EAPI Evas_Object *elm_searchbar_entry_get(Evas_Object *obj);
29235    EAPI Evas_Object *elm_searchbar_editfield_get(Evas_Object *obj);
29236    EAPI void         elm_searchbar_cancel_button_animation_set(Evas_Object *obj, Eina_Bool cancel_btn_ani_flag);
29237    EAPI void         elm_searchbar_cancel_button_set(Evas_Object *obj, Eina_Bool visible);
29238    EAPI void         elm_searchbar_clear(Evas_Object *obj);
29239    EAPI void         elm_searchbar_boundary_rect_set(Evas_Object *obj, Eina_Bool boundary);
29240
29241    EAPI Evas_Object *elm_page_control_add(Evas_Object *parent);
29242    EAPI void         elm_page_control_page_count_set(Evas_Object *obj, unsigned int page_count);
29243    EAPI void         elm_page_control_page_id_set(Evas_Object *obj, unsigned int page_id);
29244    EAPI unsigned int elm_page_control_page_id_get(Evas_Object *obj);
29245
29246    /* NoContents */
29247    EAPI Evas_Object *elm_nocontents_add(Evas_Object *parent);
29248    EAPI void         elm_nocontents_label_set(Evas_Object *obj, const char *label);
29249    EAPI const char  *elm_nocontents_label_get(const Evas_Object *obj);
29250    EAPI void         elm_nocontents_custom_set(const Evas_Object *obj, Evas_Object *custom);
29251    EAPI Evas_Object *elm_nocontents_custom_get(const Evas_Object *obj);
29252
29253    /* TickerNoti */
29254    typedef enum
29255      {
29256         ELM_TICKERNOTI_ORIENT_TOP = 0,
29257         ELM_TICKERNOTI_ORIENT_BOTTOM,
29258         ELM_TICKERNOTI_ORIENT_LAST
29259      }  Elm_Tickernoti_Orient;
29260
29261    EAPI Evas_Object              *elm_tickernoti_add (Evas_Object *parent);
29262    EAPI void                      elm_tickernoti_orient_set (Evas_Object *obj, Elm_Tickernoti_Orient orient) EINA_ARG_NONNULL(1);
29263    EAPI Elm_Tickernoti_Orient     elm_tickernoti_orient_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
29264    EAPI int                       elm_tickernoti_rotation_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
29265    EAPI void                      elm_tickernoti_rotation_set (Evas_Object *obj, int angle) EINA_ARG_NONNULL(1);
29266    EAPI Evas_Object              *elm_tickernoti_win_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
29267    /* #### Below APIs and data structures are going to be deprecated, announcment will be made soon ####*/
29268    typedef enum
29269     {
29270        ELM_TICKERNOTI_DEFAULT,
29271        ELM_TICKERNOTI_DETAILVIEW
29272     } Elm_Tickernoti_Mode;
29273    EAPI void                      elm_tickernoti_detailview_label_set (Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
29274    EAPI const char               *elm_tickernoti_detailview_label_get (const Evas_Object *obj)EINA_ARG_NONNULL(1);
29275    EAPI void                      elm_tickernoti_detailview_button_set (Evas_Object *obj, Evas_Object *button) EINA_ARG_NONNULL(2);
29276    EAPI Evas_Object              *elm_tickernoti_detailview_button_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
29277    EAPI void                      elm_tickernoti_detailview_icon_set (Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
29278    EAPI Evas_Object              *elm_tickernoti_detailview_icon_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
29279    EAPI Evas_Object              *elm_tickernoti_detailview_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
29280    EAPI void                      elm_tickernoti_mode_set (Evas_Object *obj, Elm_Tickernoti_Mode mode) EINA_ARG_NONNULL(1);
29281    EAPI Elm_Tickernoti_Mode       elm_tickernoti_mode_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
29282    EAPI void                      elm_tickernoti_orientation_set (Evas_Object *obj, Elm_Tickernoti_Orient orient) EINA_ARG_NONNULL(1);
29283    EAPI Elm_Tickernoti_Orient     elm_tickernoti_orientation_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
29284    EAPI void                      elm_tickernoti_label_set (Evas_Object *obj, const char *label) EINA_ARG_NONNULL(1);
29285    EAPI const char               *elm_tickernoti_label_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
29286    EAPI void                      elm_tickernoti_icon_set (Evas_Object *obj, Evas_Object *icon) EINA_ARG_NONNULL(1);
29287    EAPI Evas_Object              *elm_tickernoti_icon_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
29288    EAPI void                      elm_tickernoti_button_set (Evas_Object *obj, Evas_Object *button) EINA_ARG_NONNULL(1);
29289    EAPI Evas_Object              *elm_tickernoti_button_get (const Evas_Object *obj) EINA_ARG_NONNULL(1);
29290    /* ############################################################################### */
29291    /*
29292     * Parts which can be used with elm_object_text_part_set() and
29293     * elm_object_text_part_get():
29294     *
29295     * @li NULL/"default" - Operates on tickernoti content-text
29296     *
29297     * Parts which can be used with elm_object_content_part_set(),
29298     * elm_object_content_part_get() and elm_object_content_part_unset():
29299     *
29300     * @li "icon" - Operates on tickernoti's icon
29301     * @li "button" - Operates on tickernoti's button
29302     *
29303     * smart callbacks called:
29304     * @li "clicked" - emitted when tickernoti is clicked, except at the
29305     * swallow/button region, if any.
29306     * @li "hide" - emitted when the tickernoti is completely hidden. In case of
29307     * any hide animation, this signal is emitted after the animation.
29308     */
29309
29310    /* colorpalette */
29311    typedef struct _Colorpalette_Color Elm_Colorpalette_Color;
29312
29313    struct _Colorpalette_Color
29314      {
29315         unsigned int r, g, b;
29316      };
29317
29318    EAPI Evas_Object *elm_colorpalette_add(Evas_Object *parent);
29319    EAPI void         elm_colorpalette_color_set(Evas_Object *obj, int color_num, Elm_Colorpalette_Color *color);
29320    EAPI void         elm_colorpalette_row_column_set(Evas_Object *obj, int row, int col);
29321    /* smart callbacks called:
29322     * "clicked" - when image clicked
29323     */
29324
29325    /* editfield */
29326    EAPI Evas_Object *elm_editfield_add(Evas_Object *parent);
29327    EAPI void         elm_editfield_label_set(Evas_Object *obj, const char *label);
29328    EAPI const char  *elm_editfield_label_get(Evas_Object *obj);
29329    EAPI void         elm_editfield_guide_text_set(Evas_Object *obj, const char *text);
29330    EAPI const char  *elm_editfield_guide_text_get(Evas_Object *obj);
29331    EAPI Evas_Object *elm_editfield_entry_get(Evas_Object *obj);
29332 //   EAPI Evas_Object *elm_editfield_clear_button_show(Evas_Object *obj, Eina_Bool show);
29333    EAPI void         elm_editfield_right_icon_set(Evas_Object *obj, Evas_Object *icon);
29334    EAPI Evas_Object *elm_editfield_right_icon_get(Evas_Object *obj);
29335    EAPI void         elm_editfield_left_icon_set(Evas_Object *obj, Evas_Object *icon);
29336    EAPI Evas_Object *elm_editfield_left_icon_get(Evas_Object *obj);
29337    EAPI void         elm_editfield_entry_single_line_set(Evas_Object *obj, Eina_Bool single_line);
29338    EAPI Eina_Bool    elm_editfield_entry_single_line_get(Evas_Object *obj);
29339    EAPI void         elm_editfield_eraser_set(Evas_Object *obj, Eina_Bool visible);
29340    EAPI Eina_Bool    elm_editfield_eraser_get(Evas_Object *obj);
29341    /* smart callbacks called:
29342     * "clicked" - when an editfield is clicked
29343     * "unfocused" - when an editfield is unfocused
29344     */
29345
29346
29347    /* multibuttonentry */
29348    typedef struct _Multibuttonentry_Item Elm_Multibuttonentry_Item;
29349    typedef Eina_Bool (*Elm_Multibuttonentry_Item_Verify_Callback) (Evas_Object *obj, const char *item_label, void *item_data, void *data);
29350    EAPI Evas_Object               *elm_multibuttonentry_add(Evas_Object *parent);
29351    EAPI const char                *elm_multibuttonentry_label_get(const Evas_Object *obj);
29352    EAPI void                       elm_multibuttonentry_label_set(Evas_Object *obj, const char *label);
29353    EAPI Evas_Object               *elm_multibuttonentry_entry_get(const Evas_Object *obj);
29354    EAPI const char *               elm_multibuttonentry_guide_text_get(const Evas_Object *obj);
29355    EAPI void                       elm_multibuttonentry_guide_text_set(Evas_Object *obj, const char *guidetext);
29356    EAPI int                        elm_multibuttonentry_contracted_state_get(const Evas_Object *obj);
29357    EAPI void                       elm_multibuttonentry_contracted_state_set(Evas_Object *obj, int contracted);
29358    EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_add_start(Evas_Object *obj, const char *label, void *data);
29359    EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_add_end(Evas_Object *obj, const char *label, void *data);
29360    EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_add_before(Evas_Object *obj, const char *label, Elm_Multibuttonentry_Item *before, void *data);
29361    EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_add_after(Evas_Object *obj, const char *label, Elm_Multibuttonentry_Item *after, void *data);
29362    EAPI const Eina_List           *elm_multibuttonentry_items_get(const Evas_Object *obj);
29363    EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_first_get(const Evas_Object *obj);
29364    EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_last_get(const Evas_Object *obj);
29365    EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_selected_get(const Evas_Object *obj);
29366    EAPI void                       elm_multibuttonentry_item_selected_set(Elm_Multibuttonentry_Item *item);
29367    EAPI void                       elm_multibuttonentry_item_unselect_all(Evas_Object *obj);
29368    EAPI void                       elm_multibuttonentry_item_del(Elm_Multibuttonentry_Item *item);
29369    EAPI void                       elm_multibuttonentry_items_del(Evas_Object *obj);
29370    EAPI const char                *elm_multibuttonentry_item_label_get(const Elm_Multibuttonentry_Item *item);
29371    EAPI void                       elm_multibuttonentry_item_label_set(Elm_Multibuttonentry_Item *item, const char *str);
29372    EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_prev(Elm_Multibuttonentry_Item *item);
29373    EAPI Elm_Multibuttonentry_Item *elm_multibuttonentry_item_next(Elm_Multibuttonentry_Item *item);
29374    EAPI void                      *elm_multibuttonentry_item_data_get(const Elm_Multibuttonentry_Item *item);
29375    EAPI void                       elm_multibuttonentry_item_data_set(Elm_Multibuttonentry_Item *item, void *data);
29376    EAPI void                       elm_multibuttonentry_item_verify_callback_set(Evas_Object *obj, Elm_Multibuttonentry_Item_Verify_Callback func, void *data);
29377    /* smart callback called:
29378     * "selected" - This signal is emitted when the selected item of multibuttonentry is changed.
29379     * "added" - This signal is emitted when a new multibuttonentry item is added.
29380     * "deleted" - This signal is emitted when a multibuttonentry item is deleted.
29381     * "expanded" - This signal is emitted when a multibuttonentry is expanded.
29382     * "contracted" - This signal is emitted when a multibuttonentry is contracted.
29383     * "contracted,state,changed" - This signal is emitted when the contracted state of multibuttonentry is changed.
29384     * "item,selected" - This signal is emitted when the selected item of multibuttonentry is changed.
29385     * "item,added" - This signal is emitted when a new multibuttonentry item is added.
29386     * "item,deleted" - This signal is emitted when a multibuttonentry item is deleted.
29387     * "item,clicked" - This signal is emitted when a multibuttonentry item is clicked.
29388     * "clicked" - This signal is emitted when a multibuttonentry is clicked.
29389     * "unfocused" - This signal is emitted when a multibuttonentry is unfocused.
29390     */
29391    /* available styles:
29392     * default
29393     */
29394
29395    /* stackedicon */
29396    typedef struct _Stackedicon_Item Elm_Stackedicon_Item;
29397    EAPI Evas_Object          *elm_stackedicon_add(Evas_Object *parent);
29398    EAPI Elm_Stackedicon_Item *elm_stackedicon_item_append(Evas_Object *obj, const char *path);
29399    EAPI Elm_Stackedicon_Item *elm_stackedicon_item_prepend(Evas_Object *obj, const char *path);
29400    EAPI void                  elm_stackedicon_item_del(Elm_Stackedicon_Item *it);
29401    EAPI Eina_List            *elm_stackedicon_item_list_get(Evas_Object *obj);
29402    /* smart callback called:
29403     * "expanded" - This signal is emitted when a stackedicon is expanded.
29404     * "clicked" - This signal is emitted when a stackedicon is clicked.
29405     */
29406    /* available styles:
29407     * default
29408     */
29409
29410    /* dialoguegroup */
29411    typedef struct _Dialogue_Item Dialogue_Item;
29412
29413    typedef enum _Elm_Dialoguegourp_Item_Style
29414      {
29415         ELM_DIALOGUEGROUP_ITEM_STYLE_DEFAULT = 0,
29416         ELM_DIALOGUEGROUP_ITEM_STYLE_EDITFIELD = (1 << 0),
29417         ELM_DIALOGUEGROUP_ITEM_STYLE_EDITFIELD_WITH_TITLE = (1 << 1),
29418         ELM_DIALOGUEGROUP_ITEM_STYLE_EDIT_TITLE = (1 << 2),
29419         ELM_DIALOGUEGROUP_ITEM_STYLE_HIDDEN = (1 << 3),
29420         ELM_DIALOGUEGROUP_ITEM_STYLE_DATAVIEW = (1 << 4),
29421         ELM_DIALOGUEGROUP_ITEM_STYLE_NO_BG = (1 << 5),
29422         ELM_DIALOGUEGROUP_ITEM_STYLE_SUB = (1 << 6),
29423         ELM_DIALOGUEGROUP_ITEM_STYLE_EDIT = (1 << 7),
29424         ELM_DIALOGUEGROUP_ITEM_STYLE_EDIT_MERGE = (1 << 8),
29425         ELM_DIALOGUEGROUP_ITEM_STYLE_LAST = (1 << 9)
29426      } Elm_Dialoguegroup_Item_Style;
29427
29428    EINA_DEPRECATED EAPI Evas_Object   *elm_dialoguegroup_add(Evas_Object *parent);
29429    EINA_DEPRECATED EAPI Dialogue_Item *elm_dialoguegroup_append(Evas_Object *obj, Evas_Object *subobj, Elm_Dialoguegroup_Item_Style style);
29430    EINA_DEPRECATED EAPI Dialogue_Item *elm_dialoguegroup_prepend(Evas_Object *obj, Evas_Object *subobj, Elm_Dialoguegroup_Item_Style style);
29431    EINA_DEPRECATED EAPI Dialogue_Item *elm_dialoguegroup_insert_after(Evas_Object *obj, Evas_Object *subobj, Dialogue_Item *after, Elm_Dialoguegroup_Item_Style style);
29432    EINA_DEPRECATED EAPI Dialogue_Item *elm_dialoguegroup_insert_before(Evas_Object *obj, Evas_Object *subobj, Dialogue_Item *before, Elm_Dialoguegroup_Item_Style style);
29433    EINA_DEPRECATED EAPI void           elm_dialoguegroup_remove(Dialogue_Item *item);
29434    EINA_DEPRECATED EAPI void           elm_dialoguegroup_remove_all(Evas_Object *obj);
29435    EINA_DEPRECATED EAPI void           elm_dialoguegroup_title_set(Evas_Object *obj, const char *title);
29436    EINA_DEPRECATED EAPI const char    *elm_dialoguegroup_title_get(Evas_Object *obj);
29437    EINA_DEPRECATED EAPI void           elm_dialoguegroup_press_effect_set(Dialogue_Item *item, Eina_Bool press);
29438    EINA_DEPRECATED EAPI Eina_Bool      elm_dialoguegroup_press_effect_get(Dialogue_Item *item);
29439    EINA_DEPRECATED EAPI Evas_Object   *elm_dialoguegroup_item_content_get(Dialogue_Item *item);
29440    EINA_DEPRECATED EAPI void           elm_dialoguegroup_item_style_set(Dialogue_Item *item, Elm_Dialoguegroup_Item_Style style);
29441    EINA_DEPRECATED EAPI Elm_Dialoguegroup_Item_Style    elm_dialoguegroup_item_style_get(Dialogue_Item *item);
29442    EINA_DEPRECATED EAPI void           elm_dialoguegroup_item_disabled_set(Dialogue_Item *item, Eina_Bool disabled);
29443    EINA_DEPRECATED EAPI Eina_Bool      elm_dialoguegroup_item_disabled_get(Dialogue_Item *item);
29444
29445    /* Dayselector */
29446    typedef enum
29447      {
29448         ELM_DAYSELECTOR_SUN,
29449         ELM_DAYSELECTOR_MON,
29450         ELM_DAYSELECTOR_TUE,
29451         ELM_DAYSELECTOR_WED,
29452         ELM_DAYSELECTOR_THU,
29453         ELM_DAYSELECTOR_FRI,
29454         ELM_DAYSELECTOR_SAT
29455      } Elm_DaySelector_Day;
29456
29457    EAPI Evas_Object *elm_dayselector_add(Evas_Object *parent);
29458    EAPI Eina_Bool    elm_dayselector_check_state_get(Evas_Object *obj, Elm_DaySelector_Day day);
29459    EAPI void         elm_dayselector_check_state_set(Evas_Object *obj, Elm_DaySelector_Day day, Eina_Bool checked);
29460
29461    /* Image Slider */
29462    typedef struct _Imageslider_Item Elm_Imageslider_Item;
29463    typedef void (*Elm_Imageslider_Cb)(void *data, Evas_Object *obj, void *event_info);
29464    EAPI Evas_Object           *elm_imageslider_add(Evas_Object *parent) EINA_ARG_NONNULL(1);
29465    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);
29466    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);
29467    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);
29468    EAPI void                   elm_imageslider_item_del(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
29469    EAPI Elm_Imageslider_Item  *elm_imageslider_selected_item_get(Evas_Object *obj) EINA_ARG_NONNULL(1);
29470    EAPI Eina_Bool              elm_imageslider_item_selected_get(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
29471    EAPI void                   elm_imageslider_item_selected_set(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
29472    EAPI const char            *elm_imageslider_item_photo_file_get(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
29473    EAPI Elm_Imageslider_Item  *elm_imageslider_item_prev(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
29474    EAPI Elm_Imageslider_Item  *elm_imageslider_item_next(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
29475    EAPI void                   elm_imageslider_prev(Evas_Object *obj) EINA_ARG_NONNULL(1);
29476    EAPI void                   elm_imageslider_next(Evas_Object *obj) EINA_ARG_NONNULL(1);
29477    EAPI void                   elm_imageslider_item_photo_file_set(Elm_Imageslider_Item *it, const char *photo_file) EINA_ARG_NONNULL(1,2);
29478    EAPI void                   elm_imageslider_item_update(Elm_Imageslider_Item *it) EINA_ARG_NONNULL(1);
29479 #ifdef __cplusplus
29480 }
29481 #endif
29482
29483 #endif